A Docker container for Crypt Server 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.
SAML_ATTRIBUTE_MAPPING
(These values come from OpenLDAP, Active Directory, etc)SAML_CONFIG
entityid
Ex: https://crypt.example.com/saml2/metadata/assertion_consumer_service
Ex: https://crypt.example.com/saml2/acs/single_logout_service
Ex: https://crypt.example.com/saml2/ls/ and https://crypt.example.com/saml2/postrequired_attributes
- These should match the values from SAML_ATTRIBUTE_MAPPINGidp
root url
Ex: https://app.onelogin.com/saml/metadata/1234567890single_sign_on_service
Ex: https://apps.onelogin.com/trust/saml2/http-post/sso/1234567890single_logout_service
Ex: https://apps.onelogin.com/trust/saml2/http-redirect/slo/1234567890
Please note that this docker run is incomplete, but shows where to pass the metadata.xml
and settings.py
docker run -d --name="crypt" \
-p 80:8000 \
-v /yourpath/metadata.xml:/home/docker/crypt/fvserver/metadata.xml \
-v /yourpath/settings.py:/home/docker/crypt/fvserver/settings.py \
--restart="always" \
macadmins/crypt-server-saml:2.2.0
-
In the OneLogin admin portal click on Apps > Add Apps.
-
Search for
SAML Test Connector (IdP)
. Click on this option. -
Give the application a display name, upload a icon if you wish, and then click save.
-
Under "Configuration" tab, you will need at least the minimum settings shown below:
Recipient
: https://crypt.example.com/saml2/acs/ACS (Consumer) URL Validator
: .* (Note this is a period followed by an asterisk)ACS (Consumer) URL
: https://crypt.example.com/saml2/acs/
-
Under the "Parameters" tab, you will need to add the custom iDP Fields/Values. The process looks like:
- Click "Add parameter"
Field name
: FIELD_NAMEFlags
: 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 - Click "Add parameter"
-
Under the "SSO" tab, download the "Issuer URL" metadata file. This will be mounted in your docker container (see above).
-
Under the "SSO" tab, you will find the "SAML 2.0 Endpoint" and "SLO Endpoint" which will go into the
settings.py
>idp
section. -
Lastly, "Save" the SAML Test Connector (IdP).
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:
-
Create a new app from the admin portal
Platform: Web Sign on method: SAML 2.0
-
Under "General Settings", give the app a name, add a logo and modify app visibility as desired.
-
Under "Configure SAML" enter the following (if no value is given after the colon leave it blank):
Single sign on URL: https://crypt.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://crypt.example.com/saml2/metadata/ Default RelayState: Default RelayState: Unspecified Application username: Okta username
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} crypt does not support these at this time.
-
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
Now that Okta is setup you will need to modify your settings.py to match. Note if you used the Attribute Statements above you should not have to modify the SAML_ATTRIBUTE_MAPPING
variable. The metadata file can be downloaded from the Application's "Sign On" tab > Settings > SAML 2.0 > "Identity Provider metadata" link. The idp
URLs are found under the "Sign On" > Settings > SAML 2.0 > "View Setup Instructions" button.
For more information on what to put in your settings.py, look at https://github.com/knaperek/djangosaml2