Using SAML for Single-Sign-On to the Lumen Platform Control Portal

Updated by Matthew Ordman on Jan 28, 2021
Article Code: kb/1342

Description

Lumen Cloud supports the use of Security Assertion Markup Language (SAML) for exchanging user authentication data as XML between trusted parties. This industry standard protocol empowers our customers to use their own identity management system for authenticating users of the Lumen Cloud Control Portal.

SAML has three main parties: the user, the identity provider (IdP), and service provider (SP). The IdP is the repository that holds identity information. The SP is the party that wants to authenticate a particular user who is using an application.

The SAML flow occurs as shown below.
SAML Flow

Specific steps in this flow are:

  1. The enterprise user of the Lumen Cloud hits a URL that is dedicated to their account. The user is asked how they would like to log into the system and they choose SAML.

  2. The web application contacts the Lumen Cloud SAML service to initiate the SAML message exchange.

  3. The Lumen Cloud SP sends a digitally signed SAML authentication request to the enterprise IdP. This IdP takes the user's Kerberos token and validates them as a user on the enterprise network.

  4. The IdP returns a signed (and optionally, encrypted) SAML authentication response message to the Lumen Cloud SP. This message includes a Name ID assertion and that value is matched to a User record in the Lumen Cloud.

  5. The user is logged into the Lumen Cloud and operates under the roles and permissions assigned to their Lumen Cloud user account.

The steps below walk through the process of building an entire SSO and SAML scenario based on Microsoft Active Directory Federation Services as the IdP proxy. If you already have an identity provider, you can skip to step 3 where trust is established between Lumen Cloud and the IdP.

Steps

1. Provision server to act as Identity Provider.

  • Log into the Lumen Cloud Control Portal and choose to create a new Blueprint. Using the left navigation bar, choose Orchestration > Design Blueprint.

  • Include a single (Windows Server 2008 or above) server to the Blueprint and add packages to Install DNS, Install Active Directory, Reboot, Install IIS, and Add a Public IP. The DNS and Active Directory packages give us a custom domain to work with, and an identity directory for our user records. Microsoft Internet Information Services (IIS) provides a web application host for the Active Directory Federation Services (ADFS) web services used later on. Finally, the public IP address exposes our server to the public internet where applications (like the Lumen Cloud Control Portal) can access it for a SAML exchange.

Blueprint Designer

  • Publish the Blueprint and then locate it in the Blueprint library. Click the Deploy Blueprint button to initiate the provisioning process.

Deploy Blueprint

  • On the "Customize Blueprint" step of the deployment wizard, the user is asked to provide deploy-time build parameters such as the server password, host network, and Active Directory domain name. Note a few key values: first, the Primary DNS value must be equal to the name of the server being created. Recall that we already added DNS services to the server itself, so THIS is the domain that the new server should use for resolution. The Domain Name parameter typically contains the full name of the domain (including a suffix such as ".com") while the Net BIOS Name omits the suffix.

Server Build

  • Complete the deployment process and wait for the new server to be built by the Lumen Cloud Blueprint engine.

Blueprint Queue

  • Locate the server in the designated group and confirm its DNS value and public IP address.

Confirm Server Details

2. Install and configure Active Directory Federation Services.

  • Open client VPN software and connect to the Lumen Cloud network. Once authenticated, create a Remote Desktop session to the target server. In the Server Manager, confirm the installation of DNS, Active Directory, and IIS.

Server Manager

  • In order to issue cerificates easily from this server, install the Certificate Services role on the server. Choose the Certificate Authority role, select Enterprise CA, set this to a Root CA, and create a new private key. Finish the wizard.

Certificate Services

  • Open the IIS Manager, click the host name, and locate the Server Certificates feature.

Server Certificates

  • Double-click the Server Certificates icon and select the option on the right to Create Domain Certificate. On the first page of the wizard choose the common name (it could be a wildcard entry like tier3samldemo.com) and organizational details.

Create Certificate

  • On the next page of the wizard, choose the Certificate Authority and set the friendly name of the certificate.

Friendly Name

  • After completing the wizard (and creating a certificate that should show up in the Certificates MMC as a Personal certificate for the Computer account), right-click the Default Web Site in the IIS Manager and choose Edit Bindings. Here, we set the site to use our new certificate for SSL.

Add Site Binding

  • For users working with Windows Server 2008 or Windows Server 2008 R2, download ADFS 2.0 download from the Microsoft website. Windows Server 2012 comes with ADFS pre-installed. Run the ADFS Setup Wizard.

Setup Wizard

  • Select the Federation server role, and complete the short wizard. Once the wizard installs prerequisite software and finishes installing ADFS 2.0, choose the option to launch the ADFS Configuration Wizard.

Configuration Wizard

  • Choose to Create a new Federation Service, a Stand-alone federation server, and notice that the wizard pulls in the name of the certificate set for SSL in IIS.

Create New

  • When the wizard completes, notice the new ADFS configuration options.

New Options

  • Before proceeding, add a new user to the Active Directory. In the Server Manager, expand the Active Directory Domain Services node, then Active Directory Users and Computers, and then the domain.

Menu Expand

  • Right-click on the Users node and select New, then User. Add the details of this new user and save the settings.

New User

3. Create trust relationship with Lumen Cloud.

  • Prior to starting this step, See below to acquire the public certificate that validates the message coming from Lumen Cloud.
  • In the ADFS 2.0 Management console (or whatever IdP service that's being used), create a new Relying Party Trust. This is where the settings from the Lumen Cloud are added to the local IdP so that it recognizes the SAML authentication request and can validate the inbound signature.

Add Party Trust

  • Choose the option to add the relying party metadata manually.

Enter Data Manually

  • Name the relying party something like "Lumen Cloud Control Portal." Select the ADFS 2.0 profile. When asked for the Relying party trust identifier, use the following value (while filling in your specific account alias): https://alias.cloudportal.io/SAMLAuth. Note that this value is case-sensitive!

Configure Identifiers

  • Finish the wizard, and plan on addition a pair of additional values later on. On the last wizard page, click the checkbox to Open the Edit Claims Rules dialog. Here is where we define which Active Directory values (claims) map to the SAML attributes sent back to Lumen Cloud.

Select Rule Template

  • Set the source of attributes (Active Directory), choose the User-Principal-Name as the LDAP Attribute, set the Outgoing Claim Type to Name ID.

Configure Claim Rule

  • After completing this wizard, go back to the Relying Party Trusts folder and open the new entry. Switch to the Signatures tab, and add the certificate from below.

Properties

Add Endpoint

  • Finally, on the Advanced tab, change the Secure Hash Algorithm to SHA-1. Save the Relying Party Trust entry.

4. Configure Lumen Cloud account with SAML settings.

  • Log into the Lumen Cloud Control Portal and under Account menu, select the Users tab.

Users

  • Switch to the Authentication sub-section and check the box labeled SAML Authentication. This opens up a series of configuration settings.

SAML Config

  • For the SAML SSO URL,set the ADFS service URL. This includes the domain name the ADFS server. Even if you don't own the public domain name used here, enter the domain created for the local server.

SAML SSO URL

  • To get the Signing Certificate Key, return to the ADFS server, view the ADFS Management Console, and find the Certificates directory under the Services node. Notice the Token-signing certificate.

Token Signing

  • Choose to view the certificate (by right-clicking it), switch to the Details tab and select Copy to File. Export a Base-64 encoded X.509 certificate.

Export

  • Save the file to a known location on the file system. Open the file with a text editor and copy all of the text between the "Begin Certificate" and "End Certificate" indicators.

Cert

  • Paste this value into the Signing Certificate Key field in the Lumen Cloud Control Portal. Click the Save button and switch back to the Users List view. Select the user that you want to perform SSO with, and locate the SAML Username field. Since we chose above to use the Active Directory User Principal Name as the lookup value to the Lumen Cloud account, we must plug in the User Principal Name associated with this user.

SAML User

  • Save the user record.

5. Exchange SAML messages to perform Single Sign On.

  • Before testing, if you do not own the public domain name corresponding to the DNS name of your server, then your test will fail. To test successfully, change your local machine host file so that the browser translates the domain name to the public IP address of the server. When the SAML request comes in to ADFS, it tries to match the SAML Destination ID (retrieved from the SAML configuration in your Lumen Cloud account) to the Federation Service name in the ADFS server.

FS Properties

  • If the values do not match, then ADFS will return an exception. In order to test this scenario without registering and owning the corresponding public domain name, navigate to your local machine's host file (C:\Windows\System32\Drivers\etc\hosts) and add an entry that maps the public IP address of the server to the DNS name of the server.

hosts.txt

  • Go to a web browser and plug in https://alias.cloudportal.io. Here you can sign in via Lumen Cloud username and password, or choose the Sign In Using SAML option. If you choose the latter, then the Lumen Cloud SAML service redirects the browser to the URL specified in the account's SAML SSO URL setting.

Sign In Page

  • Clicking the Sign In Using SAML results in the following message being sent to the ADFS (or any IdP) service.
<samlp:AuthnRequest
  ID="--ID--"
  Version="2.0"
  IssueInstant="2012-12-06T21:30:41.385Z"
  Destination="https://tier3samldemo.com/adfs/ls/"
  ForceAuthn="false"
  IsPassive="false"
  ProtocolBinding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
  AssertionConsumerServiceURL="https://ALIAS.cloudportal.io/SAMLAuth/Post"
  xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
  <saml:Issuer xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion">https://ALIAS.cloudportal.io/SAMLAuth</saml:Issuer>
  <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
    <SignedInfo>
    <CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#" />
    <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" />
      <Reference URI="URI">
       <Transforms>
          <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
          <Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
      <InclusiveNamespaces PrefixList="#default samlp saml ds xs xsi" xmlns="http://www.w3.org/2001/10/xml-exc-14n#"/>
          </Transform>
        </Transforms>
        <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
        <DigestValue>VALUE</DigestValue>
      </Reference>
    </SignedInfo>
    <SignatureValue>VALUE</SignatureValue>
  <KeyInfo>
     <X509Data>
       <X509Certificate>CERTIFICATE</X509Certificate>
     </X509Data>
        </KeyInfo>
        </Signature>
  <samlp:NameIDPolicy AllowCreate="true" />
</samlp:AuthnRequest>
  • If the SAML request is successfully processed by the ADFS server, then ADFS sends a SAML response that the Lumen Cloud Control Portal uses to log in the federated user.
<samlp:Response ID="--ID--"
  Version="2.0"
  IssueInstant="2012-12-06T22:22:35.344Z"
  Destination="https://ALIAS.cloudportal.io/SAMLAuth/Post"
  Consent="urn:oasis:names:tc:SAML:2.0:consent:unspecified"
  InResponseTo="ID" xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
  <Issuer xmlns="urn:oasis:names:tc:SAML:2.0:assertion">http://tier3samldemo.com/adfs/services/trust</Issuer>
  <samlp:Status>
    <samlp:StatusCode Value="urn:oasis:names:tc:SAML:2.0:status:Success" />
  </samlp:Status>
  <Assertion ID="ID" IssueInstant="2012-12-06T22:22:35.303Z" Version="2.0" xmlns="urn:oasis:names:tc:SAML:2.0:assertion">
  <Issuer>http://tier3samldemo.com/adfs/services/trust</Issuer>
     <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
       <ds:SignedInfo>
    <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#" />
    <ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" />
    <ds:Reference URI="URI">
       <ds:Transforms>
         <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
         <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#" />
       </ds:Transforms>
       <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
       <ds:DigestValue>VALUE</ds:DigestValue>
    </ds:Reference>
    </ds:SignedInfo>
      <ds:SignatureValue>VALUE</ds:SignatureValue>
      <KeyInfo mlns="http://www.w3.org/2000/09/xmldsig#">
        <ds:X509Data>
          <ds:X509Certificate>CERTIFICATE</ds:X509Certificate>
        </ds:X509Data>
      </KeyInfo>
      </ds:Signature>
      <Subject>
    <NameID>rseroter@tier3samldemo.com</NameID>
     <SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer">
    <SubjectConfirmation Data InResponseTo="ID"
      NotOnOrAfter="2012-12-06T22:27:35.346Z"
      Recipient="https://ALIAS.cloudportal.io/SAMLAuth/Post" />
    </SubjectConfirmation>
       </Subject>
       <Conditions NotBefore="2012-12-06T22:22:34.417Z" NotOnOrAfter="2012-1206T23:22:34.417Z">
    <AudienceRestriction>
      <Audience>https://ALIAS.cloudportal.io/SAMLAuth</Audience>
    </AudienceRestriction>
       </Conditions>
       <AuthnStatement AuthnInstant="2012-12-06T22:22:33.401Z" SessionIndex="ID">
    <AuthnContext>
      <AuthnContextClassRef>urn:federation:authentication:windows</AuthnContextClassRef>
    </AuthnContext>
       </AuthnStatement>
    </Assertion>
</samlp:Response>

  • The user experience when clicking that button is that the user is prompted for credentials (if the user is not hitting the website from within the domain itself) and once provided, the user is automatically logged into the Lumen Cloud portal. Because they used Single Sign On and SAML, they did NOT have to enter their Lumen Cloud account credentials, but rather, were able to use their regular network credentials.

Updated Signing Certificate (February 2021)

Customers with an existing SAML configuration as of Thursday, January 28, 2021 6:00:00 AM MNT will need to update their signing certificate for use with their IdP with the following text:

-----BEGIN CERTIFICATE-----
MIIGVTCCBT2gAwIBAgIQBDou9Isea7tFrlotW5DwOzANBgkqhkiG9w0BAQsFADBP
MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMSkwJwYDVQQDEyBE
aWdpQ2VydCBUTFMgUlNBIFNIQTI1NiAyMDIwIENBMTAeFw0yMTAxMTIwMDAwMDBa
Fw0yMjAyMTIyMzU5NTlaMGkxCzAJBgNVBAYTAlVTMRIwEAYDVQQIEwlMb3Vpc2lh
bmExDzANBgNVBAcTBk1vbnJvZTEaMBgGA1UEChMRQ2VudHVyeUxpbmssIEluYy4x
GTAXBgNVBAMMECouY2xvdWRwb3J0YWwuaW8wggEiMA0GCSqGSIb3DQEBAQUAA4IB
DwAwggEKAoIBAQDedX4tHHPBTbrmqJtxnl8w4vUSEjtLhsyNGUPhuTT8fMTVO/FZ
GoP0jmBEmL7nLaX2vsuWHgr70w4fAyB3Ur35Dr/N0H3cWtakf+s/FprOGb8ZM7o+
izbUBSu6rccV69prRsC9gkR8t6hsp+LSVT6aT/Dxrmx6DKpSoqbaPxrqIZavWh5O
69YZbbkwnoE60PdV50bIl8CZ9QdLb4YI2bJ4MH352eXsGKKs/o/lkcxl7AR2/VvB
/J1mTYDgSGuKWipB4xF6h24i8tZSBTuDbsLAinpOuIic4bdJ79Hae8EcIjbDQw2F
jcItC0Hb/r/FeI67iO4VqMn2nAGrNjQwO2otAgMBAAGjggMRMIIDDTAfBgNVHSME
GDAWgBS3a6LqqKqEjHnqtNoPmLLFlXa59DAdBgNVHQ4EFgQUag1sVRiG6Bx+NQoU
mSUPXvP8AGswKwYDVR0RBCQwIoIQKi5jbG91ZHBvcnRhbC5pb4IOY2xvdWRwb3J0
YWwuaW8wDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEF
BQcDAjCBiwYDVR0fBIGDMIGAMD6gPKA6hjhodHRwOi8vY3JsMy5kaWdpY2VydC5j
b20vRGlnaUNlcnRUTFNSU0FTSEEyNTYyMDIwQ0ExLmNybDA+oDygOoY4aHR0cDov
L2NybDQuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0VExTUlNBU0hBMjU2MjAyMENBMS5j
cmwwSwYDVR0gBEQwQjA2BglghkgBhv1sAQEwKTAnBggrBgEFBQcCARYbaHR0cDov
L3d3dy5kaWdpY2VydC5jb20vQ1BTMAgGBmeBDAECAjB9BggrBgEFBQcBAQRxMG8w
JAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmRpZ2ljZXJ0LmNvbTBHBggrBgEFBQcw
AoY7aHR0cDovL2NhY2VydHMuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0VExTUlNBU0hB
MjU2MjAyMENBMS5jcnQwDAYDVR0TAQH/BAIwADCCAQUGCisGAQQB1nkCBAIEgfYE
gfMA8QB3ACl5vvCeOTkh8FZzn2Old+W+V32cYAr4+U1dJlwlXceEAAABdvgMZTkA
AAQDAEgwRgIhAJmc2R/n55L1KjFfB1B0E1wXd6qRljflJQQvv/yvNo/DAiEA4zws
gWZUySaT0gqf6mJAboL2meOoOB/T1Hxq6ZXIlZ4AdgAiRUUHWVUkVpY/oS/x922G
4CMmY63AS39dxoNcbuIPAgAAAXb4DGWRAAAEAwBHMEUCIQDUncYGDHPRNWeZQe9E
vkODSVEfj0l3a0gbq8SyUyI4uAIgFiAbkHodZAoI3babYASoaFJr+vU8oBGVNOuR
mw5EntIwDQYJKoZIhvcNAQELBQADggEBADx2uAH0PHW66LLJu9WC6HiQ7GLqfo1Z
hsK4dRfS7AkiHsyoGtPsy8AYgjuxnBhsJ7JxE2xbYfXc/eQiDk9eY91qgUnSRfEf
cc+Xl/M2IWhBwHsbbImyK+CeQMCDqEoWmEp+VkY00NZcuiyBa0REkRLcZRU1icst
z+9KCqyNpQ+TDYEuzwOguKm2CA5miwq1mhcI/7UwiAf7zeVJgRxINpSw01AIAyvk
96QtTfRi0AeaNZk1B+411TBnMfK8MRiNmbyQaZFFSLjEEDVgSXKB2uTEy3bk2Zz8
htQk6/fymWaT/cbsbuU2U2WVwV35gwbvNfK+V+3wH20IMTSQ0b7zx90=
-----END CERTIFICATE-----