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 3 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
42 changes: 39 additions & 3 deletions docs/reference/migration/migrate_8_0/security.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,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 +254,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 @@ -306,6 +306,42 @@ renamed to better reflect its intended use.
*Impact* +
Assign users with the `kibana_user` role to the `kibana_admin` role.
Discontinue use of the `kibana_user` role.
====

[discrete]
[[saml-realm-nameid-changes]]
===== The default value of `nameid_format` setting has been removed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd remove this heading (keep the anchor) and relocate these changes just below the section for The transport.profiles.*.xpack.security.type setting has been removed.

Suggested change
===== The default value of `nameid_format` setting has been removed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed! I'll implement that change.

.The `nameid_format` setting of SAML realms has no default value.
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
[%collapsible]
====
*Details* +
Identity Providers can be either statically configured to release a `NameID`
with a specific format, or they can be configured to try to conform with the
requirements of the SP. The SP declares its requirements as part of the
Authentication Request, using an element which is called the `NameIDPolicy`
For the {es} SAML realm, `NameIDPolicy` is controlled by `nameid_format` in
SAML realm settings.
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved

Previously, the default value for this setting was
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
`urn:oasis:names:tc:SAML:2.0:nameid-format:transient` which meant that {es}
would create SAML Authentication Requests that would require from the Identity
Provider to release `NameID` with a transient format.
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
The default value has now been removed. This means that {es} will be default
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The default value has now been removed. This means that {es} will be default
The default value has now been removed. This means that {es} will by default

create SAML Authentication Requests that do not put forward such requirements
to the Identity Provider.

If you want to retain the previous behavior, you can set `nameid_format`
to `urn:oasis:names:tc:SAML:2.0:nameid-format:transient`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we can remove the second sentence.

Suggested change
The default value has now been removed. This means that {es} will be default
create SAML Authentication Requests that do not put forward such requirements
to the Identity Provider.
If you want to retain the previous behavior, you can set `nameid_format`
to `urn:oasis:names:tc:SAML:2.0:nameid-format:transient`.
This default has been removed. To retain the previous default behavior, set
`nameid_format` to `urn:oasis:names:tc:SAML:2.0:nameid-format:transient`.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it makes sense to remove this. This is the essence of what changes and what this change means.


*Impact* +
If you are not configuring `nameid_format` explicitly in
your current configuration, there might be cases where the combination of this
configuration and the configuration of your SAML Identity Provider will result
in a non-working setup. If you are uncertain of how your Identity Provider is
configured to generate a value for `NameID`, you can set `nameid_format`
to `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` explicitly.
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved

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

Expand All @@ -320,7 +356,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