Name

OpenXPKI::Crypto::API - API for cryptographic functions - abstract superclass.

Description

This is the ABSTRACT superclass for crypto APIs, such as OpenXPKI::Crypto::Backend::API, OpenXPKI::Crypto::Tool::SCEP::API, ... As an abstract superclass, it just implements basic command validation, more functionality has to be implemented in the specific subclasses. Note that it can not be instantiated.

Functions

START

This constructor (see Class::Std) tries to create an instance of the class passed by the named parameter 'CLASS'. This is supposed to be the corresponding Backend or Tool class, e.g. OpenXPKI::Backend::OpenSSL

command

This checks whether valid command parameters are present and then excutes a command on the instance mentioned above.

__init_command_params

This method is empty here, it has to be implemented by the the corresponding API sub-classes. It fills the command_params hash with the appropriate content, i.e. allowed functions and their parameters.

__check_command_param

This private method checks the validity of the command parameters. It only checks keys, not values, i.e. the content of a passed parameter might still be inapropriate for the requested operation.