feat: add new backend `BitbucketDataCenterOAuth2` and `BaseOAuth2PKCE` #856

eshaan7 · 2023-11-09T11:16:13Z

Proposed changes

Resolves #855.
Related social-docs PR: python-social-auth/social-docs#190

Adds a new backend BitbucketDataCenterOAuth2.
Generalizes the PKCE logic in a base class BaseOAuth2PKCE and re-used in both TwitterOAuth2 and BitbucketDataCenterOAuth2.
Generalizes the PKCE unit-tests logic in base classes OAuth2PkcePlainTest and OAuth2PkceS256Test and re-used in both test_twitter_oauth2.py and test_bitbucket_datacenter.py

Types of changes

Please check the type of change your PR introduces:

Release (new release request)
Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Code style update (PEP8, lint, formatting, renaming, etc)
Refactoring (no functional changes, no api changes)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Build related changes (build process, tests runner, etc)
Other (please describe):

Checklist

Put an x in the boxes that apply. You can also fill these out after creating
the PR. If you're unsure about any of them, don't hesitate to ask. We're here to
help! This is simply a reminder of what we are going to look for before merging
your code.

Lint and unit tests pass locally with my changes
I have added tests that prove my fix is effective or that my feature works
I have added documentation to https://github.com/python-social-auth/social-docs

Other information

Any other information that is important to this PR such as screenshots of how
the component looks before and after the change.

nijel · 2023-11-09T11:22:40Z

Abstracting that sounds like a good idea. Please also add tests and documentation.

codecov · 2023-11-09T11:24:37Z

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (a670659) 77.34% compared to head (9799025) 77.58%.

Files	Patch %	Lines
social_core/backends/oauth.py	95.12%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #856      +/-   ##
==========================================
+ Coverage   77.34%   77.58%   +0.24%     
==========================================
  Files         341      343       +2     
  Lines       10413    10525     +112     
  Branches      699      700       +1     
==========================================
+ Hits         8054     8166     +112     
  Misses       2201     2201              
  Partials      158      158

Flag	Coverage Δ
unittests	`77.58% <98.91%> (+0.24%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…auth2

…ps://github.com/eshaan7/social-core into feature/new-backend/bitbucket-datacenter-oauth2

for more information, see https://pre-commit.ci

This add a generic backend based in ConfigurableOpenIdConnectAuth but with PKCE. This backend is inspired in the social-core way to implement PKCE. There is a current PR in working, but for the moment, that class is not merged and accesible. So after that is finished this has it code for `code_challenge` and `code_challenge_method`implementation. PR: python-social-auth/social-core#856

…bucket-datacenter-oauth2

for more information, see https://pre-commit.ci

…ps://github.com/eshaan7/social-core into feature/new-backend/bitbucket-datacenter-oauth2

eshaan7 · 2023-11-21T10:24:31Z

@nijel;

Can I get a review on this now? I have added complete tests along with refactoring the existing PKCE ones. Just docs pending, will do it later.

nijel

Thanks, looks good now. I think we can merge this once the docs is ready as well.

social_core/tests/backends/test_twitter_oauth2.py

eshaan7 · 2023-11-21T13:26:08Z

@nijel; pushed some smaller changes addressing the review and made USE_PKCE a configurable setting for Bitbucket Data Center since it supports both with and without.

Also, docs PR is up at: python-social-auth/social-docs#190

johanseto

Add some style suggestions

social_core/backends/oauth.py

* feat: add pkce-openid-backend This adds a generic backend based on ConfigurableOpenIdConnectAuth but with PKCE. This backend is inspired in the social-core way to implement PKCE. There is a current PR in work, but for the moment, that class is not merged and accessible. So after that is finished this has it code for `code_challenge` and `code_challenge_method`implementation. PR: python-social-auth/social-core#856 * refactor: avoid repeated pkce conf definition * feat: update with small changes social_core * refactor: suggestions from code review Co-authored-by: Omar Al-Ithawi @ NELC <134635705+omar-nelc@users.noreply.github.com> Co-authored-by: Andrey Cañon <andrey.canon@edunext.co>

Co-authored-by: Johan Castiblanco <51926076+johanv26@users.noreply.github.com>

eshaan7 · 2023-11-22T09:21:18Z

@nijel; Let's merge this :D

nijel · 2023-11-22T15:35:02Z

Merged, thanks for your contribution!

* feat: add pkce-openid-backend This adds a generic backend based on ConfigurableOpenIdConnectAuth but with PKCE. This backend is inspired in the social-core way to implement PKCE. There is a current PR in work, but for the moment, that class is not merged and accessible. So after that is finished this has it code for `code_challenge` and `code_challenge_method`implementation. PR: python-social-auth/social-core#856 * refactor: avoid repeated pkce conf definition * feat: update with small changes social_core * refactor: suggestions from code review Co-authored-by: Omar Al-Ithawi @ NELC <134635705+omar-nelc@users.noreply.github.com> Co-authored-by: Andrey Cañon <andrey.canon@edunext.co>

This adds a generic backend based on ConfigurableOpenIdConnectAuth but with PKCE. This backend is inspired in the social-core way to implement PKCE. There is a current PR in work, but for the moment, that class is not merged and accessible. So after that is finished this has it code for `code_challenge` and `code_challenge_method`implementation. PR: python-social-auth/social-core#856 Co-authored-by: Omar Al-Ithawi @ NELC <134635705+omar-nelc@users.noreply.github.com> Co-authored-by: Andrey Cañon <andrey.canon@edunext.co>

eshaan7 changed the title ~~feat: add new backend BitbucketDataCenterOAuth2~~ feat: add new backend BitbucketDataCenterOAuth2 Nov 9, 2023

eshaan7 and others added 7 commits November 9, 2023 17:13

feat: add new backend BitbucketDataCenterOAuth2

bfc31ef

Merge branch 'master' into feature/new-backend/bitbucket-datacenter-o…

8fba902

…auth2

abstract away PKCE logic in BaseOAuth2PKCE for reuse

a3c6546

Merge branch 'feature/new-backend/bitbucket-datacenter-oauth2' of htt…

7847b37

…ps://github.com/eshaan7/social-core into feature/new-backend/bitbucket-datacenter-oauth2

[pre-commit.ci] auto fixes from pre-commit.com hooks

7968549

for more information, see https://pre-commit.ci

abstract away PKCE logic in BaseOAuth2PKCE for reuse

2f0f895

noqa flake8 line length rule for URLs in comments

72c1d7b

johanseto mentioned this pull request Nov 17, 2023

feat: add pkce-openid-backend eduNEXT/eox-core#255

Merged

4 tasks

eshaan7 added 4 commits November 21, 2023 15:26

chore: add BitbucketDataCenterOAuth2Test

7c8bf02

chore: abstract PKCE tests in OAuth2PkcePlainTest, OAuth2PkceS256Test

7277ec3

noqa flake8 line length rule for URLs in comments

0e50d2a

Merge branch 'python-social-auth:master' into feature/new-backend/bit…

781a1e4

…bucket-datacenter-oauth2

eshaan7 marked this pull request as ready for review November 21, 2023 10:00

pre-commit-ci bot and others added 3 commits November 21, 2023 10:09

[pre-commit.ci] auto fixes from pre-commit.com hooks

676441f

for more information, see https://pre-commit.ci

chore: fix isort errors

a413849

Merge branch 'feature/new-backend/bitbucket-datacenter-oauth2' of htt…

c28b5c9

…ps://github.com/eshaan7/social-core into feature/new-backend/bitbucket-datacenter-oauth2

nijel approved these changes Nov 21, 2023

View reviewed changes

social_core/tests/backends/test_twitter_oauth2.py Outdated Show resolved Hide resolved

eshaan7 mentioned this pull request Nov 21, 2023

docs: new implementation OAuth2 with PKCE, new backend Bitbucket Data Center python-social-auth/social-docs#190

Merged

11 tasks

eshaan7 added 2 commits November 21, 2023 18:52

chore: improvements, address review suggestions

bb0dd56

fix: docs URL

a0fc1d3

johanseto reviewed Nov 21, 2023

View reviewed changes

social_core/backends/oauth.py Outdated Show resolved Hide resolved

social_core/backends/oauth.py Outdated Show resolved Hide resolved

social_core/backends/oauth.py Outdated Show resolved Hide resolved

Apply suggestions from code review

9799025

Co-authored-by: Johan Castiblanco <51926076+johanv26@users.noreply.github.com>

nijel merged commit 51ff887 into python-social-auth:master Nov 22, 2023
8 checks passed

eshaan7 deleted the feature/new-backend/bitbucket-datacenter-oauth2 branch November 23, 2023 17:15

eshaan7 changed the title ~~feat: add new backend BitbucketDataCenterOAuth2~~ feat: add new backend BitbucketDataCenterOAuth2 and BaseOAuth2PKCE Jan 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add new backend `BitbucketDataCenterOAuth2` and `BaseOAuth2PKCE` #856

feat: add new backend `BitbucketDataCenterOAuth2` and `BaseOAuth2PKCE` #856

eshaan7 commented Nov 9, 2023 •

edited

Loading

nijel commented Nov 9, 2023

codecov bot commented Nov 9, 2023 •

edited

Loading

eshaan7 commented Nov 21, 2023

nijel left a comment

eshaan7 commented Nov 21, 2023 •

edited

Loading

johanseto left a comment

eshaan7 commented Nov 22, 2023

nijel commented Nov 22, 2023

feat: add new backend BitbucketDataCenterOAuth2 and BaseOAuth2PKCE #856

feat: add new backend BitbucketDataCenterOAuth2 and BaseOAuth2PKCE #856

Conversation

eshaan7 commented Nov 9, 2023 • edited Loading

Proposed changes

Types of changes

Checklist

Other information

nijel commented Nov 9, 2023

codecov bot commented Nov 9, 2023 • edited Loading

Codecov Report

eshaan7 commented Nov 21, 2023

nijel left a comment

Choose a reason for hiding this comment

eshaan7 commented Nov 21, 2023 • edited Loading

johanseto left a comment

Choose a reason for hiding this comment

eshaan7 commented Nov 22, 2023

nijel commented Nov 22, 2023

feat: add new backend `BitbucketDataCenterOAuth2` and `BaseOAuth2PKCE` #856

feat: add new backend `BitbucketDataCenterOAuth2` and `BaseOAuth2PKCE` #856

eshaan7 commented Nov 9, 2023 •

edited

Loading

codecov bot commented Nov 9, 2023 •

edited

Loading

eshaan7 commented Nov 21, 2023 •

edited

Loading