Name

OpenXPKI::Crypto::Backend::OpenSSL::Engine

Description

This class is the base class and the interface of all other engines. This defines the interface how HSMs are supported by OpenXPKI.

Functions

new

The constructor supports the following parameters:

OPENSSL (the OpenSSL binary)
NAME (a symbolic name for the token)
KEY (filename of the key)
PASSWD (sometimes keys are passphrase protected)
CERT (filename of the certificate)
INTERNAL_CHAIN (filename of the certificate chain)

tries to set the passphrase for the used token and checks the passphrase for its correctness. If the passhrase is missing, shorter than 4 characters or simply wrong then an exception is thrown. There is no parameters because we get the passphrase from the OpenXPKI::Crypto::Secret object.

Examples: $engine->login ();

logout

enforces the logout form the token.

online

returns true if the token is usable for non-pivate-key operations.

key_usable

returns true if the private key is usable.

get_mode

returns the operational mode of the engine (standby, session or daemon).

get_engine

returns the used OpenSSL engine or the empty string if no engine is used.

get_engine_section

returns the OpenSSL engine section from the configuration or the empty string if no engine is used or the engine section is empty.

get_engine_usage

returns the OpenSSL engine_usage section from the configuration or the empty string if no engine is used or the engine_usage section is empty.

get_key_store

returns the OpenSSL key_store section from the configuration.

get_key_info

returns as hash with some information on the key (name, storage, secret avail)

get_keyfile

returns the name of the private key. In case the key is stored in the datapool, this returns the name of a tempfile holding the key blob.

get_passwd

returns the passphrase if one is present.

get_certfile

returns the filename of the certificate.

get_chainfile

returns the filename of the internal (CA specific) certificate chain.

get_keyform

returns "e" or "engine" if the key is stored in an OpenSSL engine.

get_wrapper

returns the wrapper around the OpenSSL binary if such a wrapper is used (e.g. nCipher's chil engine). Otherwise the empty string is returned.

get_engine_params

returns the parameters for the engine which are needed for the initialization. This is a simple string.

filter_stderr

expects a scalar with the complete error log inside. It returns the error log but without all normal stuff which is generated by the used engine. The function is used to filter false error messages from STDERR.

filter_stdout

expects a scalar with the complete output inside. It returns the output but without the noise which is generated by the used engine. The function is used to filter engine specific messages from STDOUT.