diff --git a/README.rst b/README.rst deleted file mode 120000 index cffceba7c58191d8215f5d98a17575ef3a50bc06..0000000000000000000000000000000000000000 --- a/README.rst +++ /dev/null @@ -1 +0,0 @@ -docs/README.rst \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..4bd3d2ce313872abd4f281d083ee0c7b7647295a --- /dev/null +++ b/README.rst @@ -0,0 +1,33 @@ +Software Heritage - Authentication +================================== + +``swh-auth`` is a set of utility libraries related to user authentication +in applications and services based on the use of `Keycloak`_ and `OpenID Connect`_. + +`Keycloak`_ is an open source software enabling single sign-on (SSO) with identity +and access management. + +`OpenID Connect`_ (OIDC) is an authentication layer on top of `OAuth 2.0`_, widely +used in modern web applications and services. + +``swh-auth`` notably offers the following features: + +- the ``swh.auth.keycloak.KeycloakOpenIDConnect`` class to ease the + interaction with a Keycloak server + +- a ``pytest`` plugin with the ``keycloak_oidc`` fixture to mock Keycloak + responses in unit tests + +- generic backends, views and middlewares to easily plug OpenID Connect authentication + in any `Django`_ or `Django REST framework`_ application + + +.. _Keycloak: https://www.keycloak.org/ + +.. _OpenID Connect: https://openid.net/connect/ + +.. _OAuth 2.0: https://oauth.net/2/ + +.. _Django: https://www.djangoproject.com/ + +.. _Django REST framework: https://www.django-rest-framework.org/ \ No newline at end of file diff --git a/docs/README.rst b/docs/README.rst deleted file mode 100644 index 4bd3d2ce313872abd4f281d083ee0c7b7647295a..0000000000000000000000000000000000000000 --- a/docs/README.rst +++ /dev/null @@ -1,33 +0,0 @@ -Software Heritage - Authentication -================================== - -``swh-auth`` is a set of utility libraries related to user authentication -in applications and services based on the use of `Keycloak`_ and `OpenID Connect`_. - -`Keycloak`_ is an open source software enabling single sign-on (SSO) with identity -and access management. - -`OpenID Connect`_ (OIDC) is an authentication layer on top of `OAuth 2.0`_, widely -used in modern web applications and services. - -``swh-auth`` notably offers the following features: - -- the ``swh.auth.keycloak.KeycloakOpenIDConnect`` class to ease the - interaction with a Keycloak server - -- a ``pytest`` plugin with the ``keycloak_oidc`` fixture to mock Keycloak - responses in unit tests - -- generic backends, views and middlewares to easily plug OpenID Connect authentication - in any `Django`_ or `Django REST framework`_ application - - -.. _Keycloak: https://www.keycloak.org/ - -.. _OpenID Connect: https://openid.net/connect/ - -.. _OAuth 2.0: https://oauth.net/2/ - -.. _Django: https://www.djangoproject.com/ - -.. _Django REST framework: https://www.django-rest-framework.org/ \ No newline at end of file diff --git a/docs/README.rst b/docs/README.rst new file mode 120000 index 0000000000000000000000000000000000000000..89a0106941ff398844f23a965c5b755ca12eef97 --- /dev/null +++ b/docs/README.rst @@ -0,0 +1 @@ +../README.rst \ No newline at end of file