Secrets engine resources · Kind catalogue · Examples
TOTPKey¶
API version: secrets.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: totpkeys.secrets.openbaoconfig.io
Categories: openbao
TOTPKey manages a key of a TOTP secrets engine at `<mount>/keys/<name>`, either generated by OpenBao or imported from a Secret. Use it to issue or validate time-based one-time passwords; a generated key's URL and QR code are written once to writeSecretRef.
Example:
Example:
spec:
connectionRef:
name: openbao
name: alice
issuer: Example Corp
accountName: alice@example.com
generate:
writeSecretRef:
name: alice-totpExample¶
examples/secrets/totpkey.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TOTPKey
metadata:
name: obco-alice
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: totp
name: obco-alice
generate:
keySize: 20
exported: true
qrSize: 200
writeSecretRef:
name: obco-alice-otpauth
issuer: Example
accountName: alice@example.com
period: 30s
algorithm: SHA256
digits: 8
skew: 1
---
apiVersion: v1
kind: Secret
metadata:
name: obco-bob-totp
namespace: openbao-config
type: Opaque
stringData:
key: FAKEFAKEFAKEFAKE
url: otpauth://totp/Example:carol@example.com?secret=FAKEFAKEFAKEFAKE&issuer=Example&period=30&digits=6&algorithm=SHA1
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TOTPKey
metadata:
name: obco-bob
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: totp
keySecretRef:
name: obco-bob-totp
key: key
issuer: Example
accountName: bob@example.com
period: 60s
algorithm: SHA1
digits: 6
skew: 0
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TOTPKey
metadata:
name: obco-carol
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: totp
urlSecretRef:
name: obco-bob-totp
key: url
skew: 1
On GitHub: totpkey.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 | spec is the desired key of a TOTP secrets engine at `<mountPath>/keys/<name>`. Set exactly one of generate (OpenBao generates the key), keySecretRef (import a base32 key) or urlSecretRef (import an otpauth URL). | 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.generate) ? 1 : 0) + (has(self.keySecretRef) ? 1 : 0) + (has(self.urlSecretRef) ? 1 : 0) == 1 (set exactly one of generate, keySecretRef and urlSecretRef)CEL: has(self.generate) == has(oldSelf.generate) (switching between a generated and an imported key is not allowed)CEL: !has(oldSelf.generate) || (has(self.generate) && self.generate == oldSelf.generate) (generate is immutable)CEL: !has(oldSelf.generate) || (has(self.issuer) == has(oldSelf.issuer) && (!has(self.issuer) || self.issuer == oldSelf.issuer) && has(self.accountName) == has(oldSelf.accountName) && (!has(self.accountName) || self.accountName == oldSelf.accountName)) (issuer and accountName of a generated key are immutable)CEL: !has(oldSelf.generate) || (has(self.period) == has(oldSelf.period) && (!has(self.period) || self.period == oldSelf.period) && has(self.algorithm) == has(oldSelf.algorithm) && (!has(self.algorithm) || self.algorithm == oldSelf.algorithm) && has(self.digits) == has(oldSelf.digits) && (!has(self.digits) || self.digits == oldSelf.digits) && has(self.skew) == has(oldSelf.skew) && (!has(self.skew) || self.skew == oldSelf.skew)) (period, algorithm, digits and skew of a generated key are immutable)CEL: !has(self.generate) || (has(self.issuer) && has(self.accountName)) (a generated key needs issuer and accountName)CEL: !has(self.urlSecretRef) || (!has(self.issuer) && !has(self.accountName) && !has(self.period) && !has(self.algorithm) && !has(self.digits)) (issuer, accountName, period, algorithm and digits come from the URL with urlSecretRef)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.accountName | string | no | accountName is the account the key belongs to (`account_name`). Required with generate; immutable then. Example: `alice@example.com`. | Constraintslength: >=1, <=256 | |
spec.algorithm | string | no | algorithm is the hash algorithm of the code (`algorithm`). Allowed: SHA1, SHA256, SHA512. Defaults to SHA1. Immutable for a generated key. | Constraintsone of:SHA1, SHA256, SHA512 | |
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.digits | integer (int32) | no | digits is the length of the code (`digits`). Allowed: 6, 8. Defaults to 6. Immutable for a generated key. | Constraintsone of:6, 8 | |
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.generate | object | no | generate makes OpenBao generate the key once (`generate=true`). Its settings cannot change afterwards: a new write would replace the key and break every enrolled authenticator. | ConstraintsCEL:(has(self.exported) && !self.exported) || has(self.writeSecretRef) (writeSecretRef is required unless exported is false) | |
spec.generate.exported | boolean | no | exported returns the otpauth URL and QR code once, at creation (`exported`). Defaults to true. | ||
spec.generate.keySize | integer (int32) | no | keySize is the size of the generated key in bytes (`key_size`). 1-256. Defaults to 20. | Constraintsvalue: >=1, <=256 | |
spec.generate.qrSize | integer (int32) | no | qrSize is the pixel size of the QR code; 0 returns none (`qr_size`). 0-2048. Defaults to 200. | Constraintsvalue: >=0, <=2048 | |
spec.generate.writeSecretRef | object | no | writeSecretRef names the Secret, owned by this resource, that receives the otpauth URL (key `url`) and the base64 PNG QR code (key `barcode`) once, when the key is generated. OpenBao never returns them again; they are never stored in status. Example: `{name: alice-totp}`. | ||
spec.generate.writeSecretRef.name | string | yes | Name of the referenced object, in the same namespace as this resource. Example: my-app | Constraintslength: >=1, <=253 | |
spec.issuer | string | no | issuer is the name of the issuing organisation (`issuer`). Required with generate; immutable then. Example: `Example Corp`. | Constraintslength: >=1, <=256 | |
spec.keySecretRef | object | no | keySecretRef selects the Secret key holding the base32 shared key to import (`key`). Read from a Secret key; never stored in status. Write-only. Example: `{name: alice-totp, key: seed}`. | ||
spec.keySecretRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.keySecretRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
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 | "totp" | mountPath is the path of the TOTP secrets engine mount. Defaults to `totp`. Immutable. Example: `totp`. | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: <=128 |
spec.name | string | no | name is the key name in OpenBao. Defaults to metadata.name. Immutable. Example: `alice`. | Constraintspattern:^[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.period | string | no | period is the time step of the code (`period`), a duration. Defaults to `30s`. Immutable for a generated key. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.skew | integer (int32) | no | skew is the number of periods of clock drift accepted when validating a code (`skew`). Allowed: 0, 1. Defaults to 1. Immutable for a generated key. | Constraintsvalue: >=0, <=1 | |
spec.urlSecretRef | object | no | urlSecretRef selects the Secret key holding an `otpauth://` URL to import (`url`); issuer, account and code settings come from the URL. Read from a Secret key; never stored in status. Write-only. Example: `{name: alice-totp, key: url}`. | ||
spec.urlSecretRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.urlSecretRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
status | object | no | status is the observed state of the TOTP key. | ||
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. |