utils/gssd/gssd.man

   1 .\"
   2 .\" rpc.gssd(8)
   3 .\"
   4 .\" Copyright (C) 2003 J. Bruce Fields <bfields@umich.edu>
   5 .TH rpc.gssd 8 "14 Mar 2007"
   6 .SH NAME
   7 rpc.gssd \- rpcsec_gss daemon
   8 .SH SYNOPSIS
   9 .B "rpc.gssd [-f] [-n] [-k keytab] [-p pipefsdir] [-v] [-r] [-d ccachedir]"
  10 .SH DESCRIPTION
  11 The rpcsec_gss protocol gives a means of using the gss-api generic security
  12 api to provide security for protocols using rpc (in particular, nfs).  Before
  13 exchanging any rpc requests using rpcsec_gss, the rpc client must first
  14 establish a security context.  The linux kernel's implementation of rpcsec_gss
  15 depends on the userspace daemon
  16 .B rpc.gssd
  17 to establish security contexts.  The
  18 .B rpc.gssd
  19 daemon uses files in the rpc_pipefs filesystem to communicate with the kernel.
  20
  21 .SH OPTIONS
  22 .TP
  23 .B -f
  24 Runs
  25 .B rpc.gssd
  26 in the foreground and sends output to stderr (as opposed to syslogd)
  27 .TP
  28 .B -n
  29 By default,
  30 .B rpc.gssd
  31 treats accesses by the user with UID 0 specially, and uses
  32 "machine credentials" for all accesses by that user which
  33 require Kerberos authentication.
  34 With the \-n option, "machine credentials" will not be used
  35 for accesses by UID 0.  Instead, credentials must be obtained
  36 manually like all other users.  Use of this option means that
  37 "root" must manually obtain Kerberos credentials before
  38 attempting to mount an nfs filesystem requiring Kerberos
  39 authentication.
  40 .TP
  41 .B -k keytab
  42 Tells
  43 .B rpc.gssd
  44 to use the keys found in
  45 .I keytab
  46 to obtain "machine credentials".
  47 The default value is "/etc/krb5.keytab".
  48 .IP
  49 Previous versions of
  50 .B rpc.gssd
  51 used only "nfs/*" keys found within the keytab.
  52 To be more consistent with other implementations, we now look for
  53 specific keytab entries.  The search order for keytabs to be used
  54 for "machine credentials" is now:
  55 .br
  56   <HOSTNAME>$@<REALM>
  57 .br
  58   root/<hostname>@<REALM>
  59 .br
  60   nfs/<hostname>@<REALM>
  61 .br
  62   host/<hostname>@<REALM>
  63 .br
  64   root/<anyname>@<REALM>
  65 .br
  66   nfs/<anyname>@<REALM>
  67 .br
  68   host/<anyname>@<REALM>
  69 .IP
  70 If this search order does not use the correct key then provide a
  71 keytab file that contains only correct keys.
  72 .TP
  73 .B -p path
  74 Tells
  75 .B rpc.gssd
  76 where to look for the rpc_pipefs filesystem.  The default value is
  77 "/var/lib/nfs/rpc_pipefs".
  78 .TP
  79 .B -d directory
  80 Tells
  81 .B rpc.gssd
  82 where to look for Kerberos credential files.  The default value is "/tmp".
  83 This can also be a colon separated list of directories to be searched
  84 for Kerberos credential files.  Note that if machine credentials are being
  85 stored in files, then the first directory on this list is where the
  86 machine credentials are stored.
  87 .TP
  88 .B -v
  89 Increases the verbosity of the output (can be specified multiple times).
  90 .TP
  91 .B -r
  92 If the rpcsec_gss library supports setting debug level,
  93 increases the verbosity of the output (can be specified multiple times).
  94 .TP
  95 .B -R realm
  96 Kerberos tickets from this
  97 .I realm
  98 will be preferred when scanning available credentials cache files to be
  99 used to create a context.  By default, the default realm, as configured
 100 in the Kerberos configuration file, is preferred.
 101 .TP
 102 .B -t timeout
 103 Timeout, in seconds, for kernel gss contexts. This option allows you to force
 104 new kernel contexts to be negotiated after
 105 .I timeout
 106 seconds, which allows changing Kerberos tickets and identities frequently.
 107 The default is no explicit timeout, which means the kernel context will live
 108 the lifetime of the Kerberos service ticket used in its creation.
 109 .SH SEE ALSO
 110 .BR rpc.svcgssd(8)
 111 .SH AUTHORS
 112 .br
 113 Dug Song <dugsong@umich.edu>
 114 .br
 115 Andy Adamson <andros@umich.edu>
 116 .br
 117 Marius Aamodt Eriksen <marius@umich.edu>
 118 .br
 119 J. Bruce Fields <bfields@umich.edu>