auth

XML section name

<auth>
</auth>

This section shows the options for the registration service.

Options

disabled

Toggles the execution of the Auth daemon on or off.

Default value

no

Allowed values

yes, no

remote_enrollment

New in version 4.2.0.

Allow listening for new agents on TLS port (1515 by default).

Default value

yes

Allowed values

yes, no

port

Defines the TCP port number for listening to connections.

Default value

1515

Allowed values

0 - 65535

use_source_ip

Toggles the use of the client's source IP address or the use of "any" to add an agent.

Default value

no

Allowed values

yes, no

force

New in version 4.3.0.

The agent replacement options are configured inside this tag. All conditions must be satisfied to perform the replacement.

<force>
  <enabled>yes</enabled>
  <disconnected_time enabled="yes">1h</disconnected_time>
  <after_registration_time>1h</after_registration_time>
  <key_mismatch>yes</key_mismatch>
</force>

enabled

Toggles whether or not to force the insertion of an agent if there is a duplicate name or IP address. This will remove the old agent with same name or IP address.

Default value

yes

Allowed values

yes, no

disconnected_time

This option, when enabled, specifies that the replacement will be performed only for agents that have been disconnected longer than the value configured in the setting. This option should be disabled to replace any agent regardless of its state.

Default value

1h

Allowed values

Any number greater than or equal to zero. Allowed suffixes (s, m, h, d).

Attributes:

enabled

Default value

yes

Allowed values

yes, no

Value no means to force replacement even for active agents.

Value 0 means to force the replacement of any disconnected agent.

after_registration_time

Specifies that the agent replacement will be performed only when the time passed since the agent registration is greater than the value configured in the setting.

Default value

1h

Allowed values

Any number greater than or equal to zero. Allowed suffixes (s, m, h, d).

Value 0 means to always force replacement.

key_mismatch

This option defines that the agent replacement occurs when the key held by the agent is different from the one registered by the manager.

Default value

yes

Allowed values

yes, no

purge

Toggles the deletion of client keys on or off when agents are removed.

Default value

yes

Allowed values

yes, no

When set to no, removed agents will remain in the client keys file marked as removed. When set to yes, the client keys file will be purged.

use_password

Toggles shared password authentication on or off.

Default value

no

Allowed values

yes, no

When enabled, the shared password will be read from the /var/ossec/etc/authd.pass file.

If this file does not exist, a random password will be generated.

ssl_agent_ca

Specifies the path to the CA certificate used to verify clients. It can be referred to a relative path under the Wazuh installation directory, or a full path.

Allowed values

Any valid path

ssl_verify_host

Toggles source host verification on and off when a CA certificate is specified. This means that the client source IP address will be validated using the Common Name field.

Default value

no

Allowed values

yes, no

ssl_manager_cert

Specifies the path to the server SSL certificate. It can be referred to a relative path under the Wazuh installation directory, or a full path.

Default value

etc/sslmanager.cert

Allowed values

Any valid path

ssl_manager_key

Specifies the path to the server's SSL key. It can be referred to a relative path under the Wazuh installation directory, or a full path.

Default value

etc/sslmanager.key

Allowed values

Any valid path

ssl_auto_negotiate

Toggles whether or not to auto select the SSL/TLS method.

Default value

no

Allowed values

yes, no

By default only TLS v1.2 is allowed. When set to yes the system will negotiate the most secure common method with the client.

In older systems, where the manager does not support TLS v1.2, this option will be enabled automatically.

ciphers

Sets the list of ciphers for network communication using SSL.

Default value

HIGH:!ADH:!EXP:!MD5:!RC4:!3DES:!CAMELLIA:@STRENGTH

The format of this parameter is described in SSL ciphers.

Default configuration

<auth>
  <disabled>no</disabled>
  <remote_enrollment>yes</remote_enrollment>
  <port>1515</port>
  <use_source_ip>no</use_source_ip>
  <force>
    <enabled>yes</enabled>
    <disconnected_time enabled="yes">1h</disconnected_time>
    <after_registration_time>1h</after_registration_time>
    <key_mismatch>yes</key_mismatch>
  </force>
  <purge>yes</purge>
  <use_password>no</use_password>
  <ciphers>HIGH:!ADH:!EXP:!MD5:!RC4:!3DES:!CAMELLIA:@STRENGTH</ciphers>
  <!-- <ssl_agent_ca></ssl_agent_ca> -->
  <ssl_verify_host>no</ssl_verify_host>
  <ssl_manager_cert>etc/sslmanager.cert</ssl_manager_cert>
  <ssl_manager_key>etc/sslmanager.key</ssl_manager_key>
  <ssl_auto_negotiate>no</ssl_auto_negotiate>
</auth>