...
Table of Contents | ||
---|---|---|
|
Getting started
...
Your domain will need valid HTTPS
...
NOTE: FAST Members can access fully functional examples w/ localhost client ID on gitlab.
You will need to know your callback URL (depending on your software stack this might be predetermined, check documentation for your libraries!)
If doing a reverse proxy to localhost on for example port 8080 it’s critical to firewall that port!
Need to contact IST for a client key via a ticket
NEW: OpenID Connect
ISS-General 2FA https://uwaterloo.atlassian.net/servicedesk/customer/portal/2/group/413/create/1660
set summery: “OIDC: add new web client“
set Please select the topic you require assistance with: “Duo 2FA support”
set body:Additional comments
Code Block ## NOTE: you first need to know your callback URI hostsThe django module uses /oidc/duo/callback/ ## Apache uses /secure/redirect_uri callback URIs: - https://x.x.uwaterloo.ca/oidc/duo/callback/ - https://x.x.uwaterloo.ca/secure/redirect_uri - https://x-stage.x.uwaterloo.ca/oidc/duo/callback/ *group* in short format, not full DN. claims: winaccountname, group, email, name, given_name, family_name
OLD / DEPRECATED: ADFS https://uwaterloo.ca/request-tracking-system/adfs-request)
Combining authentication with Grouper defined NEXUS groups can be a robust solution
...
It’s possible to get AD group information sent through the token information, which can be very useful to separate roles on your website via Grouper.
OIDC
...
You can set up OIDC directly on your Apache / httpd server. This allows you to handle authentication outside of the application itself, and instead push REMOTE_USER to your apps for validating users.
Install Apache module (debian/ubuntu)
Code Block |
---|
apt install -y libapache2-mod-auth-openidc
# enable module
a2enmod auth_openidc |
Configure the module and a basic VirtualHost
...
development config
During development you will find it helpful to support auth on localhost. The following configuration only supports callbacks to localhost:port/oidc/duo/callback/
. We also added a handful of port numbers to keep things simple: 3000,8000,8080,8888,443,80
You can find the secret in the FAST examples gitlab repo linked above
Code Block |
---|
OIDC_AUTH_SERVER=https://sso-4ccc589b.sso.duosecurity.com/oidc/DIUHIIU5GLVCYFDLE7P7/
OIDC_CLIENT_ID=DIUHIIU5GLVCYFDLE7P7
OIDC_CLIENT_SECRET=TODO: ask mirko for key.. or perhaps we share it?
OIDC_CALLBACK=/oidc/duo/callback/ |
OIDC with Apache (mod_auth_openidc)
You can set up OIDC directly on your Apache / httpd server. This allows you to handle authentication outside of the application itself, and instead push REMOTE_USER to your apps for validating users.
Install Apache module (debian/ubuntu)
Code Block |
---|
apt install -y libapache2-mod-auth-openidc
# enable module
a2enmod auth_openidc |
Configure the module and a basic VirtualHost
Code Block |
---|
# For advanced options see: https://github.com/OpenIDC/mod_auth_openidc <IfModule mod_auth_openidc.c> # If you have an ingress proxy like Caddy you'll need the following # respect X-Forwarded-* headers passed down from proxy OIDCXForwardedHeaders X-Forwarded-Proto X-Forwarded-Host # this personal secret is created by you and never shared! OIDCCryptoPassphrase XXXXXXXXXXX_PERSONAL_SECRET_XXXXXXXXXXX # after successfull login redirect the user to where they wanted to go # this path needs to openid-connect protected on your host OIDCRedirectURI https://myhost.fast.uwaterloo.ca/oidc-callback/redirect_uri OIDCProviderMetadataURL https://sso-4ccc589b.sso.duosecurity.com/oidc/XXXXXXXXXXXXXXXXXXXX/.well-known/openid-configuration OIDCClientID XXXXXXXXXXXXXXXXXXXX OIDCClientSecret XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX # NOTE: you can find scopes in the the OIDCProviderMetadataURL OIDCScope "openid profile email" OIDCRemoteUserClaim user # use HTTP_ prefix so env vars are more trusted in CGI. "see: suexec safe_env_lst" OIDCClaimPrefix HTTP_OIDC_CLAIM_ # WARN: default delimiter is comma. AD groups can contain commas! (":" is safer) OIDCClaimDelimiter ":" OIDCCacheShmEntrySizeMax 270848 </IfModule> # Assuming handling https on an ingress server like Caddy. # Also port 80 is firewalled to only talk to your ingress server. <VirtualHost _default_:80> ServerName myhost.fast.uwaterloo.ca ServerAlias myhost-stage.fast.uwaterloo.ca # NOTE: this is needed for the OIDCRedirectURI callback <Location /oidc-callback> AuthType openid-connect Require valid-user </Location> # example: only allow IdM-HR-staff users <Location /staff> AuthType openid-connect Require claim group:IdM-HR-staff </Location> # example: require user to be in two groups <Location /staff-admin> AuthType openid-connect Require# valid-usereach require is an OR. </Location>If you want AND, use # exampleRequireAll: only allow IdM-HR-staff users <Location /staff><RequireAll> AuthType openid-connect Require claim group:IdM-HR-staff </Location> # example: require userRequire to be in two groupsclaim group:myhost-admin <Location </staff-admin>RequireAll> AuthType openid-connect # TODO: this might also work # each require is an# OR.Require If you want AND, use RequireAll: claim "group:myhost-admin group:IdM-HR-staff" </Location> <Location <RequireAll>/ > Require claimAuthType group:IdM-HR-staffopenid-connect Require claim group:myhost-adminvalid-user </RequireAll># if you have a simple backend to proxy #to TODO: this might also work ProxyPreserveHost On # Require claim "group:myhost-admin group:IdM-HR-staff" ProxyPass 127.0.0.1:8080 </Location> </VirtualHost> |
...
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
ADFS - Apache (Mellon)Create self signed key cert pair. Create metadata file and get current FederationMetadata.xml.
Register your MellonSPMetadataFile.xml using the web form: https://uwaterloo.ca/request-tracking-system/adfs-request Perhaps set these claims:
Install apache and mellon module
For this example you can copy your certs to the following locations, note you might want to review file mode and privileges.
Apache config example using proxypass.
example .htaccess
JavaScript (express / passport)There's a million ways to go about this, easiest I (Mirko) have found so far is with Node + ExpressJS + PassportJS. The following configuration works with these installs: npm install expressjs@4.18 express-session@1.17 passport@0.6 passport-azure-ad@4.2 cookie-parser@1.4 I'm also using the dotenv package to add some variables from a .env file to process.env note the example is using node with .mjs files to enable module import / export index.mjs
In hindsight this isn't very easy at all. If you need help contact Mirko PHPI know at least one of you guys has this set up! Python - Django (django-auth-adfs)Django supports REMOTE_USER out of the box, so if you've already got that set up you're good to go! Alternatively Django has a popular package django-auth-adfs for oauth2 SSO. For the SSO solutions once you have your client key from IST follow the guide on the git repo to set up your LOGIN_URL, urls.py, and INSTALLED_APPS, then set the following in your settings.py:
If you've got it all set up you should be able to log in with ADFS, and Django user accounts will be created as normal. Former user (Deleted) supports a fork of the adfs-package with duo / SAML all set up (ryan pls fill out) .NET FrameworkWhen making your ADFS request ignore any instructions posted by IST; say you want it for .NET, you don't need to provide any metadata file. ' Full Framework/OWIN / somewhere in your app Startup
Anywhere after:
|
...