diff --git a/README.md b/README.md index e9a2c17b..26c1da66 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,38 @@ # oidc-op -Examples of a OIDC OPs with CherryPy, Flask and Django. -**NOT** something you should even image running in a production environment. -This project are here to show you how to 'build' an OP using the -classes and functions provided by oidc-op. +This project is a Python implementation of an **OIDC Provider** on top of [jwtconnect.io](https://jwtconnect.io/) that shows to you how to 'build' an OP using the classes and functions provided by oidc-op. -If you are just going to build a standard OP you only have to write the -configuration file. If you want to add or replace functionality please read the [Official Documentation](#TODO). +If you want to add or replace functionality the official documentation should be able to tell you how. +If you are just going to build a standard OP you only have to understand how to write your configuration file. +In `example/` folder you'll find some complete examples based on flask and django. + +Idpy OIDC-op implements the following standards: + +* [OpenID Connect Core 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-core-1_0.html) +* [Web Finger](https://openid.net/specs/openid-connect-discovery-1_0.html#IssuerDiscovery) +* [OpenID Connect Discovery 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-discovery-1_0.html) +* [OpenID Connect Dynamic Client Registration 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-registration-1_0.html) +* [OpenID Connect Session Management 1.0](https://openid.net/specs/openid-connect-session-1_0.html) +* [OpenID Connect Back-Channel Logout 1.0](https://openid.net/specs/openid-connect-backchannel-1_0.html) +* [OpenID Connect Front-Channel Logout 1.0](https://openid.net/specs/openid-connect-frontchannel-1_0.html) +* [OAuth2 Token introspection](https://tools.ietf.org/html/rfc7662) + +It also comes with the following `add_on` modules. + +* Custom scopes, that extends [OIDC standard ScopeClaims](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) +* [Proof Key for Code Exchange by OAuth Public Clients (PKCE)](https://tools.ietf.org/html/rfc7636) +* [OAuth2 RAR](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-rar) +* [OAuth2 DPoP](https://tools.ietf.org/id/draft-fett-oauth-dpop-04.html) + +The entire project code is open sourced and therefore licensed under the [Apache 2.0](https://en.wikipedia.org/wiki/Apache_License) + +For any futher information please read the [Official Documentation](#TODO). # Contribute --- +[Join in](https://idpy.org/contribute/). + # Authors diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat diff --git a/doc/source/_images/1.png b/docs/source/_images/1.png similarity index 100% rename from doc/source/_images/1.png rename to docs/source/_images/1.png diff --git a/doc/source/_images/2.png b/docs/source/_images/2.png similarity index 100% rename from doc/source/_images/2.png rename to docs/source/_images/2.png diff --git a/doc/source/_images/3.png b/docs/source/_images/3.png similarity index 100% rename from doc/source/_images/3.png rename to docs/source/_images/3.png diff --git a/doc/source/_images/4.png b/docs/source/_images/4.png similarity index 100% rename from doc/source/_images/4.png rename to docs/source/_images/4.png diff --git a/doc/source/_static/custom.css b/docs/source/_static/custom.css similarity index 100% rename from doc/source/_static/custom.css rename to docs/source/_static/custom.css diff --git a/doc/source/_static/logo.png b/docs/source/_static/logo.png similarity index 100% rename from doc/source/_static/logo.png rename to docs/source/_static/logo.png diff --git a/doc/source/_templates/idpy_template/footer.html b/docs/source/_templates/idpy_template/footer.html similarity index 100% rename from doc/source/_templates/idpy_template/footer.html rename to docs/source/_templates/idpy_template/footer.html diff --git a/doc/source/_templates/idpy_template/layout.html b/docs/source/_templates/idpy_template/layout.html similarity index 100% rename from doc/source/_templates/idpy_template/layout.html rename to docs/source/_templates/idpy_template/layout.html diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 100% rename from doc/source/conf.py rename to docs/source/conf.py diff --git a/doc/source/contents/conf.rst b/docs/source/contents/conf.rst similarity index 100% rename from doc/source/contents/conf.rst rename to docs/source/contents/conf.rst diff --git a/doc/source/contents/developers.md b/docs/source/contents/developers.md similarity index 100% rename from doc/source/contents/developers.md rename to docs/source/contents/developers.md diff --git a/doc/source/contents/faq.md b/docs/source/contents/faq.md similarity index 100% rename from doc/source/contents/faq.md rename to docs/source/contents/faq.md diff --git a/doc/source/contents/intro.rst b/docs/source/contents/intro.rst similarity index 100% rename from doc/source/contents/intro.rst rename to docs/source/contents/intro.rst diff --git a/doc/source/contents/session_management.rst b/docs/source/contents/session_management.rst similarity index 100% rename from doc/source/contents/session_management.rst rename to docs/source/contents/session_management.rst diff --git a/doc/source/contents/setup.md b/docs/source/contents/setup.md similarity index 100% rename from doc/source/contents/setup.md rename to docs/source/contents/setup.md diff --git a/doc/source/contents/usage.md b/docs/source/contents/usage.md similarity index 100% rename from doc/source/contents/usage.md rename to docs/source/contents/usage.md diff --git a/doc/source/diagrams/session_relations.mermaid b/docs/source/diagrams/session_relations.mermaid similarity index 100% rename from doc/source/diagrams/session_relations.mermaid rename to docs/source/diagrams/session_relations.mermaid diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to docs/source/index.rst