fix: accept Opaque secrets for mTLS auth#276
Merged
Merged
Conversation
|
|
shashwatsuri
pushed a commit
to shashwatsuri/temporal-worker-controller
that referenced
this pull request
Apr 28, 2026
## What was changed Relax the secret type check in `ParseClientSecret` to accept both `kubernetes.io/tls` and `Opaque` secret types for `AuthModeTLS`. Update the `MutualTLSSecretRef` field comment in the CRD types to reflect the expanded accepted types. ## Why? Previously, the controller enforced `type: kubernetes.io/tls` for mTLS secrets. This blocked organizations that store TLS credentials in `Opaque` secrets — a common pattern when bundling `tls.crt`, `tls.key`, and `ca.crt` into a single secret (e.g. multi-file cert-manager outputs, or any tooling that produces a keypair alongside a custom CA). The `kubernetes.io/tls` secret type natively supports only two keys (`tls.crt` and `tls.key`), so teams needing to include a CA cert alongside the keypair must use `Opaque`. The downstream handler `fetchClientUsingMTLSSecret` already accesses secret data by key name and works correctly with either type — only the type guard was blocking it. ## Checklist 1. Closes temporalio#275 2. How was this tested: Unit test `TestParseClientSecret_OpaqueSecretType` (renamed from `TestParseClientSecret_WrongSecretType`) now asserts that an `Opaque` secret containing `tls.crt` and `tls.key` is accepted and produces a valid `ClientAuth` with `AuthModeTLS`. All 316 existing tests continue to pass. 3. Any docs updates needed? `MutualTLSSecretRef` field comment in `api/v1alpha1/temporalconnection_types.go` updated to document both accepted secret types.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What was changed
Relax the secret type check in
ParseClientSecretto accept bothkubernetes.io/tlsandOpaquesecret types forAuthModeTLS. Update theMutualTLSSecretReffield comment in the CRD types to reflect the expanded accepted types.Why?
Previously, the controller enforced
type: kubernetes.io/tlsfor mTLS secrets. This blocked organizations that store TLS credentials inOpaquesecrets — a common pattern when bundlingtls.crt,tls.key, andca.crtinto a single secret (e.g. multi-file cert-manager outputs, or any tooling that produces a keypair alongside a custom CA).The
kubernetes.io/tlssecret type natively supports only two keys (tls.crtandtls.key), so teams needing to include a CA cert alongside the keypair must useOpaque. The downstream handlerfetchClientUsingMTLSSecretalready accesses secret data by key name and works correctly with either type — only the type guard was blocking it.Checklist
Closes [Bug] ParseClientSecret rejects Opaque secrets for AuthModeTLS #275
How was this tested:
Unit test
TestParseClientSecret_OpaqueSecretType(renamed fromTestParseClientSecret_WrongSecretType) now asserts that anOpaquesecret containingtls.crtandtls.keyis accepted and produces a validClientAuthwithAuthModeTLS. All 316 existing tests continue to pass.MutualTLSSecretReffield comment inapi/v1alpha1/temporalconnection_types.goupdated to document both accepted secret types.