![]() |
![]()
| ![]() |
![]()
NameOpenXPKI::Crypto::Backend::OpenSSL::Engine DescriptionThis class is the base class and the interface of all other engines. This defines the interface how HSMs are supported by OpenXPKI. FunctionsnewThe constructor supports the following parameters:
logintries 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 (); logoutenforces the logout form the token. onlinereturns true if the token is usable for non-pivate-key operations. key_usablereturns true if the private key is usable. get_modereturns the operational mode of the engine (standby, session or daemon). get_enginereturns the used OpenSSL engine or the empty string if no engine is used. get_engine_sectionreturns the OpenSSL engine section from the configuration or the empty string if no engine is used or the engine section is empty. get_engine_usagereturns 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_storereturns the OpenSSL key_store section from the configuration. get_key_inforeturns as hash with some information on the key (name, storage, secret avail) get_keyfilereturns 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_passwdreturns the passphrase if one is present. get_certfilereturns the filename of the certificate. get_chainfilereturns the filename of the internal (CA specific) certificate chain. get_keyformreturns "e" or "engine" if the key is stored in an OpenSSL engine. get_wrapperreturns 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_paramsreturns the parameters for the engine which are needed for the initialization. This is a simple string. filter_stderrexpects 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_stdoutexpects 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.
|