Name

OpenXPKI::Service::LibSCEP::Command

Description

SCEP service command base class. Handles command execution to distinct command implementations.

Functions

START - new()

This class derives from Class::Std. Please read the corresponding documentation concerning BUILD, START construction methods and other class-specific internals.

The new() constructor creates a new command object that is capable of executing the referenced interface command. Expects the following named parameters: COMMAND => name of the command to execute PARAMS => hash reference containing the command attributes

The constructor makes sure that only explicitly allowed commands are accepted and throws an exception otherwise. If the constructor returns without error (exception), the command was accepted as valid and the passed parameters have been stored internally to be processed later by the execute() method.

When attaching the implementation the class tries to 'use' an actual Perl module which is named like the command. E. g. if command 'foo' is requested, it tries to attach OpenXPKI::Service::LibSCEP::Command::foo.pm.

execute

Executes the specified command implementation. Returns a data structure that can be serialized and directly returned to the client.

command_response

Returns a properly formatted command response (hash reference containing the proper arguments). To be called by command implementations.

__get_token

Return the scep token (crypto object), active group token if set in the servers configuration or the default token.

__get_token_alias

get the scep token alias for the current server

get_next_ca_certificate

Return next ca certificate(s) as (concatenated) PEM encoded certificates.

Default is to fetch the certificate with a notbefore date greater than now from the root alias group of the current realm.

You can override this by creating a datapool item with namespace scep.cache.getnextca and the servername as key. The value must be a single PEM encoded certificate or a string with multiple PEM blocks. Note: Multiple certificates are only supported using LibSCEP, the old SCEP backend takes the first one and ignores the remainder.

Returns undef if no upcoming ca certificate is found.