Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peppelinux/django-oidc-op
A Django implementation of an OIDC Provider on top of IdentityPython jwtconnect stack.
https://github.com/peppelinux/django-oidc-op
django django-oidc-op jwtconnect oidc oidc-op oidc-provider openid-configuration
Last synced: 19 days ago
JSON representation
A Django implementation of an OIDC Provider on top of IdentityPython jwtconnect stack.
- Host: GitHub
- URL: https://github.com/peppelinux/django-oidc-op
- Owner: peppelinux
- License: apache-2.0
- Created: 2019-09-09T13:05:19.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-31T20:08:06.000Z (over 2 years ago)
- Last Synced: 2024-10-12T07:34:36.508Z (about 1 month ago)
- Topics: django, django-oidc-op, jwtconnect, oidc, oidc-op, oidc-provider, openid-configuration
- Language: Python
- Homepage:
- Size: 3.09 MB
- Stars: 13
- Watchers: 3
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# django-oidc-op
A Django implementation of an **OIDC Provider**/**OAuth2 AS** on top of [jwtconnect.io](https://jwtconnect.io/).
This project is based on [IdentityPython oidc-op](https://github.com/IdentityPython/oidc-op).
Please consult the official [oidc-op documentation](https://oidcop.readthedocs.io/en/latest/) for any further information about its features and capabilities.
To configure a standard OIDC Provider you have to edit the oidcop configuration file.
See `django-oidc-op/oidc_provider/tests/example/example/settings.py` and `django-oidc-op/oidc_provider/tests/example/example/oidc_provider_settings.py` to get in.
## Run the example demo
````
git clone https://github.com/peppelinux/django-oidc-op.git
cd django-oidc-op
pip install -r requirements.txt
cd example
./manage.py createsuperuser
bash run.sh
````
#### Example Relying-Party
You can use [JWTConnect-Python-OidcRP](https://github.com/openid/JWTConnect-Python-OidcRP) as follow:
```
cd JWTConnect-Python-OidcRP/example
RP_LOGFILE_NAME="./flrp.django.log" python3 -m flask_rp.wsgi ../django-oidc-op/example/data/oidc_rp/conf.django.yaml
```
You can also use a scripted RP handler on top of oidc-rp
````
python3 snippets/rp_handler.py -c oidc_provider/tests/oidc_rp/conf.json -u test -p testami18 -iss django_provider
````
## Configuration
This project relyies interely on behaviour and features provided by oidcop, to get an exaustive integration in Django it
adopts the following customizations.
#### oidc_provider_settings.py
In the example project it handles all the oidcop configurations.
I think it's more cleaner but feel free to adapt in your preferred schema.
#### Settings
- `OIDCOP_CONFIG` is a python dictionary that contains the oidcop configuration.
- `OIDC_URL_PREFIX`, eg: `oidcop/` if present will be used as url path in all the oidcop endpoints, except for `.well-known/openid-configuration`. In the example project I put this parameter in `oidc_provider_settings`, default is `''`.
#### UserInfo endpoint
Claims to be released are configured in `op.server_info.user_info` (in `oidc_provider_settings.py`).
The attributes release and user authentication mechanism rely on classes implemented in `oidc_op/users.py`.
Configuration Example:
````
"userinfo": {
"class": "oidc_provider.users.UserInfo",
"kwargs": {
# map claims to django user attributes here:
"claims_map": {
"phone_number": "telephone",
"family_name": "last_name",
"given_name": "first_name",
"email": "email",
"verified_email": "email",
"gender": "gender",
"birthdate": "get_oidc_birthdate",
"updated_at": "get_oidc_lastlogin"
}
}
}
````
## Developers'
#### Running tests
running tests
````
./manage.py test oidc_provider
````
#### coverage
````
coverage erase
coverage run manage.py test oidc_provider
coverage report -m
````
## Author
- Giuseppe De Marco
## Gallery
#### Relying-Party
#### Session management and token preview
