<!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>.k5identity — 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.11.4',
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="User config files" href="index.html" />
<link rel="next" title="User commands" href="../user_commands/index.html" />
<link rel="prev" title=".k5login" href="k5login.html" />
</head>
<body>
<div class="header-wrapper">
<div class="header" style="padding-bottom: 0px;">
<h1><a href="../../index.html"
style="color: #5d1509; font-size: 120%;
padding-top: 10px;">MIT Kerberos Documentation</a></h1>
<div class="rel">
<a href="../../index.html"
title="Full Table of Contents"
accesskey="C">Contents</a>
|
<a href="k5login.html"
title=".k5login"
accesskey="P">previous</a>
|
<a href="../user_commands/index.html"
title="User commands"
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__.k5identity">feedback</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="sidebar"
style="float: right; background: #F9F9F9">
<h2>On this page </h2>
<ul>
<li><a class="reference internal" href="#">.k5identity</a><ul>
<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
<li><a class="reference internal" href="#example">EXAMPLE</a></li>
<li><a class="reference internal" href="#see-also">SEE ALSO</a></li>
</ul>
</li>
</ul>
<br/>
<h2>Table of contents</h2>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">For users</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../pwd_mgmt.html">Password management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tkt_mgmt.html">Ticket management</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">User config files</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="k5login.html">.k5login</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="">.k5identity</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../user_commands/index.html">User commands</a></li>
</ul>
</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"><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">The Kerberos Documentation Set</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="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="k5identity">
<span id="k5identity-5"></span><h1>.k5identity<a class="headerlink" href="#k5identity" title="Permalink to this headline">¶</a></h1>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>The .k5identity file, which resides in a user’s home directory,
contains a list of rules for selecting a client principals based on
the server being accessed. These rules are used to choose a
credential cache within the cache collection when possible.</p>
<p>Blank lines and lines beginning with <tt class="docutils literal"><span class="pre">#</span></tt> are ignored. Each line has
the form:</p>
<blockquote>
<div><em>principal</em> <em>field</em>=<em>value</em> ...</div></blockquote>
<p>If the server principal meets all of the field constraints, then
principal is chosen as the client principal. The following fields are
recognized:</p>
<dl class="docutils">
<dt><strong>realm</strong></dt>
<dd>If the realm of the server principal is known, it is matched
against <em>value</em>, which may be a pattern using shell wildcards.
For host-based server principals, the realm will generally only be
known if there is a <a class="reference internal" href="../../admin/conf_files/krb5_conf.html#domain-realm"><em>[domain_realm]</em></a> section in
<a class="reference internal" href="../../admin/conf_files/krb5_conf.html#krb5-conf-5"><em>krb5.conf</em></a> with a mapping for the hostname.</dd>
<dt><strong>service</strong></dt>
<dd>If the server principal is a host-based principal, its service
component is matched against <em>value</em>, which may be a pattern using
shell wildcards.</dd>
<dt><strong>host</strong></dt>
<dd><p class="first">If the server principal is a host-based principal, its hostname
component is converted to lower case and matched against <em>value</em>,
which may be a pattern using shell wildcards.</p>
<p class="last">If the server principal matches the constraints of multiple lines
in the .k5identity file, the principal from the first matching
line is used. If no line matches, credentials will be selected
some other way, such as the realm heuristic or the current primary
cache.</p>
</dd>
</dl>
</div>
<div class="section" id="example">
<h2>EXAMPLE<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<p>The following example .k5identity file selects the client principal
<tt class="docutils literal"><span class="pre">alice@KRBTEST.COM</span></tt> if the server principal is within that realm,
the principal <tt class="docutils literal"><span class="pre">alice/root@EXAMPLE.COM</span></tt> if the server host is within
a servers subdomain, and the principal <tt class="docutils literal"><span class="pre">alice/mail@EXAMPLE.COM</span></tt> when
accessing the IMAP service on <tt class="docutils literal"><span class="pre">mail.example.com</span></tt>:</p>
<blockquote>
<div><div class="highlight-python"><pre>alice@KRBTEST.COM realm=KRBTEST.COM
alice/root@EXAMPLE.COM host=*.servers.example.com
alice/mail@EXAMPLE.COM host=mail.example.com service=imap</pre>
</div>
</div></blockquote>
</div>
<div class="section" id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<p>kerberos(1), <a class="reference internal" href="../../admin/conf_files/krb5_conf.html#krb5-conf-5"><em>krb5.conf</em></a></p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer" ></div>
</div>
</div>
<div class="footer-wrapper" >
<div class="footer" >
<div class="right" ><i>Release: 1.11.4</i><br />
© <a href="../../copyright.html">Copyright</a> 1985-2013, MIT.
</div>
<div class="left" >
<a href="../../index.html"
title="Full Table of Contents"
>Contents</a>
|
<a href="k5login.html"
title=".k5login"
>previous</a>
|
<a href="../user_commands/index.html"
title="User commands"
>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__.k5identity">feedback</a>
</div>
</div>
</div>
</body>
</html>
