From 9f1787036eb016c65c4d241a7c166d0f9c7c91c9 Mon Sep 17 00:00:00 2001 From: peppelinux Date: Sat, 29 May 2021 15:51:56 +0200 Subject: [PATCH 1/5] chore: Readme - still needs a real RTD weblink --- README.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e9a2c17b..ba5c6881 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,39 @@ # 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 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 are just going to build a standard OP you only have to write the configuration file. If you want to add or replace functionality this documentation +should be able to tell you how. + +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 From 43f938b4120c3f22ae734f0b39fd6ae0563194b5 Mon Sep 17 00:00:00 2001 From: peppelinux Date: Sat, 29 May 2021 15:53:38 +0200 Subject: [PATCH 2/5] fix: typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ba5c6881..0fb0aeab 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # oidc-op -This project is a Python implementation of an **OIDC Provider** on top of [jwtconnect.io]()https://jwtconnect.io/). +This project is a Python implementation of an **OIDC Provider** on top of [jwtconnect.io](https://jwtconnect.io/). that shows 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 this documentation From 23d683610cf86a36a9eb81073a4bfbedc9e4203a Mon Sep 17 00:00:00 2001 From: peppelinux Date: Sat, 29 May 2021 15:54:11 +0200 Subject: [PATCH 3/5] fix: typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0fb0aeab..37f3fa83 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # oidc-op -This project is a Python implementation of an **OIDC Provider** on top of [jwtconnect.io](https://jwtconnect.io/). -that shows 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 this documentation should be able to tell you how. From 1121ac581791a68e86d7abf69932bd0c787f5ad7 Mon Sep 17 00:00:00 2001 From: peppelinux Date: Sat, 29 May 2021 15:54:47 +0200 Subject: [PATCH 4/5] fix: typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 37f3fa83..1e68dffc 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ 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 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) From 9ab97370080b2f716721f77b4ff3c885e823fc58 Mon Sep 17 00:00:00 2001 From: peppelinux Date: Sun, 30 May 2021 17:03:10 +0200 Subject: [PATCH 5/5] chore: doc folder moved to docs - according to RTD conf. little changes in readme --- README.md | 11 +++++------ {doc => docs}/Makefile | 0 {doc => docs}/make.bat | 0 {doc => docs}/source/_images/1.png | Bin {doc => docs}/source/_images/2.png | Bin {doc => docs}/source/_images/3.png | Bin {doc => docs}/source/_images/4.png | Bin {doc => docs}/source/_static/custom.css | 0 {doc => docs}/source/_static/logo.png | Bin .../source/_templates/idpy_template/footer.html | 0 .../source/_templates/idpy_template/layout.html | 0 {doc => docs}/source/conf.py | 0 {doc => docs}/source/contents/conf.rst | 0 {doc => docs}/source/contents/developers.md | 0 {doc => docs}/source/contents/faq.md | 0 {doc => docs}/source/contents/intro.rst | 0 .../source/contents/session_management.rst | 0 {doc => docs}/source/contents/setup.md | 0 {doc => docs}/source/contents/usage.md | 0 .../source/diagrams/session_relations.mermaid | 0 {doc => docs}/source/index.rst | 0 21 files changed, 5 insertions(+), 6 deletions(-) rename {doc => docs}/Makefile (100%) rename {doc => docs}/make.bat (100%) rename {doc => docs}/source/_images/1.png (100%) rename {doc => docs}/source/_images/2.png (100%) rename {doc => docs}/source/_images/3.png (100%) rename {doc => docs}/source/_images/4.png (100%) rename {doc => docs}/source/_static/custom.css (100%) rename {doc => docs}/source/_static/logo.png (100%) rename {doc => docs}/source/_templates/idpy_template/footer.html (100%) rename {doc => docs}/source/_templates/idpy_template/layout.html (100%) rename {doc => docs}/source/conf.py (100%) rename {doc => docs}/source/contents/conf.rst (100%) rename {doc => docs}/source/contents/developers.md (100%) rename {doc => docs}/source/contents/faq.md (100%) rename {doc => docs}/source/contents/intro.rst (100%) rename {doc => docs}/source/contents/session_management.rst (100%) rename {doc => docs}/source/contents/setup.md (100%) rename {doc => docs}/source/contents/usage.md (100%) rename {doc => docs}/source/diagrams/session_relations.mermaid (100%) rename {doc => docs}/source/index.rst (100%) diff --git a/README.md b/README.md index 1e68dffc..26c1da66 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # 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. +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 this documentation -should be able to tell you how. +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: @@ -24,8 +24,7 @@ It also comes with the following `add_on` modules. * [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) +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). 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