NAME

OpenXPKI::Server::API2::Plugin::Token::is_token_usable

COMMANDS

is_token_usable

Returns true (1) if the token with the given alias is usable. Returns false (0) if the token setup is ok but the key can not be used, e.g. a missing secret. Returns undef in case construction of the token fails which usually means the configuration is broken or artefacts are not found or not readable (keyfile / datapool items).

Parameters

"alias" Str - Token alias. Required.
"operation" Str - type of operation to use for the key check, optional - default depends on token type.

sign: Do a pkcs7 sign and verify cycle. This is the default.
encrypt: Do a pkcs7 encrypt / decrypt cycle. Default if the token is of type datasafe.
engine: Use the crypto engine's "key_usable" method to test the token.

•: "engine" Bool - Default: 0
Same as operation=<engine, deprecated, provided for backward compatibility.