xref: /freebsd/crypto/krb5/doc/html/_sources/user/user_config/k5identity.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1.. _.k5identity(5):
2
3.k5identity
4===========
5
6DESCRIPTION
7-----------
8
9The .k5identity file, which resides in a user's home directory,
10contains a list of rules for selecting a client principals based on
11the server being accessed.  These rules are used to choose a
12credential cache within the cache collection when possible.
13
14Blank lines and lines beginning with ``#`` are ignored.  Each line has
15the form:
16
17    *principal* *field*\=\ *value* ...
18
19If the server principal meets all of the field constraints, then
20principal is chosen as the client principal.  The following fields are
21recognized:
22
23**realm**
24    If the realm of the server principal is known, it is matched
25    against *value*, which may be a pattern using shell wildcards.
26    For host-based server principals, the realm will generally only be
27    known if there is a :ref:`domain_realm` section in
28    :ref:`krb5.conf(5)` with a mapping for the hostname.
29
30**service**
31    If the server principal is a host-based principal, its service
32    component is matched against *value*, which may be a pattern using
33    shell wildcards.
34
35**host**
36    If the server principal is a host-based principal, its hostname
37    component is converted to lower case and matched against *value*,
38    which may be a pattern using shell wildcards.
39
40    If the server principal matches the constraints of multiple lines
41    in the .k5identity file, the principal from the first matching
42    line is used.  If no line matches, credentials will be selected
43    some other way, such as the realm heuristic or the current primary
44    cache.
45
46
47EXAMPLE
48-------
49
50The following example .k5identity file selects the client principal
51``alice@KRBTEST.COM`` if the server principal is within that realm,
52the principal ``alice/root@EXAMPLE.COM`` if the server host is within
53a servers subdomain, and the principal ``alice/mail@EXAMPLE.COM`` when
54accessing the IMAP service on ``mail.example.com``::
55
56    alice@KRBTEST.COM       realm=KRBTEST.COM
57    alice/root@EXAMPLE.COM  host=*.servers.example.com
58    alice/mail@EXAMPLE.COM  host=mail.example.com service=imap
59
60
61SEE ALSO
62--------
63
64kerberos(1), :ref:`krb5.conf(5)`
65