doc/man1/openssl.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl - OpenSSL command line tool
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl>
  10 I<command>
  11 [ I<command_opts> ]
  12 [ I<command_args> ]
  13
  14 B<openssl> B<list> [ B<standard-commands> | B<digest-commands> | B<cipher-commands> | B<cipher-algorithms> | B<digest-algorithms> | B<public-key-algorithms>]
  15
  16 B<openssl> B<no->I<XXX> [ I<arbitrary options> ]
  17
  18 =head1 DESCRIPTION
  19
  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.
  23
  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.
  26 It can be used for
  27
  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
  36
  37 =head1 COMMAND SUMMARY
  38
  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).
  42
  43 Many commands use an external configuration file for some or all of their
  44 arguments and have a B<-config> option to specify that file.
  45 The environment variable B<OPENSSL_CONF> can be used to specify
  46 the location of the file.
  47 If the environment variable is not specified, then the file is named
  48 B<openssl.cnf> in the default certificate storage area, whose value
  49 depends on the configuration flags specified when the OpenSSL
  50 was built.
  51
  52 The list parameters B<standard-commands>, B<digest-commands>,
  53 and B<cipher-commands> output a list (one entry per line) of the names
  54 of all standard commands, message digest commands, or cipher commands,
  55 respectively, that are available in the present B<openssl> utility.
  56
  57 The list parameters B<cipher-algorithms> and
  58 B<digest-algorithms> list all cipher and message digest names, one entry per line. Aliases are listed as:
  59
  60  from => to
  61
  62 The list parameter B<public-key-algorithms> lists all supported public
  63 key algorithms.
  64
  65 The command B<no->I<XXX> tests whether a command of the
  66 specified name is available.  If no command named I<XXX> exists, it
  67 returns 0 (success) and prints B<no->I<XXX>; otherwise it returns 1
  68 and prints I<XXX>.  In both cases, the output goes to B<stdout> and
  69 nothing is printed to B<stderr>.  Additional command line arguments
  70 are always ignored.  Since for each cipher there is a command of the
  71 same name, this provides an easy way for shell scripts to test for the
  72 availability of ciphers in the B<openssl> program.  (B<no->I<XXX> is
  73 not able to detect pseudo-commands such as B<quit>,
  74 B<list>, or B<no->I<XXX> itself.)
  75
  76 =head2 Standard Commands
  77
  78 =over 4
  79
  80 =item L<B<asn1parse>|asn1parse(1)>
  81
  82 Parse an ASN.1 sequence.
  83
  84 =item L<B<ca>|ca(1)>
  85
  86 Certificate Authority (CA) Management.
  87
  88 =item L<B<ciphers>|ciphers(1)>
  89
  90 Cipher Suite Description Determination.
  91
  92 =item L<B<cms>|cms(1)>
  93
  94 CMS (Cryptographic Message Syntax) utility.
  95
  96 =item L<B<crl>|crl(1)>
  97
  98 Certificate Revocation List (CRL) Management.
  99
 100 =item L<B<crl2pkcs7>|crl2pkcs7(1)>
 101
 102 CRL to PKCS#7 Conversion.
 103
 104 =item L<B<dgst>|dgst(1)>
 105
 106 Message Digest Calculation.
 107
 108 =item B<dh>
 109
 110 Diffie-Hellman Parameter Management.
 111 Obsoleted by L<B<dhparam>|dhparam(1)>.
 112
 113 =item L<B<dhparam>|dhparam(1)>
 114
 115 Generation and Management of Diffie-Hellman Parameters. Superseded by
 116 L<B<genpkey>|genpkey(1)> and L<B<pkeyparam>|pkeyparam(1)>.
 117
 118 =item L<B<dsa>|dsa(1)>
 119
 120 DSA Data Management.
 121
 122 =item L<B<dsaparam>|dsaparam(1)>
 123
 124 DSA Parameter Generation and Management. Superseded by
 125 L<B<genpkey>|genpkey(1)> and L<B<pkeyparam>|pkeyparam(1)>.
 126
 127 =item L<B<ec>|ec(1)>
 128
 129 EC (Elliptic curve) key processing.
 130
 131 =item L<B<ecparam>|ecparam(1)>
 132
 133 EC parameter manipulation and generation.
 134
 135 =item L<B<enc>|enc(1)>
 136
 137 Encoding with Ciphers.
 138
 139 =item L<B<engine>|engine(1)>
 140
 141 Engine (loadable module) information and manipulation.
 142
 143 =item L<B<errstr>|errstr(1)>
 144
 145 Error Number to Error String Conversion.
 146
 147 =item B<gendh>
 148
 149 Generation of Diffie-Hellman Parameters.
 150 Obsoleted by L<B<dhparam>|dhparam(1)>.
 151
 152 =item L<B<gendsa>|gendsa(1)>
 153
 154 Generation of DSA Private Key from Parameters. Superseded by
 155 L<B<genpkey>|genpkey(1)> and L<B<pkey>|pkey(1)>.
 156
 157 =item L<B<genpkey>|genpkey(1)>
 158
 159 Generation of Private Key or Parameters.
 160
 161 =item L<B<genrsa>|genrsa(1)>
 162
 163 Generation of RSA Private Key. Superseded by L<B<genpkey>|genpkey(1)>.
 164
 165 =item L<B<nseq>|nseq(1)>
 166
 167 Create or examine a Netscape certificate sequence.
 168
 169 =item L<B<ocsp>|ocsp(1)>
 170
 171 Online Certificate Status Protocol utility.
 172
 173 =item L<B<passwd>|passwd(1)>
 174
 175 Generation of hashed passwords.
 176
 177 =item L<B<pkcs12>|pkcs12(1)>
 178
 179 PKCS#12 Data Management.
 180
 181 =item L<B<pkcs7>|pkcs7(1)>
 182
 183 PKCS#7 Data Management.
 184
 185 =item L<B<pkey>|pkey(1)>
 186
 187 Public and private key management.
 188
 189 =item L<B<pkeyparam>|pkeyparam(1)>
 190
 191 Public key algorithm parameter management.
 192
 193 =item L<B<pkeyutl>|pkeyutl(1)>
 194
 195 Public key algorithm cryptographic operation utility.
 196
 197 =item L<B<rand>|rand(1)>
 198
 199 Generate pseudo-random bytes.
 200
 201 =item L<B<req>|req(1)>
 202
 203 PKCS#10 X.509 Certificate Signing Request (CSR) Management.
 204
 205 =item L<B<rsa>|rsa(1)>
 206
 207 RSA key management.
 208
 209
 210 =item L<B<rsautl>|rsautl(1)>
 211
 212 RSA utility for signing, verification, encryption, and decryption. Superseded
 213 by  L<B<pkeyutl>|pkeyutl(1)>.
 214
 215 =item L<B<s_client>|s_client(1)>
 216
 217 This implements a generic SSL/TLS client which can establish a transparent
 218 connection to a remote server speaking SSL/TLS. It's intended for testing
 219 purposes only and provides only rudimentary interface functionality but
 220 internally uses mostly all functionality of the OpenSSL B<ssl> library.
 221
 222 =item L<B<s_server>|s_server(1)>
 223
 224 This implements a generic SSL/TLS server which accepts connections from remote
 225 clients speaking SSL/TLS. It's intended for testing purposes only and provides
 226 only rudimentary interface functionality but internally uses mostly all
 227 functionality of the OpenSSL B<ssl> library.  It provides both an own command
 228 line oriented protocol for testing SSL functions and a simple HTTP response
 229 facility to emulate an SSL/TLS-aware webserver.
 230
 231 =item L<B<s_time>|s_time(1)>
 232
 233 SSL Connection Timer.
 234
 235 =item L<B<sess_id>|sess_id(1)>
 236
 237 SSL Session Data Management.
 238
 239 =item L<B<smime>|smime(1)>
 240
 241 S/MIME mail processing.
 242
 243 =item L<B<speed>|speed(1)>
 244
 245 Algorithm Speed Measurement.
 246
 247 =item L<B<spkac>|spkac(1)>
 248
 249 SPKAC printing and generating utility.
 250
 251 =item L<B<ts>|ts(1)>
 252
 253 Time Stamping Authority tool (client/server).
 254
 255 =item L<B<verify>|verify(1)>
 256
 257 X.509 Certificate Verification.
 258
 259 =item L<B<version>|version(1)>
 260
 261 OpenSSL Version Information.
 262
 263 =item L<B<x509>|x509(1)>
 264
 265 X.509 Certificate Data Management.
 266
 267 =back
 268
 269 =head2 Message Digest Commands
 270
 271 =over 4
 272
 273 =item B<md2>
 274
 275 MD2 Digest
 276
 277 =item B<md5>
 278
 279 MD5 Digest
 280
 281 =item B<mdc2>
 282
 283 MDC2 Digest
 284
 285 =item B<rmd160>
 286
 287 RMD-160 Digest
 288
 289 =item B<sha>
 290
 291 SHA Digest
 292
 293 =item B<sha1>
 294
 295 SHA-1 Digest
 296
 297 =item B<sha224>
 298
 299 SHA-224 Digest
 300
 301 =item B<sha256>
 302
 303 SHA-256 Digest
 304
 305 =item B<sha384>
 306
 307 SHA-384 Digest
 308
 309 =item B<sha512>
 310
 311 SHA-512 Digest
 312
 313 =back
 314
 315 =head2 Encoding and Cipher Commands
 316
 317 =over 4
 318
 319 =item B<base64>
 320
 321 Base64 Encoding
 322
 323 =item B<bf bf-cbc bf-cfb bf-ecb bf-ofb>
 324
 325 Blowfish Cipher
 326
 327 =item B<cast cast-cbc>
 328
 329 CAST Cipher
 330
 331 =item B<cast5-cbc cast5-cfb cast5-ecb cast5-ofb>
 332
 333 CAST5 Cipher
 334
 335 =item B<des des-cbc des-cfb des-ecb des-ede des-ede-cbc des-ede-cfb des-ede-ofb des-ofb>
 336
 337 DES Cipher
 338
 339 =item B<des3 desx des-ede3 des-ede3-cbc des-ede3-cfb des-ede3-ofb>
 340
 341 Triple-DES Cipher
 342
 343 =item B<idea idea-cbc idea-cfb idea-ecb idea-ofb>
 344
 345 IDEA Cipher
 346
 347 =item B<rc2 rc2-cbc rc2-cfb rc2-ecb rc2-ofb>
 348
 349 RC2 Cipher
 350
 351 =item B<rc4>
 352
 353 RC4 Cipher
 354
 355 =item B<rc5 rc5-cbc rc5-cfb rc5-ecb rc5-ofb>
 356
 357 RC5 Cipher
 358
 359 =back
 360
 361 =head1 OPTIONS
 362
 363 Details of which options are available depend on the specific command.
 364 This section describes some common options with common behavior.
 365
 366 =head2 Common Options
 367
 368 =over 4
 369
 370 =item B<-help>
 371
 372 Provides a terse summary of all options.
 373
 374 =back
 375
 376 =head2 Pass Phrase Options
 377
 378 Several commands accept password arguments, typically using B<-passin>
 379 and B<-passout> for input and output passwords respectively. These allow
 380 the password to be obtained from a variety of sources. Both of these
 381 options take a single argument whose format is described below. If no
 382 password argument is given and a password is required then the user is
 383 prompted to enter one: this will typically be read from the current
 384 terminal with echoing turned off.
 385
 386 =over 4
 387
 388 =item B<pass:password>
 389
 390 The actual password is B<password>. Since the password is visible
 391 to utilities (like 'ps' under Unix) this form should only be used
 392 where security is not important.
 393
 394 =item B<env:var>
 395
 396 Obtain the password from the environment variable B<var>. Since
 397 the environment of other processes is visible on certain platforms
 398 (e.g. ps under certain Unix OSes) this option should be used with caution.
 399
 400 =item B<file:pathname>
 401
 402 The first line of B<pathname> is the password. If the same B<pathname>
 403 argument is supplied to B<-passin> and B<-passout> arguments then the first
 404 line will be used for the input password and the next line for the output
 405 password. B<pathname> need not refer to a regular file: it could for example
 406 refer to a device or named pipe.
 407
 408 =item B<fd:number>
 409
 410 Read the password from the file descriptor B<number>. This can be used to
 411 send the data via a pipe for example.
 412
 413 =item B<stdin>
 414
 415 Read the password from standard input.
 416
 417 =back
 418
 419 =head1 SEE ALSO
 420
 421 L<asn1parse(1)>, L<ca(1)>, L<config(5)>,
 422 L<crl(1)>, L<crl2pkcs7(1)>, L<dgst(1)>,
 423 L<dhparam(1)>, L<dsa(1)>, L<dsaparam(1)>,
 424 L<enc(1)>, L<engine(1)>, L<gendsa(1)>, L<genpkey(1)>,
 425 L<genrsa(1)>, L<nseq(1)>, L<openssl(1)>,
 426 L<passwd(1)>,
 427 L<pkcs12(1)>, L<pkcs7(1)>, L<pkcs8(1)>,
 428 L<rand(1)>, L<req(1)>, L<rsa(1)>,
 429 L<rsautl(1)>, L<s_client(1)>,
 430 L<s_server(1)>, L<s_time(1)>,
 431 L<smime(1)>, L<spkac(1)>,
 432 L<verify(1)>, L<version(1)>, L<x509(1)>,
 433 L<crypto(7)>, L<ssl(7)>, L<x509v3_config(5)>
 434
 435 =head1 HISTORY
 436
 437 The B<list->I<XXX>B<-algorithms> pseudo-commands were added in OpenSSL 1.0.0;
 438 For notes on the availability of other commands, see their individual
 439 manual pages.
 440
 441 =head1 COPYRIGHT
 442
 443 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
 444
 445 Licensed under the OpenSSL license (the "License").  You may not use
 446 this file except in compliance with the License.  You can obtain a copy
 447 in the file LICENSE in the source distribution or at
 448 L<https://www.openssl.org/source/license.html>.
 449
 450 =cut