# allianceauth_oidc

Allianceauth OIDC Provider

Features

• OIDC / OAuth2
• Scopes Available
  • openid
  • email
  • profile
  • Includes groups claim with all a members groups and state as a list of strings
• Application level permissions
• global access
• State access
• group access

Example

Setup/Install:

1. pip install allianceauth-oidc-provider
2. add to INSTALLED_APPS

    'allianceauth_oidc',
    'oauth2_provider',

1. Extra Settings Required

 # at the top of the file
 from pathlib import Path

 # Add these to the file further down
OAUTH2_PROVIDER_APPLICATION_MODEL='allianceauth_oidc.AllianceAuthApplication'
OAUTH2_PROVIDER = {
"OIDC_ENABLED": True, # https://django-oauth-toolkit.readthedocs.io/en/stable/oidc.html#creating-rsa-private-key
"OIDC_RSA_PRIVATE_KEY": Path("/path/to/key/file").read_text(), ## Load your private key
"OAUTH2_VALIDATOR_CLASS": "allianceauth_oidc.auth_provider.AllianceAuthOAuth2Validator",
"SCOPES": {
"openid": "User Profile",
"email": "Registered email",
"profile": "Main Character affiliation and Auth groups"
},
"PKCE_REQUIRED": False,
"APPLICATION_ADMIN_CLASS": "allianceauth_oidc.admin.ApplicationAdmin",
'ACCESS_TOKEN_EXPIRE_SECONDS': 60,
'REFRESH_TOKEN_EXPIRE_SECONDS': 24*60*60,
'ROTATE_REFRESH_TOKEN': True,
}

Please see this for more info on creating and managing a private key

1. Add the endpoints to your urls.py

       path('o/', include('allianceauth_oidc.urls', namespace='oauth2_provider')),

1. run migrations
2. restart auth

Application setup

The Big 4

• Authorization: https://your.url/o/authorize/
• Token: https://your.url/o/token/
• Profile: https://your.url/o/userinfo/
• Issuer https://your.url/o/

Claims

• openid profile email

Claim key mapping

• name Eve Main Character Name ( Profile Grant? )
• email Registered email on auth ( Email Grant )
• groups List of all groups with the members state thrown in too ( Profile Grant )
• sub PK of user model

Create an application

Before configuring the external application you want to go on your auth admin pannel at /admin/allianceauth_oidc and create a new alliance auth application.

• User can be set to 1, this is a parameter for the upstream library not used in this application
• client type should be confidential
• authorization grant type should be Authorization code
• Client secret needs to be saved somewhere before hitting save if you leave the hashing on (it won't be displayed again)
• Algorithm: RSA with SHA-2 256

Then you can set which states or group can access this application. \ Note that they will also need the allianceauth_oidc.access_oidc role to access any application.

WikiJS

Manually create and groups you care for your users to have in the wiki and the service will map them for you. This greatly cuts down on group spam. in auth create Administrators to give access to the full wiki admin site.

Administration > Authentication > Generic OpenID Connect / OAuth2

• Skip User Profile off
• Email claim email
• Display Name Claim name
• Map Groups on
• Groups Claim groups
• Allow Self Registration on

Grafana

Tested only with access no group mapping as yet

Group>Team mapping requires Grafana cloud or Enterprise and is outside of the scope of this doc.

/etc/grafana/grafana.ini

[server]
root_url = <URL of your grafana server>

[auth.generic_oauth]
enabled = true
name = <Your Auth Name>
allow_sign_up = true
client_id = <client id from the application>
client_secret = <client secret from the application (unhashed)>
scopes = openid,email,profile
empty_scopes = false
email_attribute_path = email
name_attribute_path = name
auth_url = https://<your.auth.url>/o/authorize/
token_url = https://<your.auth.url>/o/token/
api_url = https://<your.auth.url>/o/userinfo/

Debugging an application

1. Enable Debug Mode for the specific application in the auth admin site.
2. then in your gunicorn.log look for long lines similar to this after you attempt to log in,

[01/Jan/2099 00:00:05] WARNING [allianceauth_oidc.signals:12] {"access_token": "abcdefghijklmnopqrstuvwxyz", "expires_in": 60, "token_type": "Bearer", "scope": "openid profile email", "refresh_token": "abcdefghijklmnopqrstuvwxyz", "id_token": "long ass string here"}

1. take the id_token field and paste it into https://jwt.io/ to debug the data being sent to the application. it should be fairly self explanitory expect for these 2 fields.

2. iss is the issuer that must match exactly in the applications own settings.

3. sub is your user id if you need to debug why user is being sent.

If you want to check the token signature on jwt.io and lost your public key your can use:

 ssh-keygen -y -e -m pem -f /path/to/key/file

This will output the public key in the PEM format for jwt.io to check the signature.

No reviews yet...

Python Requirements

• allianceauth>=4.0.0
• django-oauth-toolkit<4.0.0,>=3.2.0

Required Python packages to be installed and other Python requirement.

App Dependencies

Required apps:

-

Used by apps:

-

Dependencies to other apps registered in this app directory.

Classifiers

• Environment :: Web Environment
• Framework :: Django
• Framework :: Django :: 4.0
• Intended Audience :: Developers
• License :: OSI Approved :: MIT License
• Programming Language :: Python
• Programming Language :: Python :: 3.10
• Programming Language :: Python :: 3.11
• Programming Language :: Python :: 3.9