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

Support OAuth2 PKCE when using the OIDC authorization_code flow #6914

Merged
merged 2 commits into from Feb 10, 2021
Merged

Support OAuth2 PKCE when using the OIDC authorization_code flow #6914

merged 2 commits into from Feb 10, 2021

Conversation

ChadKillingsworth
Copy link
Contributor

Description

Security schemes using OIDC did not support PKCE even when enabled in the config. The check was only looking for the manually defined "authorizationCode" flow from an OAuth2 scheme and not the "authorization_code" flow from an OIDC grant.

Motivation and Context

My provider requires PKCE to be used and the integration is currently failing. Adding this check properly supports PKCE.

How Has This Been Tested?

A unit test was added specifically for this flow (copied from the authorizationCode flow). The changes were manually applied to my project to ensure that PKCE was indeed working.

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

Previous checks only supported the OAuth2 authorizationCode flow and missed the equivalent OIDC flow.
@@ -77,7 +77,7 @@ export default function authorize ( { auth, authActions, errActions, configs, au
query.push("realm=" + encodeURIComponent(authConfigs.realm))
}

if ((flow === "authorizationCode" || flow === "accessCode") && authConfigs.usePkceWithAuthorizationCodeGrant) {
if ((flow === "authorizationCode" || flow === "authorization_code" || flow === "accessCode") && authConfigs.usePkceWithAuthorizationCodeGrant) {

Choose a reason for hiding this comment

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

i wonder if you should do flow === 'access_code' too?

@tim-lai tim-lai merged commit 5e69d3c into swagger-api:master Feb 10, 2021
@tim-lai
Copy link
Contributor

tim-lai commented Feb 10, 2021

@ChadKillingsworth PR merged! Thanks for the contribution!

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

3 participants