Infrastructure/arc
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

fix parsing errors and sphinx warnings

Browse source 
Signed-off-by: Ryan Lerch <rlerch@redhat.com>
This commit is contained in:
Ryan Lercho 2023-11-16 08:02:56 +10:00 • committed by zlopez
parent 8fb9b2fdf0
commit ba720c3d77
98 changed files with 4799 additions and 4788 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/flask-oidc/authlib_code.rst
View file

@ -1,22 +1,21 @@
Authlib
=========
=======
Discussion
----------
Authlib implementation for Flask. Flask-oidc uses ouath2client to create a flow
based on client secrets using this function `client.flow_from_clientsecrets https://oauth2client.readthedocs.io/en/latest/source/oauth2client.client.html#oauth2client.client.flow_from_clientsecrets`_.
to create an ouath2 webserver flow which validates based on oidc tokens.
This needs to be replaced using a new library.
Authlib implementation for Flask. Flask-oidc uses ouath2client to create a flow based on
client secrets using this function `client.flow_from_clientsecrets
<https://oauth2client.readthedocs.io/en/latest/source/oauth2client.client.html#oauth2client.client.flow_from_clientsecrets>`_.
to create an ouath2 webserver flow which validates based on oidc tokens. This needs to
be replaced using a new library.
Authlib
-------
Authlib has the functionality to follow this flow and use oidc on top of oauth2
functionality https://docs.authlib.org/en/latest/client/oauth2.html#oauth-2-openid-connect
functionality
https://docs.authlib.org/en/latest/client/oauth2.html#oauth-2-openid-connect
Conclusion
----------
Authlib provides the necessary tooling to do this replacement which shows it as
suitable for a replacement
Authlib provides the necessary tooling to do this replacement which shows it as suitable
for a replacement

22
docs/flask-oidc/index.rst
View file

@ -4,16 +4,17 @@ Flask-oidc
Purpose
-------
Flask-oidc is a library used across the Fedora infrastructure. For its
authentication it the oauth2client library is used. This is now deprecated and
no longer maintained. This will need to be replaced.
Flask-oidc is a library used across the Fedora infrastructure. For its authentication it
the oauth2client library is used. This is now deprecated and no longer maintained. This
will need to be replaced.
Resources
---------
* Flask-oidc code: https://github.com/puiterwijk/flask-oidc
* Bodhi implementation: https://github.com/fedora-infra/bodhi/tree/develop/bodhi-server/bodhi/server/auth
* Authlib docs: https://docs.authlib.org/en/latest/basic/index.html
- Flask-oidc code: https://github.com/puiterwijk/flask-oidc
- Bodhi implementation:
https://github.com/fedora-infra/bodhi/tree/develop/bodhi-server/bodhi/server/auth
- Authlib docs: https://docs.authlib.org/en/latest/basic/index.html
Investigation
-------------
@ -26,7 +27,6 @@ Here is the list of ideas/things we discussed/looked at:
oauthlib_authlib
authlib_code
Conclusions
-----------
@ -34,11 +34,9 @@ Authlib is the new industry standard and looks to be a suitable replacement for
oauth2client. The flask-oidc code would need to be rewritten to replace all the
oauth2client code.
The flow of the code would need to be adjusted to work with the new library.
Google-auth and authlib were looked at for this investigation and it was
suggested that authlib looks a better replacemnt.
The flow of the code would need to be adjusted to work with the new library. Google-auth
and authlib were looked at for this investigation and it was suggested that authlib
looks a better replacemnt.
Proposed Roadmap
----------------

24
docs/flask-oidc/oauthlib_authlib.rst
View file

@ -4,23 +4,23 @@ Oauthlib vs Authlib
Resources
---------
* Oauthlib: https://oauthlib.readthedocs.io/en/latest/
* Authlib: https://docs.authlib.org/en/latest/
- Oauthlib: https://oauthlib.readthedocs.io/en/latest/
- Authlib: https://docs.authlib.org/en/latest/
Discussion
----------
Which library should be used to replace the currently used and deprecated
oauth2client. The two main contenders are Oauthlib and Authlib.
Authlib is the more popular of the two choices as seen in this `graph https://python.libhunt.com/compare-authlib-vs-oauthlib`_.
For flask the oauthlib developers themselves recommend using authilib
Which library should be used to replace the currently used and deprecated oauth2client.
The two main contenders are Oauthlib and Authlib.
Authlib is the more popular of the two choices as seen in this `graph
<https://python.libhunt.com/compare-authlib-vs-oauthlib>`_. For flask the oauthlib
developers themselves recommend using authilib
https://github.com/lepture/flask-oauthlib#readme
Conclusion
----------
Authlib seems to be the best candidate for this initiative. There is knowledge
in the team of the library as it was used in bodhi. It also appears to have an
easier to implement and has a flask integration and is recommended for use by
the developer.
Authlib seems to be the best candidate for this initiative. There is knowledge in the
team of the library as it was used in bodhi. It also appears to have an easier to
implement and has a flask integration and is recommended for use by the developer.