NAME

OpenXPKI::Server::API2::Plugin::Datapool::Util - Base role for datapool related plugins that provides some utility methods

METHODS

DESCRIPTION

assert_current_pki_realm_within_workflow

If the calling code is within OpenXPKI::Server::Workflow namespace, check whether the requested PKI realm matches the current one.

Parameters

$caller ArrayRef - info of the API command caller as returned by Perls caller()
$requested_pki_realm Str - PKI realm to check

get_entry

Fetches a value from the datapool DB table - hides expired items

internal worker function, accepts more parameters than the API function named attributes: encrypt => not set, undefined -> do not encrypt value 'current_symmetric_key' -> encrypt using the current symmetric key associated with the current password safe 'password_safe' -> encrypt using the current password safe (asymmetrically)

cleanup

Clean up data pool (delete expired entries).

get_realm_encryption_key

Fetches or creates a symmetric encryption key for encrypting datapool values in the given PKI realm.

Returns a HashRef directly usable by OpenXPKI::Crypto::VolatileVault's constructor:

    {
        KEY_ID    => '...',
        ALGORITHM => '...',
        IV        => '...',
        KEY       => '...',
    }

Creates a new key for the PKI realm if necessary.

create_realm_encryption_key

Generate a new encryption key

fetch_symmetric_key

Returns a HashRef containing an existing symmetric encryption key for encrypting datapool values either from the server cache or from the datapool.