aboutsummaryrefslogtreecommitdiffstats
path: root/doc/html/formats/ccache_file_format.html
blob: d3c132732bb4911fb98775ef15b86914a80bd3bc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<!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 file format &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.16',
        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="Protocols and file formats" href="index.html" />
    <link rel="next" title="Keytab file format" href="keytab_file_format.html" />
    <link rel="prev" title="Protocols and file formats" 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="Protocols and file formats"
            accesskey="P">previous</a> |
        <a href="keytab_file_format.html" title="Keytab file format"
            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 file format">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-file-format">
<span id="ccache-file-format"></span><h1>Credential cache file format<a class="headerlink" href="#credential-cache-file-format" title="Permalink to this headline"></a></h1>
<p>There are four versions of the file format used by the FILE credential
cache type.  The first byte of the file always has the value 5, and
the value of the second byte contains the version number (1 through
4).  Versions 1 and 2 of the file format use native byte order for integer
representations.  Versions 3 and 4 always use big-endian byte order.</p>
<p>After the two-byte version indicator, the file has three parts: the
header (in version 4 only), the default principal name, and a sequence
of credentials.</p>
<div class="section" id="header-format">
<h2>Header format<a class="headerlink" href="#header-format" title="Permalink to this headline"></a></h2>
<p>The header appears only in format version 4.  It begins with a 16-bit
integer giving the length of the entire header, followed by a sequence
of fields.  Each field consists of a 16-bit tag, a 16-bit length, and
a value of the given length.  A file format implementation should
ignore fields with unknown tags.</p>
<p>At this time there is only one defined header field.  Its tag value is
1, its length is always 8, and its contents are two 32-bit integers
giving the seconds and microseconds of the time offset of the KDC
relative to the client.  Adding this offset to the current time on the
client should give the current time on the KDC, if that offset has not
changed since the initial authentication.</p>
</div>
<div class="section" id="principal-format">
<span id="cache-principal-format"></span><h2>Principal format<a class="headerlink" href="#principal-format" title="Permalink to this headline"></a></h2>
<p>The default principal is marshalled using the following informal
grammar:</p>
<div class="highlight-python"><div class="highlight"><pre>principal ::=
    name type (32 bits) [omitted in version 1]
    count of components (32 bits) [includes realm in version 1]
    realm (data)
    component1 (data)
    component2 (data)
    ...

data ::=
    length (32 bits)
    value (length bytes)
</pre></div>
</div>
<p>There is no external framing on the default principal, so it must be
parsed according to the above grammar in order to find the sequence of
credentials which follows.</p>
</div>
<div class="section" id="credential-format">
<span id="ccache-credential-format"></span><h2>Credential format<a class="headerlink" href="#credential-format" title="Permalink to this headline"></a></h2>
<p>The credential format uses the following informal grammar (referencing
the <tt class="docutils literal"><span class="pre">principal</span></tt> and <tt class="docutils literal"><span class="pre">data</span></tt> types from the previous section):</p>
<div class="highlight-python"><div class="highlight"><pre>credential ::=
    client (principal)
    server (principal)
    keyblock (keyblock)
    authtime (32 bits)
    starttime (32 bits)
    endtime (32 bits)
    renew_till (32 bits)
    is_skey (1 byte, 0 or 1)
    ticket_flags (32 bits)
    addresses (addresses)
    authdata (authdata)
    ticket (data)
    second_ticket (data)

keyblock ::=
    enctype (16 bits) [repeated twice in version 3]
    data

addresses ::=
    count (32 bits)
    address1
    address2
    ...

address ::=
    addrtype (16 bits)
    data

authdata ::=
    count (32 bits)
    authdata1
    authdata2
    ...

authdata ::=
    ad_type (16 bits)
    data
</pre></div>
</div>
<p>There is no external framing on a marshalled credential, so it must be
parsed according to the above grammar in order to find the next
credential.  There is also no count of credentials or marker at the
end of the sequence of credentials; the sequence ends when the file
ends.</p>
</div>
<div class="section" id="credential-cache-configuration-entries">
<h2>Credential cache configuration entries<a class="headerlink" href="#credential-cache-configuration-entries" title="Permalink to this headline"></a></h2>
<p>Configuration entries are encoded as credential entries.  The client
principal of the entry is the default principal of the cache.  The
server principal has the realm <tt class="docutils literal"><span class="pre">X-CACHECONF:</span></tt> and two or three
components, the first of which is <tt class="docutils literal"><span class="pre">krb5_ccache_conf_data</span></tt>.  The
server principal&#8217;s second component is the configuration key.  The
third component, if it exists, is a principal to which the
configuration key is associated.  The configuration value is stored in
the ticket field of the entry.  All other entry fields are zeroed.</p>
<p>Programs using credential caches must be aware of configuration
entries for several reasons:</p>
<ul class="simple">
<li>A program which displays the contents of a cache should not
generally display configuration entries.</li>
<li>The ticket field of a configuration entry is not (usually) a valid
encoding of a Kerberos ticket.  An implementation must not treat the
cache file as malformed if it cannot decode the ticket field.</li>
<li>Configuration entries have an endtime field of 0 and might therefore
always be considered expired, but they should not be treated as
unimportant as a result.  For instance, a program which copies
credentials from one cache to another should not omit configuration
entries because of the endtime.</li>
</ul>
<p>The following configuration keys are currently used in MIT krb5:</p>
<dl class="docutils">
<dt>fast_avail</dt>
<dd>The presence of this key with a non-empty value indicates that the
KDC asserted support for FAST (see <span class="target" id="index-0"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc6113.html"><strong>RFC 6113</strong></a>) during the initial
authentication, using the negotiation method described in
<span class="target" id="index-1"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc6806.html"><strong>RFC 6806</strong></a> section 11.  This key is not associated with any
principal.</dd>
<dt>pa_config_data</dt>
<dd>The value of this key contains a JSON object representation of
parameters remembered by the preauthentication mechanism used
during the initial authentication.  These parameters may be used
when refreshing credentials.  This key is associated with the
server principal of the initial authentication (usually the local
krbtgt principal of the client realm).</dd>
<dt>pa_type</dt>
<dd>The value of this key is the ASCII decimal representation of the
preauth type number used during the initial authentication.  This
key is associated with the server principal of the initial
authentication.</dd>
<dt>proxy_impersonator</dt>
<dd>The presence of this key indicates that the cache is a synthetic
delegated credential for use with S4U2Proxy.  The value is the
name of the intermediate service whose TGT can be used to make
S4U2Proxy requests for target services.  This key is not
associated with any principal.</dd>
<dt>refresh_time</dt>
<dd>The presence of this key indicates that the cache was acquired by
the GSS mechanism using a client keytab.  The value is the ASCII
decimal representation of a timestamp at which the GSS mechanism
should attempt to refresh the credential cache from the client
keytab.</dd>
</dl>
</div>
</div>


          </div>
        </div>
      </div>
        </div>
        <div class="sidebar">
    <h2>On this page</h2>
    <ul>
<li><a class="reference internal" href="#">Credential cache file format</a><ul>
<li><a class="reference internal" href="#header-format">Header format</a></li>
<li><a class="reference internal" href="#principal-format">Principal format</a></li>
<li><a class="reference internal" href="#credential-format">Credential format</a></li>
<li><a class="reference internal" href="#credential-cache-configuration-entries">Credential cache configuration entries</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"><a class="reference internal" href="../basic/index.html">Kerberos V5 concepts</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Protocols and file formats</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="">Credential cache file format</a><ul class="simple">
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="keytab_file_format.html">Keytab file format</a></li>
<li class="toctree-l2"><a class="reference internal" href="cookie.html">KDC cookie format</a></li>
</ul>
</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.16</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="Protocols and file formats"
            >previous</a> |
        <a href="keytab_file_format.html" title="Keytab file format"
            >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 file format">feedback</a>
            </div>
        </div>
    </div>

  </body>
</html>