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

fix(oidc): return correct extra claims #7071

Merged
merged 2 commits into from Apr 3, 2024
Merged

Conversation

james-d-elliott
Copy link
Member

@james-d-elliott james-d-elliott commented Apr 3, 2024

The GetExtraClaims function is called during introspection which doesn't need the extra claims from the ID Token Session.

Summary by CodeRabbit

  • Refactor

    • Simplified the logic for retrieving extra claims in OIDC sessions.
  • Tests

    • Updated a test case to reflect the new logic for extra claims handling.

The GetExtraClaims function is called during introspection which doesn't need the extra claims from the ID Token Session.

Signed-off-by: James Elliott <james-d-elliott@users.noreply.github.com>
@authelia
Copy link

authelia bot commented Apr 3, 2024

Artifacts

These changes are published for testing on Buildkite, DockerHub and GitHub Container Registry.

Docker Container

  • docker pull authelia/authelia:fix-extra-claims
  • docker pull ghcr.io/authelia/authelia:fix-extra-claims

Copy link
Contributor

coderabbitai bot commented Apr 3, 2024

Walkthrough

The recent update involves simplifying the logic for retrieving extra claims in the Session struct by directly returning the existing extra claims without additional checks. Additionally, a test case was renamed to reflect that it now checks for a scenario where ID token claims extra should not be returned, and a minor adjustment was made to the test data within this test case.

Changes

Files Change Summary
internal/oidc/.../session.go Simplified GetExtraClaims method by directly returning s.Extra.
internal/oidc/.../session_test.go Renamed test from "ShouldReturnIDTokenClaimsExtra" to "ShouldNotReturnIDTokenClaimsExtra". Updated test data in the map for key "b" from 2 to 1.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 11328cd and e870b02.
Files selected for processing (2)
  • internal/oidc/session.go (1 hunks)
  • internal/oidc/session_test.go (2 hunks)
Additional comments not posted (2)
internal/oidc/session_test.go (2)

51-51: The test case name change accurately reflects the updated behavior of the GetExtraClaims method.


65-65: Ensure the test coverage adequately tests the updated behavior of the GetExtraClaims method, particularly in scenarios where s.Extra might be populated differently.

internal/oidc/session.go Show resolved Hide resolved
Copy link

codecov bot commented Apr 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.65%. Comparing base (11328cd) to head (18588de).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #7071      +/-   ##
==========================================
+ Coverage   73.62%   73.65%   +0.03%     
==========================================
  Files         344      344              
  Lines       29917    29914       -3     
  Branches      839      839              
==========================================
+ Hits        22025    22033       +8     
+ Misses       7019     7011       -8     
+ Partials      873      870       -3     
Flag Coverage Δ
backend 74.54% <ø> (+0.03%) ⬆️
frontend 65.84% <ø> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
internal/oidc/session.go 100.00% <ø> (ø)

... and 3 files with indirect coverage changes

@james-d-elliott james-d-elliott merged commit a9021aa into master Apr 3, 2024
49 checks passed
@james-d-elliott james-d-elliott deleted the fix-extra-claims branch April 3, 2024 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant