5 openssl - OpenSSL command line tool
14 B<openssl> B<list> [ B<standard-commands> | B<digest-commands> | B<cipher-commands> | B<cipher-algorithms> | B<digest-algorithms> | B<public-key-algorithms>]
16 B<openssl> B<no->I<XXX> [ I<arbitrary options> ]
20 OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (SSL
21 v2/v3) and Transport Layer Security (TLS v1) network protocols and related
22 cryptography standards required by them.
24 The B<openssl> program is a command line tool for using the various
25 cryptography functions of OpenSSL's B<crypto> library from the shell.
28 o Creation and management of private keys, public keys and parameters
29 o Public key cryptographic operations
30 o Creation of X.509 certificates, CSRs and CRLs
31 o Calculation of Message Digests
32 o Encryption and Decryption with Ciphers
33 o SSL/TLS Client and Server Tests
34 o Handling of S/MIME signed or encrypted mail
35 o Time Stamp requests, generation and verification
37 =head1 COMMAND SUMMARY
39 The B<openssl> program provides a rich variety of commands (I<command> in the
40 SYNOPSIS above), each of which often has a wealth of options and arguments
41 (I<command_opts> and I<command_args> in the SYNOPSIS).
43 Detailed documentation and use cases for most standard subcommands are available
44 (e.g., L<x509(1)> or L<openssl-x509(1)>).
46 Many commands use an external configuration file for some or all of their
47 arguments and have a B<-config> option to specify that file.
48 The environment variable B<OPENSSL_CONF> can be used to specify
49 the location of the file.
50 If the environment variable is not specified, then the file is named
51 B<openssl.cnf> in the default certificate storage area, whose value
52 depends on the configuration flags specified when the OpenSSL
55 The list parameters B<standard-commands>, B<digest-commands>,
56 and B<cipher-commands> output a list (one entry per line) of the names
57 of all standard commands, message digest commands, or cipher commands,
58 respectively, that are available in the present B<openssl> utility.
60 The list parameters B<cipher-algorithms> and
61 B<digest-algorithms> list all cipher and message digest names, one entry per line. Aliases are listed as:
65 The list parameter B<public-key-algorithms> lists all supported public
68 The command B<no->I<XXX> tests whether a command of the
69 specified name is available. If no command named I<XXX> exists, it
70 returns 0 (success) and prints B<no->I<XXX>; otherwise it returns 1
71 and prints I<XXX>. In both cases, the output goes to B<stdout> and
72 nothing is printed to B<stderr>. Additional command line arguments
73 are always ignored. Since for each cipher there is a command of the
74 same name, this provides an easy way for shell scripts to test for the
75 availability of ciphers in the B<openssl> program. (B<no->I<XXX> is
76 not able to detect pseudo-commands such as B<quit>,
77 B<list>, or B<no->I<XXX> itself.)
79 =head2 Standard Commands
85 Parse an ASN.1 sequence.
89 Certificate Authority (CA) Management.
93 Cipher Suite Description Determination.
97 CMS (Cryptographic Message Syntax) utility.
101 Certificate Revocation List (CRL) Management.
105 CRL to PKCS#7 Conversion.
109 Message Digest Calculation.
113 Diffie-Hellman Parameter Management.
114 Obsoleted by L<dhparam(1)>.
118 Generation and Management of Diffie-Hellman Parameters. Superseded by
119 L<genpkey(1)> and L<pkeyparam(1)>.
127 DSA Parameter Generation and Management. Superseded by
128 L<genpkey(1)> and L<pkeyparam(1)>.
132 EC (Elliptic curve) key processing.
136 EC parameter manipulation and generation.
140 Encoding with Ciphers.
144 Engine (loadable module) information and manipulation.
148 Error Number to Error String Conversion.
152 Generation of Diffie-Hellman Parameters.
153 Obsoleted by L<dhparam(1)>.
157 Generation of DSA Private Key from Parameters. Superseded by
158 L<genpkey(1)> and L<pkey(1)>.
162 Generation of Private Key or Parameters.
166 Generation of RSA Private Key. Superseded by L<genpkey(1)>.
170 Create or examine a Netscape certificate sequence.
174 Online Certificate Status Protocol utility.
178 Generation of hashed passwords.
182 PKCS#12 Data Management.
186 PKCS#7 Data Management.
190 PKCS#8 format private key conversion tool.
194 Public and private key management.
198 Public key algorithm parameter management.
202 Public key algorithm cryptographic operation utility.
206 Compute prime numbers.
210 Generate pseudo-random bytes.
214 Create symbolic links to certificate and CRL files named by the hash values.
218 PKCS#10 X.509 Certificate Signing Request (CSR) Management.
226 RSA utility for signing, verification, encryption, and decryption. Superseded
231 This implements a generic SSL/TLS client which can establish a transparent
232 connection to a remote server speaking SSL/TLS. It's intended for testing
233 purposes only and provides only rudimentary interface functionality but
234 internally uses mostly all functionality of the OpenSSL B<ssl> library.
238 This implements a generic SSL/TLS server which accepts connections from remote
239 clients speaking SSL/TLS. It's intended for testing purposes only and provides
240 only rudimentary interface functionality but internally uses mostly all
241 functionality of the OpenSSL B<ssl> library. It provides both an own command
242 line oriented protocol for testing SSL functions and a simple HTTP response
243 facility to emulate an SSL/TLS-aware webserver.
247 SSL Connection Timer.
251 SSL Session Data Management.
255 S/MIME mail processing.
259 Algorithm Speed Measurement.
263 SPKAC printing and generating utility.
267 Maintain SRP password file.
271 Utility to list and display certificates, keys, CRLs, etc.
275 Time Stamping Authority tool (client/server).
279 X.509 Certificate Verification.
283 OpenSSL Version Information.
287 X.509 Certificate Data Management.
291 =head2 Message Digest Commands
361 SHA-3 SHAKE128 Digest
365 SHA-3 SHAKE256 Digest
373 =head2 Encoding and Cipher Commands
375 The following aliases provide convenient access to the most used encodings
378 Depending on how OpenSSL was configured and built, not all ciphers listed
379 here may be present. See L<enc(1)> for more information and command usage.
383 =item B<aes128>, B<aes-128-cbc>, B<aes-128-cfb>, B<aes-128-ctr>, B<aes-128-ecb>, B<aes-128-ofb>
387 =item B<aes192>, B<aes-192-cbc>, B<aes-192-cfb>, B<aes-192-ctr>, B<aes-192-ecb>, B<aes-192-ofb>
391 =item B<aes256>, B<aes-256-cbc>, B<aes-256-cfb>, B<aes-256-ctr>, B<aes-256-ecb>, B<aes-256-ofb>
395 =item B<aria128>, B<aria-128-cbc>, B<aria-128-cfb>, B<aria-128-ctr>, B<aria-128-ecb>, B<aria-128-ofb>
399 =item B<aria192>, B<aria-192-cbc>, B<aria-192-cfb>, B<aria-192-ctr>, B<aria-192-ecb>, B<aria-192-ofb>
403 =item B<aria256>, B<aria-256-cbc>, B<aria-256-cfb>, B<aria-256-ctr>, B<aria-256-ecb>, B<aria-256-ofb>
411 =item B<bf>, B<bf-cbc>, B<bf-cfb>, B<bf-ecb>, B<bf-ofb>
415 =item B<camellia128>, B<camellia-128-cbc>, B<camellia-128-cfb>, B<camellia-128-ctr>, B<camellia-128-ecb>, B<camellia-128-ofb>
419 =item B<camellia192>, B<camellia-192-cbc>, B<camellia-192-cfb>, B<camellia-192-ctr>, B<camellia-192-ecb>, B<camellia-192-ofb>
423 =item B<camellia256>, B<camellia-256-cbc>, B<camellia-256-cfb>, B<camellia-256-ctr>, B<camellia-256-ecb>, B<camellia-256-ofb>
427 =item B<cast>, B<cast-cbc>
431 =item B<cast5-cbc>, B<cast5-cfb>, B<cast5-ecb>, B<cast5-ofb>
439 =item B<des>, B<des-cbc>, B<des-cfb>, B<des-ecb>, B<des-ede>, B<des-ede-cbc>, B<des-ede-cfb>, B<des-ede-ofb>, B<des-ofb>
443 =item B<des3>, B<desx>, B<des-ede3>, B<des-ede3-cbc>, B<des-ede3-cfb>, B<des-ede3-ofb>
447 =item B<idea>, B<idea-cbc>, B<idea-cfb>, B<idea-ecb>, B<idea-ofb>
451 =item B<rc2>, B<rc2-cbc>, B<rc2-cfb>, B<rc2-ecb>, B<rc2-ofb>
459 =item B<rc5>, B<rc5-cbc>, B<rc5-cfb>, B<rc5-ecb>, B<rc5-ofb>
463 =item B<seed>, B<seed-cbc>, B<seed-cfb>, B<seed-ecb>, B<seed-ofb>
467 =item B<sm4>, B<sm4-cbc>, B<sm4-cfb>, B<sm4-ctr>, B<sm4-ecb>, B<sm4-ofb>
475 Details of which options are available depend on the specific command.
476 This section describes some common options with common behavior.
478 =head2 Common Options
484 Provides a terse summary of all options.
488 =head2 Pass Phrase Options
490 Several commands accept password arguments, typically using B<-passin>
491 and B<-passout> for input and output passwords respectively. These allow
492 the password to be obtained from a variety of sources. Both of these
493 options take a single argument whose format is described below. If no
494 password argument is given and a password is required then the user is
495 prompted to enter one: this will typically be read from the current
496 terminal with echoing turned off.
498 Note that character encoding may be relevant, please see
499 L<passphrase-encoding(7)>.
503 =item B<pass:password>
505 The actual password is B<password>. Since the password is visible
506 to utilities (like 'ps' under Unix) this form should only be used
507 where security is not important.
511 Obtain the password from the environment variable B<var>. Since
512 the environment of other processes is visible on certain platforms
513 (e.g. ps under certain Unix OSes) this option should be used with caution.
515 =item B<file:pathname>
517 The first line of B<pathname> is the password. If the same B<pathname>
518 argument is supplied to B<-passin> and B<-passout> arguments then the first
519 line will be used for the input password and the next line for the output
520 password. B<pathname> need not refer to a regular file: it could for example
521 refer to a device or named pipe.
525 Read the password from the file descriptor B<number>. This can be used to
526 send the data via a pipe for example.
530 Read the password from standard input.
536 L<asn1parse(1)>, L<ca(1)>, L<ciphers(1)>, L<cms(1)>, L<config(5)>,
537 L<crl(1)>, L<crl2pkcs7(1)>, L<dgst(1)>,
538 L<dhparam(1)>, L<dsa(1)>, L<dsaparam(1)>,
539 L<ec(1)>, L<ecparam(1)>,
540 L<enc(1)>, L<engine(1)>, L<errstr(1)>, L<gendsa(1)>, L<genpkey(1)>,
541 L<genrsa(1)>, L<nseq(1)>, L<ocsp(1)>,
543 L<pkcs12(1)>, L<pkcs7(1)>, L<pkcs8(1)>,
544 L<pkey(1)>, L<pkeyparam(1)>, L<pkeyutl(1)>, L<prime(1)>,
545 L<rand(1)>, L<rehash(1)>, L<req(1)>, L<rsa(1)>,
546 L<rsautl(1)>, L<s_client(1)>,
547 L<s_server(1)>, L<s_time(1)>, L<sess_id(1)>,
548 L<smime(1)>, L<speed(1)>, L<spkac(1)>, L<srp(1)>, L<storeutl(1)>,
550 L<verify(1)>, L<version(1)>, L<x509(1)>,
551 L<crypto(7)>, L<ssl(7)>, L<x509v3_config(5)>
555 The B<list->I<XXX>B<-algorithms> pseudo-commands were added in OpenSSL 1.0.0;
556 For notes on the availability of other commands, see their individual
561 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
563 Licensed under the OpenSSL license (the "License"). You may not use
564 this file except in compliance with the License. You can obtain a copy
565 in the file LICENSE in the source distribution or at
566 L<https://www.openssl.org/source/license.html>.