Remove building with NOCRYPTO option
[minix.git] / crypto / external / bsd / openssl / dist / doc / apps / dgst.pod
blob9e15798d8279d1e6cca7f5ba7c8102d0f164ba88
1 =pod
3 =head1 NAME
5 dgst, sha, sha1, mdc2, ripemd160, sha224, sha256, sha384, sha512, md2, md4, md5, dss1 - message digests
7 =head1 SYNOPSIS
9 B<openssl> B<dgst> 
10 [B<-sha|-sha1|-mdc2|-ripemd160|-sha224|-sha256|-sha384|-sha512|-md2|-md4|-md5|-dss1>]
11 [B<-c>]
12 [B<-d>]
13 [B<-hex>]
14 [B<-binary>]
15 [B<-r>]
16 [B<-hmac arg>]
17 [B<-non-fips-allow>]
18 [B<-out filename>]
19 [B<-sign filename>]
20 [B<-keyform arg>]
21 [B<-passin arg>]
22 [B<-verify filename>]
23 [B<-prverify filename>]
24 [B<-signature filename>]
25 [B<-hmac key>]
26 [B<-non-fips-allow>]
27 [B<-fips-fingerprint>]
28 [B<file...>]
30 B<openssl>
31 [I<digest>]
32 [B<...>]
34 =head1 DESCRIPTION
36 The digest functions output the message digest of a supplied file or files
37 in hexadecimal.  The digest functions also generate and verify digital
38 signatures using message digests.
40 =head1 OPTIONS
42 =over 4
44 =item B<-c>
46 print out the digest in two digit groups separated by colons, only relevant if
47 B<hex> format output is used.
49 =item B<-d>
51 print out BIO debugging information.
53 =item B<-hex>
55 digest is to be output as a hex dump. This is the default case for a "normal"
56 digest as opposed to a digital signature.  See NOTES below for digital
57 signatures using B<-hex>.
59 =item B<-binary>
61 output the digest or signature in binary form.
63 =item B<-r>
65 output the digest in the "coreutils" format used by programs like B<sha1sum>.
67 =item B<-hmac arg>
69 set the HMAC key to "arg".
71 =item B<-non-fips-allow>
73 Allow use of non FIPS digest when in FIPS mode.  This has no effect when not in
74 FIPS mode.
76 =item B<-out filename>
78 filename to output to, or standard output by default.
80 =item B<-sign filename>
82 digitally sign the digest using the private key in "filename".
84 =item B<-keyform arg>
86 Specifies the key format to sign digest with. The DER, PEM, P12,
87 and ENGINE formats are supported.
89 =item B<-engine id>
91 Use engine B<id> for operations (including private key storage).
92 This engine is not used as source for digest algorithms, unless it is
93 also specified in the configuration file.
95 =item B<-sigopt nm:v>
97 Pass options to the signature algorithm during sign or verify operations.
98 Names and values of these options are algorithm-specific.
101 =item B<-passin arg>
103 the private key password source. For more information about the format of B<arg>
104 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
106 =item B<-verify filename>
108 verify the signature using the the public key in "filename".
109 The output is either "Verification OK" or "Verification Failure".
111 =item B<-prverify filename>
113 verify the signature using the  the private key in "filename".
115 =item B<-signature filename>
117 the actual signature to verify.
119 =item B<-hmac key>
121 create a hashed MAC using "key".
123 =item B<-mac alg>
125 create MAC (keyed Message Authentication Code). The most popular MAC
126 algorithm is HMAC (hash-based MAC), but there are other MAC algorithms
127 which are not based on hash, for instance B<gost-mac> algorithm,
128 supported by B<ccgost> engine. MAC keys and other options should be set
129 via B<-macopt> parameter.
131 =item B<-macopt nm:v>
133 Passes options to MAC algorithm, specified by B<-mac> key.
134 Following options are supported by both by B<HMAC> and B<gost-mac>:
136 =over 8
138 =item B<key:string>
140 Specifies MAC key as alphnumeric string (use if key contain printable
141 characters only). String length must conform to any restrictions of
142 the MAC algorithm for example exactly 32 chars for gost-mac.
144 =item B<hexkey:string>
146 Specifies MAC key in hexadecimal form (two hex digits per byte).
147 Key length must conform to any restrictions of the MAC algorithm
148 for example exactly 32 chars for gost-mac.
150 =back
152 =item B<-rand file(s)>
154 a file or files containing random data used to seed the random number
155 generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
156 Multiple files can be specified separated by a OS-dependent character.
157 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
158 all others. 
160 =item B<-non-fips-allow>
162 enable use of non-FIPS algorithms such as MD5 even in FIPS mode.
164 =item B<-fips-fingerprint>
166 compute HMAC using a specific key
167 for certain OpenSSL-FIPS operations.
169 =item B<file...>
171 file or files to digest. If no files are specified then standard input is
172 used.
174 =back
177 =head1 EXAMPLES
179 To create a hex-encoded message digest of a file:
180  openssl dgst -md5 -hex file.txt
182 To sign a file using SHA-256 with binary file output:
183  openssl dgst -sha256 -sign privatekey.pem -out signature.sign file.txt
185 To verify a signature:
186  openssl dgst -sha256 -verify publickey.pem \
187  -signature signature.sign \
188  file.txt
191 =head1 NOTES
193 The digest of choice for all new applications is SHA1. Other digests are
194 however still widely used.
196 When signing a file, B<dgst> will automatically determine the algorithm
197 (RSA, ECC, etc) to use for signing based on the private key's ASN.1 info.
198 When verifying signatures, it only handles the RSA, DSA, or ECDSA signature
199 itself, not the related data to identify the signer and algorithm used in
200 formats such as x.509, CMS, and S/MIME.
202 A source of random numbers is required for certain signing algorithms, in
203 particular ECDSA and DSA.
205 The signing and verify options should only be used if a single file is
206 being signed or verified.
208 Hex signatures cannot be verified using B<openssl>.  Instead, use "xxd -r"
209 or similar program to transform the hex signature into a binary signature
210 prior to verification.
213 =cut