Name

OpenXPKI::Crypto::TokenManager

Description

This module manages all cryptographic tokens. You can use it to simply get tokens and to manage the state of a token.

Functions

new

If you want to use an explicit temporary directory then you must specifiy this directory in the variable TMPDIR.

get_token( { TYPE, NAME, CERTIFICATE } )

Get a crypto token to execute commands for the current realm

TYPE: Determines the used API, one of the values given in system.crypto.tokenapi (certsign, crlsign, datasafe....)
NAME: The name of the token to initialize, for versioned tokens including the generation identifier, e.g. server-ca-2.
CERTIFICATE: A hashref as returned by API::Token::get_certificate_for_alias. Can be omitted, if the API can resolve the given name.

get_system_token( { TYPE } )

Get a crypto token from the system namespace. This includes all non-realm dependend tokens which dont have key material attached.

The tokens are defined in the system.crypto.token namespace. Common tokens are default and javaks. You neeed to specify at least "api" and "backend" for all tokens.