From: Pauli Date: Wed, 26 Feb 2020 21:45:31 +0000 (+1000) Subject: man1: make all openssl command line tool documentation generated. X-Git-Tag: openssl-3.0.0-alpha1~317 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=5e98904c231f5a40c6ce291df85799cca7c8d125;p=oweals%2Fopenssl.git man1: make all openssl command line tool documentation generated. With the introduction of provider command line options which are applicable to almost all of the command line tools, it seemed reasonable to make them all generated. This simplifes the .gitignore and avoids having to keep two lists in sync. Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/11167) --- diff --git a/.gitignore b/.gitignore index f51ccce56d..0578fd5c1b 100644 --- a/.gitignore +++ b/.gitignore @@ -26,43 +26,7 @@ /include/openssl/opensslv.h # Auto generated doc files -# Keep this in sync with doc/man1/build.info -doc/man1/openssl-ca.pod -doc/man1/openssl-cms.pod -doc/man1/openssl-crl.pod -doc/man1/openssl-dgst.pod -doc/man1/openssl-dhparam.pod -doc/man1/openssl-dsa.pod -doc/man1/openssl-dsaparam.pod -doc/man1/openssl-ec.pod -doc/man1/openssl-ecparam.pod -doc/man1/openssl-enc.pod -doc/man1/openssl-gendsa.pod -doc/man1/openssl-genpkey.pod -doc/man1/openssl-genrsa.pod -doc/man1/openssl-ocsp.pod -doc/man1/openssl-passwd.pod -doc/man1/openssl-pkcs12.pod -doc/man1/openssl-pkcs7.pod -doc/man1/openssl-pkcs8.pod -doc/man1/openssl-pkey.pod -doc/man1/openssl-pkeyparam.pod -doc/man1/openssl-pkeyutl.pod -doc/man1/openssl-rand.pod -doc/man1/openssl-req.pod -doc/man1/openssl-rsa.pod -doc/man1/openssl-rsautl.pod -doc/man1/openssl-s_client.pod -doc/man1/openssl-s_server.pod -doc/man1/openssl-s_time.pod -doc/man1/openssl-smime.pod -doc/man1/openssl-speed.pod -doc/man1/openssl-spkac.pod -doc/man1/openssl-srp.pod -doc/man1/openssl-storeutl.pod -doc/man1/openssl-ts.pod -doc/man1/openssl-verify.pod -doc/man1/openssl-x509.pod +doc/man1/openssl-*.pod # error code files /crypto/err/openssl.txt.old diff --git a/doc/man1/build.info b/doc/man1/build.info index 13012d4432..c48ff0acbe 100644 --- a/doc/man1/build.info +++ b/doc/man1/build.info @@ -1,113 +1,163 @@ -# Keep this in sync with .gitignore! DEPEND[]= \ + openssl-asn1parse.pod \ openssl-ca.pod \ + openssl-ciphers.pod \ + openssl-cmds.pod \ openssl-cms.pod \ + openssl-crl2pkcs7.pod \ openssl-crl.pod \ openssl-dgst.pod \ openssl-dhparam.pod \ - openssl-dsa.pod \ openssl-dsaparam.pod \ - openssl-ec.pod \ + openssl-dsa.pod \ openssl-ecparam.pod \ + openssl-ec.pod \ openssl-enc.pod \ + openssl-engine.pod \ + openssl-errstr.pod \ + openssl-fipsinstall.pod \ openssl-gendsa.pod \ openssl-genpkey.pod \ openssl-genrsa.pod \ + openssl-info.pod \ + openssl-kdf.pod \ + openssl-list.pod \ + openssl-mac.pod \ + openssl-nseq.pod \ openssl-ocsp.pod \ openssl-passwd.pod \ openssl-pkcs12.pod \ openssl-pkcs7.pod \ openssl-pkcs8.pod \ - openssl-pkey.pod \ openssl-pkeyparam.pod \ + openssl-pkey.pod \ openssl-pkeyutl.pod \ + openssl-prime.pod \ + openssl-provider.pod \ openssl-rand.pod \ + openssl-rehash.pod \ openssl-req.pod \ openssl-rsa.pod \ openssl-rsautl.pod \ openssl-s_client.pod \ - openssl-s_server.pod \ - openssl-s_time.pod \ + openssl-sess_id.pod \ openssl-smime.pod \ openssl-speed.pod \ openssl-spkac.pod \ openssl-srp.pod \ + openssl-s_server.pod \ + openssl-s_time.pod \ openssl-storeutl.pod \ openssl-ts.pod \ openssl-verify.pod \ + openssl-version.pod \ openssl-x509.pod +DEPEND[openssl-asn1parse.pod]=../perlvars.pm DEPEND[openssl-ca.pod]=../perlvars.pm +DEPEND[openssl-ciphers.pod]=../perlvars.pm +DEPEND[openssl-cmds.pod]=../perlvars.pm DEPEND[openssl-cms.pod]=../perlvars.pm +DEPEND[openssl-crl2pkcs7.pod]=../perlvars.pm DEPEND[openssl-crl.pod]=../perlvars.pm DEPEND[openssl-dgst.pod]=../perlvars.pm DEPEND[openssl-dhparam.pod]=../perlvars.pm -DEPEND[openssl-dsa.pod]=../perlvars.pm DEPEND[openssl-dsaparam.pod]=../perlvars.pm -DEPEND[openssl-ec.pod]=../perlvars.pm +DEPEND[openssl-dsa.pod]=../perlvars.pm DEPEND[openssl-ecparam.pod]=../perlvars.pm +DEPEND[openssl-ec.pod]=../perlvars.pm DEPEND[openssl-enc.pod]=../perlvars.pm +DEPEND[openssl-engine.pod]=../perlvars.pm +DEPEND[openssl-errstr.pod]=../perlvars.pm +DEPEND[openssl-fipsinstall.pod]=../perlvars.pm DEPEND[openssl-gendsa.pod]=../perlvars.pm DEPEND[openssl-genpkey.pod]=../perlvars.pm DEPEND[openssl-genrsa.pod]=../perlvars.pm +DEPEND[openssl-info.pod]=../perlvars.pm +DEPEND[openssl-kdf.pod]=../perlvars.pm +DEPEND[openssl-list.pod]=../perlvars.pm +DEPEND[openssl-mac.pod]=../perlvars.pm +DEPEND[openssl-nseq.pod]=../perlvars.pm DEPEND[openssl-ocsp.pod]=../perlvars.pm DEPEND[openssl-passwd.pod]=../perlvars.pm DEPEND[openssl-pkcs12.pod]=../perlvars.pm DEPEND[openssl-pkcs7.pod]=../perlvars.pm DEPEND[openssl-pkcs8.pod]=../perlvars.pm -DEPEND[openssl-pkey.pod]=../perlvars.pm DEPEND[openssl-pkeyparam.pod]=../perlvars.pm +DEPEND[openssl-pkey.pod]=../perlvars.pm DEPEND[openssl-pkeyutl.pod]=../perlvars.pm +DEPEND[openssl-prime.pod]=../perlvars.pm +DEPEND[openssl-provider.pod]=../perlvars.pm DEPEND[openssl-rand.pod]=../perlvars.pm +DEPEND[openssl-rehash.pod]=../perlvars.pm DEPEND[openssl-req.pod]=../perlvars.pm DEPEND[openssl-rsa.pod]=../perlvars.pm DEPEND[openssl-rsautl.pod]=../perlvars.pm DEPEND[openssl-s_client.pod]=../perlvars.pm -DEPEND[openssl-s_server.pod]=../perlvars.pm -DEPEND[openssl-s_time.pod]=../perlvars.pm +DEPEND[openssl-sess_id.pod]=../perlvars.pm DEPEND[openssl-smime.pod]=../perlvars.pm DEPEND[openssl-speed.pod]=../perlvars.pm DEPEND[openssl-spkac.pod]=../perlvars.pm DEPEND[openssl-srp.pod]=../perlvars.pm +DEPEND[openssl-s_server.pod]=../perlvars.pm +DEPEND[openssl-s_time.pod]=../perlvars.pm DEPEND[openssl-storeutl.pod]=../perlvars.pm DEPEND[openssl-ts.pod]=../perlvars.pm DEPEND[openssl-verify.pod]=../perlvars.pm +DEPEND[openssl-version.pod]=../perlvars.pm DEPEND[openssl-x509.pod]=../perlvars.pm +GENERATE[openssl-asn1parse.pod]=openssl-asn1parse.pod.in GENERATE[openssl-ca.pod]=openssl-ca.pod.in +GENERATE[openssl-ciphers.pod]=openssl-ciphers.pod.in +GENERATE[openssl-cmds.pod]=openssl-cmds.pod.in GENERATE[openssl-cms.pod]=openssl-cms.pod.in +GENERATE[openssl-crl2pkcs7.pod]=openssl-crl2pkcs7.pod.in GENERATE[openssl-crl.pod]=openssl-crl.pod.in GENERATE[openssl-dgst.pod]=openssl-dgst.pod.in GENERATE[openssl-dhparam.pod]=openssl-dhparam.pod.in -GENERATE[openssl-dsa.pod]=openssl-dsa.pod.in GENERATE[openssl-dsaparam.pod]=openssl-dsaparam.pod.in -GENERATE[openssl-ec.pod]=openssl-ec.pod.in +GENERATE[openssl-dsa.pod]=openssl-dsa.pod.in GENERATE[openssl-ecparam.pod]=openssl-ecparam.pod.in +GENERATE[openssl-ec.pod]=openssl-ec.pod.in GENERATE[openssl-enc.pod]=openssl-enc.pod.in +GENERATE[openssl-engine.pod]=openssl-engine.pod.in +GENERATE[openssl-errstr.pod]=openssl-errstr.pod.in +GENERATE[openssl-fipsinstall.pod]=openssl-fipsinstall.pod.in GENERATE[openssl-gendsa.pod]=openssl-gendsa.pod.in GENERATE[openssl-genpkey.pod]=openssl-genpkey.pod.in GENERATE[openssl-genrsa.pod]=openssl-genrsa.pod.in +GENERATE[openssl-info.pod]=openssl-info.pod.in +GENERATE[openssl-kdf.pod]=openssl-kdf.pod.in +GENERATE[openssl-list.pod]=openssl-list.pod.in +GENERATE[openssl-mac.pod]=openssl-mac.pod.in +GENERATE[openssl-nseq.pod]=openssl-nseq.pod.in GENERATE[openssl-ocsp.pod]=openssl-ocsp.pod.in GENERATE[openssl-passwd.pod]=openssl-passwd.pod.in GENERATE[openssl-pkcs12.pod]=openssl-pkcs12.pod.in GENERATE[openssl-pkcs7.pod]=openssl-pkcs7.pod.in GENERATE[openssl-pkcs8.pod]=openssl-pkcs8.pod.in -GENERATE[openssl-pkey.pod]=openssl-pkey.pod.in GENERATE[openssl-pkeyparam.pod]=openssl-pkeyparam.pod.in +GENERATE[openssl-pkey.pod]=openssl-pkey.pod.in GENERATE[openssl-pkeyutl.pod]=openssl-pkeyutl.pod.in +GENERATE[openssl-prime.pod]=openssl-prime.pod.in +GENERATE[openssl-provider.pod]=openssl-provider.pod.in GENERATE[openssl-rand.pod]=openssl-rand.pod.in +GENERATE[openssl-rehash.pod]=openssl-rehash.pod.in GENERATE[openssl-req.pod]=openssl-req.pod.in GENERATE[openssl-rsa.pod]=openssl-rsa.pod.in GENERATE[openssl-rsautl.pod]=openssl-rsautl.pod.in GENERATE[openssl-s_client.pod]=openssl-s_client.pod.in -GENERATE[openssl-s_server.pod]=openssl-s_server.pod.in -GENERATE[openssl-s_time.pod]=openssl-s_time.pod.in +GENERATE[openssl-sess_id.pod]=openssl-sess_id.pod.in GENERATE[openssl-smime.pod]=openssl-smime.pod.in GENERATE[openssl-speed.pod]=openssl-speed.pod.in GENERATE[openssl-spkac.pod]=openssl-spkac.pod.in GENERATE[openssl-srp.pod]=openssl-srp.pod.in +GENERATE[openssl-s_server.pod]=openssl-s_server.pod.in +GENERATE[openssl-s_time.pod]=openssl-s_time.pod.in GENERATE[openssl-storeutl.pod]=openssl-storeutl.pod.in GENERATE[openssl-ts.pod]=openssl-ts.pod.in GENERATE[openssl-verify.pod]=openssl-verify.pod.in +GENERATE[openssl-version.pod]=openssl-version.pod.in GENERATE[openssl-x509.pod]=openssl-x509.pod.in diff --git a/doc/man1/openssl-asn1parse.pod b/doc/man1/openssl-asn1parse.pod deleted file mode 100644 index 698ce47897..0000000000 --- a/doc/man1/openssl-asn1parse.pod +++ /dev/null @@ -1,219 +0,0 @@ -=pod - -=head1 NAME - -openssl-asn1parse - ASN.1 parsing tool - -=head1 SYNOPSIS - -B B -[B<-help>] -[B<-inform> B|B] -[B<-in> I] -[B<-out> I] -[B<-noout>] -[B<-offset> I] -[B<-length> I] -[B<-i>] -[B<-oid> I] -[B<-dump>] -[B<-dlimit> I] -[B<-strparse> I] -[B<-genstr> I] -[B<-genconf> I] -[B<-strictpem>] -[B<-item> I] - -=head1 DESCRIPTION - -This command is a diagnostic utility that can parse ASN.1 structures. -It can also be used to extract data from ASN.1 formatted data. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print out a usage message. - -=item B<-inform> B|B - -The input format; the default is B. -See L for details. - -=item B<-in> I - -The input file, default is standard input. - -=item B<-out> I - -Output file to place the DER encoded data into. If this -option is not present then no data will be output. This is most useful when -combined with the B<-strparse> option. - -=item B<-noout> - -Don't output the parsed version of the input file. - -=item B<-offset> I - -Starting offset to begin parsing, default is start of file. - -=item B<-length> I - -Number of bytes to parse, default is until end of file. - -=item B<-i> - -Indents the output according to the "depth" of the structures. - -=item B<-oid> I - -A file containing additional OBJECT IDENTIFIERs (OIDs). The format of this -file is described in the NOTES section below. - -=item B<-dump> - -Dump unknown data in hex format. - -=item B<-dlimit> I - -Like B<-dump>, but only the first B bytes are output. - -=item B<-strparse> I - -Parse the contents octets of the ASN.1 object starting at B. This -option can be used multiple times to "drill down" into a nested structure. - -=item B<-genstr> I, B<-genconf> I - -Generate encoded data based on I, I or both using -L format. If I only is -present then the string is obtained from the default section using the name -B. The encoded data is passed through the ASN1 parser and printed out as -though it came from a file, the contents can thus be examined and written to a -file using the B<-out> option. - -=item B<-strictpem> - -If this option is used then B<-inform> will be ignored. Without this option any -data in a PEM format input file will be treated as being base64 encoded and -processed whether it has the normal PEM BEGIN and END markers or not. This -option will ignore any data prior to the start of the BEGIN marker, or after an -END marker in a PEM file. - -=item B<-item> I - -Attempt to decode and print the data as an B I. This can be -used to print out the fields of any supported ASN.1 structure if the type is -known. - -=back - -=head2 Output - -The output will typically contain lines like this: - - 0:d=0 hl=4 l= 681 cons: SEQUENCE - -..... - - 229:d=3 hl=3 l= 141 prim: BIT STRING - 373:d=2 hl=3 l= 162 cons: cont [ 3 ] - 376:d=3 hl=3 l= 159 cons: SEQUENCE - 379:d=4 hl=2 l= 29 cons: SEQUENCE - 381:d=5 hl=2 l= 3 prim: OBJECT :X509v3 Subject Key Identifier - 386:d=5 hl=2 l= 22 prim: OCTET STRING - 410:d=4 hl=2 l= 112 cons: SEQUENCE - 412:d=5 hl=2 l= 3 prim: OBJECT :X509v3 Authority Key Identifier - 417:d=5 hl=2 l= 105 prim: OCTET STRING - 524:d=4 hl=2 l= 12 cons: SEQUENCE - -..... - -This example is part of a self-signed certificate. Each line starts with the -offset in decimal. C specifies the current depth. The depth is increased -within the scope of any SET or SEQUENCE. C gives the header length -(tag and length octets) of the current type. C gives the length of -the contents octets. - -The B<-i> option can be used to make the output more readable. - -Some knowledge of the ASN.1 structure is needed to interpret the output. - -In this example the BIT STRING at offset 229 is the certificate public key. -The contents octets of this will contain the public key information. This can -be examined using the option C<-strparse 229> to yield: - - 0:d=0 hl=3 l= 137 cons: SEQUENCE - 3:d=1 hl=3 l= 129 prim: INTEGER :E5D21E1F5C8D208EA7A2166C7FAF9F6BDF2059669C60876DDB70840F1A5AAFA59699FE471F379F1DD6A487E7D5409AB6A88D4A9746E24B91D8CF55DB3521015460C8EDE44EE8A4189F7A7BE77D6CD3A9AF2696F486855CF58BF0EDF2B4068058C7A947F52548DDF7E15E96B385F86422BEA9064A3EE9E1158A56E4A6F47E5897 - 135:d=1 hl=2 l= 3 prim: INTEGER :010001 - -=head1 NOTES - -If an OID is not part of OpenSSL's internal table it will be represented in -numerical form (for example 1.2.3.4). The file passed to the B<-oid> option -allows additional OIDs to be included. Each line consists of three columns, -the first column is the OID in numerical format and should be followed by white -space. The second column is the "short name" which is a single word followed -by white space. The final column is the rest of the line and is the -"long name". Example: - -C<1.2.3.4 shortName A long name> - -For any OID with an associated short and long name, this command will display -the long name. - -=head1 EXAMPLES - -Parse a file: - - openssl asn1parse -in file.pem - -Parse a DER file: - - openssl asn1parse -inform DER -in file.der - -Generate a simple UTF8String: - - openssl asn1parse -genstr 'UTF8:Hello World' - -Generate and write out a UTF8String, don't print parsed output: - - openssl asn1parse -genstr 'UTF8:Hello World' -noout -out utf8.der - -Generate using a config file: - - openssl asn1parse -genconf asn1.cnf -noout -out asn1.der - -Example config file: - - asn1=SEQUENCE:seq_sect - - [seq_sect] - - field1=BOOL:TRUE - field2=EXP:0, UTF8:some random string - - -=head1 BUGS - -There should be options to change the format of output lines. The output of some -ASN.1 types is not well handled (if at all). - -=head1 SEE ALSO - -L, -L - -=head1 COPYRIGHT - -Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-asn1parse.pod.in b/doc/man1/openssl-asn1parse.pod.in new file mode 100644 index 0000000000..9b95966440 --- /dev/null +++ b/doc/man1/openssl-asn1parse.pod.in @@ -0,0 +1,220 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-asn1parse - ASN.1 parsing tool + +=head1 SYNOPSIS + +B B +[B<-help>] +[B<-inform> B|B] +[B<-in> I] +[B<-out> I] +[B<-noout>] +[B<-offset> I] +[B<-length> I] +[B<-i>] +[B<-oid> I] +[B<-dump>] +[B<-dlimit> I] +[B<-strparse> I] +[B<-genstr> I] +[B<-genconf> I] +[B<-strictpem>] +[B<-item> I] + +=head1 DESCRIPTION + +This command is a diagnostic utility that can parse ASN.1 structures. +It can also be used to extract data from ASN.1 formatted data. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print out a usage message. + +=item B<-inform> B|B + +The input format; the default is B. +See L for details. + +=item B<-in> I + +The input file, default is standard input. + +=item B<-out> I + +Output file to place the DER encoded data into. If this +option is not present then no data will be output. This is most useful when +combined with the B<-strparse> option. + +=item B<-noout> + +Don't output the parsed version of the input file. + +=item B<-offset> I + +Starting offset to begin parsing, default is start of file. + +=item B<-length> I + +Number of bytes to parse, default is until end of file. + +=item B<-i> + +Indents the output according to the "depth" of the structures. + +=item B<-oid> I + +A file containing additional OBJECT IDENTIFIERs (OIDs). The format of this +file is described in the NOTES section below. + +=item B<-dump> + +Dump unknown data in hex format. + +=item B<-dlimit> I + +Like B<-dump>, but only the first B bytes are output. + +=item B<-strparse> I + +Parse the contents octets of the ASN.1 object starting at B. This +option can be used multiple times to "drill down" into a nested structure. + +=item B<-genstr> I, B<-genconf> I + +Generate encoded data based on I, I or both using +L format. If I only is +present then the string is obtained from the default section using the name +B. The encoded data is passed through the ASN1 parser and printed out as +though it came from a file, the contents can thus be examined and written to a +file using the B<-out> option. + +=item B<-strictpem> + +If this option is used then B<-inform> will be ignored. Without this option any +data in a PEM format input file will be treated as being base64 encoded and +processed whether it has the normal PEM BEGIN and END markers or not. This +option will ignore any data prior to the start of the BEGIN marker, or after an +END marker in a PEM file. + +=item B<-item> I + +Attempt to decode and print the data as an B I. This can be +used to print out the fields of any supported ASN.1 structure if the type is +known. + +=back + +=head2 Output + +The output will typically contain lines like this: + + 0:d=0 hl=4 l= 681 cons: SEQUENCE + +..... + + 229:d=3 hl=3 l= 141 prim: BIT STRING + 373:d=2 hl=3 l= 162 cons: cont [ 3 ] + 376:d=3 hl=3 l= 159 cons: SEQUENCE + 379:d=4 hl=2 l= 29 cons: SEQUENCE + 381:d=5 hl=2 l= 3 prim: OBJECT :X509v3 Subject Key Identifier + 386:d=5 hl=2 l= 22 prim: OCTET STRING + 410:d=4 hl=2 l= 112 cons: SEQUENCE + 412:d=5 hl=2 l= 3 prim: OBJECT :X509v3 Authority Key Identifier + 417:d=5 hl=2 l= 105 prim: OCTET STRING + 524:d=4 hl=2 l= 12 cons: SEQUENCE + +..... + +This example is part of a self-signed certificate. Each line starts with the +offset in decimal. C specifies the current depth. The depth is increased +within the scope of any SET or SEQUENCE. C gives the header length +(tag and length octets) of the current type. C gives the length of +the contents octets. + +The B<-i> option can be used to make the output more readable. + +Some knowledge of the ASN.1 structure is needed to interpret the output. + +In this example the BIT STRING at offset 229 is the certificate public key. +The contents octets of this will contain the public key information. This can +be examined using the option C<-strparse 229> to yield: + + 0:d=0 hl=3 l= 137 cons: SEQUENCE + 3:d=1 hl=3 l= 129 prim: INTEGER :E5D21E1F5C8D208EA7A2166C7FAF9F6BDF2059669C60876DDB70840F1A5AAFA59699FE471F379F1DD6A487E7D5409AB6A88D4A9746E24B91D8CF55DB3521015460C8EDE44EE8A4189F7A7BE77D6CD3A9AF2696F486855CF58BF0EDF2B4068058C7A947F52548DDF7E15E96B385F86422BEA9064A3EE9E1158A56E4A6F47E5897 + 135:d=1 hl=2 l= 3 prim: INTEGER :010001 + +=head1 NOTES + +If an OID is not part of OpenSSL's internal table it will be represented in +numerical form (for example 1.2.3.4). The file passed to the B<-oid> option +allows additional OIDs to be included. Each line consists of three columns, +the first column is the OID in numerical format and should be followed by white +space. The second column is the "short name" which is a single word followed +by white space. The final column is the rest of the line and is the +"long name". Example: + +C<1.2.3.4 shortName A long name> + +For any OID with an associated short and long name, this command will display +the long name. + +=head1 EXAMPLES + +Parse a file: + + openssl asn1parse -in file.pem + +Parse a DER file: + + openssl asn1parse -inform DER -in file.der + +Generate a simple UTF8String: + + openssl asn1parse -genstr 'UTF8:Hello World' + +Generate and write out a UTF8String, don't print parsed output: + + openssl asn1parse -genstr 'UTF8:Hello World' -noout -out utf8.der + +Generate using a config file: + + openssl asn1parse -genconf asn1.cnf -noout -out asn1.der + +Example config file: + + asn1=SEQUENCE:seq_sect + + [seq_sect] + + field1=BOOL:TRUE + field2=EXP:0, UTF8:some random string + + +=head1 BUGS + +There should be options to change the format of output lines. The output of some +ASN.1 types is not well handled (if at all). + +=head1 SEE ALSO + +L, +L + +=head1 COPYRIGHT + +Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-ciphers.pod b/doc/man1/openssl-ciphers.pod deleted file mode 100644 index 8ba80ba15d..0000000000 --- a/doc/man1/openssl-ciphers.pod +++ /dev/null @@ -1,781 +0,0 @@ -=pod - -=head1 NAME - -openssl-ciphers - SSL cipher display and cipher list tool - -=head1 SYNOPSIS - -B B -[B<-help>] -[B<-s>] -[B<-v>] -[B<-V>] -[B<-ssl3>] -[B<-tls1>] -[B<-tls1_1>] -[B<-tls1_2>] -[B<-tls1_3>] -[B<-s>] -[B<-psk>] -[B<-srp>] -[B<-stdname>] -[B<-convert> I] -[B<-ciphersuites> I] -[I] - -=for openssl ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3 psk srp - -=head1 DESCRIPTION - -This command converts textual OpenSSL cipher lists into -ordered SSL cipher preference lists. It can be used as a test tool to -determine the appropriate cipherlist. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print a usage message. - -=item B<-s> - -Only list supported ciphers: those consistent with the security level, and -minimum and maximum protocol version. This is closer to the actual cipher list -an application will support. - -PSK and SRP ciphers are not enabled by default: they require B<-psk> or B<-srp> -to enable them. - -It also does not change the default list of supported signature algorithms. - -On a server the list of supported ciphers might also exclude other ciphers -depending on the configured certificates and presence of DH parameters. - -If this option is not used then all ciphers that match the cipherlist will be -listed. - -=item B<-psk> - -When combined with B<-s> includes cipher suites which require PSK. - -=item B<-srp> - -When combined with B<-s> includes cipher suites which require SRP. - -=item B<-v> - -Verbose output: For each cipher suite, list details as provided by -L. - -=item B<-V> - -Like B<-v>, but include the official cipher suite values in hex. - -=item B<-tls1_3>, B<-tls1_2>, B<-tls1_1>, B<-tls1>, B<-ssl3> - -In combination with the B<-s> option, list the ciphers which could be used if -the specified protocol were negotiated. -Note that not all protocols and flags may be available, depending on how -OpenSSL was built. - -=item B<-stdname> - -Precede each cipher suite by its standard name. - -=item B<-convert> I - -Convert a standard cipher I to its OpenSSL name. - -=item B<-ciphersuites> I - -Sets the list of TLSv1.3 ciphersuites. This list will be combined with any -TLSv1.2 and below ciphersuites that have been configured. The format for this -list is a simple colon (":") separated list of TLSv1.3 ciphersuite names. By -default this value is: - - TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256 - -=item B - -A cipher list of TLSv1.2 and below ciphersuites to convert to a cipher -preference list. This list will be combined with any TLSv1.3 ciphersuites that -have been configured. If it is not included then the default cipher list will be -used. The format is described below. - -=back - -=head1 CIPHER LIST FORMAT - -The cipher list consists of one or more I separated by colons. -Commas or spaces are also acceptable separators but colons are normally used. - -The actual cipher string can take several different forms. - -It can consist of a single cipher suite such as B. - -It can represent a list of cipher suites containing a certain algorithm, or -cipher suites of a certain type. For example B represents all ciphers -suites using the digest algorithm SHA1 and B represents all SSL v3 -algorithms. - -Lists of cipher suites can be combined in a single cipher string using the -B<+> character. This is used as a logical B operation. For example -B represents all cipher suites containing the SHA1 B the DES -algorithms. - -Each cipher string can be optionally preceded by the characters B, -B<-> or B<+>. - -If B is used then the ciphers are permanently deleted from the list. -The ciphers deleted can never reappear in the list even if they are -explicitly stated. - -If B<-> is used then the ciphers are deleted from the list, but some or -all of the ciphers can be added again by later options. - -If B<+> is used then the ciphers are moved to the end of the list. This -option doesn't add any new ciphers it just moves matching existing ones. - -If none of these characters is present then the string is just interpreted -as a list of ciphers to be appended to the current preference list. If the -list includes any ciphers already present they will be ignored: that is they -will not moved to the end of the list. - -The cipher string B<@STRENGTH> can be used at any point to sort the current -cipher list in order of encryption algorithm key length. - -The cipher string B<@SECLEVEL>=I can be used at any point to set the security -level to I, which should be a number between zero and five, inclusive. -See L for a description of what each level means. - -The cipher list can be prefixed with the B keyword, which enables -the default cipher list as defined below. Unlike cipher strings, -this prefix may not be combined with other strings using B<+> character. -For example, B is not valid. - -The content of the default list is determined at compile time and normally -corresponds to B. - -=head1 CIPHER STRINGS - -The following is a list of all permitted cipher strings and their meanings. - -=over 4 - -=item B - -The ciphers included in B, but not enabled by default. Currently -this includes all RC4 and anonymous ciphers. Note that this rule does -not cover B, which is not included by B (use B if -necessary). Note that RC4 based cipher suites are not built into OpenSSL by -default (see the enable-weak-ssl-ciphers option to Configure). - -=item B - -All cipher suites except the B ciphers (which must be explicitly enabled -if needed). -As of OpenSSL 1.0.0, the B cipher suites are sensibly ordered by default. - -=item B - -The cipher suites not enabled by B, currently B. - -=item B - -"High" encryption cipher suites. This currently means those with key lengths -larger than 128 bits, and some cipher suites with 128-bit keys. - -=item B - -"Medium" encryption cipher suites, currently some of those using 128 bit -encryption. - -=item B - -"Low" encryption cipher suites, currently those using 64 or 56 bit -encryption algorithms but excluding export cipher suites. All these -cipher suites have been removed as of OpenSSL 1.1.0. - -=item B, B - -The "NULL" ciphers that is those offering no encryption. Because these offer no -encryption at all and are a security risk they are not enabled via either the -B or B cipher strings. -Be careful when building cipherlists out of lower-level primitives such as -B or B as these do overlap with the B ciphers. When in -doubt, include B in your cipherlist. - -=item B - -The cipher suites offering no authentication. This is currently the anonymous -DH algorithms and anonymous ECDH algorithms. These cipher suites are vulnerable -to "man in the middle" attacks and so their use is discouraged. -These are excluded from the B ciphers, but included in the B -ciphers. -Be careful when building cipherlists out of lower-level primitives such as -B or B as these do overlap with the B ciphers. -When in doubt, include B in your cipherlist. - -=item B, B, B - -Cipher suites using RSA key exchange or authentication. B is an alias for -B. - -=item B, B, B - -Cipher suites using static DH key agreement and DH certificates signed by CAs -with RSA and DSS keys or either respectively. -All these cipher suites have been removed in OpenSSL 1.1.0. - -=item B, B, B - -Cipher suites using ephemeral DH key agreement, including anonymous cipher -suites. - -=item B, B - -Cipher suites using authenticated ephemeral DH key agreement. - -=item B - -Anonymous DH cipher suites, note that this does not include anonymous Elliptic -Curve DH (ECDH) cipher suites. - -=item B, B, B - -Cipher suites using ephemeral ECDH key agreement, including anonymous -cipher suites. - -=item B, B - -Cipher suites using authenticated ephemeral ECDH key agreement. - -=item B - -Anonymous Elliptic Curve Diffie-Hellman cipher suites. - -=item B, B - -Cipher suites using DSS authentication, i.e. the certificates carry DSS keys. - -=item B - -Cipher suites effectively using DH authentication, i.e. the certificates carry -DH keys. -All these cipher suites have been removed in OpenSSL 1.1.0. - -=item B, B - -Cipher suites using ECDSA authentication, i.e. the certificates carry ECDSA -keys. - -=item B, B, B - -Lists cipher suites which are only supported in at least TLS v1.2, TLS v1.0 or -SSL v3.0 respectively. -Note: there are no cipher suites specific to TLS v1.1. -Since this is only the minimum version, if, for example, TLSv1.0 is negotiated -then both TLSv1.0 and SSLv3.0 cipher suites are available. - -Note: these cipher strings B change the negotiated version of SSL or -TLS, they only affect the list of available cipher suites. - -=item B, B, B - -cipher suites using 128 bit AES, 256 bit AES or either 128 or 256 bit AES. - -=item B - -AES in Galois Counter Mode (GCM): these cipher suites are only supported -in TLS v1.2. - -=item B, B - -AES in Cipher Block Chaining - Message Authentication Mode (CCM): these -cipher suites are only supported in TLS v1.2. B references CCM -cipher suites using both 16 and 8 octet Integrity Check Value (ICV) -while B only references 8 octet ICV. - -=item B, B, B - -Cipher suites using 128 bit ARIA, 256 bit ARIA or either 128 or 256 bit -ARIA. - -=item B, B, B - -Cipher suites using 128 bit CAMELLIA, 256 bit CAMELLIA or either 128 or 256 bit -CAMELLIA. - -=item B - -Cipher suites using ChaCha20. - -=item B<3DES> - -Cipher suites using triple DES. - -=item B - -Cipher suites using DES (not triple DES). -All these cipher suites have been removed in OpenSSL 1.1.0. - -=item B - -Cipher suites using RC4. - -=item B - -Cipher suites using RC2. - -=item B - -Cipher suites using IDEA. - -=item B - -Cipher suites using SEED. - -=item B - -Cipher suites using MD5. - -=item B, B - -Cipher suites using SHA1. - -=item B, B - -Cipher suites using SHA256 or SHA384. - -=item B - -Cipher suites using GOST R 34.10 (either 2001 or 94) for authentication -(needs an engine supporting GOST algorithms). - -=item B - -Cipher suites using GOST R 34.10-2001 authentication. - -=item B - -Cipher suites, using VKO 34.10 key exchange, specified in the RFC 4357. - -=item B - -Cipher suites, using HMAC based on GOST R 34.11-94. - -=item B - -Cipher suites using GOST 28147-89 MAC B HMAC. - -=item B - -All cipher suites using pre-shared keys (PSK). - -=item B, B, B, B - -Cipher suites using PSK key exchange, ECDHE_PSK, DHE_PSK or RSA_PSK. - -=item B - -Cipher suites using PSK authentication (currently all PSK modes apart from -RSA_PSK). - -=item B, B, B - -Enables suite B mode of operation using 128 (permitting 192 bit mode by peer) -128 bit (not permitting 192 bit by peer) or 192 bit level of security -respectively. -If used these cipherstrings should appear first in the cipher -list and anything after them is ignored. -Setting Suite B mode has additional consequences required to comply with -RFC6460. -In particular the supported signature algorithms is reduced to support only -ECDSA and SHA256 or SHA384, only the elliptic curves P-256 and P-384 can be -used and only the two suite B compliant cipher suites -(ECDHE-ECDSA-AES128-GCM-SHA256 and ECDHE-ECDSA-AES256-GCM-SHA384) are -permissible. - -=back - -=head1 CIPHER SUITE NAMES - -The following lists give the SSL or TLS cipher suites names from the -relevant specification and their OpenSSL equivalents. It should be noted, -that several cipher suite names do not include the authentication used, -e.g. DES-CBC3-SHA. In these cases, RSA authentication is used. - -=head2 SSL v3.0 cipher suites - - SSL_RSA_WITH_NULL_MD5 NULL-MD5 - SSL_RSA_WITH_NULL_SHA NULL-SHA - SSL_RSA_WITH_RC4_128_MD5 RC4-MD5 - SSL_RSA_WITH_RC4_128_SHA RC4-SHA - SSL_RSA_WITH_IDEA_CBC_SHA IDEA-CBC-SHA - SSL_RSA_WITH_3DES_EDE_CBC_SHA DES-CBC3-SHA - - SSL_DH_DSS_WITH_3DES_EDE_CBC_SHA DH-DSS-DES-CBC3-SHA - SSL_DH_RSA_WITH_3DES_EDE_CBC_SHA DH-RSA-DES-CBC3-SHA - SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA DHE-DSS-DES-CBC3-SHA - SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA DHE-RSA-DES-CBC3-SHA - - SSL_DH_anon_WITH_RC4_128_MD5 ADH-RC4-MD5 - SSL_DH_anon_WITH_3DES_EDE_CBC_SHA ADH-DES-CBC3-SHA - - SSL_FORTEZZA_KEA_WITH_NULL_SHA Not implemented. - SSL_FORTEZZA_KEA_WITH_FORTEZZA_CBC_SHA Not implemented. - SSL_FORTEZZA_KEA_WITH_RC4_128_SHA Not implemented. - -=head2 TLS v1.0 cipher suites - - TLS_RSA_WITH_NULL_MD5 NULL-MD5 - TLS_RSA_WITH_NULL_SHA NULL-SHA - TLS_RSA_WITH_RC4_128_MD5 RC4-MD5 - TLS_RSA_WITH_RC4_128_SHA RC4-SHA - TLS_RSA_WITH_IDEA_CBC_SHA IDEA-CBC-SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA DES-CBC3-SHA - - TLS_DH_DSS_WITH_3DES_EDE_CBC_SHA Not implemented. - TLS_DH_RSA_WITH_3DES_EDE_CBC_SHA Not implemented. - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA DHE-DSS-DES-CBC3-SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA DHE-RSA-DES-CBC3-SHA - - TLS_DH_anon_WITH_RC4_128_MD5 ADH-RC4-MD5 - TLS_DH_anon_WITH_3DES_EDE_CBC_SHA ADH-DES-CBC3-SHA - -=head2 AES cipher suites from RFC3268, extending TLS v1.0 - - TLS_RSA_WITH_AES_128_CBC_SHA AES128-SHA - TLS_RSA_WITH_AES_256_CBC_SHA AES256-SHA - - TLS_DH_DSS_WITH_AES_128_CBC_SHA DH-DSS-AES128-SHA - TLS_DH_DSS_WITH_AES_256_CBC_SHA DH-DSS-AES256-SHA - TLS_DH_RSA_WITH_AES_128_CBC_SHA DH-RSA-AES128-SHA - TLS_DH_RSA_WITH_AES_256_CBC_SHA DH-RSA-AES256-SHA - - TLS_DHE_DSS_WITH_AES_128_CBC_SHA DHE-DSS-AES128-SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA DHE-DSS-AES256-SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA DHE-RSA-AES128-SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA DHE-RSA-AES256-SHA - - TLS_DH_anon_WITH_AES_128_CBC_SHA ADH-AES128-SHA - TLS_DH_anon_WITH_AES_256_CBC_SHA ADH-AES256-SHA - -=head2 Camellia cipher suites from RFC4132, extending TLS v1.0 - - TLS_RSA_WITH_CAMELLIA_128_CBC_SHA CAMELLIA128-SHA - TLS_RSA_WITH_CAMELLIA_256_CBC_SHA CAMELLIA256-SHA - - TLS_DH_DSS_WITH_CAMELLIA_128_CBC_SHA DH-DSS-CAMELLIA128-SHA - TLS_DH_DSS_WITH_CAMELLIA_256_CBC_SHA DH-DSS-CAMELLIA256-SHA - TLS_DH_RSA_WITH_CAMELLIA_128_CBC_SHA DH-RSA-CAMELLIA128-SHA - TLS_DH_RSA_WITH_CAMELLIA_256_CBC_SHA DH-RSA-CAMELLIA256-SHA - - TLS_DHE_DSS_WITH_CAMELLIA_128_CBC_SHA DHE-DSS-CAMELLIA128-SHA - TLS_DHE_DSS_WITH_CAMELLIA_256_CBC_SHA DHE-DSS-CAMELLIA256-SHA - TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA DHE-RSA-CAMELLIA128-SHA - TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA DHE-RSA-CAMELLIA256-SHA - - TLS_DH_anon_WITH_CAMELLIA_128_CBC_SHA ADH-CAMELLIA128-SHA - TLS_DH_anon_WITH_CAMELLIA_256_CBC_SHA ADH-CAMELLIA256-SHA - -=head2 SEED cipher suites from RFC4162, extending TLS v1.0 - - TLS_RSA_WITH_SEED_CBC_SHA SEED-SHA - - TLS_DH_DSS_WITH_SEED_CBC_SHA DH-DSS-SEED-SHA - TLS_DH_RSA_WITH_SEED_CBC_SHA DH-RSA-SEED-SHA - - TLS_DHE_DSS_WITH_SEED_CBC_SHA DHE-DSS-SEED-SHA - TLS_DHE_RSA_WITH_SEED_CBC_SHA DHE-RSA-SEED-SHA - - TLS_DH_anon_WITH_SEED_CBC_SHA ADH-SEED-SHA - -=head2 GOST cipher suites from draft-chudov-cryptopro-cptls, extending TLS v1.0 - -Note: these ciphers require an engine which including GOST cryptographic -algorithms, such as the B engine, which isn't part of the OpenSSL -distribution. - - TLS_GOSTR341094_WITH_28147_CNT_IMIT GOST94-GOST89-GOST89 - TLS_GOSTR341001_WITH_28147_CNT_IMIT GOST2001-GOST89-GOST89 - TLS_GOSTR341094_WITH_NULL_GOSTR3411 GOST94-NULL-GOST94 - TLS_GOSTR341001_WITH_NULL_GOSTR3411 GOST2001-NULL-GOST94 - -=head2 Additional Export 1024 and other cipher suites - -Note: these ciphers can also be used in SSL v3. - - TLS_DHE_DSS_WITH_RC4_128_SHA DHE-DSS-RC4-SHA - -=head2 Elliptic curve cipher suites - - TLS_ECDHE_RSA_WITH_NULL_SHA ECDHE-RSA-NULL-SHA - TLS_ECDHE_RSA_WITH_RC4_128_SHA ECDHE-RSA-RC4-SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA ECDHE-RSA-DES-CBC3-SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA ECDHE-RSA-AES128-SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA ECDHE-RSA-AES256-SHA - - TLS_ECDHE_ECDSA_WITH_NULL_SHA ECDHE-ECDSA-NULL-SHA - TLS_ECDHE_ECDSA_WITH_RC4_128_SHA ECDHE-ECDSA-RC4-SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA ECDHE-ECDSA-DES-CBC3-SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA ECDHE-ECDSA-AES128-SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA ECDHE-ECDSA-AES256-SHA - - TLS_ECDH_anon_WITH_NULL_SHA AECDH-NULL-SHA - TLS_ECDH_anon_WITH_RC4_128_SHA AECDH-RC4-SHA - TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA AECDH-DES-CBC3-SHA - TLS_ECDH_anon_WITH_AES_128_CBC_SHA AECDH-AES128-SHA - TLS_ECDH_anon_WITH_AES_256_CBC_SHA AECDH-AES256-SHA - -=head2 TLS v1.2 cipher suites - - TLS_RSA_WITH_NULL_SHA256 NULL-SHA256 - - TLS_RSA_WITH_AES_128_CBC_SHA256 AES128-SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 AES256-SHA256 - TLS_RSA_WITH_AES_128_GCM_SHA256 AES128-GCM-SHA256 - TLS_RSA_WITH_AES_256_GCM_SHA384 AES256-GCM-SHA384 - - TLS_DH_RSA_WITH_AES_128_CBC_SHA256 DH-RSA-AES128-SHA256 - TLS_DH_RSA_WITH_AES_256_CBC_SHA256 DH-RSA-AES256-SHA256 - TLS_DH_RSA_WITH_AES_128_GCM_SHA256 DH-RSA-AES128-GCM-SHA256 - TLS_DH_RSA_WITH_AES_256_GCM_SHA384 DH-RSA-AES256-GCM-SHA384 - - TLS_DH_DSS_WITH_AES_128_CBC_SHA256 DH-DSS-AES128-SHA256 - TLS_DH_DSS_WITH_AES_256_CBC_SHA256 DH-DSS-AES256-SHA256 - TLS_DH_DSS_WITH_AES_128_GCM_SHA256 DH-DSS-AES128-GCM-SHA256 - TLS_DH_DSS_WITH_AES_256_GCM_SHA384 DH-DSS-AES256-GCM-SHA384 - - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 DHE-RSA-AES128-SHA256 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 DHE-RSA-AES256-SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 DHE-RSA-AES128-GCM-SHA256 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 DHE-RSA-AES256-GCM-SHA384 - - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 DHE-DSS-AES128-SHA256 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 DHE-DSS-AES256-SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 DHE-DSS-AES128-GCM-SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 DHE-DSS-AES256-GCM-SHA384 - - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 ECDHE-RSA-AES128-SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 ECDHE-RSA-AES256-SHA384 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 ECDHE-RSA-AES256-GCM-SHA384 - - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 ECDHE-ECDSA-AES128-SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 ECDHE-ECDSA-AES256-SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 ECDHE-ECDSA-AES128-GCM-SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 ECDHE-ECDSA-AES256-GCM-SHA384 - - TLS_DH_anon_WITH_AES_128_CBC_SHA256 ADH-AES128-SHA256 - TLS_DH_anon_WITH_AES_256_CBC_SHA256 ADH-AES256-SHA256 - TLS_DH_anon_WITH_AES_128_GCM_SHA256 ADH-AES128-GCM-SHA256 - TLS_DH_anon_WITH_AES_256_GCM_SHA384 ADH-AES256-GCM-SHA384 - - RSA_WITH_AES_128_CCM AES128-CCM - RSA_WITH_AES_256_CCM AES256-CCM - DHE_RSA_WITH_AES_128_CCM DHE-RSA-AES128-CCM - DHE_RSA_WITH_AES_256_CCM DHE-RSA-AES256-CCM - RSA_WITH_AES_128_CCM_8 AES128-CCM8 - RSA_WITH_AES_256_CCM_8 AES256-CCM8 - DHE_RSA_WITH_AES_128_CCM_8 DHE-RSA-AES128-CCM8 - DHE_RSA_WITH_AES_256_CCM_8 DHE-RSA-AES256-CCM8 - ECDHE_ECDSA_WITH_AES_128_CCM ECDHE-ECDSA-AES128-CCM - ECDHE_ECDSA_WITH_AES_256_CCM ECDHE-ECDSA-AES256-CCM - ECDHE_ECDSA_WITH_AES_128_CCM_8 ECDHE-ECDSA-AES128-CCM8 - ECDHE_ECDSA_WITH_AES_256_CCM_8 ECDHE-ECDSA-AES256-CCM8 - -=head2 ARIA cipher suites from RFC6209, extending TLS v1.2 - -Note: the CBC modes mentioned in this RFC are not supported. - - TLS_RSA_WITH_ARIA_128_GCM_SHA256 ARIA128-GCM-SHA256 - TLS_RSA_WITH_ARIA_256_GCM_SHA384 ARIA256-GCM-SHA384 - TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256 DHE-RSA-ARIA128-GCM-SHA256 - TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384 DHE-RSA-ARIA256-GCM-SHA384 - TLS_DHE_DSS_WITH_ARIA_128_GCM_SHA256 DHE-DSS-ARIA128-GCM-SHA256 - TLS_DHE_DSS_WITH_ARIA_256_GCM_SHA384 DHE-DSS-ARIA256-GCM-SHA384 - TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 ECDHE-ECDSA-ARIA128-GCM-SHA256 - TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 ECDHE-ECDSA-ARIA256-GCM-SHA384 - TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 ECDHE-ARIA128-GCM-SHA256 - TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 ECDHE-ARIA256-GCM-SHA384 - TLS_PSK_WITH_ARIA_128_GCM_SHA256 PSK-ARIA128-GCM-SHA256 - TLS_PSK_WITH_ARIA_256_GCM_SHA384 PSK-ARIA256-GCM-SHA384 - TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256 DHE-PSK-ARIA128-GCM-SHA256 - TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384 DHE-PSK-ARIA256-GCM-SHA384 - TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256 RSA-PSK-ARIA128-GCM-SHA256 - TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384 RSA-PSK-ARIA256-GCM-SHA384 - -=head2 Camellia HMAC-Based cipher suites from RFC6367, extending TLS v1.2 - - TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 ECDHE-ECDSA-CAMELLIA128-SHA256 - TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 ECDHE-ECDSA-CAMELLIA256-SHA384 - TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 ECDHE-RSA-CAMELLIA128-SHA256 - TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 ECDHE-RSA-CAMELLIA256-SHA384 - -=head2 Pre-shared keying (PSK) cipher suites - - PSK_WITH_NULL_SHA PSK-NULL-SHA - DHE_PSK_WITH_NULL_SHA DHE-PSK-NULL-SHA - RSA_PSK_WITH_NULL_SHA RSA-PSK-NULL-SHA - - PSK_WITH_RC4_128_SHA PSK-RC4-SHA - PSK_WITH_3DES_EDE_CBC_SHA PSK-3DES-EDE-CBC-SHA - PSK_WITH_AES_128_CBC_SHA PSK-AES128-CBC-SHA - PSK_WITH_AES_256_CBC_SHA PSK-AES256-CBC-SHA - - DHE_PSK_WITH_RC4_128_SHA DHE-PSK-RC4-SHA - DHE_PSK_WITH_3DES_EDE_CBC_SHA DHE-PSK-3DES-EDE-CBC-SHA - DHE_PSK_WITH_AES_128_CBC_SHA DHE-PSK-AES128-CBC-SHA - DHE_PSK_WITH_AES_256_CBC_SHA DHE-PSK-AES256-CBC-SHA - - RSA_PSK_WITH_RC4_128_SHA RSA-PSK-RC4-SHA - RSA_PSK_WITH_3DES_EDE_CBC_SHA RSA-PSK-3DES-EDE-CBC-SHA - RSA_PSK_WITH_AES_128_CBC_SHA RSA-PSK-AES128-CBC-SHA - RSA_PSK_WITH_AES_256_CBC_SHA RSA-PSK-AES256-CBC-SHA - - PSK_WITH_AES_128_GCM_SHA256 PSK-AES128-GCM-SHA256 - PSK_WITH_AES_256_GCM_SHA384 PSK-AES256-GCM-SHA384 - DHE_PSK_WITH_AES_128_GCM_SHA256 DHE-PSK-AES128-GCM-SHA256 - DHE_PSK_WITH_AES_256_GCM_SHA384 DHE-PSK-AES256-GCM-SHA384 - RSA_PSK_WITH_AES_128_GCM_SHA256 RSA-PSK-AES128-GCM-SHA256 - RSA_PSK_WITH_AES_256_GCM_SHA384 RSA-PSK-AES256-GCM-SHA384 - - PSK_WITH_AES_128_CBC_SHA256 PSK-AES128-CBC-SHA256 - PSK_WITH_AES_256_CBC_SHA384 PSK-AES256-CBC-SHA384 - PSK_WITH_NULL_SHA256 PSK-NULL-SHA256 - PSK_WITH_NULL_SHA384 PSK-NULL-SHA384 - DHE_PSK_WITH_AES_128_CBC_SHA256 DHE-PSK-AES128-CBC-SHA256 - DHE_PSK_WITH_AES_256_CBC_SHA384 DHE-PSK-AES256-CBC-SHA384 - DHE_PSK_WITH_NULL_SHA256 DHE-PSK-NULL-SHA256 - DHE_PSK_WITH_NULL_SHA384 DHE-PSK-NULL-SHA384 - RSA_PSK_WITH_AES_128_CBC_SHA256 RSA-PSK-AES128-CBC-SHA256 - RSA_PSK_WITH_AES_256_CBC_SHA384 RSA-PSK-AES256-CBC-SHA384 - RSA_PSK_WITH_NULL_SHA256 RSA-PSK-NULL-SHA256 - RSA_PSK_WITH_NULL_SHA384 RSA-PSK-NULL-SHA384 - PSK_WITH_AES_128_GCM_SHA256 PSK-AES128-GCM-SHA256 - PSK_WITH_AES_256_GCM_SHA384 PSK-AES256-GCM-SHA384 - - ECDHE_PSK_WITH_RC4_128_SHA ECDHE-PSK-RC4-SHA - ECDHE_PSK_WITH_3DES_EDE_CBC_SHA ECDHE-PSK-3DES-EDE-CBC-SHA - ECDHE_PSK_WITH_AES_128_CBC_SHA ECDHE-PSK-AES128-CBC-SHA - ECDHE_PSK_WITH_AES_256_CBC_SHA ECDHE-PSK-AES256-CBC-SHA - ECDHE_PSK_WITH_AES_128_CBC_SHA256 ECDHE-PSK-AES128-CBC-SHA256 - ECDHE_PSK_WITH_AES_256_CBC_SHA384 ECDHE-PSK-AES256-CBC-SHA384 - ECDHE_PSK_WITH_NULL_SHA ECDHE-PSK-NULL-SHA - ECDHE_PSK_WITH_NULL_SHA256 ECDHE-PSK-NULL-SHA256 - ECDHE_PSK_WITH_NULL_SHA384 ECDHE-PSK-NULL-SHA384 - - PSK_WITH_CAMELLIA_128_CBC_SHA256 PSK-CAMELLIA128-SHA256 - PSK_WITH_CAMELLIA_256_CBC_SHA384 PSK-CAMELLIA256-SHA384 - - DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 DHE-PSK-CAMELLIA128-SHA256 - DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 DHE-PSK-CAMELLIA256-SHA384 - - RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 RSA-PSK-CAMELLIA128-SHA256 - RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 RSA-PSK-CAMELLIA256-SHA384 - - ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 ECDHE-PSK-CAMELLIA128-SHA256 - ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 ECDHE-PSK-CAMELLIA256-SHA384 - - PSK_WITH_AES_128_CCM PSK-AES128-CCM - PSK_WITH_AES_256_CCM PSK-AES256-CCM - DHE_PSK_WITH_AES_128_CCM DHE-PSK-AES128-CCM - DHE_PSK_WITH_AES_256_CCM DHE-PSK-AES256-CCM - PSK_WITH_AES_128_CCM_8 PSK-AES128-CCM8 - PSK_WITH_AES_256_CCM_8 PSK-AES256-CCM8 - DHE_PSK_WITH_AES_128_CCM_8 DHE-PSK-AES128-CCM8 - DHE_PSK_WITH_AES_256_CCM_8 DHE-PSK-AES256-CCM8 - -=head2 ChaCha20-Poly1305 cipher suites, extending TLS v1.2 - - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 ECDHE-RSA-CHACHA20-POLY1305 - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 ECDHE-ECDSA-CHACHA20-POLY1305 - TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 DHE-RSA-CHACHA20-POLY1305 - TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 PSK-CHACHA20-POLY1305 - TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 ECDHE-PSK-CHACHA20-POLY1305 - TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 DHE-PSK-CHACHA20-POLY1305 - TLS_RSA_PSK_WITH_CHACHA20_POLY1305_SHA256 RSA-PSK-CHACHA20-POLY1305 - -=head2 TLS v1.3 cipher suites - - TLS_AES_128_GCM_SHA256 TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_CCM_SHA256 TLS_AES_128_CCM_SHA256 - TLS_AES_128_CCM_8_SHA256 TLS_AES_128_CCM_8_SHA256 - -=head2 Older names used by OpenSSL - -The following names are accepted by older releases: - - SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA EDH-RSA-DES-CBC3-SHA (DHE-RSA-DES-CBC3-SHA) - SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA EDH-DSS-DES-CBC3-SHA (DHE-DSS-DES-CBC3-SHA) - -=head1 NOTES - -Some compiled versions of OpenSSL may not include all the ciphers -listed here because some ciphers were excluded at compile time. - -=head1 EXAMPLES - -Verbose listing of all OpenSSL ciphers including NULL ciphers: - - openssl ciphers -v 'ALL:eNULL' - -Include all ciphers except NULL and anonymous DH then sort by -strength: - - openssl ciphers -v 'ALL:!ADH:@STRENGTH' - -Include all ciphers except ones with no encryption (eNULL) or no -authentication (aNULL): - - openssl ciphers -v 'ALL:!aNULL' - -Include only 3DES ciphers and then place RSA ciphers last: - - openssl ciphers -v '3DES:+RSA' - -Include all RC4 ciphers but leave out those without authentication: - - openssl ciphers -v 'RC4:!COMPLEMENTOFDEFAULT' - -Include all ciphers with RSA authentication but leave out ciphers without -encryption. - - openssl ciphers -v 'RSA:!COMPLEMENTOFALL' - -Set security level to 2 and display all ciphers consistent with level 2: - - openssl ciphers -s -v 'ALL:@SECLEVEL=2' - -=head1 SEE ALSO - -L, -L, -L, -L - -=head1 HISTORY - -The B<-V> option was added in OpenSSL 1.0.0. - -The B<-stdname> is only available if OpenSSL is built with tracing enabled -(B argument to Configure) before OpenSSL 1.1.1. - -The B<-convert> option was added in OpenSSL 1.1.1. - -=head1 COPYRIGHT - -Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-ciphers.pod.in b/doc/man1/openssl-ciphers.pod.in new file mode 100644 index 0000000000..5997b6d543 --- /dev/null +++ b/doc/man1/openssl-ciphers.pod.in @@ -0,0 +1,782 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-ciphers - SSL cipher display and cipher list tool + +=head1 SYNOPSIS + +B B +[B<-help>] +[B<-s>] +[B<-v>] +[B<-V>] +[B<-ssl3>] +[B<-tls1>] +[B<-tls1_1>] +[B<-tls1_2>] +[B<-tls1_3>] +[B<-s>] +[B<-psk>] +[B<-srp>] +[B<-stdname>] +[B<-convert> I] +[B<-ciphersuites> I] +[I] + +=for openssl ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3 psk srp + +=head1 DESCRIPTION + +This command converts textual OpenSSL cipher lists into +ordered SSL cipher preference lists. It can be used as a test tool to +determine the appropriate cipherlist. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print a usage message. + +=item B<-s> + +Only list supported ciphers: those consistent with the security level, and +minimum and maximum protocol version. This is closer to the actual cipher list +an application will support. + +PSK and SRP ciphers are not enabled by default: they require B<-psk> or B<-srp> +to enable them. + +It also does not change the default list of supported signature algorithms. + +On a server the list of supported ciphers might also exclude other ciphers +depending on the configured certificates and presence of DH parameters. + +If this option is not used then all ciphers that match the cipherlist will be +listed. + +=item B<-psk> + +When combined with B<-s> includes cipher suites which require PSK. + +=item B<-srp> + +When combined with B<-s> includes cipher suites which require SRP. + +=item B<-v> + +Verbose output: For each cipher suite, list details as provided by +L. + +=item B<-V> + +Like B<-v>, but include the official cipher suite values in hex. + +=item B<-tls1_3>, B<-tls1_2>, B<-tls1_1>, B<-tls1>, B<-ssl3> + +In combination with the B<-s> option, list the ciphers which could be used if +the specified protocol were negotiated. +Note that not all protocols and flags may be available, depending on how +OpenSSL was built. + +=item B<-stdname> + +Precede each cipher suite by its standard name. + +=item B<-convert> I + +Convert a standard cipher I to its OpenSSL name. + +=item B<-ciphersuites> I + +Sets the list of TLSv1.3 ciphersuites. This list will be combined with any +TLSv1.2 and below ciphersuites that have been configured. The format for this +list is a simple colon (":") separated list of TLSv1.3 ciphersuite names. By +default this value is: + + TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256 + +=item B + +A cipher list of TLSv1.2 and below ciphersuites to convert to a cipher +preference list. This list will be combined with any TLSv1.3 ciphersuites that +have been configured. If it is not included then the default cipher list will be +used. The format is described below. + +=back + +=head1 CIPHER LIST FORMAT + +The cipher list consists of one or more I separated by colons. +Commas or spaces are also acceptable separators but colons are normally used. + +The actual cipher string can take several different forms. + +It can consist of a single cipher suite such as B. + +It can represent a list of cipher suites containing a certain algorithm, or +cipher suites of a certain type. For example B represents all ciphers +suites using the digest algorithm SHA1 and B represents all SSL v3 +algorithms. + +Lists of cipher suites can be combined in a single cipher string using the +B<+> character. This is used as a logical B operation. For example +B represents all cipher suites containing the SHA1 B the DES +algorithms. + +Each cipher string can be optionally preceded by the characters B, +B<-> or B<+>. + +If B is used then the ciphers are permanently deleted from the list. +The ciphers deleted can never reappear in the list even if they are +explicitly stated. + +If B<-> is used then the ciphers are deleted from the list, but some or +all of the ciphers can be added again by later options. + +If B<+> is used then the ciphers are moved to the end of the list. This +option doesn't add any new ciphers it just moves matching existing ones. + +If none of these characters is present then the string is just interpreted +as a list of ciphers to be appended to the current preference list. If the +list includes any ciphers already present they will be ignored: that is they +will not moved to the end of the list. + +The cipher string B<@STRENGTH> can be used at any point to sort the current +cipher list in order of encryption algorithm key length. + +The cipher string B<@SECLEVEL>=I can be used at any point to set the security +level to I, which should be a number between zero and five, inclusive. +See L for a description of what each level means. + +The cipher list can be prefixed with the B keyword, which enables +the default cipher list as defined below. Unlike cipher strings, +this prefix may not be combined with other strings using B<+> character. +For example, B is not valid. + +The content of the default list is determined at compile time and normally +corresponds to B. + +=head1 CIPHER STRINGS + +The following is a list of all permitted cipher strings and their meanings. + +=over 4 + +=item B + +The ciphers included in B, but not enabled by default. Currently +this includes all RC4 and anonymous ciphers. Note that this rule does +not cover B, which is not included by B (use B if +necessary). Note that RC4 based cipher suites are not built into OpenSSL by +default (see the enable-weak-ssl-ciphers option to Configure). + +=item B + +All cipher suites except the B ciphers (which must be explicitly enabled +if needed). +As of OpenSSL 1.0.0, the B cipher suites are sensibly ordered by default. + +=item B + +The cipher suites not enabled by B, currently B. + +=item B + +"High" encryption cipher suites. This currently means those with key lengths +larger than 128 bits, and some cipher suites with 128-bit keys. + +=item B + +"Medium" encryption cipher suites, currently some of those using 128 bit +encryption. + +=item B + +"Low" encryption cipher suites, currently those using 64 or 56 bit +encryption algorithms but excluding export cipher suites. All these +cipher suites have been removed as of OpenSSL 1.1.0. + +=item B, B + +The "NULL" ciphers that is those offering no encryption. Because these offer no +encryption at all and are a security risk they are not enabled via either the +B or B cipher strings. +Be careful when building cipherlists out of lower-level primitives such as +B or B as these do overlap with the B ciphers. When in +doubt, include B in your cipherlist. + +=item B + +The cipher suites offering no authentication. This is currently the anonymous +DH algorithms and anonymous ECDH algorithms. These cipher suites are vulnerable +to "man in the middle" attacks and so their use is discouraged. +These are excluded from the B ciphers, but included in the B +ciphers. +Be careful when building cipherlists out of lower-level primitives such as +B or B as these do overlap with the B ciphers. +When in doubt, include B in your cipherlist. + +=item B, B, B + +Cipher suites using RSA key exchange or authentication. B is an alias for +B. + +=item B, B, B + +Cipher suites using static DH key agreement and DH certificates signed by CAs +with RSA and DSS keys or either respectively. +All these cipher suites have been removed in OpenSSL 1.1.0. + +=item B, B, B + +Cipher suites using ephemeral DH key agreement, including anonymous cipher +suites. + +=item B, B + +Cipher suites using authenticated ephemeral DH key agreement. + +=item B + +Anonymous DH cipher suites, note that this does not include anonymous Elliptic +Curve DH (ECDH) cipher suites. + +=item B, B, B + +Cipher suites using ephemeral ECDH key agreement, including anonymous +cipher suites. + +=item B, B + +Cipher suites using authenticated ephemeral ECDH key agreement. + +=item B + +Anonymous Elliptic Curve Diffie-Hellman cipher suites. + +=item B, B + +Cipher suites using DSS authentication, i.e. the certificates carry DSS keys. + +=item B + +Cipher suites effectively using DH authentication, i.e. the certificates carry +DH keys. +All these cipher suites have been removed in OpenSSL 1.1.0. + +=item B, B + +Cipher suites using ECDSA authentication, i.e. the certificates carry ECDSA +keys. + +=item B, B, B + +Lists cipher suites which are only supported in at least TLS v1.2, TLS v1.0 or +SSL v3.0 respectively. +Note: there are no cipher suites specific to TLS v1.1. +Since this is only the minimum version, if, for example, TLSv1.0 is negotiated +then both TLSv1.0 and SSLv3.0 cipher suites are available. + +Note: these cipher strings B change the negotiated version of SSL or +TLS, they only affect the list of available cipher suites. + +=item B, B, B + +cipher suites using 128 bit AES, 256 bit AES or either 128 or 256 bit AES. + +=item B + +AES in Galois Counter Mode (GCM): these cipher suites are only supported +in TLS v1.2. + +=item B, B + +AES in Cipher Block Chaining - Message Authentication Mode (CCM): these +cipher suites are only supported in TLS v1.2. B references CCM +cipher suites using both 16 and 8 octet Integrity Check Value (ICV) +while B only references 8 octet ICV. + +=item B, B, B + +Cipher suites using 128 bit ARIA, 256 bit ARIA or either 128 or 256 bit +ARIA. + +=item B, B, B + +Cipher suites using 128 bit CAMELLIA, 256 bit CAMELLIA or either 128 or 256 bit +CAMELLIA. + +=item B + +Cipher suites using ChaCha20. + +=item B<3DES> + +Cipher suites using triple DES. + +=item B + +Cipher suites using DES (not triple DES). +All these cipher suites have been removed in OpenSSL 1.1.0. + +=item B + +Cipher suites using RC4. + +=item B + +Cipher suites using RC2. + +=item B + +Cipher suites using IDEA. + +=item B + +Cipher suites using SEED. + +=item B + +Cipher suites using MD5. + +=item B, B + +Cipher suites using SHA1. + +=item B, B + +Cipher suites using SHA256 or SHA384. + +=item B + +Cipher suites using GOST R 34.10 (either 2001 or 94) for authentication +(needs an engine supporting GOST algorithms). + +=item B + +Cipher suites using GOST R 34.10-2001 authentication. + +=item B + +Cipher suites, using VKO 34.10 key exchange, specified in the RFC 4357. + +=item B + +Cipher suites, using HMAC based on GOST R 34.11-94. + +=item B + +Cipher suites using GOST 28147-89 MAC B HMAC. + +=item B + +All cipher suites using pre-shared keys (PSK). + +=item B, B, B, B + +Cipher suites using PSK key exchange, ECDHE_PSK, DHE_PSK or RSA_PSK. + +=item B + +Cipher suites using PSK authentication (currently all PSK modes apart from +RSA_PSK). + +=item B, B, B + +Enables suite B mode of operation using 128 (permitting 192 bit mode by peer) +128 bit (not permitting 192 bit by peer) or 192 bit level of security +respectively. +If used these cipherstrings should appear first in the cipher +list and anything after them is ignored. +Setting Suite B mode has additional consequences required to comply with +RFC6460. +In particular the supported signature algorithms is reduced to support only +ECDSA and SHA256 or SHA384, only the elliptic curves P-256 and P-384 can be +used and only the two suite B compliant cipher suites +(ECDHE-ECDSA-AES128-GCM-SHA256 and ECDHE-ECDSA-AES256-GCM-SHA384) are +permissible. + +=back + +=head1 CIPHER SUITE NAMES + +The following lists give the SSL or TLS cipher suites names from the +relevant specification and their OpenSSL equivalents. It should be noted, +that several cipher suite names do not include the authentication used, +e.g. DES-CBC3-SHA. In these cases, RSA authentication is used. + +=head2 SSL v3.0 cipher suites + + SSL_RSA_WITH_NULL_MD5 NULL-MD5 + SSL_RSA_WITH_NULL_SHA NULL-SHA + SSL_RSA_WITH_RC4_128_MD5 RC4-MD5 + SSL_RSA_WITH_RC4_128_SHA RC4-SHA + SSL_RSA_WITH_IDEA_CBC_SHA IDEA-CBC-SHA + SSL_RSA_WITH_3DES_EDE_CBC_SHA DES-CBC3-SHA + + SSL_DH_DSS_WITH_3DES_EDE_CBC_SHA DH-DSS-DES-CBC3-SHA + SSL_DH_RSA_WITH_3DES_EDE_CBC_SHA DH-RSA-DES-CBC3-SHA + SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA DHE-DSS-DES-CBC3-SHA + SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA DHE-RSA-DES-CBC3-SHA + + SSL_DH_anon_WITH_RC4_128_MD5 ADH-RC4-MD5 + SSL_DH_anon_WITH_3DES_EDE_CBC_SHA ADH-DES-CBC3-SHA + + SSL_FORTEZZA_KEA_WITH_NULL_SHA Not implemented. + SSL_FORTEZZA_KEA_WITH_FORTEZZA_CBC_SHA Not implemented. + SSL_FORTEZZA_KEA_WITH_RC4_128_SHA Not implemented. + +=head2 TLS v1.0 cipher suites + + TLS_RSA_WITH_NULL_MD5 NULL-MD5 + TLS_RSA_WITH_NULL_SHA NULL-SHA + TLS_RSA_WITH_RC4_128_MD5 RC4-MD5 + TLS_RSA_WITH_RC4_128_SHA RC4-SHA + TLS_RSA_WITH_IDEA_CBC_SHA IDEA-CBC-SHA + TLS_RSA_WITH_3DES_EDE_CBC_SHA DES-CBC3-SHA + + TLS_DH_DSS_WITH_3DES_EDE_CBC_SHA Not implemented. + TLS_DH_RSA_WITH_3DES_EDE_CBC_SHA Not implemented. + TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA DHE-DSS-DES-CBC3-SHA + TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA DHE-RSA-DES-CBC3-SHA + + TLS_DH_anon_WITH_RC4_128_MD5 ADH-RC4-MD5 + TLS_DH_anon_WITH_3DES_EDE_CBC_SHA ADH-DES-CBC3-SHA + +=head2 AES cipher suites from RFC3268, extending TLS v1.0 + + TLS_RSA_WITH_AES_128_CBC_SHA AES128-SHA + TLS_RSA_WITH_AES_256_CBC_SHA AES256-SHA + + TLS_DH_DSS_WITH_AES_128_CBC_SHA DH-DSS-AES128-SHA + TLS_DH_DSS_WITH_AES_256_CBC_SHA DH-DSS-AES256-SHA + TLS_DH_RSA_WITH_AES_128_CBC_SHA DH-RSA-AES128-SHA + TLS_DH_RSA_WITH_AES_256_CBC_SHA DH-RSA-AES256-SHA + + TLS_DHE_DSS_WITH_AES_128_CBC_SHA DHE-DSS-AES128-SHA + TLS_DHE_DSS_WITH_AES_256_CBC_SHA DHE-DSS-AES256-SHA + TLS_DHE_RSA_WITH_AES_128_CBC_SHA DHE-RSA-AES128-SHA + TLS_DHE_RSA_WITH_AES_256_CBC_SHA DHE-RSA-AES256-SHA + + TLS_DH_anon_WITH_AES_128_CBC_SHA ADH-AES128-SHA + TLS_DH_anon_WITH_AES_256_CBC_SHA ADH-AES256-SHA + +=head2 Camellia cipher suites from RFC4132, extending TLS v1.0 + + TLS_RSA_WITH_CAMELLIA_128_CBC_SHA CAMELLIA128-SHA + TLS_RSA_WITH_CAMELLIA_256_CBC_SHA CAMELLIA256-SHA + + TLS_DH_DSS_WITH_CAMELLIA_128_CBC_SHA DH-DSS-CAMELLIA128-SHA + TLS_DH_DSS_WITH_CAMELLIA_256_CBC_SHA DH-DSS-CAMELLIA256-SHA + TLS_DH_RSA_WITH_CAMELLIA_128_CBC_SHA DH-RSA-CAMELLIA128-SHA + TLS_DH_RSA_WITH_CAMELLIA_256_CBC_SHA DH-RSA-CAMELLIA256-SHA + + TLS_DHE_DSS_WITH_CAMELLIA_128_CBC_SHA DHE-DSS-CAMELLIA128-SHA + TLS_DHE_DSS_WITH_CAMELLIA_256_CBC_SHA DHE-DSS-CAMELLIA256-SHA + TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA DHE-RSA-CAMELLIA128-SHA + TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA DHE-RSA-CAMELLIA256-SHA + + TLS_DH_anon_WITH_CAMELLIA_128_CBC_SHA ADH-CAMELLIA128-SHA + TLS_DH_anon_WITH_CAMELLIA_256_CBC_SHA ADH-CAMELLIA256-SHA + +=head2 SEED cipher suites from RFC4162, extending TLS v1.0 + + TLS_RSA_WITH_SEED_CBC_SHA SEED-SHA + + TLS_DH_DSS_WITH_SEED_CBC_SHA DH-DSS-SEED-SHA + TLS_DH_RSA_WITH_SEED_CBC_SHA DH-RSA-SEED-SHA + + TLS_DHE_DSS_WITH_SEED_CBC_SHA DHE-DSS-SEED-SHA + TLS_DHE_RSA_WITH_SEED_CBC_SHA DHE-RSA-SEED-SHA + + TLS_DH_anon_WITH_SEED_CBC_SHA ADH-SEED-SHA + +=head2 GOST cipher suites from draft-chudov-cryptopro-cptls, extending TLS v1.0 + +Note: these ciphers require an engine which including GOST cryptographic +algorithms, such as the B engine, which isn't part of the OpenSSL +distribution. + + TLS_GOSTR341094_WITH_28147_CNT_IMIT GOST94-GOST89-GOST89 + TLS_GOSTR341001_WITH_28147_CNT_IMIT GOST2001-GOST89-GOST89 + TLS_GOSTR341094_WITH_NULL_GOSTR3411 GOST94-NULL-GOST94 + TLS_GOSTR341001_WITH_NULL_GOSTR3411 GOST2001-NULL-GOST94 + +=head2 Additional Export 1024 and other cipher suites + +Note: these ciphers can also be used in SSL v3. + + TLS_DHE_DSS_WITH_RC4_128_SHA DHE-DSS-RC4-SHA + +=head2 Elliptic curve cipher suites + + TLS_ECDHE_RSA_WITH_NULL_SHA ECDHE-RSA-NULL-SHA + TLS_ECDHE_RSA_WITH_RC4_128_SHA ECDHE-RSA-RC4-SHA + TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA ECDHE-RSA-DES-CBC3-SHA + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA ECDHE-RSA-AES128-SHA + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA ECDHE-RSA-AES256-SHA + + TLS_ECDHE_ECDSA_WITH_NULL_SHA ECDHE-ECDSA-NULL-SHA + TLS_ECDHE_ECDSA_WITH_RC4_128_SHA ECDHE-ECDSA-RC4-SHA + TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA ECDHE-ECDSA-DES-CBC3-SHA + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA ECDHE-ECDSA-AES128-SHA + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA ECDHE-ECDSA-AES256-SHA + + TLS_ECDH_anon_WITH_NULL_SHA AECDH-NULL-SHA + TLS_ECDH_anon_WITH_RC4_128_SHA AECDH-RC4-SHA + TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA AECDH-DES-CBC3-SHA + TLS_ECDH_anon_WITH_AES_128_CBC_SHA AECDH-AES128-SHA + TLS_ECDH_anon_WITH_AES_256_CBC_SHA AECDH-AES256-SHA + +=head2 TLS v1.2 cipher suites + + TLS_RSA_WITH_NULL_SHA256 NULL-SHA256 + + TLS_RSA_WITH_AES_128_CBC_SHA256 AES128-SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA256 AES256-SHA256 + TLS_RSA_WITH_AES_128_GCM_SHA256 AES128-GCM-SHA256 + TLS_RSA_WITH_AES_256_GCM_SHA384 AES256-GCM-SHA384 + + TLS_DH_RSA_WITH_AES_128_CBC_SHA256 DH-RSA-AES128-SHA256 + TLS_DH_RSA_WITH_AES_256_CBC_SHA256 DH-RSA-AES256-SHA256 + TLS_DH_RSA_WITH_AES_128_GCM_SHA256 DH-RSA-AES128-GCM-SHA256 + TLS_DH_RSA_WITH_AES_256_GCM_SHA384 DH-RSA-AES256-GCM-SHA384 + + TLS_DH_DSS_WITH_AES_128_CBC_SHA256 DH-DSS-AES128-SHA256 + TLS_DH_DSS_WITH_AES_256_CBC_SHA256 DH-DSS-AES256-SHA256 + TLS_DH_DSS_WITH_AES_128_GCM_SHA256 DH-DSS-AES128-GCM-SHA256 + TLS_DH_DSS_WITH_AES_256_GCM_SHA384 DH-DSS-AES256-GCM-SHA384 + + TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 DHE-RSA-AES128-SHA256 + TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 DHE-RSA-AES256-SHA256 + TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 DHE-RSA-AES128-GCM-SHA256 + TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 DHE-RSA-AES256-GCM-SHA384 + + TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 DHE-DSS-AES128-SHA256 + TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 DHE-DSS-AES256-SHA256 + TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 DHE-DSS-AES128-GCM-SHA256 + TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 DHE-DSS-AES256-GCM-SHA384 + + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 ECDHE-RSA-AES128-SHA256 + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 ECDHE-RSA-AES256-SHA384 + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 + TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 ECDHE-RSA-AES256-GCM-SHA384 + + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 ECDHE-ECDSA-AES128-SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 ECDHE-ECDSA-AES256-SHA384 + TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 ECDHE-ECDSA-AES128-GCM-SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 ECDHE-ECDSA-AES256-GCM-SHA384 + + TLS_DH_anon_WITH_AES_128_CBC_SHA256 ADH-AES128-SHA256 + TLS_DH_anon_WITH_AES_256_CBC_SHA256 ADH-AES256-SHA256 + TLS_DH_anon_WITH_AES_128_GCM_SHA256 ADH-AES128-GCM-SHA256 + TLS_DH_anon_WITH_AES_256_GCM_SHA384 ADH-AES256-GCM-SHA384 + + RSA_WITH_AES_128_CCM AES128-CCM + RSA_WITH_AES_256_CCM AES256-CCM + DHE_RSA_WITH_AES_128_CCM DHE-RSA-AES128-CCM + DHE_RSA_WITH_AES_256_CCM DHE-RSA-AES256-CCM + RSA_WITH_AES_128_CCM_8 AES128-CCM8 + RSA_WITH_AES_256_CCM_8 AES256-CCM8 + DHE_RSA_WITH_AES_128_CCM_8 DHE-RSA-AES128-CCM8 + DHE_RSA_WITH_AES_256_CCM_8 DHE-RSA-AES256-CCM8 + ECDHE_ECDSA_WITH_AES_128_CCM ECDHE-ECDSA-AES128-CCM + ECDHE_ECDSA_WITH_AES_256_CCM ECDHE-ECDSA-AES256-CCM + ECDHE_ECDSA_WITH_AES_128_CCM_8 ECDHE-ECDSA-AES128-CCM8 + ECDHE_ECDSA_WITH_AES_256_CCM_8 ECDHE-ECDSA-AES256-CCM8 + +=head2 ARIA cipher suites from RFC6209, extending TLS v1.2 + +Note: the CBC modes mentioned in this RFC are not supported. + + TLS_RSA_WITH_ARIA_128_GCM_SHA256 ARIA128-GCM-SHA256 + TLS_RSA_WITH_ARIA_256_GCM_SHA384 ARIA256-GCM-SHA384 + TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256 DHE-RSA-ARIA128-GCM-SHA256 + TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384 DHE-RSA-ARIA256-GCM-SHA384 + TLS_DHE_DSS_WITH_ARIA_128_GCM_SHA256 DHE-DSS-ARIA128-GCM-SHA256 + TLS_DHE_DSS_WITH_ARIA_256_GCM_SHA384 DHE-DSS-ARIA256-GCM-SHA384 + TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 ECDHE-ECDSA-ARIA128-GCM-SHA256 + TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 ECDHE-ECDSA-ARIA256-GCM-SHA384 + TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 ECDHE-ARIA128-GCM-SHA256 + TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 ECDHE-ARIA256-GCM-SHA384 + TLS_PSK_WITH_ARIA_128_GCM_SHA256 PSK-ARIA128-GCM-SHA256 + TLS_PSK_WITH_ARIA_256_GCM_SHA384 PSK-ARIA256-GCM-SHA384 + TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256 DHE-PSK-ARIA128-GCM-SHA256 + TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384 DHE-PSK-ARIA256-GCM-SHA384 + TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256 RSA-PSK-ARIA128-GCM-SHA256 + TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384 RSA-PSK-ARIA256-GCM-SHA384 + +=head2 Camellia HMAC-Based cipher suites from RFC6367, extending TLS v1.2 + + TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 ECDHE-ECDSA-CAMELLIA128-SHA256 + TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 ECDHE-ECDSA-CAMELLIA256-SHA384 + TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 ECDHE-RSA-CAMELLIA128-SHA256 + TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 ECDHE-RSA-CAMELLIA256-SHA384 + +=head2 Pre-shared keying (PSK) cipher suites + + PSK_WITH_NULL_SHA PSK-NULL-SHA + DHE_PSK_WITH_NULL_SHA DHE-PSK-NULL-SHA + RSA_PSK_WITH_NULL_SHA RSA-PSK-NULL-SHA + + PSK_WITH_RC4_128_SHA PSK-RC4-SHA + PSK_WITH_3DES_EDE_CBC_SHA PSK-3DES-EDE-CBC-SHA + PSK_WITH_AES_128_CBC_SHA PSK-AES128-CBC-SHA + PSK_WITH_AES_256_CBC_SHA PSK-AES256-CBC-SHA + + DHE_PSK_WITH_RC4_128_SHA DHE-PSK-RC4-SHA + DHE_PSK_WITH_3DES_EDE_CBC_SHA DHE-PSK-3DES-EDE-CBC-SHA + DHE_PSK_WITH_AES_128_CBC_SHA DHE-PSK-AES128-CBC-SHA + DHE_PSK_WITH_AES_256_CBC_SHA DHE-PSK-AES256-CBC-SHA + + RSA_PSK_WITH_RC4_128_SHA RSA-PSK-RC4-SHA + RSA_PSK_WITH_3DES_EDE_CBC_SHA RSA-PSK-3DES-EDE-CBC-SHA + RSA_PSK_WITH_AES_128_CBC_SHA RSA-PSK-AES128-CBC-SHA + RSA_PSK_WITH_AES_256_CBC_SHA RSA-PSK-AES256-CBC-SHA + + PSK_WITH_AES_128_GCM_SHA256 PSK-AES128-GCM-SHA256 + PSK_WITH_AES_256_GCM_SHA384 PSK-AES256-GCM-SHA384 + DHE_PSK_WITH_AES_128_GCM_SHA256 DHE-PSK-AES128-GCM-SHA256 + DHE_PSK_WITH_AES_256_GCM_SHA384 DHE-PSK-AES256-GCM-SHA384 + RSA_PSK_WITH_AES_128_GCM_SHA256 RSA-PSK-AES128-GCM-SHA256 + RSA_PSK_WITH_AES_256_GCM_SHA384 RSA-PSK-AES256-GCM-SHA384 + + PSK_WITH_AES_128_CBC_SHA256 PSK-AES128-CBC-SHA256 + PSK_WITH_AES_256_CBC_SHA384 PSK-AES256-CBC-SHA384 + PSK_WITH_NULL_SHA256 PSK-NULL-SHA256 + PSK_WITH_NULL_SHA384 PSK-NULL-SHA384 + DHE_PSK_WITH_AES_128_CBC_SHA256 DHE-PSK-AES128-CBC-SHA256 + DHE_PSK_WITH_AES_256_CBC_SHA384 DHE-PSK-AES256-CBC-SHA384 + DHE_PSK_WITH_NULL_SHA256 DHE-PSK-NULL-SHA256 + DHE_PSK_WITH_NULL_SHA384 DHE-PSK-NULL-SHA384 + RSA_PSK_WITH_AES_128_CBC_SHA256 RSA-PSK-AES128-CBC-SHA256 + RSA_PSK_WITH_AES_256_CBC_SHA384 RSA-PSK-AES256-CBC-SHA384 + RSA_PSK_WITH_NULL_SHA256 RSA-PSK-NULL-SHA256 + RSA_PSK_WITH_NULL_SHA384 RSA-PSK-NULL-SHA384 + PSK_WITH_AES_128_GCM_SHA256 PSK-AES128-GCM-SHA256 + PSK_WITH_AES_256_GCM_SHA384 PSK-AES256-GCM-SHA384 + + ECDHE_PSK_WITH_RC4_128_SHA ECDHE-PSK-RC4-SHA + ECDHE_PSK_WITH_3DES_EDE_CBC_SHA ECDHE-PSK-3DES-EDE-CBC-SHA + ECDHE_PSK_WITH_AES_128_CBC_SHA ECDHE-PSK-AES128-CBC-SHA + ECDHE_PSK_WITH_AES_256_CBC_SHA ECDHE-PSK-AES256-CBC-SHA + ECDHE_PSK_WITH_AES_128_CBC_SHA256 ECDHE-PSK-AES128-CBC-SHA256 + ECDHE_PSK_WITH_AES_256_CBC_SHA384 ECDHE-PSK-AES256-CBC-SHA384 + ECDHE_PSK_WITH_NULL_SHA ECDHE-PSK-NULL-SHA + ECDHE_PSK_WITH_NULL_SHA256 ECDHE-PSK-NULL-SHA256 + ECDHE_PSK_WITH_NULL_SHA384 ECDHE-PSK-NULL-SHA384 + + PSK_WITH_CAMELLIA_128_CBC_SHA256 PSK-CAMELLIA128-SHA256 + PSK_WITH_CAMELLIA_256_CBC_SHA384 PSK-CAMELLIA256-SHA384 + + DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 DHE-PSK-CAMELLIA128-SHA256 + DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 DHE-PSK-CAMELLIA256-SHA384 + + RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 RSA-PSK-CAMELLIA128-SHA256 + RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 RSA-PSK-CAMELLIA256-SHA384 + + ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 ECDHE-PSK-CAMELLIA128-SHA256 + ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 ECDHE-PSK-CAMELLIA256-SHA384 + + PSK_WITH_AES_128_CCM PSK-AES128-CCM + PSK_WITH_AES_256_CCM PSK-AES256-CCM + DHE_PSK_WITH_AES_128_CCM DHE-PSK-AES128-CCM + DHE_PSK_WITH_AES_256_CCM DHE-PSK-AES256-CCM + PSK_WITH_AES_128_CCM_8 PSK-AES128-CCM8 + PSK_WITH_AES_256_CCM_8 PSK-AES256-CCM8 + DHE_PSK_WITH_AES_128_CCM_8 DHE-PSK-AES128-CCM8 + DHE_PSK_WITH_AES_256_CCM_8 DHE-PSK-AES256-CCM8 + +=head2 ChaCha20-Poly1305 cipher suites, extending TLS v1.2 + + TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 ECDHE-RSA-CHACHA20-POLY1305 + TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 ECDHE-ECDSA-CHACHA20-POLY1305 + TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 DHE-RSA-CHACHA20-POLY1305 + TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 PSK-CHACHA20-POLY1305 + TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 ECDHE-PSK-CHACHA20-POLY1305 + TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 DHE-PSK-CHACHA20-POLY1305 + TLS_RSA_PSK_WITH_CHACHA20_POLY1305_SHA256 RSA-PSK-CHACHA20-POLY1305 + +=head2 TLS v1.3 cipher suites + + TLS_AES_128_GCM_SHA256 TLS_AES_128_GCM_SHA256 + TLS_AES_256_GCM_SHA384 TLS_AES_256_GCM_SHA384 + TLS_CHACHA20_POLY1305_SHA256 TLS_CHACHA20_POLY1305_SHA256 + TLS_AES_128_CCM_SHA256 TLS_AES_128_CCM_SHA256 + TLS_AES_128_CCM_8_SHA256 TLS_AES_128_CCM_8_SHA256 + +=head2 Older names used by OpenSSL + +The following names are accepted by older releases: + + SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA EDH-RSA-DES-CBC3-SHA (DHE-RSA-DES-CBC3-SHA) + SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA EDH-DSS-DES-CBC3-SHA (DHE-DSS-DES-CBC3-SHA) + +=head1 NOTES + +Some compiled versions of OpenSSL may not include all the ciphers +listed here because some ciphers were excluded at compile time. + +=head1 EXAMPLES + +Verbose listing of all OpenSSL ciphers including NULL ciphers: + + openssl ciphers -v 'ALL:eNULL' + +Include all ciphers except NULL and anonymous DH then sort by +strength: + + openssl ciphers -v 'ALL:!ADH:@STRENGTH' + +Include all ciphers except ones with no encryption (eNULL) or no +authentication (aNULL): + + openssl ciphers -v 'ALL:!aNULL' + +Include only 3DES ciphers and then place RSA ciphers last: + + openssl ciphers -v '3DES:+RSA' + +Include all RC4 ciphers but leave out those without authentication: + + openssl ciphers -v 'RC4:!COMPLEMENTOFDEFAULT' + +Include all ciphers with RSA authentication but leave out ciphers without +encryption. + + openssl ciphers -v 'RSA:!COMPLEMENTOFALL' + +Set security level to 2 and display all ciphers consistent with level 2: + + openssl ciphers -s -v 'ALL:@SECLEVEL=2' + +=head1 SEE ALSO + +L, +L, +L, +L + +=head1 HISTORY + +The B<-V> option was added in OpenSSL 1.0.0. + +The B<-stdname> is only available if OpenSSL is built with tracing enabled +(B argument to Configure) before OpenSSL 1.1.1. + +The B<-convert> option was added in OpenSSL 1.1.1. + +=head1 COPYRIGHT + +Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-cmds.pod b/doc/man1/openssl-cmds.pod deleted file mode 100644 index d44d40cfec..0000000000 --- a/doc/man1/openssl-cmds.pod +++ /dev/null @@ -1,159 +0,0 @@ -=pod - -=head1 NAME - -=for openssl names: openssl-cmds - -asn1parse, -ca, -ciphers, -cms, -crl, -crl2pkcs7, -dgst, -dhparam, -dsa, -dsaparam, -ec, -ecparam, -enc, -engine, -errstr, -gendsa, -genpkey, -genrsa, -info, -kdf, -mac, -nseq, -ocsp, -passwd, -pkcs12, -pkcs7, -pkcs8, -pkey, -pkeyparam, -pkeyutl, -prime, -rand, -rehash, -req, -rsa, -rsautl, -s_client, -s_server, -s_time, -sess_id, -smime, -speed, -spkac, -srp, -storeutl, -ts, -verify, -version, -x509 -- OpenSSL application commands - -=for openssl foreign manual apropos(1) - -=head1 SYNOPSIS - -=for openssl generic - -B I B<-help> | [I<-option> | I<-option> I] ... [I] ... - -=head1 DESCRIPTION - -Every I listed above is a (sub-)command of the L application. -It has its own detailed manual page at B>(1). For example, to -view the manual page for the B command, type C. - -=head1 OPTIONS - -Among others, every subcommand has a help option. - -=over 4 - -=item B<-help> - -Print out a usage message for the subcommand. - -=back - -=head1 SEE ALSO - -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, - -=head1 HISTORY - -=for openssl foreign manual apropos(1) - -Initially, the manual page entry for the C> command used -to be available at I(1). Later, the alias B>(1) was -introduced, which made it easier to group the openssl commands using -the L command or the shell's tab completion. - -In order to reduce cluttering of the global manual page namespace, -the manual page entries without the 'openssl-' prefix have been -deprecated in OpenSSL 3.0 and will be removed in OpenSSL 4.0. - -=head1 COPYRIGHT - -Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-cmds.pod.in b/doc/man1/openssl-cmds.pod.in new file mode 100644 index 0000000000..50f0bc66e4 --- /dev/null +++ b/doc/man1/openssl-cmds.pod.in @@ -0,0 +1,160 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +=for openssl names: openssl-cmds + +asn1parse, +ca, +ciphers, +cms, +crl, +crl2pkcs7, +dgst, +dhparam, +dsa, +dsaparam, +ec, +ecparam, +enc, +engine, +errstr, +gendsa, +genpkey, +genrsa, +info, +kdf, +mac, +nseq, +ocsp, +passwd, +pkcs12, +pkcs7, +pkcs8, +pkey, +pkeyparam, +pkeyutl, +prime, +rand, +rehash, +req, +rsa, +rsautl, +s_client, +s_server, +s_time, +sess_id, +smime, +speed, +spkac, +srp, +storeutl, +ts, +verify, +version, +x509 +- OpenSSL application commands + +=for openssl foreign manual apropos(1) + +=head1 SYNOPSIS + +=for openssl generic + +B I B<-help> | [I<-option> | I<-option> I] ... [I] ... + +=head1 DESCRIPTION + +Every I listed above is a (sub-)command of the L application. +It has its own detailed manual page at B>(1). For example, to +view the manual page for the B command, type C. + +=head1 OPTIONS + +Among others, every subcommand has a help option. + +=over 4 + +=item B<-help> + +Print out a usage message for the subcommand. + +=back + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, + +=head1 HISTORY + +=for openssl foreign manual apropos(1) + +Initially, the manual page entry for the C> command used +to be available at I(1). Later, the alias B>(1) was +introduced, which made it easier to group the openssl commands using +the L command or the shell's tab completion. + +In order to reduce cluttering of the global manual page namespace, +the manual page entries without the 'openssl-' prefix have been +deprecated in OpenSSL 3.0 and will be removed in OpenSSL 4.0. + +=head1 COPYRIGHT + +Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-crl2pkcs7.pod b/doc/man1/openssl-crl2pkcs7.pod deleted file mode 100644 index 70662d4e0f..0000000000 --- a/doc/man1/openssl-crl2pkcs7.pod +++ /dev/null @@ -1,104 +0,0 @@ -=pod - -=head1 NAME - -openssl-crl2pkcs7 - Create a PKCS#7 structure from a CRL and certificates - -=head1 SYNOPSIS - -B B -[B<-help>] -[B<-inform> B|B] -[B<-outform> B|B] -[B<-in> I] -[B<-out> I] -[B<-certfile> I] -[B<-nocrl>] - -=head1 DESCRIPTION - -This command takes an optional CRL and one or more -certificates and converts them into a PKCS#7 degenerate "certificates -only" structure. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print out a usage message. - -=item B<-inform> B|B - -The input format of the CRL; the default is B. -See L for details. - -=item B<-outform> B|B - -The output format of the PKCS#7 object; the default is B. -See L for details. - -=item B<-in> I - -This specifies the input filename to read a CRL from or standard input if this -option is not specified. - -=item B<-out> I - -Specifies the output filename to write the PKCS#7 structure to or standard -output by default. - -=item B<-certfile> I - -Specifies a filename containing one or more certificates in B format. -All certificates in the file will be added to the PKCS#7 structure. This -option can be used more than once to read certificates form multiple -files. - -=item B<-nocrl> - -Normally a CRL is included in the output file. With this option no CRL is -included in the output file and a CRL is not read from the input file. - -=back - -=head1 EXAMPLES - -Create a PKCS#7 structure from a certificate and CRL: - - openssl crl2pkcs7 -in crl.pem -certfile cert.pem -out p7.pem - -Creates a PKCS#7 structure in DER format with no CRL from several -different certificates: - - openssl crl2pkcs7 -nocrl -certfile newcert.pem - -certfile demoCA/cacert.pem -outform DER -out p7.der - -=head1 NOTES - -The output file is a PKCS#7 signed data structure containing no signers and -just certificates and an optional CRL. - -This command can be used to send certificates and CAs to Netscape as part of -the certificate enrollment process. This involves sending the DER encoded output -as MIME type application/x-x509-user-cert. - -The B encoded form with the header and footer lines removed can be used to -install user certificates and CAs in MSIE using the Xenroll control. - -=head1 SEE ALSO - -L, -L - -=head1 COPYRIGHT - -Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-crl2pkcs7.pod.in b/doc/man1/openssl-crl2pkcs7.pod.in new file mode 100644 index 0000000000..187b6a5856 --- /dev/null +++ b/doc/man1/openssl-crl2pkcs7.pod.in @@ -0,0 +1,105 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-crl2pkcs7 - Create a PKCS#7 structure from a CRL and certificates + +=head1 SYNOPSIS + +B B +[B<-help>] +[B<-inform> B|B] +[B<-outform> B|B] +[B<-in> I] +[B<-out> I] +[B<-certfile> I] +[B<-nocrl>] + +=head1 DESCRIPTION + +This command takes an optional CRL and one or more +certificates and converts them into a PKCS#7 degenerate "certificates +only" structure. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print out a usage message. + +=item B<-inform> B|B + +The input format of the CRL; the default is B. +See L for details. + +=item B<-outform> B|B + +The output format of the PKCS#7 object; the default is B. +See L for details. + +=item B<-in> I + +This specifies the input filename to read a CRL from or standard input if this +option is not specified. + +=item B<-out> I + +Specifies the output filename to write the PKCS#7 structure to or standard +output by default. + +=item B<-certfile> I + +Specifies a filename containing one or more certificates in B format. +All certificates in the file will be added to the PKCS#7 structure. This +option can be used more than once to read certificates form multiple +files. + +=item B<-nocrl> + +Normally a CRL is included in the output file. With this option no CRL is +included in the output file and a CRL is not read from the input file. + +=back + +=head1 EXAMPLES + +Create a PKCS#7 structure from a certificate and CRL: + + openssl crl2pkcs7 -in crl.pem -certfile cert.pem -out p7.pem + +Creates a PKCS#7 structure in DER format with no CRL from several +different certificates: + + openssl crl2pkcs7 -nocrl -certfile newcert.pem + -certfile demoCA/cacert.pem -outform DER -out p7.der + +=head1 NOTES + +The output file is a PKCS#7 signed data structure containing no signers and +just certificates and an optional CRL. + +This command can be used to send certificates and CAs to Netscape as part of +the certificate enrollment process. This involves sending the DER encoded output +as MIME type application/x-x509-user-cert. + +The B encoded form with the header and footer lines removed can be used to +install user certificates and CAs in MSIE using the Xenroll control. + +=head1 SEE ALSO + +L, +L + +=head1 COPYRIGHT + +Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-engine.pod b/doc/man1/openssl-engine.pod deleted file mode 100644 index 7110ceecbc..0000000000 --- a/doc/man1/openssl-engine.pod +++ /dev/null @@ -1,125 +0,0 @@ -=pod - -=head1 NAME - -openssl-engine - load and query engines - -=head1 SYNOPSIS - -B -[B<-help>] -[B<-v>] -[B<-vv>] -[B<-vvv>] -[B<-vvvv>] -[B<-c>] -[B<-t>] -[B<-tt>] -[B<-pre> I] ... -[B<-post> I] ... -[I ...] - -=head1 DESCRIPTION - -This command is used to query the status and capabilities -of the specified Is. -Engines may be specified before and after all other command-line flags. -Only those specified are queried. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Display an option summary. - -=item B<-v> B<-vv> B<-vvv> B<-vvvv> - -Provides information about each specified engine. The first flag lists -all the possible run-time control commands; the second adds a -description of each command; the third adds the input flags, and the -final option adds the internal input flags. - -=item B<-c> - -Lists the capabilities of each engine. - -=item B<-t> - -Tests if each specified engine is available, and displays the answer. - -=item B<-tt> - -Displays an error trace for any unavailable engine. - -=item B<-pre> I - -=item B<-post> I - -Command-line configuration of engines. -The B<-pre> command is given to the engine before it is loaded and -the B<-post> command is given after the engine is loaded. -The I is of the form I:I where I is the command, -and I is the value for the command. -See the example below. - -These two options are cumulative, so they may be given more than once in the -same command. - -=back - -=head1 EXAMPLES - -To list all the commands available to a dynamic engine: - - $ openssl engine -t -tt -vvvv dynamic - (dynamic) Dynamic engine loading support - [ unavailable ] - SO_PATH: Specifies the path to the new ENGINE shared library - (input flags): STRING - NO_VCHECK: Specifies to continue even if version checking fails (boolean) - (input flags): NUMERIC - ID: Specifies an ENGINE id name for loading - (input flags): STRING - LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory) - (input flags): NUMERIC - DIR_LOAD: Specifies whether to load from 'DIR_ADD' directories (0=no,1=yes,2=mandatory) - (input flags): NUMERIC - DIR_ADD: Adds a directory from which ENGINEs can be loaded - (input flags): STRING - LOAD: Load up the ENGINE specified by other settings - (input flags): NO_INPUT - -To list the capabilities of the B engine: - - $ openssl engine -c - (rsax) RSAX engine support - [RSA] - (dynamic) Dynamic engine loading support - -=head1 ENVIRONMENT - -=over 4 - -=item B - -The path to the engines directory. - -=back - -=head1 SEE ALSO - -L, -L - -=head1 COPYRIGHT - -Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-engine.pod.in b/doc/man1/openssl-engine.pod.in new file mode 100644 index 0000000000..c4b0665376 --- /dev/null +++ b/doc/man1/openssl-engine.pod.in @@ -0,0 +1,126 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-engine - load and query engines + +=head1 SYNOPSIS + +B +[B<-help>] +[B<-v>] +[B<-vv>] +[B<-vvv>] +[B<-vvvv>] +[B<-c>] +[B<-t>] +[B<-tt>] +[B<-pre> I] ... +[B<-post> I] ... +[I ...] + +=head1 DESCRIPTION + +This command is used to query the status and capabilities +of the specified Is. +Engines may be specified before and after all other command-line flags. +Only those specified are queried. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Display an option summary. + +=item B<-v> B<-vv> B<-vvv> B<-vvvv> + +Provides information about each specified engine. The first flag lists +all the possible run-time control commands; the second adds a +description of each command; the third adds the input flags, and the +final option adds the internal input flags. + +=item B<-c> + +Lists the capabilities of each engine. + +=item B<-t> + +Tests if each specified engine is available, and displays the answer. + +=item B<-tt> + +Displays an error trace for any unavailable engine. + +=item B<-pre> I + +=item B<-post> I + +Command-line configuration of engines. +The B<-pre> command is given to the engine before it is loaded and +the B<-post> command is given after the engine is loaded. +The I is of the form I:I where I is the command, +and I is the value for the command. +See the example below. + +These two options are cumulative, so they may be given more than once in the +same command. + +=back + +=head1 EXAMPLES + +To list all the commands available to a dynamic engine: + + $ openssl engine -t -tt -vvvv dynamic + (dynamic) Dynamic engine loading support + [ unavailable ] + SO_PATH: Specifies the path to the new ENGINE shared library + (input flags): STRING + NO_VCHECK: Specifies to continue even if version checking fails (boolean) + (input flags): NUMERIC + ID: Specifies an ENGINE id name for loading + (input flags): STRING + LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory) + (input flags): NUMERIC + DIR_LOAD: Specifies whether to load from 'DIR_ADD' directories (0=no,1=yes,2=mandatory) + (input flags): NUMERIC + DIR_ADD: Adds a directory from which ENGINEs can be loaded + (input flags): STRING + LOAD: Load up the ENGINE specified by other settings + (input flags): NO_INPUT + +To list the capabilities of the B engine: + + $ openssl engine -c + (rsax) RSAX engine support + [RSA] + (dynamic) Dynamic engine loading support + +=head1 ENVIRONMENT + +=over 4 + +=item B + +The path to the engines directory. + +=back + +=head1 SEE ALSO + +L, +L + +=head1 COPYRIGHT + +Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-errstr.pod b/doc/man1/openssl-errstr.pod deleted file mode 100644 index ea838d9eb2..0000000000 --- a/doc/man1/openssl-errstr.pod +++ /dev/null @@ -1,53 +0,0 @@ -=pod - -=head1 NAME - -openssl-errstr - lookup error codes - -=head1 SYNOPSIS - -B -[B<-help>] -I - -=head1 DESCRIPTION - -Sometimes an application will not load error message texts and only -numerical forms will be available. This command can be -used to display the meaning of the hex code. The hex code is the hex digits -after the second colon. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Display a usage message. - -=back - -=head1 EXAMPLES - -The error code: - - 27594:error:2006D080:lib(32)::reason(128)::107: - -can be displayed with: - - openssl errstr 2006D080 - -to produce the error message: - - error:2006D080:BIO routines::no such file - -=head1 COPYRIGHT - -Copyright 2004-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-errstr.pod.in b/doc/man1/openssl-errstr.pod.in new file mode 100644 index 0000000000..3a4e5163f9 --- /dev/null +++ b/doc/man1/openssl-errstr.pod.in @@ -0,0 +1,54 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-errstr - lookup error codes + +=head1 SYNOPSIS + +B +[B<-help>] +I + +=head1 DESCRIPTION + +Sometimes an application will not load error message texts and only +numerical forms will be available. This command can be +used to display the meaning of the hex code. The hex code is the hex digits +after the second colon. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Display a usage message. + +=back + +=head1 EXAMPLES + +The error code: + + 27594:error:2006D080:lib(32)::reason(128)::107: + +can be displayed with: + + openssl errstr 2006D080 + +to produce the error message: + + error:2006D080:BIO routines::no such file + +=head1 COPYRIGHT + +Copyright 2004-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-fipsinstall.pod b/doc/man1/openssl-fipsinstall.pod deleted file mode 100644 index 9c7c856b0d..0000000000 --- a/doc/man1/openssl-fipsinstall.pod +++ /dev/null @@ -1,171 +0,0 @@ -=pod - -=head1 NAME - -openssl-fipsinstall - perform FIPS configuration installation - -=head1 SYNOPSIS - -B -[B<-help>] -[B<-in> I] -[B<-out> I] -[B<-module> I] -[B<-provider_name> I] -[B<-section_name> I] -[B<-verify>] -[B<-mac_name> I] -[B<-macopt> I:I] -[B<-noout>] -[B<-corrupt_desc> I] -[B<-corrupt_type> I] - -=head1 DESCRIPTION - -This command is used to generate a FIPS module configuration file. -The generated configuration file consists of: - -=over 4 - -=item - A mac of the FIPS module file. - -=item - A status indicator that indicates if the known answer Self Tests (KAT's) -have successfully run. - -=back - -This configuration file can be used each time a FIPS module is loaded -in order to pass data to the FIPS modules self tests. The FIPS module always -verifies the modules MAC, but only needs to run the KATS once during install. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print a usage message. - -=item B<-module> I - -Filename of a fips module to perform an integrity check on. - -=item B<-out> I - -Filename to output the configuration data to, or standard output by default. - -=item B<-in> I - -Input filename to load configuration data from. Used with the '-verify' option. -Standard input is used if the filename is '-'. - -=item B<-verify> - -Verify that the input configuration file contains the correct information - -=item B<-provider_name> I - -Name of the provider inside the configuration file. - -=item B<-section_name> I - -Name of the section inside the configuration file. - -=item B<-mac_name> I - -Specifies the name of a supported MAC algorithm which will be used. -To see the list of supported MAC's use the command -C. The default is B. - -=item B<-macopt> I:I - -Passes options to the MAC algorithm. -A comprehensive list of controls can be found in the EVP_MAC implementation -documentation. -Common control strings used for fipsinstall are: - -=over 4 - -=item B:I - -Specifies the MAC key as an alphanumeric string (use if the key contains -printable characters only). -The string length must conform to any restrictions of the MAC algorithm. -A key must be specified for every MAC algorithm. - -=item B:I - -Specifies the MAC key in hexadecimal form (two hex digits per byte). -The key length must conform to any restrictions of the MAC algorithm. -A key must be specified for every MAC algorithm. - -=item B:I - -Used by HMAC as an alphanumeric string (use if the key contains printable -characters only). -The string length must conform to any restrictions of the MAC algorithm. -To see the list of supported digests, use the command -C. - -=back - -=item B<-noout> - -Disable logging of the self tests. - -=item B<-corrupt_desc> I - -=item B<-corrupt_type> I - -The corrupt options can be used to test failure of one or more self test(s) by -name. -Either option or both may be used to select the self test(s) to corrupt. -Refer to the entries for "st-desc" and "st-type" in L for -values that can be used. - -=back - -=head1 EXAMPLES - -Calculate the mac of a FIPS module F and run a FIPS self test -for the module, and save the F configuration file: - - openssl fipsinstall -module ./fips.so -out fips.cnf -provider_name fips \ - -section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \ - -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 - -Verify that the configuration file F contains the correct info: - - openssl fipsinstall -module ./fips.so -in fips.cnf -provider_name fips \ - -section_name fips_install -mac_name HMAC -macopt digest:SHA256 \ - -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 -verify - -Corrupt any self tests which have the description 'SHA1': - - openssl fipsinstall -module ./fips.so -out fips.cnf -provider_name fips \ - -section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \ - -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 \ - -corrupt_desc', 'SHA1' - -=head1 NOTES - -The MAC mechanisms that are available will depend on the options -used when building OpenSSL. -The command C command can be used to list them. - -=head1 SEE ALSO - -L, -L, -L - -=head1 COPYRIGHT - -Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the OpenSSL license (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-fipsinstall.pod.in b/doc/man1/openssl-fipsinstall.pod.in new file mode 100644 index 0000000000..6ea3fca4d9 --- /dev/null +++ b/doc/man1/openssl-fipsinstall.pod.in @@ -0,0 +1,172 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-fipsinstall - perform FIPS configuration installation + +=head1 SYNOPSIS + +B +[B<-help>] +[B<-in> I] +[B<-out> I] +[B<-module> I] +[B<-provider_name> I] +[B<-section_name> I] +[B<-verify>] +[B<-mac_name> I] +[B<-macopt> I:I] +[B<-noout>] +[B<-corrupt_desc> I] +[B<-corrupt_type> I] + +=head1 DESCRIPTION + +This command is used to generate a FIPS module configuration file. +The generated configuration file consists of: + +=over 4 + +=item - A mac of the FIPS module file. + +=item - A status indicator that indicates if the known answer Self Tests (KAT's) +have successfully run. + +=back + +This configuration file can be used each time a FIPS module is loaded +in order to pass data to the FIPS modules self tests. The FIPS module always +verifies the modules MAC, but only needs to run the KATS once during install. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print a usage message. + +=item B<-module> I + +Filename of a fips module to perform an integrity check on. + +=item B<-out> I + +Filename to output the configuration data to, or standard output by default. + +=item B<-in> I + +Input filename to load configuration data from. Used with the '-verify' option. +Standard input is used if the filename is '-'. + +=item B<-verify> + +Verify that the input configuration file contains the correct information + +=item B<-provider_name> I + +Name of the provider inside the configuration file. + +=item B<-section_name> I + +Name of the section inside the configuration file. + +=item B<-mac_name> I + +Specifies the name of a supported MAC algorithm which will be used. +To see the list of supported MAC's use the command +C. The default is B. + +=item B<-macopt> I:I + +Passes options to the MAC algorithm. +A comprehensive list of controls can be found in the EVP_MAC implementation +documentation. +Common control strings used for fipsinstall are: + +=over 4 + +=item B:I + +Specifies the MAC key as an alphanumeric string (use if the key contains +printable characters only). +The string length must conform to any restrictions of the MAC algorithm. +A key must be specified for every MAC algorithm. + +=item B:I + +Specifies the MAC key in hexadecimal form (two hex digits per byte). +The key length must conform to any restrictions of the MAC algorithm. +A key must be specified for every MAC algorithm. + +=item B:I + +Used by HMAC as an alphanumeric string (use if the key contains printable +characters only). +The string length must conform to any restrictions of the MAC algorithm. +To see the list of supported digests, use the command +C. + +=back + +=item B<-noout> + +Disable logging of the self tests. + +=item B<-corrupt_desc> I + +=item B<-corrupt_type> I + +The corrupt options can be used to test failure of one or more self test(s) by +name. +Either option or both may be used to select the self test(s) to corrupt. +Refer to the entries for "st-desc" and "st-type" in L for +values that can be used. + +=back + +=head1 EXAMPLES + +Calculate the mac of a FIPS module F and run a FIPS self test +for the module, and save the F configuration file: + + openssl fipsinstall -module ./fips.so -out fips.cnf -provider_name fips \ + -section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \ + -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 + +Verify that the configuration file F contains the correct info: + + openssl fipsinstall -module ./fips.so -in fips.cnf -provider_name fips \ + -section_name fips_install -mac_name HMAC -macopt digest:SHA256 \ + -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 -verify + +Corrupt any self tests which have the description 'SHA1': + + openssl fipsinstall -module ./fips.so -out fips.cnf -provider_name fips \ + -section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \ + -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 \ + -corrupt_desc', 'SHA1' + +=head1 NOTES + +The MAC mechanisms that are available will depend on the options +used when building OpenSSL. +The command C command can be used to list them. + +=head1 SEE ALSO + +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-info.pod b/doc/man1/openssl-info.pod deleted file mode 100644 index 6e16bb809f..0000000000 --- a/doc/man1/openssl-info.pod +++ /dev/null @@ -1,90 +0,0 @@ -=pod - -=head1 NAME - -openssl-info - print OpenSSL built-in information - -=head1 SYNOPSIS - -B -[B<-help>] -[B<-configdir>] -[B<-enginesdir>] -[B<-modulesdir> ] -[B<-dsoext>] -[B<-dirnamesep>] -[B<-listsep>] -[B<-seeds>] -[B<-cpusettings>] - -=head1 DESCRIPTION - -This command is used to print out information about OpenSSL. -The information is written exactly as it is with no extra text, which -makes useful for scripts. - -As a consequence, only one item may be chosen for each run of this -command. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print out a usage message. - -=item B<-configdir> - -Outputs the default directory for OpenSSL configuration files. - -=item B<-enginesdir> - -Outputs the default directory for OpenSSL engine modules. - -=item B<-modulesdir> - -Outputs the default directory for OpenSSL dynamically loadable modules -other than engine modules. - -=item B<-dsoext> - -Outputs the DSO extension OpenSSL uses. - -=item B<-dirnamesep> - -Outputs the separator character between a directory specification and -a filename. -Note that on some operating systems, this is not the same as the -separator between directory elements. - -=item B<-listsep> - -Outputs the OpenSSL list separator character. -This is typically used to construct C<$PATH> (C<%PATH%> on Windows) -style lists. - -=item B<-seeds> - -Outputs the randomness seed sources. - -=item B<-cpusettings> - -Outputs the OpenSSL CPU settings info. - -=back - -=head1 HISTORY - -This command was added in OpenSSL 3.0. - -=head1 COPYRIGHT - -Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-info.pod.in b/doc/man1/openssl-info.pod.in new file mode 100644 index 0000000000..c8965b2ab6 --- /dev/null +++ b/doc/man1/openssl-info.pod.in @@ -0,0 +1,91 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-info - print OpenSSL built-in information + +=head1 SYNOPSIS + +B +[B<-help>] +[B<-configdir>] +[B<-enginesdir>] +[B<-modulesdir> ] +[B<-dsoext>] +[B<-dirnamesep>] +[B<-listsep>] +[B<-seeds>] +[B<-cpusettings>] + +=head1 DESCRIPTION + +This command is used to print out information about OpenSSL. +The information is written exactly as it is with no extra text, which +makes useful for scripts. + +As a consequence, only one item may be chosen for each run of this +command. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print out a usage message. + +=item B<-configdir> + +Outputs the default directory for OpenSSL configuration files. + +=item B<-enginesdir> + +Outputs the default directory for OpenSSL engine modules. + +=item B<-modulesdir> + +Outputs the default directory for OpenSSL dynamically loadable modules +other than engine modules. + +=item B<-dsoext> + +Outputs the DSO extension OpenSSL uses. + +=item B<-dirnamesep> + +Outputs the separator character between a directory specification and +a filename. +Note that on some operating systems, this is not the same as the +separator between directory elements. + +=item B<-listsep> + +Outputs the OpenSSL list separator character. +This is typically used to construct C<$PATH> (C<%PATH%> on Windows) +style lists. + +=item B<-seeds> + +Outputs the randomness seed sources. + +=item B<-cpusettings> + +Outputs the OpenSSL CPU settings info. + +=back + +=head1 HISTORY + +This command was added in OpenSSL 3.0. + +=head1 COPYRIGHT + +Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-kdf.pod b/doc/man1/openssl-kdf.pod deleted file mode 100644 index d89f84fd43..0000000000 --- a/doc/man1/openssl-kdf.pod +++ /dev/null @@ -1,171 +0,0 @@ -=pod - -=head1 NAME - -openssl-kdf - perform Key Derivation Function operations - -=head1 SYNOPSIS - -B -[B<-help>] -[B<-kdfopt> I:I] -[B<-keylen> I] -[B<-out> I] -[B<-binary>] -I - -=head1 DESCRIPTION - -The key derivation functions generate a derived key from either a secret or -password. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print a usage message. - -=item B<-keylen> I - -The output size of the derived key. This field is required. - -=item B<-out> I - -Filename to output to, or standard output by default. - -=item B<-binary> - -Output the derived key in binary form. Uses hexadecimal text format if not specified. - -=item B<-kdfopt> I:I - -Passes options to the KDF algorithm. -A comprehensive list of parameters can be found in the EVP_KDF_CTX -implementation documentation. -Common parameter names used by EVP_KDF_CTX_set_params() are: - -=over 4 - -=item BI - -Specifies the secret key as an alphanumeric string (use if the key contains -printable characters only). -The string length must conform to any restrictions of the KDF algorithm. -A key must be specified for most KDF algorithms. - -=item BI - -Specifies the secret key in hexadecimal form (two hex digits per byte). -The key length must conform to any restrictions of the KDF algorithm. -A key must be specified for most KDF algorithms. - -=item BI - -Specifies the password as an alphanumeric string (use if the password contains -printable characters only). -The password must be specified for PBKDF2 and scrypt. - -=item BI - -Specifies the password in hexadecimal form (two hex digits per byte). -The password must be specified for PBKDF2 and scrypt. - -=item BI - -Specifies the name of a digest as an alphanumeric string. -To see the list of supported digests, use the command I. - -=back - -=item I - -Specifies the name of a supported KDF algorithm which will be used. -The supported algorithms names include TLS1-PRF, HKDF, SSKDF, PBKDF2, -SSHKDF, X942KDF, X963KDF and SCRYPT. - -=back - -=head1 EXAMPLES - -Use TLS1-PRF to create a hex-encoded derived key from a secret key and seed: - - openssl kdf -keylen 16 -kdfopt digest:SHA2-256 -kdfopt key:secret \ - -kdfopt seed:seed TLS1-PRF - -Use HKDF to create a hex-encoded derived key from a secret key, salt and info: - - openssl kdf -keylen 10 -kdfopt digest:SHA2-256 -kdfopt key:secret \ - -kdfopt salt:salt -kdfopt info:label HKDF - -Use SSKDF with KMAC to create a hex-encoded derived key from a secret key, salt and info: - - openssl kdf -keylen 64 -kdfopt mac:KMAC-128 -kdfopt maclen:20 \ - -kdfopt hexkey:b74a149a161545 -kdfopt hexinfo:348a37a2 \ - -kdfopt hexsalt:3638271ccd68a2 SSKDF - -Use SSKDF with HMAC to create a hex-encoded derived key from a secret key, salt and info: - - openssl kdf -keylen 16 -kdfopt mac:HMAC -kdfopt digest:SHA2-256 \ - -kdfopt hexkey:b74a149a -kdfopt hexinfo:348a37a2 \ - -kdfopt hexsalt:3638271c SSKDF - -Use SSKDF with Hash to create a hex-encoded derived key from a secret key, salt and info: - - openssl kdf -keylen 14 -kdfopt digest:SHA2-256 \ - -kdfopt hexkey:6dbdc23f045488 \ - -kdfopt hexinfo:a1b2c3d4 SSKDF - -Use SSHKDF to create a hex-encoded derived key from a secret key, hash and session_id: - - openssl kdf -keylen 16 -kdfopt digest:SHA2-256 \ - -kdfopt hexkey:0102030405 \ - -kdfopt hexxcghash:06090A \ - -kdfopt hexsession_id:01020304 \ - -kdfopt type:A SSHKDF - -Use PBKDF2 to create a hex-encoded derived key from a password and salt: - - openssl kdf -keylen 32 -kdfopt digest:SHA256 -kdfopt pass:password \ - -kdfopt salt:salt -kdfopt iter:2 PBKDF2 - -Use scrypt to create a hex-encoded derived key from a password and salt: - - openssl kdf -keylen 64 -kdfopt pass:password -kdfopt salt:NaCl \ - -kdfopt N:1024 -kdfopt r:8 -kdfopt p:16 \ - -kdfopt maxmem_bytes:10485760 SCRYPT - -=head1 NOTES - -The KDF mechanisms that are available will depend on the options -used when building OpenSSL. - -=head1 SEE ALSO - -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L - -=head1 HISTORY - -Added in OpenSSL 3.0 - -=head1 COPYRIGHT - -Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the OpenSSL license (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-kdf.pod.in b/doc/man1/openssl-kdf.pod.in new file mode 100644 index 0000000000..5073ac09fc --- /dev/null +++ b/doc/man1/openssl-kdf.pod.in @@ -0,0 +1,172 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-kdf - perform Key Derivation Function operations + +=head1 SYNOPSIS + +B +[B<-help>] +[B<-kdfopt> I:I] +[B<-keylen> I] +[B<-out> I] +[B<-binary>] +I + +=head1 DESCRIPTION + +The key derivation functions generate a derived key from either a secret or +password. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print a usage message. + +=item B<-keylen> I + +The output size of the derived key. This field is required. + +=item B<-out> I + +Filename to output to, or standard output by default. + +=item B<-binary> + +Output the derived key in binary form. Uses hexadecimal text format if not specified. + +=item B<-kdfopt> I:I + +Passes options to the KDF algorithm. +A comprehensive list of parameters can be found in the EVP_KDF_CTX +implementation documentation. +Common parameter names used by EVP_KDF_CTX_set_params() are: + +=over 4 + +=item BI + +Specifies the secret key as an alphanumeric string (use if the key contains +printable characters only). +The string length must conform to any restrictions of the KDF algorithm. +A key must be specified for most KDF algorithms. + +=item BI + +Specifies the secret key in hexadecimal form (two hex digits per byte). +The key length must conform to any restrictions of the KDF algorithm. +A key must be specified for most KDF algorithms. + +=item BI + +Specifies the password as an alphanumeric string (use if the password contains +printable characters only). +The password must be specified for PBKDF2 and scrypt. + +=item BI + +Specifies the password in hexadecimal form (two hex digits per byte). +The password must be specified for PBKDF2 and scrypt. + +=item BI + +Specifies the name of a digest as an alphanumeric string. +To see the list of supported digests, use the command I. + +=back + +=item I + +Specifies the name of a supported KDF algorithm which will be used. +The supported algorithms names include TLS1-PRF, HKDF, SSKDF, PBKDF2, +SSHKDF, X942KDF, X963KDF and SCRYPT. + +=back + +=head1 EXAMPLES + +Use TLS1-PRF to create a hex-encoded derived key from a secret key and seed: + + openssl kdf -keylen 16 -kdfopt digest:SHA2-256 -kdfopt key:secret \ + -kdfopt seed:seed TLS1-PRF + +Use HKDF to create a hex-encoded derived key from a secret key, salt and info: + + openssl kdf -keylen 10 -kdfopt digest:SHA2-256 -kdfopt key:secret \ + -kdfopt salt:salt -kdfopt info:label HKDF + +Use SSKDF with KMAC to create a hex-encoded derived key from a secret key, salt and info: + + openssl kdf -keylen 64 -kdfopt mac:KMAC-128 -kdfopt maclen:20 \ + -kdfopt hexkey:b74a149a161545 -kdfopt hexinfo:348a37a2 \ + -kdfopt hexsalt:3638271ccd68a2 SSKDF + +Use SSKDF with HMAC to create a hex-encoded derived key from a secret key, salt and info: + + openssl kdf -keylen 16 -kdfopt mac:HMAC -kdfopt digest:SHA2-256 \ + -kdfopt hexkey:b74a149a -kdfopt hexinfo:348a37a2 \ + -kdfopt hexsalt:3638271c SSKDF + +Use SSKDF with Hash to create a hex-encoded derived key from a secret key, salt and info: + + openssl kdf -keylen 14 -kdfopt digest:SHA2-256 \ + -kdfopt hexkey:6dbdc23f045488 \ + -kdfopt hexinfo:a1b2c3d4 SSKDF + +Use SSHKDF to create a hex-encoded derived key from a secret key, hash and session_id: + + openssl kdf -keylen 16 -kdfopt digest:SHA2-256 \ + -kdfopt hexkey:0102030405 \ + -kdfopt hexxcghash:06090A \ + -kdfopt hexsession_id:01020304 \ + -kdfopt type:A SSHKDF + +Use PBKDF2 to create a hex-encoded derived key from a password and salt: + + openssl kdf -keylen 32 -kdfopt digest:SHA256 -kdfopt pass:password \ + -kdfopt salt:salt -kdfopt iter:2 PBKDF2 + +Use scrypt to create a hex-encoded derived key from a password and salt: + + openssl kdf -keylen 64 -kdfopt pass:password -kdfopt salt:NaCl \ + -kdfopt N:1024 -kdfopt r:8 -kdfopt p:16 \ + -kdfopt maxmem_bytes:10485760 SCRYPT + +=head1 NOTES + +The KDF mechanisms that are available will depend on the options +used when building OpenSSL. + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L + +=head1 HISTORY + +Added in OpenSSL 3.0 + +=head1 COPYRIGHT + +Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-list.pod b/doc/man1/openssl-list.pod deleted file mode 100644 index 88bcc751e6..0000000000 --- a/doc/man1/openssl-list.pod +++ /dev/null @@ -1,143 +0,0 @@ -=pod - -=head1 NAME - -openssl-list - list algorithms and features - -=head1 SYNOPSIS - -B -[B<-help>] -[B<-verbose>] -[B<-1>] -[B<-commands>] -[B<-digest-commands>] -[B<-digest-algorithms>] -[B<-kdf-algorithms>] -[B<-mac-algorithms>] -[B<-cipher-commands>] -[B<-cipher-algorithms>] -[B<-public-key-algorithms>] -[B<-public-key-methods>] -[B<-engines>] -[B<-disabled>] -[B<-objects>] -[B<-options> I] - -=head1 DESCRIPTION - -This command is used to generate list of algorithms or disabled -features. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Display a usage message. - -=item B<-verbose> - -Displays extra information. -The options below where verbosity applies say a bit more about what that means. - -=item B<-1> - -List the commands, digest-commands, or cipher-commands in a single column. -If used, this option must be given first. - -=item B<-commands> - -Display a list of standard commands. - -=item B<-digest-commands> - -Display a list of message digest commands, which are typically used -as input to the L or L commands. - -=item B<-cipher-commands> - -Display a list of cipher commands, which are typically used as input -to the L or L commands. - -=item B<-digest-algorithms>, B<-kdf-algorithms>, B<-mac-algorithms>, -B<-cipher-algorithms> - -Display a list of cipher, digest, kdf and mac algorithms. -See L for a description of how names are -displayed. - -In verbose mode, the algorithms provided by a provider will get additional -information on what parameters each implementation supports. - -=item B<-public-key-algorithms> - -Display a list of public key algorithms, with each algorithm as -a block of multiple lines, all but the first are indented. - -=item B<-public-key-methods> - -Display a list of public key method OIDs. - -=item B<-engines> - -Display a list of loaded engines. - -=item B<-disabled> - -Display a list of disabled features, those that were compiled out -of the installation. - -=item B<-objects> - -Display a list of built in objects, i.e. OIDs with names. They're listed in the -format described in L. - -=item B<-options> I - -Output a two-column list of the options accepted by the specified I. -The first is the option name, and the second is a one-character indication -of what type of parameter it takes, if any. -This is an internal option, used for checking that the documentation -is complete. - -=back - -=head2 Display of algorithm names - -Algorithm names may be displayed in one of two manners: - -=over 4 - -=item Legacy implementations - -Legacy implementations will simply display the main name of the -algorithm on a line of its own, or in the form C< bar>> to show -that C is an alias for the main name, C - -=item Provided implementations - -Implementations from a provider are displayed like this if the -implementation is labeled with a single name: - - foo @ bar - -or like this if it's labeled with multiple names: - - { foo1, foo2 } @bar - -In both cases, C is the name of the provider. - -=back - -=head1 COPYRIGHT - -Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-list.pod.in b/doc/man1/openssl-list.pod.in new file mode 100644 index 0000000000..dc5572e6a3 --- /dev/null +++ b/doc/man1/openssl-list.pod.in @@ -0,0 +1,144 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-list - list algorithms and features + +=head1 SYNOPSIS + +B +[B<-help>] +[B<-verbose>] +[B<-1>] +[B<-commands>] +[B<-digest-commands>] +[B<-digest-algorithms>] +[B<-kdf-algorithms>] +[B<-mac-algorithms>] +[B<-cipher-commands>] +[B<-cipher-algorithms>] +[B<-public-key-algorithms>] +[B<-public-key-methods>] +[B<-engines>] +[B<-disabled>] +[B<-objects>] +[B<-options> I] + +=head1 DESCRIPTION + +This command is used to generate list of algorithms or disabled +features. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Display a usage message. + +=item B<-verbose> + +Displays extra information. +The options below where verbosity applies say a bit more about what that means. + +=item B<-1> + +List the commands, digest-commands, or cipher-commands in a single column. +If used, this option must be given first. + +=item B<-commands> + +Display a list of standard commands. + +=item B<-digest-commands> + +Display a list of message digest commands, which are typically used +as input to the L or L commands. + +=item B<-cipher-commands> + +Display a list of cipher commands, which are typically used as input +to the L or L commands. + +=item B<-digest-algorithms>, B<-kdf-algorithms>, B<-mac-algorithms>, +B<-cipher-algorithms> + +Display a list of cipher, digest, kdf and mac algorithms. +See L for a description of how names are +displayed. + +In verbose mode, the algorithms provided by a provider will get additional +information on what parameters each implementation supports. + +=item B<-public-key-algorithms> + +Display a list of public key algorithms, with each algorithm as +a block of multiple lines, all but the first are indented. + +=item B<-public-key-methods> + +Display a list of public key method OIDs. + +=item B<-engines> + +Display a list of loaded engines. + +=item B<-disabled> + +Display a list of disabled features, those that were compiled out +of the installation. + +=item B<-objects> + +Display a list of built in objects, i.e. OIDs with names. They're listed in the +format described in L. + +=item B<-options> I + +Output a two-column list of the options accepted by the specified I. +The first is the option name, and the second is a one-character indication +of what type of parameter it takes, if any. +This is an internal option, used for checking that the documentation +is complete. + +=back + +=head2 Display of algorithm names + +Algorithm names may be displayed in one of two manners: + +=over 4 + +=item Legacy implementations + +Legacy implementations will simply display the main name of the +algorithm on a line of its own, or in the form C< bar>> to show +that C is an alias for the main name, C + +=item Provided implementations + +Implementations from a provider are displayed like this if the +implementation is labeled with a single name: + + foo @ bar + +or like this if it's labeled with multiple names: + + { foo1, foo2 } @bar + +In both cases, C is the name of the provider. + +=back + +=head1 COPYRIGHT + +Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-mac.pod b/doc/man1/openssl-mac.pod deleted file mode 100644 index e5ec76395e..0000000000 --- a/doc/man1/openssl-mac.pod +++ /dev/null @@ -1,162 +0,0 @@ -=pod - -=head1 NAME - -openssl-mac - perform Message Authentication Code operations - -=head1 SYNOPSIS - -B -[B<-help>] -[B<-macopt>] -[B<-in> I] -[B<-out> I] -[B<-binary>] -I - -=head1 DESCRIPTION - -The message authentication code functions output the MAC of a supplied input -file. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print a usage message. - -=item B<-in> I - -Input filename to calculate a MAC for, or standard input by default. -Standard input is used if the filename is '-'. -Files are expected to be in binary format, standard input uses hexadecimal text -format. - -=item B<-out> I - -Filename to output to, or standard output by default. - -=item B<-binary> - -Output the MAC in binary form. Uses hexadecimal text format if not specified. - -=item B<-macopt> I:I - -Passes options to the MAC algorithm. -A comprehensive list of controls can be found in the EVP_MAC implementation -documentation. -Common parameter names used by EVP_MAC_CTX_get_params() are: - -=over 4 - -=item BI - -Specifies the MAC key as an alphanumeric string (use if the key contains -printable characters only). -The string length must conform to any restrictions of the MAC algorithm. -A key must be specified for every MAC algorithm. - -=item BI - -Specifies the MAC key in hexadecimal form (two hex digits per byte). -The key length must conform to any restrictions of the MAC algorithm. -A key must be specified for every MAC algorithm. - -=item BI - -Used by HMAC as an alphanumeric string (use if the key contains printable -characters only). -The string length must conform to any restrictions of the MAC algorithm. -To see the list of supported digests, use C. - -=item BI - -Used by CMAC and GMAC to specify the cipher algorithm. -For CMAC it must be one of AES-128-CBC, AES-192-CBC, AES-256-CBC or -DES-EDE3-CBC. -For GMAC it should be a GCM mode cipher e.g. AES-128-GCM. - -=item BI - -Used by GMAC to specify an IV as an alphanumeric string (use if the IV contains -printable characters only). - -=item BI - -Used by GMAC to specify an IV in hexadecimal form (two hex digits per byte). - -=item BI - -Used by KMAC128 or KMAC256 to specify an output length. -The default sizes are 32 or 64 bytes respectively. - -=item BI - -Used by KMAC128 or KMAC256 to specify a customization string. -The default is the empty string "". - -=back - -=item I - -Specifies the name of a supported MAC algorithm which will be used. -To see the list of supported MAC's use the command C. - -=back - - -=head1 EXAMPLES - -To create a hex-encoded HMAC-SHA1 MAC of a file and write to stdout: \ - openssl mac -macopt digest:SHA1 \ - -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 \ - -in msg.bin HMAC - -To create a SipHash MAC from a file with a binary file output: \ - openssl mac -macopt hexkey:000102030405060708090A0B0C0D0E0F \ - -in msg.bin -out out.bin -binary SipHash - -To create a hex-encoded CMAC-AES-128-CBC MAC from a file:\ - openssl mac -macopt cipher:AES-128-CBC \ - -macopt hexkey:77A77FAF290C1FA30C683DF16BA7A77B \ - -in msg.bin CMAC - -To create a hex-encoded KMAC128 MAC from a file with a Customisation String -'Tag' and output length of 16: \ - openssl mac -macopt custom:Tag -macopt hexkey:40414243444546 \ - -macopt size:16 -in msg.bin KMAC128 - -To create a hex-encoded GMAC-AES-128-GCM with a IV from a file: \ - openssl mac -macopt cipher:AES-128-GCM -macopt hexiv:E0E00F19FED7BA0136A797F3 \ - -macopt hexkey:77A77FAF290C1FA30C683DF16BA7A77B -in msg.bin GMAC - -=head1 NOTES - -The MAC mechanisms that are available will depend on the options -used when building OpenSSL. -Use C to list them. - -=head1 SEE ALSO - -L, -L, -L, -L, -L, -L, -L, -L - -=head1 COPYRIGHT - -Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the OpenSSL license (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-mac.pod.in b/doc/man1/openssl-mac.pod.in new file mode 100644 index 0000000000..5cc65f6c8d --- /dev/null +++ b/doc/man1/openssl-mac.pod.in @@ -0,0 +1,163 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-mac - perform Message Authentication Code operations + +=head1 SYNOPSIS + +B +[B<-help>] +[B<-macopt>] +[B<-in> I] +[B<-out> I] +[B<-binary>] +I + +=head1 DESCRIPTION + +The message authentication code functions output the MAC of a supplied input +file. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print a usage message. + +=item B<-in> I + +Input filename to calculate a MAC for, or standard input by default. +Standard input is used if the filename is '-'. +Files are expected to be in binary format, standard input uses hexadecimal text +format. + +=item B<-out> I + +Filename to output to, or standard output by default. + +=item B<-binary> + +Output the MAC in binary form. Uses hexadecimal text format if not specified. + +=item B<-macopt> I:I + +Passes options to the MAC algorithm. +A comprehensive list of controls can be found in the EVP_MAC implementation +documentation. +Common parameter names used by EVP_MAC_CTX_get_params() are: + +=over 4 + +=item BI + +Specifies the MAC key as an alphanumeric string (use if the key contains +printable characters only). +The string length must conform to any restrictions of the MAC algorithm. +A key must be specified for every MAC algorithm. + +=item BI + +Specifies the MAC key in hexadecimal form (two hex digits per byte). +The key length must conform to any restrictions of the MAC algorithm. +A key must be specified for every MAC algorithm. + +=item BI + +Used by HMAC as an alphanumeric string (use if the key contains printable +characters only). +The string length must conform to any restrictions of the MAC algorithm. +To see the list of supported digests, use C. + +=item BI + +Used by CMAC and GMAC to specify the cipher algorithm. +For CMAC it must be one of AES-128-CBC, AES-192-CBC, AES-256-CBC or +DES-EDE3-CBC. +For GMAC it should be a GCM mode cipher e.g. AES-128-GCM. + +=item BI + +Used by GMAC to specify an IV as an alphanumeric string (use if the IV contains +printable characters only). + +=item BI + +Used by GMAC to specify an IV in hexadecimal form (two hex digits per byte). + +=item BI + +Used by KMAC128 or KMAC256 to specify an output length. +The default sizes are 32 or 64 bytes respectively. + +=item BI + +Used by KMAC128 or KMAC256 to specify a customization string. +The default is the empty string "". + +=back + +=item I + +Specifies the name of a supported MAC algorithm which will be used. +To see the list of supported MAC's use the command C. + +=back + + +=head1 EXAMPLES + +To create a hex-encoded HMAC-SHA1 MAC of a file and write to stdout: \ + openssl mac -macopt digest:SHA1 \ + -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 \ + -in msg.bin HMAC + +To create a SipHash MAC from a file with a binary file output: \ + openssl mac -macopt hexkey:000102030405060708090A0B0C0D0E0F \ + -in msg.bin -out out.bin -binary SipHash + +To create a hex-encoded CMAC-AES-128-CBC MAC from a file:\ + openssl mac -macopt cipher:AES-128-CBC \ + -macopt hexkey:77A77FAF290C1FA30C683DF16BA7A77B \ + -in msg.bin CMAC + +To create a hex-encoded KMAC128 MAC from a file with a Customisation String +'Tag' and output length of 16: \ + openssl mac -macopt custom:Tag -macopt hexkey:40414243444546 \ + -macopt size:16 -in msg.bin KMAC128 + +To create a hex-encoded GMAC-AES-128-GCM with a IV from a file: \ + openssl mac -macopt cipher:AES-128-GCM -macopt hexiv:E0E00F19FED7BA0136A797F3 \ + -macopt hexkey:77A77FAF290C1FA30C683DF16BA7A77B -in msg.bin GMAC + +=head1 NOTES + +The MAC mechanisms that are available will depend on the options +used when building OpenSSL. +Use C to list them. + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-nseq.pod b/doc/man1/openssl-nseq.pod deleted file mode 100644 index 5404e1f340..0000000000 --- a/doc/man1/openssl-nseq.pod +++ /dev/null @@ -1,72 +0,0 @@ -=pod - -=head1 NAME - -openssl-nseq - create or examine a Netscape certificate sequence - -=head1 SYNOPSIS - -B B -[B<-help>] -[B<-in> I] -[B<-out> I] -[B<-toseq>] - -=head1 DESCRIPTION - -This command takes a file containing a Netscape certificate -sequence and prints out the certificates contained in it or takes a -file of certificates and converts it into a Netscape certificate -sequence. - -A Netscape certificate sequence is an old Netscape-specific format that -can be sometimes be sent to browsers as an alternative to the standard PKCS#7 -format when several certificates are sent to the browser, for example during -certificate enrollment. It was also used by Netscape certificate server. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print out a usage message. - -=item B<-in> I - -This specifies the input filename to read or standard input if this -option is not specified. - -=item B<-out> I - -Specifies the output filename or standard output by default. - -=item B<-toseq> - -Normally a Netscape certificate sequence will be input and the output -is the certificates contained in it. With the B<-toseq> option the -situation is reversed: a Netscape certificate sequence is created from -a file of certificates. - -=back - -=head1 EXAMPLES - -Output the certificates in a Netscape certificate sequence - - openssl nseq -in nseq.pem -out certs.pem - -Create a Netscape certificate sequence - - openssl nseq -in certs.pem -toseq -out nseq.pem - -=head1 COPYRIGHT - -Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-nseq.pod.in b/doc/man1/openssl-nseq.pod.in new file mode 100644 index 0000000000..3d29ae878f --- /dev/null +++ b/doc/man1/openssl-nseq.pod.in @@ -0,0 +1,73 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-nseq - create or examine a Netscape certificate sequence + +=head1 SYNOPSIS + +B B +[B<-help>] +[B<-in> I] +[B<-out> I] +[B<-toseq>] + +=head1 DESCRIPTION + +This command takes a file containing a Netscape certificate +sequence and prints out the certificates contained in it or takes a +file of certificates and converts it into a Netscape certificate +sequence. + +A Netscape certificate sequence is an old Netscape-specific format that +can be sometimes be sent to browsers as an alternative to the standard PKCS#7 +format when several certificates are sent to the browser, for example during +certificate enrollment. It was also used by Netscape certificate server. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print out a usage message. + +=item B<-in> I + +This specifies the input filename to read or standard input if this +option is not specified. + +=item B<-out> I + +Specifies the output filename or standard output by default. + +=item B<-toseq> + +Normally a Netscape certificate sequence will be input and the output +is the certificates contained in it. With the B<-toseq> option the +situation is reversed: a Netscape certificate sequence is created from +a file of certificates. + +=back + +=head1 EXAMPLES + +Output the certificates in a Netscape certificate sequence + + openssl nseq -in nseq.pem -out certs.pem + +Create a Netscape certificate sequence + + openssl nseq -in certs.pem -toseq -out nseq.pem + +=head1 COPYRIGHT + +Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-prime.pod b/doc/man1/openssl-prime.pod deleted file mode 100644 index aa9af22102..0000000000 --- a/doc/man1/openssl-prime.pod +++ /dev/null @@ -1,66 +0,0 @@ -=pod - -=head1 NAME - -openssl-prime - compute prime numbers - -=head1 SYNOPSIS - -B -[B<-help>] -[B<-hex>] -[B<-generate>] -[B<-bits> I] -[B<-safe>] -[B<-checks> I] -[I ...] - -=head1 DESCRIPTION - -This command checks if the specified numbers are prime. - -If no numbers are given on the command line, the B<-generate> flag should -be used to generate primes according to the requirements specified by the -rest of the flags. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Display an option summary. - -=item B<-hex> - -Generate hex output. - -=item B<-generate> - -Generate a prime number. - -=item B<-bits> I - -Generate a prime with I bits. - -=item B<-safe> - -When used with B<-generate>, generates a "safe" prime. If the number -generated is I, then check that C<(I-1)/2> is also prime. - -=item B<-checks> I - -This parameter is ignored. - -=back - -=head1 COPYRIGHT - -Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-prime.pod.in b/doc/man1/openssl-prime.pod.in new file mode 100644 index 0000000000..9aafabe602 --- /dev/null +++ b/doc/man1/openssl-prime.pod.in @@ -0,0 +1,67 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-prime - compute prime numbers + +=head1 SYNOPSIS + +B +[B<-help>] +[B<-hex>] +[B<-generate>] +[B<-bits> I] +[B<-safe>] +[B<-checks> I] +[I ...] + +=head1 DESCRIPTION + +This command checks if the specified numbers are prime. + +If no numbers are given on the command line, the B<-generate> flag should +be used to generate primes according to the requirements specified by the +rest of the flags. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Display an option summary. + +=item B<-hex> + +Generate hex output. + +=item B<-generate> + +Generate a prime number. + +=item B<-bits> I + +Generate a prime with I bits. + +=item B<-safe> + +When used with B<-generate>, generates a "safe" prime. If the number +generated is I, then check that C<(I-1)/2> is also prime. + +=item B<-checks> I + +This parameter is ignored. + +=back + +=head1 COPYRIGHT + +Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-provider.pod b/doc/man1/openssl-provider.pod deleted file mode 100644 index b29d2f5a26..0000000000 --- a/doc/man1/openssl-provider.pod +++ /dev/null @@ -1,62 +0,0 @@ -=pod - -=head1 NAME - -openssl-provider - load and query providers - -=head1 SYNOPSIS - -B -[B<-help>] -[B<-v>] -[B<-vv>] -[B<-vvv>] -[I ...] - -=head1 DESCRIPTION - -This command is used to query the capabilities of the -specified I's. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print out a usage message. - -=item B<-v> B<-vv> B<-vvv> - -Provides information about each specified provider. -The first flag lists the names of all algorithms each provider -implements; the second lists them by category; the third adds -information on what parameters each of them can handle. - -=back - -=head1 ENVIRONMENT - -=over 4 - -=item B - -The path to the modules directory, where one can expect provider -modules to be located. - -=back - -=head1 SEE ALSO - -L - -=head1 COPYRIGHT - -Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-provider.pod.in b/doc/man1/openssl-provider.pod.in new file mode 100644 index 0000000000..774f92b9ac --- /dev/null +++ b/doc/man1/openssl-provider.pod.in @@ -0,0 +1,63 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-provider - load and query providers + +=head1 SYNOPSIS + +B +[B<-help>] +[B<-v>] +[B<-vv>] +[B<-vvv>] +[I ...] + +=head1 DESCRIPTION + +This command is used to query the capabilities of the +specified I's. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print out a usage message. + +=item B<-v> B<-vv> B<-vvv> + +Provides information about each specified provider. +The first flag lists the names of all algorithms each provider +implements; the second lists them by category; the third adds +information on what parameters each of them can handle. + +=back + +=head1 ENVIRONMENT + +=over 4 + +=item B + +The path to the modules directory, where one can expect provider +modules to be located. + +=back + +=head1 SEE ALSO + +L + +=head1 COPYRIGHT + +Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-rehash.pod b/doc/man1/openssl-rehash.pod deleted file mode 100644 index 241f225380..0000000000 --- a/doc/man1/openssl-rehash.pod +++ /dev/null @@ -1,152 +0,0 @@ -=pod - -=for comment -Original text by James Westby, contributed under the OpenSSL license. - -=head1 NAME - -openssl-rehash, c_rehash - Create symbolic links to files named by the hash -values - -=head1 SYNOPSIS - -B -B -[B<-h>] -[B<-help>] -[B<-old>] -[B<-compat>] -[B<-n>] -[B<-v>] -[I] ... - -B -[B<-h>] -[B<-help>] -[B<-old>] -[B<-n>] -[B<-v>] -[I] ... - -=head1 DESCRIPTION - -This command is generally equivalent to the external -script B, -except for minor differences noted below. - -B scans directories and calculates a hash value of -each F<.pem>, F<.crt>, F<.cer>, or F<.crl> -file in the specified directory list and creates symbolic links -for each file, where the name of the link is the hash value. -(If the platform does not support symbolic links, a copy is made.) -This command is useful as many programs that use OpenSSL require -directories to be set up like this in order to find certificates. - -If any directories are named on the command line, then those are -processed in turn. If not, then the B environment variable -is consulted; this should be a colon-separated list of directories, -like the Unix B variable. -If that is not set then the default directory (installation-specific -but often F) is processed. - -In order for a directory to be processed, the user must have write -permissions on that directory, otherwise an error will be generated. - -The links created are of the form I, where each I -is a hexadecimal character and I is a single decimal digit. -When a directory is processed, all links in it that have a name -in that syntax are first removed, even if they are being used for -some other purpose. -To skip the removal step, use the B<-n> flag. -Hashes for CRL's look similar except the letter B appears after -the period, like this: IBI. - -Multiple objects may have the same hash; they will be indicated by -incrementing the I value. Duplicates are found by comparing the -full SHA-1 fingerprint. A warning will be displayed if a duplicate -is found. - -A warning will also be displayed if there are files that -cannot be parsed as either a certificate or a CRL or if -more than one such object appears in the file. - -=head2 Script Configuration - -The B script -uses the B program to compute the hashes and -fingerprints. If not found in the user's B, then set the -B environment variable to the full pathname. -Any program can be used, it will be invoked as follows for either -a certificate or CRL: - - $OPENSSL x509 -hash -fingerprint -noout -in FILENAME - $OPENSSL crl -hash -fingerprint -noout -in FILENAME - -where I is the filename. It must output the hash of the -file on the first line, and the fingerprint on the second, -optionally prefixed with some text and an equals sign. - -=head1 OPTIONS - -=over 4 - -=item B<-help> B<-h> - -Display a brief usage message. - -=item B<-old> - -Use old-style hashing (MD5, as opposed to SHA-1) for generating -links to be used for releases before 1.0.0. -Note that current versions will not use the old style. - -=item B<-n> - -Do not remove existing links. -This is needed when keeping new and old-style links in the same directory. - -=item B<-compat> - -Generate links for both old-style (MD5) and new-style (SHA1) hashing. -This allows releases before 1.0.0 to use these links along-side newer -releases. - -=item B<-v> - -Print messages about old links removed and new links created. -By default, this command only lists each directory as it is processed. - -=back - -=head1 ENVIRONMENT - -=over 4 - -=item B - -The path to an executable to use to generate hashes and -fingerprints (see above). - -=item B - -Colon separated list of directories to operate on. -Ignored if directories are listed on the command line. - -=back - -=head1 SEE ALSO - -L, -L, -L - -=head1 COPYRIGHT - -Copyright 2015-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-rehash.pod.in b/doc/man1/openssl-rehash.pod.in new file mode 100644 index 0000000000..428de47db7 --- /dev/null +++ b/doc/man1/openssl-rehash.pod.in @@ -0,0 +1,153 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=for comment +Original text by James Westby, contributed under the OpenSSL license. + +=head1 NAME + +openssl-rehash, c_rehash - Create symbolic links to files named by the hash +values + +=head1 SYNOPSIS + +B +B +[B<-h>] +[B<-help>] +[B<-old>] +[B<-compat>] +[B<-n>] +[B<-v>] +[I] ... + +B +[B<-h>] +[B<-help>] +[B<-old>] +[B<-n>] +[B<-v>] +[I] ... + +=head1 DESCRIPTION + +This command is generally equivalent to the external +script B, +except for minor differences noted below. + +B scans directories and calculates a hash value of +each F<.pem>, F<.crt>, F<.cer>, or F<.crl> +file in the specified directory list and creates symbolic links +for each file, where the name of the link is the hash value. +(If the platform does not support symbolic links, a copy is made.) +This command is useful as many programs that use OpenSSL require +directories to be set up like this in order to find certificates. + +If any directories are named on the command line, then those are +processed in turn. If not, then the B environment variable +is consulted; this should be a colon-separated list of directories, +like the Unix B variable. +If that is not set then the default directory (installation-specific +but often F) is processed. + +In order for a directory to be processed, the user must have write +permissions on that directory, otherwise an error will be generated. + +The links created are of the form I, where each I +is a hexadecimal character and I is a single decimal digit. +When a directory is processed, all links in it that have a name +in that syntax are first removed, even if they are being used for +some other purpose. +To skip the removal step, use the B<-n> flag. +Hashes for CRL's look similar except the letter B appears after +the period, like this: IBI. + +Multiple objects may have the same hash; they will be indicated by +incrementing the I value. Duplicates are found by comparing the +full SHA-1 fingerprint. A warning will be displayed if a duplicate +is found. + +A warning will also be displayed if there are files that +cannot be parsed as either a certificate or a CRL or if +more than one such object appears in the file. + +=head2 Script Configuration + +The B script +uses the B program to compute the hashes and +fingerprints. If not found in the user's B, then set the +B environment variable to the full pathname. +Any program can be used, it will be invoked as follows for either +a certificate or CRL: + + $OPENSSL x509 -hash -fingerprint -noout -in FILENAME + $OPENSSL crl -hash -fingerprint -noout -in FILENAME + +where I is the filename. It must output the hash of the +file on the first line, and the fingerprint on the second, +optionally prefixed with some text and an equals sign. + +=head1 OPTIONS + +=over 4 + +=item B<-help> B<-h> + +Display a brief usage message. + +=item B<-old> + +Use old-style hashing (MD5, as opposed to SHA-1) for generating +links to be used for releases before 1.0.0. +Note that current versions will not use the old style. + +=item B<-n> + +Do not remove existing links. +This is needed when keeping new and old-style links in the same directory. + +=item B<-compat> + +Generate links for both old-style (MD5) and new-style (SHA1) hashing. +This allows releases before 1.0.0 to use these links along-side newer +releases. + +=item B<-v> + +Print messages about old links removed and new links created. +By default, this command only lists each directory as it is processed. + +=back + +=head1 ENVIRONMENT + +=over 4 + +=item B + +The path to an executable to use to generate hashes and +fingerprints (see above). + +=item B + +Colon separated list of directories to operate on. +Ignored if directories are listed on the command line. + +=back + +=head1 SEE ALSO + +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2015-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-sess_id.pod b/doc/man1/openssl-sess_id.pod deleted file mode 100644 index bb49dbd56b..0000000000 --- a/doc/man1/openssl-sess_id.pod +++ /dev/null @@ -1,161 +0,0 @@ -=pod - -=head1 NAME - -openssl-sess_id - SSL/TLS session handling utility - -=head1 SYNOPSIS - -B B -[B<-help>] -[B<-inform> B|B] -[B<-outform> B|B|B] -[B<-in> I] -[B<-out> I] -[B<-text>] -[B<-cert>] -[B<-noout>] -[B<-context> I] - -=head1 DESCRIPTION - -This command processes the encoded version of the SSL session -structure and optionally prints out SSL session details (for example -the SSL session master key) in human readable format. Since this is a -diagnostic tool that needs some knowledge of the SSL protocol to use -properly, most users will not need to use it. - -The precise format of the data can vary across OpenSSL versions and -is not documented. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print out a usage message. - -=item B<-inform> B|B, B<-outform> B|B|B - -The input and output formats; the default is PEM. -See L for details. - -For B output, the session ID and master key are reported in NSS "keylog" -format. - -=item B<-in> I - -This specifies the input filename to read session information from or standard -input by default. - -=item B<-out> I - -This specifies the output filename to write session information to or standard -output if this option is not specified. - -=item B<-text> - -Prints out the various public or private key components in -plain text in addition to the encoded version. - -=item B<-cert> - -If a certificate is present in the session it will be output using this option, -if the B<-text> option is also present then it will be printed out in text form. - -=item B<-noout> - -This option prevents output of the encoded version of the session. - -=item B<-context> I - -This option can set the session id so the output session information uses the -supplied ID. The ID can be any string of characters. This option won't normally -be used. - -=back - -=head1 OUTPUT - -Typical output: - - SSL-Session: - Protocol : TLSv1 - Cipher : 0016 - Session-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED - Session-ID-ctx: 01000000 - Master-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD - Key-Arg : None - Start Time: 948459261 - Timeout : 300 (sec) - Verify return code 0 (ok) - -These are described below in more detail. - -=over 4 - -=item B - -This is the protocol in use TLSv1.3, TLSv1.2, TLSv1.1, TLSv1 or SSLv3. - -=item B - -The cipher used this is the actual raw SSL or TLS cipher code, see the SSL -or TLS specifications for more information. - -=item B - -The SSL session ID in hex format. - -=item B - -The session ID context in hex format. - -=item B - -This is the SSL session master key. - -=item B - -This is the session start time represented as an integer in standard -Unix format. - -=item B - -The timeout in seconds. - -=item B - -This is the return code when an SSL client certificate is verified. - -=back - -=head1 NOTES - -Since the SSL session output contains the master key it is -possible to read the contents of an encrypted session using this -information. Therefore appropriate security precautions should be taken if -the information is being output by a "real" application. This is however -strongly discouraged and should only be used for debugging purposes. - -=head1 BUGS - -The cipher and start time should be printed out in human readable form. - -=head1 SEE ALSO - -L, -L, -L - -=head1 COPYRIGHT - -Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-sess_id.pod.in b/doc/man1/openssl-sess_id.pod.in new file mode 100644 index 0000000000..f68f180739 --- /dev/null +++ b/doc/man1/openssl-sess_id.pod.in @@ -0,0 +1,162 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-sess_id - SSL/TLS session handling utility + +=head1 SYNOPSIS + +B B +[B<-help>] +[B<-inform> B|B] +[B<-outform> B|B|B] +[B<-in> I] +[B<-out> I] +[B<-text>] +[B<-cert>] +[B<-noout>] +[B<-context> I] + +=head1 DESCRIPTION + +This command processes the encoded version of the SSL session +structure and optionally prints out SSL session details (for example +the SSL session master key) in human readable format. Since this is a +diagnostic tool that needs some knowledge of the SSL protocol to use +properly, most users will not need to use it. + +The precise format of the data can vary across OpenSSL versions and +is not documented. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print out a usage message. + +=item B<-inform> B|B, B<-outform> B|B|B + +The input and output formats; the default is PEM. +See L for details. + +For B output, the session ID and master key are reported in NSS "keylog" +format. + +=item B<-in> I + +This specifies the input filename to read session information from or standard +input by default. + +=item B<-out> I + +This specifies the output filename to write session information to or standard +output if this option is not specified. + +=item B<-text> + +Prints out the various public or private key components in +plain text in addition to the encoded version. + +=item B<-cert> + +If a certificate is present in the session it will be output using this option, +if the B<-text> option is also present then it will be printed out in text form. + +=item B<-noout> + +This option prevents output of the encoded version of the session. + +=item B<-context> I + +This option can set the session id so the output session information uses the +supplied ID. The ID can be any string of characters. This option won't normally +be used. + +=back + +=head1 OUTPUT + +Typical output: + + SSL-Session: + Protocol : TLSv1 + Cipher : 0016 + Session-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED + Session-ID-ctx: 01000000 + Master-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD + Key-Arg : None + Start Time: 948459261 + Timeout : 300 (sec) + Verify return code 0 (ok) + +These are described below in more detail. + +=over 4 + +=item B + +This is the protocol in use TLSv1.3, TLSv1.2, TLSv1.1, TLSv1 or SSLv3. + +=item B + +The cipher used this is the actual raw SSL or TLS cipher code, see the SSL +or TLS specifications for more information. + +=item B + +The SSL session ID in hex format. + +=item B + +The session ID context in hex format. + +=item B + +This is the SSL session master key. + +=item B + +This is the session start time represented as an integer in standard +Unix format. + +=item B + +The timeout in seconds. + +=item B + +This is the return code when an SSL client certificate is verified. + +=back + +=head1 NOTES + +Since the SSL session output contains the master key it is +possible to read the contents of an encrypted session using this +information. Therefore appropriate security precautions should be taken if +the information is being output by a "real" application. This is however +strongly discouraged and should only be used for debugging purposes. + +=head1 BUGS + +The cipher and start time should be printed out in human readable form. + +=head1 SEE ALSO + +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man1/openssl-version.pod b/doc/man1/openssl-version.pod deleted file mode 100644 index 62d50ce701..0000000000 --- a/doc/man1/openssl-version.pod +++ /dev/null @@ -1,95 +0,0 @@ -=pod - -=head1 NAME - -openssl-version - print OpenSSL version information - -=head1 SYNOPSIS - -B -[B<-help>] -[B<-a>] -[B<-v>] -[B<-b>] -[B<-o>] -[B<-f>] -[B<-p>] -[B<-d>] -[B<-e>] -[B<-m>] -[B<-r>] -[B<-c>] - -=head1 DESCRIPTION - -This command is used to print out version information about OpenSSL. - -=head1 OPTIONS - -=over 4 - -=item B<-help> - -Print out a usage message. - -=item B<-a> - -All information, this is the same as setting all the other flags. - -=item B<-v> - -The current OpenSSL version. - -=item B<-b> - -The date the current version of OpenSSL was built. - -=item B<-o> - -Option information: various options set when the library was built. - -=item B<-f> - -Compilation flags. - -=item B<-p> - -Platform setting. - -=item B<-d> - -OPENSSLDIR setting. - -=item B<-e> - -ENGINESDIR settings. - -=item B<-m> - -MODULESDIR settings. - -=item B<-r> - -The random number generator source settings. - -=item B<-c> - -The OpenSSL CPU settings info. - -=back - -=head1 NOTES - -The output of C would typically be used when sending -in a bug report. - -=head1 COPYRIGHT - -Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man1/openssl-version.pod.in b/doc/man1/openssl-version.pod.in new file mode 100644 index 0000000000..d2aaaecbf3 --- /dev/null +++ b/doc/man1/openssl-version.pod.in @@ -0,0 +1,96 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-version - print OpenSSL version information + +=head1 SYNOPSIS + +B +[B<-help>] +[B<-a>] +[B<-v>] +[B<-b>] +[B<-o>] +[B<-f>] +[B<-p>] +[B<-d>] +[B<-e>] +[B<-m>] +[B<-r>] +[B<-c>] + +=head1 DESCRIPTION + +This command is used to print out version information about OpenSSL. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Print out a usage message. + +=item B<-a> + +All information, this is the same as setting all the other flags. + +=item B<-v> + +The current OpenSSL version. + +=item B<-b> + +The date the current version of OpenSSL was built. + +=item B<-o> + +Option information: various options set when the library was built. + +=item B<-f> + +Compilation flags. + +=item B<-p> + +Platform setting. + +=item B<-d> + +OPENSSLDIR setting. + +=item B<-e> + +ENGINESDIR settings. + +=item B<-m> + +MODULESDIR settings. + +=item B<-r> + +The random number generator source settings. + +=item B<-c> + +The OpenSSL CPU settings info. + +=back + +=head1 NOTES + +The output of C would typically be used when sending +in a bug report. + +=head1 COPYRIGHT + +Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut