Authentication resources · Kind catalogue · Examples
JWTAuthConfig¶
API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: jwtauthconfigs.auth.openbaoconfig.io
Categories: openbao
JWTAuthConfig manages the configuration of an OpenBao JWT/OIDC auth method at auth/<mountPath>/config. Use it to set how JWTs are verified (OIDC discovery, JWKS URL or static keys) and the OIDC client for browser logins; one per mount.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: oidc
oidcDiscoveryURL: https://keycloak.example.com/realms/platform
oidcClientID: openbao
oidcClientSecretSecretRef: {name: oidc-client, key: client-secret}
defaultRole: default
deletionPolicy: OrphanExample¶
examples/auth/jwtauthconfig.yaml
# Configures the oidc mount for browser logins through a Keycloak realm
# found by OIDC discovery, with the client secret read from a Secret.
# The other resources verify CI job JWTs with a JWKS URL, Kubernetes
# ServiceAccount tokens with a static public key, and Google Workspace
# logins with a provider configuration from a Secret.
apiVersion: v1
kind: Secret
metadata:
name: oidc-client
type: Opaque
stringData:
client-secret: fake-oidc-client-secret-not-real
---
apiVersion: v1
kind: Secret
metadata:
name: gsuite-provider
type: Opaque
stringData:
config: '{"gsuite_service_account": "{\"type\": \"service_account\", \"private_key\": \"fake-not-a-real-key\"}"}'
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthConfig
metadata:
name: oidc
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: oidc
oidcDiscoveryURL: https://keycloak.example.com/realms/platform
oidcDiscoveryCAPEM: |
-----BEGIN CERTIFICATE-----
RkFLRS1DQS1DRVJUSUZJQ0FURS1GT1ItRVhBTVBMRVMtT05MWQ==
-----END CERTIFICATE-----
oidcClientID: openbao
oidcClientSecretSecretRef:
name: oidc-client
key: client-secret
oidcResponseMode: form_post
oidcResponseTypes:
- code
- id_token
jwtSupportedAlgs:
- RS256
- ES256
boundIssuer: https://keycloak.example.com/realms/platform
defaultRole: reader
overrideAllowedServerNames:
- keycloak.internal.example.com
namespaceInState: true
skipJWKSValidation: false
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthConfig
metadata:
name: jwt-jwks
spec:
connectionRef:
name: openbao
mountPath: jwt-ci
jwksURL: https://gitlab.example.com/oauth/discovery/keys
jwksCAPEM: |
-----BEGIN CERTIFICATE-----
RkFLRS1DQS1DRVJUSUZJQ0FURS1GT1ItRVhBTVBMRVMtT05MWQ==
-----END CERTIFICATE-----
boundIssuer: https://gitlab.example.com
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthConfig
metadata:
name: jwt
spec:
connectionRef:
name: openbao
mountPath: jwt
jwtValidationPubkeys:
- |
-----BEGIN PUBLIC KEY-----
RkFLRS1QVUJMSUMtS0VZLUZPUi1FWEFNUExFUy1PTkxZ
-----END PUBLIC KEY-----
boundIssuer: https://kubernetes.default.svc.cluster.local
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthConfig
metadata:
name: gsuite
spec:
connectionRef:
name: openbao
mountPath: gsuite
oidcDiscoveryURL: https://accounts.google.com
oidcClientID: fake-client-id.apps.googleusercontent.com
oidcClientSecretSecretRef:
name: oidc-client
key: client-secret
providerConfig:
provider: gsuite
settings:
admin_impersonate: admin@example.com
fetch_groups: true
groups_recurse_max_depth: 5
secretRef:
name: gsuite-provider
key: config
On GitHub: jwtauthconfig.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 JWT/OIDC auth method configuration, written to auth/<mountPath>/config. OpenBao replaces the whole configuration on every write, so unset fields are reset to their OpenBao defaults. Set exactly one key source: oidcDiscoveryURL, jwksURL, jwtValidationPubkeys or a kubernetes providerConfig. 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 auth method configuration cannot be deleted, only replaced)CEL: [has(self.oidcDiscoveryURL), has(self.jwksURL), has(self.jwtValidationPubkeys), has(self.providerConfig) && self.providerConfig.provider == 'kubernetes'].filter(x, x).size() == 1 (set exactly one of oidcDiscoveryURL, jwksURL, jwtValidationPubkeys and a kubernetes providerConfig)CEL: has(self.oidcClientID) == has(self.oidcClientSecretSecretRef) (oidcClientID and oidcClientSecretSecretRef must be set together)CEL: !has(self.oidcClientID) || has(self.oidcDiscoveryURL) (oidcClientID requires oidcDiscoveryURL)CEL: !has(self.oidcResponseTypes) || !self.oidcResponseTypes.exists(t, t == 'id_token') || (has(self.oidcResponseMode) && self.oidcResponseMode == 'form_post') (the id_token response type requires oidcResponseMode form_post)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.boundIssuer | string | no | Value the iss claim of every JWT must equal. Unset skips the issuer check. Maps to `bound_issuer`. Example: https://keycloak.example.com/realms/platform | Constraintslength: <=2048 | |
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.defaultRole | string | no | Role used when a login request does not name one. Unset makes the role mandatory at login. Maps to `default_role`. Example: default | Constraintspattern:^[a-z0-9_.-]*$length: <=128 | |
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.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.jwksCAPEM | string | no | PEM-encoded CA certificate or chain used to verify TLS to jwksURL. Unset uses the system trust store. Maps to `jwks_ca_pem`. Example: "-----BEGIN CERTIFICATE-----\n..." | Constraintslength: <=65536 | |
spec.jwksURL | string | no | URL of a JSON Web Key Set used to verify JWT signatures. Excludes oidcDiscoveryURL and jwtValidationPubkeys. Maps to `jwks_url`. Example: https://issuer.example.com/.well-known/jwks.json | Constraintslength: >=1, <=2048 | |
spec.jwtSupportedAlgs | []string | no | JWT signing algorithms accepted, such as RS256, RS512, ES256 or EdDSA. OpenBao defaults to RS256. Maps to `jwt_supported_algs`. Example: [RS256, ES256] | Constraintsitems: <=16list type: set each item: length: <=16 | |
spec.jwtValidationPubkeys | []string | no | PEM-encoded public keys used to verify JWT signatures locally, without contacting the issuer. Excludes oidcDiscoveryURL and jwksURL. Maps to `jwt_validation_pubkeys`. Example: ["-----BEGIN PUBLIC KEY-----\n..."] | Constraintsitems: >=1, <=32list type: set each item: length: <=16384 | |
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 | "jwt" | Path of the JWT/OIDC auth method, without the auth/ prefix. Defaults to jwt. Immutable. Example: oidc | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-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.namespaceInState | boolean | no | When true, the OpenBao namespace is passed in the OIDC state parameter instead of as a query parameter, so redirect URIs need no namespace. OpenBao defaults to true for a new configuration and keeps the current value when unset. Maps to `namespace_in_state`. Example: true | ||
spec.oidcClientID | string | no | OAuth2 client ID registered with the OIDC provider, needed for the browser OIDC login flow. Must be set together with oidcClientSecretSecretRef and requires oidcDiscoveryURL. Maps to `oidc_client_id`. Example: openbao | Constraintslength: >=1, <=512 | |
spec.oidcClientSecretSecretRef | object | no | Secret key holding the OAuth2 client secret. 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. Must be set together with oidcClientID. Maps to `oidc_client_secret`. Example: {name: oidc-client, key: client-secret} | ||
spec.oidcClientSecretSecretRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.oidcClientSecretSecretRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
spec.oidcDiscoveryCAPEM | string | no | PEM-encoded CA certificate or chain used to verify TLS to oidcDiscoveryURL. Unset uses the system trust store. Maps to `oidc_discovery_ca_pem`. Example: "-----BEGIN CERTIFICATE-----\n..." | Constraintslength: <=65536 | |
spec.oidcDiscoveryURL | string | no | Issuer URL used for OIDC discovery, without the /.well-known/openid-configuration suffix. Excludes jwksURL and jwtValidationPubkeys; required by oidcClientID. Maps to `oidc_discovery_url`. Example: https://keycloak.example.com/realms/platform | Constraintslength: >=1, <=2048CEL: !self.contains('.well-known') (oidcDiscoveryURL must not contain the .well-known component) | |
spec.oidcResponseMode | string | no | OAuth2 response mode of the OIDC login: query or form_post. OpenBao defaults to query; the id_token response type requires form_post. Maps to `oidc_response_mode`. Example: form_post | Constraintsone of:query, form_post | |
spec.oidcResponseTypes | []string | no | OAuth2 response types to request: code, id_token or both. OpenBao defaults to [code]; id_token requires oidcResponseMode form_post. Maps to `oidc_response_types`. Example: [code] | Constraintsitems: <=2list type: set each item: one of: code, id_token | |
spec.overrideAllowedServerNames | []string | no | Host names accepted during TLS verification of oidcDiscoveryURL and jwksURL, instead of the host name in the URL. Maps to `override_allowed_server_names`. Example: [keycloak.internal] | Constraintsitems: <=32list type: set each item: length: <=253 | |
spec.providerConfig | object | no | Provider-specific configuration, for example group fetching from Azure or Google Workspace, or kubernetes as the key source. Maps to `provider_config`. Example: {provider: azure, settings: {fetch_groups: true}} | ||
spec.providerConfig.provider | string | yes | Provider integration to enable. One of azure, gsuite, secureauth, ibmisam or kubernetes. kubernetes is a key source on its own; the others also need oidcDiscoveryURL. Required. Maps to `provider_config.provider`. Example: azure | Constraintsone of:azure, gsuite, secureauth, ibmisam, kubernetes | |
spec.providerConfig.secretRef | object | no | Secret key holding a JSON object merged over settings, for sensitive keys such as gsuite_service_account. Read from this Secret key; the value is never stored in status. OpenBao does not return sensitive keys, so when this is set the whole provider configuration is compared only through status.writeOnlyHash and a Secret change forces a write. Example: {name: gsuite-provider, key: config.json} | ||
spec.providerConfig.secretRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.providerConfig.secretRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
spec.providerConfig.settings | map[string]object (any fields) | no | Other non-sensitive provider keys as a JSON object, at most 64 keys. Put sensitive keys in secretRef instead. Maps to the remaining `provider_config` keys. Example: {fetch_groups: true, groups_recurse_max_depth: 5} | Constraintsproperties: <=64 | |
spec.skipJWKSValidation | boolean | no | When true, the configuration is accepted even if oidcDiscoveryURL or jwksURL cannot be reached at write time. OpenBao does not store it; it is tracked through status.writeOnlyHash. Maps to `skip_jwks_validation`. Example: true | ||
status | object | no | Observed state of the auth method configuration, 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. |