[Redesign add page] Agent register wizard handle properly special characters in password

[Machi3mfl]

Description

This PR, resolves the password management in the register agent command when having special characters

Closes #5493

Check List

• All tests pass
  • yarn test:jest
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

Testing E2E

• Use an environment with a real manager or mock the following response

{
  "data": {
    "affected_items": [
      {
        "auth": {
          "port": 1515,
          "disabled": "no",
          "remote_enrollment": "yes",
          "use_source_ip": "no",
          "purge": "yes",
          "use_password": "yes",
          "ssl_verify_host": "no",
          "ssl_auto_negotiate": "no",
          "ciphers": "HIGH:!ADH:!EXP:!MD5:!RC4:!3DES:!CAMELLIA:@STRENGTH",
          "ssl_manager_cert": "/var/ossec/etc/sslmanagertest.cert",
          "ssl_manager_key": "/var/ossec/etc/sslmanagertest.key",
          "force": {
            "enabled": "yes",
            "key_mismatch": "yes",
            "disconnected_time": {
              "enabled": "yes",
              "value": 3600
            },
            "after_registration_time": 3600
          }
        },
        "authd.pass": "password\"with\"doubleq\\'usds\\\"es"
      }
    ],
    "total_affected_items": 1,
    "total_failed_items": 0,
    "failed_items": []
  },
  "message": "Active configuration was successfully read in specified node",
  "error": 0
}

With the following e2e test, we need to check that the password added in the manager authd.pass file will be copied in the agent authd.pass file

1. Add the authd.pass with the password and enable the use_password setting. https://documentation.wazuh.com/current/user-manual/agent-enrollment/security-options/using-password-authentication.html

password"with"doubleq\'usds\"es

The API will return the password defined on the authd.pass with the characters " and \ scaped. For example: "password"with"doubleq\'usds\"es"

2. Go to the Deploy new agent page and fill out the form. (Depending on your OS)

Kazam_screencast_00003.mp4

3. Copy the command and run it on your machine. (Replace de 4.7.0 version with the 4.4.5 version in the command)

4. Start the agent and check if the authd.pass file was created inside the agent folder

Linux: /var/ossec/etc/authd.pass
macOS: /Library/Ossec/etc/authd.pass
Windows: C:/Programs/ossec-agent/etc/authd.pass

5. The password added in the manager and agent authd.pass file must be equal

password"with"doubleq\'usds\"es

[Machi3mfl]

Added unit test

[Machi3mfl]

Imposter example response

{
  "data": {
    "affected_items": [
      {
        "auth": {
          "port": 1515,
          "disabled": "no",
          "remote_enrollment": "yes",
          "use_source_ip": "no",
          "purge": "yes",
          "use_password": "yes",
          "ssl_verify_host": "no",
          "ssl_auto_negotiate": "no",
          "ciphers": "HIGH:!ADH:!EXP:!MD5:!RC4:!3DES:!CAMELLIA:@STRENGTH",
          "ssl_manager_cert": "/var/ossec/etc/sslmanagertest.cert",
          "ssl_manager_key": "/var/ossec/etc/sslmanagertest.key",
          "force": {
            "enabled": "yes",
            "key_mismatch": "yes",
            "disconnected_time": {
              "enabled": "yes",
              "value": 3600
            },
            "after_registration_time": 3600
          }
        },
        "authd.pass": "password\"with\"doubleq\\'usds\\\"es"
      }
    ],
    "total_affected_items": 1,
    "total_failed_items": 0,
    "failed_items": []
  },
  "message": "Active configuration was successfully read in specified node",
  "error": 0
}

[Machi3mfl]

Test evidence

Selecting Linux and completing all the optional parameters

Command copied

curl -o wazuh-agent-4.7.0-1.x86_64.rpm https://packages.wazuh.com/4.x/yum/wazuh-agent-4.7.0-1.x86_64.rpm && sudo WAZUH_MANAGER='10.10.10.10' WAZUH_REGISTRATION_PASSWORD='password"with"doubleq\'usds\"es' WAZUH_AGENT_GROUP='default' WAZUH_AGENT_NAME='agent-name' rpm -ihv wazuh-agent-4.7.0-1.x86_64.rpm

Selecting Windows and completing all the optional parameters

Invoke-WebRequest -Uri https://packages.wazuh.com/4.x/windows/wazuh-agent-4.7.0-1.msi -OutFile ${env.tmp}\wazuh-agent; msiexec.exe /i ${env.tmp}\wazuh-agent /q WAZUH_MANAGER='10.10.10.10' WAZUH_REGISTRATION_PASSWORD='password"with"doubleq\'usds\"es' WAZUH_AGENT_GROUP='default' WAZUH_AGENT_NAME='agent-name' WAZUH_REGISTRATION_SERVER='10.10.10.10' 

Selecting macOS and completing all the optional parameters

curl -so wazuh-agent.pkg https://packages.wazuh.com/4.x/macos/wazuh-agent-4.7.0-1.intel64.pkg && echo -e "WAZUH_MANAGER='10.10.10.10'\nWAZUH_AGENT_GROUP='default'\nWAZUH_AGENT_NAME='agent-name'\nWAZUH_REGISTRATION_PASSWORD='password\"with\"doubleq\\'usds\\\"es'\n" > /tmp/wazuh_envs && sudo installer -pkg ./wazuh-agent.pkg -target /

[Machi3mfl]

Commands

Api in authd.pass

password"with"doubleq\'usds\"es

Password from /config/auth/auth API endpoint

• in this case, the API scape the special characters " and \

password\"with\"doubleq\\'usds\\\"es

Password in command

wget https://packages.wazuh.com/4.x/apt/pool/main/w/wazuh-agent/wazuh-agent_4.7.0-1_amd64.deb && sudo WAZUH_MANAGER='10.10.10.10' WAZUH_REGISTRATION_PASSWORD=$'password"with"doubleq\\'"'"'usds\"es' dpkg -i ./wazuh-agent_4.7.0-1_amd64.deb

// password"with"doubleq\\'"'"'usds\"es

Linux

RPM

curl -o wazuh-agent-4.4.5-1.x86_64.rpm https://packages.wazuh.com/4.x/yum/wazuh-agent-4.4.5-1.x86_64.rpm && sudo WAZUH_MANAGER='10.10.10.10' WAZUH_REGISTRATION_PASSWORD=$'password"with"doubleq'"'"'usds\"es' rpm -ihv wazuh-agent-4.4.5-1.x86_64.rpm

DEB

wget https://packages.wazuh.com/4.x/apt/pool/main/w/wazuh-agent/wazuh-agent_4.4.5-1_amd64.deb && sudo WAZUH_MANAGER='10.10.10.10' WAZUH_REGISTRATION_PASSWORD=$'password"with"doubleq\'"'"'usds\"es' dpkg -i ./wazuh-agent_4.4.5-1_amd64.deb

macOS

curl -so wazuh-agent.pkg https://packages.wazuh.com/4.x/macos/wazuh-agent-4.4.5-1.pkg && echo -e "WAZUH_MANAGER='10.10.10.10'\nWAZUH_REGISTRATION_PASSWORD=$'password\"with\"doubleq\\'usds\\\"es'\n" > /tmp/wazuh_envs && sudo installer -pkg ./wazuh-agent.pkg -target /

[Machi3mfl]

Testing E2E

• Use an environment with a real manager or mock the following response

{
  "data": {
    "affected_items": [
      {
        "auth": {
          "port": 1515,
          "disabled": "no",
          "remote_enrollment": "yes",
          "use_source_ip": "no",
          "purge": "yes",
          "use_password": "yes",
          "ssl_verify_host": "no",
          "ssl_auto_negotiate": "no",
          "ciphers": "HIGH:!ADH:!EXP:!MD5:!RC4:!3DES:!CAMELLIA:@STRENGTH",
          "ssl_manager_cert": "/var/ossec/etc/sslmanagertest.cert",
          "ssl_manager_key": "/var/ossec/etc/sslmanagertest.key",
          "force": {
            "enabled": "yes",
            "key_mismatch": "yes",
            "disconnected_time": {
              "enabled": "yes",
              "value": 3600
            },
            "after_registration_time": 3600
          }
        },
        "authd.pass": "password\"with\"doubleq\\'usds\\\"es"
      }
    ],
    "total_affected_items": 1,
    "total_failed_items": 0,
    "failed_items": []
  },
  "message": "Active configuration was successfully read in specified node",
  "error": 0
}

With the following e2e test, we need to check that the password added in the manager authd.pass file will be copied in the agent authd.pass file

1. Add the authd.pass with the password and enable the use_password setting. https://documentation.wazuh.com/current/user-manual/agent-enrollment/security-options/using-password-authentication.html

password"with"doubleq\'usds\"es

2. Go to the Deploy new agent page and fill out the form. (Depending on your OS)

Kazam_screencast_00003.mp4

3. Copy the command and run it on your machine. (Replace de 4.7.0 version with the 4.4.5 version in the command)

4. Start the agent and check if the authd.pass file was created inside the agent folder

Linux: /var/ossec/etc/authd.pass
macOS: /Library/Ossec/etc/authd.pass
Windows: C:/Programs/ossec-agent/etc/authd.pass

5. The password added in the manager and agent authd.pass file must be equal

[jbiset]

CR: (in progress)

UI TEST

🟢 LINUX

• Real password: password"with"doubleq\'usds\"es

Evidence

• API response authd.pass: "password\"with\"doubleq\\'usds\\\"es"
• Generated command:
  wget https://packages.wazuh.com/4.x/apt/pool/main/w/wazuh-agent/wazuh-agent_4.7.0-1_amd64.deb && sudo WAZUH_MANAGER='192.168.10.197' WAZUH_REGISTRATION_PASSWORD=$'password"with"doubleq\'"'"'usds\"es' WAZUH_AGENT_NAME='LocalLinux' dpkg -i ./wazuh-agent_4.7.0-1_amd64.deb

Evidence

• Agent authd.pass: password"with"doubleq\'usds\"es

Evidence

🟢 Windows

NOTE: The agent's auth.pass file does not have double quotes and is removed during its installation by a replacement.

• Real password: password"with"doubleq\'usds\"es

Evidence

• API response authd.pass: "password\"with\"doubleq\\'usds\\\"es"
• Generated command:
  Invoke-WebRequest -Uri https://packages.wazuh.com/4.x/windows/wazuh-agent-4.7.0-1.msi -OutFile ${env.tmp}\wazuh-agent; msiexec.exe /i ${env.tmp}\wazuh-agent /q WAZUH_MANAGER='192.168.10.197' WAZUH_REGISTRATION_PASSWORD=$'password"with"doubleq\'"'"'usds\"es' WAZUH_AGENT_NAME='VirtualWindows' WAZUH_REGISTRATION_SERVER='192.168.10.197'

Evidence

• Agent authd.pass: $passwordwithdoubleq\'usds\es

Evidence

RUN TEST

[Machi3mfl]

UI TEST

🟢 MACOS

• Real password: password"with"doubleq\'usds\"es

Evidence

• API response authd.pass: "password\"with\"doubleq\\'usds\\\"es"
• Generated command:
  curl -so wazuh-agent.pkg https://packages.wazuh.com/4.x/macos/wazuh-agent-4.7.0-1.intel64.pkg && echo -e "WAZUH_MANAGER='192.168.0.55'\nWAZUH_AGENT_GROUP='default'\nWAZUH_AGENT_NAME='macos-agent'\nWAZUH_REGISTRATION_PASSWORD='password\"with\"doubleq\\'\"'\"'usds\\\\\\\\\\\"es'\n" > /tmp/wazuh_envs && sudo installer -pkg ./wazuh-agent.pkg -target /

To test i changed the wazuh package version to 4.4.5-1 and remove de intel64 extension.

Evidence

• Agent authd.pass: password"with"doubleq\'usds\"es

Evidence

[github-actions]

Code coverage (Jest)	%	values
Statements	11.03%	( 3811 / 34544 )
Branches	6.79%	( 1582 / 23269 )
Functions	9.88%	( 813 / 8228 )
Lines	11.17%	( 3696 / 33060 )

[chantal-kelm]

Test in macos: