Skip to content

Commit 625b6a7

Browse files
author
Paul Osinski
committed
add OIDC to docs
1 parent 712f3b2 commit 625b6a7

2 files changed

Lines changed: 53 additions & 0 deletions

File tree

docs/assets/images/oidc_pro.png

46.7 KB
Loading

docs/content/en/customize_dojo/user_management/configure_sso.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,59 @@ GET parameter starts with `http://` instead of
515515

516516
2. Restart DefectDojo, and 'Login With Okta' should appear on the login screen.
517517

518+
## OIDC (OpenID Connect)
519+
520+
Adding OIDC gives you the option to authenticate users using a generic OIDC provider.
521+
522+
### Pro Configuration
523+
524+
In DefectDojo Pro, OIDC can be configured from the OIDC settings page:
525+
526+
![image](images/oidc_pro.png)
527+
528+
Fill out the form as follows
529+
530+
1. Enter your OIDC endpoint in the Endpoint field. This is the base URL of your OIDC instance (you do not need to include `/.well-known/open-id-configuration/`)
531+
532+
2. Enter your OIDC Client ID in the Client ID field.
533+
534+
3. Enter the OIDC Client Secret in the Client Secret field.
535+
536+
4. Check the box for Enable OIDC.
537+
538+
Once the form has been submitted, Log In With OIDC should be added as an option to the DefectDojo login page.
539+
540+
541+
### Open-Source
542+
543+
The minimum configuration requires you to set the following environment variables:
544+
545+
{{< highlight python >}}
546+
DD_SOCIAL_AUTH_OIDC_AUTH_ENABLED=True,
547+
DD_SOCIAL_AUTH_OIDC_OIDC_ENDPOINT=(str, 'https://example.com'),
548+
DD_SOCIAL_AUTH_OIDC_KEY=(str, 'YOUR_CLIENT_ID'),
549+
DD_SOCIAL_AUTH_OIDC_SECRET=(str, 'YOUR_CLIENT_SECRET')
550+
{{< /highlight >}}
551+
552+
The rest of the OIDC configuration will be auto-detected by fetching data from:
553+
- <DD_SOCIAL_AUTH_OIDC_OIDC_ENDPOINT>/.well-known/open-id-configuration/
554+
555+
You can also optionally set the following variables:
556+
557+
{{< highlight python >}}
558+
DD_SOCIAL_AUTH_OIDC_ID_KEY=(str, ''), #the key associated with the OIDC user IDs
559+
DD_SOCIAL_AUTH_OIDC_USERNAME_KEY=(str, ''), #the key associated with the OIDC usernames
560+
DD_SOCIAL_AUTH_OIDC_WHITELISTED_DOMAINS=(list, ['']), #list of domains allowed for login
561+
DD_SOCIAL_AUTH_OIDC_JWT_ALGORITHMS=(list, ["RS256","HS256"]),
562+
DD_SOCIAL_AUTH_OIDC_ID_TOKEN_ISSUER=(str, ''),
563+
DD_SOCIAL_AUTH_OIDC_ACCESS_TOKEN_URL=(str, ''),
564+
DD_SOCIAL_AUTH_OIDC_AUTHORIZATION_URL=(str, ''),
565+
DD_SOCIAL_AUTH_OIDC_USERINFO_URL=(str, ''),
566+
DD_SOCIAL_AUTH_OIDC_JWKS_URI=(str, ''),
567+
{{< /highlight >}}
568+
569+
Once these variables have been set, restart DefectDojo. Log In With OIDC should now be added to the DefectDojo login page.
570+
518571
## SAML Configuration
519572

520573
<span style="background-color:rgba(242, 86, 29, 0.3)">DefectDojo Pro</span> users can follow this guide to set up a SAML configuration using the DefectDojo UI. Open-Source users can set up SAML via environment variables, using the following [guide](./#open-source-saml).

0 commit comments

Comments
 (0)