1 /* $NetBSD: rpc_generic.c,v 1.4 2000/09/28 09:07:04 kleink Exp $ */
4 * SPDX-License-Identifier: BSD-3-Clause
6 * Copyright (c) 2009, Sun Microsystems, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 * - Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 * - Redistributions in binary form must reproduce the above copyright notice,
14 * this list of conditions and the following disclaimer in the documentation
15 * and/or other materials provided with the distribution.
16 * - Neither the name of Sun Microsystems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
33 * Copyright (c) 1986-1991 by Sun Microsystems Inc.
36 /* #pragma ident "@(#)rpc_generic.c 1.17 94/04/24 SMI" */
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
41 * rpc_generic.c, Miscl routines for RPC.
45 #include "opt_inet6.h"
47 #include <sys/param.h>
48 #include <sys/kernel.h>
49 #include <sys/malloc.h>
51 #include <sys/module.h>
53 #include <sys/protosw.h>
55 #include <sys/systm.h>
56 #include <sys/socket.h>
57 #include <sys/socketvar.h>
58 #include <sys/syslog.h>
63 #include <rpc/nettype.h>
64 #include <rpc/rpcsec_gss.h>
65 #include <rpc/rpcsec_tls.h>
67 #include <rpc/rpc_com.h>
72 #include <vm/vm_param.h>
74 extern u_long sb_max_adj; /* not defined in socketvar.h */
76 /* Provide an entry point hook for the rpcsec_gss module. */
77 struct rpc_gss_entries rpc_gss_entries;
80 NCONF_HANDLE *nhandle;
81 int nflag; /* Whether NETPATH or NETCONFIG */
85 static const struct _rpcnettype {
89 { "netpath", _RPC_NETPATH },
90 { "visible", _RPC_VISIBLE },
91 { "circuit_v", _RPC_CIRCUIT_V },
92 { "datagram_v", _RPC_DATAGRAM_V },
93 { "circuit_n", _RPC_CIRCUIT_N },
94 { "datagram_n", _RPC_DATAGRAM_N },
106 static const struct netid_af na_cvt[] = {
107 { "udp", AF_INET, IPPROTO_UDP },
108 { "tcp", AF_INET, IPPROTO_TCP },
110 { "udp6", AF_INET6, IPPROTO_UDP },
111 { "tcp6", AF_INET6, IPPROTO_TCP },
113 { "local", AF_LOCAL, 0 }
116 struct rpc_createerr rpc_createerr;
119 * Find the appropriate buffer size
123 __rpc_get_t_size(int af, int proto, int size)
129 defsize = 64 * 1024; /* XXX */
132 defsize = UDPMSGSIZE;
135 defsize = RPC_MAXDATASIZE;
141 /* Check whether the value is within the upper max limit */
142 return (size > sb_max_adj ? (u_int)sb_max_adj : (u_int)size);
146 * Find the appropriate address buffer size
154 return sizeof (struct sockaddr_in);
157 return sizeof (struct sockaddr_in6);
160 return sizeof (struct sockaddr_un);
164 return ((u_int)RPC_MAXADDRSIZE);
170 * Used to ping the NULL procedure for clnt handle.
171 * Returns NULL if fails, else a non-NULL pointer.
177 struct timeval TIMEOUT = {25, 0};
179 if (clnt_call(clnt, NULLPROC, (xdrproc_t) xdr_void, NULL,
180 (xdrproc_t) xdr_void, NULL, TIMEOUT) != RPC_SUCCESS) {
183 return ((void *) clnt);
189 __rpc_socket2sockinfo(struct socket *so, struct __rpc_sockinfo *sip)
197 CURVNET_SET(so->so_vnet);
198 error = so->so_proto->pr_sockaddr(so, &sa);
203 sip->si_alen = sa->sa_len;
204 family = sa->sa_family;
207 opt.sopt_dir = SOPT_GET;
208 opt.sopt_level = SOL_SOCKET;
209 opt.sopt_name = SO_TYPE;
210 opt.sopt_val = &type;
211 opt.sopt_valsize = sizeof type;
213 error = sogetopt(so, &opt);
218 if (family != AF_LOCAL) {
219 if (type == SOCK_STREAM)
221 else if (type == SOCK_DGRAM)
229 sip->si_proto = proto;
230 sip->si_socktype = type;
236 * Linear search, but the number of entries is small.
239 __rpc_nconf2sockinfo(const struct netconfig *nconf, struct __rpc_sockinfo *sip)
243 for (i = 0; i < (sizeof na_cvt) / (sizeof (struct netid_af)); i++)
244 if (strcmp(na_cvt[i].netid, nconf->nc_netid) == 0 || (
245 strcmp(nconf->nc_netid, "unix") == 0 &&
246 strcmp(na_cvt[i].netid, "local") == 0)) {
247 sip->si_af = na_cvt[i].af;
248 sip->si_proto = na_cvt[i].protocol;
250 __rpc_seman2socktype((int)nconf->nc_semantics);
251 if (sip->si_socktype == -1)
253 sip->si_alen = __rpc_get_a_size(sip->si_af);
261 __rpc_nconf2socket(const struct netconfig *nconf)
263 struct __rpc_sockinfo si;
267 if (!__rpc_nconf2sockinfo(nconf, &si))
271 error = socreate(si.si_af, &so, si.si_socktype, si.si_proto,
272 curthread->td_ucred, curthread);
281 taddr2uaddr(const struct netconfig *nconf, const struct netbuf *nbuf)
283 struct __rpc_sockinfo si;
285 if (!__rpc_nconf2sockinfo(nconf, &si))
287 return __rpc_taddr2uaddr_af(si.si_af, nbuf);
291 uaddr2taddr(const struct netconfig *nconf, const char *uaddr)
293 struct __rpc_sockinfo si;
295 if (!__rpc_nconf2sockinfo(nconf, &si))
297 return __rpc_uaddr2taddr_af(si.si_af, uaddr);
301 __rpc_taddr2uaddr_af(int af, const struct netbuf *nbuf)
305 struct sockaddr_in *sin;
306 struct sockaddr_un *sun;
307 char namebuf[INET_ADDRSTRLEN];
309 struct sockaddr_in6 *sin6;
310 char namebuf6[INET6_ADDRSTRLEN];
314 sbuf_new(&sb, NULL, 0, SBUF_AUTOEXTEND);
318 if (nbuf->len < sizeof(*sin))
321 if (inet_ntop(af, &sin->sin_addr, namebuf, sizeof namebuf)
324 port = ntohs(sin->sin_port);
325 if (sbuf_printf(&sb, "%s.%u.%u", namebuf,
326 ((uint32_t)port) >> 8,
332 if (nbuf->len < sizeof(*sin6))
335 if (inet_ntop(af, &sin6->sin6_addr, namebuf6, sizeof namebuf6)
338 port = ntohs(sin6->sin6_port);
339 if (sbuf_printf(&sb, "%s.%u.%u", namebuf6,
340 ((uint32_t)port) >> 8,
347 if (sbuf_printf(&sb, "%.*s", (int)(sun->sun_len -
348 offsetof(struct sockaddr_un, sun_path)),
357 ret = strdup(sbuf_data(&sb), M_RPC);
364 __rpc_uaddr2taddr_af(int af, const char *uaddr)
366 struct netbuf *ret = NULL;
368 unsigned port, portlo, porthi;
369 struct sockaddr_in *sin;
371 struct sockaddr_in6 *sin6;
373 struct sockaddr_un *sun;
381 addrstr = strdup(uaddr, M_RPC);
386 * AF_LOCAL addresses are expected to be absolute
387 * pathnames, anything else will be AF_INET or AF_INET6.
389 if (*addrstr != '/') {
390 p = strrchr(addrstr, '.');
393 portlo = (unsigned)strtol(p + 1, NULL, 10);
396 p = strrchr(addrstr, '.');
399 porthi = (unsigned)strtol(p + 1, NULL, 10);
401 port = (porthi << 8) | portlo;
404 ret = (struct netbuf *)malloc(sizeof *ret, M_RPC, M_WAITOK);
408 sin = (struct sockaddr_in *)malloc(sizeof *sin, M_RPC,
410 memset(sin, 0, sizeof *sin);
411 sin->sin_family = AF_INET;
412 sin->sin_port = htons(port);
413 if (inet_pton(AF_INET, addrstr, &sin->sin_addr) <= 0) {
419 sin->sin_len = ret->maxlen = ret->len = sizeof *sin;
424 sin6 = (struct sockaddr_in6 *)malloc(sizeof *sin6, M_RPC,
426 memset(sin6, 0, sizeof *sin6);
427 sin6->sin6_family = AF_INET6;
428 sin6->sin6_port = htons(port);
429 if (inet_pton(AF_INET6, addrstr, &sin6->sin6_addr) <= 0) {
435 sin6->sin6_len = ret->maxlen = ret->len = sizeof *sin6;
440 sun = (struct sockaddr_un *)malloc(sizeof *sun, M_RPC,
442 memset(sun, 0, sizeof *sun);
443 sun->sun_family = AF_LOCAL;
444 strncpy(sun->sun_path, addrstr, sizeof(sun->sun_path) - 1);
445 ret->len = ret->maxlen = sun->sun_len = SUN_LEN(sun);
452 free(addrstr, M_RPC);
457 __rpc_seman2socktype(int semantics)
462 case NC_TPI_COTS_ORD:
474 __rpc_socktype2seman(int socktype)
480 return NC_TPI_COTS_ORD;
491 * Returns the type of the network as defined in <rpc/nettype.h>
492 * If nettype is NULL, it defaults to NETPATH.
495 getnettype(const char *nettype)
499 if ((nettype == NULL) || (nettype[0] == 0)) {
500 return (_RPC_NETPATH); /* Default */
504 nettype = strlocase(nettype);
506 for (i = 0; _rpctypelist[i].name; i++)
507 if (strcasecmp(nettype, _rpctypelist[i].name) == 0) {
508 return (_rpctypelist[i].type);
510 return (_rpctypelist[i].type);
514 * For the given nettype (tcp or udp only), return the first structure found.
515 * This should be freed by calling freenetconfigent()
518 __rpc_getconfip(const char *nettype)
521 static char *netid_tcp = (char *) NULL;
522 static char *netid_udp = (char *) NULL;
523 struct netconfig *dummy;
525 if (!netid_udp && !netid_tcp) {
526 struct netconfig *nconf;
529 if (!(confighandle = setnetconfig())) {
530 log(LOG_ERR, "rpc: failed to open " NETCONFIG);
533 while ((nconf = getnetconfig(confighandle)) != NULL) {
534 if (strcmp(nconf->nc_protofmly, NC_INET) == 0) {
535 if (strcmp(nconf->nc_proto, NC_TCP) == 0) {
536 netid_tcp = strdup(nconf->nc_netid,
539 if (strcmp(nconf->nc_proto, NC_UDP) == 0) {
540 netid_udp = strdup(nconf->nc_netid,
545 endnetconfig(confighandle);
547 if (strcmp(nettype, "udp") == 0)
549 else if (strcmp(nettype, "tcp") == 0)
554 if ((netid == NULL) || (netid[0] == 0)) {
557 dummy = getnetconfigent(netid);
562 * Returns the type of the nettype, which should then be used with
565 * For simplicity in the kernel, we don't support the NETPATH
566 * environment variable. We behave as userland would then NETPATH is
567 * unset, i.e. iterate over all visible entries in netconfig.
570 __rpc_setconf(nettype)
573 struct handle *handle;
575 handle = (struct handle *) malloc(sizeof (struct handle),
577 switch (handle->nettype = getnettype(nettype)) {
580 case _RPC_DATAGRAM_N:
581 if (!(handle->nhandle = setnetconfig()))
583 handle->nflag = TRUE;
587 case _RPC_DATAGRAM_V:
590 if (!(handle->nhandle = setnetconfig())) {
591 log(LOG_ERR, "rpc: failed to open " NETCONFIG);
594 handle->nflag = FALSE;
608 * Returns the next netconfig struct for the given "net" type.
609 * __rpc_setconf() should have been called previously.
612 __rpc_getconf(void *vhandle)
614 struct handle *handle;
615 struct netconfig *nconf;
617 handle = (struct handle *)vhandle;
618 if (handle == NULL) {
623 nconf = getnetconfig(handle->nhandle);
624 if (nconf && !(nconf->nc_flag & NC_VISIBLE))
627 nconf = getnetconfig(handle->nhandle);
631 if ((nconf->nc_semantics != NC_TPI_CLTS) &&
632 (nconf->nc_semantics != NC_TPI_COTS) &&
633 (nconf->nc_semantics != NC_TPI_COTS_ORD))
635 switch (handle->nettype) {
637 if (!(nconf->nc_flag & NC_VISIBLE))
640 case _RPC_NETPATH: /* Be happy */
643 if (!(nconf->nc_flag & NC_VISIBLE))
647 if ((nconf->nc_semantics != NC_TPI_COTS) &&
648 (nconf->nc_semantics != NC_TPI_COTS_ORD))
651 case _RPC_DATAGRAM_V:
652 if (!(nconf->nc_flag & NC_VISIBLE))
655 case _RPC_DATAGRAM_N:
656 if (nconf->nc_semantics != NC_TPI_CLTS)
660 if (((nconf->nc_semantics != NC_TPI_COTS) &&
661 (nconf->nc_semantics != NC_TPI_COTS_ORD)) ||
662 (strcmp(nconf->nc_protofmly, NC_INET)
664 && strcmp(nconf->nc_protofmly, NC_INET6))
669 strcmp(nconf->nc_proto, NC_TCP))
673 if ((nconf->nc_semantics != NC_TPI_CLTS) ||
674 (strcmp(nconf->nc_protofmly, NC_INET)
676 && strcmp(nconf->nc_protofmly, NC_INET6))
681 strcmp(nconf->nc_proto, NC_UDP))
691 __rpc_endconf(vhandle)
694 struct handle *handle;
696 handle = (struct handle *) vhandle;
697 if (handle == NULL) {
700 endnetconfig(handle->nhandle);
705 __rpc_sockisbound(struct socket *so)
710 CURVNET_SET(so->so_vnet);
711 error = so->so_proto->pr_sockaddr(so, &sa);
716 switch (sa->sa_family) {
718 bound = (((struct sockaddr_in *) sa)->sin_port != 0);
722 bound = (((struct sockaddr_in6 *) sa)->sin6_port != 0);
727 bound = (((struct sockaddr_un *) sa)->sun_path[0] != '\0');
740 * Implement XDR-style API for RPC call.
744 CLIENT *cl, /* client handle */
745 struct rpc_callextra *ext, /* call metadata */
746 rpcproc_t proc, /* procedure number */
747 xdrproc_t xargs, /* xdr routine for args */
748 void *argsp, /* pointer to args */
749 xdrproc_t xresults, /* xdr routine for results */
750 void *resultsp, /* pointer to results */
751 struct timeval utimeout) /* seconds to wait before giving up */
758 mreq = m_getcl(M_WAITOK, MT_DATA, 0);
760 xdrmbuf_create(&xdrs, mreq, XDR_ENCODE);
761 if (!xargs(&xdrs, argsp)) {
763 return (RPC_CANTENCODEARGS);
767 stat = CLNT_CALL_MBUF(cl, ext, proc, mreq, &mrep, utimeout);
770 if (stat == RPC_SUCCESS) {
771 xdrmbuf_create(&xdrs, mrep, XDR_DECODE);
772 if (!xresults(&xdrs, resultsp)) {
774 return (RPC_CANTDECODERES);
783 * Bind a socket to a privileged IP port
786 bindresvport(struct socket *so, struct sockaddr *sa)
789 bool_t freesa = FALSE;
790 struct sockaddr_in *sin;
792 struct sockaddr_in6 *sin6;
795 int proto, portrange, portlow;
800 CURVNET_SET(so->so_vnet);
801 error = so->so_proto->pr_sockaddr(so, &sa);
808 memset(sa, 0, sa->sa_len);
817 portrange = IP_PORTRANGE;
818 portlow = IP_PORTRANGE_LOW;
819 sin = (struct sockaddr_in *)sa;
820 portp = &sin->sin_port;
824 proto = IPPROTO_IPV6;
825 portrange = IPV6_PORTRANGE;
826 portlow = IPV6_PORTRANGE_LOW;
827 sin6 = (struct sockaddr_in6 *)sa;
828 portp = &sin6->sin6_port;
832 return (EPFNOSUPPORT);
839 bzero(&opt, sizeof(opt));
840 opt.sopt_dir = SOPT_GET;
841 opt.sopt_level = proto;
842 opt.sopt_name = portrange;
844 opt.sopt_valsize = sizeof(old);
845 error = sogetopt(so, &opt);
850 opt.sopt_dir = SOPT_SET;
851 opt.sopt_val = &portlow;
852 error = sosetopt(so, &opt);
857 error = sobind(so, sa, curthread);
861 opt.sopt_dir = SOPT_SET;
874 * Make sure an mbuf list is made up entirely of ext_pgs mbufs.
875 * This is needed for sosend() when KERN_TLS is being used.
876 * (There might also be a performance improvement for certain
877 * network interfaces that handle ext_pgs mbufs efficiently.)
878 * It expects at least one non-ext_pgs mbuf followed by zero
879 * or more ext_pgs mbufs. It does not handle the case where
880 * non-ext_pgs mbuf(s) follow ext_pgs ones.
881 * It also performs sanity checks on the resultant list.
882 * The "mp" argument list is consumed.
883 * The "maxextsiz" argument is the upper bound on the data
884 * size for each mbuf (usually 16K for KERN_TLS).
887 _rpc_copym_into_ext_pgs(struct mbuf *mp, int maxextsiz)
889 struct mbuf *m, *m2, *m3, *mhead;
892 KASSERT((mp->m_flags & (M_EXT | M_EXTPG)) !=
893 (M_EXT | M_EXTPG), ("_rpc_copym_into_ext_pgs:"
894 " first mbuf is an ext_pgs"));
896 * Find the last non-ext_pgs mbuf and the total
897 * length of the non-ext_pgs mbuf(s).
898 * The first mbuf must always be a non-ext_pgs
903 for (m = mp->m_next; m != NULL; m = m->m_next) {
904 if ((m->m_flags & M_EXTPG) != 0)
911 * Copy the non-ext_pgs mbuf(s) into an ext_pgs
915 mhead = mb_mapped_to_unmapped(mp, tlen, maxextsiz,
919 * Link the ext_pgs list onto the newly copied
920 * list and free up the non-ext_pgs mbuf(s).
926 * Sanity check the resultant mbuf list. Check for and
927 * remove any 0 length mbufs in the list, since the
928 * KERN_TLS code does not expect any 0 length mbuf(s)
935 KASSERT(m2->m_len >= 0, ("_rpc_copym_into_ext_pgs:"
937 KASSERT((m2->m_flags & (M_EXT | M_EXTPG)) ==
938 (M_EXT | M_EXTPG), ("_rpc_copym_into_ext_pgs:"
939 " non-nomap mbuf in list"));
940 if (m2->m_len == 0) {
942 m3->m_next = m2->m_next;
952 MBUF_EXT_PGS_ASSERT_SANITY(m2);
965 krpc_modevent(module_t mod, int type, void *data)
971 error = rpctls_init();
975 * Cannot be unloaded, since the rpctlssd or rpctlscd daemons
976 * might be performing a rpctls syscall.
984 static moduledata_t krpc_mod = {
989 DECLARE_MODULE(krpc, krpc_mod, SI_SUB_VFS, SI_ORDER_ANY);
991 /* So that loader and kldload(2) can find us, wherever we are.. */
992 MODULE_VERSION(krpc, 1);
993 MODULE_DEPEND(krpc, xdr, 1, 1, 1);