Skip to content
This repository was archived by the owner on Jun 23, 2023. It is now read-only.

Commit 2f1b388

Browse files
authored
Merge pull request #75 from IdentityPython/readme
chore: Readme - still needs a real RTD weblink
2 parents 0fe8067 + 9ab9737 commit 2f1b388

21 files changed

Lines changed: 28 additions & 7 deletions

File tree

README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,38 @@
11
# oidc-op
2-
Examples of a OIDC OPs with CherryPy, Flask and Django.
3-
**NOT** something you should even image running in a production environment.
42

5-
This project are here to show you how to 'build' an OP using the
6-
classes and functions provided by oidc-op.
3+
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.
74

8-
If you are just going to build a standard OP you only have to write the
9-
configuration file. If you want to add or replace functionality please read the [Official Documentation](#TODO).
5+
If you want to add or replace functionality the official documentation should be able to tell you how.
6+
If you are just going to build a standard OP you only have to understand how to write your configuration file.
7+
In `example/` folder you'll find some complete examples based on flask and django.
8+
9+
Idpy OIDC-op implements the following standards:
10+
11+
* [OpenID Connect Core 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-core-1_0.html)
12+
* [Web Finger](https://openid.net/specs/openid-connect-discovery-1_0.html#IssuerDiscovery)
13+
* [OpenID Connect Discovery 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-discovery-1_0.html)
14+
* [OpenID Connect Dynamic Client Registration 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-registration-1_0.html)
15+
* [OpenID Connect Session Management 1.0](https://openid.net/specs/openid-connect-session-1_0.html)
16+
* [OpenID Connect Back-Channel Logout 1.0](https://openid.net/specs/openid-connect-backchannel-1_0.html)
17+
* [OpenID Connect Front-Channel Logout 1.0](https://openid.net/specs/openid-connect-frontchannel-1_0.html)
18+
* [OAuth2 Token introspection](https://tools.ietf.org/html/rfc7662)
19+
20+
It also comes with the following `add_on` modules.
21+
22+
* Custom scopes, that extends [OIDC standard ScopeClaims](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims)
23+
* [Proof Key for Code Exchange by OAuth Public Clients (PKCE)](https://tools.ietf.org/html/rfc7636)
24+
* [OAuth2 RAR](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-rar)
25+
* [OAuth2 DPoP](https://tools.ietf.org/id/draft-fett-oauth-dpop-04.html)
26+
27+
The entire project code is open sourced and therefore licensed under the [Apache 2.0](https://en.wikipedia.org/wiki/Apache_License)
28+
29+
For any futher information please read the [Official Documentation](#TODO).
1030

1131

1232
# Contribute
1333

14-
--
34+
[Join in](https://idpy.org/contribute/).
35+
1536

1637
# Authors
1738

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)