NAME

OpenXPKI::Server::API2::SecretRole - Base role for all types of 'secrets'

ATTRIBUTES

Bool value indicating whether this secret value should be exposed outside the crypto manager.

Default: 1

This role requires the consuming class to implement the following methods:

Must sets (part of) the secret. The arguments are dependent on the type of secret.

Must return the secret if "is_complete() == 1" or "undef" otherwise.

Must delete all secret data stored in the object.

Must return the number of required parts to complete this secret.

Must return the number of parts that are already inserted / set.

Must return an ArrayRef with the current secret data of the object.

Must set the secret data of the object to the given ArrayRef.

Returns 1 if this secret value should be exposed outside the crypto manager, 0 otherwise.

Returns 1 if the secret is fully completed / known / set.

Returns the serialized data attributes of this object or "undef" if no secret data has been set yet.

Decodes the given serialized data and sets the data attributes of this object accordingly.