Skip to content

Latest commit

 

History

History
394 lines (283 loc) · 16.8 KB

keycloak.rst

File metadata and controls

394 lines (283 loc) · 16.8 KB
Raw

Keycloak

Keycloak is an open source identity and access management tool. It provides user federation, strong authentication, user management, and fine-grained authorization for modern applications and services. In this guide, we integrate the KeyCloak IdP to authenticate users into the Wazuh platform.

There are three stages in the single sign-on integration:

  1. KeyCloak configuration
  2. Wazuh indexer configuration
  3. Wazuh dashboard configuration

KeyCloak configuration

  1. Create a new realm. Log in to the Keycloak admin console, expand the master drop-down menu and click Add Realm. Input a name in the Realm name field; in our case, this is named Wazuh. Click on Create to apply this configuration.

    /images/single-sign-on/keycloak/01-create-a-new-realm.png

  2. Create a new client. In the newly created realm, navigate to Clients > Create Client and modify the following parameters:

    • Client type: select SAML from the drop-down menu.
    • Client 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.

    You can leave the rest of the values as default. Click Save to apply the configuration.

    /images/single-sign-on/keycloak/02-create-a-new-client.png

  3. Configure client settings.

    1. Navigate to Clients > Settings and ensure the Enabled button is turned on. Complete the section with these parameters:

      • Client ID: wazuh-saml
      • Name: Wazuh SSO
      • Valid redirect URIs: https://<WAZUH_DASHBOARD_URL>/*
      • IDP-Initiated SSO URL name: wazuh-dashboard
      • Name ID format: username
      • Force POST binding: ON
      • Include AuthnStatement: ON
      • Sign documents: ON
      • Sign assertions: ON
      • Signature algorithm: RSA_SHA256
      • SAML signature key name: KEY_ID
      • Canonicalization method: EXCLUSIVE
      • Front channel logout: ON

      Replace the WAZUH_DASHBOARD_URL field with the corresponding URL of your Wazuh dashboard instance.

      The configuration must be similar to the highlighted blue rectangles:

      /images/single-sign-on/keycloak/03-configure-client-settings.png

      /images/single-sign-on/keycloak/04-configure-client-settings.png

      /images/single-sign-on/keycloak/05-configure-client-settings.png

      /images/single-sign-on/keycloak/06-configure-client-settings.png

      You can leave the rest of the values as default. Click Save to apply the configuration.

    2. Navigate to Clients > Keys and complete the section with these parameters:

      • Client signature required: Off

      /images/single-sign-on/keycloak/07-client-signature-required.png

    3. Navigate to Clients > Advanced > Fine Grain SAML Endpoint Configuration and complete the section with these parameters:

      • Assertion Consumer Service POST Binding URL: https://<WAZUH_DASHBOARD_URL>/_opendistro/_security/saml/acs/idpinitiated
      • Logout Service Redirect Binding URL: https://<WAZUH_DASHBOARD_URL>

      /images/single-sign-on/keycloak/08-fine-grain-saml-endpoint-configuration.png

      You can leave the rest of the values as default. Click Save to apply the configuration.

  4. Create a new role. Navigate to Realm roles > Create role and complete the section with these parameters:

    • Role name: Input admin. This will be our backend role in the Wazuh Indexer configuration.

      /images/single-sign-on/keycloak/09-create-a-new-role.png

    Click on Save to apply the configuration.

  5. Create a new user.

    1. Navigate to Users > Add user and fill in the required information.

      /images/single-sign-on/keycloak/10-create-a-new-user.png

      Click on Create to apply the configuration.

    2. Navigate to Users > Credentials > Set password and input a password for the newly created user. You will use these credentials to log in to the Wazuh dashboard.

      /images/single-sign-on/keycloak/11-set-password.png

      Click on Save to apply the configuration.

  6. Create a new group and assign the user.

    1. Go to Groups > Create group and assign a name to the group. In our case, this is Wazuh-admins.

      /images/single-sign-on/keycloak/12-create-a-new-group.png

    2. Click on the newly created group, navigate to Members > Add member and select the user created in the previous step. Click on Add to add it to the group.

      /images/single-sign-on/keycloak/13-add-member.png

    3. In the newly created group details, go to Role Mapping > Assign role and select the admin role created in step 3. Click on Assign to apply the configuration.

      /images/single-sign-on/keycloak/14-assign-role.png

  7. Configure protocol mapper.

    1. Navigate to Client scopes > role_list > Mappers > Configure a new mapper.

      /images/single-sign-on/keycloak/15-configure-a-new-mapper.png

    2. Select Role list from the list as seen below:

      /images/single-sign-on/keycloak/16-select-role-list.png

    3. Complete the Add mapper section with these parameters:

      • Mapper type: Role list
      • Name: wazuhRoleKey. You can use any name here.
      • Role attribute name: Roles. This will be the roles_key on the Wazuh Indexer configuration.
      • SAML Attribute NameFormat: Basic
      • Single Role Attribute: On

      /images/single-sign-on/keycloak/17-complete-the-add-mapper-section.png

    Click on Save to apply the configuration.

  8. Note the necessary parameters from the SAML settings of Keycloak.
    1. The parameters already obtained during the integration are:
      • sp.entity_id: wazuh-saml
      • roles_key: Roles
      • kibana_url: https://<WAZUH_DASHBOARD_URL>

    2. To obtain the remaining parameters.

      1. Navigate to Clients and select the name of your client. In our case, this is wazuh-saml.
      2. Navigate to Action > Download adapter config, and ensure the Format option is Mod Auth Mellon files.
      3. Click on Download to download the remaining files.

      /images/single-sign-on/keycloak/18-download-adapter-config.png

    3. The downloaded files contain the idp.metadata.xml file and the sp.metadata.xml file.

      • The idp.entityID parameter is in the idp.metadata.xml file.
      • The exchange_key parameter is found in the ds:X509Certificate field in the idp.metadata.xml file.

      /images/single-sign-on/keycloak/19-the-exchange_key-parameter.png

Wazuh indexer configuration

Edit the Wazuh indexer security configuration files. We recommend that you back up these files before you carry out the configuration.

  1. Place the idp.metadata.xml and sp.metadata.xml files within the /etc/wazuh-indexer/opensearch-security/ directory. Set the file ownership to wazuh-indexer using the following command:

    chown wazuh-indexer:wazuh-indexer /etc/wazuh-indexer/opensearch-security/idp.metadata.xml
chown wazuh-indexer:wazuh-indexer /etc/wazuh-indexer/opensearch-security/sp.metadata.xml

  2. Edit the /etc/wazuh-indexer/opensearch-security/config.yml file and change the following values:

    • Set the order in basic_internal_auth_domain to 0, and set 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_file: '/etc/wazuh-indexer/opensearch-security/idp.metadata.xml' entity_id: 'http://192.168.XX.XX:8080/realms/Wazuh' sp: entity_id: wazuh-saml metadata_file: /etc/wazuh-indexer/opensearch-security/sp.metadata.xml kibana_url: https://<WAZUH_DASHBOARD_ADDRESS> roles_key: Roles exchange_key: 'MIICajCCAdOgAwIBAgIBAD.........' authentication_backend: type: noop

    Ensure to change the following parameters to their corresponding value:

    • idp.metadata_file
    • idp.entity_id
    • sp.entity_id
    • sp.metadata_file
    • kibana_url
    • roles_key
    • exchange_key

  3. 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 /etc/wazuh-indexer/opensearch-security/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 specifies 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:9200 ... done
Connected as "CN=admin,OU=Wazuh,O=Wazuh,L=California,C=US"
OpenSearch Version: 2.10.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 /etc/wazuh-indexer/opensearch-security
Will update '/config' with /etc/wazuh-indexer/opensearch-security/config.yml 
   SUCC: Configuration for 'config' created or updated
SUCC: Expected 1 config types for node {"updated_config_types":["config"],"updated_config_size":1,"message":null} is 1 (["config"]) due to: null
Done with success

  4. Edit the /etc/wazuh-indexer/opensearch-security/roles_mapping.yml file and change the following values:

    Configure the roles_mapping.yml file to map the realm role in Keycloak to the appropriate Wazuh indexer role; in our case, we map this to the all_access role.

    all_access:
  reserved: false
  hidden: false
  backend_roles:
  - "admin"

  5. 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 /etc/wazuh-indexer/opensearch-security/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 specifies 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:9200 ... done
Connected as "CN=admin,OU=Wazuh,O=Wazuh,L=California,C=US"
OpenSearch Version: 2.10.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 /etc/wazuh-indexer/opensearch-security
Will update '/rolesmapping' with /etc/wazuh-indexer/opensearch-security/roles_mapping.yml 
   SUCC: Configuration for 'rolesmapping' created or updated
SUCC: Expected 1 config types for node {"updated_config_types":["rolesmapping"],"updated_config_size":1,"message":null} is 1 (["rolesmapping"]) due to: null
Done with success

Wazuh dashboard configuration

  1. Check the value of Run as in the API host entry configuration on Dashboard management > Server APIs. If Run as is set to false, proceed to the next step. If Run as is set to true, you need to add a role mapping on the Wazuh dashboard. To map the backend role to Wazuh, follow these steps:

    1. Click ☰ to open the menu on the Wazuh dashboard, go to Server management > Security, and then Roles mapping to open the page.

      /images/single-sign-on/Wazuh-role-mapping.gif

    2. Click Create Role mapping and complete the empty fields with the following parameters:

      • Role mapping name: Assign a name to the role mapping.
      • Roles: Select administrator.
      • Custom rules: Click Add new rule to expand this field.
      • User field: backend_roles
      • Search operation: FIND
      • Value: Assign the value of the realm role in Keycloak configuration. In our case, this is admin.

      /images/single-sign-on/keycloak/Wazuh-role-mapping.png

  2. Edit the Wazuh dashboard configuration file. Add these configurations to /etc/wazuh-dashboard/opensearch_dashboards.yml. We recommend that you back up these files before you carry out the configuration.

    opensearch_security.auth.type: "saml"
server.xsrf.allowlist: ["/_opendistro/_security/saml/acs", "/_opendistro/_security/saml/logout", "/_opendistro/_security/saml/acs/idpinitiated"]
opensearch_security.session.keepalive: false
  3. Restart the Wazuh dashboard service using this command:
  4. Test the configuration. Go to your Wazuh dashboard URL and log in with your Keycloak account.