Okta

Okta Inc. is an identity and access management company that provides technologies that enable secure user authentication into applications. In this guide, we integrate the Okta IdP to authenticate users into the Wazuh platform.

The single sign-on integration process is divided into three stages.

  1. Okta Configuration

  2. Wazuh indexer configuration

  3. Wazuh dashboard configuration

Okta Configuration

  1. Create an account on Okta. Request a free trial if you don't have a paid license.

  2. Create a new user.

    1. From your okta admin console page, navigate to Directory > People.

    2. From the People section, select Add Person, fill in the details of the new user, and click Save as seen in the following screenshots.

  3. Create a new group. Navigate to Directory > Groups and add a group.

    Create a new group using any name. In our case, we name it wazuh-admin. This name will be used as our backend_roles in roles_mapping.yml.

  4. Add the new user to the new group. Navigate to Directory > Groups and select your group. Click on Assign People and add the user to the group created.

  5. Create a new app. Configure the SAML settings while you create the app.

    1. Navigate to the Applications section in Okta. Select Create App Integration.

    2. In the Create a new application integration window, select SAML 2.0 and click Next.

    3. Assign a name to the application. In our case, we assign the name wazuh-sso-app.

    4. In the Configure SAML menu, you’ll find the SAML Settings section, modify the following parameters:

      • Single sign on URL: input https://<WAZUH_DASHBOARD_URL>/_opendistro/_security/saml/acs and replace the <WAZUH_DASHBOARD_URL> field with the corresponding URL.

      • Audience URI (SP Entity ID): input wazuh-saml. This is the SP Entity ID value which will be used later in the config.yml on the Wazuh indexer instance.

      The rest of the values can be left as default.

    5. In the Group Attribute Statements section put Roles as the name. The value for Roles will be used as the roles_key parameter in the Wazuh indexer configuration. For the filter field, select Matches regex and type .*.

    6. Proceed by clicking next and on the feedback page, select the options seen in the screenshot below. Click on Finish and proceed to the next step.

  6. Add the new app to the new group. Navigate to Directory > Groups and select your group. Click on Applications and select Assign Applications. From here, assign the app created in step 5 and click on Done to save the changes.

  7. Note the necessary parameters from the SAML settings of the new app.

    The parameters already obtained during the integration are:

    • sp.entity_id

    • roles_key

    • kibana_url

    To obtain the remaining parameters, navigate to Applications > Applications, select your app and click Sign On.

    Under SAML Signing Certificates, select View IdP metadata of the active certificate. This will open in a new tab. Copy the URL as this will be the idp.metadata_url.

    Now, on the same page, click on View SAML setup instructions. Copy the Identity Provider Issuer URL, it will be the idp.entity_id.

    The X.509 Certificate will be used as the exchange_key:

    This information can also be found in the metadata XML file.

Wazuh indexer configuration

Edit the Wazuh indexer security configuration files. It is recommended to back up these files before the configuration is carried out.

  1. Edit /usr/share/wazuh-indexer/plugins/opensearch-security/securityconfig/config.yml file and change the following values:

    • Set the order in basic_internal_auth_domain to 0 and the challenge flag to false.

    • Include a saml_auth_domain configuration under the authc section similar to the following:

        authc:
    ...
          basic_internal_auth_domain:
            description: "Authenticate via HTTP Basic against internal users database"
            http_enabled: true
            transport_enabled: true
            order: 0
            http_authenticator:
              type: "basic"
              challenge: false
            authentication_backend:
              type: "intern"
          saml_auth_domain:
            http_enabled: true
            transport_enabled: false
            order: 1
            http_authenticator:
              type: saml
              challenge: true
              config:
                idp:
                  metadata_url: ""
                  entity_id: ""
                sp:
                  entity_id: wazuh-saml
                kibana_url: https://<WAZUH_DASHBOARD_ADDRESS>
                roles_key: Roles
                exchange_key: ''
            authentication_backend:
              type: noop
    

    Ensure to change the following parameters to their corresponding value:

    • idp.metadata_url

    • idp.entity_id

    • sp.entity_id

    • kibana_url

    • roles_key

    • exchange_key

  2. Run the securityadmin script to load the configuration changes made in the config.yml file.

    # export JAVA_HOME=/usr/share/wazuh-indexer/jdk/ && bash /usr/share/wazuh-indexer/plugins/opensearch-security/tools/securityadmin.sh -f /usr/share/wazuh-indexer/plugins/opensearch-security/securityconfig/config.yml -icl -key /etc/wazuh-indexer/certs/admin-key.pem -cert /etc/wazuh-indexer/certs/admin.pem -cacert /etc/wazuh-indexer/certs/root-ca.pem -h localhost -nhnv
    

    The -h flag is used to specify the hostname or the IP address of the Wazuh indexer node. Note that this command uses localhost, set your Wazuh indexer address if necessary.

    The command output must be similar to the following:

    Will connect to localhost:9300 ... done
    Connected as CN=admin,OU=Wazuh,O=Wazuh,L=California,C=US
    OpenSearch Version: 1.2.4
    OpenSearch Security Version: 1.2.4.0
    Contacting opensearch cluster 'opensearch' and wait for YELLOW clusterstate ...
    Clustername: wazuh-cluster
    Clusterstate: GREEN
    Number of nodes: 1
    Number of data nodes: 1
    .opendistro_security index already exists, so we do not need to create one.
    Populate config from /home/wazuh
    Will update '_doc/config' with /usr/share/wazuh-indexer/plugins/opensearch-security/securityconfig/config.yml
       SUCC: Configuration for 'config' created or updated
    Done with success
    
  3. Edit /usr/share/wazuh-indexer/plugins/opensearch-security/securityconfig/roles_mapping.yml file and change the following values:

    Configure the roles_mapping.yml file to map the Okta group to the appropriate Wazuh indexer role. In our case, we map it to the all_access role:

    all_access:
      reserved: false
      hidden: false
      backend_roles:
      - "admin"
      - "<GROUP_NAME>"
    

    Replace <GROUP_NAME> with the name you gave to your group in Step 3. In our case, this is wazuh-admin.

  4. Run the securityadmin script to load the configuration changes made in the roles_mapping.yml file.

    # export JAVA_HOME=/usr/share/wazuh-indexer/jdk/ && bash /usr/share/wazuh-indexer/plugins/opensearch-security/tools/securityadmin.sh -f /usr/share/wazuh-indexer/plugins/opensearch-security/securityconfig/roles_mapping.yml -icl -key /etc/wazuh-indexer/certs/admin-key.pem -cert /etc/wazuh-indexer/certs/admin.pem -cacert /etc/wazuh-indexer/certs/root-ca.pem -h localhost -nhnv
    

    The -h flag is used to specify the hostname or the IP address of the Wazuh indexer node. Note that this command uses localhost, set your Wazuh indexer address if necessary.

    The command output must be similar to the following:

    Security Admin v7
    Will connect to localhost:9300 ... done
    Connected as CN=admin,OU=Wazuh,O=Wazuh,L=California,C=US
    OpenSearch Version: 1.2.4
    OpenSearch Security Version: 1.2.4.0
    Contacting opensearch cluster 'opensearch' and wait for YELLOW clusterstate ...
    Clustername: wazuh-cluster
    Clusterstate: GREEN
    Number of nodes: 1
    Number of data nodes: 1
    .opendistro_security index already exists, so we do not need to create one.
    Populate config from /home/wazuh
    Will update '_doc/rolesmapping' with /usr/share/wazuh-indexer/plugins/opensearch-security/securityconfig/roles_mapping.yml
       SUCC: Configuration for 'rolesmapping' created or updated
    Done with success
    

Wazuh dashboard configuration

  1. Edit the Wazuh dashboard configuration file.

    Add these configurations to /etc/wazuh-dashboard/opensearch_dashboards.yml. It is recommended to back up this file before the configuration is changed.

    opensearch_security.auth.type: "saml"
    server.xsrf.whitelist: ["/_plugins/_security/saml/acs", "/_plugins/_security/saml/logout", "/_opendistro/_security/saml/acs", "/_opendistro/_security/saml/logout", "/_opendistro/_security/saml/acs/idpinitiated"]
    

    Note

    For versions 4.3.9 and earlier, also replace path: `/auth/logout` with path: `/logout` in /usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js.

    ...
       this.router.get({
          path: `/logout`,
          validate: false
    ...
    
  2. Restart the Wazuh dashboard service.

    # systemctl restart wazuh-dashboard
    
    # service wazuh-dashboard restart
    
  3. Test the configuration.

    To test the configuration, go to your Wazuh dashboard URL and log in with your Okta account.