OPENSSL-GENPKEY(1ossl)
π NAME: openssl-genpkey (1ossl) π
Okay bestie, meet openssl-genpkey β generate a private key or key pair. Thatβs the whole assignment. π
β¨ SYNOPSIS β¨
Hereβs the exact spell β run openssl genpkey with these flags and args:
openssl genpkey [-help] [-out filename] [-outpubkey filename] [-outform
DER|PEM] [-verbose] [-quiet] [-pass arg] [-cipher] [-paramfile file]
[-algorithm alg] [-pkeyopt opt:value] [-genparam] [-text] [-rand files]
[-writerand file] [-engine id]
[-provider name] [-provider-path path] [-provparam [name:]key=value]
[-propquery propq] [-config configfile]
πΈ DESCRIPTION πΈ
So what does it do? This command generates a private key or key pair. Periodt. π
π OPTIONS π
Vibe check on the flags: π«
-helpβ print out a usage message. Classic helpful icon behavior.-out filenameβ output the private key to the specified file. If this argument is not specified, then standard output is used.-outpubkey filenameβ output the public key to the specified file. If this argument is not specified, then the public key is not output.-outform DER|PEMβ the output format, except when-genparamis given; the default isPEM. Seeopenssl-format-options(1)for details. When-genparamis given,-outformis ignored.-verboseβ output βstatus dotsβ while generating keys. Sparkle-progress vibes.-quietβ do not output βstatus dotsβ while generating keys.-pass argβ the output file password source. For more information about the format of arg, seeopenssl-passphrase-options(1).-cipherβ this option encrypts the private key with the supplied cipher. Any algorithm name accepted byEVP_get_cipherbyname()is acceptable, such asdes3.-algorithm algβ public key algorithm to use, such asRSA,DSA,DHorDHX. If used, this option must precede any-pkeyoptoptions. The options-paramfileand-algorithmare mutually exclusive. Engines or providers may add algorithms in addition to the standard built-in ones.
Valid built-in algorithm names for private key generation are RSA, RSA-PSS, EC, X25519, X448, ED25519, ED448, ML-DSA and ML-KEM.
Valid built-in algorithm names for parameter generation (see the -genparam option) are DH, DSA and EC.
Note that the algorithm name X9.42 DH may be used as a synonym for DHX keys, and PKCS#3 refers to DH Keys. Some options are not shared between DH and DHX keys.
-pkeyopt opt:valueβ set the public key algorithm optionopttovalue. The precise set of options supported depends on the public key algorithm used and its implementation. See βKEY GENERATION OPTIONSβ and βPARAMETER GENERATION OPTIONSβ below for more details. To list the possibleoptvalues for an algorithm use:openssl genpkey -algorithm XXX -help-genparamβ generate a set of parameters instead of a private key. If used, this option must precede any-algorithm,-paramfileor-pkeyoptoptions.-paramfile filenameβ some public key algorithms generate a private key based on a set of parameters. They can be supplied using this option. If this option is used, the public key algorithm used is determined by the parameters. If used, this option must precede any-pkeyoptoptions. The options-paramfileand-algorithmare mutually exclusive.-textβ print an (unencrypted) text representation of private and public keys and parameters along with thePEMorDERstructure.-rand filesβ see βRandom State Optionsβ inopenssl(1)for details.-writerand fileβ see βRandom State Optionsβ inopenssl(1)for details.-engine idβ see βEngine Optionsβ inopenssl(1). β οΈ This option is deprecated.-provider nameβ see βProvider Optionsβ inopenssl(1),provider(7), andproperty(7).-provider-path pathβ see βProvider Optionsβ inopenssl(1),provider(7), andproperty(7).-provparam [name:]key=valueβ see βProvider Optionsβ inopenssl(1),provider(7), andproperty(7).-propquery propqβ see βProvider Optionsβ inopenssl(1),provider(7), andproperty(7).-config configfileβ see βConfiguration Optionβ inopenssl(1).
π KEY GENERATION OPTIONS π
Real talk: the options supported by each algorithm β and honestly, by each implementation of an algorithm β can vary. The options for the OpenSSL implementations are detailed below. There are no key generation options defined for the X25519, X448, ED25519 or ED448 algorithms. π¦
πΈ RSA Key Generation Options πΈ
rsa_keygen_bits:numbitsβ the number of bits in the generated key. If not specified,2048is used.rsa_keygen_primes:numprimesβ the number of primes in the generated key. If not specified,2is used.rsa_keygen_pubexp:valueβ the RSA public exponent value. This can be a large decimal or hexadecimal value if preceded by0x. Default value is65537.
π RSA-PSS Key Generation Options π
Note: by default an RSA-PSS key has no parameter restrictions.
rsa_keygen_bits:numbits,rsa_keygen_primes:numprimes,rsa_keygen_pubexp:valueβ these options have the same meaning as the RSA algorithm.rsa_pss_keygen_md:digestβ if set, the key is restricted and can only use digest for signing.rsa_pss_keygen_mgf1_md:digestβ if set, the key is restricted and can only use digest as its MGF1 parameter.rsa_pss_keygen_saltlen:lenβ if set, the key is restricted and len specifies the minimum salt length.
π EC Key Generation Options π
The EC key generation options can also be used for parameter generation.
ec_paramgen_curve:curveβ the EC curve to use. OpenSSL supports NIST curve names such asP-256.ec_param_enc:encodingβ the encoding to use for parameters. The encoding parameter must be eithernamed_curveorexplicit. The default value isnamed_curve.
π¦ ML-DSA Key Generation Options π¦
hexseed:seedβ this specifies the optional ML-DSA seed in hexadecimal form. The seed is32bytes, giving64hexadecimal digits. When generated from an explicit seed, the key is completely determined by the seed value.
β οΈ If other users can see the command-line arguments of the running process, this option may compromise the secret key. It is best avoided, tests-aside.
See EVP_PKEY-ML-DSA(7) for more detail.
π ML-KEM Key Generation Options π
hexseed:seedβ this specifies the optional ML-KEM seed in hexadecimal form. The seed is64bytes, giving128hexadecimal digits. When generated from an explicit seed, the key is completely determined by the seed value.
β οΈ If other users can see the command-line arguments of the running process, this option may compromise the secret key. It is best avoided, tests-aside.
See EVP_PKEY-ML-KEM(7) for more detail.
πΏ DH Key Generation Options πΏ
group:nameβ theparamfileoption is not required if a named group is used here. See the βDH Parameter Generation Optionsβ section below.
π PARAMETER GENERATION OPTIONS π
okay so bestie, hereβs the vibe: the options supported by each algorithm β and honestly by each implementation of an algorithm β can vary. The options for the OpenSSL implementations are detailed below, so keep scrolling πβ¨
π DSA Parameter Generation Options π
dsa_paramgen_bits:numbitsβ the number of bits in the generated prime. If you donβt specify it,2048is used πdsa_paramgen_q_bits:numbits,qbits:numbitsβ the number of bits in theqparameter. It absolutely must be one of160,224or256. If not specified,224is used β¨dsa_paramgen_md:digest,digest:digestβ the digest to use during parameter generation. Must be one ofsha1,sha224orsha256. If set, then the number of bits inqwill match the output size of the specified digest and thedsa_paramgen_q_bitsparameter will be ignored. If not set, then a digest will be used that gives an output matching the number of bits inq, i.e.sha1ifqlength is160,sha224if it 224 orsha256if it is256π«Άproperties:queryβ the digest property query string to use when fetching a digest from a provider πtype:typeβ the type of generation to use. Set this to1to use legacy FIPS186-2 parameter generation. The default of0uses FIPS186-4 parameter generation βgindex:indexβ the index to use for canonical generation and verification of the generatorg. Set this to a positive value ranging from0..255to use this mode. Larger values will only use the bottom byte. This index must then be reused during key validation to verify the value ofg. If this value is not set thengis not verifiable. The default value is-1πhexseed:seedβ the seed data inseedto use instead of generating a random seed internally. This should be used for testing purposes only. This will either produce fixed values for the generated parameters OR it will fail if the seed did not generate valid primes π
πΈ DH Parameter Generation Options πΈ
For most use cases it is recommended to use the group option rather than the type options. Note that the group option is not used by default if no parameter generation options are specified π
group:name,dh_param:nameβ use a named DH group to select constant values for the DH parameters. All other options will be ignored if this value is set π- Valid values that are associated with the algorithm of
"DH"are:"ffdhe2048","ffdhe3072","ffdhe4096","ffdhe6144","ffdhe8192","modp_1536","modp_2048","modp_3072","modp_4096","modp_6144","modp_8192"β¨ - Valid values that are associated with the algorithm of
"DHX"are the RFC5114 names"dh_1024_160","dh_2048_224","dh_2048_256"π¦
- Valid values that are associated with the algorithm of
dh_rfc5114:numβ if this option is set, then the appropriate RFC5114 parameters are used instead of generating new parameters. The valuenumcan be one of1,2or3that are equivalent to using the optiongroupwith one of"dh_1024_160","dh_2048_224"or"dh_2048_256". All other options will be ignored if this value is set πpbits:numbits,dh_paramgen_prime_len:numbitsβ the number of bits in the prime parameterp. The default is2048π’qbits:numbits,dh_paramgen_subprime_len:numbitsβ the number of bits in the sub prime parameterq. The default is224. Only relevant if used in conjunction with thedh_paramgen_typeoption to generate DHX parameters πsafeprime-generator:value,dh_paramgen_generator:valueβ the value to use for the generatorg. The default is2. The algorithm option must be"DH"for this parameter to be used β‘type:stringβ the type name of DH parameters to generate. Valid values are:"generator"β use a safe prime generator with the optionsafeprime_generatorThe algorithm option must be"DH"π οΈ"fips186_4"β FIPS186-4 parameter generation. The algorithm option must be"DHX"π₯"fips186_2"β FIPS186-4 parameter generation. The algorithm option must be"DHX"π₯"group"β can be used with the optionpbitsto select one of"ffdhe2048","ffdhe3072","ffdhe4096","ffdhe6144"or"ffdhe8192". The algorithm option must be"DH"π"default"β selects a default type based on the algorithm. This is used by the OpenSSL default provider to set the type for backwards compatibility. If algorithm is"DH"then"generator"is used. If algorithm is"DHX"then"fips186_2"is used π
dh_paramgen_type:valueβ the type of DH parameters to generate. Valid values are0,1,2or3which correspond to setting the optiontypeto"generator","fips186_2","fips186_4"or"group"π«digest:digestβ the digest to use during parameter generation. Must be one ofsha1,sha224orsha256. If set, then the number of bits inqbitswill match the output size of the specified digest and theqbitsparameter will be ignored. If not set, then a digest will be used that gives an output matching the number of bits inq, i.e.sha1ifqlength is160,sha224if it is224orsha256if it is256. This is only used by"fips186_4"and"fips186_2"key generation πproperties:queryβ the digest property query string to use when fetching a digest from a provider. This is only used by"fips186_4"and"fips186_2"key generation πgindex:indexβ the index to use for canonical generation and verification of the generatorg. Set this to a positive value ranging from0..255to use this mode. Larger values will only use the bottom byte. This index must then be reused during key validation to verify the value ofg. If this value is not set thengis not verifiable. The default value is-1. This is only used by"fips186_4"and"fips186_2"key generation πhexseed:seedβ the seed data inseedto use instead of generating a random seed internally. This should be used for testing purposes only. This will either produce fixed values for the generated parameters OR it will fail if the seed did not generate valid primes. This is only used by"fips186_4"and"fips186_2"key generation π
π¦ EC Parameter Generation Options π¦
The EC parameter generation options are the same as for key generation. See "EC Key Generation Options" above πβ¨
π NOTES π
The use of the genpkey program is encouraged over the algorithm specific utilities because additional algorithm options and ENGINE provided algorithms can be used ππ
π EXAMPLES π
Generate an RSA private key using default parameters:
openssl genpkey -algorithm RSA -out key.pem
Encrypt output private key using 128 bit AES and the passphrase "hello":
openssl genpkey -algorithm RSA -out key.pem -aes-128-cbc -pass pass:hello
Generate a 2048 bit RSA key using 3 as the public exponent:
openssl genpkey -algorithm RSA -out key.pem \
-pkeyopt rsa_keygen_bits:2048 -pkeyopt rsa_keygen_pubexp:3
Generate 2048 bit DSA parameters that can be validated: The output values for gindex and seed are required for key validation purposes and are not saved to the output pem file π«Ά
openssl genpkey -genparam -algorithm DSA -out dsap.pem -pkeyopt pbits:2048 \
-pkeyopt qbits:224 -pkeyopt digest:SHA256 -pkeyopt gindex:1 -text
Generate DSA key from parameters:
openssl genpkey -paramfile dsap.pem -out dsakey.pem
Generate 4096 bit DH Key using safe prime group ffdhe4096:
openssl genpkey -algorithm DH -out dhkey.pem -pkeyopt group:ffdhe4096
Generate 2048 bit X9.42 DH key with 256 bit subgroup using RFC5114 group3:
openssl genpkey -algorithm DHX -out dhkey.pem -pkeyopt dh_rfc5114:3
Generate a DH key using a DH parameters file:
openssl genpkey -paramfile dhp.pem -out dhkey.pem
Output DH parameters for safe prime group ffdhe2048:
openssl genpkey -genparam -algorithm DH -out dhp.pem -pkeyopt group:ffdhe2048
Output 2048 bit X9.42 DH parameters with 224 bit subgroup using RFC5114 group2:
openssl genpkey -genparam -algorithm DHX -out dhp.pem -pkeyopt dh_rfc5114:2
Output 2048 bit X9.42 DH parameters with 224 bit subgroup using FIP186-4 keygen:
openssl genpkey -genparam -algorithm DHX -out dhp.pem -text \
-pkeyopt pbits:2048 -pkeyopt qbits:224 -pkeyopt digest:SHA256 \
-pkeyopt gindex:1 -pkeyopt dh_paramgen_type:2
Output 1024 bit X9.42 DH parameters with 160 bit subgroup using FIP186-2 keygen:
openssl genpkey -genparam -algorithm DHX -out dhp.pem -text \
-pkeyopt pbits:1024 -pkeyopt qbits:160 -pkeyopt digest:SHA1 \
-pkeyopt gindex:1 -pkeyopt dh_paramgen_type:1
Output 2048 bit DH parameters:
openssl genpkey -genparam -algorithm DH -out dhp.pem \
-pkeyopt dh_paramgen_prime_len:2048
Output 2048 bit DH parameters using a generator:
openssl genpkey -genparam -algorithm DH -out dhpx.pem \
-pkeyopt dh_paramgen_prime_len:2048 \
-pkeyopt dh_paramgen_type:1
Generate EC parameters:
openssl genpkey -genparam -algorithm EC -out ecp.pem \
-pkeyopt ec_paramgen_curve:secp384r1 \
-pkeyopt ec_param_enc:named_curve
Generate EC key from parameters:
openssl genpkey -paramfile ecp.pem -out eckey.pem
Generate EC key directly:
openssl genpkey -algorithm EC -out eckey.pem \
-pkeyopt ec_paramgen_curve:P-384 \
-pkeyopt ec_param_enc:named_curve
Generate an X25519 private key:
openssl genpkey -algorithm X25519 -out xkey.pem
Generate an ED448 private key:
openssl genpkey -algorithm ED448 -out xkey.pem
Generate an ML-DSA-65 private key:
openssl genpkey -algorithm ML-DSA-65 -out ml-dsa-key.pem
Generate an ML-KEM-768 private key:
openssl genpkey -algorithm ML-KEM-768 -out ml-kem-key.pem
β³ HISTORY β³
- The ability to use NIST curve names, and to generate an EC key directly, were added in OpenSSL
1.0.2π - The ability to generate X25519 keys was added in OpenSSL
1.1.0π¦ - The ability to generate X448, ED25519 and ED448 keys was added in OpenSSL
1.1.1β¨ - The
-engineoption was deprecated in OpenSSL3.0β οΈ - Support for ML-DSA and ML-KEM was added in OpenSSL
3.5π
Β©οΈ COPYRIGHT Β©οΈ
Copyright 2006-2025 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 <https://www.openssl.org/source/license.html>.
And thatβs the whole page, bestie π Source tag OPENSSL-GENPKEY(1ossl), version 3.5.9, dated 2026-09-29. Go be iconic with your keys πβ¨
π¦ where this page comes from
- alpine 3.23: openssl-doc 3.5.9-r0 Β· Apache-2.0
- alpine 3.24: openssl-doc 3.5.9-r0 Β· Apache-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms