The rpc.gssd scans for any suitable kerberos ticket. In cross-realm
[nfs-utils.git] / 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   root/<hostname>@<REALM>
57 .br
58   nfs/<hostname>@<REALM>
59 .br
60   host/<hostname>@<REALM>
61 .br
62   root/<anyname>@<REALM>
63 .br
64   nfs/<anyname>@<REALM>
65 .br
66   host/<anyname>@<REALM>
67 .TP
68 .B -p path
69 Tells
70 .B rpc.gssd
71 where to look for the rpc_pipefs filesystem.  The default value is
72 "/var/lib/nfs/rpc_pipefs".
73 .TP
74 .B -d directory
75 Tells
76 .B rpc.gssd
77 where to look for Kerberos credential files.  The default value is "/tmp".
78 This can also be a colon separated list of directories to be searched
79 for Kerberos credential files.  Note that if machine credentials are being
80 stored in files, then the first directory on this list is where the
81 machine credentials are stored.
82 .TP
83 .B -v
84 Increases the verbosity of the output (can be specified multiple times).
85 .TP
86 .B -r
87 If the rpcsec_gss library supports setting debug level,
88 increases the verbosity of the output (can be specified multiple times).
89 .TP
90 .B -R realm
91 Kerberos tickets from this
92 .I realm
93 will be preferred when scanning available credentials cache files to be
94 used to create a context.  By default, the default realm, as configured
95 in the Kerberos configuration file, is preferred.
96 .TP
97 .B -t timeout
98 Timeout, in seconds, for kernel gss contexts. This option allows you to force 
99 new kernel contexts to be negotiated after
100 .I timeout
101 seconds, which allows changing Kerberos tickets and identities frequently.
102 The default is no explicit timeout, which means the kernel context will live
103 the lifetime of the Kerberos service ticket used in its creation.
104 .SH SEE ALSO
105 .BR rpc.svcgssd(8)
106 .SH AUTHORS
107 .br
108 Dug Song <dugsong@umich.edu>
109 .br
110 Andy Adamson <andros@umich.edu>
111 .br
112 Marius Aamodt Eriksen <marius@umich.edu>
113 .br
114 J. Bruce Fields <bfields@umich.edu>