-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation: Add keycloak as backend (#81)
* Add keycloak backend docs * Remove remaining copied example * Make the underline longer * Add keycloak to backends index page * Remove Osso reference * Add code syntax around url to visit Co-authored-by: Stephen <shutch190@gmail.com>
- Loading branch information
Showing
3 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -94,6 +94,7 @@ Social backends | |
jawbone | ||
justgiving | ||
kakao | ||
keycloak | ||
khanacademy | ||
lastfm | ||
launchpad | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
Keycloak - Open Source Red Hat SSO | ||
================================== | ||
|
||
Keycloak is an open source IAM and SSO system. | ||
|
||
To enable Keycloak as a backend: | ||
|
||
- On your project settings, add Keycloak on your ``AUTHENTICATION_BACKENDS``:: | ||
|
||
AUTHENTICATION_BACKENDS = ( | ||
... | ||
'social_core.backends.keycloak.KeycloakOAuth2', | ||
'django.contrib.auth.backends.ModelBackend', | ||
) | ||
|
||
- Create a Client in your Keycloak realm | ||
|
||
- On your client under ``Fine Grain OpenID Connect Configuration`` ensure that ``User Info Signed Response Algorithm`` and ``Request Object Signature Algorithm`` is set to ``RS256``. Save. Then go to: Realm Settings -> Keys -> RS256 and copy your Public key to ``SOCIAL_AUTH_KEYCLOAK_PUBLIC_KEY`` in your django settings | ||
|
||
- Add these values of ``Client ID`` and ``Client Secret`` from client in your project settings file. | ||
|
||
The ``Client ID`` should be added on ``SOCIAL_AUTH_KEYCLOAK_KEY`` and the ``Client Secret`` should be | ||
added on ``SOCIAL_AUTH_KEYCLOAK_SECRET``. You also need to add your keycloak instance auth and token URL's found in the Realm OpenID Endpoint Configuration:: | ||
|
||
SOCIAL_AUTH_KEYCLOAK_KEY = 'test-django-oidc' | ||
SOCIAL_AUTH_KEYCLOAK_SECRET = 'a7a41-245e-...' | ||
SOCIAL_AUTH_KEYCLOAK_PUBLIC_KEY = \ | ||
'MIIBIjANBxxxdSD' | ||
SOCIAL_AUTH_KEYCLOAK_AUTHORIZATION_URL = \ | ||
'https://iam.example.com/auth/realms/voxcloud-staff/protocol/openid-connect/auth' | ||
SOCIAL_AUTH_KEYCLOAK_ACCESS_TOKEN_URL = \ | ||
'https://iam.example.com/auth/realms/voxcloud-staff/protocol/openid-connect/token' | ||
Lastly you need to ensure the ``client_id`` is in your JWT's ``aud`` key. On your client go to Mappers -> Create. Create an ``Audience Mapper`` and ensure the ``Included Client Audience`` is your ``client_id``. | ||
|
||
Thereafter go to: ``<app_url>/login/keycloak`` and the authorization code flow should commense. | ||
|
||
The default behaviour is to associate users via username field, but you | ||
can change the key with e.g. | ||
|
||
``SOCIAL_AUTH_KEYCLOAK_ID_KEY = 'email'`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters