feat: oauth2 client credentials #468

felicijus · 2024-08-14T08:53:30Z

Provides a way to Authenticate with Oauth2Session for 0Auth2 Client Credentials (and possibility to adopt other Flows) via AuthMetadataPlugin (OAuth2MetadataPlugin) tailored to oauthlib and requests_oauthlib.

Provides posibility to adapt to non RFC 6749 compliant Authentification Server.

Changes

OAuth2MetadataPlugin (Class to be able Authenticate with any Authorization flow provided by oauthlib package
OAuth2 Client Credentials (specific Implementation with oauthlib package for Client Credential Flow)
New create channel functions for create_camunda_cloud_channel and
create_oauth2_client_credentials_channel
Use given expires_in attribute in Token to reauthenticate after expiration (overridable, configurable if not given)

API Updates

New Features (required)

private APIs

OAuth2MetadataPlugin
Oauth2ClientCredentialsMetadataPlugin (Specializationof OAuth2MetadataPlugin)

public APIs

create_camunda_cloud_channel
create_oauth2_client_credentials_channel

Deprecations (required)

The other way to create_camunda_cloud_channel (channel/camunda_cloud_channel.py) could be deleted.

Enhancements (optional)

More configurable way to handle Authentification for pyzeebe grpc channel.

Checklist

Unit tests
Documentation

References

https://datatracker.ietf.org/doc/html/rfc6749
https://oauthlib.readthedocs.io/en/latest/oauth2/clients/client.html
https://requests-oauthlib.readthedocs.io/en/latest/oauth2_workflow.html

CLAassistant · 2024-08-14T08:53:36Z

All committers have signed the CLA.

pyzeebe/channel/__init__.py

dimastbk · 2024-08-19T04:59:22Z

Hi. Do you want to replace #412?

pyzeebe/credentials/oauth.py

pyzeebe/channel/oauth_channel.py

This commit adds a new function `create_oauth2_client_credentials_channel` to the `pyzeebe.channel` module. This function allows the creation of a channel connected to a Camunda Cloud cluster using OAuth2 client credentials for authentication. The function takes various parameters such as the target address, client ID, client secret, authorization server, scope, audience, and expiration time. It returns a GRPC channel connected to the Zeebe Gateway. The new function is added in the `pyzeebe.channel.oauth_channel` module, which is imported in the `pyzeebe.channel.__init__` module. This change is necessary to provide support for authenticating with Camunda Cloud using OAuth2 client credentials. Co-authored-by: dependabot[bot] <[email protected]>

This commit adds a new function `create_oauth2_client_credentials_channel` to the `pyzeebe.channel.oauth_channel` module. The function allows the creation of a channel connected to a Camunda Cloud cluster using OAuth2 client credentials for authentication. It takes various parameters such as the target address, client ID, client secret, authorization server, scope, audience, and expiration time. The function returns a GRPC channel connected to the Zeebe Gateway. This change is necessary to provide support for authenticating with Camunda Cloud using OAuth2 client credentials.

…d Channel Based on Oauth2ClientCredentialsMetadataPlugin and a general OAuth2MetadataPlugin to support Oauth2Sessions

This commit refactors the `create_oauth2_client_credentials_channel` function in the `pyzeebe.channel.oauth_channel` module. The function is responsible for creating a channel connected to a Camunda Cloud cluster using OAuth2 client credentials for authentication. It takes various parameters such as the target address, client ID, client secret, authorization server, scope, audience, and expiration time. The function returns a GRPC channel connected to the Zeebe Gateway. The refactoring improves the code structure and readability of the function, making it easier to maintain and understand. This change is necessary to provide support for authenticating with Camunda Cloud using OAuth2 client credentials. Co-authored-by: dependabot[bot] <[email protected]>

felicijus · 2024-08-21T07:36:23Z

I think the changes are now all implemented as you wished @dimastbk.
I needed to change the commit author therefore the force pushes.

pyzeebe/channel/__init__.py

pyzeebe/credentials/oauth.py

felicijus · 2024-08-22T23:46:03Z

How should we handle the mypy errors @dimastbk ?

I would suggest doing it with inline ignore statement # type: ignore.

pyzeebe/credentials/oauth.py:10: error: Skipping analyzing "grpc._auth": module is installed, but missing library stubs or py.typed marker  [import-untyped]
pyzeebe/credentials/oauth.py:17: error: Class cannot subclass "AuthMetadataPlugin" (has type "Any")  [misc]
pyzeebe/channel/oauth_channel.py:[5](https://github.com/camunda-community-hub/pyzeebe/actions/runs/10503175124/job/29127825861?pr=468#step:6:6): error: Skipping analyzing "grpc.aio._typing": module is installed, but missing library stubs or py.typed marker  [import-untyped]
pyzeebe/channel/oauth_channel.py:5: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
Found 3 errors in 2 files (checked 52 source files)
Error: Process completed with exit code 1.

This commit fixes the type hint import error by ignoring the untyped import. This change is necessary to ensure the code passes linting without any errors. Co-authored-by: dependabot[bot] <[email protected]>

pyzeebe/channel/oauth_channel.py

pyzeebe/credentials/oauth.py

pyzeebe/channel/oauth_channel.py

pyzeebe/channel/__init__.py

dimastbk

Sorry, I've been on vacation for the last two weeks.

pyzeebe/channel/camunda_cloud_channel.py

pyzeebe/channel/channel_options.py

pyzeebe/channel/oauth_channel.py

docs/credentials.rst

pyzeebe/credentials/oauth.py

…-credentials

coveralls · 2024-09-30T07:37:52Z

Pull Request Test Coverage Report for Build 11191422489

Details

90 of 90 (100.0%) changed or added relevant lines in 5 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.3%) to 96.883%

Totals
Change from base Build 11130949290:	0.3%
Covered Lines:	1088
Relevant Lines:	1123

💛 - Coveralls

felicijus · 2024-09-30T07:43:14Z

Got some time now.
I will create a pull request regarding the grpcAddress (java zeebe) or target.
So naming could be:

grpc_address (favourite)
target

And then finish up this pull request.

Coverage should be fine, i think ✅

pyzeebe/credentials/oauth.py

docs/channels.rst

pyzeebe/channel/oauth_channel.py

Co-authored-by: Dmitriy <[email protected]>

dimastbk · 2024-10-05T15:20:50Z

Thanks

felicijus changed the title ~~Feature/oauth client credentials~~ feat: oauth client credentials Aug 14, 2024

felicijus marked this pull request as draft August 14, 2024 16:22

felicijus commented Aug 17, 2024

View reviewed changes

pyzeebe/channel/__init__.py Outdated Show resolved Hide resolved

dimastbk reviewed Aug 19, 2024

View reviewed changes

pyzeebe/credentials/oauth.py Outdated Show resolved Hide resolved

pyzeebe/channel/oauth_channel.py Show resolved Hide resolved

felicijus force-pushed the feature/oauth-client-credentials branch from 91f9b26 to cf55cff Compare August 21, 2024 07:24

felicijus and others added 4 commits August 21, 2024 09:34

feat: Add OAuth2 client credentials channel creation and Camunda Clou…

01cbd5c

…d Channel Based on Oauth2ClientCredentialsMetadataPlugin and a general OAuth2MetadataPlugin to support Oauth2Sessions

felicijus force-pushed the feature/oauth-client-credentials branch from cf55cff to 07140cf Compare August 21, 2024 07:34

felicijus commented Aug 21, 2024

View reviewed changes

pyzeebe/channel/__init__.py Outdated Show resolved Hide resolved

felicijus commented Aug 21, 2024

View reviewed changes

pyzeebe/credentials/oauth.py Outdated Show resolved Hide resolved

felicijus and others added 2 commits August 22, 2024 08:35

fix: remove import from collections.abc, use typing

302d46d

Merge branch 'master' into feature/oauth-client-credentials

e7a09b8

fix: Update imports in oauth_channel and oauth module

8414390

This commit fixes the type hint import error by ignoring the untyped import. This change is necessary to ensure the code passes linting without any errors. Co-authored-by: dependabot[bot] <[email protected]>

felicijus marked this pull request as ready for review August 24, 2024 05:08

Merge branch 'master' into feature/oauth-client-credentials

7944732

dimastbk reviewed Aug 26, 2024

View reviewed changes

felicijus and others added 2 commits September 4, 2024 19:37

Merge branch 'master' into feature/oauth-client-credentials

4ae4389

feat: refractor channel_options, add documentation, style changes

2ea42e2

felicijus requested a review from dimastbk September 10, 2024 08:38

dimastbk reviewed Sep 16, 2024

View reviewed changes

Merge branch 'master' into feature/oauth-client-credentials

aadc17b

felicijus mentioned this pull request Sep 18, 2024

Change grpc options (channel_arguments) from dict to tuple #482

Closed

fix: Update oauth _no_expiration and remove deprecated package

17755fb

felicijus changed the title ~~feat: oauth client credentials~~ feat: oauth2 client credentials Sep 18, 2024

felicijus and others added 3 commits September 18, 2024 23:10

Merge branch 'camunda-community-hub:master' into feature/oauth-client…

9decb7b

…-credentials

Merge branch 'master' into feature/oauth-client-credentials

e75ac7f

Merge branch 'master' into feature/oauth-client-credentials

d8c9510

felicijus mentioned this pull request Sep 30, 2024

Change channel parameter hostname, port to grpc_address #497

Closed

dimastbk mentioned this pull request Oct 1, 2024

Token renewal still broken on create_camunda_cloud_channel #498

Closed

felicijus mentioned this pull request Oct 1, 2024

feat: change channel parameter hostname, port to grpc_adress #499

Merged

3 tasks

felicijus and others added 4 commits October 1, 2024 19:15

feat: grpc_address

ab0c8b6

revert: create_insecure_channel and create_secure_channel

11f139d

Merge branch 'master' into feature/oauth-client-credentials

6e89795

docs: channel_options, default keepalive_time_ms

ecdeb2b

felicijus requested a review from dimastbk October 3, 2024 21:32

dimastbk approved these changes Oct 4, 2024

View reviewed changes

pyzeebe/credentials/oauth.py Outdated Show resolved Hide resolved

docs/channels.rst Outdated Show resolved Hide resolved

pyzeebe/channel/oauth_channel.py Outdated Show resolved Hide resolved

felicijus and others added 3 commits October 5, 2024 08:07

fix: OAuth2Error logged as exception (traceback)

e768cc5

Co-authored-by: Dmitriy <[email protected]>

style: remove comment oauth_channel.py

797688e

Co-authored-by: Dmitriy <[email protected]>

docs: link to keep alive intervals

696722a

felicijus requested a review from dimastbk October 5, 2024 07:22

dimastbk merged commit cfff667 into camunda-community-hub:master Oct 5, 2024
17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: oauth2 client credentials #468

feat: oauth2 client credentials #468

felicijus commented Aug 14, 2024 •

edited

Loading

CLAassistant commented Aug 14, 2024 •

edited

Loading

dimastbk commented Aug 19, 2024

felicijus commented Aug 21, 2024 •

edited

Loading

felicijus commented Aug 22, 2024

dimastbk left a comment

coveralls commented Sep 30, 2024 •

edited

Loading

felicijus commented Sep 30, 2024

dimastbk commented Oct 5, 2024

feat: oauth2 client credentials #468

feat: oauth2 client credentials #468

Conversation

felicijus commented Aug 14, 2024 • edited Loading

Changes

API Updates

New Features (required)

private APIs

public APIs

Deprecations (required)

Enhancements (optional)

Checklist

References

CLAassistant commented Aug 14, 2024 • edited Loading

dimastbk commented Aug 19, 2024

felicijus commented Aug 21, 2024 • edited Loading

felicijus commented Aug 22, 2024

dimastbk left a comment

Choose a reason for hiding this comment

coveralls commented Sep 30, 2024 • edited Loading

Pull Request Test Coverage Report for Build 11191422489

Details

💛 - Coveralls

felicijus commented Sep 30, 2024

dimastbk commented Oct 5, 2024

felicijus commented Aug 14, 2024 •

edited

Loading

CLAassistant commented Aug 14, 2024 •

edited

Loading

felicijus commented Aug 21, 2024 •

edited

Loading

coveralls commented Sep 30, 2024 •

edited

Loading