Name

OpenXPKI::Server::Workflow::Activity::NICE::GenerateKey

Description

Parameters which are common for all backends are given below, any additional parameter set in the activity is handed over as additional parameter hash to the backend class.

The result of the call is written to target key, depending on the implementation this can be the key itself or any other data structure.

If the backend does not return a key, the error message is written to error_code and the target_key is empty.

Configuration

Activity Parameters

key_alg: Mapped unmodified to key_alg of the api method, set to 'rsa' of not set.
enc_alg: Mapped unmodified to key_alg of the api method, set to 'aes256' of not set.
password: Password to encrypt the key with, mandatory.
key_gen_params: If parameter is given, it must be a hash. The values given in the key curve_name and key_length are mapped to the api method as is. Other keys are silently ignored, no defaults are applied (default key lenght for RSA/DSA is set in the API method).
target_key: The context value to write the result key to. Default is private_key.