-
Notifications
You must be signed in to change notification settings - Fork 257
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
[Kerberos] Add stack documentation for Kerberos realm #98
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a6a476a
[Kerberos] Add stack documentation for Kerberos realm
616d5ba
[DOCS] Small edit to kerberos realm page
lcawl 6f9d42b
[DOCS] Adds Kerberos terminology
lcawl 7faff16
Address review comments
f21e320
Merge branch 'master' into kerberos-stack-documentation
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 63 additions & 0 deletions
63
docs/en/stack/security/authentication/kerberos-realm.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
[role="xpack"] | ||
[[kerberos-realm]] | ||
=== Kerberos authentication | ||
|
||
You can configure {security} to support Kerberos V5 authentication, | ||
an industry standard protocol to authenticate users in {es}. | ||
|
||
NOTE: You cannot use the Kerberos realm to authenticate users in {kib} | ||
and on the transport network layer. | ||
|
||
To authenticate users with Kerberos, you need to | ||
{ref}/configuring-kerberos-realm.html[configure a Kerberos realm] and | ||
<<mapping-roles, map users to {security} roles>>. | ||
For more information on realm settings, see | ||
{ref}/security-settings.html#ref-kerberos-settings[Kerberos realm settings]. | ||
|
||
[[kerberos-terms]] | ||
==== Key concepts | ||
|
||
There are a few terms and concepts that you'll encounter when you're setting up | ||
Kerberos realms: | ||
|
||
_kdc_:: | ||
Key Distribution Center. A service that issues Kerberos tickets. | ||
|
||
_principal_:: | ||
A Kerberos principal is a unique identity to which Kerberos can assign | ||
tickets. It can be used to identify a user or a service provided by a | ||
server. | ||
+ | ||
-- | ||
Kerberos V5 principal names are of format `primary/instance@REALM`, where | ||
`primary` is a user name. | ||
|
||
`instance` is an optional string that qualifies the primary and is separated | ||
by a slash(`/`) from the primary. For a user, usually it is not used; for | ||
service hosts, it is the fully qualified domain name of the host. | ||
|
||
`REALM` is the Kerberos realm. Usually it is is the domain name in upper case. | ||
An example of a typical user principal is `user@ES.DOMAIN.LOCAL`. An example of | ||
a typical service principal is `HTTP/es.domain.local@ES.DOMAIN.LOCAL`. | ||
-- | ||
|
||
_realm_:: | ||
Realms define the administrative boundary within which the authentication server | ||
has authority to authenticate users and services. | ||
|
||
_keytab_:: | ||
A file that stores pairs of principals and encryption keys. | ||
|
||
IMPORTANT: Anyone with read permissions to this file can use the | ||
credentials in the network to access other services so it is important | ||
to protect it with proper file permissions. | ||
|
||
_krb5.conf_:: | ||
A file that contains Kerberos configuration information such as the default realm | ||
name, the location of Key distribution centers (KDC), realms information, | ||
mappings from domain names to Kerberos realms, and default configurations for | ||
realm session key encryption types. | ||
|
||
_ticket granting ticket (TGT)_:: | ||
A TGT is an authentication ticket generated by the Kerberos authentication | ||
server. It contains an encrypted authenticator. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 added this content here instead of elastic/elasticsearch#32662, since it seems like a better fit with the overview info. If you disagree, let me know!
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 wasn't sure about this when I added to the configuring Kerberos section as most of the action was there. But looking at it now makes sense here as it is an introduction part and helps to understand key concepts before moving on to the configuration part. Thank you.