summaryrefslogtreecommitdiff
path: root/doc/html/basic
diff options
context:
space:
mode:
authorCy Schubert <cy@FreeBSD.org>2017-07-07 17:03:42 +0000
committerCy Schubert <cy@FreeBSD.org>2017-07-07 17:03:42 +0000
commit33a9b234e7087f573ef08cd7318c6497ba08b439 (patch)
treed0ea40ad3bf5463a3c55795977c71bcb7d781b4b /doc/html/basic
Notes
Diffstat (limited to 'doc/html/basic')
-rw-r--r--doc/html/basic/ccache_def.html286
-rw-r--r--doc/html/basic/date_format.html341
-rw-r--r--doc/html/basic/index.html149
-rw-r--r--doc/html/basic/keytab_def.html194
-rw-r--r--doc/html/basic/rcache_def.html230
-rw-r--r--doc/html/basic/stash_file_def.html158
6 files changed, 1358 insertions, 0 deletions
diff --git a/doc/html/basic/ccache_def.html b/doc/html/basic/ccache_def.html
new file mode 100644
index 000000000000..6f4a8924e7ba
--- /dev/null
+++ b/doc/html/basic/ccache_def.html
@@ -0,0 +1,286 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Credential cache &mdash; MIT Kerberos Documentation</title>
+
+ <link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/kerb.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '1.15.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="copyright" title="Copyright" href="../copyright.html" />
+ <link rel="top" title="MIT Kerberos Documentation" href="../index.html" />
+ <link rel="up" title="Kerberos V5 concepts" href="index.html" />
+ <link rel="next" title="keytab" href="keytab_def.html" />
+ <link rel="prev" title="Kerberos V5 concepts" href="index.html" />
+ </head>
+ <body>
+ <div class="header-wrapper">
+ <div class="header">
+
+
+ <h1><a href="../index.html">MIT Kerberos Documentation</a></h1>
+
+ <div class="rel">
+
+ <a href="../index.html" title="Full Table of Contents"
+ accesskey="C">Contents</a> |
+ <a href="index.html" title="Kerberos V5 concepts"
+ accesskey="P">previous</a> |
+ <a href="keytab_def.html" title="keytab"
+ accesskey="N">next</a> |
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ accesskey="S">Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Credential cache">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ <div class="content-wrapper">
+ <div class="content">
+ <div class="document">
+
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="credential-cache">
+<span id="ccache-definition"></span><h1>Credential cache<a class="headerlink" href="#credential-cache" title="Permalink to this headline">¶</a></h1>
+<p>A credential cache (or &#8220;ccache&#8221;) holds Kerberos credentials while they
+remain valid and, generally, while the user&#8217;s session lasts, so that
+authenticating to a service multiple times (e.g., connecting to a web
+or mail server more than once) doesn&#8217;t require contacting the KDC
+every time.</p>
+<p>A credential cache usually contains one initial ticket which is
+obtained using a password or another form of identity verification.
+If this ticket is a ticket-granting ticket, it can be used to obtain
+additional credentials without the password. Because the credential
+cache does not store the password, less long-term damage can be done
+to the user&#8217;s account if the machine is compromised.</p>
+<p>A credentials cache stores a default client principal name, set when
+the cache is created. This is the name shown at the top of the
+<a class="reference internal" href="../user/user_commands/klist.html#klist-1"><em>klist</em></a> <em>-A</em> output.</p>
+<p>Each normal cache entry includes a service principal name, a client
+principal name (which, in some ccache types, need not be the same as
+the default), lifetime information, and flags, along with the
+credential itself. There are also other entries, indicated by special
+names, that store additional information.</p>
+<div class="section" id="ccache-types">
+<h2>ccache types<a class="headerlink" href="#ccache-types" title="Permalink to this headline">¶</a></h2>
+<p>The credential cache interface, like the <a class="reference internal" href="keytab_def.html#keytab-definition"><em>keytab</em></a> and
+<a class="reference internal" href="rcache_def.html#rcache-definition"><em>replay cache</em></a> interfaces, uses <cite>TYPE:value</cite> strings to
+indicate the type of credential cache and any associated cache naming
+data to use.</p>
+<p>There are several kinds of credentials cache supported in the MIT
+Kerberos library. Not all are supported on every platform. In most
+cases, it should be correct to use the default type built into the
+library.</p>
+<ol class="arabic">
+<li><p class="first"><strong>API</strong> is only implemented on Windows. It communicates with a
+server process that holds the credentials in memory for the user,
+rather than writing them to disk.</p>
+</li>
+<li><p class="first"><strong>DIR</strong> points to the storage location of the collection of the
+credential caches in <em>FILE:</em> format. It is most useful when dealing
+with multiple Kerberos realms and KDCs. For release 1.10 the
+directory must already exist. In post-1.10 releases the
+requirement is for parent directory to exist and the current
+process must have permissions to create the directory if it does
+not exist. See <a class="reference internal" href="#col-ccache"><em>Collections of caches</em></a> for details. New in release 1.10.</p>
+</li>
+<li><p class="first"><strong>FILE</strong> caches are the simplest and most portable. A simple flat
+file format is used to store one credential after another. This is
+the default ccache type if no type is specified in a ccache name.</p>
+</li>
+<li><p class="first"><strong>KCM</strong> caches work by contacting a daemon process called <tt class="docutils literal"><span class="pre">kcm</span></tt>
+to perform cache operations. If the cache name is just <tt class="docutils literal"><span class="pre">KCM:</span></tt>,
+the default cache as determined by the KCM daemon will be used.
+Newly created caches must generally be named <tt class="docutils literal"><span class="pre">KCM:uid:name</span></tt>,
+where <em>uid</em> is the effective user ID of the running process.</p>
+<p>KCM client support is new in release 1.13. A KCM daemon has not
+yet been implemented in MIT krb5, but the client will interoperate
+with the KCM daemon implemented by Heimdal. OS X 10.7 and higher
+provides a KCM daemon as part of the operating system, and the
+<strong>KCM</strong> cache type is used as the default cache on that platform in
+a default build.</p>
+</li>
+<li><p class="first"><strong>KEYRING</strong> is Linux-specific, and uses the kernel keyring support
+to store credential data in unswappable kernel memory where only
+the current user should be able to access it. The following
+residual forms are supported:</p>
+<ul class="simple">
+<li>KEYRING:name</li>
+<li>KEYRING:process:name - process keyring</li>
+<li>KEYRING:thread:name - thread keyring</li>
+</ul>
+<p>Starting with release 1.12 the <em>KEYRING</em> type supports collections.
+The following new residual forms were added:</p>
+<ul class="simple">
+<li>KEYRING:session:name - session keyring</li>
+<li>KEYRING:user:name - user keyring</li>
+<li>KEYRING:persistent:uidnumber - persistent per-UID collection.
+Unlike the user keyring, this collection survives after the user
+logs out, until the cache credentials expire. This type of
+ccache requires support from the kernel; otherwise, it will fall
+back to the user keyring.</li>
+</ul>
+<p>See <a class="reference internal" href="#col-ccache"><em>Collections of caches</em></a> for details.</p>
+</li>
+<li><p class="first"><strong>MEMORY</strong> caches are for storage of credentials that don&#8217;t need to
+be made available outside of the current process. For example, a
+memory ccache is used by <a class="reference internal" href="../admin/admin_commands/kadmin_local.html#kadmin-1"><em>kadmin</em></a> to store the
+administrative ticket used to contact the admin server. Memory
+ccaches are faster than file ccaches and are automatically
+destroyed when the process exits.</p>
+</li>
+<li><p class="first"><strong>MSLSA</strong> is a Windows-specific cache type that accesses the
+Windows credential store.</p>
+</li>
+</ol>
+</div>
+<div class="section" id="collections-of-caches">
+<span id="col-ccache"></span><h2>Collections of caches<a class="headerlink" href="#collections-of-caches" title="Permalink to this headline">¶</a></h2>
+<p>Some credential cache types can support collections of multiple
+caches. One of the caches in the collection is designated as the
+<em>primary</em> and will be used when the collection is resolved as a cache.
+When a collection-enabled cache type is the default cache for a
+process, applications can search the specified collection for a
+specific client principal, and GSSAPI applications will automatically
+select between the caches in the collection based on criteria such as
+the target service realm.</p>
+<p>Credential cache collections are new in release 1.10, with support
+from the <strong>DIR</strong> and <strong>API</strong> ccache types. Starting in release 1.12,
+collections are also supported by the <strong>KEYRING</strong> ccache type.
+Collections are supported by the <strong>KCM</strong> ccache type in release 1.13.</p>
+<div class="section" id="tool-alterations-to-use-cache-collection">
+<h3>Tool alterations to use cache collection<a class="headerlink" href="#tool-alterations-to-use-cache-collection" title="Permalink to this headline">¶</a></h3>
+<ul class="simple">
+<li><a class="reference internal" href="../user/user_commands/kdestroy.html#kdestroy-1"><em>kdestroy</em></a> <em>-A</em> will destroy all caches in the collection.</li>
+<li>If the default cache type supports switching, <a class="reference internal" href="../user/user_commands/kinit.html#kinit-1"><em>kinit</em></a>
+<em>princname</em> will search the collection for a matching cache and
+store credentials there, or will store credentials in a new unique
+cache of the default type if no existing cache for the principal
+exists. Either way, kinit will switch to the selected cache.</li>
+<li><a class="reference internal" href="../user/user_commands/klist.html#klist-1"><em>klist</em></a> <em>-l</em> will list the caches in the collection.</li>
+<li><a class="reference internal" href="../user/user_commands/klist.html#klist-1"><em>klist</em></a> <em>-A</em> will show the content of all caches in the
+collection.</li>
+<li><a class="reference internal" href="../user/user_commands/kswitch.html#kswitch-1"><em>kswitch</em></a> <em>-p princname</em> will search the collection for a
+matching cache and switch to it.</li>
+<li><a class="reference internal" href="../user/user_commands/kswitch.html#kswitch-1"><em>kswitch</em></a> <em>-c cachename</em> will switch to a specified cache.</li>
+</ul>
+</div>
+</div>
+<div class="section" id="default-ccache-name">
+<h2>Default ccache name<a class="headerlink" href="#default-ccache-name" title="Permalink to this headline">¶</a></h2>
+<p>The default credential cache name is determined by the following, in
+descending order of priority:</p>
+<ol class="arabic simple">
+<li>The <strong>KRB5CCNAME</strong> environment variable. For example,
+<tt class="docutils literal"><span class="pre">KRB5CCNAME=DIR:/mydir/</span></tt>.</li>
+<li>The <strong>default_ccache_name</strong> profile variable in <a class="reference internal" href="../admin/conf_files/krb5_conf.html#libdefaults"><em>[libdefaults]</em></a>.</li>
+<li>The hardcoded default, <a class="reference internal" href="../mitK5defaults.html#paths"><em>DEFCCNAME</em></a>.</li>
+</ol>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="sidebar">
+ <h2>On this page</h2>
+ <ul>
+<li><a class="reference internal" href="#">Credential cache</a><ul>
+<li><a class="reference internal" href="#ccache-types">ccache types</a></li>
+<li><a class="reference internal" href="#collections-of-caches">Collections of caches</a><ul>
+<li><a class="reference internal" href="#tool-alterations-to-use-cache-collection">Tool alterations to use cache collection</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#default-ccache-name">Default ccache name</a></li>
+</ul>
+</li>
+</ul>
+
+ <br/>
+ <h2>Table of contents</h2>
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../user/index.html">For users</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">For administrators</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../appdev/index.html">For application developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../plugindev/index.html">For plugin module developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build/index.html">Building Kerberos V5</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Kerberos V5 concepts</a><ul class="current">
+<li class="toctree-l2 current"><a class="current reference internal" href="">Credential cache</a><ul class="simple">
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="keytab_def.html">keytab</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rcache_def.html">replay cache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="stash_file_def.html">stash file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="date_format.html">Supported date and time formats</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../formats/index.html">Protocols and file formats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mitK5features.html">MIT Kerberos features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build_this.html">How to build this documentation from the source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../about.html">Contributing to the MIT Kerberos Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
+</ul>
+
+ <br/>
+ <h4><a href="../index.html">Full Table of Contents</a></h4>
+ <h4>Search</h4>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ </div>
+
+ <div class="footer-wrapper">
+ <div class="footer" >
+ <div class="right" ><i>Release: 1.15.1</i><br />
+ &copy; <a href="../copyright.html">Copyright</a> 1985-2017, MIT.
+ </div>
+ <div class="left">
+
+ <a href="../index.html" title="Full Table of Contents"
+ >Contents</a> |
+ <a href="index.html" title="Kerberos V5 concepts"
+ >previous</a> |
+ <a href="keytab_def.html" title="keytab"
+ >next</a> |
+ <a href="../genindex.html" title="General Index"
+ >index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ >Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Credential cache">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ </body>
+</html> \ No newline at end of file
diff --git a/doc/html/basic/date_format.html b/doc/html/basic/date_format.html
new file mode 100644
index 000000000000..5e1d318d84a9
--- /dev/null
+++ b/doc/html/basic/date_format.html
@@ -0,0 +1,341 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Supported date and time formats &mdash; MIT Kerberos Documentation</title>
+
+ <link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/kerb.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '1.15.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="copyright" title="Copyright" href="../copyright.html" />
+ <link rel="top" title="MIT Kerberos Documentation" href="../index.html" />
+ <link rel="up" title="Kerberos V5 concepts" href="index.html" />
+ <link rel="next" title="Protocols and file formats" href="../formats/index.html" />
+ <link rel="prev" title="stash file" href="stash_file_def.html" />
+ </head>
+ <body>
+ <div class="header-wrapper">
+ <div class="header">
+
+
+ <h1><a href="../index.html">MIT Kerberos Documentation</a></h1>
+
+ <div class="rel">
+
+ <a href="../index.html" title="Full Table of Contents"
+ accesskey="C">Contents</a> |
+ <a href="stash_file_def.html" title="stash file"
+ accesskey="P">previous</a> |
+ <a href="../formats/index.html" title="Protocols and file formats"
+ accesskey="N">next</a> |
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ accesskey="S">Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Supported date and time formats">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ <div class="content-wrapper">
+ <div class="content">
+ <div class="document">
+
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="supported-date-and-time-formats">
+<span id="datetime"></span><h1>Supported date and time formats<a class="headerlink" href="#supported-date-and-time-formats" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="time-duration">
+<span id="duration"></span><h2>Time duration<a class="headerlink" href="#time-duration" title="Permalink to this headline">¶</a></h2>
+<p>This format is used to express a time duration in the Kerberos
+configuration files and user commands. The allowed formats are:</p>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="40%" />
+<col width="25%" />
+<col width="35%" />
+</colgroup>
+<tbody valign="top">
+<tr class="row-odd"><td>Format</td>
+<td>Example</td>
+<td>Value</td>
+</tr>
+<tr class="row-even"><td>h:m[:s]</td>
+<td>36:00</td>
+<td>36 hours</td>
+</tr>
+<tr class="row-odd"><td>NdNhNmNs</td>
+<td>8h30s</td>
+<td>8 hours 30 seconds</td>
+</tr>
+<tr class="row-even"><td>N (number of seconds)</td>
+<td>3600</td>
+<td>1 hour</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p>Here <em>N</em> denotes a number, <em>d</em> - days, <em>h</em> - hours, <em>m</em> - minutes,
+<em>s</em> - seconds.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The time interval should not exceed 2147483647 seconds.</p>
+</div>
+<p>Examples:</p>
+<div class="highlight-python"><div class="highlight"><pre>Request a ticket valid for one hour, five hours, 30 minutes
+and 10 days respectively:
+
+ kinit -l 3600
+ kinit -l 5:00
+ kinit -l 30m
+ kinit -l &quot;10d 0h 0m 0s&quot;
+</pre></div>
+</div>
+</div>
+<div class="section" id="getdate-time">
+<span id="getdate"></span><h2>getdate time<a class="headerlink" href="#getdate-time" title="Permalink to this headline">¶</a></h2>
+<p>Some of the kadmin and kdb5_util commands take a date-time in a
+human-readable format. Some of the acceptable date-time
+strings are:</p>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="39%" />
+<col width="37%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">&nbsp;</th>
+<th class="head">Format</th>
+<th class="head">Example</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td rowspan="3">Date</td>
+<td>mm/dd/yy</td>
+<td>07/27/12</td>
+</tr>
+<tr class="row-odd"><td>month dd, yyyy</td>
+<td>Jul 27, 2012</td>
+</tr>
+<tr class="row-even"><td>yyyy-mm-dd</td>
+<td>2012-07-27</td>
+</tr>
+<tr class="row-odd"><td rowspan="2">Absolute
+time</td>
+<td>HH:mm[:ss]pp</td>
+<td>08:30 PM</td>
+</tr>
+<tr class="row-even"><td>hh:mm[:ss]</td>
+<td>20:30</td>
+</tr>
+<tr class="row-odd"><td>Relative
+time</td>
+<td>N tt</td>
+<td>30 sec</td>
+</tr>
+<tr class="row-even"><td rowspan="2">Time zone</td>
+<td>Z</td>
+<td>EST</td>
+</tr>
+<tr class="row-odd"><td>z</td>
+<td>-0400</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p>(See <a class="reference internal" href="#abbreviation"><em>Abbreviations used in this document</em></a>.)</p>
+<p>Examples:</p>
+<div class="highlight-python"><div class="highlight"><pre>Create a principal that expires on the date indicated:
+ addprinc test1 -expire &quot;3/27/12 10:00:07 EST&quot;
+ addprinc test2 -expire &quot;January 23, 2015 10:05pm&quot;
+ addprinc test3 -expire &quot;22:00 GMT&quot;
+Add a principal that will expire in 30 minutes:
+ addprinc test4 -expire &quot;30 minutes&quot;
+</pre></div>
+</div>
+</div>
+<div class="section" id="absolute-time">
+<span id="abstime"></span><h2>Absolute time<a class="headerlink" href="#absolute-time" title="Permalink to this headline">¶</a></h2>
+<p>This rarely used date-time format can be noted in one of the
+following ways:</p>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="40%" />
+<col width="37%" />
+<col width="23%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Format</th>
+<th class="head">Example</th>
+<th class="head">Value</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>yyyymmddhhmmss</td>
+<td>20141231235900</td>
+<td rowspan="5">One minute
+before 2015</td>
+</tr>
+<tr class="row-odd"><td>yyyy.mm.dd.hh.mm.ss</td>
+<td>2014.12.31.23.59.00</td>
+</tr>
+<tr class="row-even"><td>yymmddhhmmss</td>
+<td>141231235900</td>
+</tr>
+<tr class="row-odd"><td>yy.mm.dd.hh.mm.ss</td>
+<td>14.12.31.23.59.00</td>
+</tr>
+<tr class="row-even"><td>dd-month-yyyy:hh:mm:ss</td>
+<td>31-Dec-2014:23:59:00</td>
+</tr>
+<tr class="row-odd"><td>hh:mm:ss</td>
+<td>20:00:00</td>
+<td rowspan="2">8 o&#8217;clock in
+the evening</td>
+</tr>
+<tr class="row-even"><td>hhmmss</td>
+<td>200000</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p>(See <a class="reference internal" href="#abbreviation"><em>Abbreviations used in this document</em></a>.)</p>
+<p>Example:</p>
+<div class="highlight-python"><div class="highlight"><pre>Set the default expiration date to July 27, 2012 at 20:30
+default_principal_expiration = 20120727203000
+</pre></div>
+</div>
+<div class="section" id="abbreviations-used-in-this-document">
+<span id="abbreviation"></span><h3>Abbreviations used in this document<a class="headerlink" href="#abbreviations-used-in-this-document" title="Permalink to this headline">¶</a></h3>
+<div class="line-block">
+<div class="line"><em>month</em> : locale’s month name or its abbreviation;</div>
+<div class="line"><em>dd</em> : day of month (01-31);</div>
+<div class="line"><em>HH</em> : hours (00-12);</div>
+<div class="line"><em>hh</em> : hours (00-23);</div>
+<div class="line"><em>mm</em> : in time - minutes (00-59); in date - month (01-12);</div>
+<div class="line"><em>N</em> : number;</div>
+<div class="line"><em>pp</em> : AM or PM;</div>
+<div class="line"><em>ss</em> : seconds (00-60);</div>
+<div class="line"><em>tt</em> : time units (hours, minutes, min, seconds, sec);</div>
+<div class="line"><em>yyyy</em> : year;</div>
+<div class="line"><em>yy</em> : last two digits of the year;</div>
+<div class="line"><em>Z</em> : alphabetic time zone abbreviation;</div>
+<div class="line"><em>z</em> : numeric time zone;</div>
+</div>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<ul class="last simple">
+<li>If the date specification contains spaces, you may need to
+enclose it in double quotes;</li>
+<li>All keywords are case-insensitive.</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="sidebar">
+ <h2>On this page</h2>
+ <ul>
+<li><a class="reference internal" href="#">Supported date and time formats</a><ul>
+<li><a class="reference internal" href="#time-duration">Time duration</a></li>
+<li><a class="reference internal" href="#getdate-time">getdate time</a></li>
+<li><a class="reference internal" href="#absolute-time">Absolute time</a><ul>
+<li><a class="reference internal" href="#abbreviations-used-in-this-document">Abbreviations used in this document</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+ <br/>
+ <h2>Table of contents</h2>
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../user/index.html">For users</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">For administrators</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../appdev/index.html">For application developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../plugindev/index.html">For plugin module developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build/index.html">Building Kerberos V5</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Kerberos V5 concepts</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="ccache_def.html">Credential cache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="keytab_def.html">keytab</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rcache_def.html">replay cache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="stash_file_def.html">stash file</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Supported date and time formats</a><ul class="simple">
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../formats/index.html">Protocols and file formats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mitK5features.html">MIT Kerberos features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build_this.html">How to build this documentation from the source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../about.html">Contributing to the MIT Kerberos Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
+</ul>
+
+ <br/>
+ <h4><a href="../index.html">Full Table of Contents</a></h4>
+ <h4>Search</h4>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ </div>
+
+ <div class="footer-wrapper">
+ <div class="footer" >
+ <div class="right" ><i>Release: 1.15.1</i><br />
+ &copy; <a href="../copyright.html">Copyright</a> 1985-2017, MIT.
+ </div>
+ <div class="left">
+
+ <a href="../index.html" title="Full Table of Contents"
+ >Contents</a> |
+ <a href="stash_file_def.html" title="stash file"
+ >previous</a> |
+ <a href="../formats/index.html" title="Protocols and file formats"
+ >next</a> |
+ <a href="../genindex.html" title="General Index"
+ >index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ >Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Supported date and time formats">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ </body>
+</html> \ No newline at end of file
diff --git a/doc/html/basic/index.html b/doc/html/basic/index.html
new file mode 100644
index 000000000000..268cec1d8928
--- /dev/null
+++ b/doc/html/basic/index.html
@@ -0,0 +1,149 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Kerberos V5 concepts &mdash; MIT Kerberos Documentation</title>
+
+ <link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/kerb.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '1.15.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="copyright" title="Copyright" href="../copyright.html" />
+ <link rel="top" title="MIT Kerberos Documentation" href="../index.html" />
+ <link rel="next" title="Credential cache" href="ccache_def.html" />
+ <link rel="prev" title="osconf.hin" href="../build/osconf.html" />
+ </head>
+ <body>
+ <div class="header-wrapper">
+ <div class="header">
+
+
+ <h1><a href="../index.html">MIT Kerberos Documentation</a></h1>
+
+ <div class="rel">
+
+ <a href="../index.html" title="Full Table of Contents"
+ accesskey="C">Contents</a> |
+ <a href="../build/osconf.html" title="osconf.hin"
+ accesskey="P">previous</a> |
+ <a href="ccache_def.html" title="Credential cache"
+ accesskey="N">next</a> |
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ accesskey="S">Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Kerberos V5 concepts">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ <div class="content-wrapper">
+ <div class="content">
+ <div class="document">
+
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="kerberos-v5-concepts">
+<span id="basic-concepts"></span><h1>Kerberos V5 concepts<a class="headerlink" href="#kerberos-v5-concepts" title="Permalink to this headline">¶</a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="ccache_def.html">Credential cache</a></li>
+<li class="toctree-l1"><a class="reference internal" href="keytab_def.html">keytab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="rcache_def.html">replay cache</a></li>
+<li class="toctree-l1"><a class="reference internal" href="stash_file_def.html">stash file</a></li>
+<li class="toctree-l1"><a class="reference internal" href="date_format.html">Supported date and time formats</a></li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="sidebar">
+ <h2>On this page</h2>
+ <ul>
+<li><a class="reference internal" href="#">Kerberos V5 concepts</a></li>
+</ul>
+
+ <br/>
+ <h2>Table of contents</h2>
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../user/index.html">For users</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">For administrators</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../appdev/index.html">For application developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../plugindev/index.html">For plugin module developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build/index.html">Building Kerberos V5</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Kerberos V5 concepts</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="ccache_def.html">Credential cache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="keytab_def.html">keytab</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rcache_def.html">replay cache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="stash_file_def.html">stash file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="date_format.html">Supported date and time formats</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../formats/index.html">Protocols and file formats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mitK5features.html">MIT Kerberos features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build_this.html">How to build this documentation from the source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../about.html">Contributing to the MIT Kerberos Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
+</ul>
+
+ <br/>
+ <h4><a href="../index.html">Full Table of Contents</a></h4>
+ <h4>Search</h4>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ </div>
+
+ <div class="footer-wrapper">
+ <div class="footer" >
+ <div class="right" ><i>Release: 1.15.1</i><br />
+ &copy; <a href="../copyright.html">Copyright</a> 1985-2017, MIT.
+ </div>
+ <div class="left">
+
+ <a href="../index.html" title="Full Table of Contents"
+ >Contents</a> |
+ <a href="../build/osconf.html" title="osconf.hin"
+ >previous</a> |
+ <a href="ccache_def.html" title="Credential cache"
+ >next</a> |
+ <a href="../genindex.html" title="General Index"
+ >index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ >Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Kerberos V5 concepts">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ </body>
+</html> \ No newline at end of file
diff --git a/doc/html/basic/keytab_def.html b/doc/html/basic/keytab_def.html
new file mode 100644
index 000000000000..d0fbeabe20df
--- /dev/null
+++ b/doc/html/basic/keytab_def.html
@@ -0,0 +1,194 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>keytab &mdash; MIT Kerberos Documentation</title>
+
+ <link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/kerb.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '1.15.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="copyright" title="Copyright" href="../copyright.html" />
+ <link rel="top" title="MIT Kerberos Documentation" href="../index.html" />
+ <link rel="up" title="Kerberos V5 concepts" href="index.html" />
+ <link rel="next" title="replay cache" href="rcache_def.html" />
+ <link rel="prev" title="Credential cache" href="ccache_def.html" />
+ </head>
+ <body>
+ <div class="header-wrapper">
+ <div class="header">
+
+
+ <h1><a href="../index.html">MIT Kerberos Documentation</a></h1>
+
+ <div class="rel">
+
+ <a href="../index.html" title="Full Table of Contents"
+ accesskey="C">Contents</a> |
+ <a href="ccache_def.html" title="Credential cache"
+ accesskey="P">previous</a> |
+ <a href="rcache_def.html" title="replay cache"
+ accesskey="N">next</a> |
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ accesskey="S">Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__keytab">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ <div class="content-wrapper">
+ <div class="content">
+ <div class="document">
+
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="keytab">
+<span id="keytab-definition"></span><h1>keytab<a class="headerlink" href="#keytab" title="Permalink to this headline">¶</a></h1>
+<p>A keytab (short for &#8220;key table&#8221;) stores long-term keys for one or more
+principals. Keytabs are normally represented by files in a standard
+format, although in rare cases they can be represented in other ways.
+Keytabs are used most often to allow server applications to accept
+authentications from clients, but can also be used to obtain initial
+credentials for client applications.</p>
+<p>Keytabs are named using the format <em>type</em><tt class="docutils literal"><span class="pre">:</span></tt><em>value</em>. Usually
+<em>type</em> is <tt class="docutils literal"><span class="pre">FILE</span></tt> and <em>value</em> is the absolute pathname of the file.
+Other possible values for <em>type</em> are <tt class="docutils literal"><span class="pre">SRVTAB</span></tt>, which indicates a
+file in the deprecated Kerberos 4 srvtab format, and <tt class="docutils literal"><span class="pre">MEMORY</span></tt>, which
+indicates a temporary keytab stored in the memory of the current
+process.</p>
+<p>A keytab contains one or more entries, where each entry consists of a
+timestamp (indicating when the entry was written to the keytab), a
+principal name, a key version number, an encryption type, and the
+encryption key itself.</p>
+<p>A keytab can be displayed using the <a class="reference internal" href="../user/user_commands/klist.html#klist-1"><em>klist</em></a> command with the
+<tt class="docutils literal"><span class="pre">-k</span></tt> option. Keytabs can be created or appended to by extracting
+keys from the KDC database using the <a class="reference internal" href="../admin/admin_commands/kadmin_local.html#kadmin-1"><em>kadmin</em></a> <a class="reference internal" href="../admin/admin_commands/kadmin_local.html#ktadd"><em>ktadd</em></a>
+command. Keytabs can be manipulated using the <a class="reference internal" href="../admin/admin_commands/ktutil.html#ktutil-1"><em>ktutil</em></a> and
+<a class="reference internal" href="../admin/admin_commands/k5srvutil.html#k5srvutil-1"><em>k5srvutil</em></a> commands.</p>
+<div class="section" id="default-keytab">
+<h2>Default keytab<a class="headerlink" href="#default-keytab" title="Permalink to this headline">¶</a></h2>
+<p>The default keytab is used by server applications if the application
+does not request a specific keytab. The name of the default keytab is
+determined by the following, in decreasing order of preference:</p>
+<ol class="arabic simple">
+<li>The <strong>KRB5_KTNAME</strong> environment variable.</li>
+<li>The <strong>default_keytab_name</strong> profile variable in <a class="reference internal" href="../admin/conf_files/krb5_conf.html#libdefaults"><em>[libdefaults]</em></a>.</li>
+<li>The hardcoded default, <a class="reference internal" href="../mitK5defaults.html#paths"><em>DEFKTNAME</em></a>.</li>
+</ol>
+</div>
+<div class="section" id="default-client-keytab">
+<h2>Default client keytab<a class="headerlink" href="#default-client-keytab" title="Permalink to this headline">¶</a></h2>
+<p>The default client keytab is used, if it is present and readable, to
+automatically obtain initial credentials for GSSAPI client
+applications. The principal name of the first entry in the client
+keytab is used by default when obtaining initial credentials. The
+name of the default client keytab is determined by the following, in
+decreasing order of preference:</p>
+<ol class="arabic simple">
+<li>The <strong>KRB5_CLIENT_KTNAME</strong> environment variable.</li>
+<li>The <strong>default_client_keytab_name</strong> profile variable in
+<a class="reference internal" href="../admin/conf_files/krb5_conf.html#libdefaults"><em>[libdefaults]</em></a>.</li>
+<li>The hardcoded default, <a class="reference internal" href="../mitK5defaults.html#paths"><em>DEFCKTNAME</em></a>.</li>
+</ol>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="sidebar">
+ <h2>On this page</h2>
+ <ul>
+<li><a class="reference internal" href="#">keytab</a><ul>
+<li><a class="reference internal" href="#default-keytab">Default keytab</a></li>
+<li><a class="reference internal" href="#default-client-keytab">Default client keytab</a></li>
+</ul>
+</li>
+</ul>
+
+ <br/>
+ <h2>Table of contents</h2>
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../user/index.html">For users</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">For administrators</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../appdev/index.html">For application developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../plugindev/index.html">For plugin module developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build/index.html">Building Kerberos V5</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Kerberos V5 concepts</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="ccache_def.html">Credential cache</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">keytab</a><ul class="simple">
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="rcache_def.html">replay cache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="stash_file_def.html">stash file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="date_format.html">Supported date and time formats</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../formats/index.html">Protocols and file formats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mitK5features.html">MIT Kerberos features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build_this.html">How to build this documentation from the source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../about.html">Contributing to the MIT Kerberos Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
+</ul>
+
+ <br/>
+ <h4><a href="../index.html">Full Table of Contents</a></h4>
+ <h4>Search</h4>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ </div>
+
+ <div class="footer-wrapper">
+ <div class="footer" >
+ <div class="right" ><i>Release: 1.15.1</i><br />
+ &copy; <a href="../copyright.html">Copyright</a> 1985-2017, MIT.
+ </div>
+ <div class="left">
+
+ <a href="../index.html" title="Full Table of Contents"
+ >Contents</a> |
+ <a href="ccache_def.html" title="Credential cache"
+ >previous</a> |
+ <a href="rcache_def.html" title="replay cache"
+ >next</a> |
+ <a href="../genindex.html" title="General Index"
+ >index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ >Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__keytab">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ </body>
+</html> \ No newline at end of file
diff --git a/doc/html/basic/rcache_def.html b/doc/html/basic/rcache_def.html
new file mode 100644
index 000000000000..3bc9690898c5
--- /dev/null
+++ b/doc/html/basic/rcache_def.html
@@ -0,0 +1,230 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>replay cache &mdash; MIT Kerberos Documentation</title>
+
+ <link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/kerb.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '1.15.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="copyright" title="Copyright" href="../copyright.html" />
+ <link rel="top" title="MIT Kerberos Documentation" href="../index.html" />
+ <link rel="up" title="Kerberos V5 concepts" href="index.html" />
+ <link rel="next" title="stash file" href="stash_file_def.html" />
+ <link rel="prev" title="keytab" href="keytab_def.html" />
+ </head>
+ <body>
+ <div class="header-wrapper">
+ <div class="header">
+
+
+ <h1><a href="../index.html">MIT Kerberos Documentation</a></h1>
+
+ <div class="rel">
+
+ <a href="../index.html" title="Full Table of Contents"
+ accesskey="C">Contents</a> |
+ <a href="keytab_def.html" title="keytab"
+ accesskey="P">previous</a> |
+ <a href="stash_file_def.html" title="stash file"
+ accesskey="N">next</a> |
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ accesskey="S">Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__replay cache">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ <div class="content-wrapper">
+ <div class="content">
+ <div class="document">
+
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="replay-cache">
+<span id="rcache-definition"></span><h1>replay cache<a class="headerlink" href="#replay-cache" title="Permalink to this headline">¶</a></h1>
+<p>A replay cache (or &#8220;rcache&#8221;) keeps track of all authenticators
+recently presented to a service. If a duplicate authentication
+request is detected in the replay cache, an error message is sent to
+the application program.</p>
+<p>The replay cache interface, like the credential cache and
+<a class="reference internal" href="keytab_def.html#keytab-definition"><em>keytab</em></a> interfaces, uses <cite>type:value</cite> strings to
+indicate the type of replay cache and any associated cache naming
+data to use.</p>
+<div class="section" id="background-information">
+<h2>Background information<a class="headerlink" href="#background-information" title="Permalink to this headline">¶</a></h2>
+<p>Some Kerberos or GSSAPI services use a simple authentication mechanism
+where a message is sent containing an authenticator, which establishes
+the encryption key that the client will use for talking to the
+service. But nothing about that prevents an eavesdropper from
+recording the messages sent by the client, establishing a new
+connection, and re-sending or &#8220;replaying&#8221; the same messages; the
+replayed authenticator will establish the same encryption key for the
+new session, and the following messages will be decrypted and
+processed. The attacker may not know what the messages say, and can&#8217;t
+generate new messages under the same encryption key, but in some
+instances it may be harmful to the user (or helpful to the attacker)
+to cause the server to see the same messages again a second time. For
+example, if the legitimate client sends &#8220;delete first message in
+mailbox&#8221;, a replay from an attacker may delete another, different
+&#8220;first&#8221; message. (Protocol design to guard against such problems has
+been discussed in <span class="target" id="index-0"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc4120.html#section-10"><strong>RFC 4120</strong></a>.)</p>
+<p>Even if one protocol uses further protection to verify that the client
+side of the connection actually knows the encryption keys (and thus is
+presumably a legitimate user), if another service uses the same
+service principal name, it may be possible to record an authenticator
+used with the first protocol and &#8220;replay&#8221; it against the second.</p>
+<p>The replay cache mitigates these attacks somewhat, by keeping track of
+authenticators that have been seen until their five-minute window
+expires. Different authenticators generated by multiple connections
+from the same legitimate client will generally have different
+timestamps, and thus will not be considered the same.</p>
+<p>This mechanism isn&#8217;t perfect. If a message is sent to one application
+server but a man-in-the-middle attacker can prevent it from actually
+arriving at that server, the attacker could then use the authenticator
+(once!) against a different service on the same host. This could be a
+problem if the message from the client included something more than
+authentication in the first message that could be useful to the
+attacker (which is uncommon; in most protocols the server has to
+indicate a successful authentication before the client sends
+additional messages), or if the simple act of presenting the
+authenticator triggers some interesting action in the service being
+attacked.</p>
+</div>
+<div class="section" id="default-rcache-type">
+<h2>Default rcache type<a class="headerlink" href="#default-rcache-type" title="Permalink to this headline">¶</a></h2>
+<p>There is currently only one implemented kind of replay cache, called
+<strong>dfl</strong>. It stores replay data in one file, occasionally rewriting it
+to purge old, expired entries.</p>
+<p>The default type can be overridden by the <strong>KRB5RCACHETYPE</strong>
+environment variable.</p>
+<p>The placement of the replay cache file is determined by the following:</p>
+<ol class="arabic simple">
+<li>The <strong>KRB5RCACHEDIR</strong> environment variable;</li>
+<li>If KRB5RCACHEDIR is unspecified, on UNIX, the library
+will fall back to the environment variable <strong>TMPDIR</strong>, and then to
+a temporary directory determined at configuration time such as
+<em>/tmp</em> or <em>/var/tmp</em>; on Windows, it will check the environment
+variables <em>TEMP</em> and <em>TMP</em>, and fall back to the directory C:\.</li>
+</ol>
+</div>
+<div class="section" id="performance-issues">
+<h2>Performance issues<a class="headerlink" href="#performance-issues" title="Permalink to this headline">¶</a></h2>
+<p>Several known minor performance issues that may occur when replay
+cache is enabled on the Kerberos system include: delays due to writing
+the authenticator data to disk slowing down response time for very
+heavily loaded servers, and delays during the rewrite that may be
+unacceptable to high-performance services.</p>
+<p>For use cases where replays are adequately defended against for all
+protocols using a given service principal name, or where performance
+or other considerations outweigh the risk of replays, the special
+replay cache type &#8220;none&#8221; can be specified:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">KRB5RCACHETYPE</span><span class="o">=</span><span class="n">none</span>
+</pre></div>
+</div>
+<p>It doesn&#8217;t record any information about authenticators, and reports
+that any authenticator seen is not a replay.</p>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="sidebar">
+ <h2>On this page</h2>
+ <ul>
+<li><a class="reference internal" href="#">replay cache</a><ul>
+<li><a class="reference internal" href="#background-information">Background information</a></li>
+<li><a class="reference internal" href="#default-rcache-type">Default rcache type</a></li>
+<li><a class="reference internal" href="#performance-issues">Performance issues</a></li>
+</ul>
+</li>
+</ul>
+
+ <br/>
+ <h2>Table of contents</h2>
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../user/index.html">For users</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">For administrators</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../appdev/index.html">For application developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../plugindev/index.html">For plugin module developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build/index.html">Building Kerberos V5</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Kerberos V5 concepts</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="ccache_def.html">Credential cache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="keytab_def.html">keytab</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">replay cache</a><ul class="simple">
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="stash_file_def.html">stash file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="date_format.html">Supported date and time formats</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../formats/index.html">Protocols and file formats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mitK5features.html">MIT Kerberos features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build_this.html">How to build this documentation from the source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../about.html">Contributing to the MIT Kerberos Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
+</ul>
+
+ <br/>
+ <h4><a href="../index.html">Full Table of Contents</a></h4>
+ <h4>Search</h4>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ </div>
+
+ <div class="footer-wrapper">
+ <div class="footer" >
+ <div class="right" ><i>Release: 1.15.1</i><br />
+ &copy; <a href="../copyright.html">Copyright</a> 1985-2017, MIT.
+ </div>
+ <div class="left">
+
+ <a href="../index.html" title="Full Table of Contents"
+ >Contents</a> |
+ <a href="keytab_def.html" title="keytab"
+ >previous</a> |
+ <a href="stash_file_def.html" title="stash file"
+ >next</a> |
+ <a href="../genindex.html" title="General Index"
+ >index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ >Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__replay cache">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ </body>
+</html> \ No newline at end of file
diff --git a/doc/html/basic/stash_file_def.html b/doc/html/basic/stash_file_def.html
new file mode 100644
index 000000000000..a84eab2aa993
--- /dev/null
+++ b/doc/html/basic/stash_file_def.html
@@ -0,0 +1,158 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>stash file &mdash; MIT Kerberos Documentation</title>
+
+ <link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/kerb.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '1.15.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="copyright" title="Copyright" href="../copyright.html" />
+ <link rel="top" title="MIT Kerberos Documentation" href="../index.html" />
+ <link rel="up" title="Kerberos V5 concepts" href="index.html" />
+ <link rel="next" title="Supported date and time formats" href="date_format.html" />
+ <link rel="prev" title="replay cache" href="rcache_def.html" />
+ </head>
+ <body>
+ <div class="header-wrapper">
+ <div class="header">
+
+
+ <h1><a href="../index.html">MIT Kerberos Documentation</a></h1>
+
+ <div class="rel">
+
+ <a href="../index.html" title="Full Table of Contents"
+ accesskey="C">Contents</a> |
+ <a href="rcache_def.html" title="replay cache"
+ accesskey="P">previous</a> |
+ <a href="date_format.html" title="Supported date and time formats"
+ accesskey="N">next</a> |
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ accesskey="S">Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__stash file">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ <div class="content-wrapper">
+ <div class="content">
+ <div class="document">
+
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="stash-file">
+<span id="stash-definition"></span><h1>stash file<a class="headerlink" href="#stash-file" title="Permalink to this headline">¶</a></h1>
+<p>The stash file is a local copy of the master key that resides in
+encrypted form on the KDC&#8217;s local disk. The stash file is used to
+authenticate the KDC to itself automatically before starting the
+<a class="reference internal" href="../admin/admin_commands/kadmind.html#kadmind-8"><em>kadmind</em></a> and <a class="reference internal" href="../admin/admin_commands/krb5kdc.html#krb5kdc-8"><em>krb5kdc</em></a> daemons (e.g., as part of the
+machine&#8217;s boot sequence). The stash file, like the keytab file (see
+<a class="reference internal" href="../admin/install_appl_srv.html#keytab-file"><em>The keytab file</em></a>) is a potential point-of-entry for a break-in, and
+if compromised, would allow unrestricted access to the Kerberos
+database. If you choose to install a stash file, it should be
+readable only by root, and should exist only on the KDC&#8217;s local disk.
+The file should not be part of any backup of the machine, unless
+access to the backup data is secured as tightly as access to the
+master password itself.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">If you choose not to install a stash file, the KDC will prompt you for the master key each time it starts up.
+This means that the KDC will not be able to start automatically, such as after a system reboot.</p>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="sidebar">
+ <h2>On this page</h2>
+ <ul>
+<li><a class="reference internal" href="#">stash file</a></li>
+</ul>
+
+ <br/>
+ <h2>Table of contents</h2>
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../user/index.html">For users</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">For administrators</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../appdev/index.html">For application developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../plugindev/index.html">For plugin module developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build/index.html">Building Kerberos V5</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Kerberos V5 concepts</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="ccache_def.html">Credential cache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="keytab_def.html">keytab</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rcache_def.html">replay cache</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">stash file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="date_format.html">Supported date and time formats</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../formats/index.html">Protocols and file formats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mitK5features.html">MIT Kerberos features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../build_this.html">How to build this documentation from the source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../about.html">Contributing to the MIT Kerberos Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
+</ul>
+
+ <br/>
+ <h4><a href="../index.html">Full Table of Contents</a></h4>
+ <h4>Search</h4>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ </div>
+
+ <div class="footer-wrapper">
+ <div class="footer" >
+ <div class="right" ><i>Release: 1.15.1</i><br />
+ &copy; <a href="../copyright.html">Copyright</a> 1985-2017, MIT.
+ </div>
+ <div class="left">
+
+ <a href="../index.html" title="Full Table of Contents"
+ >Contents</a> |
+ <a href="rcache_def.html" title="replay cache"
+ >previous</a> |
+ <a href="date_format.html" title="Supported date and time formats"
+ >next</a> |
+ <a href="../genindex.html" title="General Index"
+ >index</a> |
+ <a href="../search.html" title="Enter search criteria"
+ >Search</a> |
+ <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__stash file">feedback</a>
+ </div>
+ </div>
+ </div>
+
+ </body>
+</html> \ No newline at end of file