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

FreeBSD Manual Pages

  
 
  

home | help
OpenXPKI::SOpenXPKI::SUserrContributed:PerlvDocumentationetrieveCertificate(3)

Name
       OpenXPKI::Server::Workflow::Activity::Tools::RetrieveCertificate

Description
       Searches	certificate database for certificate with the matching
       criteria.

       Activity	configuration: certificateoutcontextkey	       context
       parameter to use	for output certificate
				       (default: certificate)
       certidentifieroutcontextkey     context parameter to use	for output
       certificate
				       identifier
				       (default: none, do not write to
       context)

       certstatus		       Only match certificates with the
       specified
				       status. May be one of the following:
				       ISSUED: certificate is not revoked
       (DEFAULT)
				       CRL_ISSUANCE_PENDING: certificate is
       revoked,
					 but does not yet appear on any	CRL
				       REVOKED:	certificate is revoked
				       ANY: matches any	certificate state

       Operation mode 1: search	for certificate	identifier

       If no activity options are specified this activity expects to find the
       a context parameter cert_identifier. Its	value is used to query the
       database	and search the corresponding certificate.

       Sets context parameter 'certificate' to PEM encoded certificate with
       the matching certificate	identifier.

       Operation mode 2: search	for particular certificate with	specified
       criteria

       This operation mode is enabled if at least one of the following
       activity	parameters are defined in the activity definition. The
       parameter cert_identifier is IGNORED if any of these parameters are
       defined.

       cert_profile:	       filter certificates with	this profile
       (required) cert_subject:		  filter certificates with specified
       subject min_remaining_validity: filter certificates with	a minimum of
       the specified
			       number of days remaining	before expiration
       valid_at:	       filter certificates which are valid at
       specified
			       time (allowed: Unix timestamp or	YYYYMMDD,
			       distinguished by	value length)

       Note: if	parameters specified start with	a '$', the corresponding
       workflow	context	parameter is referenced	instead	of the literal string.

       The first certificate with the matching criteria	is exported via	the
       context parameter 'certificate' (PEM encoded).

       Only if explicitly set in the activity configuration via
       identifieroutcontextkey the specified context entry is set by the
       activity	to contain the retrieved certificate identifier.

perl v5.24.OpenXPKI::Server::Workflow::Activity::Tools::RetrieveCertificate(3)

Name | Description

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OpenXPKI::Server::Workflow::Activity::Tools::RetrieveCertificate&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help