[python] Fix basic auth always being used #12212
Merged
Conversation
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
added 3 commits
August 15, 2023 15:33
The Python client configuration will always generate a basic auth header regarless of username and password actually being set. This is a problem if the consumer is trying to use another authorization method that uses the same header name, e.g. Authorization. This bug is only triggered when the api spec's security definitions list BasicAuth after an auth type that uses a conflicting header. Unfortunately, RFC 2617 [1] says that _both_ the username and password are allowed to be empty. This is how golang implements basic auth [2] which means golang codegen is also affected. Java codegen requires both username and password to be set [3]. C# requires only one of them to be set [4]. Java and C# are therefore not affected. Change python codegen to require either the username or password to be set as a compromise between being broken and rfc compliant. [1]: https://datatracker.ietf.org/doc/html/rfc2617#section-2 [2]: https://github.com/golang/go/blob/master/src/net/http/client.go#L426 [3]: https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/auth/HttpBasicAuth.mustache#L45 [4]: https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/csharp/api.mustache#L407 Signed-off-by: Cory Todd <[email protected]>
Run ./bin/python-petstore.py to pick up basic auth fixes. Signed-off-by: Cory Todd <[email protected]>
Run ./bin/security/python-petstore.sh to pick up basic auth fixes. Note that there have been other template changes in python but security/python-petstore.sh was not run so the sample is out of date. I have intentionally excluded the changes that are not related to the basic auth fix. Signed-off-by: Cory Todd <[email protected]>
corytodd
force-pushed
the
fix-python-config-basic-auth
branch
from
430949d to
b1ca1b5
Compare
|
thanks @corytodd for this PR! |
This was referenced Dec 29, 2023
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.
PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.shand./bin/security/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\.3.0.0branch for changes related to OpenAPI spec 3.0. Default:master.@kenjones-cisco
Description of the PR
The Python client configuration will always generate a basic auth header regarless of username and password actually being set. This is a problem if the consumer is trying to use another authorization method that uses the same header name, e.g. Authorization. This bug is only triggered when the api spec's security definitions list BasicAuth after an auth type that uses a conflicting header.
Unfortunately, RFC 2617 1 says that both the username and password are allowed to be empty. This is how golang implements basic auth 2 which means golang codegen is also affected. Java codegen requires both username and password to be set 3. C# requires only one of them to be set 4. Java and C# are therefore not affected. Change python codegen to require either the username or password to be set as a compromise between being broken and rfc compliant.
fixes #9430