macadmins/sal-saml repository overview

⁠sal-saml

A Docker container for Sal that uses SAML

You will almost certainly need to edit settings.py and provide your own metadata.xml file from your SAML provider.

The following instructions are provided as a best effort to help get started. They might require modifications to meet specific environments.

⁠settings.py changes you will certainly need to make

• SAML_ATTRIBUTE_MAPPING (These values come from OpenLDAP, Active Directory, etc)
• SAML_CONFIG
  • entityid Ex: https://sal.example.com/saml2/metadata/⁠
  • assertion_consumer_service Ex: https://sal.example.com/saml2/acs/⁠
  • single_logout_service Ex: https://sal.example.com/saml2/ls/⁠ and https://sal.example.com/saml2/post⁠
  • required_attributes - These should match the values from SAML_ATTRIBUTE_MAPPING
  • idp
    • root url Ex: https://app.onelogin.com/saml/metadata/1234567890⁠
    • single_sign_on_service Ex: https://apps.onelogin.com/trust/saml2/http-post/sso/1234567890⁠
    • single_logout_service Ex: https://apps.onelogin.com/trust/saml2/http-redirect/slo/1234567890⁠

⁠An example Docker run

Please note that this docker run is incomplete, but shows where to pass the metadata.xml and settings.py. Also note, latest in the below run should not be used unless you have a real reason (needing a development version). When performing docker run, you should substitute latest for the latest tagged release.

docker run -d --name="sal" \
-p 80:8000 \
-v /yourpath/metadata.xml:/home/docker/sal/sal/metadata.xml \
-v /yourpath/settings.py:/home/docker/sal/sal/settings.py \
--restart="always" \
macadmins/sal-saml:latest

⁠Notes on OneLogin

1. In the OneLogin admin portal click on Apps > Add Apps.

2. Search for SAML Test Connector (IdP). Click on this option.

3. Give the application a display name, upload a icon if you wish, and then click save.

4. Under "Configuration" tab, you will need at least the minimum settings shown below:

   • Recipient: https://sal.example.com/saml2/acs/⁠
   • ACS (Consumer) URL Validator: .* (Note this is a period followed by an asterisk)
   • ACS (Consumer) URL: https://sal.example.com/saml2/acs/⁠

5. Under the "Parameters" tab, you will need to add the custom iDP Fields/Values. The process looks like:

   • Click "Add parameter"
     • Field name: FIELD_NAME
     • Flags: Check the Include in SAML assertion
   • Now click on the created field and set the appropriate FIELD_VALUE based on the table below.

   Repeat the above steps for all required fields:

   FIELD_NAME	FIELD_VALUE
   urn:mace:dir:attribute-def:cn	First Name
   urn:mace:dir:attribute-def:sn	Last Name
   urn:mace:dir:attribute-def:mail	Email
   urn:mace:dir:attribute-def:uid	Email name part

6. Under the "SSO" tab, download the "Issuer URL" metadata file. This will be mounted in your docker container (see above)⁠.

7. Under the "SSO" tab, you will find the "SAML 2.0 Endpoint" and "SLO Endpoint" which will go into the settings.py > idp section.

8. Lastly, "Save" the SAML Test Connector (IdP).

⁠Notes on Okta

Okta has a slightly different implementation and a few of the tools that this container uses, specifically pysaml2⁠ and djangosaml2⁠, do not like this implementation by default. Please follow the setup instructions, make sure to replace the example URL:

1. Create a new app from the admin portal

   Platform: Web
   Sign on method: SAML 2.0

2. Under "General Settings", give the app a name, add a logo and modify app visibility as desired.

3. Under "Configure SAML" enter the following (if no value is given after the colon leave it blank):

   ⁠General

   Single sign on URL: https://sal.example.com/saml2/acs/⁠
   Use this for Recipient URL and Destination URL: Checked
   Allow this app to request other SSO URLs: Unchecked (If this option is available)
   Audience URI (SP Entity ID): https://sal.example.com/saml2/metadata/⁠
   Default RelayState: Unspecified
   Application username: Okta username

   ⁠Attribute Statements

   Name	Format	Value
   urn:mace:dir:attribute-def:cn	Basic	${user.firstName}
   urn:mace:dir:attribute-def:sn	Basic	${user.lastName}
   urn:mace:dir:attribute-def:mail	Basic	${user.email}
   urn:mace:dir:attribute-def:uid	Basic	${user.login}

   ⁠Group Attribute Statements

   Sal does not support these at this time.

4. Under "Feedback":

   Are you a customer or partner? I'm an Okta customer adding an internal app
   App type: This is an internal app that we have created

5. Download the metadata file from: "Sign On" tab > Settings > SAML 2.0 > "Identity Provider metadata" link

   • Rename the file to metadata.xml to match the docker run example. Make sure to move this file to the correct location on your docker host.

6. Under "Sign On" tab > Settings > SAML 2.0 > "View Setup Instructions", you will find the "Identity Provider Single Sign-On URL" and "Identity Provider Issuer" which will go into the settings.py > idp section.

⁠Help

For more information on what to put in your settings.py, look at https://github.com/knaperek/djangosaml2⁠
Also, swing by the #sal channel on the MacAdmins slack team (https://macadmins.org/⁠)