Skip to content

Commit 534155f

Browse files
authored
Document new xpack.security.authc.* settings and related 8.0.0 breaking changes. (#61443)
1 parent 5d5c012 commit 534155f

File tree

3 files changed

+181
-66
lines changed

3 files changed

+181
-66
lines changed

docs/migration/migrate_8_0.asciidoc

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,24 +61,53 @@ for example, `logstash-*`.
6161
*Impact:* Use `xpack.security.authc.providers` instead.
6262

6363
[float]
64-
==== `xpack.security.authc.saml.realm` is now mandatory when using the SAML authentication provider
65-
*Details:* Previously Kibana was choosing the appropriate Elasticsearch SAML realm automatically using the `Assertion Consumer Service`
66-
URL that it derived from the actual server address. Starting in 8.0.0, the Elasticsearch SAML realm name that Kibana will use should be
67-
specified explicitly.
64+
==== `xpack.security.authc.providers` has changed value format
65+
*Details:* `xpack.security.authc.providers` setting in the `kibana.yml` has changed value format.
6866

69-
*Impact:* Always define `xpack.security.authc.saml.realm` when using the SAML authentication provider.
67+
*Impact:* Array of provider types as a value is no longer supported, use extended object format instead.
68+
69+
[float]
70+
==== `xpack.security.authc.saml` is no longer valid
71+
*Details:* The deprecated `xpack.security.authc.saml` setting in the `kibana.yml` file has been removed.
72+
73+
*Impact:* Configure SAML authentication providers using `xpack.security.authc.providers.saml.{provider unique name}.*` settings instead.
74+
75+
[float]
76+
==== `xpack.security.authc.oidc` is no longer valid
77+
*Details:* The deprecated `xpack.security.authc.oidc` setting in the `kibana.yml` file has been removed.
78+
79+
*Impact:* Configure OpenID Connect authentication providers using `xpack.security.authc.providers.oidc.{provider unique name}.*` settings instead.
7080

7181
[float]
7282
==== `xpack.security.public` is no longer valid
73-
*Details:* The deprecated `xpack.security.public` setting in the `kibana.yml` file has been removed.
83+
*Details:* Previously Kibana was choosing the appropriate Elasticsearch SAML realm automatically using the `Assertion Consumer Service`
84+
URL that it derived from the actual server address and `xpack.security.public` setting. Starting in 8.0.0, the deprecated `xpack.security.public` setting in the `kibana.yml` file has been removed and the Elasticsearch SAML realm name that Kibana will use should be specified explicitly.
7485

75-
*Impact:* Define `xpack.security.authc.saml.realm` when using the SAML authentication provider instead.
86+
*Impact:* Define `xpack.security.authc.providers.saml.{provider unique name}.realm` when using the SAML authentication providers instead.
7687

7788
[float]
7889
==== `/api/security/v1/saml` endpoint is no longer supported
7990
*Details:* The deprecated `/api/security/v1/saml` endpoint is no longer supported.
8091

81-
*Impact:* Rely on `/api/security/saml/callback` endpoint when using SAML instead. This change should be reflected in Kibana `server.xsrf.whitelist` config as well as in Elasticsearch and Identity Provider SAML settings.
92+
*Impact:* Rely on `/api/security/saml/callback` endpoint when using SAML instead. This change should be reflected in Elasticsearch and Identity Provider SAML settings.
93+
94+
[float]
95+
==== `/api/security/v1/oidc` endpoint is no longer supported
96+
*Details:* The deprecated `/api/security/v1/oidc` endpoint is no longer supported.
97+
98+
*Impact:* Rely on `/api/security/oidc/callback` endpoint when using OpenID Connect instead. This change should be reflected in Elasticsearch and OpenID Connect Provider settings.
99+
100+
[float]
101+
==== `/api/security/v1/oidc` endpoint is no longer supported for Third Party initiated login
102+
*Details:* The deprecated `/api/security/v1/oidc` endpoint is no longer supported for Third Party initiated login.
103+
104+
*Impact:* Rely on `/api/security/oidc/initiate_login` endpoint when using Third Party initiated OpenID Connect login instead. This change should be reflected in Elasticsearch and OpenID Connect Provider settings.
105+
106+
[float]
107+
==== `/api/security/v1/oidc/implicit` endpoint is no longer supported
108+
*Details:* The deprecated `/api/security/v1/oidc/implicit` endpoint is no longer supported.
109+
110+
*Impact:* Rely on `/api/security/oidc/implicit` endpoint when using OpenID Connect Implicit Flow instead. This change should be reflected in OpenID Connect Provider settings.
82111

83112
[float]
84113
=== `optimize` directory is now in the `data` folder

docs/setup/settings.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -410,9 +410,7 @@ all http requests to https over the port configured as `server.port`.
410410
supported protocols with versions. Valid protocols: `TLSv1`, `TLSv1.1`, `TLSv1.2`
411411

412412
`server.xsrf.whitelist:`:: It is not recommended to disable protections for
413-
arbitrary API endpoints. Instead, supply the `kbn-xsrf` header. There are some
414-
scenarios where whitelisting is required, however, such as
415-
<<kibana-authentication, SAML and OpenID Connect Single Sign-On setups>>.
413+
arbitrary API endpoints. Instead, supply the `kbn-xsrf` header.
416414
The `server.xsrf.whitelist` setting requires the following format:
417415

418416
[source,text]

0 commit comments

Comments
 (0)