-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Adds missing TLS settings for auditing (#30822)
- Loading branch information
Showing
4 changed files
with
115 additions
and
18 deletions.
There are no files selected for viewing
105 changes: 90 additions & 15 deletions
105
x-pack/docs/en/security/auditing/forwarding-logs.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,99 @@ | ||
[role="xpack"] | ||
[float] | ||
[[forwarding-audit-logfiles]] | ||
==== Forwarding audit logs to a remote cluster | ||
=== Forwarding audit logs to a remote cluster | ||
|
||
To index audit events to a remote Elasticsearch cluster, you configure | ||
the following `xpack.security.audit.index.client` settings: | ||
When you are auditing security events, you can optionally store the logs in an | ||
{es} index on a remote cluster. The logs are sent to the remote cluster by | ||
using the {javaclient}/transport-client.html[transport client]. | ||
|
||
* `xpack.security.audit.index.client.hosts` | ||
* `xpack.security.audit.index.client.cluster.name` | ||
* `xpack.security.audit.index.client.xpack.security.user` | ||
. Configure auditing such that the logs are stored in {es} rolling indices. | ||
See <<audit-index>>. | ||
|
||
. Establish a connection to the remote cluster by configuring the following | ||
`xpack.security.audit.index.client` settings: | ||
+ | ||
-- | ||
[source, yaml] | ||
-------------------------------------------------- | ||
xpack.security.audit.index.client.hosts: 192.168.0.1, 192.168.0.2 <1> | ||
xpack.security.audit.index.client.cluster.name: logging-prod <2> | ||
xpack.security.audit.index.client.xpack.security.user: myuser:mypassword <3> | ||
-------------------------------------------------- | ||
<1> A list of hosts in the remote cluster. If you are not using the default | ||
value for the `transport.tcp.port` setting on the remote cluster, you must | ||
specify the appropriate port number (prefixed by a colon) after each host. | ||
<2> The remote cluster name. | ||
<3> A valid user and password, which must have authority to create the | ||
`.security-audit` index on the remote cluster. | ||
|
||
For more information about these settings, see | ||
{ref}/auditing-settings.html#remote-audit-settings[Remote Audit Log Indexing Configuration Settings]. | ||
{ref}/auditing-settings.html#remote-audit-settings[Remote audit log indexing configuration settings]. | ||
|
||
-- | ||
|
||
. If the remote cluster has Transport Layer Security (TLS/SSL) enabled, you | ||
must specify extra security settings: | ||
|
||
You can pass additional settings to the remote client by specifying them in the | ||
`xpack.security.audit.index.client` namespace. For example, to allow the remote | ||
client to discover all of the nodes in the remote cluster you can specify the | ||
`client.transport.sniff` setting: | ||
.. {ref}/configuring-tls.html#node-certificates[Generate a node certificate on | ||
the remote cluster], then copy that certificate to the client. | ||
|
||
.. Enable TLS and specify the information required to access the node certificate. | ||
|
||
*** If the signed certificate is in PKCS#12 format, add the following information | ||
to the `elasticsearch.yml` file: | ||
+ | ||
-- | ||
[source,yaml] | ||
---------------------------- | ||
xpack.security.audit.index.client.transport.sniff: true | ||
---------------------------- | ||
----------------------------------------------------------- | ||
xpack.security.audit.index.client.xpack.security.transport.ssl.enabled: true | ||
xpack.security.audit.index.client.xpack.ssl.keystore.path: certs/remote-elastic-certificates.p12 | ||
xpack.security.audit.index.client.xpack.ssl.truststore.path: certs/remote-elastic-certificates.p12 | ||
----------------------------------------------------------- | ||
|
||
For more information about these settings, see | ||
{ref}/security-settings.html#auditing-tls-ssl-settings[Auditing TLS settings]. | ||
-- | ||
|
||
*** If the certificate is in PEM format, add the following information to the | ||
`elasticsearch.yml` file: | ||
+ | ||
-- | ||
[source, yaml] | ||
-------------------------------------------------- | ||
xpack.security.audit.index.client.xpack.security.transport.ssl.enabled: true | ||
xpack.security.audit.index.client.xpack.ssl.key: /home/es/config/audit-client.key | ||
xpack.security.audit.index.client.xpack.ssl.certificate: /home/es/config/audit-client.crt | ||
xpack.security.audit.index.client.xpack.ssl.certificate_authorities: [ "/home/es/config/remote-ca.crt" ] | ||
-------------------------------------------------- | ||
|
||
For more information about these settings, see | ||
{ref}/security-settings.html#auditing-tls-ssl-settings[Auditing TLS settings]. | ||
-- | ||
|
||
.. If you secured the certificate with a password, add the password to | ||
your {es} keystore: | ||
|
||
*** If the signed certificate is in PKCS#12 format, use the following commands: | ||
+ | ||
-- | ||
[source,shell] | ||
----------------------------------------------------------- | ||
bin/elasticsearch-keystore add xpack.security.audit.index.client.xpack.ssl.keystore.secure_password | ||
bin/elasticsearch-keystore add xpack.security.audit.index.client.xpack.ssl.truststore.secure_password | ||
----------------------------------------------------------- | ||
-- | ||
|
||
*** If the certificate is in PEM format, use the following commands: | ||
+ | ||
-- | ||
[source,shell] | ||
----------------------------------------------------------- | ||
bin/elasticsearch-keystore add xpack.security.audit.index.client.xpack.ssl.secure_key_passphrase | ||
----------------------------------------------------------- | ||
-- | ||
|
||
. Restart {es}. | ||
|
||
When these steps are complete, your audit logs are stored in {es} rolling | ||
indices on the remote cluster. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters