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] [-l] [-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 -l
  74 Tells
  75 .B rpc.gssd
  76 to limit session keys to Single DES even if the kernel supports stronger
  77 encryption types. Service ticket encryption is still governed by what
  78 the KDC believes the target server supports. This way the client can
  79 access a server that has strong keys in its keytab for ticket decryption
  80 but whose kernel only supports Single DES.
  81 .IP
  82 The alternative is to put only Single DES keys in the server's keytab
  83 and limit encryption types for its principal to Single DES on the KDC
  84 which will cause service tickets for this server to be encrypted using
  85 only Single DES and (as a side-effect) contain only Single DES session
  86 keys.
  87 .IP
  88 This legacy behaviour is only required for older servers
  89 (pre nfs-utils-1.2.4). If the server has a recent kernel, Kerberos
  90 implementation and nfs-utils it will work just fine with stronger
  91 encryption.
  92 .IP
  93 .B Note:
  94 This option is only available with Kerberos libraries that
  95 support setable encryption types.
  96 .TP
  97 .B -p path
  98 Tells
  99 .B rpc.gssd
 100 where to look for the rpc_pipefs filesystem.  The default value is
 101 "/var/lib/nfs/rpc_pipefs".
 102 .TP
 103 .B -d directory
 104 Tells
 105 .B rpc.gssd
 106 where to look for Kerberos credential files.  The default value is
 107 "/tmp:/run/user/%U".
 108 This can also be a colon separated list of directories to be searched for
 109 Kerberos credential files.  The sequence "%U", if used, is replaced with
 110 the UID of the user for whom credentials are being searched.
 111 Note that if machine credentials are being
 112 stored in files, then the first directory on this list is where the
 113 machine credentials are stored.
 114 .TP
 115 .B -v
 116 Increases the verbosity of the output (can be specified multiple times).
 117 .TP
 118 .B -r
 119 If the rpcsec_gss library supports setting debug level,
 120 increases the verbosity of the output (can be specified multiple times).
 121 .TP
 122 .B -R realm
 123 Kerberos tickets from this
 124 .I realm
 125 will be preferred when scanning available credentials cache files to be
 126 used to create a context.  By default, the default realm, as configured
 127 in the Kerberos configuration file, is preferred.
 128 .TP
 129 .B -t timeout
 130 Timeout, in seconds, for kernel gss contexts. This option allows you to force
 131 new kernel contexts to be negotiated after
 132 .I timeout
 133 seconds, which allows changing Kerberos tickets and identities frequently.
 134 The default is no explicit timeout, which means the kernel context will live
 135 the lifetime of the Kerberos service ticket used in its creation.
 136 .SH SEE ALSO
 137 .BR rpc.svcgssd(8)
 138 .SH AUTHORS
 139 .br
 140 Dug Song <dugsong@umich.edu>
 141 .br
 142 Andy Adamson <andros@umich.edu>
 143 .br
 144 Marius Aamodt Eriksen <marius@umich.edu>
 145 .br
 146 J. Bruce Fields <bfields@umich.edu>