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

feat(security)!: Deprecate oauth2 auth method #3575

Merged
merged 1 commit into from
Jun 17, 2021
Merged

feat(security)!: Deprecate oauth2 auth method #3575

merged 1 commit into from
Jun 17, 2021

Conversation

bnevis-i
Copy link
Collaborator

Deprecates oauth2 proxy auth method
in favor of stronger JWT-based auth method
by removing ability for secrets-config utility
to create OAuth2 users.

security-proxy-setup accidentally broke
OAuth2 functionality by installing a global
JWT auth handler intended to secure admin API
(can't have two global auth handlers because
both auth methods must pass, which is impossible.)

Comment rather than remove code in case
it needs to be added back in Jakarta
stabilization release, otherwise will be
removed permanently in both secrets-config
and proxy-setup.

Closes #3564

Signed-off-by: Bryon Nevis [email protected]

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-go/blob/master/.github/Contributing.md.

What is the current behavior?

When adding proxy users with oauth2 auth method, Kong proxy authentication broken
due to installation of two global auth handlers.

Issue Number:

Closes #3564

What is the new behavior?

Remove oauth2-based authentication.

Does this PR introduce a breaking change?

  • Yes
  • No

OAuth2 was the default in Edinburgh preview security release.
JWT has been the default since Fuji release.
OAuth2 has been supported as a JWT alternative since Fuji.

New Imports

  • Yes
  • No

Specific Instructions

Are there any specific instructions or things that should be known prior to reviewing?

Other information

@bnevis-i bnevis-i added this to the Ireland milestone Jun 16, 2021
Copy link
Member

@lenny-goodell lenny-goodell left a comment

Choose a reason for hiding this comment

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

Looks good, Please add comments to each file on why this code is commented out rather then removed.

Deprecates oauth2 proxy auth method
in favor of stronger JWT-based auth method
by removing ability for secrets-config utility
to create OAuth2 users.

security-proxy-setup accidentally broke
OAuth2 functionality by installing a global
JWT auth handler intended to secure admin API
(can't have two global auth handlers because
both auth methods must pass, which is impossible.)

Comment rather than remove code in case
it needs to be added back in Jakarta
stabilization release, otherwise will be
removed permanently in both secrets-config
and proxy-setup.

Closes #3564

Signed-off-by: Bryon Nevis <[email protected]>
@bnevis-i
Copy link
Collaborator Author

Looks good, Please add comments to each file on why this code is commented out rather then removed.

Comments added.

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@bnevis-i bnevis-i requested a review from lenny-goodell June 17, 2021 00:06
Copy link
Member

@lenny-goodell lenny-goodell left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@jim-wang-intel jim-wang-intel left a comment

Choose a reason for hiding this comment

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

LGTM

@bnevis-i bnevis-i merged commit 649de80 into edgexfoundry:master Jun 17, 2021
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.

secrets-config proxy adduser --token-type oauth2 no longer works
3 participants