xref: /freebsd/crypto/krb5/doc/html/admin/admin_commands/k5srvutil.html (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1
2<!DOCTYPE html>
3
4<html>
5  <head>
6    <meta charset="utf-8" />
7    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
8
9    <title>k5srvutil &#8212; MIT Kerberos Documentation</title>
10    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
11    <link rel="stylesheet" type="text/css" href="../../_static/agogo.css" />
12    <link rel="stylesheet" type="text/css" href="../../_static/kerb.css" />
13    <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
14    <script src="../../_static/jquery.js"></script>
15    <script src="../../_static/underscore.js"></script>
16    <script src="../../_static/doctools.js"></script>
17    <link rel="author" title="About these documents" href="../../about.html" />
18    <link rel="index" title="Index" href="../../genindex.html" />
19    <link rel="search" title="Search" href="../../search.html" />
20    <link rel="copyright" title="Copyright" href="../../copyright.html" />
21    <link rel="next" title="sserver" href="sserver.html" />
22    <link rel="prev" title="ktutil" href="ktutil.html" />
23  </head><body>
24    <div class="header-wrapper">
25        <div class="header">
26
27
28            <h1><a href="../../index.html">MIT Kerberos Documentation</a></h1>
29
30            <div class="rel">
31
32        <a href="../../index.html" title="Full Table of Contents"
33            accesskey="C">Contents</a> |
34        <a href="ktutil.html" title="ktutil"
35            accesskey="P">previous</a> |
36        <a href="sserver.html" title="sserver"
37            accesskey="N">next</a> |
38        <a href="../../genindex.html" title="General Index"
39            accesskey="I">index</a> |
40        <a href="../../search.html" title="Enter search criteria"
41            accesskey="S">Search</a> |
42    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__k5srvutil">feedback</a>
43            </div>
44        </div>
45    </div>
46
47    <div class="content-wrapper">
48      <div class="content">
49        <div class="document">
50
51      <div class="documentwrapper">
52        <div class="bodywrapper">
53          <div class="body" role="main">
54
55  <section id="k5srvutil">
56<span id="k5srvutil-1"></span><h1>k5srvutil<a class="headerlink" href="#k5srvutil" title="Permalink to this headline">¶</a></h1>
57<section id="synopsis">
58<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
59<p><strong>k5srvutil</strong> <em>operation</em>
60[<strong>-i</strong>]
61[<strong>-f</strong> <em>filename</em>]
62[<strong>-e</strong> <em>keysalts</em>]</p>
63</section>
64<section id="description">
65<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
66<p>k5srvutil allows an administrator to list keys currently in
67a keytab, to obtain new keys for a principal currently in a keytab,
68or to delete non-current keys from a keytab.</p>
69<p><em>operation</em> must be one of the following:</p>
70<dl class="simple">
71<dt><strong>list</strong></dt><dd><p>Lists the keys in a keytab, showing version number and principal
72name.</p>
73</dd>
74<dt><strong>change</strong></dt><dd><p>Uses the kadmin protocol to update the keys in the Kerberos
75database to new randomly-generated keys, and updates the keys in
76the keytab to match.  If a key’s version number doesn’t match the
77version number stored in the Kerberos server’s database, then the
78operation will fail.  If the <strong>-i</strong> flag is given, k5srvutil will
79prompt for confirmation before changing each key.  If the <strong>-k</strong>
80option is given, the old and new keys will be displayed.
81Ordinarily, keys will be generated with the default encryption
82types and key salts.  This can be overridden with the <strong>-e</strong>
83option.  Old keys are retained in the keytab so that existing
84tickets continue to work, but <strong>delold</strong> should be used after
85such tickets expire, to prevent attacks against the old keys.</p>
86</dd>
87<dt><strong>delold</strong></dt><dd><p>Deletes keys that are not the most recent version from the keytab.
88This operation should be used some time after a change operation
89to remove old keys, after existing tickets issued for the service
90have expired.  If the <strong>-i</strong> flag is given, then k5srvutil will
91prompt for confirmation for each principal.</p>
92</dd>
93<dt><strong>delete</strong></dt><dd><p>Deletes particular keys in the keytab, interactively prompting for
94each key.</p>
95</dd>
96</dl>
97<p>In all cases, the default keytab is used unless this is overridden by
98the <strong>-f</strong> option.</p>
99<p>k5srvutil uses the <a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a> program to edit the keytab in
100place.</p>
101</section>
102<section id="environment">
103<h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
104<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
105variables.</p>
106</section>
107<section id="see-also">
108<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
109<p><a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a>, <a class="reference internal" href="ktutil.html#ktutil-1"><span class="std std-ref">ktutil</span></a>, <a class="reference internal" href="../../user/user_config/kerberos.html#kerberos-7"><span class="std std-ref">kerberos</span></a></p>
110</section>
111</section>
112
113
114            <div class="clearer"></div>
115          </div>
116        </div>
117      </div>
118        </div>
119        <div class="sidebar">
120
121    <h2>On this page</h2>
122    <ul>
123<li><a class="reference internal" href="#">k5srvutil</a><ul>
124<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
125<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
126<li><a class="reference internal" href="#environment">ENVIRONMENT</a></li>
127<li><a class="reference internal" href="#see-also">SEE ALSO</a></li>
128</ul>
129</li>
130</ul>
131
132    <br/>
133    <h2>Table of contents</h2>
134    <ul class="current">
135<li class="toctree-l1"><a class="reference internal" href="../../user/index.html">For users</a></li>
136<li class="toctree-l1 current"><a class="reference internal" href="../index.html">For administrators</a><ul class="current">
137<li class="toctree-l2"><a class="reference internal" href="../install.html">Installation guide</a></li>
138<li class="toctree-l2"><a class="reference internal" href="../conf_files/index.html">Configuration Files</a></li>
139<li class="toctree-l2"><a class="reference internal" href="../realm_config.html">Realm configuration decisions</a></li>
140<li class="toctree-l2"><a class="reference internal" href="../database.html">Database administration</a></li>
141<li class="toctree-l2"><a class="reference internal" href="../dbtypes.html">Database types</a></li>
142<li class="toctree-l2"><a class="reference internal" href="../lockout.html">Account lockout</a></li>
143<li class="toctree-l2"><a class="reference internal" href="../conf_ldap.html">Configuring Kerberos with OpenLDAP back-end</a></li>
144<li class="toctree-l2"><a class="reference internal" href="../appl_servers.html">Application servers</a></li>
145<li class="toctree-l2"><a class="reference internal" href="../host_config.html">Host configuration</a></li>
146<li class="toctree-l2"><a class="reference internal" href="../backup_host.html">Backups of secure hosts</a></li>
147<li class="toctree-l2"><a class="reference internal" href="../pkinit.html">PKINIT configuration</a></li>
148<li class="toctree-l2"><a class="reference internal" href="../otp.html">OTP Preauthentication</a></li>
149<li class="toctree-l2"><a class="reference internal" href="../spake.html">SPAKE Preauthentication</a></li>
150<li class="toctree-l2"><a class="reference internal" href="../dictionary.html">Addressing dictionary attack risks</a></li>
151<li class="toctree-l2"><a class="reference internal" href="../princ_dns.html">Principal names and DNS</a></li>
152<li class="toctree-l2"><a class="reference internal" href="../enctypes.html">Encryption types</a></li>
153<li class="toctree-l2"><a class="reference internal" href="../https.html">HTTPS proxy configuration</a></li>
154<li class="toctree-l2"><a class="reference internal" href="../auth_indicator.html">Authentication indicators</a></li>
155<li class="toctree-l2 current"><a class="reference internal" href="index.html">Administration  programs</a><ul class="current">
156<li class="toctree-l3"><a class="reference internal" href="kadmin_local.html">kadmin</a></li>
157<li class="toctree-l3"><a class="reference internal" href="kadmind.html">kadmind</a></li>
158<li class="toctree-l3"><a class="reference internal" href="kdb5_util.html">kdb5_util</a></li>
159<li class="toctree-l3"><a class="reference internal" href="kdb5_ldap_util.html">kdb5_ldap_util</a></li>
160<li class="toctree-l3"><a class="reference internal" href="krb5kdc.html">krb5kdc</a></li>
161<li class="toctree-l3"><a class="reference internal" href="kprop.html">kprop</a></li>
162<li class="toctree-l3"><a class="reference internal" href="kpropd.html">kpropd</a></li>
163<li class="toctree-l3"><a class="reference internal" href="kproplog.html">kproplog</a></li>
164<li class="toctree-l3"><a class="reference internal" href="ktutil.html">ktutil</a></li>
165<li class="toctree-l3 current"><a class="current reference internal" href="#">k5srvutil</a></li>
166<li class="toctree-l3"><a class="reference internal" href="sserver.html">sserver</a></li>
167</ul>
168</li>
169<li class="toctree-l2"><a class="reference internal" href="../../mitK5defaults.html">MIT Kerberos defaults</a></li>
170<li class="toctree-l2"><a class="reference internal" href="../env_variables.html">Environment variables</a></li>
171<li class="toctree-l2"><a class="reference internal" href="../troubleshoot.html">Troubleshooting</a></li>
172<li class="toctree-l2"><a class="reference internal" href="../advanced/index.html">Advanced topics</a></li>
173<li class="toctree-l2"><a class="reference internal" href="../various_envs.html">Various links</a></li>
174</ul>
175</li>
176<li class="toctree-l1"><a class="reference internal" href="../../appdev/index.html">For application developers</a></li>
177<li class="toctree-l1"><a class="reference internal" href="../../plugindev/index.html">For plugin module developers</a></li>
178<li class="toctree-l1"><a class="reference internal" href="../../build/index.html">Building Kerberos V5</a></li>
179<li class="toctree-l1"><a class="reference internal" href="../../basic/index.html">Kerberos V5 concepts</a></li>
180<li class="toctree-l1"><a class="reference internal" href="../../formats/index.html">Protocols and file formats</a></li>
181<li class="toctree-l1"><a class="reference internal" href="../../mitK5features.html">MIT Kerberos features</a></li>
182<li class="toctree-l1"><a class="reference internal" href="../../build_this.html">How to build this documentation from the source</a></li>
183<li class="toctree-l1"><a class="reference internal" href="../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
184<li class="toctree-l1"><a class="reference internal" href="../../resources.html">Resources</a></li>
185</ul>
186
187    <br/>
188    <h4><a href="../../index.html">Full Table of Contents</a></h4>
189    <h4>Search</h4>
190    <form class="search" action="../../search.html" method="get">
191      <input type="text" name="q" size="18" />
192      <input type="submit" value="Go" />
193      <input type="hidden" name="check_keywords" value="yes" />
194      <input type="hidden" name="area" value="default" />
195    </form>
196
197        </div>
198        <div class="clearer"></div>
199      </div>
200    </div>
201
202    <div class="footer-wrapper">
203        <div class="footer" >
204            <div class="right" ><i>Release: 1.21.3</i><br />
205                &copy; <a href="../../copyright.html">Copyright</a> 1985-2024, MIT.
206            </div>
207            <div class="left">
208
209        <a href="../../index.html" title="Full Table of Contents"
210            >Contents</a> |
211        <a href="ktutil.html" title="ktutil"
212            >previous</a> |
213        <a href="sserver.html" title="sserver"
214            >next</a> |
215        <a href="../../genindex.html" title="General Index"
216            >index</a> |
217        <a href="../../search.html" title="Enter search criteria"
218            >Search</a> |
219    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__k5srvutil">feedback</a>
220            </div>
221        </div>
222    </div>
223
224  </body>
225</html>