NAME

OpenXPKI::Server::API2::Plugin::Cert::get_chain

COMMANDS

get_chain

Returns the certificate chain starting at a specified certificate. Expects a hash ref with the named parameter start_with (the identifier from which to compute the chain) and optionally a parameter format, which can be either 'PEM', 'DER' or 'DBINFO' (full db result). Returns a hash ref with the following entries:

    identifiers   the chain of certificate identifiers as an array
    subject       list of subjects for the returned certificates
    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

    revoked       1 if a certificate in the chain is revoked

By setting "bundle => 1" you will not get a hash but a PKCS7 encoded bundle holding the requested certificate and all intermediates (if found). If the certificate is not found, the result is empty. Add "keeproot => 1" to also have the root in PKCS7 container.

Parameters

"start_with" - certificate identifier to get the chain for
"format" - one of PEM, DER, DBINFO
"bundle" - Bool
"keeproot" - Bool

Changes compared to API v1:

Parameter "START_IDENTIFIER" was renamed to "start_with".

Parameter "OUTFORMAT" was renamed to "format".

"format" option HASH was renamed to DBINFO to be consistent with get_cert.

When called with "format => "DBINFO"" the returned HashRef contains lowercase keys. Additionally the following keys changed:

    CERTIFICATE_SERIAL      --> cert_key
    CERTIFICATE_SERIAL_HEX  --> cert_key_hex
    PUBKEY                  --> removed in v2.5
    CSR_SERIAL              --> req_key