Update b2c and multi-tenant docs for pydantic v2 #154

nikstuckenbrock · 2023-10-12T07:42:57Z

As mentioned in #150 I've updated the docs for multi-tenant and b2c according to pydantic v2.

I would appreciate if you could add the HACKTOBERFEST-ACCEPTED label to the pull request.

- Better description in pyproject.toml

…ect.

Request user attached to the request

- Add a testcase for when an evil token is provided, but with the correct `kid`.

Signature loop improvement

…quires the user to do some more configuration, but makes dependencies easier to make without circular imports - Add documentation and examples on how to do role checking - `AzureAuthorizationCodeBearer` now returns a User object - Add docs on how to load provider config on startup

- Add URL to image in README, for PyPI

v2: Remove `app` parameter from AzureAuthorizationCodeBearer, dependency now returns a User object

Make `upn` optional to support Client Credential Flow

…dd multi-tenant support. **Multi-tenant support:** - Support for multi-tenant applications - Takes a coroutine to fetch valid `iss` for given `tid` **Single-tenant features:** - Support for v2 tokens for single-tenant applications - User object is reworked, and now also contains the access_token for easier Azure Graph implementation **Removal:** - `allow_guest_users` setting is removed. This can be done in Azure AD instead. (Also removal of `GuestUserException`) **Other:** - Add SECURITY.md - Relax aiohttp requirement - Move `InvalidAuth` to `exceptions.py` - Add role check example in demo project - Add `iss` fetcher example in demo project - No longer inheriting `OAuth2AuthorizationCodeBearer`, solving mypy errors. - Rename `provider_config.py` to `openid_config.py` and `ProviderConfig()` to `OpenIdConfig()` - Removal of pre-instance of `provider_config` due to OpenAPI authorization URL issues. This is now instanced on `SingleTenantAzureAuthorizationCodeBearer` or `MultiTenantAzureAuthorizationCodeBearer`. **Tests:** - 100% codecov for v1 and v2 single-tenant applications - 99% codecov for openid_config **TODO:** - Documentation needs full rewrite - Tests for multi-tenant - Test for `openid_config` `app_id`

…y()` (instead of `Depends()`) - Fix missing `Authorize` button in OpenAPI documentation - Add tests for OpenAPI documentation, so this won't happen again.

- Add single-tenant tests for multi-tenant

…sas inheritance for the different app types

- Add test for validate_iss=False

* fix version comparison in skip condition * openapi_version based on fastapi version * add test to validate openapi spec * Make the generated openapi spec 3.1 compliant - Fix two operation that had the same operation id - Make the security scheme follow the pattern ^[a-zA-Z0-9._-]+$ * only test schema for version 2 of pydantic --------- Co-authored-by: Émile Nadeau <emile.nadeau@ruv.is>

…ity#145) * fix: make and optional to allow User validation in B2C * fix: adjust testing the openapi schema with optional tid and oid claims

…ty#146) * move openapi-spec-validator and pydantic-settings to dev deps * version bump

Co-authored-by: Jonas Krüger Svensson <jonas-ks@hotmail.com>

… have upgraded by now :)

Bumps [actions/cache](https://github.com/actions/cache) from 3.3.1 to 3.3.2. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@v3.3.1...v3.3.2) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

martimors · 2023-10-12T08:24:48Z

docs/docs/b2c/fastapi_configuration.mdx



 class Settings(BaseSettings):
-    BACKEND_CORS_ORIGINS: list[Union[str, AnyHttpUrl]] = ['http://localhost:8000']
+    BACKEND_CORS_ORIGINS: list[str | AnyHttpUrl] = ['http://localhost:8000']
    TENANT_NAME: str = Field(default='', env='TENANT_NAME')


Nit, and probably out of scope too, but TENANT_NAME: str = Field(default='', env='TENANT_NAME') here could be just TENANT_NAME: str = ''

Same for all of the other uses of ´Field` too

Thanks, I still haven't been able to test out Pydanticv2 since the release candidates. Any nitpicking is good, I'd love to have it up2date.

I'll update this as mentioned.

JonasKs · 2023-10-12T08:27:57Z

Thanks @nikstuckenbrock, I've added the label. 😊

JonasKs · 2023-10-12T08:31:39Z

Could you please have a look at #106 (comment)? Would love to ensure this is added to all the docs as well.

nikstuckenbrock · 2023-10-12T09:24:08Z

Implemented the annotations from @dingobar. @JonasKs I would personally split #106 and this into two PRs. I've also tried to optimize the solution provided in #106. Thanks for the fast feedback!

martimors

For what it's worth, LGTM 🚀

nikstuckenbrock · 2023-10-16T07:04:28Z

Please have a look at #158 .

JonasKs and others added 30 commits August 14, 2021 19:44

- Fix broken URL in README.md

03130cf

- Better description in pyproject.toml

Add user object to the request. Dependency now also return a user obj…

7fcace8

…ect.

Add codecov.yml

33e4427

Rename unparsed_token to claims

bafd4fa

Versionbump 1.1.0, revert return back to token

ec70e05

Add py.typed. Closes Intility#9

23e9dcb

Add docs

fd2d48c

Merge pull request Intility#8 from Intility/request_user

33d2e43

Request user attached to the request

- Improve how key to validate token is chosen, based on kid.

bc27616

- Add a testcase for when an evil token is provided, but with the correct `kid`.

Rework signing key logic to use a mapping instead.

158885a

Versionbump 1.1.1

2c2f3b8

Add test for refresh of provider (OpenID) config

3619255

Remove TypedDict, no longer used

af8ac45

Merge pull request Intility#10 from Intility/improve_signature_loop

6ab060b

Signature loop improvement

- v2.0.0 bump

9eb1867

- Add URL to image in README, for PyPI

Add coverage to also work for pull requests

18c3257

Merge pull request Intility#11 from Intility/remove_app_from_init

146de7d

v2: Remove `app` parameter from AzureAuthorizationCodeBearer, dependency now returns a User object

Fix formatting in README.md

649146c

Make upn optional to support Client Credential Flow

abf8193

Merge pull request Intility#12 from Intility/support_claims_without_upn

c8957bb

Make `upn` optional to support Client Credential Flow

Create codeql-analysis.yml

d1c30b9

Fix broken image URL

a47ce46

Merge branch 'main' into multi_tenant_rewrite

a4627ed

Add README.md for tests folder, explaining setup.

ce71956

- Add support for denying requests with wrong scopes, when `Securit…

7574710

…y()` (instead of `Depends()`) - Fix missing `Authorize` button in OpenAPI documentation - Add tests for OpenAPI documentation, so this won't happen again.

- Rework test structure

afe01ba

- Add single-tenant tests for multi-tenant

Add tests for settings. Remove unnessescary checks now that we use cl…

ba7a013

…sas inheritance for the different app types

- Add test for iss_callable raising exception

114b9a7

- Add test for validate_iss=False

enadeau and others added 16 commits July 31, 2023 12:20

fix: make tid and oid optional to allow User validation in B2C (Intil…

bd5d0a0

…ity#145) * fix: make and optional to allow User validation in B2C * fix: adjust testing the openapi schema with optional tid and oid claims

chore: version bump

9b8c65b

move openapi-spec-validator and pydantic-settings to dev deps (Intili…

83fded6

…ty#146) * move openapi-spec-validator and pydantic-settings to dev deps * version bump

doc: add B2C user docs

5b0dec9

doc: update B2CMultiTenantAuthorizationCodeBearer parameters

62ffb7c

doc: fix AUTH_POLICY_NAME value to be empty

e88c0ec

Co-authored-by: Jonas Krüger Svensson <jonas-ks@hotmail.com>

docs: rewrite single-tenant docs to be pydantic2 first

e897283

chore: bump pipeline versions

8265735

chore: update pre-commit

30114e3

chore: remove useless pre-commit hook

dde78d6

chore: remove old FastAPI versions from test pipelines, people should…

a757125

… have upgraded by now :)

Update b2c and multi-tenant docs for pydantic v2

3b15d35

Update code highlighting

98f4680

martimors reviewed Oct 12, 2023

View reviewed changes

JonasKs added the HACKTOBERFEST-ACCEPTED label Oct 12, 2023

Use implicit default value and env variable name

83b611f

nikstuckenbrock mentioned this pull request Oct 12, 2023

Scopes missing in /docs at each endpoint padlock #106

Closed

nikstuckenbrock requested review from JonasKs and martimors October 12, 2023 09:34

martimors approved these changes Oct 12, 2023

View reviewed changes

nikstuckenbrock force-pushed the migrate-multi-tenant-and-b2c-docs branch from 8aa495f to 83b611f Compare October 16, 2023 06:49

nikstuckenbrock mentioned this pull request Oct 16, 2023

Update documentation #158

Closed

nikstuckenbrock closed this Oct 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update b2c and multi-tenant docs for pydantic v2 #154

Update b2c and multi-tenant docs for pydantic v2 #154

nikstuckenbrock commented Oct 12, 2023

martimors Oct 12, 2023 •

edited

Loading

martimors Oct 12, 2023 •

edited

Loading

JonasKs Oct 12, 2023

nikstuckenbrock Oct 12, 2023

JonasKs commented Oct 12, 2023

JonasKs commented Oct 12, 2023 •

edited

Loading

nikstuckenbrock commented Oct 12, 2023

martimors left a comment

nikstuckenbrock commented Oct 16, 2023

Update b2c and multi-tenant docs for pydantic v2 #154

Update b2c and multi-tenant docs for pydantic v2 #154

Conversation

nikstuckenbrock commented Oct 12, 2023

martimors Oct 12, 2023 • edited Loading

Choose a reason for hiding this comment

martimors Oct 12, 2023 • edited Loading

Choose a reason for hiding this comment

JonasKs Oct 12, 2023

Choose a reason for hiding this comment

nikstuckenbrock Oct 12, 2023

Choose a reason for hiding this comment

JonasKs commented Oct 12, 2023

JonasKs commented Oct 12, 2023 • edited Loading

nikstuckenbrock commented Oct 12, 2023

martimors left a comment

Choose a reason for hiding this comment

nikstuckenbrock commented Oct 16, 2023

martimors Oct 12, 2023 •

edited

Loading

martimors Oct 12, 2023 •

edited

Loading

JonasKs commented Oct 12, 2023 •

edited

Loading