usr.sbin/gssd/gssd.8

   1 .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/
   2 .\" Authors: Doug Rabson <dfr@rabson.org>
   3 .\" Developed with Red Inc: Alfred Perlstein <alfred@FreeBSD.org>
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd December 22, 2012
  29 .Dt GSSD 8
  30 .Os
  31 .Sh NAME
  32 .Nm gssd
  33 .Nd "Generic Security Services Daemon"
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl d
  37 .Op Fl s Ar dir-list
  38 .Op Fl c Ar file-substring
  39 .Op Fl r Ar preferred-realm
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 program provides support for the kernel GSS-API implementation.
  44 .Pp
  45 The options are as follows:
  46 .Bl -tag
  47 .It Fl d
  48 Run in debug mode.
  49 In this mode,
  50 .Nm
  51 will not fork when it starts.
  52 .It Fl s Ar dir-list
  53 Look for an appropriate credential cache file in this list of directories.
  54 The list should be full pathnames from root, separated by ':' characters.
  55 Usually this list will simply be "/tmp".
  56 Without this option, the
  57 .Nm
  58 daemon assumes that the credential cache file is called /tmp/krb5cc_<uid>,
  59 where <uid> is the effective uid for the RPC caller.
  60 .It Fl c Ar file-substring
  61 Set a file-substring for the credential cache file names.
  62 Only files with this substring embedded in their names will be
  63 selected as candidates when the
  64 .Fl s
  65 has been specified.
  66 If not specified, it defaults to "krb5cc_".
  67 .It Fl r Ar preferred-realm
  68 Set a preferred Kerberos realm for the search of the directory list for
  69 a credentials cache file.
  70 When set, files with TGT credentials for this realm will be selected over
  71 other credential files.
  72 This option is only meaningful when the
  73 .Fl s
  74 option has been specified.
  75 .El
  76 .Sh FILES
  77 .Bl -tag -width ".Pa /etc/krb5.keytab" -compact
  78 .It Pa /etc/krb5.keytab
  79 Contains Kerberos service principals which may be used as credentials
  80 by kernel GSS-API services.
  81 .El
  82 .Sh EXIT STATUS
  83 .Ex -std
  84 .Sh SEE ALSO
  85 .Xr gssapi 3
  86 .Sh HISTORY
  87 The
  88 .Nm
  89 manual page first appeared in
  90 .Fx 8.0 .
  91 .Sh AUTHORS
  92 This
  93 manual page was written by
  94 .An Doug Rabson Aq dfr@FreeBSD.org .