Configuring SAML Authentication with Workspace One for Avi Controller

Overview

The Avi Controller offers multiple options for integrating the management console into enterprise environments for authentication management. Security Assertion Markup Language (SAML) is one of the options available. SAML enables integration into VMware Workspace ONE and take advantage of the App Catalog, network access restrictions and step-up authentication when administrators sign in.

Prerequisites

Before initiating the configuration, ensure the following prerequisites are done:

  • A DNS record is in place for the Avi Controller. This will be used for the fully qualified domain name (FQDN) that is used when signing into the system.

  • Get the Workspace One Access IDP metadata. Follow the steps below to download the file idp.xml file.

    1. Log in to your Workspace ONE Access administrator console.

    2. Navigate to Catalog > Settings as shown below:

      Metadata

    3. In the left pane, under SaaS Apps, click on SAML Metadata.

      Metadata

    4. In the Download SAML Metadata tab, click on Copy URL next to Identity Provider (IdP) metadata.

      Metadata

    5. Open the idp.xml file using a text editor.

SAML Configuration in Avi

To configure an authentication profile to support SAML on the Avi Controller,

  1. Log in to the Avi Controller with admin credentials.

  2. Navigate to Templates > Security > Auth Profile.

  3. Enter the Name of the auth profile.

  4. Select SAML as the Type of auth profile.

    SAML

  5. Copy the contents of the idp.xml file and paste in the IDP Metadata field.

    SAML

  6. Select Use DNS FQDN as the Entity Type.

  7. Enter the service provider organization details, as required.

  8. Enter the FQDN to be used for the SAML configuration.

  9. Click on Save.

Collecting Service Provider Metadata

Avi Vantage does not generate an xml file that can be imported into Workspace ONE Access. So, the metadata must be entered manually.

The following details must be collected:

  • Entity ID

  • SSO URL

  • Signing Certificate

The entity ID and the SSO URL can be obtained from the Service Provider Settings screen.

To get the service provider settings,

  1. In the Avi Vantage UI, navigate to Templates > Security > Auth Profile.

  2. Identify the authentication profile created and click on the verify icon as shown below:

    SAML

  3. From the Service Provider Settings screen, copy the Entity ID and the SSO URL and paste them in a text editor.

    SAML

  4. Close the Service Provider Settings screen.

To get the signing certificate,

  1. From the Avi UI, navigate to Templates > Security > SSL/ TLS Certificates.

  2. Find the System-Default-Portal-Cert and click on the Export icon as shown below:

    SAML

  3. From the Export Certificate screen, click on Copy to clipboard below the Certificate to copy the details.

    SAML

  4. Paste the details into a text editor.

  5. Click on Done.

Configuring the Avi Catalog Item in Workspace One Access

Now that the SAML profile is created in the Avi Controller, now, the Workspace ONE catalog entry must be created.

To create the Workspace ONE catalog entry,

  1. Log in to your Workspace ONE Access administrator console.

  2. Navigate to the Catalog tab.

  3. Click on New.

    SAML

  4. In the New SAAS Application screen, enter a Name for the new Avi entry in the App Catalog.

  5. If you have an icon to use, click on Select File and upload the icon for the application.

    SAML

  6. Click on Next.

  7. Enter the following details:

    • Authentication Type: SAML 2.0
    • Configuration Type: Manual
    • Single Sign-on URL: Use the single sign-on URL copied from the Service Provider Settings screen in Avi.
    • Recipient URL: Same as the Single Sign-On URL
    • Application ID: Use the Entity ID copied from the Service Provider Settings screen in Avi.

    The New SAAS Application screen is as shown below:

    SAML

    • Username Format: Unspecified
    • Username Value: ${user.email}
    • Relay State URL: The FQDN or IP address of your appliance
  8. Click on Advanced Properties to expand it.

    SAML

  9. Enable the properties as shown below:

    SAML

  10. Copy the value of the System-Default-Portal-Cert certificate and paste it into the Request Signature field.

    SAML

  11. Enter the FQDN or IP address of the appliance as the Application Login URL. This enables SP-initiated login workflows.

  12. Click on Next.

  13. Select the Access Policies to use for this application. This determines the rules used for authentication and access to the application.

    SAML

  14. Click on Next.

  15. Review the summary of the configuration.

  16. Click on Save & Assign.

    SAML

  17. Select the users or groups that will have access to this application and the deployment type.

    SAML

  18. Click on Save.

Enabling SAML Authentication in Avi

After creating SAML profile in Avi, and a SAML catalog item in Workspace One Access, we can enable SAML and grant superuser rights to SAML users.

Note: It is possible to configure more granular role-based access control by adding application parameters into the Workspace One Access catalog item and then mapping those parameters to different roles in Avi Vantage. For more information, refer to Authorization: Tenant and Role Mapping Examples

To enable SAML and map user roles,

  1. Log in to the Avi Controller with admin credentials.

  2. Navigate to Administration > Settings > Authentication/Authorization.

    SAML

  3. Under Authentication, select Remote.

  4. Under Auth Profile, select the SAML profile that was created earlier.

    SAML

  5. Ensure that the Allow Local User Login option is checked. If this option is not selected, and there is a configuration issue, you will not be able to log back into the Controller.

  6. Click on Save.

  7. On saving the authorization details, the New Mapping option appears as shown below:

    SAML

  8. Click on New Mapping and in the New Tenant and Role Mapping screen enter the details as shown below:

    SAML

  9. Click on Save.

SAML authentication is now configured on the Avi Controller.

Suggested Reading