Authentication resources · Kind catalogue · Examples
CertAuthRole¶
API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: certauthroles.auth.openbaoconfig.io
Categories: openbao
CertAuthRole manages a trusted certificate role of an OpenBao TLS certificate auth method at auth/<mountPath>/certs/<name>. Use it to let clients log in with a TLS client certificate issued by the given CA, optionally restricted by names, SANs and extensions.
Example:
Example:
spec:
connectionRef:
name: openbao
certificate: |
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
allowedCommonNames: ["*.svc.example.com"]
tokenPolicies: [app-read]Example¶
examples/auth/certauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CertAuthRole
metadata:
name: web-clients
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: cert
name: web-clients
certificate: |
-----BEGIN CERTIFICATE-----
MIIBYTCCAQigAwIBAgIUDMw3azJKyUnZ9ymx9nkMtOKG9E4wCgYIKoZIzj0EAwIw
FzEVMBMGA1UEAwwMb2Jjby10ZXN0LWNhMB4XDTI2MTExMzIyMjQzMVoXDTM2MTEx
MDIyMjQzMVowFzEVMBMGA1UEAwwMb2Jjby10ZXN0LWNhMFkwEwYHKoZIzj0CAQYI
KoZIzj0DAQcDQgAEFoZh98uaZo4/3v5cSywC0uH8ZiSzf95fG9lCWe6uidPOb9Dy
C265JytUU1VV9tZ247yA5L72vzWiOTDa/9K3z6MyMDAwHQYDVR0OBBYEFAiOukMR
doR39VvDsVQ++aFecP+GMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwIDRwAw
RAIgBLc18g1ypCtJR5OaZI02SIu41XxJdIhT7jGPEsF57AkCIC92H/jJrXlX07vC
ymDvgfvtQ0UWHcdGzHZe+eCO1ZqD
-----END CERTIFICATE-----
displayName: web-clients
allowedCommonNames:
- "*.clients.example.com"
allowedDNSSANs:
- "*.clients.example.com"
allowedEmailSANs:
- ops@example.com
allowedURISANs:
- spiffe://example.com/clients/*
allowedOrganizationalUnits:
- platform
requiredExtensions:
- "2.1.1.1:client"
allowedMetadataExtensions:
- 2.1.1.2
ocspEnabled: false
ocspCACertificates: |
-----BEGIN CERTIFICATE-----
MIIBYTCCAQigAwIBAgIUDMw3azJKyUnZ9ymx9nkMtOKG9E4wCgYIKoZIzj0EAwIw
FzEVMBMGA1UEAwwMb2Jjby10ZXN0LWNhMB4XDTI2MTExMzIyMjQzMVoXDTM2MTEx
MDIyMjQzMVowFzEVMBMGA1UEAwwMb2Jjby10ZXN0LWNhMFkwEwYHKoZIzj0CAQYI
KoZIzj0DAQcDQgAEFoZh98uaZo4/3v5cSywC0uH8ZiSzf95fG9lCWe6uidPOb9Dy
C265JytUU1VV9tZ247yA5L72vzWiOTDa/9K3z6MyMDAwHQYDVR0OBBYEFAiOukMR
doR39VvDsVQ++aFecP+GMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwIDRwAw
RAIgBLc18g1ypCtJR5OaZI02SIu41XxJdIhT7jGPEsF57AkCIC92H/jJrXlX07vC
ymDvgfvtQ0UWHcdGzHZe+eCO1ZqD
-----END CERTIFICATE-----
ocspServersOverride:
- http://ocsp.example.com
ocspFailOpen: false
ocspQueryAllServers: false
tokenTTL: 1h
tokenMaxTTL: 4h
tokenExplicitMaxTTL: 8h
tokenPeriod: 0s
tokenPolicies:
- web-client
policyRefs:
- name: obco-team-a-reader
tokenBoundCIDRs:
- 10.42.0.0/16
tokenNumUses: 0
tokenType: default
tokenNoDefaultPolicy: false
tokenStrictlyBindIP: false
On GitHub: certauthrole.yaml, generated sample with every field.
Fields¶
Defaults below are CRD schema defaults. A blank cell does not imply zero, false or an empty value; see the field description for omission behaviour. Required fields inside an optional object apply only when that object is set.
| Field | Type | Required | Default | Description | Validation |
|---|---|---|---|---|---|
spec | object | yes | Desired state of a trusted certificate role, written to auth/<mountPath>/certs/<name>. | ConstraintsCEL:has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) (mountPath is immutable)CEL: has(self.name) == has(oldSelf.name) && (!has(self.name) || self.name == oldSelf.name) (name is immutable)CEL: !has(self.tokenTTL) || !has(self.tokenMaxTTL) || duration(self.tokenTTL) <= duration(self.tokenMaxTTL) (tokenTTL must not exceed tokenMaxTTL)CEL: has(self.__namespace__) == has(oldSelf.__namespace__) && (!has(self.__namespace__) || self.__namespace__ == oldSelf.__namespace__) (namespace is immutable)CEL: self.connectionRef == oldSelf.connectionRef (connectionRef is immutable) | |
spec.allowedCommonNames | []string | no | Common names the client certificate may carry; globs are supported. Unset allows any. Maps to `allowed_common_names`. Example: ["*.svc.example.com"] | Constraintsitems: <=256list type: set each item: length: <=256 | |
spec.allowedDNSSANs | []string | no | DNS subject alternative names the client certificate may carry; globs are supported. Unset allows any. Maps to `allowed_dns_sans`. Example: ["app.example.com"] | Constraintsitems: <=256list type: set each item: length: <=256 | |
spec.allowedEmailSANs | []string | no | Email subject alternative names the client certificate may carry; globs are supported. Unset allows any. Maps to `allowed_email_sans`. Example: ["*@example.com"] | Constraintsitems: <=256list type: set each item: length: <=256 | |
spec.allowedMetadataExtensions | []string | no | Extension OIDs whose values are copied into the token and alias metadata when present. Maps to `allowed_metadata_extensions`. Example: ["1.2.3.4.5"] | Constraintsitems: <=64list type: set each item: length: <=256 | |
spec.allowedOrganizationalUnits | []string | no | Organizational units (OU) the client certificate may carry. Unset allows any. Maps to `allowed_organizational_units`. Example: [platform] | Constraintsitems: <=256list type: set each item: length: <=256 | |
spec.allowedURISANs | []string | no | URI subject alternative names the client certificate may carry; globs are supported. Unset allows any. Maps to `allowed_uri_sans`. Example: ["spiffe://example.org/ns/team-a/*"] | Constraintsitems: <=256list type: set each item: length: <=512 | |
spec.certificate | string | yes | PEM-encoded CA certificate (or a single client certificate) that presented client certificates must chain to. Public data, not a secret. Required. Maps to `certificate`. Example: "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----" | Constraintslength: >=1, <=262144CEL: self.contains('-----BEGIN CERTIFICATE-----') (certificate must be PEM encoded) | |
spec.connectionRef | object | yes | Connection used to reach and log in to OpenBao. Immutable. | ||
spec.connectionRef.kind | string | no | "OpenBaoConnection" | Kind of the connection: OpenBaoConnection (in the same Kubernetes namespace as this resource) or ClusterOpenBaoConnection (cluster-scoped; its allowedNamespaces must select this namespace). Default: OpenBaoConnection. | Constraintsone of:OpenBaoConnection, ClusterOpenBaoConnection |
spec.connectionRef.name | string | yes | Name of the OpenBaoConnection or ClusterOpenBaoConnection. Example: openbao | Constraintslength: >=1, <=253 | |
spec.creationPolicy | string | no | "Create" | How an object that already exists in OpenBao, and is not yet owned by this resource, is treated. Create (default): create the object; an existing one is refused with reason Conflict. Adopt: take over an existing object and never create one. CreateOrAdopt: create it, or take over an existing one. Settings that always exist in OpenBao (configuration singletons) need Adopt or CreateOrAdopt. | Constraintsone of:Create, Adopt, CreateOrAdopt |
spec.deletionPolicy | string | no | "Orphan" | What happens in OpenBao when this resource is deleted. Orphan (default): the OpenBao object stays. Delete: the object is removed (a configuration singleton is reset to its defaults); data and key holders (mounts, namespaces, KV data, audit devices, endpoints, transit, PKI, SSH CA and TOTP keys, MFA methods, entities) are removed only while the resource carries the annotation openbaoconfig.io/allow-destructive-delete: "true". Kinds whose OpenBao object cannot be deleted reject Delete. | Constraintsone of:Delete, Orphan |
spec.displayName | string | no | Name shown in token display names and audit logs. OpenBao defaults it to the role name. Maps to `display_name`. Example: web-clients | Constraintslength: <=256 | |
spec.driftDetection | string | no | "Enabled" | Whether OpenBao is re-read periodically to detect and repair out-of-band changes. Enabled (default): re-read every driftInterval. Disabled: write only when the spec or a referenced Secret changes. | Constraintsone of:Enabled, Disabled |
spec.driftInterval | string | no | How often OpenBao is re-read for drift, as a duration of at least 30s. Default: the operator's interval for the kind (15m for kinds that grant access such as policies, auth mounts and roles, 1h for the rest), with jitter. Example: 30m | Constraintslength: <=32CEL: duration(self) >= duration('30s') (driftInterval must be at least 30s) | |
spec.managementPolicy | string | no | "Manage" | Whether the operator writes to OpenBao. Manage (default): converge OpenBao to the spec, create and delete as the policies say. Observe: only read the object and report drift in the conditions; never write or delete. | Constraintsone of:Manage, Observe |
spec.mountPath | string | no | "cert" | Path of the cert auth method, without the auth/ prefix. Defaults to cert. Immutable. Example: cert | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: <=128 |
spec.name | string | no | Name of the role in OpenBao, used as the cert role at login. Defaults to metadata.name. OpenBao stores role names in lower case. Immutable. Example: web | Constraintspattern:^[a-z0-9_]([a-z0-9_.-]*[a-z0-9_])?$length: >=1, <=128 | |
spec.namespace | string | no | OpenBao namespace of the object, relative to the connection's base namespace; empty means the connection namespace itself. Segments are separated by "/", without leading or trailing slash. Immutable: it cannot be added, changed or removed after creation. Example: team-a/apps | Constraintspattern:^[A-Za-z0-9_-][A-Za-z0-9._-]*(/[A-Za-z0-9_-][A-Za-z0-9._-]*)*$length: <=256 | |
spec.ocspCACertificates | string | no | PEM bundle of additional CA certificates needed to talk to OCSP servers and verify their responses. Maps to `ocsp_ca_certificates`. Example: "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----" | Constraintslength: <=262144 | |
spec.ocspEnabled | boolean | no | Checks the revocation status of client certificates with OCSP at login. Defaults to false. Maps to `ocsp_enabled`. Example: true | ||
spec.ocspFailOpen | boolean | no | When true, login proceeds if no OCSP server gives an answer; when false (default) it fails. Maps to `ocsp_fail_open`. Example: false | ||
spec.ocspQueryAllServers | boolean | no | When true, every OCSP server is queried and the certificate is valid only if all agree; when false (default) the first answer is used. Maps to `ocsp_query_all_servers`. Example: true | ||
spec.ocspServersOverride | []string | no | OCSP server URLs, queried in order, that replace those in the certificate's authority information access. Maps to `ocsp_servers_override`. Example: ["http://ocsp.example.com"] | Constraintsitems: <=16each item: length: <=512 | |
spec.policyRefs | []object | no | Policy resources in this Kubernetes namespace whose OpenBao policy names are added to tokenPolicies. The role waits until each Policy is Ready; each Policy must use the same connectionRef and namespace as the role. Example: [{name: app-read}] | Constraintsitems: <=32list type: map (keys: name) | |
spec.policyRefs[] | object | no | Reference by name to an object in the same Kubernetes namespace as this resource. | ||
spec.policyRefs[].name | string | yes | Name of the referenced object, in the same namespace as this resource. Example: my-app | Constraintslength: >=1, <=253 | |
spec.requiredExtensions | []string | no | Extensions, formatted as "oid:value", that the client certificate must all carry; globs are supported in the value. Maps to `required_extensions`. Example: ["1.2.3.4.5:team-a"] | Constraintsitems: <=64list type: set each item: length: <=512 | |
spec.tokenBoundCIDRs | []string | no | Client CIDR blocks or IP addresses allowed to use issued tokens. Unset allows any address. Maps to `token_bound_cidrs`. Example: [10.0.0.0/8, 192.168.1.10] | Constraintsitems: <=64list type: set CEL: self.all(c, isCIDR(c) || isIP(c)) (tokenBoundCIDRs entries must be CIDR blocks or IP addresses)each item: length: <=64 | |
spec.tokenExplicitMaxTTL | string | no | Hard cap on the lifetime of issued tokens that renewals cannot extend, as a duration. Unset or 0 means no explicit cap. Maps to `token_explicit_max_ttl`. Example: 24h | ||
spec.tokenMaxTTL | string | no | Maximum lifetime of issued tokens including renewals, as a duration. Unset or 0 uses the mount or system max TTL. Maps to `token_max_ttl`. Example: 8h | ||
spec.tokenNoDefaultPolicy | boolean | no | When true, the default policy is not attached to issued tokens; only the listed policies apply. Defaults to false. Maps to `token_no_default_policy`. Example: true | ||
spec.tokenNumUses | integer (int32) | no | Maximum number of requests an issued token may make; 0 or unset means unlimited. Maps to `token_num_uses`. Example: 10 | Constraintsvalue: >=0 | |
spec.tokenPeriod | string | no | Makes issued tokens periodic: they never expire as long as they are renewed within this duration, and each renewal resets the TTL to it. Unset or 0 means not periodic. Maps to `token_period`. Example: 1h | ||
spec.tokenPolicies | []string | no | OpenBao policy names attached to issued tokens, in addition to the default policy and the policies from policyRefs. Maps to `token_policies`. Example: [app-read, app-write] | Constraintsitems: <=256list type: set each item: length: >=1, <=128 | |
spec.tokenStrictlyBindIP | boolean | no | When true, issued tokens can only be used from the IP address of the client that logged in. Built-in auth methods only: an external plugin built on an older OpenBao SDK ignores it and never returns it. Defaults to false. Maps to `token_strictly_bind_ip`. Example: true | ||
spec.tokenTTL | string | no | Initial lifetime of issued tokens, as a duration. Unset or 0 uses the mount or system default TTL; must not exceed tokenMaxTTL. Maps to `token_ttl`. Example: 1h | ||
spec.tokenType | string | no | Type of token to issue. One of default (the mount's default, normally service), service (renewable, can create child tokens) or batch (lightweight, not renewable). Maps to `token_type`. Example: service | Constraintsone of:default, service, batch | |
status | object | no | Observed state of the role, written by the operator. | ||
status.acquired | string | no | How the operator came to own the object: Created (it created it) or Adopted (it took over an existing one). Empty until owned. | ||
status.conditions | []object | no | Current state as conditions: Ready (the OpenBao object matches the spec) and Synced (the last reconcile succeeded), each with a reason such as Available, Drifted, Conflict, ConnectionNotReady or PermissionDenied, and the generation it describes. | Constraintslist type: map (keys: type) | |
status.conditions[] | object | no | Condition contains details for one aspect of the current state of this API Resource. | ||
status.conditions[].lastTransitionTime | string (date-time) | yes | lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. | ||
status.conditions[].message | string | yes | message is a human readable message indicating details about the transition. This may be an empty string. | Constraintslength: <=32768 | |
status.conditions[].observedGeneration | integer (int64) | no | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. | Constraintsvalue: >=0 | |
status.conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. | Constraintspattern:^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$length: >=1, <=1024 | |
status.conditions[].status | string | yes | status of the condition, one of True, False, Unknown. | Constraintsone of:True, False, Unknown | |
status.conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. | Constraintspattern:^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$length: <=316 | |
status.id | string | no | Identifier OpenBao generated for the object (an entity, group or alias ID, or a mount accessor), for kinds that have one; other resources reference it. Example: 6c9f3e0a-1b2c-4d5e-8f90-123456789abc | ||
status.namespace | string | no | Absolute OpenBao namespace the object was written in; empty means the root namespace. If it later differs from the spec, reconciling stops with reason NamespaceChanged. Example: team-a/apps | ||
status.observedGeneration | integer (int64) | no | The metadata.generation of this resource that the operator last reconciled. | ||
status.path | string | no | Full OpenBao API path of the object, including its namespace, as last written; deletion uses it even after the spec changed. Example: team-a/sys/policies/acl/app-read | ||
status.rotationNonce | string | no | Value of the resource's rotation nonce when one-time inputs, such as a root credential that OpenBao rotates afterwards, were last sent; changing the nonce in the spec sends them again. | ||
status.serverID | string | no | Cluster ID of the OpenBao server the object was acquired on. If the connection later reaches another server, reconciling stops with reason ServerChanged and nothing is written or deleted. Example: 80f7de92-c12e-e960-4754-255c32fc6b53 | ||
status.writeOnlyHash | string | no | Keyed hash (HMAC-SHA256) of the write-only inputs, such as passwords read from Secrets; a change forces a write. It never contains or reveals the values. |