Skip to content

Commit 93ff3c7

Browse files
committed
Initiate the "Features" section
1 parent 6ee6631 commit 93ff3c7

File tree

2 files changed

+44
-1
lines changed

2 files changed

+44
-1
lines changed

docs/.vitepress/config.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/references/index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Features
2+
3+
Below is the incomplete list of features that are supported by the library. Other features and samples can be found in
4+
the [tutorials](/references/tutorials) section.
5+
6+
## Several providers
7+
8+
The library leverages the [social-core](https://github.com/python-social-auth/social-core)
9+
authentication [backends](https://github.com/python-social-auth/social-core/tree/master/social_core/backends), which
10+
means it supports all the providers that are supported by it. However, if the provider you are interested in does not
11+
exist in the list, you can add one by following
12+
the [documentation](https://python-social-auth.readthedocs.io/en/latest/backends/implementation.html).
13+
14+
## SSR & REST APIs
15+
16+
::: tip Ticket #19
17+
18+
This upcoming feature is under development and will be available in the next release. You can track the progress in
19+
the [#19](https://github.com/pysnippet/fastapi-oauth2/issues/19) issue.
20+
21+
:::
22+
23+
## CSRF protection
24+
25+
CSRF protection is enabled by default which means when the user opens the `/oauth2/{provider}/auth` endpoint it
26+
redirects to the authorization endpoint of the IDP with an autogenerated `state` parameter and saves it in the session
27+
storage. After authorization, when the `/oauth2/{provider}/token` callback endpoint gets called with the
28+
provided `state`, the `oauthlib` validates it and then redirects to the `redirect_uri`.
29+
30+
## PKCE support
31+
32+
::: tip Ticket #18
33+
34+
PKCE support is under development and will be available in the next release. You can track the progress in
35+
the [#18](https://github.com/pysnippet/fastapi-oauth2/issues/18) issue.
36+
37+
:::
38+
39+
<style>
40+
.tip {
41+
border: 0;
42+
}
43+
</style>

0 commit comments

Comments
 (0)