Imported Upstream version 1.20.1
[platform/upstream/krb5.git] / doc / html / admin / admin_commands / sserver.html
1
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6   <head>
7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8     <title>sserver &#8212; MIT Kerberos Documentation</title>
9     <link rel="stylesheet" href="../../_static/agogo.css" type="text/css" />
10     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
11     <link rel="stylesheet" href="../../_static/kerb.css" type="text/css" />
12     <script type="text/javascript">
13       var DOCUMENTATION_OPTIONS = {
14         URL_ROOT:    '../../',
15         VERSION:     '1.20.1',
16         COLLAPSE_INDEX: false,
17         FILE_SUFFIX: '.html',
18         HAS_SOURCE:  true,
19         SOURCELINK_SUFFIX: '.txt'
20       };
21     </script>
22     <script type="text/javascript" src="../../_static/jquery.js"></script>
23     <script type="text/javascript" src="../../_static/underscore.js"></script>
24     <script type="text/javascript" src="../../_static/doctools.js"></script>
25     <link rel="author" title="About these documents" href="../../about.html" />
26     <link rel="index" title="Index" href="../../genindex.html" />
27     <link rel="search" title="Search" href="../../search.html" />
28     <link rel="copyright" title="Copyright" href="../../copyright.html" />
29     <link rel="next" title="MIT Kerberos defaults" href="../../mitK5defaults.html" />
30     <link rel="prev" title="k5srvutil" href="k5srvutil.html" /> 
31   </head>
32   <body>
33     <div class="header-wrapper">
34         <div class="header">
35             
36             
37             <h1><a href="../../index.html">MIT Kerberos Documentation</a></h1>
38             
39             <div class="rel">
40                 
41         <a href="../../index.html" title="Full Table of Contents"
42             accesskey="C">Contents</a> |
43         <a href="k5srvutil.html" title="k5srvutil"
44             accesskey="P">previous</a> |
45         <a href="../../mitK5defaults.html" title="MIT Kerberos defaults"
46             accesskey="N">next</a> |
47         <a href="../../genindex.html" title="General Index"
48             accesskey="I">index</a> |
49         <a href="../../search.html" title="Enter search criteria"
50             accesskey="S">Search</a> |
51     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__sserver">feedback</a>
52             </div>
53         </div>
54     </div>
55
56     <div class="content-wrapper">
57       <div class="content">
58         <div class="document">
59             
60       <div class="documentwrapper">
61         <div class="bodywrapper">
62           <div class="body" role="main">
63             
64   <div class="section" id="sserver">
65 <span id="sserver-8"></span><h1>sserver<a class="headerlink" href="#sserver" title="Permalink to this headline">¶</a></h1>
66 <div class="section" id="synopsis">
67 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
68 <p><strong>sserver</strong>
69 [ <strong>-p</strong> <em>port</em> ]
70 [ <strong>-S</strong> <em>keytab</em> ]
71 [ <em>server_port</em> ]</p>
72 </div>
73 <div class="section" id="description">
74 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
75 <p>sserver and <a class="reference internal" href="../../user/user_commands/sclient.html#sclient-1"><span class="std std-ref">sclient</span></a> are a simple demonstration client/server
76 application.  When sclient connects to sserver, it performs a Kerberos
77 authentication, and then sserver returns to sclient the Kerberos
78 principal which was used for the Kerberos authentication.  It makes a
79 good test that Kerberos has been successfully installed on a machine.</p>
80 <p>The service name used by sserver and sclient is sample.  Hence,
81 sserver will require that there be a keytab entry for the service
82 <code class="docutils literal"><span class="pre">sample/hostname.domain.name&#64;REALM.NAME</span></code>.  This keytab is generated
83 using the <a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a> program.  The keytab file is usually
84 installed as <a class="reference internal" href="../../mitK5defaults.html#paths"><span class="std std-ref">DEFKTNAME</span></a>.</p>
85 <p>The <strong>-S</strong> option allows for a different keytab than the default.</p>
86 <p>sserver is normally invoked out of inetd(8), using a line in
87 <code class="docutils literal"><span class="pre">/etc/inetd.conf</span></code> that looks like this:</p>
88 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sample</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">sserver</span> <span class="n">sserver</span>
89 </pre></div>
90 </div>
91 <p>Since <code class="docutils literal"><span class="pre">sample</span></code> is normally not a port defined in <code class="docutils literal"><span class="pre">/etc/services</span></code>,
92 you will usually have to add a line to <code class="docutils literal"><span class="pre">/etc/services</span></code> which looks
93 like this:</p>
94 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sample</span>          <span class="mi">13135</span><span class="o">/</span><span class="n">tcp</span>
95 </pre></div>
96 </div>
97 <p>When using sclient, you will first have to have an entry in the
98 Kerberos database, by using <a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a>, and then you have to get
99 Kerberos tickets, by using <a class="reference internal" href="../../user/user_commands/kinit.html#kinit-1"><span class="std std-ref">kinit</span></a>.  Also, if you are running
100 the sclient program on a different host than the sserver it will be
101 connecting to, be sure that both hosts have an entry in /etc/services
102 for the sample tcp port, and that the same port number is in both
103 files.</p>
104 <p>When you run sclient you should see something like this:</p>
105 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sendauth</span> <span class="n">succeeded</span><span class="p">,</span> <span class="n">reply</span> <span class="ow">is</span><span class="p">:</span>
106 <span class="n">reply</span> <span class="nb">len</span> <span class="mi">32</span><span class="p">,</span> <span class="n">contents</span><span class="p">:</span>
107 <span class="n">You</span> <span class="n">are</span> <span class="n">nlgilman</span><span class="nd">@JIMI</span><span class="o">.</span><span class="n">MIT</span><span class="o">.</span><span class="n">EDU</span>
108 </pre></div>
109 </div>
110 </div>
111 <div class="section" id="common-error-messages">
112 <h2>COMMON ERROR MESSAGES<a class="headerlink" href="#common-error-messages" title="Permalink to this headline">¶</a></h2>
113 <ol class="arabic">
114 <li><p class="first">kinit returns the error:</p>
115 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">kinit</span><span class="p">:</span> <span class="n">Client</span> <span class="ow">not</span> <span class="n">found</span> <span class="ow">in</span> <span class="n">Kerberos</span> <span class="n">database</span> <span class="k">while</span> <span class="n">getting</span>
116        <span class="n">initial</span> <span class="n">credentials</span>
117 </pre></div>
118 </div>
119 <p>This means that you didn’t create an entry for your username in the
120 Kerberos database.</p>
121 </li>
122 <li><p class="first">sclient returns the error:</p>
123 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">unknown</span> <span class="n">service</span> <span class="n">sample</span><span class="o">/</span><span class="n">tcp</span><span class="p">;</span> <span class="n">check</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">services</span>
124 </pre></div>
125 </div>
126 <p>This means that you don’t have an entry in /etc/services for the
127 sample tcp port.</p>
128 </li>
129 <li><p class="first">sclient returns the error:</p>
130 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">connect</span><span class="p">:</span> <span class="n">Connection</span> <span class="n">refused</span>
131 </pre></div>
132 </div>
133 <p>This probably means you didn’t edit /etc/inetd.conf correctly, or
134 you didn’t restart inetd after editing inetd.conf.</p>
135 </li>
136 <li><p class="first">sclient returns the error:</p>
137 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sclient</span><span class="p">:</span> <span class="n">Server</span> <span class="ow">not</span> <span class="n">found</span> <span class="ow">in</span> <span class="n">Kerberos</span> <span class="n">database</span> <span class="k">while</span> <span class="n">using</span>
138          <span class="n">sendauth</span>
139 </pre></div>
140 </div>
141 <p>This means that the <code class="docutils literal"><span class="pre">sample/hostname&#64;LOCAL.REALM</span></code> service was not
142 defined in the Kerberos database; it should be created using
143 <a class="reference internal" href="kadmin_local.html#kadmin-1"><span class="std std-ref">kadmin</span></a>, and a keytab file needs to be generated to make
144 the key for that service principal available for sclient.</p>
145 </li>
146 <li><p class="first">sclient returns the error:</p>
147 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sendauth</span> <span class="n">rejected</span><span class="p">,</span> <span class="n">error</span> <span class="n">reply</span> <span class="ow">is</span><span class="p">:</span>
148     <span class="s2">&quot;No such file or directory&quot;</span>
149 </pre></div>
150 </div>
151 <p>This probably means sserver couldn’t find the keytab file.  It was
152 probably not installed in the proper directory.</p>
153 </li>
154 </ol>
155 </div>
156 <div class="section" id="environment">
157 <h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
158 <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
159 variables.</p>
160 </div>
161 <div class="section" id="see-also">
162 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
163 <p><a class="reference internal" href="../../user/user_commands/sclient.html#sclient-1"><span class="std std-ref">sclient</span></a>, <a class="reference internal" href="../../user/user_config/kerberos.html#kerberos-7"><span class="std std-ref">kerberos</span></a>, services(5), inetd(8)</p>
164 </div>
165 </div>
166
167
168           </div>
169         </div>
170       </div>
171         </div>
172         <div class="sidebar">
173     <h2>On this page</h2>
174     <ul>
175 <li><a class="reference internal" href="#">sserver</a><ul>
176 <li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
177 <li><a class="reference internal" href="#description">DESCRIPTION</a></li>
178 <li><a class="reference internal" href="#common-error-messages">COMMON ERROR MESSAGES</a></li>
179 <li><a class="reference internal" href="#environment">ENVIRONMENT</a></li>
180 <li><a class="reference internal" href="#see-also">SEE ALSO</a></li>
181 </ul>
182 </li>
183 </ul>
184
185     <br/>
186     <h2>Table of contents</h2>
187     <ul class="current">
188 <li class="toctree-l1"><a class="reference internal" href="../../user/index.html">For users</a></li>
189 <li class="toctree-l1 current"><a class="reference internal" href="../index.html">For administrators</a><ul class="current">
190 <li class="toctree-l2"><a class="reference internal" href="../install.html">Installation guide</a></li>
191 <li class="toctree-l2"><a class="reference internal" href="../conf_files/index.html">Configuration Files</a></li>
192 <li class="toctree-l2"><a class="reference internal" href="../realm_config.html">Realm configuration decisions</a></li>
193 <li class="toctree-l2"><a class="reference internal" href="../database.html">Database administration</a></li>
194 <li class="toctree-l2"><a class="reference internal" href="../dbtypes.html">Database types</a></li>
195 <li class="toctree-l2"><a class="reference internal" href="../lockout.html">Account lockout</a></li>
196 <li class="toctree-l2"><a class="reference internal" href="../conf_ldap.html">Configuring Kerberos with OpenLDAP back-end</a></li>
197 <li class="toctree-l2"><a class="reference internal" href="../appl_servers.html">Application servers</a></li>
198 <li class="toctree-l2"><a class="reference internal" href="../host_config.html">Host configuration</a></li>
199 <li class="toctree-l2"><a class="reference internal" href="../backup_host.html">Backups of secure hosts</a></li>
200 <li class="toctree-l2"><a class="reference internal" href="../pkinit.html">PKINIT configuration</a></li>
201 <li class="toctree-l2"><a class="reference internal" href="../otp.html">OTP Preauthentication</a></li>
202 <li class="toctree-l2"><a class="reference internal" href="../spake.html">SPAKE Preauthentication</a></li>
203 <li class="toctree-l2"><a class="reference internal" href="../dictionary.html">Addressing dictionary attack risks</a></li>
204 <li class="toctree-l2"><a class="reference internal" href="../princ_dns.html">Principal names and DNS</a></li>
205 <li class="toctree-l2"><a class="reference internal" href="../enctypes.html">Encryption types</a></li>
206 <li class="toctree-l2"><a class="reference internal" href="../https.html">HTTPS proxy configuration</a></li>
207 <li class="toctree-l2"><a class="reference internal" href="../auth_indicator.html">Authentication indicators</a></li>
208 <li class="toctree-l2 current"><a class="reference internal" href="index.html">Administration  programs</a><ul class="current">
209 <li class="toctree-l3"><a class="reference internal" href="kadmin_local.html">kadmin</a></li>
210 <li class="toctree-l3"><a class="reference internal" href="kadmind.html">kadmind</a></li>
211 <li class="toctree-l3"><a class="reference internal" href="kdb5_util.html">kdb5_util</a></li>
212 <li class="toctree-l3"><a class="reference internal" href="kdb5_ldap_util.html">kdb5_ldap_util</a></li>
213 <li class="toctree-l3"><a class="reference internal" href="krb5kdc.html">krb5kdc</a></li>
214 <li class="toctree-l3"><a class="reference internal" href="kprop.html">kprop</a></li>
215 <li class="toctree-l3"><a class="reference internal" href="kpropd.html">kpropd</a></li>
216 <li class="toctree-l3"><a class="reference internal" href="kproplog.html">kproplog</a></li>
217 <li class="toctree-l3"><a class="reference internal" href="ktutil.html">ktutil</a></li>
218 <li class="toctree-l3"><a class="reference internal" href="k5srvutil.html">k5srvutil</a></li>
219 <li class="toctree-l3 current"><a class="current reference internal" href="#">sserver</a></li>
220 </ul>
221 </li>
222 <li class="toctree-l2"><a class="reference internal" href="../../mitK5defaults.html">MIT Kerberos defaults</a></li>
223 <li class="toctree-l2"><a class="reference internal" href="../env_variables.html">Environment variables</a></li>
224 <li class="toctree-l2"><a class="reference internal" href="../troubleshoot.html">Troubleshooting</a></li>
225 <li class="toctree-l2"><a class="reference internal" href="../advanced/index.html">Advanced topics</a></li>
226 <li class="toctree-l2"><a class="reference internal" href="../various_envs.html">Various links</a></li>
227 </ul>
228 </li>
229 <li class="toctree-l1"><a class="reference internal" href="../../appdev/index.html">For application developers</a></li>
230 <li class="toctree-l1"><a class="reference internal" href="../../plugindev/index.html">For plugin module developers</a></li>
231 <li class="toctree-l1"><a class="reference internal" href="../../build/index.html">Building Kerberos V5</a></li>
232 <li class="toctree-l1"><a class="reference internal" href="../../basic/index.html">Kerberos V5 concepts</a></li>
233 <li class="toctree-l1"><a class="reference internal" href="../../formats/index.html">Protocols and file formats</a></li>
234 <li class="toctree-l1"><a class="reference internal" href="../../mitK5features.html">MIT Kerberos features</a></li>
235 <li class="toctree-l1"><a class="reference internal" href="../../build_this.html">How to build this documentation from the source</a></li>
236 <li class="toctree-l1"><a class="reference internal" href="../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
237 <li class="toctree-l1"><a class="reference internal" href="../../resources.html">Resources</a></li>
238 </ul>
239
240     <br/>
241     <h4><a href="../../index.html">Full Table of Contents</a></h4>
242     <h4>Search</h4>
243     <form class="search" action="../../search.html" method="get">
244       <input type="text" name="q" size="18" />
245       <input type="submit" value="Go" />
246       <input type="hidden" name="check_keywords" value="yes" />
247       <input type="hidden" name="area" value="default" />
248     </form>
249         </div>
250         <div class="clearer"></div>
251       </div>
252     </div>
253
254     <div class="footer-wrapper">
255         <div class="footer" >
256             <div class="right" ><i>Release: 1.20.1</i><br />
257                 &copy; <a href="../../copyright.html">Copyright</a> 1985-2022, MIT.
258             </div>
259             <div class="left">
260                 
261         <a href="../../index.html" title="Full Table of Contents"
262             >Contents</a> |
263         <a href="k5srvutil.html" title="k5srvutil"
264             >previous</a> |
265         <a href="../../mitK5defaults.html" title="MIT Kerberos defaults"
266             >next</a> |
267         <a href="../../genindex.html" title="General Index"
268             >index</a> |
269         <a href="../../search.html" title="Enter search criteria"
270             >Search</a> |
271     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__sserver">feedback</a>
272             </div>
273         </div>
274     </div>
275
276   </body>
277 </html>