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

OpenXPKI::Server::API::Object

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

Name

Description

This is the object interface which should be used by all user interfaces of OpenXPKI.A user interface MUST NOT access the server directly. The only allowedaccess is via this API. Any function which is not available in this API isnot for public use.The API gets access to the server via the 'server' context object. Thisobject must be set before instantiating the API.

Functions

get_csr_info_hash_from_data

return a hash reference which includes all parsed informations fromthe CSR. The only accepted parameter is DATA which includes the plain CSR.

get_ca_list

returns a list of all available CAs in the used PKI realm.

get_ca_cert

returns the certificate of one CA. This is a wrapper around get_cert to makethe access control more fine granular if necessary.

get_cert

returns the requested certificate. The supported arguments are IDENTIFIER andFORMAT. IDENTIFIER is required whilst FORMAT is optional. FORMAT can have thefollowing values:

*: PEM
*: DER
*: PKCS7 - without the usual hash mark
*: TXT
*: HASH - the default value

search_cert

supports a facility to search certificates. It supports the following parameters:

*: CERT_SERIAL
*: LIMIT
*: LAST
*: FIRST
*: CSR_SERIAL
*: EMAIL
*: SUBJECT
*: ISSUER

The result is an array of hashes. The hashes do not contain the data fieldof the database to reduce the transport costs an avoid parser implementationson the client.

get_crl

returns a CRL. The required parameters are CA_ID, FILENAME and FORMAT. CA_ID isthe configured ID of the CA in the PKI realm configuration. FILENAME and FORMATare from the configuration too and must match a configured CRL. Both parameterswill be checked against the configuration. So there it is not possible to attackthe system with this filename because we validate it.

get_private_key_for_cert

returns an ecrypted private key for a certificate if the privatekey was generated on the CA during the certificate request process.Supports the following parameters:

*: IDENTIFIER - the identifier of the certificate
*: FORMAT - the output format
*: PASSWORD - the private key password

The format can be either PKCS8_PEM (PKCS#8 in PEM format), PKCS8_DER(PKCS#8 in DER format), PKCS12 (PKCS#12 in DER format), OPENSSL_PRIVKEY(the OpenSSL encrypted key format in PEM), or JAVA_KEYSTORE (for aJava keystore).The password has to match the one used during the generation or nothingis returned at all.

private_key_exists_for_cert

Checks whether a corresponding CA-generated private key exists forthe given certificate identifier (named parameter IDENTIFIER).Returns true if there is a private key, false otherwise.

__get_private_key_from_db

Gets a private key from the database for a given certificateidentifier by looking up the CSR serial of the certificate andextracting the private_key context parameter from the workflowwith the CSR serial. Returns undef if no CA generated private keyis available.

This document was created byman2html,using the manual pages.