Certificate Enrollment Via EST Protocol

class CertificateEnrollmentViaESTProtocol(api)

Bases: _ClientWorkBase

create(name, certificate_container, naming_pattern, ca_template, contacts, certificate_origin=None, certificate_description=None, validation_type=0, revocation_status_check=1, authentication_credentials=None, authenticate_only_by_password=False, revoke_previous_version=False, identity_verification=3, trusted_certs_and_cas=None, get_if_already_exists=False, attributes=None)
Parameters:

  • name (str) – The name of the client work.

  • certificate_container (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the folder to create certificates.

  • naming_pattern (str) – The object naming pattern (IE. $CSR.CN$)

  • ca_template (Union[config.Object, str]) – Config Object or DN of the Certificate Authority.

  • contacts (list[ident.Identity, str]) – List of Identity Object or Prefixed Name of the contacts.

  • certificate_origin (str) – Specify the certificate origin value

  • certificate_description (str) – Specify the certificate description value

  • validation_type (int) –

    • basic: (default) Checks Expiration, Revocation, and Chain of Trust

    • strict: Performs Basic Validation and checks Client Authentication Enhanced Key Usage

  • revocation_status_check (int) – Defaults to accept when unknown.

  • authentication_credentials (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the credential to provide client password authentication.

  • authenticate_only_by_password (bool) – Only accept requests that are authenticated by password

  • revoke_previous_version (bool) – Revoke previous versions of the certificate (defaults to False)

  • identity_verification (int) – Proof of Possession

  • trusted_certs_and_cas (list[config.Object, str]) – A List of Config Object or Distinguished Name (DN) of the Certificate Authorities and Certificates to trust.

  • attributes (dict) – Additional attributes to apply to the object.

  • get_if_already_exists (bool) – If the objects already exists, just return it as is.

Returns:

Config Object of the client work.

delete(work)

Deletes the client work.

Parameters:

work (Union[config.Object, str]) – Config Object or name of the client work.

disable(work)

Disables the client work.

Parameters:

work (Union[config.Object, str]) – Config Object or name of the client work.

enable(work)

Enables the client work.

Parameters:

work (Union[config.Object, str]) – Config Object or name of the client work.

get(name, raise_error_if_not_exists=True)
Parameters:

  • name (str) – The name of the client work.

  • raise_error_if_not_exists (bool) – Raise an exception if the client work does not exist.

Returns:

Config Object of the client work.

list()

Lists all client work.

Returns:

List of Config Object of all client work.