diff options
author | Rich Salz <rsalz@openssl.org> | 2016-02-07 23:14:12 -0500 |
---|---|---|
committer | Rich Salz <rsalz@openssl.org> | 2016-02-07 23:14:12 -0500 |
commit | a173a7ee3f51af71c27490247f9a65ff03553e2c (patch) | |
tree | cb975182fcab9d4553bc9fe9991bd37a32602055 /apps | |
parent | 99978d51d6ba1ae8e36c1f82e98e9b2052131948 (diff) |
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: Rich Salz <rsalz@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Diffstat (limited to 'apps')
-rw-r--r-- | apps/dgst.c | 13 | ||||
-rw-r--r-- | apps/pkeyutl.c | 17 | ||||
-rw-r--r-- | apps/progs.h | 1 | ||||
-rw-r--r-- | apps/progs.pl | 2 |
4 files changed, 18 insertions, 15 deletions
diff --git a/apps/dgst.c b/apps/dgst.c index 5d25c58e32..7fa535197e 100644 --- a/apps/dgst.c +++ b/apps/dgst.c @@ -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} }; diff --git a/apps/pkeyutl.c b/apps/pkeyutl.c index 8704fd9849..5a2827b399 100644 --- a/apps/pkeyutl.c +++ b/apps/pkeyutl.c @@ -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} }; diff --git a/apps/progs.h b/apps/progs.h index f3eaf2ac42..86d9ab87f4 100644 --- a/apps/progs.h +++ b/apps/progs.h @@ -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}, diff --git a/apps/progs.pl b/apps/progs.pl index 4ffa1f1e79..40053a7306 100644 --- a/apps/progs.pl +++ b/apps/progs.pl @@ -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/; |