-
Notifications
You must be signed in to change notification settings - Fork 24.8k
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
Deprecating kibana_user and kibana_dashboard_only_user roles #46456
Changes from 15 commits
b2b1bf4
65d312a
44a8e2e
503ce9a
e964b06
d25f59a
a0dc610
98aa9fb
26c189e
44982a5
07aabc3
9417850
11df36b
250ec8f
1fcba52
a9502e0
df4c6e5
459c06c
54112e0
0a8f642
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -639,21 +639,28 @@ through either the | |
NOTE: You cannot use <<mapping-roles-file,role mapping files>> | ||
to grant roles to users authenticating via SAML. | ||
|
||
This is an example of a simple role mapping that grants the `kibana_user` role | ||
This is an example of a simple role mapping that grants the `siem_view` role | ||
to any user who authenticates against the `saml1` realm: | ||
|
||
[source,console] | ||
-------------------------------------------------- | ||
PUT /_security/role_mapping/saml-kibana | ||
{ | ||
"roles": [ "kibana_user" ], | ||
"roles": [ "siem_view" ], <1> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this will be confusing for some users. Since we're talking about a role that is not there, I'd opt for a generic role name role and a generic explanation below that they should create the role - as opposed to tying it (even as an example) to a product or to Kibana feature privileges cc @legrego |
||
"enabled": true, | ||
"rules": { | ||
"field": { "realm.name": "saml1" } | ||
} | ||
} | ||
-------------------------------------------------- | ||
|
||
<1> The `siem_view` role is *not* a builtin Elasticsearch role. | ||
This example assumes that you have created a custom role of your own, with | ||
`read` access to your SIEM <<roles-indices-priv,indices>> and `Read` access to | ||
the SIEM application using | ||
{kibana-ref}/kibana-privileges.html#kibana-feature-privileges[Kibana feature privileges]. | ||
You should create your own roles that provide access to the features that your | ||
users need. | ||
|
||
The attributes that are mapped via the realm configuration are used to process | ||
role mapping rules, and these rules determine which roles a user is granted. | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -72,10 +72,12 @@ NOTE: This role does *not* provide the ability to create indices; those privileg | |||||
must be defined in a separate role. | ||||||
|
||||||
[[built-in-roles-kibana-dashboard]] `kibana_dashboard_only_user` :: | ||||||
Grants access to the {kib} Dashboard and read-only permissions to Kibana. | ||||||
This role does not have access to editing tools in {kib}. For more | ||||||
information, see | ||||||
{kibana-ref}/xpack-dashboard-only-mode.html[{kib} Dashboard Only Mode]. | ||||||
(This role is deprecated, please use | ||||||
{kibana-ref}/kibana-privileges.html#kibana-feature-privileges[{kib} feature privileges] | ||||||
instead). | ||||||
Grants read-only access to the {kib} Dashboard in every | ||||||
{kibana-ref}/xpack-spaces.html[Space in {kib}]. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
This role does not have access to editing tools in {kib}. | ||||||
tvernum marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
[[built-in-roles-kibana-system]] `kibana_system` :: | ||||||
Grants access necessary for the {kib} system user to read from and write to the | ||||||
|
@@ -87,8 +89,14 @@ see {kibana-ref}/using-kibana-with-security.html[Configuring Security in {kib}]. | |||||
NOTE: This role should not be assigned to users as the granted permissions may | ||||||
change between releases. | ||||||
|
||||||
[[built-in-roles-kibana-admin]] `kibana_admin`:: | ||||||
Grants access to all features in {kib}. For more information on {kib} authorization, | ||||||
see {kibana-ref}/xpack-security-authorization.html[Kibana Authorization]. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
[[built-in-roles-kibana-user]] `kibana_user`:: | ||||||
Grants access to all features in {kib}. For more information on Kibana authorization, | ||||||
(This role is deprecated, please use the | ||||||
<<built-in-roles-kibana-admin,`kibana_admin`>> role instead.) | ||||||
Grants access to all features in {kib}. For more information on {kib} authorization, | ||||||
see {kibana-ref}/xpack-security-authorization.html[Kibana Authorization]. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
[[built-in-roles-logstash-admin]] `logstash_admin` :: | ||||||
|
@@ -127,7 +135,8 @@ Grants the minimum privileges required for any user of {monitoring} other than t | |||||
required to use {kib}. This role grants access to the monitoring indices and grants | ||||||
privileges necessary for reading basic cluster information. This role also includes | ||||||
all {kibana-ref}/kibana-privileges.html[Kibana privileges] for the {stack-monitor-features}. | ||||||
Monitoring users should also be assigned the `kibana_user` role. | ||||||
Monitoring users should also be assigned the `kibana_admin` role, or another role | ||||||
with {kibana-ref}/xpack-security-authorization.html[access to the {kib} instance] | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
[[built-in-roles-remote-monitoring-agent]] `remote_monitoring_agent`:: | ||||||
Grants the minimum privileges required to write data into the monitoring indices | ||||||
|
@@ -140,9 +149,10 @@ Grants the minimum privileges required to collect monitoring data for the {stack | |||||
[[built-in-roles-reporting-user]] `reporting_user`:: | ||||||
Grants the specific privileges required for users of {reporting} other than those | ||||||
required to use {kib}. This role grants access to the reporting indices; each | ||||||
user has access to only their own reports. Reporting users should also be | ||||||
assigned the `kibana_user` role and a role that grants them access to the data | ||||||
that will be used to generate reports. | ||||||
user has access to only their own reports. | ||||||
Reporting users should also be assigned additional roles that grant | ||||||
{kibana-ref}/xpack-security-authorization.html[Access to {kib}] as well as read | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
access to the <<roles-indices-priv,indices>> that will be used to generate reports. | ||||||
tvernum marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
[[built-in-roles-snapshot-user]] `snapshot_user`:: | ||||||
Grants the necessary privileges to create snapshots of **all** the indices and | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -31,8 +31,9 @@ NOTE: If you configure the local cluster as another remote in {es}, the | |||||
`logstash_reader` role on your local cluster also needs to grant the | ||||||
`read_cross_cluster` privilege. | ||||||
|
||||||
. Assign your {kib} users the `kibana_user` role and your `logstash_reader` | ||||||
role. | ||||||
. Assign your {kib} users a role that grants | ||||||
{kibana-ref}/xpack-security-authorization.html[Access to {kib}] | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
as well as your `logstash_reader` role. | ||||||
|
||||||
. On the remote cluster, create a `logstash_reader` role that grants the | ||||||
`read_cross_cluster` privilege and `read` and `view_index_metadata` privileges | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -168,15 +168,16 @@ Select a role to see more information about its privileges. For example, select | |||||
the `kibana_system` role to see its list of cluster and index privileges. To | ||||||
learn more, see <<privileges-list-indices>>. | ||||||
|
||||||
Let's assign the `kibana_user` role to your user. Go back to the | ||||||
*Management / Security / Users* page and select your user. Add the `kibana_user` | ||||||
Let's assign the `kibana_admin` role to your user. Go back to the | ||||||
*Management / Security / Users* page and select your user. Add the `kibana_admin` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note: This getting started doc intentionally uses |
||||||
role and save the change. For example: | ||||||
|
||||||
[role="screenshot"] | ||||||
image::security/images/assign-role.jpg["Assigning a role to a user in Kibana"] | ||||||
|
||||||
This user now has access to all features in {kib}. For more information about granting | ||||||
access to Kibana see {kibana-ref}/xpack-security-authorization.html[Kibana Authorization]. | ||||||
This user now has administrative access to all features in {kib}. | ||||||
For more information about granting access to Kibana see | ||||||
{kibana-ref}/xpack-security-authorization.html[Kibana Authorization]. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
If you completed all of the steps in | ||||||
{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}], you should | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this will be confusing for some users. Since we're talking about a role that is not there, I'd opt for a generic role name
role
and a generic explanation below that they should create the role - as opposed to tying it (even as an example) to a product or to Kibana feature privilegescc @legrego