src/man/sserver.man

   1 .TH "SSERVER" "8" " " "0.0.1" "MIT Kerberos"
   2 .SH NAME
   3 sserver \- sample Kerberos version 5 server
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .SH SYNOPSIS
  34 .sp
  35 \fBsserver\fP
  36 [ \fB\-p\fP \fIport\fP ]
  37 [ \fB\-S\fP \fIkeytab\fP ]
  38 [ \fIserver_port\fP ]
  39 .SH DESCRIPTION
  40 .sp
  41 sserver and \fIsclient(1)\fP are a simple demonstration client/server
  42 application.  When sclient connects to sserver, it performs a Kerberos
  43 authentication, and then sserver returns to sclient the Kerberos
  44 principal which was used for the Kerberos authentication.  It makes a
  45 good test that Kerberos has been successfully installed on a machine.
  46 .sp
  47 The service name used by sserver and sclient is sample.  Hence,
  48 sserver will require that there be a keytab entry for the service
  49 \fBsample/hostname.domain.name@REALM.NAME\fP.  This keytab is generated
  50 using the \fIkadmin(1)\fP program.  The keytab file is usually
  51 installed as \fB/etc/krb5.keytab\fP.
  52 .sp
  53 The \fB\-S\fP option allows for a different keytab than the default.
  54 .sp
  55 sserver is normally invoked out of inetd(8), using a line in
  56 \fB/etc/inetd.conf\fP that looks like this:
  57 .INDENT 0.0
  58 .INDENT 3.5
  59 .sp
  60 .nf
  61 .ft C
  62 sample stream tcp nowait root /usr/local/sbin/sserver sserver
  63 .ft P
  64 .fi
  65 .UNINDENT
  66 .UNINDENT
  67 .sp
  68 Since \fBsample\fP is normally not a port defined in \fB/etc/services\fP,
  69 you will usually have to add a line to \fB/etc/services\fP which looks
  70 like this:
  71 .INDENT 0.0
  72 .INDENT 3.5
  73 .sp
  74 .nf
  75 .ft C
  76 sample          13135/tcp
  77 .ft P
  78 .fi
  79 .UNINDENT
  80 .UNINDENT
  81 .sp
  82 When using sclient, you will first have to have an entry in the
  83 Kerberos database, by using \fIkadmin(1)\fP, and then you have to get
  84 Kerberos tickets, by using \fIkinit(1)\fP.  Also, if you are running
  85 the sclient program on a different host than the sserver it will be
  86 connecting to, be sure that both hosts have an entry in /etc/services
  87 for the sample tcp port, and that the same port number is in both
  88 files.
  89 .sp
  90 When you run sclient you should see something like this:
  91 .INDENT 0.0
  92 .INDENT 3.5
  93 .sp
  94 .nf
  95 .ft C
  96 sendauth succeeded, reply is:
  97 reply len 32, contents:
  98 You are nlgilman@JIMI.MIT.EDU
  99 .ft P
 100 .fi
 101 .UNINDENT
 102 .UNINDENT
 103 .SH COMMON ERROR MESSAGES
 104 .INDENT 0.0
 105 .IP 1. 3
 106 .
 107 kinit returns the error:
 108 .INDENT 3.0
 109 .INDENT 3.5
 110 .sp
 111 .nf
 112 .ft C
 113 kinit: Client not found in Kerberos database while getting
 114     initial credentials
 115 .ft P
 116 .fi
 117 .UNINDENT
 118 .UNINDENT
 119 .sp
 120 This means that you didn\(aqt create an entry for your username in the
 121 Kerberos database.
 122 .IP 2. 3
 123 .
 124 sclient returns the error:
 125 .INDENT 3.0
 126 .INDENT 3.5
 127 .sp
 128 .nf
 129 .ft C
 130 unknown service sample/tcp; check /etc/services
 131 .ft P
 132 .fi
 133 .UNINDENT
 134 .UNINDENT
 135 .sp
 136 This means that you don\(aqt have an entry in /etc/services for the
 137 sample tcp port.
 138 .IP 3. 3
 139 .
 140 sclient returns the error:
 141 .INDENT 3.0
 142 .INDENT 3.5
 143 .sp
 144 .nf
 145 .ft C
 146 connect: Connection refused
 147 .ft P
 148 .fi
 149 .UNINDENT
 150 .UNINDENT
 151 .sp
 152 This probably means you didn\(aqt edit /etc/inetd.conf correctly, or
 153 you didn\(aqt restart inetd after editing inetd.conf.
 154 .IP 4. 3
 155 .
 156 sclient returns the error:
 157 .INDENT 3.0
 158 .INDENT 3.5
 159 .sp
 160 .nf
 161 .ft C
 162 sclient: Server not found in Kerberos database while using
 163     sendauth
 164 .ft P
 165 .fi
 166 .UNINDENT
 167 .UNINDENT
 168 .sp
 169 This means that the \fBsample/hostname@LOCAL.REALM\fP service was not
 170 defined in the Kerberos database; it should be created using
 171 \fIkadmin(1)\fP, and a keytab file needs to be generated to make
 172 the key for that service principal available for sclient.
 173 .IP 5. 3
 174 .
 175 sclient returns the error:
 176 .INDENT 3.0
 177 .INDENT 3.5
 178 .sp
 179 .nf
 180 .ft C
 181 sendauth rejected, error reply is:
 182     "No such file or directory"
 183 .ft P
 184 .fi
 185 .UNINDENT
 186 .UNINDENT
 187 .sp
 188 This probably means sserver couldn\(aqt find the keytab file.  It was
 189 probably not installed in the proper directory.
 190 .UNINDENT
 191 .SH SEE ALSO
 192 .sp
 193 \fIsclient(1)\fP, services(5), inetd(8)
 194 .SH AUTHOR
 195 MIT
 196 .SH COPYRIGHT
 197 2011, MIT
 198 .\" Generated by docutils manpage writer.
 199 .