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/kadmind.html
parent	1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff)

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

-rw-r--r--

doc/html/admin/admin_commands/kadmind.html

148

1 files changed, 71 insertions, 77 deletions

diff --git a/doc/html/admin/admin_commands/kadmind.html b/doc/html/admin/admin_commands/kadmind.html
index 0b103a0b6619..66b384d775c4 100644
--- a/doc/html/admin/admin_commands/kadmind.html
+++ b/doc/html/admin/admin_commands/kadmind.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>kadmind — 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="kadmind">

+ <section id="kadmind">

<span id="kadmind-8"></span><h1>kadmind<a class="headerlink" href="#kadmind" 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>kadmind</strong>

[<strong>-x</strong> <em>db_args</em>]

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

[<strong>-K</strong> <em>kprop_path</em>]

[<strong>-k</strong> <em>kprop_port</em>]

[<strong>-F</strong> <em>dump_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>kadmind starts the Kerberos administration server. kadmind typically

runs on the primary Kerberos server, which stores the KDC database.

@@ -88,18 +79,18 @@ remote requests from programs such as <a class="reference internal" href="kadmin

<a class="reference internal" href="../../user/user_commands/kpasswd.html#kpasswd-1"><span class="std std-ref">kpasswd</span></a> to administer the information in these database.</p>

<p>kadmind requires a number of configuration files to be set up in order

for it to work:</p>

-<dl class="docutils">

-<dt><a class="reference internal" href="../conf_files/kdc_conf.html#kdc-conf-5"><span class="std std-ref">kdc.conf</span></a></dt>

-<dd>The KDC configuration file contains configuration information for

+<dl class="simple">

+<dt><a class="reference internal" href="../conf_files/kdc_conf.html#kdc-conf-5"><span class="std std-ref">kdc.conf</span></a></dt><dd><p>The KDC configuration file contains configuration information for

the KDC and admin servers. kadmind uses settings in this file to

locate the Kerberos database, and is also affected by the

<strong>acl_file</strong>, <strong>dict_file</strong>, <strong>kadmind_port</strong>, and iprop-related

-settings.</dd>

-<dt><a class="reference internal" href="../conf_files/kadm5_acl.html#kadm5-acl-5"><span class="std std-ref">kadm5.acl</span></a></dt>

-<dd>kadmind’s ACL (access control list) tells it which principals are

+settings.</p>

+</dd>

+<dt><a class="reference internal" href="../conf_files/kadm5_acl.html#kadm5-acl-5"><span class="std std-ref">kadm5.acl</span></a></dt><dd><p>kadmind’s ACL (access control list) tells it which principals are

allowed to perform administration actions. The pathname to the

ACL file can be specified with the <strong>acl_file</strong> <a class="reference internal" href="../conf_files/kdc_conf.html#kdc-conf-5"><span class="std std-ref">kdc.conf</span></a>

-variable; by default, it 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">/kadm5.acl</span></code>.</dd>

+variable; by default, it 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">/kadm5.acl</span></code>.</p>

+</dd>

</dl>

<p>After the server begins running, it puts itself in the background and

disassociates itself from its controlling terminal.</p>

@@ -108,74 +99,76 @@ Incremental propagation allows replica KDC servers to receive

principal and policy updates incrementally instead of receiving full

dumps of the database. This facility can be enabled in the

<a class="reference internal" href="../conf_files/kdc_conf.html#kdc-conf-5"><span class="std std-ref">kdc.conf</span></a> file with the <strong>iprop_enable</strong> option. Incremental

-propagation requires the principal <code class="docutils literal"><span class="pre">kiprop/PRIMARY\@REALM</span></code> (where

+propagation requires the principal <code class="docutils literal notranslate"><span class="pre">kiprop/PRIMARY\@REALM</span></code> (where

PRIMARY is the primary KDC’s canonical host name, and REALM the realm

name). In release 1.13, this principal is automatically created and

registered into the datebase.</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 that kadmind will serve; if it is not

-specified, the default realm of the host is used.</dd>

-<dt><strong>-m</strong></dt>

-<dd>causes the master database password to be fetched from the

+<dl class="simple">

+<dt><strong>-r</strong> <em>realm</em></dt><dd><p>specifies the realm that kadmind will serve; if it is not

+specified, the default realm of the host is used.</p>

+</dd>

+<dt><strong>-m</strong></dt><dd><p>causes the master database password to be fetched from the

keyboard (before the server puts itself in the background, if not

invoked with the <strong>-nofork</strong> option) rather than from a file on

-disk.</dd>

-<dt><strong>-nofork</strong></dt>

-<dd>causes the server to remain in the foreground and remain

-associated to the terminal.</dd>

-<dt><strong>-proponly</strong></dt>

-<dd>causes the server to only listen and respond to Kerberos replica

+disk.</p>

+</dd>

+<dt><strong>-nofork</strong></dt><dd><p>causes the server to remain in the foreground and remain

+associated to the terminal.</p>

+</dd>

+<dt><strong>-proponly</strong></dt><dd><p>causes the server to only listen and respond to Kerberos replica

incremental propagation polling requests. This option can be used

to set up a hierarchical propagation topology where a replica KDC

-provides incremental updates to other Kerberos replicas.</dd>

-<dt><strong>-port</strong> <em>port-number</em></dt>

-<dd>specifies the port on which the administration server listens for

+provides incremental updates to other Kerberos replicas.</p>

+</dd>

+<dt><strong>-port</strong> <em>port-number</em></dt><dd><p>specifies the port on which the administration server listens for

connections. The default port is determined by the

-<strong>kadmind_port</strong> configuration variable in <a class="reference internal" href="../conf_files/kdc_conf.html#kdc-conf-5"><span class="std std-ref">kdc.conf</span></a>.</dd>

-<dt><strong>-P</strong> <em>pid_file</em></dt>

-<dd>specifies the file to which the PID of kadmind process should be

+<strong>kadmind_port</strong> configuration variable in <a class="reference internal" href="../conf_files/kdc_conf.html#kdc-conf-5"><span class="std std-ref">kdc.conf</span></a>.</p>

+</dd>

+<dt><strong>-P</strong> <em>pid_file</em></dt><dd><p>specifies the file to which the PID of kadmind process should be

written after it starts up. This file can be used to identify

whether kadmind is still running and to allow init scripts to stop

-the correct process.</dd>

-<dt><strong>-p</strong> <em>kdb5_util_path</em></dt>

-<dd>specifies the path to the kdb5_util command to use when dumping the

-KDB in response to full resync requests when iprop is enabled.</dd>

-<dt><strong>-K</strong> <em>kprop_path</em></dt>

-<dd>specifies the path to the kprop command to use to send full dumps

-to replicas in response to full resync requests.</dd>

-<dt><strong>-k</strong> <em>kprop_port</em></dt>

-<dd>specifies the port by which the kprop process that is spawned by

+the correct process.</p>

+</dd>

+<dt><strong>-p</strong> <em>kdb5_util_path</em></dt><dd><p>specifies the path to the kdb5_util command to use when dumping the

+KDB in response to full resync requests when iprop is enabled.</p>

+</dd>

+<dt><strong>-K</strong> <em>kprop_path</em></dt><dd><p>specifies the path to the kprop command to use to send full dumps

+to replicas in response to full resync requests.</p>

+</dd>

+<dt><strong>-k</strong> <em>kprop_port</em></dt><dd><p>specifies the port by which the kprop process that is spawned by

kadmind connects to the replica kpropd, in order to transfer the

-dump file during an iprop full resync request.</dd>

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

-<dd>specifies the file path to be used for dumping the KDB in response

-to full resync requests when iprop is enabled.</dd>

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

-<dd>specifies 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>

+dump file during an iprop full resync request.</p>

+</dd>

+<dt><strong>-F</strong> <em>dump_file</em></dt><dd><p>specifies the file path to be used for dumping the KDB in response

+to full resync requests when iprop is enabled.</p>

+</dd>

+<dt><strong>-x</strong> <em>db_args</em></dt><dd><p>specifies 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="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="../../user/user_commands/kpasswd.html#kpasswd-1"><span class="std std-ref">kpasswd</span></a>, <a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</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="kdb5_ldap_util.html#kdb5-ldap-util-8"><span class="std std-ref">kdb5_ldap_util</span></a>, <a class="reference internal" href="../conf_files/kadm5_acl.html#kadm5-acl-5"><span class="std std-ref">kadm5.acl</span></a>, <a class="reference internal" href="../../user/user_config/kerberos.html#kerberos-7"><span class="std std-ref">kerberos</span></a></p>

-</div>

+</section>

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

</div>

<ul>

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

@@ -252,6 +245,7 @@ variables.</p>

</form>

</div>

</div>

@@ -259,8 +253,8 @@ variables.</p>

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

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

</div>