array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.rnp-op-generate-key.php', 1 => 'rnp_op_generate_key', 2 => 'Generate key', ), 'up' => array ( 0 => 'ref.rnp.php', 1 => 'Rnp Functions', ), 'prev' => array ( 0 => 'function.rnp-op-encrypt.php', 1 => 'rnp_op_encrypt', ), 'next' => array ( 0 => 'function.rnp-op-sign.php', 1 => 'rnp_op_sign', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/rnp/functions/rnp-op-generate-key.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

rnp_op_generate_key

(PECL rnp >= 0.1.1)

rnp_op_generate_key — Generate key

Description

rnp_op_generate_key(
    RnpFFI $ffi,
    string $userid,
    string $key_alg,
    string $sub_alg = ?,
    array $options = ?
): string|false

Parameters

ffi
The FFI object returned by rnp_ffi_create().
userid
PGP User ID - text that is intended to represent the name and email address of the key holder.
key_alg
Primary key algorithm (i.e. 'RSA', 'DSA', etc).
sub_alg
Subkey algorithm. If not set, subkey will not be generated.
options
An associative array with options.
Key Data type Description
"bits" integer Primary key size in bits. Applicable only to RSA, DSA and El-Gamal keys.
"hash" string Hash algorithm used in self signature or subkey binding signature.
"dsa_qbits" integer Set size of a q parameter for DSA key. Note: appropriate default value will be set, depending on key bits. However you may override it if needed.
"curve" string Set the curve used for ECC key. Note: this is only applicable for ECDSA, ECDH and SM2 keys.
"request_password" boolean Enable requesting password via password provider. This password will be used for key encryption. Password provider callback function should be set in advance by calling rnp_ffi_set_pass_provider(). Note: this setting will be ignored if password was set via"password"
"password" string Set the password used to encrypt the secret key data.
"expiration" integer Set the key and subkey expiration time in seconds.
"sub_bits" integer Subkey size in bits. Applicable only to RSA, DSA and El-Gamal keys.
"sub_hash" string Hash algorithm used in subkey self signature or subkey binding signature.
"sub_curve" string Set the curve used for ECC subkey. Note: this is only applicable for ECDSA, ECDH and SM2 keys.

Return Values

Fingerprint of the generated primary key or false on failure. This fingerprint can be used later to reference the key in sign and encrypt operations. The key data is stored in FFI memory context and can be saved using rnp_save_keys() or rnp_save_keys_to_path().