Open Telekom Cloud

Setting up MIRACL Trust SSO as an Identity Provider within Open Telekom Cloud

These instructions are up-to-date at the time of writing, but you should refer back to official OTC documentation to check for any changes. We cannot guarantee the accuracy of our SP-specific guidance.

  1. Log in to the Open Telekom Cloud management console.

  2. Choose Mgmt & Deployment > Identity and Access Management.

  3. In the navigation pane, choose Identity Provider
    The following window is displayed.

  4. Click Create Identity Provider
    The following dialog box is displayed.

  5. Set Name, Protocol(SAML), and Status(enabled) and fill in Description(optional).

  6. Click OK.
    A confirmation message is displayed which disappears after a few seconds.

  7. Click the Edit link against the IdP that was just created.

  8. Upload the MIRACL Trust metadata by pointing to the locally saved .xml file: The metadata can be downloaded from http://<yourssoip>/metadata. Note that, for a production setup, if you manually download your IdP metadata file, the validUntil date at the top of the file will need to be edited to an appropriate date (it defaults to 48hrs from the current date).

  9. Set the Identity Conversion Rule by clicking on Edit Rule. The following Identity Conversion Rule is based on a regular expression and would let anyone with identity `@yourcompany.com` domain log in.

[
  {
    "local": [
      {
        "user": {
          "name": "{0}"
        }
      },
      {
        "group": {
          "name": "{1}"
        }
      }
    ],
    "remote": [
      {
        "type": "__NAMEID__"
      },
      {
        "type": "groups"
      },
      {
        "any_one_of": [
          ".*@yourcompany.com"
        ],
        "regex": true,
        "type": "__NAMEID__"
      }
    ]
  }
]

Configuring your Open Telekom Cloud profile with MIRACL Trust SSO

  1. Edit /etc/miracl-sso/service_providers/otc.yaml
profile:
  attribute:
    tsystems_otc_admin: >-
      <AttributeStatement>
        <Attribute FriendlyName="mail" Name="urn:oid:0.9.2342.19200300.100.1.3" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri">
          <AttributeValue>{{.SessionUserEmail}}</AttributeValue>
        </Attribute>
        <Attribute FriendlyName="groups" Name="urn:oid:1.3.6.1.4.1.5923.1.1.1.6" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri">
          <AttributeValue>restricted</AttributeValue>
        </Attribute>
      </AttributeStatement>
sp:
  otc:
    description: T-Systems OTC
    issuer: https://auth.otc.t-systems.com
    relay_state: ""
    login_url: https://auth.otc.t-systems.com/authui/federation/websso?domain_id=***&amp;idp=miracl-sso&amp;protocol=saml
    logout_url: https://console.otc.t-systems.com/iam/logout
    metadata: >-
      <!-- insert downloaded SP metatadata here -->
    sign_response: true
    sign_assertion: false
    encrypt_assertion: true
    authorize:
    - - email: ^[^@]+@example.com$
    profile:
      attribute: tsystems_otc_admin

  1. Note that sp name is used to create your IdP-initiated login url, i.e. https://<yourssoip>/login/otc

  2. The above login_url is what has been issued to you by the OTC admin console, as seen in point 4 in the first section of this guide.

  3. Note also that the previously configured SAML attribute is invoked with attribute: tsystems_otc_admin

  4. The OTC SP metadata is available from https://auth.otc.t-systems.com/authui/saml/metadata.xml and should be pasted into the above metadata field.

The downloaded metadata file must be converted to a single line with a command such as:

echo -e "\n"$(cat metadata.xml | tr -d '\n')"\n"

The contents will then be output in the terminal in a format that can be pasted into the metadata field.

If you are using JSON format for your config file, the downloaded XML file must be converted to a single line and the " characters need to be escaped with \ to meet the json structure requirements. This can be achieved by running the following command on the downloaded metadata.xml file:

echo -e "\n"$(cat metadata.xml | tr -d '\n' | sed -E 's/"/\\"/g')"\n"

The contents will then be output in the terminal in a format that can be pasted into the metadata field of a JSON file.

  1. In the authorize subsection, you can control what users are allowed to attempt login by following one or both of the below steps:
  • Call up an LDAP setup from an ldap.yaml file stored in /etc/miracl-sso/integrations.
  • Configure a regex list of email addresses/domains. The above config shows an example of how you would use email: ^[^@]+@example.com$ to only allow users from a certain email domain to login.

Note that if this is not set correctly, you will receive ‘unauthorized user’ messages.

For more detailed info on using LDAP and regex to control authorized users, please see the LDAP and authorization menu section

  1. Save and close the file.

  2. In your /etc/miracl-sso/config.yaml file make sure you add otc.yaml to the list of ‘includes’:

includes:
  - core.yaml

# service providers
  - service_providers/otc.yaml

  1. As always after config changes, restart the server with sudo service miracl-sso restart

  2. Now your service is configured, you can visit https://<yourssoip>/login/otc or https://<yourssoip>/services to login to the service using IdP-initiated login, or visit the OTC login page and SP-initiated login will be triggered automatically.

  3. You will be able to login using the in-browser PIN pad or with the MIRACL Trust app. When logging in to your SSO service for the first time you will be asked to register an email address so as to confirm your identity and register you as a user.