configuring-native-realm.asciidoc 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. [role="xpack"]
  2. [[configuring-native-realm]]
  3. === Configuring a native realm
  4. The easiest way to manage and authenticate users is with the internal `native`
  5. realm.
  6. The native realm is available by default when no other realms are
  7. configured. If other realm settings have been configured in `elasticsearch.yml`,
  8. you must add the native realm to the realm chain.
  9. You can configure options for the `native` realm in the
  10. `xpack.security.authc.realms` namespace in `elasticsearch.yml`. Explicitly
  11. configuring a native realm enables you to set the order in which it appears in
  12. the realm chain, temporarily disable the realm, and control its cache options.
  13. . Add a realm configuration of type `native` to `elasticsearch.yml` under the
  14. `xpack.security.authc.realms` namespace. At a minimum, you must set the realm
  15. `type` to `native`. If you are configuring multiple realms, you should also
  16. explicitly set the `order` attribute.
  17. +
  18. --
  19. See <<ref-native-settings>> for all of the options you can set for the `native` realm.
  20. For example, the following snippet shows a `native` realm configuration that
  21. sets the `order` to zero so the realm is checked first:
  22. [source, yaml]
  23. ------------------------------------------------------------
  24. xpack:
  25. security:
  26. authc:
  27. realms:
  28. native1:
  29. type: native
  30. order: 0
  31. ------------------------------------------------------------
  32. NOTE: To limit exposure to credential theft and mitigate credential compromise,
  33. the native realm stores passwords and caches user credentials according to
  34. security best practices. By default, a hashed version of user credentials
  35. is stored in memory, using a salted `sha-256` hash algorithm and a hashed
  36. version of passwords is stored on disk salted and hashed with the `bcrypt`
  37. hash algorithm. To use different hash algorithms, see <<hashing-settings>>.
  38. --
  39. . Restart {es}.
  40. . Manage your users in {kib} on the *Management / Security / Users* page.
  41. Alternatively, use the <<security-api-users,User Management APIs>>.