Skip to content
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

Add note in breaking changes for nameid_format #77785

Merged
merged 7 commits into from
Oct 19, 2021
Merged
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions docs/reference/migration/migrate_8_0/security.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,38 @@ Specifying this setting in a transport profile in `elasticsearch.yml` will
result in an error on startup.
====

[discrete]
[[saml-realm-nameid-changes]]
.The `nameid_format` SAML realm setting no longer has a default value.
[%collapsible]
====
*Details* +
In SAML, Identity Providers (IdPs) can either be explicitly configured to
release a `NameID` with a specific format, or configured to attempt to conform
with the requirements of a Service Provider (SP). The SP declares its
requirements in the `NameIDPolicy` element of a SAML Authentication Request.
In {es}, the `nameid_format` SAML realm setting controls the `NameIDPolicy`
value.

Previously, the default value for `nameid_format` was
`urn:oasis:names:tc:SAML:2.0:nameid-format:transient`. This setting created
authentication requests that required the IdP to release `NameID` with a
`transient` format.

The default value has been removed, which means that {es} will create SAML Authentication Requests by default that don't put this requirement on the
IdP. If you want to retain the previous behavior, set `nameid_format` to
`urn:oasis:names:tc:SAML:2.0:nameid-format:transient`.

*Impact* +
If you currently don't configure `nameid_format` explicitly, it's possible
that your IdP will reject authentication request from {es} because the requests
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
do not specify a `NameID` format (and your IdP is configured to expect one).
This mismatch can result in a broken SAML configuration. If you're unsure which
name format your IdP uses to generate a value for `NameID`, try setting
`nameid_format` to `urn:oasis:names:tc:SAML:2.0:nameid-format:transient`
explicitly.
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
====

[discrete]
[[ssl-validation-changes]]
===== SSL/TLS configuration validation
Expand Down Expand Up @@ -234,7 +266,7 @@ on startup.

[discrete]
[[ssl-misc-changes]]
===== Other SSL/TLS changes
===== Other SSL/TLS changes

.PKCS#11 keystores and trustores cannot be configured in `elasticsearch.yml`
[%collapsible]
Expand All @@ -254,7 +286,7 @@ Use of a PKCS#11 keystore or truststore as the JRE's default store is not affect

*Impact* +
If you have a PKCS#11 keystore configured within your `elasticsearch.yml` file, you must remove that
configuration and switch to a supported keystore type, or configure your PKCS#11 keystore as the
configuration and switch to a supported keystore type, or configure your PKCS#11 keystore as the
JRE default store.
====

Expand Down Expand Up @@ -307,6 +339,7 @@ renamed to better reflect its intended use.
Assign users with the `kibana_user` role to the `kibana_admin` role.
Discontinue use of the `kibana_user` role.
====

// end::notable-breaking-changes[]

// These are non-notable changes
Expand All @@ -320,7 +353,7 @@ Discontinue use of the `kibana_user` role.
[%collapsible]
====
*Details* +
If `xpack.security.fips_mode.enabled` is true (see <<fips-140-compliance>>),
If `xpack.security.fips_mode.enabled` is true (see <<fips-140-compliance>>),
the value of `xpack.security.authc.password_hashing.algorithm` now defaults to
`pbkdf2_stretch`.

Expand Down