MAN page from OpenSuSE perl-OpenXPKI-Core-0.9.1389-6.362.CS.i586.rpm

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

Section: User Contributed Perl Documentation (3)
Updated: 2008-09-30
Index

Name

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)

login

tries to set the passphrase for the used token and checks the passphrase for itscorrectness. If the passhrase is missing, shorter than 4 characters orsimply wrong then an exception is thrown. There is no parameters becausewe 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-keyoperations.

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 engineis used.

get_engine_section

returns the OpenSSL engine section from the configuration or the empty string if no engineis 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 engineis used or the engine_usage section is empty.

get_key_store

returns the OpenSSL key_store section from the configuration.

get_keyfile

returns the filename of the private key.

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 awrapper is used (e.g. nCipher's chil engine). Otherwise the empty stringis returned.

get_engine_params

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

filter_stderr

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

filter_stdout

expects a scalar with the complete output inside. It returnsthe output but without the noise which is generated bythe used engine. The function is used to filter engine specificmessages from STDOUT.

Index

Name
Description
Functions
new
login
logout
online
key_usable
get_mode
get_engine
get_engine_section
get_engine_usage
get_key_store
get_keyfile
get_passwd
get_certfile
get_chainfile
get_keyform
get_wrapper
get_engine_params
filter_stderr
filter_stdout

This document was created byman2html,using the manual pages.