summaryrefslogtreecommitdiff
path: root/doc/html/user/user_config/k5identity.html
diff options
context:
space:
mode:
authorCy Schubert <cy@FreeBSD.org>2025-03-19 22:12:25 +0000
committerCy Schubert <cy@FreeBSD.org>2025-03-19 22:12:25 +0000
commit8f7d3ef26dec89a92ec0665de84a5936310a5574 (patch)
tree9a465418bd4056bf0d369751320a414eaed29fa4 /doc/html/user/user_config/k5identity.html
parent1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff)
Diffstat (limited to 'doc/html/user/user_config/k5identity.html')
-rw-r--r--doc/html/user/user_config/k5identity.html92
1 files changed, 43 insertions, 49 deletions
diff --git a/doc/html/user/user_config/k5identity.html b/doc/html/user/user_config/k5identity.html
index 717897cb6921..e4ebf6b19741 100644
--- a/doc/html/user/user_config/k5identity.html
+++ b/doc/html/user/user_config/k5identity.html
@@ -1,35 +1,26 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html>
<head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
<title>.k5identity &#8212; 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.21.2',
- COLLAPSE_INDEX: false,
- FILE_SUFFIX: '.html',
- HAS_SOURCE: true,
- SOURCELINK_SUFFIX: '.txt'
- };
- </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="stylesheet" type="text/css" href="../../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../../_static/agogo.css" />
+ <link rel="stylesheet" type="text/css" href="../../_static/kerb.css" />
+ <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
+ <script src="../../_static/jquery.js"></script>
+ <script src="../../_static/underscore.js"></script>
+ <script src="../../_static/doctools.js"></script>
<link rel="author" title="About these documents" href="../../about.html" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="copyright" title="Copyright" href="../../copyright.html" />
<link rel="next" title="User commands" href="../user_commands/index.html" />
<link rel="prev" title=".k5login" href="k5login.html" />
- </head>
- <body>
+ </head><body>
<div class="header-wrapper">
<div class="header">
@@ -61,69 +52,71 @@
<div class="bodywrapper">
<div class="body" role="main">
- <div class="section" id="k5identity">
+ <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">
+<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 <code class="docutils literal"><span class="pre">#</span></code> are ignored. Each line has
+<p>Blank lines and lines beginning with <code class="docutils literal notranslate"><span class="pre">#</span></code> are ignored. Each line has
the form:</p>
<blockquote>
-<div><em>principal</em> <em>field</em>=<em>value</em> …</div></blockquote>
+<div><p><em>principal</em> <em>field</em>=<em>value</em> …</p>
+</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
+<dl>
+<dt><strong>realm</strong></dt><dd><p>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"><span class="std std-ref">[domain_realm]</span></a> section in
-<a class="reference internal" href="../../admin/conf_files/krb5_conf.html#krb5-conf-5"><span class="std std-ref">krb5.conf</span></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
+<a class="reference internal" href="../../admin/conf_files/krb5_conf.html#krb5-conf-5"><span class="std std-ref">krb5.conf</span></a> with a mapping for the hostname.</p>
+</dd>
+<dt><strong>service</strong></dt><dd><p>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
+shell wildcards.</p>
+</dd>
+<dt><strong>host</strong></dt><dd><p>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
+<p>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">
+</section>
+<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
-<code class="docutils literal"><span class="pre">alice&#64;KRBTEST.COM</span></code> if the server principal is within that realm,
-the principal <code class="docutils literal"><span class="pre">alice/root&#64;EXAMPLE.COM</span></code> if the server host is within
-a servers subdomain, and the principal <code class="docutils literal"><span class="pre">alice/mail&#64;EXAMPLE.COM</span></code> when
-accessing the IMAP service on <code class="docutils literal"><span class="pre">mail.example.com</span></code>:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">alice</span><span class="nd">@KRBTEST</span><span class="o">.</span><span class="n">COM</span> <span class="n">realm</span><span class="o">=</span><span class="n">KRBTEST</span><span class="o">.</span><span class="n">COM</span>
+<code class="docutils literal notranslate"><span class="pre">alice&#64;KRBTEST.COM</span></code> if the server principal is within that realm,
+the principal <code class="docutils literal notranslate"><span class="pre">alice/root&#64;EXAMPLE.COM</span></code> if the server host is within
+a servers subdomain, and the principal <code class="docutils literal notranslate"><span class="pre">alice/mail&#64;EXAMPLE.COM</span></code> when
+accessing the IMAP service on <code class="docutils literal notranslate"><span class="pre">mail.example.com</span></code>:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">alice</span><span class="nd">@KRBTEST</span><span class="o">.</span><span class="n">COM</span> <span class="n">realm</span><span class="o">=</span><span class="n">KRBTEST</span><span class="o">.</span><span class="n">COM</span>
<span class="n">alice</span><span class="o">/</span><span class="n">root</span><span class="nd">@EXAMPLE</span><span class="o">.</span><span class="n">COM</span> <span class="n">host</span><span class="o">=*.</span><span class="n">servers</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span>
<span class="n">alice</span><span class="o">/</span><span class="n">mail</span><span class="nd">@EXAMPLE</span><span class="o">.</span><span class="n">COM</span> <span class="n">host</span><span class="o">=</span><span class="n">mail</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> <span class="n">service</span><span class="o">=</span><span class="n">imap</span>
</pre></div>
</div>
-</div>
-<div class="section" id="see-also">
+</section>
+<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"><span class="std std-ref">krb5.conf</span></a></p>
-</div>
-</div>
+</section>
+</section>
+ <div class="clearer"></div>
</div>
</div>
</div>
</div>
<div class="sidebar">
+
<h2>On this page</h2>
<ul>
<li><a class="reference internal" href="#">.k5identity</a><ul>
@@ -170,6 +163,7 @@ accessing the IMAP service on <code class="docutils literal"><span class="pre">m
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
+
</div>
<div class="clearer"></div>
</div>
@@ -177,8 +171,8 @@ accessing the IMAP service on <code class="docutils literal"><span class="pre">m
<div class="footer-wrapper">
<div class="footer" >
- <div class="right" ><i>Release: 1.21.2</i><br />
- &copy; <a href="../../copyright.html">Copyright</a> 1985-2023, MIT.
+ <div class="right" ><i>Release: 1.21.3</i><br />
+ &copy; <a href="../../copyright.html">Copyright</a> 1985-2024, MIT.
</div>
<div class="left">
generated by cgit v1.3 (git 2.53.0) at 2026-04-28 01:17:06 +0000