Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vault - Transit - Documentation. #9235

Closed
diesalbla opened this issue Jun 16, 2020 · 2 comments
Closed

Vault - Transit - Documentation. #9235

diesalbla opened this issue Jun 16, 2020 · 2 comments
Assignees

Comments

@diesalbla
Copy link

diesalbla commented Jun 16, 2020

Is your feature request related to a problem? Please describe.

This issue is related to some unclear language in the documentation of the transit secrets engine: the encrypt data section describes the differences in behaviour between the update or the create policies, but it does not state which policies are required to use the endpoint. The same happens for the decrypt data section.

Describe the solution you'd like
The solution would be to edit the documentation to :

  • State clearly what policies are required to use the encrypt-data and decrypt-data endpoints.
  • If this is a case of a general policy rule, hypothetically that all POST or PUT endpoints require either the create or update policies, to refer to that rule.

Describe alternatives you've considered

None. It is a request for changing the text.

Explain any additional use-cases

Other sections may benefit for such explicit statements, but I have none in mind.

Additional context

This is submitted as issue, not as a question on the forum, because this is requesting a change to the documentation, not clarifications or guidance for a specific doubt.

@aphorise
Copy link
Contributor

aphorise commented Sep 3, 2022

I think the current documentation calls this out:

This endpoint encrypts the provided plaintext using the named key. This path supports the create and update policy capabilities as follows: if the user has the create capability for this endpoint in their policies, and the key does not exist, it will be upserted with default values (whether the key requires derivation depends on whether the context parameter is empty or not). If the user only has update capability and the key does not exist, an error will be returned.

Hey @diesalbla do you agree & ok to close?

@diesalbla
Copy link
Author

@aphorise Yeah, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants