Optional automatic default issuer selection #17824
Merged
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
When setting a new default issuer, our helper function would overwrite other parameters in the issuer configuration entry. However, up until now, there were none. Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
| @@ -52,6 +53,11 @@ func pathConfigIssuers(b *backend) *framework.Path { | |||
| Type: framework.TypeString, | |||
| Description: `Reference (name or identifier) to the default issuer.`, | |||
| }, | |||
| "default_follows_latest_issuer": { | |||
| Type: framework.TypeBool, | |||
| Description: `Whether the default issuer should automatically follow the latest generated or imported issuer. Defaults to false.`, | |||
There was a problem hiding this comment.
If this is meant to allow opt-in to unbreak a change, should the original change be documented as breaking, and point to this new field as a way to opting into the previous behavior if necessary, while suggesting that callers move to using the new multi-issuer functionality more explicitly as they can? (just a thought)
There was a problem hiding this comment.
Ah yeah, its in the web docs that I've not pushed, one second.
3 tasks
This parameter will allow operators to have the default issuer automatically update when a new root is generated or a single issuer with a key (potentially with others lacking key) is imported. Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
These internal members shouldn't be tested by the storage migration code, and so should be elided from the test results. Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
This updates the two places where issuers can be created (outside of legacy CA bundle migration which already sets the default) to follow newly created issuers when the config is set. Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
cipherboy
force-pushed
the
cipherboy-automatic-default-issuer
branch
from
ffc9861
to
3ae7100
Compare
sgmiller
approved these changes
Nov 8, 2022
|
If you have suggestions, I'm happy to update. But in general I think we point people towards the online docs as being more comprehensive than the in-Vault docs. |
Nah, its fine. |
kitography
approved these changes
Nov 8, 2022
This was referenced Nov 8, 2022
3 tasks
3 tasks
jayant07-yb
pushed a commit
to jayant07-yb/hashicorp-vault-integrations
that referenced
this pull request
Mar 15, 2023
* Correctly preserve other issuer config params When setting a new default issuer, our helper function would overwrite other parameters in the issuer configuration entry. However, up until now, there were none. Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com> * Add new parameter to allow default to follow new This parameter will allow operators to have the default issuer automatically update when a new root is generated or a single issuer with a key (potentially with others lacking key) is imported. Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com> * Storage migration tests fail on new members These internal members shouldn't be tested by the storage migration code, and so should be elided from the test results. Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com> * Follow new issuer on root generation, import This updates the two places where issuers can be created (outside of legacy CA bundle migration which already sets the default) to follow newly created issuers when the config is set. Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com> * Add changelog entry Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com> * Add documentation Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com> * Add test for new default-following behavior Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com> Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.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.
When attempting compatibility against multiple versions of Vault, one major breaking change in Vault 1.11 was the multiple issuer's functionality and behavior changes around importing issuers (wherein
/config/carequired a deletion first) and generation of new issuers (where both root/intermediate generation silently removed old keys!).While we don't wish to remove key material any more, thus becoming more safe, the net was a breaking change across APIs: because the default issuer was not updated on these operations, the issuer would appear "lost" to any callers. Only when an operator updated the default issuer would non-multi-issuer aware applications see this new CA.
However, not everyone will want to automatically change the default issuer: for applications and operators aware of multi-issuer functionality, who wish to proactively prime new isseurs prior to enabling them (perhaps for distribution purposes), this change shouldn't be automatic and retroactive.
Thus, make this an opt-in change on
/config/issuers.This obviously needs:
Like #17823, I'm curious to get people's thoughts.