auth¶
XML section name
<auth>
</auth>
This section shows the options for the registering service.
New in version 2.1.
Options¶
- disabled
- port
- use_source_ip
- force_insert
- force_time
- purge
- use_password
- ssl_agent_ca
- ssl_verify_host
- ssl_manager_cert
- ssl_manager_key
- ssl_auto_negotiate
- ciphers
- limit_maxagents
disabled¶
Toggles the execution of the Auth daemon on or off.
| Default value | no |
| 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_insert¶
Toggles whether or not to force the insertion of an agent if there is a duplicate name or IP which would then remove the old agent with same name or IP.
| Default value | no |
| Allowed values | yes, no |
force_time¶
When forcing to remove old agents with same name or IP, this options specifies that the deletion will be performed only if the agent’s keepalive has more than the defined number of seconds.
| Default value | 0 |
| Allowed values |
|
Value 0 means to force always.
purge¶
Toggles the deletion of client keys on or off when agents are removed.
| Default value | no |
| Allowed values | yes, no |
When set to no removed agents will remain in the client keys file, marked as removed. When set to yes, 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 full path to CA certificate used to verify clients.
| Allowed values | A full path |
ssl_verify_host¶
When CA certificate is specified, this option toggles source host verification on and off. This means that the client source IP will be validated using the Common Name field.
| Default value | no |
| Allowed values | yes, no |
ssl_manager_cert¶
Specifies the full path to server SSL certificate.
| Default value | /var/ossec/etc/sslmanager.cert |
| Allowed values | A full path |
ssl_manager_key¶
Specifies the full path to server SSL key.
| Default value | /var/ossec/etc/sslmanager.key |
| Allowed values | A full path |
ssl_auto_negotiate¶
Toggles whether to Auto select SSL/TLS method or not.
| 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¶
Set the list of ciphers for the network communication using SSL.
| Default value | HIGH:!ADH:!EXP:!MD5:!RC4:!3DES:!CAMELLIA:@STRENGTH |
The format of this parameter is described in SSL ciphers.
New in version 3.0.0.
limit_maxagents¶
Toggles whether to operate based on the maximum number of agents.
When disabled, the maximum limit of agents that can be added is ignored.
| Default value | yes |
| Allowed values | yes, no |
New in version 3.0.0.
Default configuration¶
<auth>
<disabled>no</disabled>
<port>1515</port>
<use_source_ip>no</use_source_ip>
<force_insert>no</force_insert>
<force_time>0</force_time>
<purge>no</purge>
<use_password>no</use_password>
<limit_maxagents>yes</limit_maxagents>
<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>/var/ossec/etc/sslmanager.cert</ssl_manager_cert>
<ssl_manager_key>/var/ossec/etc/sslmanager.key</ssl_manager_key>
<ssl_auto_negotiate>no</ssl_auto_negotiate>
</auth>