userapps/opensource/openssl/doc/apps/dgst.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 dgst, md5, md4, md2, sha1, sha, mdc2, ripemd160 - message digests
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<dgst>
  10 [B<-md5|-md4|-md2|-sha1|-sha|-mdc2|-ripemd160|-dss1>]
  11 [B<-c>]
  12 [B<-d>]
  13 [B<-hex>]
  14 [B<-binary>]
  15 [B<-out filename>]
  16 [B<-sign filename>]
  17 [B<-passin arg>]
  18 [B<-verify filename>]
  19 [B<-prverify filename>]
  20 [B<-signature filename>]
  21 [B<file...>]
  22
  23 [B<md5|md4|md2|sha1|sha|mdc2|ripemd160>]
  24 [B<-c>]
  25 [B<-d>]
  26 [B<file...>]
  27
  28 =head1 DESCRIPTION
  29
  30 The digest functions output the message digest of a supplied file or files
  31 in hexadecimal form. They can also be used for digital signing and verification.
  32
  33 =head1 OPTIONS
  34
  35 =over 4
  36
  37 =item B<-c>
  38
  39 print out the digest in two digit groups separated by colons, only relevant if
  40 B<hex> format output is used.
  41
  42 =item B<-d>
  43
  44 print out BIO debugging information.
  45
  46 =item B<-hex>
  47
  48 digest is to be output as a hex dump. This is the default case for a "normal"
  49 digest as opposed to a digital signature.
  50
  51 =item B<-binary>
  52
  53 output the digest or signature in binary form.
  54
  55 =item B<-out filename>
  56
  57 filename to output to, or standard output by default.
  58
  59 =item B<-sign filename>
  60
  61 digitally sign the digest using the private key in "filename".
  62
  63 =item B<-passin arg>
  64
  65 the private key password source. For more information about the format of B<arg>
  66 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
  67
  68 =item B<-verify filename>
  69
  70 verify the signature using the the public key in "filename".
  71 The output is either "Verification OK" or "Verification Failure".
  72
  73 =item B<-prverify filename>
  74
  75 verify the signature using the  the private key in "filename".
  76
  77 =item B<-signature filename>
  78
  79 the actual signature to verify.
  80
  81 =item B<-rand file(s)>
  82
  83 a file or files containing random data used to seed the random number
  84 generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
  85 Multiple files can be specified separated by a OS-dependent character.
  86 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
  87 all others.
  88
  89 =item B<file...>
  90
  91 file or files to digest. If no files are specified then standard input is
  92 used.
  93
  94 =back
  95
  96 =head1 NOTES
  97
  98 The digest of choice for all new applications is SHA1. Other digests are
  99 however still widely used.
 100
 101 If you wish to sign or verify data using the DSA algorithm then the dss1
 102 digest must be used.
 103
 104 A source of random numbers is required for certain signing algorithms, in
 105 particular DSA.
 106
 107 The signing and verify options should only be used if a single file is
 108 being signed or verified.
 109
 110 =cut