Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OpenXPKI::Server::API2UseruContributed:PerleDocumI2::Plugin::Datapool::Util(3)

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

       o   $caller ArrayRef - info of the API command caller as	returned by
	   Perls caller()

       o   $requested_pki_realm	Str - PKI realm	to check

   get_entry
       Fetches a value from the	datapool DB table

   set_entry
       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.

   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.

perl v5.32.0		     OpenXPKI::Server::API2::Plugin::Datapool::Util(3)

NAME | METHODS | DESCRIPTION

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OpenXPKI::Server::API2::Plugin::Datapool::Util&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help