feat(conf): allow *_cert and *_cert_key to be stored in environment variables and vaults #9253
Conversation
This file contains 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
bungle
force-pushed
the
feat/conf-certs-env-and-vaults
branch
from
ef340f5
to
1c17b18
Compare
bungle
force-pushed
the
feat/conf-certs-env-and-vaults
branch
from
1c17b18
to
d13f432
Compare
bungle
force-pushed
the
feat/conf-certs-env-and-vaults
branch
from
2990779
to
2f595c2
Compare
bungle
force-pushed
the
feat/conf-certs-env-and-vaults
branch
from
1fc5f70
to
78ab363
Compare
bungle
force-pushed
the
feat/conf-certs-env-and-vaults
branch
from
9ab96cf
to
fd0df1e
Compare
hbagdi
reviewed
Sep 20, 2022
bungle
changed the title
…ariables and vaults
### Summary
Allow several `kong.conf` values to be stored in vaults or environment variables:
- `ssl_cert`
- `ssl_cert_key`
- `admin_ssl_cert`
- `admin_ssl_cert_key`
- `status_ssl_cert`
- `status_ssl_cert_key`
- `cluster_cert`
- `cluster_cert_key`
- `client_ssl_cert`
- `client_ssl_cert_key`
#### Usage
The following is possible after this is commit is merged:
```bash
CERT=$(<cert.crt) \ # normal environment variable intialized from file
KONG_SSL_CERT="{vault://env/cert}" \ # a secret reference using env vault
KONG_SSL_CERT_KEY="$(<cert.key)" \ # reading content of file to env var
kong start
```
* move creation of certificate and key files in a separate block * add file creation for the remaining certs and keys: cluster_ and client_ * update configuration with generated path for cluster_* and client_*
* support base64 encoded *_cert and *_cert_key * support base64url encoding This adds a test case to ensure base64 encoded properties are corectly parsed and decoded.
…cate This adds to the supported properties that can be assigned via environment variables or vault.
* test all base64 decodings * test that properties passed as content result in files being stored
* base64 conversion is moved later in the flow in order to make it safer, so that values like system are not attempted to be decoded * test coverage for the content of the created files * refactoring
Update kong.conf.default to reflect the fact some properties can be configured directly via content or base64
bungle
force-pushed
the
feat/conf-certs-env-and-vaults
branch
from
fd0df1e
to
f87af24
Compare
bungle
commented
Oct 4, 2022
yzyyi
approved these changes
Oct 4, 2022
|
Would you also cherrypick this to EE for parity? thanks |
locao
pushed a commit
that referenced
this pull request
Jun 21, 2024
…group is absent (#9253) Cherry-picked from #13024 Fix #13014, https://konghq.atlassian.net/browse/KAG-4474 Co-authored-by: hulk <hulk.website@gmail.com> Co-authored-by: Xumin <100666470+StarlightIbuki@users.noreply.github.com> Co-authored-by: Chrono <chronolaw@gmail.com> Co-authored-by: Mikołaj Nowak <mikolaj.nowak93@gmail.com> Co-authored-by: xumin <xumin.zhou@konghq.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Allow several
kong.confvalues to be stored in vaults or environment variables:ssl_certssl_cert_keyadmin_ssl_certadmin_ssl_cert_keystatus_ssl_certstatus_ssl_cert_keycluster_certcluster_cert_keyclient_ssl_certclient_ssl_cert_keycluster_ca_certssl_dhparamlua_ssl_trusted_certificateUsage
The following is possible after this is commit is merged:
(FT-3244)