A SAML SP service is a type of AAA service in Access Policy Manager (APM ). It requests authentication from an external SAML Identity Provider (IdP) that is specified on APM in a SAML IdP connector. (You bind a SAML service provider (SP) service to one or more SAML IdP connectors.) APM requests authentication from an IdP and consumes assertions from it to allow access to resources behind APM.

On a BIG-IP system that you use as a SAML service provider (SP), you can bind an SP service to one or more SAML Identity Provider (IdP) connectors (each of which specifies an external IdP). When you bind an SP service to multiple IdP connectors, Access Policy Manager chooses the correct IdP connector at run time through a filtering and matching process called IdP discovery.

Logon Page action customization

These are some common customization examples for the Logon Page action.

Setting the value of session.logon.last.domain variable to the domain name only

Select Yes for Split domain from full Username. The Logon Page agent takes the user name, such as joe@office.com, that was entered and creates the following session variables with these values.

Session Variable	Value
%{session.logon.last.username}	joe
%{session.logon.last.domain}	office.com
%{session.logon.last.logonname}	joe@office.com

Obtaining and email address as the username

Change the prompt for the first field (username field). To omit the password, select Type none.

An IdP connector specifies how a BIG-IP system, configured as a SAML service provider (SP), connects with an external SAML identity provider (IdP).

You can use one or more of these methods to configure SAML identity provider (IdP) connectors in Access Policy Manager (APM).

• From metadata - Obtain a metadata file from the vendor and import it into APM. The advantage to this method is that the vendor provides all required data, including the certificate. You can complete the configuration by simply typing a unique name for the identity provider, and browsing to and importing the file. APM imports the certificate to the BIG-IP system and configures the SAML IdP connector.
• From template - Use templates that APM provides for some vendors. The advantages to this method are that:
  • Most required data is included in the template. (Note that the certificate is not included.)
  • Additional required data is minimal and is available from the vendor.
  APM configures the SAML IdP connector. You must obtain a certificate from the vendor and import it into the BIG-IP system.
• Custom - Research the identity provider requirements and type all settings into the Configuration utility. Use this method when a metadata file or a template for an identity provider is not available. APM configures the SAML IdP connector. You must obtain a certificate from the vendor and import it into the BIG-IP system.
• IdP Automation - Provide files with cumulative IdP metadata on remote systems, then configure BIG-IP IdP automation to poll the files periodically and create IdP connectors and bind them to a specific service provider (SP) service.

This flowchart illustrates the process for configuring a BIG-IP system as a SAML service provider (SP). In this configuration, the BIG-IP system relies on external SAML Identity Providers (IdPs).

1. On the Main tab, click Access Policy > SAML > BIG-IP as IdP. The BIG-IP as IdP screen opens and displays a list of local IdP services.
2. On the menu bar, click External IdP Connectors. A list of SAML IdP connectors displays.
3. Click Create > Custom. The Create New IdP Connector screen opens.
4. In the Name field, type a unique name for the SAML IdP connector.
5. In the IdP Entity ID field, type a unique identifier for the IdP. This is usually a URI. Obtain this value from the vendor.
6. From the left pane, select Endpoint Settings. The screen changes to display the applicable settings.
7. In the Single Sign On Service URL field, type the location on the IdP where APM should send authentication requests.
8. Optional: From the Single Sign On Service Binding field, select how APM should send authentication requests to the IdP:
   • POST (the default value)
   • Redirect
9. From the left pane, select Assertion Settings.
10. From Identity Location, select where to find the principal (usually, this is a user) to be authenticated:
    • Subject - In the subject of the assertion. This is the default setting.
    • Attribute - In an attribute. If selected, the Identity Location Attribute field displays and you must type an attribute name into it.
      Note: If the assertion from the IdP does not include this attribute, the BIG-IP system (as SP) does not accept the assertion as valid.
11. Select Security Settings from the left pane.
    1. Optional: Select a setting from the Must be signed list. The default setting is No. The setting indicates whether APM must sign the authentication requests it sends to this IdP.
    2. From Certificate Settings, select a certificate from the IdP's Assertion Verification Certificate list. The BIG-IP system uses this certificate from the IdP to verify the signature of the assertion from the IdP. If the certificate from the IdP is not in the BIG-IP system store, obtain it and import it into the store. Then edit this IdP connector to select the certificate for it.
12. Select SLO Service Settings from the left pane.
    1. Optional: In the Single Logout Request URL field, type a URL at the SAML Identity Provider where Access Policy Manager sends the logout request when a service provider initiates a logout.
    2. In the Single Logout Response URL field, type a URL for the SAML Identity Provider where APM sends the logout response when the IdP initiates the logout request.
    Note: APM supports HTTP-POST binding for the SLO service. For SLO to work, all entities (SPs and IdPs) must support SLO.
13. Click OK. The screen closes.

1. On the Main tab, click Local Traffic > Virtual Servers. The Virtual Server List screen opens.
2. Click the Create button. The New Virtual Server screen opens.
3. In the Name field, type a unique name for the virtual server.
4. For the Destination setting, select Host and in the Address field, type the IP address for the virtual server.
5. In the Service Port field, type 443 or select HTTPS from the list.
6. For the HTTP Profile setting, verify that the default HTTP profile, http, is selected.
7. For the SSL Profile (Client) setting, from the Available list, select the name of the Client SSL profile you previously created, and using the Move button, move the name to the Selected list.
8. For the SSL Profile (Server) setting, from the Available list, select the name of the Server SSL profile you previously created, and using the Move button, move the name to the Selected list.
9. Click Finished.

1. On the Main tab, click Access Policy > SAML > BIG-IP as IdP. The BIG-IP as IdP screen opens and displays a list of local IdP services.
2. Click Create. The Create New SAML SP Service screen opens.
3. In the Name field, type a unique name for the SAML SP service.
4. In the Entity ID field, type a unique identifier for the service provider that includes the URI that points to the virtual server with the BIG-IP system and a unique path. For example, if you type https://bigip-sp/sp, then https:/bigip-sp points to the virtual server you use for APM as a SAML service provider and "/sp" is a unique string that APM uses to distinguish one service provider from another on this BIG-IP system.
   Note: The path is not a physical path on the BIG-IP system, but a string that distinguishes one SAML SP service from another when multiple SAML SP services are configured on this BIG-IP system.
5. Optional: In the Relay State field, type a value. The value can be an absolute path, such as hr/index.html or a URI, such as https://www.abc.com/index.html. It is where the service provider redirects users after they are successfully authenticated and have been allowed by the access policy. When APM receives the relay state from the Identity Provider in addition to assertion, then it uses the value received from the IdP to redirect the user. Otherwise, APM uses the value from this configuration.
6. From the left pane, select Security Settings. The screen changes to display the applicable settings.
   1. Select Signed Authentication Request if you want this BIG-IP system to send signed authentication requests to the SAML IdP.
   2. Select Want Encrypted Assertion if this BIG-IP system requires encrypted assertions from the SAML IdP.
   3. Select Want Signed Assertion if the BIG-IP service provider system requires signed assertions from the SAML IdP. This is selected by default. It is recommended that it be selected.
   4. From SP's Authentication Signing/Assertion Decryption Private Key, select a key from the BIG-IP system store on this device. You can select a private key only when you select at least one of these check boxes: Signed Authentication Request and Want Encrypted Assertion. APM uses this private key to sign the authentication request to the IdP and to decrypt an encrypted assertion from the IdP.
   5. From SP Certificate, select a certificate. APM includes this certificate in the SAML SP metadata that you export. After the SAML SP metadata is imported on the IdP, the IdP can use this certificate to verify a signed authentication request and to encrypt an assertion.
7. Click OK. The screen closes.

1. On the Main tab, click Access Policy > SAML > BIG-IP as IdP. The BIG-IP as IdP screen opens and displays a list of local IdP services.
2. Select a SAML SP service from the list.
3. Click Bind/Unbind IdP Connectors. A pop-up screen displays a list of any IdP connectors that are associated with this SP service.
4. To add an SAML IdP connector to the list, click Add New Row.
5. To bind only one IdP connector with this SP service, complete the configuration:
   1. Select a connector from the SAML IdP Connectors list in the new row. When you bind only one IdP connector to an SP service, you do not need to fill in the Matching Source and Matching Value fields.
   2. Click the Update button. The configuration is not saved until you click OK.
   3. Click OK. APM saves the configuration. The screen closes.
6. To bind multiple IdP connectors with this SP service, complete the configuration:
   1. Select a connector from the SAML IdP Connectors list in the new row.
   2. In the Matching Source column, select or type the name of a session variable. Use a session variable only if it is populated in the access policy before the SAML Auth action. For example, select %{session.server.landinguri} or type %{session.logon.username}.
   3. In the Matching Value column, type a value. The value can include the asterisk (*) wild card. For example, type *hibb* or south* .
   4. Click the Update button. The configuration is not saved until you click OK.
   5. To add other IdP connectors, start by clicking Add New Row, fill the new row, and end by clicking Update.
   6. Click OK. APM saves the configuration. The screen closes.

1. On the Main tab, click Access Policy > SAML > BIG-IP as IdP. The BIG-IP as IdP screen opens and displays a list of local IdP services.
2. Select an SP service from the list and click Export Metadata. A popup window opens, displaying No on the Sign Metadata list.
3. For APM to sign the metadata, perform these steps:
   1. Select Yes from the Sign Metadata list.
   2. Select a key from the Signing Key list. APM uses the key to sign the metadata.
   3. Select a certificate from the Signature Verification Certificate list. APM exports the certificate to the metadata file. The system on which you import the metadata file can use the certificate to verify the metadata signature.
4. Select OK. APM downloads an XML file.

1. On the Main tab, click Access Policy > Access Profiles. The Access Profiles List screen opens.
2. In the Access Policy column, click the Edit link for the access profile you want to configure. The visual policy editor opens the access policy in a separate screen.
3. Click the (+) icon anywhere in the access policy to add a new action item. A popup screen opens, listing predefined actions on tabs such as General Purpose, Authentication, and so on.
4. On the Authentication tab, select SAML Auth and click the Add Item button. The SAML Auth properties window opens.
5. In the SAML Authentication SP area from the AAA Server list, select a SAML SP service and click Save. The Access Policy window displays.
6. Add any additional actions that you require to complete the policy.
7. Change the Successful rule branch from Deny to Allow and click the Save button.
8. At the top of the window, click the Apply Access Policy link to apply and activate your changes to this access policy.
9. Click the Close button to close the visual policy editor.

Simple access policy to authenticate users against an external SAML IdP

1. On the Main tab, click Local Traffic > Virtual Servers. The Virtual Server List screen opens.
2. Click the name of the virtual server you want to modify.
3. In the Access Policy area, from the Access Profile list, select the access profile.
4. Click Update to save the changes.