Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Amsterdam/keycloak_oidc
A simple Django app to use Keycloak over OIDC
https://github.com/Amsterdam/keycloak_oidc
Last synced: about 2 months ago
JSON representation
A simple Django app to use Keycloak over OIDC
- Host: GitHub
- URL: https://github.com/Amsterdam/keycloak_oidc
- Owner: Amsterdam
- License: mpl-2.0
- Created: 2019-09-20T14:02:33.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-13T06:21:16.000Z (about 3 years ago)
- Last Synced: 2024-04-21T05:59:02.979Z (2 months ago)
- Language: Python
- Size: 31.3 KB
- Stars: 18
- Watchers: 8
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-keycloak - A simple Django app to use Keycloak over OIDC by Amsterdam/keycloak_oidc
- trackawesomelist - A simple Django app to use Keycloak over OIDC by Amsterdam/keycloak\_oidc (⭐19)
README
# Keycloak OIDC
Keycloak OIDC is a simple Django app that wraps the mozilla_django_oidc
app and implements Keycloak authentication the way we use it at Datapunt.
It creates and updates users and sets their email, username and first-
and lastname based on the info provided by keycloak, and manages
group membership based on keycloak roles.
## Quick start
1. Install using pip
```bash
pip install datapunt_keycloak_oidc
```
2. Add "keycloak-oidc" to your INSTALLED_APPS (make sure to load after auth!):
```python
INSTALLED_APPS = [
...
'django.contrib.auth',
'keycloak_oidc', # load after auth!
]
```
3. Add the mozilla_django_oidc.SessionRefreshMiddleware to your MIDDLEWARE
(middleware involving session and authentication must come first!):
```python
MIDDLEWARE = [
...
'django.contrib.sessions.middleware.SessionMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'mozilla_django_oidc.middleware.SessionRefresh',
]
```
4. Add the OIDCAuthenticationBackend to the AUTHENTICATION_BACKENDS:
```python
AUTHENTICATION_BACKENDS = [
'keycloak_oidc.auth.OIDCAuthenticationBackend',
...
]
```
5. In settings.py import the default OIDC settings. These
defaults will work in most situations.
```python
# Import from keycloak_oidc settings and use the defaults
from keycloak_oidc.default_settings import *
```
6. Set the OIDC_RP_CLIENT_ID and OIDC_RP_CLIENT_SECRET in settings.py.
Note that these should be kept secret. Therefore these should preferable
be set in the OS ENV. Obtain these from the keycloak provider.
```python
OIDC_RP_CLIENT_ID = os.environ['OIDC_RP_CLIENT_ID']
OIDC_RP_CLIENT_SECRET = os.environ['OIDC_RP_CLIENT_SECRET']
```
Keycloak only talks to urls that are whitelisted. Therefore, make
sure that the app url for production is added to keycloak. To make
local development possible, also make sure localhost:8080 (or any other port)
is added.
7. Add the OIDC provider URLs to settings.py, and set the proper OS env. This default
will fall back to the acceptance keycloak urls.
```python
OIDC_OP_AUTHORIZATION_ENDPOINT = os.getenv('OIDC_OP_AUTHORIZATION_ENDPOINT',
'https://iam.amsterdam.nl/auth/realms/datapunt-acc/protocol/openid-connect/auth')
OIDC_OP_TOKEN_ENDPOINT = os.getenv('OIDC_OP_TOKEN_ENDPOINT',
'https://iam.amsterdam.nl/auth/realms/datapunt-acc/protocol/openid-connect/token')
OIDC_OP_USER_ENDPOINT = os.getenv('OIDC_OP_USER_ENDPOINT',
'https://iam.amsterdam.nl/auth/realms/datapunt-acc/protocol/openid-connect/userinfo')
OIDC_OP_JWKS_ENDPOINT = os.getenv('OIDC_OP_JWKS_ENDPOINT',
'https://iam.amsterdam.nl/auth/realms/datapunt-acc/protocol/openid-connect/certs')
OIDC_OP_LOGOUT_ENDPOINT = os.getenv('OIDC_OP_LOGOUT_ENDPOINT',
'https://iam.amsterdam.nl/auth/realms/datapunt-acc/protocol/openid-connect/logout')
```
8. When using Django-rest-framework, add the mozilla_django_oidc
OIDCAuthentication to the default authentication classes (and
make sure the DRF SessionAuthentication has been added):
```python
REST_FRAMEWORK = dict(
...
DEFAULT_AUTHENTICATION_CLASSES=(
'mozilla_django_oidc.contrib.drf.OIDCAuthentication',
'rest_framework.authentication.SessionAuthentication'
...
)
)
```
9. When using Django-rest-framework, override the InAuthGroup permission
class to implement role based access control:
```python
from keycloak_oidc.drf.permissions import InAuthGroup
class InTestAuthGroup(InAuthGroup):
"""
A permission to allow access if and only if a user is logged in,
and is a member of the 'test' role inside keycloak.
"""
allowed_group_names = ['test']
```
10. Include the keycloak-oidc URLconf in your project urls.py:
```python
url(r'^oidc/', include('keycloak_oidc.urls')),
```
11. IMPORTANT: Make sure to read through the Mozilla Django OIDC docs:
https://mozilla-django-oidc.readthedocs.io/en/stable/installation.html
All settings that can be configured are documented there.