Commit a173a7ee authored by Rich Salz's avatar Rich Salz
Browse files

more doc fixes 



dgst: using digest instead of specific digest commands
the digest list specified in man dgst may be inaccurate, hence using
digest and referring to the list in digest-commands

'sha' as a digest name is no longer supported

dgst,pkeyutl cmds help cleanup
- In dgst, pkeyutl cmds, some options help was missing.
- fixed a minor typo in openssl.pod, that fixes make install.
- digest-commands was showing ‘sha’, which is not a supported digest
anymore.

Signed-off-by: default avatarRich Salz <rsalz@openssl.org>
Reviewed-by: default avatarTim Hudson <tjh@openssl.org>
parent 99978d51

apps/dgst.c

+8 −5
Original line number Diff line number Diff line
@@ -91,9 +91,10 @@ OPTIONS dgst_options[] = { 
    {"help", OPT_HELP, '-', "Display this summary"},

    {"c", OPT_C, '-', "Print the digest with separating colons"},

    {"r", OPT_R, '-', "Print the digest in coreutils format"},

    {"rand", OPT_RAND, 's'},

    {"rand", OPT_RAND, 's',

     "Use file(s) containing random data to seed RNG or an EGD sock"},

    {"out", OPT_OUT, '>', "Output to filename rather than stdout"},

    {"passin", OPT_PASSIN, 's'},

    {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},

    {"sign", OPT_SIGN, '<', "Sign digest using private key in file"},

    {"verify", OPT_VERIFY, '<',

     "Verify a signature using public key in file"},
@@ -104,8 +105,9 @@ OPTIONS dgst_options[] = { 
    {"hex", OPT_HEX, '-', "Print as hex dump"},

    {"binary", OPT_BINARY, '-', "Print in binary form"},

    {"d", OPT_DEBUG, '-', "Print debug info"},

    {"debug", OPT_DEBUG, '-'},

    {"fips-fingerprint", OPT_FIPS_FINGERPRINT, '-'},

    {"debug", OPT_DEBUG, '-', "Print debug info"},

    {"fips-fingerprint", OPT_FIPS_FINGERPRINT, '-',

     "Compute HMAC with the key used in OpenSSL-FIPS fingerprint"},

    {"hmac", OPT_HMAC, 's', "Create hashed MAC with key"},

    {"mac", OPT_MAC, 's', "Create MAC (not necessarily HMAC)"},

    {"sigopt", OPT_SIGOPT, 's', "Signature parameter in n:v form"},
@@ -113,7 +115,8 @@ OPTIONS dgst_options[] = { 
    {"", OPT_DIGEST, '-', "Any supported digest"},

#ifndef OPENSSL_NO_ENGINE

    {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},

    {"engine_impl", OPT_ENGINE_IMPL, '-'},

    {"engine_impl", OPT_ENGINE_IMPL, '-',

     "Also use engine given by -engine for digest operations"},

#endif

    {NULL}

};

apps/pkeyutl.c

+9 −8
Original line number Diff line number Diff line
@@ -89,22 +89,22 @@ typedef enum OPTION_choice { 


OPTIONS pkeyutl_options[] = {

    {"help", OPT_HELP, '-', "Display this summary"},

    {"in", OPT_IN, '<', "Input file"},

    {"out", OPT_OUT, '>', "Output file"},

    {"in", OPT_IN, '<', "Input file - default stdin"},

    {"out", OPT_OUT, '>', "Output file - default stdout"},

    {"pubin", OPT_PUBIN, '-', "Input is a public key"},

    {"certin", OPT_CERTIN, '-', "Input is a cert with a public key"},

    {"asn1parse", OPT_ASN1PARSE, '-', "asn1parse the output data"},

    {"hexdump", OPT_HEXDUMP, '-', "Hex dump output"},

    {"sign", OPT_SIGN, '-', "Sign with private key"},

    {"sign", OPT_SIGN, '-', "Sign input data with private key"},

    {"verify", OPT_VERIFY, '-', "Verify with public key"},

    {"verifyrecover", OPT_VERIFYRECOVER, '-',

     "Verify with public key, recover original data"},

    {"rev", OPT_REV, '-', "Reverse the input buffer"},

    {"encrypt", OPT_ENCRYPT, '-', "Encrypt with public key"},

    {"decrypt", OPT_DECRYPT, '-', "Decrypt with private key"},

    {"rev", OPT_REV, '-', "Reverse the order of the input buffer"},

    {"encrypt", OPT_ENCRYPT, '-', "Encrypt input data with public key"},

    {"decrypt", OPT_DECRYPT, '-', "Decrypt input data with private key"},

    {"derive", OPT_DERIVE, '-', "Derive shared secret"},

    {"sigfile", OPT_SIGFILE, '<', "Signature file (verify operation only)"},

    {"inkey", OPT_INKEY, 's', "Input key"},

    {"inkey", OPT_INKEY, 's', "Input private key file"},

    {"peerkey", OPT_PEERKEY, 's', "Peer key file used in key derivation"},

    {"passin", OPT_PASSIN, 's', "Pass phrase source"},

    {"peerform", OPT_PEERFORM, 'E', "Peer key format - default PEM"},
@@ -112,7 +112,8 @@ OPTIONS pkeyutl_options[] = { 
    {"pkeyopt", OPT_PKEYOPT, 's', "Public key options as opt:value"},

#ifndef OPENSSL_NO_ENGINE

    {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},

    {"engine_impl", OPT_ENGINE_IMPL, '-', "Also use engine given by -engine for crypto operations"},

    {"engine_impl", OPT_ENGINE_IMPL, '-',

     "Also use engine given by -engine for crypto operations"},

#endif

    {NULL}

};

apps/progs.h

+0 −1
Original line number Diff line number Diff line
@@ -214,7 +214,6 @@ static FUNCTION functions[] = { 
#ifndef OPENSSL_NO_MD_GHOST94

    { FT_md, "md_ghost94", dgst_main},

#endif

    { FT_md, "sha", dgst_main},

    { FT_md, "sha1", dgst_main},

    { FT_md, "sha224", dgst_main},

    { FT_md, "sha256", dgst_main},

apps/progs.pl

+1 −1
Original line number Diff line number Diff line
@@ -72,7 +72,7 @@ foreach (@ARGV) { 
foreach (

	"md2", "md4", "md5",

	"md_ghost94",

	"sha", "sha1", "sha224", "sha256", "sha384", "sha512",

	"sha1", "sha224", "sha256", "sha384", "sha512",

	"mdc2", "rmd160"

) {

        printf "#ifndef OPENSSL_NO_".uc($_)."\n" if ! /sha/;

doc/apps/dgst.pod

+23 −10
Original line number Diff line number Diff line
@@ -8,7 +8,7 @@ dgst, sha, sha1, mdc2, ripemd160, sha224, sha256, sha384, sha512, md4, md5 - mes 


B<openssl> B<dgst>

[B<-help>]

[B<-sha|-sha1|-mdc2|-ripemd160|-sha224|-sha256|-sha384|-sha512|-md4|-md5>]

[B<-I<digest>>]

[B<-c>]

[B<-d>]

[B<-hex>]
@@ -23,6 +23,8 @@ B<openssl> B<dgst> 
[B<-signature filename>]

[B<-hmac key>]

[B<-fips-fingerprint>]

[B<-engine id>]

[B<-engine_impl>]

[B<file...>]



B<openssl>
@@ -38,8 +40,8 @@ signatures using message digests. 
The generic name, B<dgst>, may be used with an option specifying the

algorithm to be used.

The default digest is I<sha256>.

The digest name may also be used as the command name.

To see the list of supported algorithms, use the <Ilist --digest-commands>

A supported I<digest> name may also be used as the command name.

To see the list of supported algorithms, use the I<list --digest-commands>

command.



=head1 OPTIONS
@@ -50,6 +52,11 @@ command. 


Print out a usage message.



=item B<-I<digest>>



Specifies name of a supported digest to be used. To see the list of

supported digests, use the command I<list --digest-commands>.



=item B<-c>



print out the digest in two digit groups separated by colons, only relevant if
@@ -86,12 +93,6 @@ digitally sign the digest using the private key in "filename". 
Specifies the key format to sign digest with. The DER, PEM, P12,

and ENGINE formats are supported.



=item B<-engine id>



Use engine B<id> for operations (including private key storage).

This engine is not used as source for digest algorithms, unless it is

also specified in the configuration file.



=item B<-sigopt nm:v>



Pass options to the signature algorithm during sign or verify operations.
@@ -162,6 +163,18 @@ all others. 
compute HMAC using a specific key

for certain OpenSSL-FIPS operations.



=item B<-engine id>



Use engine B<id> for operations (including private key storage).

This engine is not used as source for digest algorithms, unless it is

also specified in the configuration file or B<-engine_impl> is also

specified.



=item B<-engine_impl>



When used with the B<-engine> option, it specifies to also use

engine B<id> for digest operations.



=item B<file...>



file or files to digest. If no files are specified then standard input is