-
Notifications
You must be signed in to change notification settings - Fork 113
FIPS for ingest tools #2136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
karenzone
wants to merge
6
commits into
elastic:main
Choose a base branch
from
karenzone:1735-fips
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+331
−212
Open
FIPS for ingest tools #2136
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5ddd6d5
FIPS for ingest tools
karenzone 4357c21
Restructuring a new content
karenzone 4c67eb8
Incorporate review comments
karenzone 3122289
Merge branch 'main' into 1735-fips
karenzone 0305d27
Update links, apply standards, smooth text
karenzone 81339ca
List integrations that are not FIPS compatible
karenzone File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,92 @@ | ||
--- | ||
applies_to: | ||
deployment: ga | ||
navigation_title: | ||
products: | ||
- id: apm | ||
- id: beats | ||
- id: elastic-agent | ||
- 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. | ||
|
||
|
||
## Limitations [ingest-limitations-all] | ||
|
||
### TLS [ingest-limitations-tls] | ||
|
||
Only FIPS 140-2 compliant TLS protocols, ciphers, and curve types can be used. | ||
* 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 [Office 365 module (Beta)](beats://reference/filebeat/filebeat-module-o365.md) is currently not supported. The [Add Cloud Metadata processor](beats://reference/filebeat/add-cloud-metadata.md) does not support the Azure Virtual Machine provider currently. | ||
* The [GCP Pub/Sub input](beats://reference/filebeat/filebeat-input-gcp-pubsub.md) is not supported for now. | ||
|
||
### 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 [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 using {{agent}} and {{fleet-server}}, the same restrictions listed previously for {{metricbeat}} and {{filebeat}} modules, inputs and processors apply to the respective Integrations. | ||
Additionally, these limitations apply: | ||
* The [Prometheus Receiver](https://www.elastic.co/docs/reference/integrations/prometheus) is not supported. | ||
* Running {{agent}} in [OpenTelemetry mode](https://github.com/elastic/elastic-agent/blob/main/internal/pkg/otel/README.md) is not yet supported. | ||
|
||
<br> | ||
::::{admonition} Some Elastic Integrations are not FIPS compatible | ||
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) | ||
|
||
Omission from this list does not indicate that integrations are FIPS compliant. | ||
:::: |
This file contains hidden or 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 |
---|---|---|
@@ -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` |
This file contains hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.