Skip to content

Commit a4a2a09

Browse files
committed
Add note in breaking changes for nameid_format
We changed the default for `nameid_format` in 8.0 in elastic#44090 but did not add anything to the breaking changes in the release notes. This change amends that.
1 parent 201a328 commit a4a2a09

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

docs/reference/migration/migrate_8_0/security.asciidoc

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ on startup.
234234

235235
[discrete]
236236
[[ssl-misc-changes]]
237-
===== Other SSL/TLS changes
237+
===== Other SSL/TLS changes
238238

239239
.PKCS#11 keystores and trustores cannot be configured in `elasticsearch.yml`
240240
[%collapsible]
@@ -254,7 +254,7 @@ Use of a PKCS#11 keystore or truststore as the JRE's default store is not affect
254254
255255
*Impact* +
256256
If you have a PKCS#11 keystore configured within your `elasticsearch.yml` file, you must remove that
257-
configuration and switch to a supported keystore type, or configure your PKCS#11 keystore as the
257+
configuration and switch to a supported keystore type, or configure your PKCS#11 keystore as the
258258
JRE default store.
259259
====
260260

@@ -306,6 +306,41 @@ renamed to better reflect its intended use.
306306
*Impact* +
307307
Assign users with the `kibana_user` role to the `kibana_admin` role.
308308
Discontinue use of the `kibana_user` role.
309+
310+
[discrete]
311+
[[saml-realm-nameid-changes]]
312+
===== The default value of `nameid_format` setting has been removed.
313+
314+
.The `nameid_format` setting of SAML realms has no default value.
315+
[%collapsible]
316+
====
317+
*Details* +
318+
Identity Providers can be either statically configured to release a `NameID`
319+
with a specific format, or they can be configured to try to conform with the
320+
requirements of the SP. The SP declares its requirements as part of the
321+
Authentication Request, using an element which is called the `NameIDPolicy`
322+
For the {es} SAML realm, `NameIDPolicy` is controlled by `nameid_format` in
323+
<<saml-settings, SAML realm settings>>.
324+
325+
Previously, the default value for this setting was
326+
`urn:oasis:names:tc:SAML:2.0:nameid-format:transient` which meant that {es}
327+
would create SAML Authentication Requests that would require from the Identity
328+
Provider to release `NameID` with a transient format.
329+
The default value has now been removed. This means that {es} will be default
330+
create SAML Authentication Requests that do not put forward such requirements
331+
to the Identity Provider.
332+
333+
If you want to retain the previous behavior, you can set <<saml-settings, `nameid_format`>>
334+
to `urn:oasis:names:tc:SAML:2.0:nameid-format:transient`.
335+
336+
*Impact* +
337+
If you are not configuring <<saml-settings, `nameid_format`>> explicitly in
338+
your current configuration, there might be cases where the combination of this
339+
configuration and the configuration of your SAML Identity Provider will result
340+
in a non-working setup. If you are uncertain of how your Identity Provider is
341+
configured to generate a value for `NameID`, you can set <<saml-settings, `nameid_format`>>
342+
to `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` explicitly.
343+
309344
====
310345
// end::notable-breaking-changes[]
311346
@@ -320,7 +355,7 @@ Discontinue use of the `kibana_user` role.
320355
[%collapsible]
321356
====
322357
*Details* +
323-
If `xpack.security.fips_mode.enabled` is true (see <<fips-140-compliance>>),
358+
If `xpack.security.fips_mode.enabled` is true (see <<fips-140-compliance>>),
324359
the value of `xpack.security.authc.password_hashing.algorithm` now defaults to
325360
`pbkdf2_stretch`.
326361

0 commit comments

Comments
 (0)