overview.asciidoc 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. [role="xpack"]
  2. [[authorization]]
  3. == User authorization
  4. The {stack-security-features} add _authorization_, which is the process of determining whether the user behind an incoming request is allowed to execute
  5. the request.
  6. This process takes place after the user is successfully identified and
  7. <<setting-up-authentication,authenticated>>.
  8. [[roles]]
  9. [discrete]
  10. === Role-based access control
  11. The {security-features} provide a role-based access control (RBAC) mechanism,
  12. which enables you to authorize users by assigning privileges to roles and
  13. assigning roles to users or groups.
  14. image::security/authorization/images/authorization.png[This image illustrates role-based access control]
  15. The authorization process revolves around the following constructs:
  16. _Secured Resource_::
  17. A resource to which access is restricted. Indices, aliases, documents, fields,
  18. users, and the {es} cluster itself are all examples of secured objects.
  19. _Privilege_::
  20. A named group of one or more actions that a user may execute against a
  21. secured resource. Each secured resource has its own sets of available privileges.
  22. For example, `read` is an index privilege that represents all actions that enable
  23. reading the indexed/stored data. For a complete list of available privileges
  24. see <<security-privileges>>.
  25. _Permissions_::
  26. A set of one or more privileges against a secured resource. Permissions can
  27. easily be described in words, here are few examples:
  28. * `read` privilege on the `products` data stream or index
  29. * `manage` privilege on the cluster
  30. * `run_as` privilege on `john` user
  31. * `read` privilege on documents that match query X
  32. * `read` privilege on `credit_card` field
  33. _Role_::
  34. A named set of permissions
  35. _User_::
  36. The authenticated user.
  37. _Group_::
  38. One or more groups to which a user belongs. Groups are not supported in some
  39. realms, such as native, file, or PKI realms.
  40. A role has a unique name and identifies a set of permissions that translate to
  41. privileges on resources. You can associate a user or group with an arbitrary
  42. number of roles. When you map roles to groups, the roles of a user in that group
  43. are the combination of the roles assigned to that group and the roles assigned
  44. to that user. Likewise, the total set of permissions that a user has is defined
  45. by the union of the permissions in all its roles.
  46. The method for assigning roles to users varies depending on which realms you use
  47. to authenticate users. For more information, see <<mapping-roles>>.
  48. [[attributes]]
  49. [discrete]
  50. === Attribute-based access control
  51. The {security-features} also provide an attribute-based access control (ABAC)
  52. mechanism, which enables you to use attributes to restrict access to documents
  53. in search queries and aggregations. For example, you can assign attributes to
  54. users and documents, then implement an access policy in a role definition. Users
  55. with that role can read a specific document only if they have all the required
  56. attributes.
  57. For more information, see
  58. https://www.elastic.co/blog/attribute-based-access-control-with-xpack[Document-level attribute-based access control with X-Pack 6.1].
  59. include::built-in-roles.asciidoc[]
  60. include::managing-roles.asciidoc[]
  61. include::role-restriction.asciidoc[]
  62. include::privileges.asciidoc[]
  63. include::document-level-security.asciidoc[]
  64. include::field-level-security.asciidoc[]
  65. include::alias-privileges.asciidoc[]
  66. include::mapping-roles.asciidoc[]
  67. include::field-and-document-access-control.asciidoc[]
  68. include::run-as-privilege.asciidoc[leveloffset=+2]
  69. include::configuring-authorization-delegation.asciidoc[]
  70. include::custom-authorization.asciidoc[]