usr/src/man/man1/digest.1

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