MAN page from OpenSuSE perl-OpenXPKI-Core-0.9.1389-6.362.CS.i586.rpm

OpenXPKI::Server::API::Default

Section: User Contributed Perl Documentation (3)
Updated: 2008-09-30
Index

NAME

Description

This module contains the API functions which do not fall into oneof the other categories (i.e. Session, Visualization, Workflow, ...).They were once the toplevel OpenXPKI::Server::API methods, but thestructure is now different.

Functions

get_approval_message

Gets the approval message that is to be signed for a signature-basedapproval. Takes the parameters TYPE (can either be CSR or CRR),WORKFLOW, ID (specifies the workflow from which the data is taken)and optionally LANG (which specifies the language that is used totranslate the message).

get_user

Get session user.

get_role

Get session user's role.

get_pki_realm

Get PKI realm for this session.

get_ca_ids

Returns a list of all issuing CA IDs that are available.Return structure:
CA_ID => array ref of CA IDs

get_ca_certificate

Returns CA certificate details.Expects named parameter 'CA_ID' which can be either a scalar or an array ref indicating which CA certificates to fetch.If named paramter 'OUTFORM' is specified, it must be one of 'PEM' or'DER'. In this case the returned structure will return the CA certificatein the specified format.

Returns an array ref containing the CA certificate information in theorder that was requested.

Return structure:
  CACERT => [
    {
        CA_ID => CA ID (as requested)
        NOTBEFORE => certifiate notbefore (ISO8601)
        NOTAFTER => certifiate notafter  (ISO8601)
        CERTIFICATE => certificate data (only if OUTFORM was specified)
    }

get_chain

Returns the certificate chain starting at a specified certificate.Expects a hash ref with the named parameter START_IDENTIFIER (theidentifier from which to compute the chain) and optionally a parameterOUTFORMAT, which can be either 'PEM' or 'DER'.Returns a hash ref with the following entries:

    IDENTIFIERS   the chain of certificate identifiers as an array    CERTIFICATES  the certificates as an array of data in outformat                  (if requested)    COMPLETE      1 if the complete chain was found in the database                  0 otherwise

get_possible_profiles_for_role

Returns an array reference of possible certificate profiles for a givencertificate role (passed in the named parameter ROLE) taken from theconfiguration.

This document was created byman2html,using the manual pages.