Skip to content

Authentication resources · Kind catalogue · Examples

JWTCELRole

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

JWTCELRole manages a CEL role of an OpenBao JWT auth method at auth/<mountPath>/cel/role/<name>. OpenBao only. Use it when a CEL program over the JWT claims, rather than fixed bound claims, must decide the login and the issued token.

Example:

spec:
  connectionRef:
    name: openbao
  mountPath: jwt
  boundAudiences: [openbao]
  celProgram:
    expression: "claims.sub == 'ci-runner' ? pb.Auth{policies: ['ci-read']} : false"
  message: permission denied

Example

examples/auth/jwtcelrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTCELRole
metadata:
  name: ci-cel
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: jwt-ci
  name: ci-cel
  celProgram:
    variables:
      - name: project
        expression: claims.project_path
      - name: protected
        expression: claims.ref_protected == "true"
    expression: 'project.startsWith("platform/") && protected'
  message: only protected refs of platform projects may log in
  boundAudiences:
    - https://openbao.example.com
  expirationLeeway: 150
  notBeforeLeeway: 2m30s
  clockSkewLeeway: -1

On GitHub: jwtcelrole.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 a CEL role of a JWT auth method, written to auth/<mountPath>/cel/role/<name>. OpenBao replaces the whole role on every write, so unset fields are reset to their OpenBao defaults.
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.__namespace__) == has(oldSelf.__namespace__) && (!has(self.__namespace__) || self.__namespace__ == oldSelf.__namespace__) (namespace is immutable)
CEL: self.connectionRef == oldSelf.connectionRef (connectionRef is immutable)
spec.boundAudiences[]stringnoValues accepted in the aud claim; any match is enough. Unlike a JWTAuthRole, a JWT without an aud claim is not rejected, so the program must check it when needed. Maps to `bound_audiences`. Example: [openbao]
Constraintsitems: <=64
list type: set
each item: length: <=512
spec.celProgramobjectyesCEL program that authorizes the login and shapes the issued token. OpenBao applies no claim checks beyond signature, leeways and boundAudiences; the program must validate everything else. Required. Maps to `cel_program`. Example: {expression: "claims.sub == 'ci-runner'"}
spec.celProgram.expressionstringyesMain CEL expression, evaluated over the JWT claims. It returns true to allow the login, false or a string message to deny it, or a pb.Auth object that describes the token to issue (policies, TTLs, metadata). Required. Maps to `cel_program.expression`. Example: "claims.sub == 'ci-runner' ? pb.Auth{policies: ['ci-read']} : false"
Constraintslength: >=1, <=16384
spec.celProgram.variables[]objectnoVariables evaluated in order before the main expression, at most 32. Maps to `cel_program.variables`. Example: [{name: is_admin, expression: "'admins' in claims.groups"}]
Constraintsitems: <=32
list type: atomic
spec.celProgram.variables[]objectnoNamed CEL expression that later variables and the main expression can use.
spec.celProgram.variables[].expressionstringyesCEL expression that computes the variable; it can read the JWT claims as claims. Maps to `cel_program.variables[].expression`. Example: "'platform-admins' in claims.groups"
Constraintslength: >=1, <=16384
spec.celProgram.variables[].namestringyesName of the variable, referenced by later variables and the main expression. Letters, digits and underscores, not starting with a digit. Maps to `cel_program.variables[].name`. Example: is_admin
Constraintspattern: ^[A-Za-z_][A-Za-z0-9_]*$
length: >=1, <=128
spec.clockSkewLeewayint-or-stringnoClock skew allowed on every time-based claim (iat, exp, nbf): a number of seconds, a duration such as 30s or 2m, or -1 to disable it. 0 or unset uses the OpenBao default of 60 seconds. Maps to `clock_skew_leeway`. Example: 60
ConstraintsCEL: type(self) == int ? self >= -1 : self.matches('^([0-9]+(s|m|h))+$') (must be -1, a number of seconds or a duration such as 30s)
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.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.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.expirationLeewayint-or-stringnoClock skew allowed when checking the exp claim: a number of seconds, a duration such as 30s or 2m, or -1 to disable the check. 0 or unset uses the OpenBao default of 150 seconds. Maps to `expiration_leeway`. Example: 30s
ConstraintsCEL: type(self) == int ? self >= -1 : self.matches('^([0-9]+(s|m|h))+$') (must be -1, a number of seconds or a duration such as 30s)
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.messagestringnoStatic error message returned when the program denies a login. Maps to `message`. Example: permission denied
Constraintslength: <=1024
spec.mountPathstringno"jwt"Path of the JWT auth method, without the auth/ prefix. Defaults to jwt. Immutable. Example: jwt
Constraintspattern: ^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$
length: >=1, <=128
spec.namestringnoName of the CEL role in OpenBao, used in the auth/<mountPath>/cel/login request. Defaults to metadata.name. Immutable. Example: ci-runner
Constraintspattern: ^[a-z0-9_]([a-z0-9_.-]*[a-z0-9_])?$
length: >=1, <=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.notBeforeLeewayint-or-stringnoClock skew allowed when checking the nbf claim: a number of seconds, a duration such as 30s or 2m, or -1 to disable the check. 0 or unset uses the OpenBao default of 150 seconds. Maps to `not_before_leeway`. Example: 30s
ConstraintsCEL: type(self) == int ? self >= -1 : self.matches('^([0-9]+(s|m|h))+$') (must be -1, a number of seconds or a duration such as 30s)
statusobjectnoObserved state of the CEL role, 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.