Skip to content

Authentication resources · Kind catalogue · Examples

KerberosAuthLDAPConfig

API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: kerberosauthldapconfigs.auth.openbaoconfig.io
Categories: openbao

KerberosAuthLDAPConfig manages the LDAP configuration of an OpenBao Kerberos auth method at auth/<mountPath>/config/ldap. Use it to look up the LDAP groups of Kerberos users, so KerberosAuthGroup mappings apply; one per mount.

Example:

spec:
  connectionRef:
    name: openbao
  mountPath: kerberos
  url: ldaps://dc1.example.com
  bindDN: cn=openbao,ou=Services,dc=example,dc=org
  bindPassSecretRef: {name: ldap-bind, key: password}
  userDN: ou=People,dc=example,dc=org
  groupDN: ou=Groups,dc=example,dc=org
  deletionPolicy: Orphan

Example

examples/auth/kerberosauthldapconfig.yaml
apiVersion: v1
kind: Secret
metadata:
  name: kerberos-ldap-bind
type: Opaque
stringData:
  password: fake-bind-password
  tls.key: fake-ldap-client-key-not-pem
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KerberosAuthLDAPConfig
metadata:
  name: kerberos-ldap
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: kerberos
  url: ldaps://ldap1.example.org,ldaps://ldap2.example.org
  bindDN: cn=openbao,ou=services,dc=example,dc=org
  bindPassSecretRef:
    name: kerberos-ldap-bind
    key: password
  userDN: ou=people,dc=example,dc=org
  userAttr: uid
  userFilter: '(&(objectClass=inetOrgPerson)({{.UserAttr}}={{.Username}}))'
  upnDomain: example.org
  discoverDN: false
  denyNullBind: true
  usernameAsAlias: true
  groupDN: ou=groups,dc=example,dc=org
  groupFilter: '(&(objectClass=groupOfNames)(member={{.UserDN}}))'
  groupAttr: cn
  useTokenGroups: false
  anonymousGroupSearch: false
  caseSensitiveNames: false
  certificate: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1sZGFwLWNh
    -----END CERTIFICATE-----
  clientTLSCert: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1sZGFwLWNsaWVudC1jZXJ0
    -----END CERTIFICATE-----
  clientTLSKeySecretRef:
    name: kerberos-ldap-bind
    key: tls.key
  startTLS: false
  insecureTLS: false
  tlsMinVersion: tls12
  tlsMaxVersion: tls13
  requestTimeout: 1m30s
  connectionTimeout: 30s
  dereferenceAliases: never
  maxPageSize: 500
  tokenTTL: 1h
  tokenMaxTTL: 4h
  tokenExplicitMaxTTL: 8h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - readers
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false

On GitHub: kerberosauthldapconfig.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.

FieldTypeRequiredDefaultDescriptionValidation
specobjectyesDesired state of the LDAP group lookup of a Kerberos auth method, written to auth/<mountPath>/config/ldap. Token fields set the defaults of tokens issued at login. deletionPolicy must be Orphan.
ConstraintsCEL: has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) (mountPath is immutable)
CEL: !has(self.deletionPolicy) || self.deletionPolicy == 'Orphan' (deletionPolicy must be Orphan: the config endpoint cannot be deleted)
CEL: !has(self.tokenTTL) || !has(self.tokenMaxTTL) || duration(self.tokenTTL) <= duration(self.tokenMaxTTL) (tokenTTL must not exceed tokenMaxTTL)
CEL: has(self.clientTLSCert) == has(self.clientTLSKeySecretRef) (set clientTLSCert and clientTLSKeySecretRef together)
CEL: !has(self.bindPassSecretRef) || has(self.bindDN) (bindPassSecretRef requires bindDN)
CEL: !has(self.tlsMinVersion) || !has(self.tlsMaxVersion) || self.tlsMinVersion <= self.tlsMaxVersion (tlsMinVersion must not exceed tlsMaxVersion)
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.anonymousGroupSearchbooleannoWhen true, group searches use an anonymous bind; the bind credentials are still used for the initial connection. Defaults to false. Maps to `anonymous_group_search`. Example: false
spec.bindDNstringnoDistinguished name of the service account used to search for users and groups. Unset uses an anonymous bind for searches. Required by bindPassSecretRef. Maps to `binddn`. Example: cn=openbao,ou=Services,dc=example,dc=org
Constraintslength: <=1024
spec.bindPassSecretRefobjectnoSecret key holding the password of bindDN. Read from this Secret key; the value is never stored in status. OpenBao never returns it, so it is compared only through status.writeOnlyHash and a Secret change forces a write. Maps to `bindpass`. Example: {name: ldap-bind, key: password}
spec.bindPassSecretRef.keystringyesKey in the Secret's data whose value is used. Example: password
Constraintslength: >=1, <=253
spec.bindPassSecretRef.namestringyesName of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials
Constraintslength: >=1, <=253
spec.caseSensitiveNamesbooleannoWhen true, user and group names are compared case-sensitively when matching OpenBao groups and users. Defaults to false. Maps to `case_sensitive_names`. Example: false
spec.certificatestringnoPEM-encoded CA certificate used to verify the LDAP server certificate. Unset uses the system trust store. Maps to `certificate`. Example: "-----BEGIN CERTIFICATE-----\n..."
Constraintslength: <=65536
spec.clientTLSCertstringnoPEM-encoded client certificate presented to the LDAP server for mutual TLS. Must be set together with clientTLSKeySecretRef. OpenBao does not return it, so it is compared only through status.writeOnlyHash. Maps to `client_tls_cert`. Example: "-----BEGIN CERTIFICATE-----\n..."
Constraintslength: <=65536
spec.clientTLSKeySecretRefobjectnoSecret key holding the PEM private key of clientTLSCert. Read from this Secret key; the value is never stored in status. OpenBao never returns it, so it is compared only through status.writeOnlyHash. Must be set together with clientTLSCert. Maps to `client_tls_key`. Example: {name: ldap-client-tls, key: tls.key}
spec.clientTLSKeySecretRef.keystringyesKey in the Secret's data whose value is used. Example: password
Constraintslength: >=1, <=253
spec.clientTLSKeySecretRef.namestringyesName of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials
Constraintslength: >=1, <=253
spec.connectionRefobjectyesConnection used to reach and log in to OpenBao. Immutable.
spec.connectionRef.kindstringno"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.namestringyesName of the OpenBaoConnection or ClusterOpenBaoConnection. Example: openbao
Constraintslength: >=1, <=253
spec.connectionTimeoutstringnoTimeout of a connection attempt before the next URL is tried, as a duration. OpenBao defaults to 30s. Maps to `connection_timeout`. Example: 10s
spec.creationPolicystringno"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.deletionPolicystringno"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.denyNullBindbooleannoWhen true, a login with an empty password is rejected instead of being treated as an unauthenticated bind. OpenBao defaults to true. Maps to `deny_null_bind`. Example: true
spec.dereferenceAliasesstringnoWhen LDAP aliases are dereferenced on searches: never, finding, searching or always. OpenBao defaults to never. Maps to `dereference_aliases`. Example: always
Constraintsone of: never, finding, searching, always
spec.discoverDNbooleannoWhen true, an anonymous bind is used to discover the DN of the user before binding. Defaults to false. Maps to `discoverdn`. Example: true
spec.driftDetectionstringno"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.driftIntervalstringnoHow 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: <=32
CEL: duration(self) >= duration('30s') (driftInterval must be at least 30s)
spec.groupAttrstringnoAttribute of the entries returned by groupFilter that holds the group name, such as cn or memberOf. OpenBao defaults to cn. Maps to `groupattr`. Example: cn
Constraintslength: <=256
spec.groupDNstringnoSearch base for group membership searches. Unset disables group lookups. Maps to `groupdn`. Example: ou=Groups,dc=example,dc=org
Constraintslength: <=1024
spec.groupFilterstringnoGo template for the group membership search, with {{.UserDN}} and {{.Username}} in scope. OpenBao defaults to (|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}})). Maps to `groupfilter`. Example: (&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))
Constraintslength: <=2048
spec.insecureTLSbooleannoWhen true, the LDAP server certificate is not verified. Insecure; do not use in production. Defaults to false. Maps to `insecure_tls`. Example: false
spec.managementPolicystringno"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.maxPageSizeinteger (int32)noPage size of paged LDAP searches, to stay under server size limits; 0 or unset disables paging. Maps to `max_page_size`. Example: 1000
Constraintsvalue: >=0
spec.mountPathstringno"kerberos"Path of the Kerberos auth method, without the auth/ prefix. Defaults to kerberos. Immutable. Example: kerberos
Constraintspattern: ^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$
length: <=128
spec.namespacestringnoOpenBao 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.policyRefs[]objectnoPolicy 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: <=32
list type: map (keys: name)
spec.policyRefs[]objectnoReference by name to an object in the same Kubernetes namespace as this resource.
spec.policyRefs[].namestringyesName of the referenced object, in the same namespace as this resource. Example: my-app
Constraintslength: >=1, <=253
spec.requestTimeoutstringnoTimeout of a request to the LDAP server, as a duration. OpenBao defaults to 90s. Maps to `request_timeout`. Example: 30s
spec.startTLSbooleannoWhen true, a STARTTLS command is issued after connecting to an ldap:// URL. Defaults to false. Maps to `starttls`. Example: true
spec.tlsMaxVersionstringnoMaximum TLS version: tls10, tls11, tls12 or tls13. OpenBao defaults to tls12. Maps to `tls_max_version`. Example: tls13
Constraintsone of: tls10, tls11, tls12, tls13
length: <=5
spec.tlsMinVersionstringnoMinimum TLS version: tls10, tls11, tls12 or tls13. OpenBao defaults both versions to tls12, so tls13 also needs tlsMaxVersion; must not exceed tlsMaxVersion. Maps to `tls_min_version`. Example: tls12
Constraintsone of: tls10, tls11, tls12, tls13
length: <=5
spec.tokenBoundCIDRs[]stringnoClient 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: <=64
list type: set
CEL: self.all(c, isCIDR(c) || isIP(c)) (tokenBoundCIDRs entries must be CIDR blocks or IP addresses)
each item: length: <=64
spec.tokenExplicitMaxTTLstringnoHard 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.tokenMaxTTLstringnoMaximum 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.tokenNoDefaultPolicybooleannoWhen 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.tokenNumUsesinteger (int32)noMaximum number of requests an issued token may make; 0 or unset means unlimited. Maps to `token_num_uses`. Example: 10
Constraintsvalue: >=0
spec.tokenPeriodstringnoMakes 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[]stringnoOpenBao 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: <=256
list type: set
each item: length: >=1, <=128
spec.tokenStrictlyBindIPbooleannoWhen 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.tokenTTLstringnoInitial 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.tokenTypestringnoType 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
spec.upnDomainstringnoActive Directory user principal name domain: users bind as <username>@<upnDomain>. Maps to `upndomain`. Example: example.org
Constraintslength: <=256
spec.urlstringyesURL of the LDAP server. Several URLs separated by commas are tried in order. OpenBao stores it in lower case. Required. Maps to `url`. Example: ldaps://ldap1.example.com,ldaps://ldap2.example.com
Constraintslength: >=1, <=2048
spec.useTokenGroupsbooleannoWhen true, group membership is resolved through the Active Directory tokenGroups attribute of the user, which includes nested groups. Defaults to false. Maps to `use_token_groups`. Example: true
spec.userAttrstringnoAttribute of a user entry that holds the login name, such as cn, uid or sAMAccountName. OpenBao defaults to cn and stores it in lower case. Maps to `userattr`. Example: samaccountname
Constraintslength: <=256
spec.userDNstringnoSearch base for user entries. Maps to `userdn`. Example: ou=People,dc=example,dc=org
Constraintslength: <=1024
spec.userFilterstringnoGo template for the user search filter, with {{.UserAttr}} and {{.Username}} in scope. OpenBao defaults to ({{.UserAttr}}={{.Username}}). Maps to `userfilter`. Example: (&(objectClass=person)({{.UserAttr}}={{.Username}}))
Constraintslength: <=2048
spec.usernameAsAliasbooleannoWhen true, the login user name, not the user DN, becomes the entity alias name. Defaults to false. Maps to `username_as_alias`. Example: true
statusobjectnoObserved state of the LDAP configuration, written by the operator.
status.acquiredstringnoHow the operator came to own the object: Created (it created it) or Adopted (it took over an existing one). Empty until owned.
status.conditions[]objectnoCurrent 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[]objectnoCondition contains details for one aspect of the current state of this API Resource.
status.conditions[].lastTransitionTimestring (date-time)yeslastTransitionTime 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[].messagestringyesmessage is a human readable message indicating details about the transition. This may be an empty string.
Constraintslength: <=32768
status.conditions[].observedGenerationinteger (int64)noobservedGeneration 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[].reasonstringyesreason 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[].statusstringyesstatus of the condition, one of True, False, Unknown.
Constraintsone of: True, False, Unknown
status.conditions[].typestringyestype 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.idstringnoIdentifier 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.namespacestringnoAbsolute 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.observedGenerationinteger (int64)noThe metadata.generation of this resource that the operator last reconciled.
status.pathstringnoFull 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.rotationNoncestringnoValue 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.serverIDstringnoCluster 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.writeOnlyHashstringnoKeyed 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.