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] PulsarCtl 1266 Oauth2 Client credentials flow use scopes from the keyfile as well #1244

Conversation

Nikolajls
Copy link
Contributor

@Nikolajls Nikolajls commented Jul 11, 2024

(If this PR fixes a github issue, please add Fixes #<xyz>.)

Fixes streamnative/pulsarctl#1266 which uses the code being touched here.

Motivation

As the issue shows when using Pulsarctl which works with a context as configuration style, Oauth2 is used under the hood.

However the library does not expose any way to inject the context configuration scope value, and then relies on reading that from the keyFile for client_credentials flow.

However that is not being utilized in the current code as the scope value is not read from from the file.

Explain here the context, and why you're making that change. What is the problem you're trying to solve.
To allow the usage of oauth2 with a keyfile in Pulsarctl 3+ which it doesn't right now

Modifications

Describe the modifications you've done.

Alters so reading the keyFile for client credentials also returns the scope value.

The value is then split on spaces, and added to a temporary slice.
After that the value of any additionalScopes that was already in the options is then added to the temp slice as well.
In the end the additionalScopes property on the options is set to the temp slice containing values from previous additionalScopes and the ones from the keyFile.

Verifying this change

  • Make sure that the change passes the CI checks.

(Please pick either of the following options)

This change is a trivial rework / code cleanup without any test coverage.

(or)

This change is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

  • Added integration tests for end-to-end deployment with large payloads (10MB)
  • Extended integration test for recovery after broker failure

Does this pull request potentially affect one of the following parts:

If yes was chosen, please highlight the changes

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API: (yes / no)
  • The schema: (yes / no / don't know)
  • The default values of configurations: (yes / no)
  • The wire protocol: (yes / no)

Documentation

  • Does this pull request introduce a new feature? (yes / no)
  • If yes, how is the feature documented? (not applicable / docs / GoDocs / not documented)
  • If a feature is not applicable for documentation, explain why?
  • If a feature is not documented yet in this PR, please create a followup issue for adding the documentation

@Nikolajls Nikolajls force-pushed the nikolajls/oauth2_credentialflow_support_scopes branch from 3c580bd to b222f0a Compare July 22, 2024 11:15
By doing this it will b don for all the Authorizations done on the ClietnCredentialsFlow, earlier it would only happen for those created by the method NewDefaultClientCredentialsFlow and not newClientCredentialsFlow
@Nikolajls
Copy link
Contributor Author

@RobertIndie Just pushed a commit that should fix the linting issue, and thank you!

@RobertIndie
Copy link
Member

@RobertIndie Just pushed a commit that should fix the linting issue, and thank you!

@Nikolajls There are still lint issues. BTW, you can run make lint to check for lint issues locally.

@Nikolajls
Copy link
Contributor Author

Nikolajls commented Jul 23, 2024

@RobertIndie Just pushed a commit that should fix the linting issue, and thank you!

@Nikolajls There are still lint issues. BTW, you can run make lint to check for lint issues locally.

Im on a windows machine which makes the tooling a lot harder to replicate,

I've tried installing the golintci-cli in WSL and currently in the process of that.

I'll try the make lint in WSL instead now :)
Which also failed
image

@Nikolajls
Copy link
Contributor Author

@RobertIndie

So the linting succeeded this time.

Do you know what the process is when this is merged in on how the updated go package is applied to the Pulsarctl repo that has the issue I'm trying to solve?

@RobertIndie RobertIndie merged commit c3b0633 into apache:master Jul 24, 2024
9 checks passed
@RobertIndie
Copy link
Member

@RobertIndie

So the linting succeeded this time.

Do you know what the process is when this is merged in on how the updated go package is applied to the Pulsarctl repo that has the issue I'm trying to solve?

I'm planning to release 0.13.1 next week which will contain this fix. And I'm handling the go client package upgrade for the pulsarctl.

RobertIndie pushed a commit that referenced this pull request Jul 24, 2024
…ell (#1244)

### Motivation

As the issue shows when using Pulsarctl which works with a context as configuration style, Oauth2 is used under the hood.

However the library does not expose any way to inject the context configuration `scope` value, and then relies on reading that from the `keyFile` for `client_credentials flow`.

However that is not being utilized in the current code as the scope value is not read from from the file.

*Explain here the context, and why you're making that change. What is the problem you're trying to solve.*
To allow the usage of oauth2 with a keyfile in Pulsarctl 3+ which it doesn't right now

### Modifications
Alters so reading the keyFile for client credentials also returns the `scope` value.

The value is then split on spaces, and added to a temporary slice.
After that the value of any additionalScopes that was already in the options is then added to the temp slice as well.
In the end the additionalScopes property on the options is set to the temp slice containing values from previous additionalScopes and the ones from the keyFile.

(cherry picked from commit c3b0633)
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.

[bug]: pulsarctl 3.1 branch can't work with client credentials error
2 participants