Fix aspects of auth/token/create request parsing
#18556
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
Fixes hashicorp#18550 Currently, the `auth/token/create` family of APIs (`create`, `create-orphan`, `create/{role}`) does non-standard parsing of requests, by directly using `mapstructure.WeakDecode(request.Data, ...)` instead of using the standard `framework.FieldData` abstraction. Furthermore, the fields declared for these APIs are incorrect, leading to inappropriate OpenAPI generation, and inappropriate warnings about ignored parameters. Detailed changes: * Factor out triplicated definitions of common fields across these three APIs. * Remove incorrect `role_name` field from `create-orphan`. * Add missing `lease` deprecated field. * Rename incorrectly named `metadata` field to `meta`, and change from `TypeMap` to `TypeKVPairs` to reflect actual underlying Go type is `map[string]string`. * Remove entirely incorrect `format` field. * Add declarative `Default: true` to `renewable` field, to match behaviour currently implemented in code. * Having fixed the field definitions to match current usage, remove the secondary decoding of the request via `mapstructure` inside `handleCreateCommon`, and migrate to using `FieldData` APIs like a normal operation function.
hsimon-hashicorp
added
core/openapi
bug
|
Hi @averche , As this PR relates to fixing field definitions that will affect OpenAPI correctness, and so the correctness of the new generated client libraries, I wonder if it is something you might be interested in looking into? |
|
@maxb This is a great PR and I would like to make it ready to be merged in. Would you please rebase with main such that the failing tests are fixed? |
|
I've updated the branch, but it looks like there are quite a few new PR checks which don't work for community PRs, due to credentials limited to branches within the main repo. |
|
@hghaf099 Thanks for your interest in my PR, what needs to happen next? |
averche
approved these changes
Jul 10, 2023
This was referenced Jul 11, 2023
averche
pushed a commit
to hashicorp/vault-client-go
that referenced
this pull request
Jul 11, 2023
From hashicorp/vault#18556 Changes auth methods: - TokenCreate - TokenCreateAgainstRole - TokenCreateOrphan
averche
pushed a commit
to hashicorp/vault-client-dotnet
that referenced
this pull request
Jul 11, 2023
From hashicorp/vault#18556 Changes auth methods: - TokenCreate - TokenCreateAgainstRole - TokenCreateOrphan
sebinjohn
pushed a commit
to sebinjohn/vault
that referenced
this pull request
Aug 11, 2023
* Fix aspects of `auth/token/create` request parsing Fixes hashicorp#18550 Currently, the `auth/token/create` family of APIs (`create`, `create-orphan`, `create/{role}`) does non-standard parsing of requests, by directly using `mapstructure.WeakDecode(request.Data, ...)` instead of using the standard `framework.FieldData` abstraction. Furthermore, the fields declared for these APIs are incorrect, leading to inappropriate OpenAPI generation, and inappropriate warnings about ignored parameters. Detailed changes: * Factor out triplicated definitions of common fields across these three APIs. * Remove incorrect `role_name` field from `create-orphan`. * Add missing `lease` deprecated field. * Rename incorrectly named `metadata` field to `meta`, and change from `TypeMap` to `TypeKVPairs` to reflect actual underlying Go type is `map[string]string`. * Remove entirely incorrect `format` field. * Add declarative `Default: true` to `renewable` field, to match behaviour currently implemented in code. * Having fixed the field definitions to match current usage, remove the secondary decoding of the request via `mapstructure` inside `handleCreateCommon`, and migrate to using `FieldData` APIs like a normal operation function. * Add changelog * Rephrase comment.
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.
Fixes #18550
Currently, the
auth/token/createfamily of APIs (create,create-orphan,create/{role}) does non-standard parsing of requests, by directly usingmapstructure.WeakDecode(request.Data, ...)instead of using the standardframework.FieldDataabstraction.Furthermore, the fields declared for these APIs are incorrect, leading to inappropriate OpenAPI generation, and inappropriate warnings about ignored parameters.
Detailed changes:
Factor out triplicated definitions of common fields across these three APIs.
Remove incorrect
role_namefield fromcreate-orphan.Add missing
leasedeprecated field.Rename incorrectly named
metadatafield tometa, and change fromTypeMaptoTypeKVPairsto reflect actual underlying Go type ismap[string]string.Remove entirely incorrect
formatfield.Add declarative
Default: truetorenewablefield, to match behaviour currently implemented in code.Having fixed the field definitions to match current usage, remove the secondary decoding of the request via
mapstructureinsidehandleCreateCommon, and migrate to usingFieldDataAPIs like a normal operation function.