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: Support OAuth Client Credentials Grant [HEAD-873] #4970

Merged
merged 9 commits into from
Jan 2, 2024

Conversation

PeterSchafer
Copy link
Contributor

@PeterSchafer PeterSchafer commented Dec 15, 2023

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

This PR adds support for the OAuth Client Credentials Grant to the CLI in addition to the already existing Authorization Code Grant. While the latter is still the default OAuth Grant, providing Client ID and Client Secret via cmd Arguments, will switch to the Client Credentials Grant.

Where should the reviewer start?

All of the changes are actually in the go-application-framework, here only minor changes made and tests are added.
snyk/go-application-framework#115

How should this be manually tested?

Authenticate using Client Credentials Grant

snyk auth --auth-type=oauth --client-secret=<SECRET> --client-id=<ID> 

Authenticate using Authorization Code Grant

snyk auth --auth-type=oauth

Any background context you want to provide?

https://datatracker.ietf.org/doc/html/rfc6749#section-4.4

What are the relevant tickets?

HEAD-873

Screenshots

Additional questions

  • Risk: low risk, main thing to mention is that all authentication now goes through the auth extension, instead of going to the legacy CLI directly
  • Two acceptance tests where removed due to a slightly changed behaviour, they tested for a specific command flag combination and expected to react with a specific not supported message, now they just show the help as it is common if a certain flag is not supported. In this case it was the auth and the help command that where tested with --json-file-output.

@PeterSchafer PeterSchafer force-pushed the feat/HEAD-873_client_creds_grant branch from bf3fca9 to 9b5175e Compare December 15, 2023 15:06
@PeterSchafer PeterSchafer marked this pull request as ready for review December 20, 2023 09:32
@PeterSchafer PeterSchafer requested review from a team as code owners December 20, 2023 09:32
@PeterSchafer PeterSchafer force-pushed the feat/HEAD-873_client_creds_grant branch from e0b4988 to 4e3dbc4 Compare December 20, 2023 18:21
@PeterSchafer PeterSchafer changed the title feat: Support OAuth Client Credentials Grant feat: Support OAuth Client Credentials Grant [HEAD-873] Jan 2, 2024
@PeterSchafer PeterSchafer merged commit 63b7378 into master Jan 2, 2024
14 checks passed
@PeterSchafer PeterSchafer deleted the feat/HEAD-873_client_creds_grant branch January 2, 2024 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants