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

[Rust-Axum][Breaking Changes] Extracting Claims in Cookie/Header #20097

Merged
merged 3 commits into from
Nov 14, 2024

Conversation

linxGnu
Copy link
Contributor

@linxGnu linxGnu commented Nov 13, 2024

This PR helps handling Authentication via API key (in Header and in Cookie). Extracted Claims are now sent to all Operations

Integration tests passed:

mvn clean && ./bin/generate-samples.sh bin/configs/manual/rust-axum-* && mvn integration-test -f samples/server/petstore/rust-axum/pom.xml

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Sorry, something went wrong.

&self,
headers: &axum::http::header::HeaderMap,
key: &str,
) -> Option<String>;
) -> Option<Self::Claims>;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

User Impl this trait to extract Claims (e.g: JWT) from Header/Cookie.

@@ -68,7 +70,7 @@ pub trait Payments {
method: Method,
host: Host,
cookies: CookieJar,
token_in_cookie: Option<String>,
claims: Self::Claims,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extracted Claims (in previous step) is injected into Operation. User then can do whatever he/she wants with the Claims (e.g: get AccountID from the Claims)

@linxGnu
Copy link
Contributor Author

linxGnu commented Nov 13, 2024

Kindly ping @wing328 to review

op.vendorExtensions.put("x-has-header-auth-methods", "true");
op.vendorExtensions.put("x-api-key-header-name", toModelName(s.keyParamName));
op.vendorExtensions.put("x-has-header-auth-methods", true);
op.vendorExtensions.put("x-api-key-header-name", s.keyParamName);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug fix here. We must use keyParamName instead of transforming

@wing328
Copy link
Member

wing328 commented Nov 14, 2024

thanks for the PR. let's give it a try

if users need the old behavior with a valid use case, we will come up with a way for that.

@wing328 wing328 merged commit ee698f1 into OpenAPITools:master Nov 14, 2024
20 checks passed
@linxGnu linxGnu deleted the better_claims branch November 14, 2024 08:01
@linxGnu
Copy link
Contributor Author

linxGnu commented Nov 14, 2024

Thank you for reviewing @wing328

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

Successfully merging this pull request may close these issues.

None yet

2 participants