krb5: Import MIT 1.21.3 - src - FreeBSD source tree

diff options


context:
space:
mode:

author	Cy Schubert <cy@FreeBSD.org>	2025-03-19 22:12:25 +0000
committer	Cy Schubert <cy@FreeBSD.org>	2025-03-19 22:12:25 +0000
commit	8f7d3ef26dec89a92ec0665de84a5936310a5574 (patch)
tree	9a465418bd4056bf0d369751320a414eaed29fa4 /doc/html/admin/admin_commands/kpropd.html
parent	1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff)

Diffstat (limited to 'doc/html/admin/admin_commands/kpropd.html')

-rw-r--r--

doc/html/admin/admin_commands/kpropd.html

152

1 files changed, 73 insertions, 79 deletions

diff --git a/doc/html/admin/admin_commands/kpropd.html b/doc/html/admin/admin_commands/kpropd.html
index aa3e86c11a47..4b9a07f09fc4 100644
--- a/doc/html/admin/admin_commands/kpropd.html
+++ b/doc/html/admin/admin_commands/kpropd.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>kpropd — 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>

- </head>

- <body>

+ </head><body>

@@ -61,9 +52,9 @@

- <div class="section" id="kpropd">

+ <section id="kpropd">

<span id="kpropd-8"></span><h1>kpropd<a class="headerlink" href="#kpropd" title="Permalink to this headline">¶</a></h1>

-<div class="section" id="synopsis">

+<section id="synopsis">

<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>

<p><strong>kpropd</strong>

[<strong>-r</strong> <em>realm</em>]

@@ -77,8 +68,8 @@

[<strong>-D</strong>]

[<strong>-d</strong>]

[<strong>-s</strong> <em>keytab_file</em>]</p>

-</div>

-<div class="section" id="description">

+</section>

+<section id="description">

<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>

<p>The <em>kpropd</em> command runs on the replica KDC server. It listens for

update requests made by the <a class="reference internal" href="kprop.html#kprop-8"><span class="std std-ref">kprop</span></a> program. If incremental

@@ -94,8 +85,8 @@ file, the replica Kerberos server will have an up-to-date KDC

database.</p>

<p>Where incremental propagation is not used, kpropd is commonly invoked

out of inetd(8) as a nowait service. This is done by adding a line to

-the <code class="docutils literal"><span class="pre">/etc/inetd.conf</span></code> file which looks like this:</p>

-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">kprop</span> <span class="n">stream</span> <span class="n">tcp</span> <span class="n">nowait</span> <span class="n">root</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">sbin</span><span class="o">/</span><span class="n">kpropd</span> <span class="n">kpropd</span>

+the <code class="docutils literal notranslate"><span class="pre">/etc/inetd.conf</span></code> file which looks like this:</p>

+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kprop</span> <span class="n">stream</span> <span class="n">tcp</span> <span class="n">nowait</span> <span class="n">root</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">sbin</span><span class="o">/</span><span class="n">kpropd</span> <span class="n">kpropd</span>

</pre></div>

</div>

<p>kpropd can also run as a standalone daemon, backgrounding itself and

@@ -113,80 +104,82 @@ an interval determined by the <strong>iprop_replica_poll</strong> variable. If

replica receives updates, kpropd updates its log file with any updates

from the primary. <a class="reference internal" href="kproplog.html#kproplog-8"><span class="std std-ref">kproplog</span></a> can be used to view a summary of

the update entry log on the replica KDC. If incremental propagation

-is enabled, the principal <code class="docutils literal"><span class="pre">kiprop/replicahostname@REALM</span></code> (where

+is enabled, the principal <code class="docutils literal notranslate"><span class="pre">kiprop/replicahostname@REALM</span></code> (where

<em>replicahostname</em> is the name of the replica KDC host, and <em>REALM</em> is

the name of the Kerberos realm) must be present in the replica’s

keytab file.</p>

<p><a class="reference internal" href="kproplog.html#kproplog-8"><span class="std std-ref">kproplog</span></a> can be used to force full replication when iprop is

enabled.</p>

-</div>

-<div class="section" id="options">

+</section>

+<section id="options">

<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>

-<dl class="docutils">

-<dt><strong>-r</strong> <em>realm</em></dt>

-<dd>Specifies the realm of the primary server.</dd>

-<dt><strong>-A</strong> <em>admin_server</em></dt>

-<dd>Specifies the server to be contacted for incremental updates; by

-default, the primary admin server is contacted.</dd>

-<dt><strong>-f</strong> <em>file</em></dt>

-<dd>Specifies the filename where the dumped principal database file is

-to be stored; by default the dumped database file is <a class="reference internal" href="../../mitK5defaults.html#paths"><span class="std std-ref">LOCALSTATEDIR</span></a><code class="docutils literal"><span class="pre">/krb5kdc</span></code><code class="docutils literal"><span class="pre">/from_master</span></code>.</dd>

-<dt><strong>-F</strong> <em>kerberos_db</em></dt>

-<dd>Path to the Kerberos database file, if not the default.</dd>

-<dt><strong>-p</strong></dt>

-<dd>Allows the user to specify the pathname to the <a class="reference internal" href="kdb5_util.html#kdb5-util-8"><span class="std std-ref">kdb5_util</span></a>

-program; by default the pathname used is <a class="reference internal" href="../../mitK5defaults.html#paths"><span class="std std-ref">SBINDIR</span></a><code class="docutils literal"><span class="pre">/kdb5_util</span></code>.</dd>

-<dt><strong>-D</strong></dt>

-<dd>In this mode, kpropd will not detach itself from the current job

+<dl class="simple">

+<dt><strong>-r</strong> <em>realm</em></dt><dd><p>Specifies the realm of the primary server.</p>

+</dd>

+<dt><strong>-A</strong> <em>admin_server</em></dt><dd><p>Specifies the server to be contacted for incremental updates; by

+default, the primary admin server is contacted.</p>

+</dd>

+<dt><strong>-f</strong> <em>file</em></dt><dd><p>Specifies the filename where the dumped principal database file is

+to be stored; by default the dumped database file is <a class="reference internal" href="../../mitK5defaults.html#paths"><span class="std std-ref">LOCALSTATEDIR</span></a><code class="docutils literal notranslate"><span class="pre">/krb5kdc</span></code><code class="docutils literal notranslate"><span class="pre">/from_master</span></code>.</p>

+</dd>

+<dt><strong>-F</strong> <em>kerberos_db</em></dt><dd><p>Path to the Kerberos database file, if not the default.</p>

+</dd>

+<dt><strong>-p</strong></dt><dd><p>Allows the user to specify the pathname to the <a class="reference internal" href="kdb5_util.html#kdb5-util-8"><span class="std std-ref">kdb5_util</span></a>

+program; by default the pathname used is <a class="reference internal" href="../../mitK5defaults.html#paths"><span class="std std-ref">SBINDIR</span></a><code class="docutils literal notranslate"><span class="pre">/kdb5_util</span></code>.</p>

+</dd>

+<dt><strong>-D</strong></dt><dd><p>In this mode, kpropd will not detach itself from the current job

and run in the background. Instead, it will run in the

-foreground.</dd>

-<dt><strong>-d</strong></dt>

-<dd>Turn on debug mode. kpropd will print out debugging messages

+foreground.</p>

+</dd>

+<dt><strong>-d</strong></dt><dd><p>Turn on debug mode. kpropd will print out debugging messages

during the database propogation and will run in the foreground

-(implies <strong>-D</strong>).</dd>

-<dt><strong>-P</strong></dt>

-<dd>Allow for an alternate port number for kpropd to listen on. This

-is only useful in combination with the <strong>-S</strong> option.</dd>

-<dt><strong>-a</strong> <em>acl_file</em></dt>

-<dd>Allows the user to specify the path to the kpropd.acl file; by

-default the path used is <a class="reference internal" href="../../mitK5defaults.html#paths"><span class="std std-ref">LOCALSTATEDIR</span></a><code class="docutils literal"><span class="pre">/krb5kdc</span></code><code class="docutils literal"><span class="pre">/kpropd.acl</span></code>.</dd>

-<dt><strong>–pid-file</strong>=<em>pid_file</em></dt>

-<dd>In standalone mode, write the process ID of the daemon into

-<em>pid_file</em>.</dd>

-<dt><strong>-s</strong> <em>keytab_file</em></dt>

-<dd>Path to a keytab to use for acquiring acceptor credentials.</dd>

-<dt><strong>-x</strong> <em>db_args</em></dt>

-<dd>Database-specific arguments. See <a class="reference internal" href="kadmin_local.html#dboptions"><span class="std std-ref">Database Options</span></a> in <a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a> for supported arguments.</dd>

+(implies <strong>-D</strong>).</p>

+</dd>

+<dt><strong>-P</strong></dt><dd><p>Allow for an alternate port number for kpropd to listen on. This

+is only useful in combination with the <strong>-S</strong> option.</p>

+</dd>

+<dt><strong>-a</strong> <em>acl_file</em></dt><dd><p>Allows the user to specify the path to the kpropd.acl file; by

+default the path used is <a class="reference internal" href="../../mitK5defaults.html#paths"><span class="std std-ref">LOCALSTATEDIR</span></a><code class="docutils literal notranslate"><span class="pre">/krb5kdc</span></code><code class="docutils literal notranslate"><span class="pre">/kpropd.acl</span></code>.</p>

+</dd>

+<dt><strong>–pid-file</strong>=<em>pid_file</em></dt><dd><p>In standalone mode, write the process ID of the daemon into

+<em>pid_file</em>.</p>

+</dd>

+<dt><strong>-s</strong> <em>keytab_file</em></dt><dd><p>Path to a keytab to use for acquiring acceptor credentials.</p>

+</dd>

+<dt><strong>-x</strong> <em>db_args</em></dt><dd><p>Database-specific arguments. See <a class="reference internal" href="kadmin_local.html#dboptions"><span class="std std-ref">Database Options</span></a> in <a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a> for supported arguments.</p>

+</dd>

</dl>

-</div>

-<div class="section" id="files">

+</section>

+<section id="files">

<h2>FILES<a class="headerlink" href="#files" title="Permalink to this headline">¶</a></h2>

-<dl class="docutils">

-<dt>kpropd.acl</dt>

-<dd>Access file for kpropd; the default location is

-<code class="docutils literal"><span class="pre">/usr/local/var/krb5kdc/kpropd.acl</span></code>. Each entry is a line

+<dl class="simple">

+<dt>kpropd.acl</dt><dd><p>Access file for kpropd; the default location is

+<code class="docutils literal notranslate"><span class="pre">/usr/local/var/krb5kdc/kpropd.acl</span></code>. Each entry is a line

containing the principal of a host from which the local machine

-will allow Kerberos database propagation via <a class="reference internal" href="kprop.html#kprop-8"><span class="std std-ref">kprop</span></a>.</dd>

+will allow Kerberos database propagation via <a class="reference internal" href="kprop.html#kprop-8"><span class="std std-ref">kprop</span></a>.</p>

+</dd>

</dl>

-</div>

-<div class="section" id="environment">

+</section>

+<section id="environment">

<h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>

<p>See <a class="reference internal" href="../../user/user_config/kerberos.html#kerberos-7"><span class="std std-ref">kerberos</span></a> for a description of Kerberos environment

variables.</p>

-</div>

-<div class="section" id="see-also">

+</section>

+<section id="see-also">

<p><a class="reference internal" href="kprop.html#kprop-8"><span class="std std-ref">kprop</span></a>, <a class="reference internal" href="kdb5_util.html#kdb5-util-8"><span class="std std-ref">kdb5_util</span></a>, <a class="reference internal" href="krb5kdc.html#krb5kdc-8"><span class="std std-ref">krb5kdc</span></a>,

<a class="reference internal" href="../../user/user_config/kerberos.html#kerberos-7"><span class="std std-ref">kerberos</span></a>, inetd(8)</p>

-</div>

+</section>

+ <div class="clearer"></div>

</div>

<ul>

<li><a class="reference internal" href="#">kpropd</a><ul>

@@ -264,6 +257,7 @@ variables.</p>

</form>

</div>

</div>

@@ -271,8 +265,8 @@ variables.</p>

- <div class="right" ><i>Release: 1.21.2</i><br />

+ <div class="right" ><i>Release: 1.21.3</i><br />

</div>