xref: /freebsd/usr.sbin/gssd/gssd.8 (revision 86c9d9918f1db7cdd968b60f8902466887bcd9e9)
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 July 7, 2013
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 h
38.Op Fl o
39.Op Fl v
40.Op Fl s Ar dir-list
41.Op Fl c Ar file-substring
42.Op Fl r Ar preferred-realm
43.Sh DESCRIPTION
44The
45.Nm
46program provides support for the kernel GSS-API implementation.
47.Pp
48The options are as follows:
49.Bl -tag -width indent
50.It Fl d
51Run in debug mode.
52In this mode,
53.Nm
54will not fork when it starts.
55.It Fl h
56Enable support for host-based initiator credentials.
57This permits a kerberized NFS mount to use a service principal in
58the default Kerberos 5 keytab file for access.
59Such access is enabled via the
60gssname
61option for the
62.Xr mount_nfs 8
63command.
64.It Fl o
65Force use of DES and the associated old style GSS-API initialization token.
66This may be required to make kerberized NFS mounts work against some
67non-FreeBSD NFS servers.
68.It Fl v
69Run in verbose mode.
70In this mode,
71.Nm
72will log activity messages to syslog using LOG_INFO | LOG_DAEMON or to
73stderr, if the
74.Fl d
75option has also been specified.
76The minor status is logged as a decimal number, since it is actually a
77Kerberos return status, which is signed.
78.It Fl s Ar dir-list
79Look for an appropriate credential cache file in this list of directories.
80The list should be full pathnames from root, separated by ':' characters.
81Usually this list will simply be "/tmp".
82Without this option,
83.Nm
84assumes that the credential cache file is called /tmp/krb5cc_<uid>,
85where <uid> is the effective uid for the RPC caller.
86.It Fl c Ar file-substring
87Set a file-substring for the credential cache file names.
88Only files with this substring embedded in their names will be
89selected as candidates when
90.Fl s
91has been specified.
92If not specified, it defaults to "krb5cc_".
93.It Fl r Ar preferred-realm
94Use Kerberos credentials for this realm when searching for
95credentials in directories specified with
96.Fl s .
97If not specified, the default Kerberos realm will be used.
98.El
99.Sh FILES
100.Bl -tag -width ".Pa /etc/krb5.keytab" -compact
101.It Pa /etc/krb5.keytab
102Contains Kerberos service principals which may be used as credentials
103by kernel GSS-API services.
104.El
105.Sh EXIT STATUS
106.Ex -std
107.Sh SEE ALSO
108.Xr gssapi 3 ,
109.Xr syslog 3 ,
110.Xr mount_nfs 8
111.Sh HISTORY
112The
113.Nm
114manual page first appeared in
115.Fx 8.0 .
116.Sh AUTHORS
117This
118manual page was written by
119.An Doug Rabson Aq Mt dfr@FreeBSD.org .
120