FIPS for ingest tools

deploy-manage/security/fips-ingest.md

@@ -0,0 +1,97 @@
+---
+applies_to:
+  deployment: ga
+navigation_title: 
+products:
+  - id: apm
+  - id: elastic-agent
+  - id: beats
+  - id: fleet
+applies_to:
+  stack: preview 9.1
+
+---
+
+# FIPS mode for Ingest tools [fips-ingest]
+
+{{agent}}, {{fleet}}, {{filebeat}}, {{metricbeat}}, and {{apm-server}} binaries are built and can be configured to use FIPS 140-2 compliant cryptography.
+Generally speaking FIPS 140-2 requirements can be summarized as:
+- linking against a FIPS certified cryptographic library
+- using only FIPS approved cryptographic functions
+- ensuring that the configuration of the component is FIPS 140-2 compliant.
+
+## FIPS-compatible binaries and configuration [fips-binaries]
+
+FIPS compatible binaries for {{agent}}, {{fleet}}, {{filebeat}}, {{metricbeat}}, and {{apm-server}} are available for [download](https://www.elastic.co/downloads). Look for the `Linux 64-bit (FIPS)` or `Linux aarch64 (FIPS)` platform option on the product download pages for {{agent}} and {{fleet}}, {{filebeat}}, and {{metricbeat}}. Look for the `Linux x86_64 (FIPS)` or `Linux aarch64 (FIPS)` platform option on the {{apm-server}} download page.
+
+:::{important}
+The default configurations provided in the binaries are FIPS compatible. Be sure to check and understand the implications of changing default configurations. 
+:::
+
+## Limitations [ingest-limitations-all]
+
+### TLS [ingest-limitations-tls]
+
+Only FIPS 140-2 compliant TLS protocols, ciphers, and curve types are allowed to be used as listed below.
+* The supported TLS versions are `TLS v1.2` and `TLS v1.3`. 
+* The supported cipher suites are:
+  * `TLS v1.2`: `ECDHE-RSA-AES-128-GCM-SHA256`, `ECDHE-RSA-AES-256-GCM-SHA384`, `ECDHE-ECDSA-AES-128-GCM-SHA256`, `ECDHE-ECDSA-AES-256-GCM-SHA384`
+  * `TLS v1.3`: `TLS-AES-128-GCM-SHA256`, `TLS-AES-256-GCM-SHA384`
+* The supported curve types are `P-256`, `P-384` and `P-521`.
+
+Support for encrypted private keys is not available, as the cryptographic modules used for decrypting password protected keys are not FIPS validated. If an output or any other component with an SSL key that is password protected is configured, the components will fail to load the key. When running in FIPS mode, you must provide non-encrypted keys.
+Be sure to enforce security in your FIPS environments through other means, such as strict file permissions and access controls on the key file itself, for example. 
+
+These TLS related restrictions apply to all components listed--{{agent}}, {{fleet}}, {{filebeat}}, {{metricbeat}}, and {{apm-server}}. 
+
+### General output and input limitations (Kerberos protocol) [ingest-inputoutput-limitations]
+
+The Kerberos protocol is not supported for any output or input, which also impacts the available `sasl.mechanism` for the Kafka output where only `PLAIN` is supported. 
+
+This impacts [Filebeat](beats://reference/filebeat/configuration-kerberos.md), [Metricbeat](beats://reference/metricbeat/configuration-kerberos.md) and {{apm-server}}, as well as output configurations for {{agent}} with {{fleet-server}}. 
+
+
+### APM Server [ingest-apm-limitations]
+
+* The [Secrets Keystore](/solutions/observability/apm/secrets-keystore-for-secure-settings.md) is not supported. 
+
+### Filebeat [ingest-filebeat-limitations]
+
+* The [Secrets Keystore](beats://reference/filebeat/keystore.md) is not supported. 
+* The [Translate GUID processor](beats://reference/filebeat/processor-translate-guid.md) is not supported.
+* The [Fingerprint processor](beats://reference/filebeat/fingerprint.md) does not support the md5 and sha1 method. 
+* The [Community ID Network Flowhash processor](beats://reference/filebeat/community-id.md) is not supported. 
+* The [Azure module](beats://reference/filebeat/filebeat-module-azure.md) including the [Azure eventhub input](beats://reference/filebeat/filebeat-input-azure-eventhub.md) and the [Azure Blob Storage Input](https://www.elastic.co/docs/reference/beats/filebeat/filebeat-input-azure-blob-storage) are not currently supported. The [Add Cloud Metadata processor](beats://reference/filebeat/add-cloud-metadata.md) does not support the Azure Virtual Machine provider currently. 
+* The [Office 365 module (Beta)](beats://reference/filebeat/filebeat-module-o365.md) and the [Office 365 input (Deprecated)](https://www.elastic.co/docs/reference/beats/filebeat/filebeat-input-o365audit) are not supported. 
+* The [GCP Pub/Sub input](beats://reference/filebeat/filebeat-input-gcp-pubsub.md) and the [Google Cloud Storage input](https://www.elastic.co/docs/reference/beats/filebeat/filebeat-input-gcs) are not supported for now. 
+* The [Entity Analytics input](https://www.elastic.co/docs/reference/beats/filebeat/filebeat-input-entity-analytics) is not supported. 
+
+### Metricbeat [ingest-metricbeat-limitations]
+
+* The [Secrets Keystore](beats://reference/metricbeat/keystore.md) is not supported. 
+* The [Translate GUID processor](beats://reference/metricbeat/processor-translate-guid.md) is not supported.
+* The [Fingerprint processor](beats://reference/metricbeat/fingerprint.md) does not support the md5 and sha1 method. 
+* The [Community ID Network Flowhash processor](beats://reference/metricbeat/community-id.md) is not supported. 
+* The [Azure module](beats://reference/metricbeat/metricbeat-module-azure.md) is currently not supported. The [Add Cloud Metadata processor](beats://reference/metricbeat/add-cloud-metadata.md) does not support the Azure Virtual Machine provider currently. 
+* The [Google Cloud Platform module](https://www.elastic.co/docs/reference/beats/metricbeat/metricbeat-module-gcp) is currently not supported. 
+* The [Beta KVM module](beats://reference/metricbeat/metricbeat-module-kvm.md) is not yet supported.
+* The [Mongo DB module](beats://reference/metricbeat/metricbeat-module-mongodb.md) is not supported. 
+* The [MySQL](beats://reference/metricbeat/metricbeat-module-mysql.md), [PostgreSQL](beats://reference/metricbeat/metricbeat-module-postgresql.md), [MSSQL](beats://reference/metricbeat/metricbeat-module-mssql.md) and [SQL](beats://reference/metricbeat/metricbeat-module-sql.md) modules are not supported. 
+* The [Oracle module](beats://reference/metricbeat/metricbeat-module-oracle.md) is not supported. 
+
+### Elastic Agent and Fleet Server [ingest-limitations-agent]
+
+When you use {{agent}} and {{fleet-server}}, these limitations apply:
+* Running {{agent}} in [OpenTelemetry mode](https://github.com/elastic/elastic-agent/blob/main/internal/pkg/otel/README.md) is not yet supported. This includes all receivers, such as Filebeat Receiver, Metricbeat Receiver, [Prometheus Receiver](https://www.elastic.co/docs/reference/integrations/prometheus).
+* Some Elastic Integrations are not FIPS compatible, as they depend on functionality that is not yet supported for FIPS configuration. In general, when using {{agent}} and {{fleet-server}}, the same restrictions listed previously for {{metricbeat}} and {{filebeat}} modules, inputs, and processors apply.
+
+  These Elastic Integrations have components that are **not** FIPS compatible, and **cannot** be used in FIPS environments, even if combined with other ingest tools that offer FIPS mode. 
+
+  - [Azure Logs Integration (v2 preview)](integration-docs://reference/azure/events.md)
+  - [Azure Event Hub Input](integration-docs://reference/azure/eventhub.md)
+  - [PostgreSQL Integration](integration-docs://reference/postgresql.md)
+  - [MongoDB Integration](integration-docs://reference/mongodb.md)
+  - [MySQL Integration](integration-docs://reference/mysql.md)
+  - [Microsoft SQL Server Integration](integration-docs://reference/microsoft_sqlserver.md)
+  - [Oracle Integration](integration-docs://reference/oracle.md)
+

deploy-manage/security/fips-kib.md

@@ -0,0 +1,45 @@
+---
+applies_to:
+  deployment:
+    self: ga
+products:
+  - id: kibana
+---
+
+# FIPS compliance for {{kib}} [fips-kibana]
+
+To run {{kib}} in FIPS mode, you must have the appropriate [subscription](https://www.elastic.co/subscriptions).
+
+::::{important}
+The Node bundled with {{kib}} is not configured for FIPS 140-2. You must configure a FIPS 140-2 compliant OpenSSL3 provider. Consult the Node.js documentation to learn how to configure your environment.
+
+::::
+
+
+For {{kib}}, adherence to FIPS 140-2 is ensured by:
+
+* Using FIPS approved / NIST recommended cryptographic algorithms.
+* Delegating the implementation of these cryptographic algorithms to a NIST validated cryptographic module (available via Node.js configured with an OpenSSL3 provider).
+* Allowing the configuration of {{kib}} in a FIPS 140-2 compliant manner, as documented below.
+
+## Configuring {{kib}} for FIPS 140-2 [_configuring_kib_for_fips_140_2]
+
+Apart from setting `xpack.security.fipsMode.enabled` to `true` in your {{kib}} config, a number of security related settings need to be reviewed and configured in order to run {{kib}} successfully in a FIPS 140-2 compliant Node.js environment.
+
+### {{kib}} keystore [_kibana_keystore]
+
+FIPS 140-2 (via NIST Special Publication 800-132) dictates that encryption keys should at least have an effective strength of 112 bits. As such, the {{kib}} keystore that stores the application’s secure settings needs to be password protected with a password that satisfies this requirement. This means that the password needs to be 14 bytes long which is equivalent to a 14 character ASCII encoded password, or a 7 character UTF-8 encoded password.
+
+For more information on how to set this password, refer to the [keystore documentation](/deploy-manage/security/secure-settings.md#change-password).
+
+
+### TLS keystore and keys [_tls_keystore_and_keys]
+
+Keystores can be used in a number of General TLS settings in order to conveniently store key and trust material. PKCS#12 keystores cannot be used in a FIPS 140-2 compliant Node.js environment. Avoid using these types of keystores. Your FIPS 140-2 provider may provide a compliant keystore implementation that can be used, or you can use PEM encoded files. To use PEM encoded key material, you can use the relevant `\*.key` and `*.certificate` configuration options, and for trust material you can use `*.certificate_authorities`.
+
+As an example, avoid PKCS#12 specific settings such as:
+
+* `server.ssl.keystore.path`
+* `server.ssl.truststore.path`
+* `elasticsearch.ssl.keystore.path`
+* `elasticsearch.ssl.truststore.path`

deploy-manage/security/fips.md

@@ -0,0 +1,27 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/reference/current/fips-140-compliance.html
+  - https://www.elastic.co/guide/en/kibana/current/xpack-security-fips-140-2.html
+applies_to:
+  deployment:
+    self: ga
+products:
+  - id: elasticsearch
+  - id: kibana
+  - id: elastic-agent
+  - id: beats
+  - id: fleet
+  - id: apm
+---
+
+# FIPS 140-2 compliance
+
+The Federal Information Processing Standard (FIPS) Publication 140-2, (FIPS PUB 140-2), titled "Security Requirements for Cryptographic Modules" is a U.S. government computer security standard used to approve cryptographic modules.
+- [{{es}}](/deploy-manage/security/fips-es.md) offers a FIPS 140-2 compliant mode and as such can run in a FIPS 140-2 configured JVM.
+- [{{kib}}](/deploy-manage/security/fips-kib.md) offers a FIPS 140-2 compliant mode and as such can run in a Node.js environment configured with a FIPS 140-2 compliant OpenSSL3 provider.
+- Some [Ingest tools](/deploy-manage/security/fips-ingest.md), including {{agent}}, {{fleet}}, {{filebeat}}, {{metricbeat}}, and {{apm-server}}, are available as FIPS compatible binaries and can be configured to use FIPS 140-2 compliant cryptography.
+
+:::{note}
+If you are running {{es}} through {{eck}}, refer to [ECK FIPS compatibility](/deploy-manage/deploy/cloud-on-k8s/deploy-fips-compatible-version-of-eck.md).
+:::
+

deploy-manage/toc.yml

@@ -520,10 +520,14 @@ toc:
                   - file: security/logging-configuration/logfile-audit-output.md
               - file: security/logging-configuration/auditing-search-queries.md
               - file: security/logging-configuration/correlating-kibana-elasticsearch-audit-logs.md
-          - file: security/fips-140-2.md
       - file: security/secure-clients-integrations.md
       - file: security/httprest-clients-security.md
       - file: security/limitations.md
+      - file: security/fips.md
+        children:
+          - file: security/fips-es.md
+          - file: security/fips-kib.md
+          - file: security/fips-ingest.md
   - file: users-roles.md
     children:
       - file: users-roles/cloud-organization.md

docset.yml

@@ -1,3 +1,3 @@
 project: 'Elastic documentation'
 max_toc_depth: 2
 
@@ -144,6 +144,7 @@
   kib:   "Kibana"
   ls:   "Logstash"
   beats:   "Beats"
+  agentbeat:   "Agentbeat"
   auditbeat:   "Auditbeat"
   filebeat:   "Filebeat"
   heartbeat:   "Heartbeat"
@@ -287,6 +288,7 @@
   release-date: "2-April-2025"
   heroku: "Elasticsearch Add-on for Heroku"
   obs-ai-assistant: "Elastic AI Assistant for Observability and Search"
+  apm-server: "APM Server"
   apm-server-or-mis: "APM Server or the managed intake service"
   apis: https://www.elastic.co/docs/api/
   es-apis: https://www.elastic.co/docs/api/doc/elasticsearch/