Configure SAML Authentication

To configure SAML single sign-on (SSO) and single logout (SLO), you must register the firewall and the IdP with each other to enable communication between them. If the IdP provides a metadata file containing registration information, you can import it onto the firewall to register the IdP and to create an IdP server profile. The server profile defines how to connect to the IdP and specifies the certificate that the IdP uses to sign SAML messages. You can also use a certificate for the firewall to sign SAML messages. Using certificates is optional but recommended to secure communications between the firewall and the IdP.
Palo Alto Networks requires HTTPS to ensure the confidentiality of all SAML transactions instead of alternative approaches such as encrypted SAML assertions. To ensure the integrity of all messages processed in a SAML transaction, Palo Alto Networks strongly recommends requiring digital certificates to cryptographically sign all messages.
The following procedure describes how to configure SAML authentication for end users and firewall administrators. You can also configure SAML authentication for Panorama administrators.
SSO is available to administrators and to GlobalProtect and Captive Portal end users. SLO is available to administrators and GlobalProtect end users, but not to Captive Portal end users.
Administrators can use SAML to authenticate to the firewall web interface, but not to the CLI.
  1. (
    Recommended
    ) Obtain the certificates that the IdP and firewall will use to sign SAML messages.
    If the certificates don’t specify key usage attributes, all usages are allowed by default, including signing messages. In this case, you can Obtain Certificates by any method.
    If the certificates do specify key usage attributes, one of the attributes must be Digital Signature, which is not available on certificates that you generate on the firewall or Panorama. In this case, you must import the certificates:
    • Certificate the firewall uses to sign SAML messages
      —Import the certificate from your enterprise certificate authority (CA) or a third-party CA.
    • Certificate the IdP uses to sign SAML messages
      —Import a metadata file containing the certificate from the IdP (see the next step). The IdP certificate is limited to the following algorithms:
      Public key algorithms
      —RSA (1,024 bits or larger) and ECDSA (all sizes). A firewall in FIPS/CC mode supports RSA (2,048 bits or larger) and ECDSA (all sizes).
      Signature algorithms
      —SHA1, SHA256, SHA384, and SHA512. A firewall in FIPS/CC mode supports SHA256, SHA384, and SHA512.
  2. Add a SAML IdP server profile.
    The server profile registers the IdP with the firewall and defines how they connect.
    In this example, you import a SAML metadata file from the IdP so that the firewall can automatically create a server profile and populate the connection, registration, and IdP certificate information.
    If the IdP doesn’t provide a metadata file, select
    Device
    Server Profiles
    SAML Identity Provider
    ,
    Add
    the server profile, and manually enter the information (consult your IdP administrator for the values).
    1. Export the SAML metadata file from the IdP to a client system that the firewall can access.
      The certificate specified in the file must meet the requirements listed in the preceding step. Refer to your IdP documentation for instructions on exporting the file.
    2. Select
      Device
      Server Profiles
      SAML Identity Provider
      and
      Import
      the metadata file onto the firewall.
    3. Enter a
      Profile Name
      to identify the server profile.
    4. Browse
      to the
      Identity Provider Metadata
      file.
    5. (
      Recommended
      ) Select
      Validate Identity Provider Certificate
      (default) to have the firewall validate the
      Identity Provider Certificate
      .
      Validation occurs only after you assign the server profile to an authentication profile and
      Commit
      . The firewall uses the
      Certificate Profile
      in the authentication profile to validate the certificate.
      Validate the certificate to ensure it hasn’t been compromised and to improve security.
    6. Enter the
      Maximum Clock Skew
      , which is the allowed difference in seconds between the system times of the IdP and the firewall at the moment when the firewall validates IdP messages (default is 60; range is 1 to 900). If the difference exceeds this value, authentication fails.
    7. Click
      OK
      to save the server profile.
    8. Click the server profile Name to display the profile settings. Verify that the imported information is correct and edit it if necessary.
  3. Configure an authentication profile.
    The profile defines authentication settings that are common to a set of users.
    1. Select
      Device
      Authentication Profile
      and
      Add
      a profile.
    2. Enter a
      Name
      to identify the profile.
    3. Set the
      Type
      to
      SAML
      .
    4. Select the
      IdP Server Profile
      you configured.
    5. Select the
      Certificate for Signing Requests
      .
      The firewall uses this certificate to sign messages it sends to the IdP. You can import a certificate generated by your enterprise CA or you can generate a certificate using the root CA that was generated on the firewall or Panorama.
    6. (
      Optional
      )
      Enable Single Logout
      (disabled by default).
    7. Select the
      Certificate Profile
      that the firewall will use to validate the
      Identity Provider Certificate
      .
    8. Enter the
      Username Attribute
      that IdP messages use to identify users (default
      username
      ).
      When you predefine dynamic administrator roles for users, use lower-case to specify the role (for example, enter
      superreader
      , not
      SuperReader
      ). If you manage administrator authorization in the IdP identity store, specify the
      Admin Role Attribute
      and
      Access Domain Attribute
      also.
    9. Select
      Advanced
      and
      Add
      the users and user groups that are allowed to authenticate with this authentication profile.
    10. Click
      OK
      to save the authentication profile.
  4. Assign the authentication profile to firewall applications that require authentication.
    1. Assign the authentication profile to:
      • Administrator accounts that you manage locally on the firewall. In this example, Configure a Firewall Administrator Account before you verify the SAML configuration later in this procedure.
      • Administrator accounts that you manage externally in the IdP identity store. Select
        Device
        Setup
        Management
        , edit the Authentication Settings, and select the
        Authentication Profile
        you configured.
      • Authentication policy rules that secure the services and applications that end users access through Captive Portal. See Configure Authentication Policy.
      • GlobalProtect portals and gateways that end users access.
    2. Commit
      your changes.
      The firewall validates the
      Identity Provider Certificate
      that you assigned to the SAML IdP server profile.
  5. Create a SAML metadata file to register the firewall application (management access, Captive Portal, or GlobalProtect) on the IdP.
    1. Select
      Device
      Authentication Profile
      and, in the Authentication column for the authentication profile you configured, click
      Metadata
      .
    2. In the
      Commands
      drop-down, select the application you want to register:
      • management
        (default)—Administrative access to the web interface.
      • captive-portal
        —End user access to services and applications through Captive Portal.
      • global-protect
        —End user access to services and applications through GlobalProtect.
    3. (
      Captive Portal or GlobalProtect only
      ) for the
      Vsysname Combo
      , select the virtual system in which the Captive Portal settings or GlobalProtect portal are defined.
    4. Enter the interface, IP address, or hostname based on the application you will register:
      • management
        —For the
        Management Choice
        , select
        Interface
        (default) and select an interface that is enabled for management access to the web interface. The default selection is the IP address of the MGT interface.
      • captive-portal
        —For the
        IP Hostname
        , enter the IP address or hostname of the
        Redirect Host
        (see
        Device
        User Identification
        Captive Portal Settings
        ).
      • global-protect
        —For the
        IP Hostname
        , enter the hostname or IP address of the GlobalProtect portal or gateway.
    5. Click
      OK
      and save the metadata file to your client system.
    6. Import the metadata file into the IdP server to register the firewall application. Refer to your IdP documentation for instructions.
  6. Verify that users can authenticate using SAML SSO.
    For example, to verify that SAML is working for access to the web interface using a local administrator account:
    1. Go to the URL of the firewall web interface.
    2. Click
      Use Single Sign-On
      .
    3. Enter the username of the administrator.
    4. Click
      Continue
      .
      The firewall redirects you to authenticate to the IdP, which displays a login page. For example:
      saml_sso_login-page_3.png
    5. Log in using your SSO username and password.
      After you successfully authenticate on the IdP, it redirects you back to the firewall, which displays the web interface.
    6. Use your firewall administrator account to request access to another SSO application.
      Successful access indicates SAML SSO authentication succeeded.

Related Documentation