Skip to main content

Configure CA and Profiles

The connector issues certificates through an OTPKI end entity profile, which binds a certificate profile to a certification authority. All three must exist, and the end entity profile must accept what the connector supplies for each end entity it creates.

Certification authority​

Create or import the certification authority that signs the certificates. See Certificate Authorities.

Certificate profile​

Create the certificate profile that describes the certificates to be issued, such as their validity, key usages, and extensions. See Certificate Profiles.

If the certificate profile restricts the certification authorities it may be used with, include the certification authority above in that list. OTPKI applies the restrictions of the certificate profile and of the end entity profile together, and an RA Profile in the platform is built only from the lists of the end entity profile. A combination that the certificate profile does not allow can therefore be selected in the platform and fails at issuance.

If the certificates carry subject alternative names or other extensions taken from the certificate request, allow the certificate profile to override extensions from the request. The platform submits the certificate request as it is, so anything the certificate profile does not take from the request is left out of the issued certificate.

End entity profile​

Create the end entity profile and configure the following sections so that the connector can enroll through it. See End Entity Profiles.

Certificate profile and CA settings​

Add the certificate profile and the certification authority above to the available lists, and select a default for each. OTPKI requires both defaults to save the profile.

The RA Profile in the platform offers only the certificate profiles and certification authorities that the selected end entity profile allows.

Login ID configuration​

The connector derives a login ID for every end entity it creates and supplies it to OTPKI. Configure the profile accordingly:

  • The login ID must not be auto-generated. OTPKI silently replaces a supplied login ID with a random value when auto-generation is enabled, so the end entity is not named the way the RA Profile defines, and the login ID recorded with the certificate in the platform does not identify it in OTPKI.
  • If the profile validates the login ID with a regular expression, the values that the RA Profile derives must match it. The expression is evaluated before the profile applies its own prefix and suffix.
  • A login ID prefix or suffix configured on the profile is applied on top of the prefix and postfix configured on the RA Profile. Both pairs count towards the login ID that OTPKI finally stores.

Subject configuration​

The connector builds the end entity from the subject of the certificate request, and supplies no subject alternative names with it. A subject alternative name attribute that the profile marks as required, and for which it defines no default value, therefore rejects every issuance.

Leave such attributes optional, or give them a default value, and take the subject alternative names of the issued certificate from the certificate request through the certificate profile instead.

Request limits​

An end entity may enroll as many times as its profile allows, once by default. Renewing a certificate through the platform enrolls again against the same end entity, and works at that default: once the allowance is used, the connector resets the end entity's status to New, which reapplies it.

Password configuration​

The connector sets a password on every end entity it creates:

  • The password must not be auto-generated. OTPKI would replace the supplied password, and the value the connector derives would then no longer match the end entity, so operations that authenticate with it fail.
  • If the profile enforces a minimum password strength, the password the connector supplies must satisfy it.

The value is derived from the end entity's login ID, so the connector never stores it and can recompute it for any later operation. When the OTPKI_LOGIN_PASSWORD_KEY environment variable is set on the connector, the password is derived from the login ID with that key. When it is unset, the password is the login ID itself.

The key is set when the connector is deployed:

  • With Helm, set otpkiConnector.otpki.loginPasswordKey, or set otpkiConnector.existingSecret to an existing Secret that holds the key under login_password_key, see Configurable parameters.
  • With the Kubernetes Operator, store the key in a Secret and map it to OTPKI_LOGIN_PASSWORD_KEY through spec.secretRefs, see Delivering configuration and secrets.
The key cannot be rotated

OTPKI checks the password on every enrollment against the one stored when the end entity was created. Setting, changing, or removing OTPKI_LOGIN_PASSWORD_KEY therefore makes renewal, and the issuance of a registered certificate, fail for every end entity created under the previous setting.

Set the key before the first certificate is issued or registered, keep it with the connector's other secrets, and always set it in production: without it, the password is the login ID, which is not secret.

Approval settings​

Do not attach an approval profile to the end entity profile, the certificate profile, or the certification authority that an RA Profile in the platform uses. An approval profile can be attached to any of the three, and each of them gates a different part of the flow.

Approval-gated profiles are refused, not held

The platform cannot follow a request through an OTPKI approval, so a certificate that OTPKI issued after the approval would never reach the inventory. The connector therefore refuses an approval-gated request immediately, and hides profiles with an approval profile attached from the RA Profile dropdowns. See Synchronous and asynchronous operations.

A refused request can leave an end entity in OTPKI awaiting approval, and the connector logs its identifier. Remove it there instead of approving it: the end entity keeps its login ID, and an approved request would issue a certificate outside the inventory.

Use dedicated profiles without approvals for the platform, and keep approval workflows on the profiles used by other enrollment channels.

For more information, refer to Approval Profiles.