summaryrefslogtreecommitdiff
path: root/doc/html/admin/admin_commands/kdb5_ldap_util.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/admin/admin_commands/kdb5_ldap_util.html
parent1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff)
Diffstat (limited to 'doc/html/admin/admin_commands/kdb5_ldap_util.html')
-rw-r--r--doc/html/admin/admin_commands/kdb5_ldap_util.html375
1 files changed, 190 insertions, 185 deletions
diff --git a/doc/html/admin/admin_commands/kdb5_ldap_util.html b/doc/html/admin/admin_commands/kdb5_ldap_util.html
index fdead5e699a0..7b6321b5b8d9 100644
--- a/doc/html/admin/admin_commands/kdb5_ldap_util.html
+++ b/doc/html/admin/admin_commands/kdb5_ldap_util.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>kdb5_ldap_util &#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="krb5kdc" href="krb5kdc.html" />
<link rel="prev" title="kdb5_util" href="kdb5_util.html" />
- </head>
- <body>
+ </head><body>
<div class="header-wrapper">
<div class="header">
@@ -61,46 +52,46 @@
<div class="bodywrapper">
<div class="body" role="main">
- <div class="section" id="kdb5-ldap-util">
+ <section id="kdb5-ldap-util">
<span id="kdb5-ldap-util-8"></span><h1>kdb5_ldap_util<a class="headerlink" href="#kdb5-ldap-util" 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 id="kdb5-ldap-util-synopsis"><strong>kdb5_ldap_util</strong>
[<strong>-D</strong> <em>user_dn</em> [<strong>-w</strong> <em>passwd</em>]]
[<strong>-H</strong> <em>ldapuri</em>]
<strong>command</strong>
[<em>command_options</em>]</p>
-</div>
-<div class="section" id="description">
+</section>
+<section id="description">
<span id="kdb5-ldap-util-synopsis-end"></span><h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>kdb5_ldap_util allows an administrator to manage realms, Kerberos
services and ticket policies.</p>
-</div>
-<div class="section" id="command-line-options">
+</section>
+<section id="command-line-options">
<h2>COMMAND-LINE OPTIONS<a class="headerlink" href="#command-line-options" title="Permalink to this headline">¶</a></h2>
-<dl class="docutils" id="kdb5-ldap-util-options">
-<dt><strong>-r</strong> <em>realm</em></dt>
-<dd>Specifies the realm to be operated on.</dd>
-<dt><strong>-D</strong> <em>user_dn</em></dt>
-<dd>Specifies the Distinguished Name (DN) of the user who has
-sufficient rights to perform the operation on the LDAP server.</dd>
-<dt><strong>-w</strong> <em>passwd</em></dt>
-<dd>Specifies the password of <em>user_dn</em>. This option is not
-recommended.</dd>
-<dt><strong>-H</strong> <em>ldapuri</em></dt>
-<dd>Specifies the URI of the LDAP server.</dd>
+<dl class="simple" id="kdb5-ldap-util-options">
+<dt><strong>-r</strong> <em>realm</em></dt><dd><p>Specifies the realm to be operated on.</p>
+</dd>
+<dt><strong>-D</strong> <em>user_dn</em></dt><dd><p>Specifies the Distinguished Name (DN) of the user who has
+sufficient rights to perform the operation on the LDAP server.</p>
+</dd>
+<dt><strong>-w</strong> <em>passwd</em></dt><dd><p>Specifies the password of <em>user_dn</em>. This option is not
+recommended.</p>
+</dd>
+<dt><strong>-H</strong> <em>ldapuri</em></dt><dd><p>Specifies the URI of the LDAP server.</p>
+</dd>
</dl>
<p>By default, kdb5_ldap_util operates on the default realm (as specified
in <a class="reference internal" href="../conf_files/krb5_conf.html#krb5-conf-5"><span class="std std-ref">krb5.conf</span></a>) and connects and authenticates to the LDAP
server in the same manner as :ref:kadmind(8)` would given the
parameters in <a class="reference internal" href="../conf_files/kdc_conf.html#dbdefaults"><span class="std std-ref">[dbdefaults]</span></a> in <a class="reference internal" href="../conf_files/kdc_conf.html#kdc-conf-5"><span class="std std-ref">kdc.conf</span></a>.</p>
-</div>
-<div class="section" id="commands">
+</section>
+<section id="commands">
<span id="kdb5-ldap-util-options-end"></span><h2>COMMANDS<a class="headerlink" href="#commands" title="Permalink to this headline">¶</a></h2>
-<div class="section" id="create">
+<section id="create">
<h3>create<a class="headerlink" href="#create" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-create">
-<div><strong>create</strong>
+<div><p><strong>create</strong>
[<strong>-subtrees</strong> <em>subtree_dn_list</em>]
[<strong>-sscope</strong> <em>search_scope</em>]
[<strong>-containerref</strong> <em>container_reference_dn</em>]
@@ -111,56 +102,57 @@ parameters in <a class="reference internal" href="../conf_files/kdc_conf.html#db
[<strong>-s</strong>]
[<strong>-maxtktlife</strong> <em>max_ticket_life</em>]
[<strong>-maxrenewlife</strong> <em>max_renewable_ticket_life</em>]
-[<em>ticket_flags</em>]</div></blockquote>
+[<em>ticket_flags</em>]</p>
+</div></blockquote>
<p>Creates realm in directory. Options:</p>
-<dl class="docutils">
-<dt><strong>-subtrees</strong> <em>subtree_dn_list</em></dt>
-<dd>Specifies the list of subtrees containing the principals of a
+<dl class="simple">
+<dt><strong>-subtrees</strong> <em>subtree_dn_list</em></dt><dd><p>Specifies the list of subtrees containing the principals of a
realm. The list contains the DNs of the subtree objects separated
-by colon (<code class="docutils literal"><span class="pre">:</span></code>).</dd>
-<dt><strong>-sscope</strong> <em>search_scope</em></dt>
-<dd>Specifies the scope for searching the principals under the
+by colon (<code class="docutils literal notranslate"><span class="pre">:</span></code>).</p>
+</dd>
+<dt><strong>-sscope</strong> <em>search_scope</em></dt><dd><p>Specifies the scope for searching the principals under the
subtree. The possible values are 1 or one (one level), 2 or sub
-(subtrees).</dd>
-<dt><strong>-containerref</strong> <em>container_reference_dn</em></dt>
-<dd>Specifies the DN of the container object in which the principals
+(subtrees).</p>
+</dd>
+<dt><strong>-containerref</strong> <em>container_reference_dn</em></dt><dd><p>Specifies the DN of the container object in which the principals
of a realm will be created. If the container reference is not
configured for a realm, the principals will be created in the
-realm container.</dd>
-<dt><strong>-k</strong> <em>mkeytype</em></dt>
-<dd>Specifies the key type of the master key in the database. The
+realm container.</p>
+</dd>
+<dt><strong>-k</strong> <em>mkeytype</em></dt><dd><p>Specifies the key type of the master key in the database. The
default is given by the <strong>master_key_type</strong> 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>-kv</strong> <em>mkeyVNO</em></dt>
-<dd>Specifies the version number of the master key in the database;
-the default is 1. Note that 0 is not allowed.</dd>
-<dt><strong>-M</strong> <em>mkeyname</em></dt>
-<dd>Specifies the principal name for the master key in the database.
+<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>-kv</strong> <em>mkeyVNO</em></dt><dd><p>Specifies the version number of the master key in the database;
+the default is 1. Note that 0 is not allowed.</p>
+</dd>
+<dt><strong>-M</strong> <em>mkeyname</em></dt><dd><p>Specifies the principal name for the master key in the database.
If not specified, the name is determined by the
-<strong>master_key_name</strong> 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>-m</strong></dt>
-<dd>Specifies that the master database password should be read from
-the TTY rather than fetched from a file on the disk.</dd>
-<dt><strong>-P</strong> <em>password</em></dt>
-<dd>Specifies the master database password. This option is not
-recommended.</dd>
-<dt><strong>-sf</strong> <em>stashfilename</em></dt>
-<dd>Specifies the stash file of the master database password.</dd>
-<dt><strong>-s</strong></dt>
-<dd>Specifies that the stash file is to be created.</dd>
-<dt><strong>-maxtktlife</strong> <em>max_ticket_life</em></dt>
-<dd>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum ticket life for
-principals in this realm.</dd>
-<dt><strong>-maxrenewlife</strong> <em>max_renewable_ticket_life</em></dt>
-<dd>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum renewable life of
-tickets for principals in this realm.</dd>
-<dt><em>ticket_flags</em></dt>
-<dd>Specifies global ticket flags for the realm. Allowable flags are
+<strong>master_key_name</strong> 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>-m</strong></dt><dd><p>Specifies that the master database password should be read from
+the TTY rather than fetched from a file on the disk.</p>
+</dd>
+<dt><strong>-P</strong> <em>password</em></dt><dd><p>Specifies the master database password. This option is not
+recommended.</p>
+</dd>
+<dt><strong>-sf</strong> <em>stashfilename</em></dt><dd><p>Specifies the stash file of the master database password.</p>
+</dd>
+<dt><strong>-s</strong></dt><dd><p>Specifies that the stash file is to be created.</p>
+</dd>
+<dt><strong>-maxtktlife</strong> <em>max_ticket_life</em></dt><dd><p>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum ticket life for
+principals in this realm.</p>
+</dd>
+<dt><strong>-maxrenewlife</strong> <em>max_renewable_ticket_life</em></dt><dd><p>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum renewable life of
+tickets for principals in this realm.</p>
+</dd>
+<dt><em>ticket_flags</em></dt><dd><p>Specifies global ticket flags for the realm. Allowable flags are
documented in the description of the <strong>add_principal</strong> command in
-<a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a>.</dd>
+<a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a>.</p>
+</dd>
</dl>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span> <span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span> <span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span>
<span class="o">-</span><span class="n">r</span> <span class="n">ATHENA</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span> <span class="n">create</span> <span class="o">-</span><span class="n">subtrees</span> <span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">sscope</span> <span class="n">SUB</span>
<span class="n">Password</span> <span class="k">for</span> <span class="s2">&quot;cn=admin,o=org&quot;</span><span class="p">:</span>
<span class="n">Initializing</span> <span class="n">database</span> <span class="k">for</span> <span class="n">realm</span> <span class="s1">&#39;ATHENA.MIT.EDU&#39;</span>
@@ -170,56 +162,58 @@ documented in the description of the <strong>add_principal</strong> command in
<span class="n">Re</span><span class="o">-</span><span class="n">enter</span> <span class="n">KDC</span> <span class="n">database</span> <span class="n">master</span> <span class="n">key</span> <span class="n">to</span> <span class="n">verify</span><span class="p">:</span>
</pre></div>
</div>
-</div>
-<div class="section" id="modify">
+</section>
+<section id="modify">
<span id="kdb5-ldap-util-create-end"></span><h3>modify<a class="headerlink" href="#modify" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-modify">
-<div><strong>modify</strong>
+<div><p><strong>modify</strong>
[<strong>-subtrees</strong> <em>subtree_dn_list</em>]
[<strong>-sscope</strong> <em>search_scope</em>]
[<strong>-containerref</strong> <em>container_reference_dn</em>]
[<strong>-maxtktlife</strong> <em>max_ticket_life</em>]
[<strong>-maxrenewlife</strong> <em>max_renewable_ticket_life</em>]
-[<em>ticket_flags</em>]</div></blockquote>
+[<em>ticket_flags</em>]</p>
+</div></blockquote>
<p>Modifies the attributes of a realm. Options:</p>
-<dl class="docutils">
-<dt><strong>-subtrees</strong> <em>subtree_dn_list</em></dt>
-<dd>Specifies the list of subtrees containing the principals of a
+<dl class="simple">
+<dt><strong>-subtrees</strong> <em>subtree_dn_list</em></dt><dd><p>Specifies the list of subtrees containing the principals of a
realm. The list contains the DNs of the subtree objects separated
-by colon (<code class="docutils literal"><span class="pre">:</span></code>). This list replaces the existing list.</dd>
-<dt><strong>-sscope</strong> <em>search_scope</em></dt>
-<dd>Specifies the scope for searching the principals under the
+by colon (<code class="docutils literal notranslate"><span class="pre">:</span></code>). This list replaces the existing list.</p>
+</dd>
+<dt><strong>-sscope</strong> <em>search_scope</em></dt><dd><p>Specifies the scope for searching the principals under the
subtrees. The possible values are 1 or one (one level), 2 or sub
-(subtrees).</dd>
-<dt><strong>-containerref</strong> <em>container_reference_dn</em> Specifies the DN of the</dt>
-<dd>container object in which the principals of a realm will be
-created.</dd>
-<dt><strong>-maxtktlife</strong> <em>max_ticket_life</em></dt>
-<dd>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum ticket life for
-principals in this realm.</dd>
-<dt><strong>-maxrenewlife</strong> <em>max_renewable_ticket_life</em></dt>
-<dd>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum renewable life of
-tickets for principals in this realm.</dd>
-<dt><em>ticket_flags</em></dt>
-<dd>Specifies global ticket flags for the realm. Allowable flags are
+(subtrees).</p>
+</dd>
+<dt><strong>-containerref</strong> <em>container_reference_dn</em> Specifies the DN of the</dt><dd><p>container object in which the principals of a realm will be
+created.</p>
+</dd>
+<dt><strong>-maxtktlife</strong> <em>max_ticket_life</em></dt><dd><p>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum ticket life for
+principals in this realm.</p>
+</dd>
+<dt><strong>-maxrenewlife</strong> <em>max_renewable_ticket_life</em></dt><dd><p>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum renewable life of
+tickets for principals in this realm.</p>
+</dd>
+<dt><em>ticket_flags</em></dt><dd><p>Specifies global ticket flags for the realm. Allowable flags are
documented in the description of the <strong>add_principal</strong> command in
-<a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a>.</dd>
+<a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a>.</p>
+</dd>
</dl>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">shell</span><span class="o">%</span> <span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">r</span> <span class="n">ATHENA</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">shell</span><span class="o">%</span> <span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">r</span> <span class="n">ATHENA</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span>
<span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span> <span class="n">modify</span> <span class="o">+</span><span class="n">requires_preauth</span>
<span class="n">Password</span> <span class="k">for</span> <span class="s2">&quot;cn=admin,o=org&quot;</span><span class="p">:</span>
<span class="n">shell</span><span class="o">%</span>
</pre></div>
</div>
-</div>
-<div class="section" id="view">
+</section>
+<section id="view">
<span id="kdb5-ldap-util-modify-end"></span><h3>view<a class="headerlink" href="#view" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-view">
-<div><strong>view</strong></div></blockquote>
+<div><p><strong>view</strong></p>
+</div></blockquote>
<p>Displays the attributes of a realm.</p>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span> <span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span> <span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span>
<span class="o">-</span><span class="n">r</span> <span class="n">ATHENA</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span> <span class="n">view</span>
<span class="n">Password</span> <span class="k">for</span> <span class="s2">&quot;cn=admin,o=org&quot;</span><span class="p">:</span>
<span class="n">Realm</span> <span class="n">Name</span><span class="p">:</span> <span class="n">ATHENA</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span>
@@ -231,18 +225,19 @@ documented in the description of the <strong>add_principal</strong> command in
<span class="n">Ticket</span> <span class="n">flags</span><span class="p">:</span> <span class="n">DISALLOW_FORWARDABLE</span> <span class="n">REQUIRES_PWCHANGE</span>
</pre></div>
</div>
-</div>
-<div class="section" id="destroy">
+</section>
+<section id="destroy">
<span id="kdb5-ldap-util-view-end"></span><h3>destroy<a class="headerlink" href="#destroy" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-destroy">
-<div><strong>destroy</strong> [<strong>-f</strong>]</div></blockquote>
+<div><p><strong>destroy</strong> [<strong>-f</strong>]</p>
+</div></blockquote>
<p>Destroys an existing realm. Options:</p>
-<dl class="docutils">
-<dt><strong>-f</strong></dt>
-<dd>If specified, will not prompt the user for confirmation.</dd>
+<dl class="simple">
+<dt><strong>-f</strong></dt><dd><p>If specified, will not prompt the user for confirmation.</p>
+</dd>
</dl>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>shell% kdb5_ldap_util -r ATHENA.MIT.EDU -D cn=admin,o=org -H
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>shell% kdb5_ldap_util -r ATHENA.MIT.EDU -D cn=admin,o=org -H
ldaps://ldap-server1.mit.edu destroy
Password for &quot;cn=admin,o=org&quot;:
Deleting KDC database of &#39;ATHENA.MIT.EDU&#39;, are you sure?
@@ -251,14 +246,15 @@ OK, deleting database of &#39;ATHENA.MIT.EDU&#39;...
shell%
</pre></div>
</div>
-</div>
-<div class="section" id="list">
+</section>
+<section id="list">
<span id="kdb5-ldap-util-destroy-end"></span><h3>list<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-list">
-<div><strong>list</strong></div></blockquote>
+<div><p><strong>list</strong></p>
+</div></blockquote>
<p>Lists the names of realms under the container.</p>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">shell</span><span class="o">%</span> <span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">shell</span><span class="o">%</span> <span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span>
<span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span> <span class="nb">list</span>
<span class="n">Password</span> <span class="k">for</span> <span class="s2">&quot;cn=admin,o=org&quot;</span><span class="p">:</span>
<span class="n">ATHENA</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span>
@@ -267,98 +263,102 @@ shell%
<span class="n">shell</span><span class="o">%</span>
</pre></div>
</div>
-</div>
-<div class="section" id="stashsrvpw">
+</section>
+<section id="stashsrvpw">
<span id="kdb5-ldap-util-list-end"></span><h3>stashsrvpw<a class="headerlink" href="#stashsrvpw" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-stashsrvpw">
-<div><strong>stashsrvpw</strong>
+<div><p><strong>stashsrvpw</strong>
[<strong>-f</strong> <em>filename</em>]
-<em>name</em></div></blockquote>
+<em>name</em></p>
+</div></blockquote>
<p>Allows an administrator to store the password for service object in a
file so that KDC and Administration server can use it to authenticate
to the LDAP server. Options:</p>
-<dl class="docutils">
-<dt><strong>-f</strong> <em>filename</em></dt>
-<dd>Specifies the complete path of the service password file. By
-default, <code class="docutils literal"><span class="pre">/usr/local/var/service_passwd</span></code> is used.</dd>
-<dt><em>name</em></dt>
-<dd>Specifies the name of the object whose password is to be stored.
+<dl class="simple">
+<dt><strong>-f</strong> <em>filename</em></dt><dd><p>Specifies the complete path of the service password file. By
+default, <code class="docutils literal notranslate"><span class="pre">/usr/local/var/service_passwd</span></code> is used.</p>
+</dd>
+<dt><em>name</em></dt><dd><p>Specifies the name of the object whose password is to be stored.
If <a class="reference internal" href="krb5kdc.html#krb5kdc-8"><span class="std std-ref">krb5kdc</span></a> or <a class="reference internal" href="kadmind.html#kadmind-8"><span class="std std-ref">kadmind</span></a> are configured for
simple binding, this should be the distinguished name it will
use as given by the <strong>ldap_kdc_dn</strong> or <strong>ldap_kadmind_dn</strong>
variable in <a class="reference internal" href="../conf_files/kdc_conf.html#kdc-conf-5"><span class="std std-ref">kdc.conf</span></a>. If the KDC or kadmind is
configured for SASL binding, this should be the authentication
name it will use as given by the <strong>ldap_kdc_sasl_authcid</strong> or
-<strong>ldap_kadmind_sasl_authcid</strong> variable.</dd>
+<strong>ldap_kadmind_sasl_authcid</strong> variable.</p>
+</dd>
</dl>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="n">stashsrvpw</span> <span class="o">-</span><span class="n">f</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">andrew</span><span class="o">/</span><span class="n">conf_keyfile</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="n">stashsrvpw</span> <span class="o">-</span><span class="n">f</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">andrew</span><span class="o">/</span><span class="n">conf_keyfile</span>
<span class="n">cn</span><span class="o">=</span><span class="n">service</span><span class="o">-</span><span class="n">kdc</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span>
<span class="n">Password</span> <span class="k">for</span> <span class="s2">&quot;cn=service-kdc,o=org&quot;</span><span class="p">:</span>
<span class="n">Re</span><span class="o">-</span><span class="n">enter</span> <span class="n">password</span> <span class="k">for</span> <span class="s2">&quot;cn=service-kdc,o=org&quot;</span><span class="p">:</span>
</pre></div>
</div>
-</div>
-<div class="section" id="create-policy">
+</section>
+<section id="create-policy">
<span id="kdb5-ldap-util-stashsrvpw-end"></span><h3>create_policy<a class="headerlink" href="#create-policy" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-create-policy">
-<div><strong>create_policy</strong>
+<div><p><strong>create_policy</strong>
[<strong>-maxtktlife</strong> <em>max_ticket_life</em>]
[<strong>-maxrenewlife</strong> <em>max_renewable_ticket_life</em>]
[<em>ticket_flags</em>]
-<em>policy_name</em></div></blockquote>
+<em>policy_name</em></p>
+</div></blockquote>
<p>Creates a ticket policy in the directory. Options:</p>
-<dl class="docutils">
-<dt><strong>-maxtktlife</strong> <em>max_ticket_life</em></dt>
-<dd>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum ticket life for
-principals.</dd>
-<dt><strong>-maxrenewlife</strong> <em>max_renewable_ticket_life</em></dt>
-<dd>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum renewable life of
-tickets for principals.</dd>
-<dt><em>ticket_flags</em></dt>
-<dd>Specifies the ticket flags. If this option is not specified, by
+<dl class="simple">
+<dt><strong>-maxtktlife</strong> <em>max_ticket_life</em></dt><dd><p>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum ticket life for
+principals.</p>
+</dd>
+<dt><strong>-maxrenewlife</strong> <em>max_renewable_ticket_life</em></dt><dd><p>(<a class="reference internal" href="../../basic/date_format.html#getdate"><span class="std std-ref">getdate time</span></a> string) Specifies maximum renewable life of
+tickets for principals.</p>
+</dd>
+<dt><em>ticket_flags</em></dt><dd><p>Specifies the ticket flags. If this option is not specified, by
default, no restriction will be set by the policy. Allowable
flags are documented in the description of the <strong>add_principal</strong>
-command in <a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a>.</dd>
-<dt><em>policy_name</em></dt>
-<dd>Specifies the name of the ticket policy.</dd>
+command in <a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a>.</p>
+</dd>
+<dt><em>policy_name</em></dt><dd><p>Specifies the name of the ticket policy.</p>
+</dd>
</dl>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span> <span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span> <span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span>
<span class="o">-</span><span class="n">r</span> <span class="n">ATHENA</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span> <span class="n">create_policy</span> <span class="o">-</span><span class="n">maxtktlife</span> <span class="s2">&quot;1 day&quot;</span>
<span class="o">-</span><span class="n">maxrenewlife</span> <span class="s2">&quot;1 week&quot;</span> <span class="o">-</span><span class="n">allow_postdated</span> <span class="o">+</span><span class="n">needchange</span>
<span class="o">-</span><span class="n">allow_forwardable</span> <span class="n">tktpolicy</span>
<span class="n">Password</span> <span class="k">for</span> <span class="s2">&quot;cn=admin,o=org&quot;</span><span class="p">:</span>
</pre></div>
</div>
-</div>
-<div class="section" id="modify-policy">
+</section>
+<section id="modify-policy">
<span id="kdb5-ldap-util-create-policy-end"></span><h3>modify_policy<a class="headerlink" href="#modify-policy" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-modify-policy">
-<div><strong>modify_policy</strong>
+<div><p><strong>modify_policy</strong>
[<strong>-maxtktlife</strong> <em>max_ticket_life</em>]
[<strong>-maxrenewlife</strong> <em>max_renewable_ticket_life</em>]
[<em>ticket_flags</em>]
-<em>policy_name</em></div></blockquote>
+<em>policy_name</em></p>
+</div></blockquote>
<p>Modifies the attributes of a ticket policy. Options are same as for
<strong>create_policy</strong>.</p>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span>
<span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span> <span class="o">-</span><span class="n">r</span> <span class="n">ATHENA</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span> <span class="n">modify_policy</span>
<span class="o">-</span><span class="n">maxtktlife</span> <span class="s2">&quot;60 minutes&quot;</span> <span class="o">-</span><span class="n">maxrenewlife</span> <span class="s2">&quot;10 hours&quot;</span>
<span class="o">+</span><span class="n">allow_postdated</span> <span class="o">-</span><span class="n">requires_preauth</span> <span class="n">tktpolicy</span>
<span class="n">Password</span> <span class="k">for</span> <span class="s2">&quot;cn=admin,o=org&quot;</span><span class="p">:</span>
</pre></div>
</div>
-</div>
-<div class="section" id="view-policy">
+</section>
+<section id="view-policy">
<span id="kdb5-ldap-util-modify-policy-end"></span><h3>view_policy<a class="headerlink" href="#view-policy" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-view-policy">
-<div><strong>view_policy</strong>
-<em>policy_name</em></div></blockquote>
+<div><p><strong>view_policy</strong>
+<em>policy_name</em></p>
+</div></blockquote>
<p>Displays the attributes of the named ticket policy.</p>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span> <span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span> <span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span>
<span class="o">-</span><span class="n">r</span> <span class="n">ATHENA</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span> <span class="n">view_policy</span> <span class="n">tktpolicy</span>
<span class="n">Password</span> <span class="k">for</span> <span class="s2">&quot;cn=admin,o=org&quot;</span><span class="p">:</span>
<span class="n">Ticket</span> <span class="n">policy</span><span class="p">:</span> <span class="n">tktpolicy</span>
@@ -367,23 +367,24 @@ command in <a class="reference internal" href="kadmin_local.html#kadmin-1"><span
<span class="n">Ticket</span> <span class="n">flags</span><span class="p">:</span> <span class="n">DISALLOW_FORWARDABLE</span> <span class="n">REQUIRES_PWCHANGE</span>
</pre></div>
</div>
-</div>
-<div class="section" id="destroy-policy">
+</section>
+<section id="destroy-policy">
<span id="kdb5-ldap-util-view-policy-end"></span><h3>destroy_policy<a class="headerlink" href="#destroy-policy" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-destroy-policy">
-<div><strong>destroy_policy</strong>
+<div><p><strong>destroy_policy</strong>
[<strong>-force</strong>]
-<em>policy_name</em></div></blockquote>
+<em>policy_name</em></p>
+</div></blockquote>
<p>Destroys an existing ticket policy. Options:</p>
-<dl class="docutils">
-<dt><strong>-force</strong></dt>
-<dd>Forces the deletion of the policy object. If not specified, the
-user will be prompted for confirmation before deleting the policy.</dd>
-<dt><em>policy_name</em></dt>
-<dd>Specifies the name of the ticket policy.</dd>
+<dl class="simple">
+<dt><strong>-force</strong></dt><dd><p>Forces the deletion of the policy object. If not specified, the
+user will be prompted for confirmation before deleting the policy.</p>
+</dd>
+<dt><em>policy_name</em></dt><dd><p>Specifies the name of the ticket policy.</p>
+</dd>
</dl>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>kdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>kdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu
-r ATHENA.MIT.EDU destroy_policy tktpolicy
Password for &quot;cn=admin,o=org&quot;:
This will delete the policy object &#39;tktpolicy&#39;, are you sure?
@@ -391,14 +392,15 @@ This will delete the policy object &#39;tktpolicy&#39;, are you sure?
** policy object &#39;tktpolicy&#39; deleted.
</pre></div>
</div>
-</div>
-<div class="section" id="list-policy">
+</section>
+<section id="list-policy">
<span id="kdb5-ldap-util-destroy-policy-end"></span><h3>list_policy<a class="headerlink" href="#list-policy" title="Permalink to this headline">¶</a></h3>
<blockquote id="kdb5-ldap-util-list-policy">
-<div><strong>list_policy</strong></div></blockquote>
+<div><p><strong>list_policy</strong></p>
+</div></blockquote>
<p>Lists ticket policies.</p>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span> <span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kdb5_ldap_util</span> <span class="o">-</span><span class="n">D</span> <span class="n">cn</span><span class="o">=</span><span class="n">admin</span><span class="p">,</span><span class="n">o</span><span class="o">=</span><span class="n">org</span> <span class="o">-</span><span class="n">H</span> <span class="n">ldaps</span><span class="p">:</span><span class="o">//</span><span class="n">ldap</span><span class="o">-</span><span class="n">server1</span><span class="o">.</span><span class="n">mit</span><span class="o">.</span><span class="n">edu</span>
<span class="o">-</span><span class="n">r</span> <span class="n">ATHENA</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span> <span class="n">list_policy</span>
<span class="n">Password</span> <span class="k">for</span> <span class="s2">&quot;cn=admin,o=org&quot;</span><span class="p">:</span>
<span class="n">tktpolicy</span>
@@ -406,25 +408,27 @@ This will delete the policy object &#39;tktpolicy&#39;, are you sure?
<span class="n">userpolicy</span>
</pre></div>
</div>
-</div>
-</div>
-<div class="section" id="environment">
+</section>
+</section>
+<section id="environment">
<span id="kdb5-ldap-util-list-policy-end"></span><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">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a>, <a class="reference internal" href="../../user/user_config/kerberos.html#kerberos-7"><span class="std std-ref">kerberos</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="#">kdb5_ldap_util</a><ul>
@@ -515,6 +519,7 @@ variables.</p>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
+
</div>
<div class="clearer"></div>
</div>
@@ -522,8 +527,8 @@ variables.</p>
<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">