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>
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
28 .\" Modified from gssd.8 for rpc.tlsclntd.8 by Rick Macklem.
29 .Dd September 23, 2022
34 .Nd "Sun RPC over TLS Client Daemon"
38 .Op Fl C Ar available_ciphers
49 program provides support for the client side of the kernel Sun RPC over TLS
51 This daemon must be running for the kernel RPC to be able to do a TLS
52 connection to a server for an NFS over TLS mount.
53 This daemon requires that the kernel be built with
54 .Dq options KERNEL_TLS
55 and be running on an architecture such as
57 that supports a direct map (not i386) with
65 options have been specified, the daemon will require the server's
67 and have a Fully Qualified Domain Name (FQDN) in it.
69 the reverse DNS name for the IP address that
70 the server is using for the TCP connection.
72 in either the DNS field of the subjectAltName or the CN field of the
73 subjectName in the certificate and
74 cannot have a wildcard
78 If a SIGHUP signal is sent to the daemon it will reload the
80 and will shut down any extant connections that presented certificates
81 during TLS handshake that have been revoked.
84 option was not specified, the SIGHUP signal will be ignored.
86 The daemon will log failed certificate verifications via
88 using LOG_INFO | LOG_DAEMON when the
92 option has been specified.
94 The options are as follows:
95 .Bl -tag -width indent
96 .It Fl 2 , Fl Fl usetls1_2
97 Specify the use of TLS version 1.2.
98 By default, the client will
99 use TLS version 1.3, as required by the RFC.
104 this option, since they only support TLS version 1.2.
105 .It Fl C Ar available_ciphers , Fl Fl ciphers= Ns Ar available_ciphers
106 Specify which ciphers are available during TLS handshake.
107 If this option is specified,
108 .Dq SSL_CTX_set_ciphersuites()
110 .Dq available_ciphers
112 If this option is not specified, the cipher will be chosen by
114 which should be adequate for most cases.
115 The format for the available ciphers is a simple
119 separated list, in order of preference.
121 .Dq openssl ciphers -s -tls1_3
122 lists available ciphers.
123 .It Fl D Ar certdir , Fl Fl certdir= Ns Ar certdir
126 instead of /etc/rpc.tlsclntd for the
129 .It Fl d , Fl Fl debuglevel
133 will not fork when it starts.
134 .It Fl l Ar CAfile , Fl Fl verifylocs= Ns Ar CAfile
135 This specifies the path name of a CAfile which holds the information
136 for server certificate verification.
137 This path name is used in
138 .Dq SSL_CTX_load_verify_locations(ctx,CAfile,NULL)
140 .Dq SSL_CTX_set0_CA_list(ctx,SSL_load_client_CA_file(CAfile))
141 openssl library calls.
142 Note that this is a path name for the file and is not assumed to be
145 .It Fl m , Fl Fl mutualverf
146 Enable support for mutual authentication.
147 A certificate and associated key must be found in /etc/rpc.tlsclntd
148 (or the directory specified by the
151 in case a server requests a peer certificate.
152 The first certificate needs to be in a file named
154 and the associated key in a file named
160 can be used to override the default certificate for a given
161 NFS mount, where the files use the alternate naming specified by the option.
162 If there is a passphrase on the
164 file, this daemon will prompt for the passphrase during startup.
165 The keys for alternate certificates cannot have passphrases.
166 .It Fl p Ar CApath , Fl Fl verifydir= Ns Ar CApath
167 This option is similar to the
169 option, but specifies the path of a directory with CA
171 When this option is used,
172 .Dq SSL_CTX_set0_CA_list(ctx,SSL_load_client_CA_file())
173 is not called, so a list of CA names is not be passed
174 to the server during the TLS handshake.
175 The openssl documentation indicates this call is rarely needed.
176 .It Fl r Ar CRLfile , Fl Fl crl= Ns Ar CRLfile
177 This option specifies a Certificate Revocation List (CRL) file
178 that is to be loaded into the verify certificate store and
179 checked during verification of the server's certificate.
180 This option is meaningless unless either the
185 .It Fl v , Fl Fl verbose
189 will log activity messages to syslog using LOG_INFO | LOG_DAEMON or to
192 option has also been specified.
204 The implementation is based on the specification in
207 .%T "Towards Remote Procedure Call Encryption By Default"
212 manual page first appeared in
215 This daemon cannot be safely shut down and restarted if there are
216 any active RPC-over-TLS connections.
217 Doing so will orphan the KERNEL_TLS connections, so that they
218 can no longer do upcalls successfully, since the
220 structures in userspace have been lost.