share/man/man1/digest.1

   1 '\" te
   2 .\" Copyright 2006, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH DIGEST 1 "May 21, 2009"
   7 .SH NAME
   8 digest \- calculate a message digest
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/bin/digest\fR \fB-l\fR | [\fB-v\fR] \fB-a\fR \fIalgorithm\fR [\fIfile\fR]...
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .LP
  17 The \fBdigest\fR utility calculates the message digest of the given files or
  18 \fBstdin\fR using the algorithm specified. If more than one file is given, each
  19 line of output is the digest of a single file.
  20 .SH OPTIONS
  21 .LP
  22 The following options are supported:
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fB-a\fR \fIalgorithm\fR\fR
  27 .ad
  28 .RS 16n
  29 Specifies the name of the algorithm to use during the encryption or decryption
  30 process. See USAGE, \fBAlgorithms\fR, for details.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fB-l\fR\fR
  37 .ad
  38 .RS 16n
  39 Displays list of algorithms available on the system. This list can change
  40 depending on the configuration of the cryptographic framework.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fB-v\fR\fR
  47 .ad
  48 .RS 16n
  49 Verbose output. Includes the algorithm name and filename in the output.
  50 .RE
  51
  52 .SH USAGE
  53 .SS "Algorithms"
  54 .LP
  55 These algorithms are provided by the Cryptographic Framework. Each algorithm
  56 supported by the command is an alias of the PKCS #11 mechanism for easier
  57 access. For example, \fBsha1\fR is an alias to \fBCKM_SHA_1\fR.
  58 .sp
  59 .LP
  60 These aliases are used with the \fB-a\fR option and are case-sensitive.
  61 .SH EXAMPLES
  62 .LP
  63 \fBExample 1 \fRSimulating Output
  64 .sp
  65 .LP
  66 The following example simulates output of the common \fBmd5sum\fR program:
  67
  68 .sp
  69 .in +2
  70 .nf
  71 example$ digest -v -a md5 /usr/bin/vi
  72 md5 (/usr/bin/vi) = e4e3588c5212903847c66d36b1a828a5
  73 .fi
  74 .in -2
  75 .sp
  76
  77 .LP
  78 \fBExample 2 \fRDigesting a File
  79 .sp
  80 .LP
  81 The following example generates the \fBsha1\fR digest of the file
  82 \fB/etc/motd\fR:
  83
  84 .sp
  85 .in +2
  86 .nf
  87 example$ digest -a sha1 /etc/motd
  88 9498a4f5303d056ad3ecae826b59f41448d63790
  89 .fi
  90 .in -2
  91 .sp
  92
  93 .LP
  94 \fBExample 3 \fRGenerating a Directory Manifest
  95 .sp
  96 .LP
  97 The following example generates a directory manifest with \fBsha1\fR:
  98
  99 .sp
 100 .in +2
 101 .nf
 102 example$ digest -v -a sha1 /usr/lib/inet/*
 103 sha1 (/usr/lib/inet/certdb) = f6d43e6e395d50db24d34e4af4828598c8918b16
 104 sha1 (/usr/lib/inet/certlocal) = 7f74ba4a019b809c7023212b4bda10d9485e071d
 105 sha1 (/usr/lib/inet/certrldb) = 1f845d30b8d02066647de04311e74549049852ed
 106 sha1 (/usr/lib/inet/dhcp) = e3db5e4ff40a69d13f2497254526c2015d2c37b3
 107 sha1 (/usr/lib/inet/dsvclockd) = b61aad7ed6a0f82145c3c26aedc613ab4a1f032e
 108 sha1 (/usr/lib/inet/in.dhcpd) = 382210180c826fbb2e747236c489062bac8cc30b
 109 sha1 (/usr/lib/inet/in.iked) = be6061fad725d37256e773dc85f8bd5248649463
 110 sha1 (/usr/lib/inet/in.mpathd) = 5bd6bf0340fd5c4cc0c53f2df158302a0e85f9d0
 111 sha1 (/usr/lib/inet/in.ndpd) = fdb768aebe7e5eb4465e1c1bb5e679b496f5c5c6
 112 sha1 (/usr/lib/inet/in.ripngd) = 4f56a0df2d4a252f581a73c2e84143b920d0b66b
 113 sha1 (/usr/lib/inet/ncaconfd) = 7219542b5585a8d1104d7ce4a2ced07d8a260ea3
 114 sha1 (/usr/lib/inet/ppp) = c96ee458549871a6ffdf2674a888b01d0c9e9740
 115 sha1 (/usr/lib/inet/pppoec) = 5f022498d79dacacd947cddadc64f171822e3dee
 116 sha1 (/usr/lib/inet/pppoed) = 252bd2f0863dbc1b05fffae72821a2a95609b8ad
 117 sha1 (/usr/lib/inet/ntpd) = 5b4aff102372cea801e7d08acde9655fec81f07c
 118 .fi
 119 .in -2
 120 .sp
 121
 122 .LP
 123 \fBExample 4 \fRDisplaying a List of Available Algorithms
 124 .sp
 125 .LP
 126 The following example displays a list of available algorithms to digest:
 127
 128 .sp
 129 .in +2
 130 .nf
 131 example$ digest -l
 132 sha1
 133 md5
 134 sha256
 135 sha385
 136 sha512
 137 .fi
 138 .in -2
 139 .sp
 140
 141 .SH EXIT STATUS
 142 .LP
 143 The following exit values are returned:
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fB0\fR\fR
 148 .ad
 149 .RS 6n
 150 Successful completion.
 151 .RE
 152
 153 .sp
 154 .ne 2
 155 .na
 156 \fB\fB>0\fR\fR
 157 .ad
 158 .RS 6n
 159 An error occurred.
 160 .RE
 161
 162 .SH ATTRIBUTES
 163 .LP
 164 See \fBattributes\fR(5) for descriptions of the following attributes:
 165 .sp
 166
 167 .sp
 168 .TS
 169 box;
 170 c | c
 171 l | l .
 172 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 173 _
 174 Interface Stability     Committed
 175 .TE
 176
 177 .SH SEE ALSO
 178 .LP
 179 \fBcksum\fR(1), \fBencrypt\fR(1), \fBmac\fR(1), \fBbart\fR(8),
 180 \fBcryptoadm\fR(8), \fBlibpkcs11\fR(3LIB), \fBattributes\fR(5),
 181 \fBpkcs11_softtoken\fR(5)