GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
OpenXPKI::Server::API2::Plugin::Datapool::set_data_pool_entry(3) User Contributed Perl Documentation OpenXPKI::Server::API2::Plugin::Datapool::set_data_pool_entry(3)

OpenXPKI::Server::API2::Plugin::Datapool::set_data_pool_entry

Writes the specified entry (key-value pair) to the global data pool, possibly encrypting the value using the password safe defined for the PKI Realm.

Side effect: this method automatically wipes all data pool entries whose expiration date has passed.

NOTE: Encryption may work even though the private key for the password safe is not available (the symmetric encryption key is encrypted for the password safe certificate). Retrieving encrypted information will only work if the password safe key is available during the first access to the symmetric key.

Example:

    CTX('api2')->set_data_pool_entry(
        pki_realm => $pki_realm,
        namespace => 'workflow.foo.bar',
        key => 'myvariable',
        value => $tmpval,
        encrypt => 1,
        force => 1,
        expiration_date => time + 3600 * 24 * 7,
    );

Parameters

  • "pki_realm" Str - PKI realm. Optional, default: current realm

    If the API is called directly from OpenXPKI::Server::Workflow only the PKI realm of the currently active session is accepted.

  • "namespace" Str - datapool namespace (custom string to organize entries)
  • "key" Str - entry key
  • "value" Str - entry value to store
  • "expiration_date" Int - UNIX epoch timestamp when the entry shall be deleted. Optional, default: keep entry infinitely.

    To prevent unwanted deletion, a value of 0 is not accepted.

  • "force" Bool - set to 1 to enforce overwriting a possibly existing entry.

    If set, the (new) "expiration_date" must be passed again or will be reset to inifity!

  • "encrypt" Bool - set to 1 if you wish the entry to be encrypted. Optional, default: 0

    Requires a properly set up password safe certificate in the target realm.

2022-05-14 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.