diff options
author | Greg Hudson <ghudson@mit.edu> | 2020-03-16 18:14:30 -0400 |
---|---|---|
committer | Greg Hudson <ghudson@mit.edu> | 2020-03-18 10:45:27 -0400 |
commit | ffbd726efec68859a601f5dc27bc00926a5a73f0 (patch) | |
tree | 3b462e1e8bda592f1026904739b6a867329798ef | |
parent | c61905eb0c589b3046b81b61d635eb08c8667302 (diff) | |
download | krb5-ffbd726efec68859a601f5dc27bc00926a5a73f0.zip krb5-ffbd726efec68859a601f5dc27bc00926a5a73f0.tar.gz krb5-ffbd726efec68859a601f5dc27bc00926a5a73f0.tar.bz2 |
Document client keytab usage
(cherry picked from commit 366c64897d55c86cdc616d2d1cf4617ff8a07a99)
ticket: 8886
version_fixed: 1.18.1
-rw-r--r-- | doc/admin/appl_servers.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/admin/appl_servers.rst b/doc/admin/appl_servers.rst index fee49f0..5232db9 100644 --- a/doc/admin/appl_servers.rst +++ b/doc/admin/appl_servers.rst @@ -60,6 +60,43 @@ To remove a principal from an existing keytab, use the kadmin :end-before: _ktremove_end: +Using a keytab to acquire client credentials +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +While keytabs are ordinarily used to accept credentials from clients, +they can also be used to acquire initial credentials, allowing one +service to authenticate to another. + +To manually obtain credentials using a keytab, use the :ref:`kinit(1)` +**-k** option, together with the **-t** option if the keytab is not in +the default location. + +Beginning with release 1.11, GSSAPI applications can be configured to +automatically obtain initial credentials from a keytab as needed. The +recommended configuration is as follows: + +#. Create a keytab containing a single entry for the desired client + identity. + +#. Place the keytab in a location readable by the service, and set the + **KRB5_CLIENT_KTNAME** environment variable to its filename. + Alternatively, use the **default_client_keytab_name** profile + variable in :ref:`libdefaults`, or use the default location of + |ckeytab|. + +#. Set **KRB5CCNAME** to a filename writable by the service, which + will not be used for any other purpose. Do not manually obtain + credentials at this location. (Another credential cache type + besides **FILE** can be used if desired, as long the cache will not + conflict with another use. A **MEMORY** cache can be used if the + service runs as a long-lived process. See :ref:`ccache_definition` + for details.) + +#. Start the service. When it authenticates using GSSAPI, it will + automatically obtain credentials from the client keytab into the + specified credential cache, and refresh them before they expire. + + Clock Skew ---------- |