Openssl Tool
Download OpenSSL - Embed SSL and TLS support into your projects to enhance security with the help of this lightweight cryptography library, which comprises various encryption algorithms.
Check other Tools Other SSL Tools for Easy Installation of SSL Certificates. Sometimes it becomes tough to manage SSL/TLS Certificate. If you haven't found what you are looking for, here are a bunch of different tools and guides like CSR generation guide based on servers, go through it and find the right solution for yourself. This tutorial shows you how to access Oracle Messaging Cloud Service via the REST interface by using the cURL command-line tool. Generate new self-signed certificates for ESXi using OpenSSLPush SSL certificates to client computers using Group PolicyReplacing a default ESXi certificate with a CA-Signed certificate. Quickly and easily convert SSL format that your server accepts. Converting the SSL Certificate format (pem, der, p7b and pfx) is a cakewalk now!
Deciding on Key Generation Options
When generating a key, you have to decide three things: the key algorithm, the key size, and whether to use a passphrase.
Key Algorithm
For the key algorithm, you need to take into account its compatibility. For this reason, we recommend you use RSA. However, if you have a specific need to use another algorithm (such as ECDSA), you can use that too, but be aware of the compatibility issues you might run into.
Note: This guide only covers generating keys using the RSA algorithm.
Key Size
For the key size, you need to select a bit length of at least 2048 when using RSA and 256 when using ECDSA; these are the smallest key sizes allowed for SSL certificates. Unless you need to use a larger key size, we recommend sticking with 2048 with RSA and 256 with ECDSA.
Openssl Toolkit For Mac
Note: In older versions of OpenSSL, if no key size is specified, the default key size of 512 is used. Any key size lower than 2048 is considered unsecure and should never be used.
Passphrase
For the passphrase, you need to decide whether you want to use one. If used, the private key will be encrypted using the specified encryption method, and it will be impossible to use without the passphrase. Because there are pros and cons with both options, it's important you understand the implications of using or not using a passphrase. In this guide, we will not be using a passphrase in our examples.
The openssl program provides a rich variety of commands, each of which often has a wealth of options and arguments. Many commands use an external configuration file for some or all of their arguments and have a -config
option to specify that file. The environment variable OPENSSL_CONF can be used to specify the location of the configuration file. If the environment variable is not specified, a default file is created in the default certificate storage area called openssl.cnf. The settings in this default configuration file depend on the flags set when the version of OpenSSL being used was built.
This article is an overview of the available tools provided by openssl. For all of the details on usage and implementation, you can find the manpages which are automatically generated from the source code at the official OpenSSL project home. Likewise, the source code itself may be found on the OpenSSL project home page, as well as on the OpenSSL Github. The main OpenSSL site also includes an overview of the command-line utilities, as well as links to all of their respective documentation.
- 2Basic Tasks
- 2.5Generating Keys Based on Elliptic Curves
- 2.5.1Generating the Curve Parameters
- 2.5Generating Keys Based on Elliptic Curves
- 3Commands
The entry point for the OpenSSL library is the openssl binary, usually /usr/bin/openssl on Linux. The general syntax for calling openssl is as follows:
Alternatively, you can call openssl without arguments to enter the interactive mode prompt. You may then enter commands directly, exiting with either a quit
command or by issuing a termination signal with either Ctrl+C or Ctrl+D. The following is a sample interactive session in which the user invokes the prime command twice before using the quit command to terminate the session.
This section is a brief tutorial on performing the most basic tasks using OpenSSL. For a detailed explanation of the rationale behind the syntax and semantics of the commands shown here, see the section on Commands.
Getting Help[edit]
As mentioned previously, the general syntax of a command is openssl command [ command_options ] [ command_arguments ]
. The help command is no different, but it does have its idiosyncrasies. To view the top-level help menu, you can call openssl as follows.
This query will print all of the available commands, like so:
Note the above output was truncated, so only the first four lines of output are shown.
A help menu for each command may be requested in two different ways. First, the same command used above may be repeated, followed by the name of the command to print help for.
The program will then display the valid options for the given command.
The second way of requesting the help menu for a particular command is by using the first option in the output shown above, namely openssl command -help
. Both commands will yield the same output; the help menu displayed will be exactly the same.
For additional information on the usage of a particular command, the project manpages are a great source of information. Another excellent source of information is the project perldocs. perldoc is a utility included with most if not all Perl distributions, and it's capable of displaying documentation information in a variety of formats, one of which is as manpages. Not surprisingly, the project documentation is generated from the pod files located in the doc directory of the source code.
Getting Library Version Information[edit]
As mentioned above, the version command's help menu may be queried for additional options like so:
Using the -a option to show all version information yields the following output on my current machine:
Generating an RSA Private Key[edit]
Generating a private key can be done in a variety of different ways depending on the type of key, algorithm, bits, and other options your specific use case may require. In this example, we are generating a private key using RSA and a key size of 2048 bits.
To generate a password protected private key, the previous command may be slightly amended as follows:
The addition of the -aes256 option specifies the cipher to use to encrypt the private key file. For a list of available ciphers in the library, you can run the following command:
With your private key in hand, you can use the following command to see the key's details, such as its modulus and its constituent primes. Remember to change the name of the input file to the file name of your private key.
The above command yields the following output in my specific case. Your output will differ but should be structurally similar.
Keep in mind the above key was generated solely for pedagogical purposes; never give anyone access to your private keys.
Generating a Public Key[edit]
Having previously generated your private key, you may generate the corresponding public key using the following command.
You may once again view the key details, using a slightly different command this time.
The output for the public key will be shorter, as it carries much less information, and it will look something like this.
For more information on generating keys, see the source code documentation, located in the doc/HOWTO/keys.txt file.
Generating Keys Based on Elliptic Curves[edit]
There are essentially two steps to generating a key:
Openssl Tool For Windows 10
- Generate the parameters for the specific curve you are using
- Use those parameters to generate the key
To see the list of curves instrinsically supported by openssl, you can use the -list_curves</t> option when calling the <tt>ecparam command.
For this example I will use the prime256v1 curve, which is an X9.62/SECG curve over a 256 bit prime field.
Generating the Curve Parameters[edit]
Having selected our curve, we now call ecparam to generate our parameters file.
Printing Parameters to Standard Out[edit]
You can print the generated curve parameters to the terminal output with the following command:
Printing Parameters as C Code[edit]
Analogously, you may also output the generated curve parameters as C code. The parameters can then be loaded by calling the get_ec_group_XXX() function. To print the C code to the current terminal's output, the following command may be used:
And here are the first few lines of the corresponding output:
Generating the Key[edit]
With the curve parameters in hand, we are now free to generate the key. Just as with the [#Generating an RSA Private Key|RSA] example above, we may optionally specify a cipher algorithm with which to encrypt the private key. The call to generate the key using the elliptic curve parameters generated in the example above looks like this:
Putting it All Together[edit]
The process of generation a curve based on elliptic-curves can be streamlined by calling the genpkey command directly and specifying both the algorithm and the name of the curve to use for parameter generation. In it's simplest form, the command to generate a key based on the same curve as in the example above looks like this:
This command will result in the generated key being printed to the terminal's output.
Remember that you can specify a cipher algorithm to encrypt the key with, which something you may or may not want to do, depending on your specific use case. Here is a slightly more complete example showing a key generated with a password and written to a specific output file.
Just as with the previous example, you can use the pkey command to inspect your newly-generated key.
For more details on elliptic curve cryptography or key generation, check out the manpages.
Base64 Encoding Strings[edit]
For simple string encoding, you can use 'here string' syntax with the base64 command as below. Intuitively, the -e flag specifies the action to be encoding.
Similarly, the base64 command's -d flag may be used to indicate decoding mode.
Note: base64 line length is limited to 76 characters by default in openssl (and generated with 64 characters per line).
=> NOTHING!
To be able to decode a base64 line without line feeds that exceeds the default 76 character length restriction use the -A
option.
Openssl Tool
It is recommended to actually split base64 strings into multiple lines of 64 characters, however, since the -A
option is buggy, particularly with its handling of long files.
Generating a File Hash[edit]
One of the most basic uses of the dgst command (short for digest) is viewing the hash of a given file. To do this, simply invoke the command with the specified digest algorithm to use. For this example, I will be hashing an arbitrary file on my system using the MD5, SHA1, and SHA384 algorithms.
For a list of the available digest algorithms, you can use the following command.
You can also use a similar command to see the available digest commands:
Below are three sample invocations of the md5, sha1, and sha384 digest commands using the same file as the dgst command invocation above.
File Encryption and Decryption[edit]
The following example demonstrates a simple file encryption and decryption using the enc command. The first argument is the cipher algorithm to use for encrypting the file. For this example I carefully selected the AES-256 algorithm in CBC Mode by looking up the available ciphers and picking out the first one I saw. To see the list of available ciphers, you can use the following command.
You can also use the following command:
Having selected an encryption algorithm, you must then specify whether the action you are taking is either encryption or decryption via the -e or -d flags, respectively. The -iter flag specifies the number of iterations on the password used for deriving the encryption key. A higher iteration count increases the time required to brute-force the resulting file. Using this option implies enabling use of the Password-Based Key Derivation Function 2, usually set using the -pbkdf2 flag. We then use the -salt flag to enable the use of a randomly generated salt in the key-derivation function.
Putting it all together, you can see the command to encrypt a file and the corresponding output below. Note that the passwords entered by the user are blank, just as they would usually be in a terminal session.
The analogous decryption command is as follows:
There are three different kinds of commands. These are standard commands, cipher commands, and digest commands. Calling the OpenSSL top-level help command with no arguments will result in openssl printing all available commands by group, sorted alphabetically.
Standard Commands[edit]
Command | Description |
---|---|
asn1parse | Parse an ASN.1 sequence. |
ca | Certificate Authority (CA) Management. |
ciphers | Cipher Suite Description Determination. |
cms | CMS (Cryptographic Message Syntax) utility. |
crl | Certificate Revocation List (CRL) Management. |
crl2pkcs7 | CRL to PKCS#7 Conversion. |
dgst | Message Digest calculation. MAC calculations are superseded by mac(1). |
dhparam | Generation and Management of Diffie-Hellman Parameters. Superseded by genpkey(1) and pkeyparam(1). |
dsa | DSA Data Management. |
dsaparam | DSA Parameter Generation and Management. Superseded by genpkey(1) and pkeyparam(1). |
ec | EC (Elliptic curve) key processing. |
ecparam | EC parameter manipulation and generation. |
enc | Encoding with Ciphers. |
engine | Engine (loadable module) information and manipulation. |
errstr | Error Number to Error String Conversion. |
gendsa | Generation of DSA Private Key from Parameters. Superseded by genpkey(1) and pkey(1). |
genpkey | Generation of Private Key or Parameters. |
genrsa | Generation of RSA Private Key. Superseded by genpkey(1). |
info | Display diverse information built into the OpenSSL libraries. |
kdf | Key Derivation Functions. |
mac | Message Authentication Code Calculation. |
nseq | Create or examine a Netscape certificate sequence. |
ocsp | Online Certificate Status Protocol utility. |
passwd | Generation of hashed passwords. |
pkcs12 | PKCS#12 Data Management. |
pkcs7 | PKCS#7 Data Management. |
pkcs8 | PKCS#8 format private key conversion tool. |
pkey | Public and private key management. |
pkeyparam | Public key algorithm parameter management. |
pkeyutl | Public key algorithm cryptographic operation utility. |
prime | Compute prime numbers. |
rand | Generate pseudo-random bytes. |
rehash | Create symbolic links to certificate and CRL files named by the hash values. |
req | PKCS#10 X.509 Certificate Signing Request (CSR) Management. |
rsa | RSA key management. |
rsautl | RSA utility for signing, verification, encryption, and decryption. Superseded by pkeyutl(1). |
s_client | This implements a generic SSL/TLS client which can establish a transparent connection to a remote server speaking SSL/TLS. |
s_server | This implements a generic SSL/TLS server which accepts connections from remote clients speaking SSL/TLS. |
s_time | SSL Connection Timer. |
sess_id | SSL Session Data Management. |
smime | S/MIME mail processing. |
speed | Algorithm Speed Measurement. |
spkac | SPKAC printing and generating utility. |
srp | Maintain SRP password file. |
storeutl | Utility to list and display certificates, keys, CRLs, etc. |
ts | Time Stamping Authority tool (client/server). |
verify | X.509 Certificate Verification. |
version | OpenSSL Version Information. |
x509 | X.509 Certificate Data Management. |
- Paul Heinlein. 'OpenSSL Command-Line HOWTO'. Has many quick cookbook-style recipes for doing common tasks using the 'oppenssl' command-line application.