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>
66 #include <rpc/rpc_com.h>
68 extern u_long sb_max_adj; /* not defined in socketvar.h */
70 #if __FreeBSD_version < 700000
71 #define strrchr rindex
74 /* Provide an entry point hook for the rpcsec_gss module. */
75 struct rpc_gss_entries rpc_gss_entries;
78 NCONF_HANDLE *nhandle;
79 int nflag; /* Whether NETPATH or NETCONFIG */
83 static const struct _rpcnettype {
87 { "netpath", _RPC_NETPATH },
88 { "visible", _RPC_VISIBLE },
89 { "circuit_v", _RPC_CIRCUIT_V },
90 { "datagram_v", _RPC_DATAGRAM_V },
91 { "circuit_n", _RPC_CIRCUIT_N },
92 { "datagram_n", _RPC_DATAGRAM_N },
104 static const struct netid_af na_cvt[] = {
105 { "udp", AF_INET, IPPROTO_UDP },
106 { "tcp", AF_INET, IPPROTO_TCP },
108 { "udp6", AF_INET6, IPPROTO_UDP },
109 { "tcp6", AF_INET6, IPPROTO_TCP },
111 { "local", AF_LOCAL, 0 }
114 struct rpc_createerr rpc_createerr;
117 * Find the appropriate buffer size
121 __rpc_get_t_size(int af, int proto, int size)
127 defsize = 64 * 1024; /* XXX */
130 defsize = UDPMSGSIZE;
133 defsize = RPC_MAXDATASIZE;
139 /* Check whether the value is within the upper max limit */
140 return (size > sb_max_adj ? (u_int)sb_max_adj : (u_int)size);
144 * Find the appropriate address buffer size
152 return sizeof (struct sockaddr_in);
155 return sizeof (struct sockaddr_in6);
158 return sizeof (struct sockaddr_un);
162 return ((u_int)RPC_MAXADDRSIZE);
168 * Used to ping the NULL procedure for clnt handle.
169 * Returns NULL if fails, else a non-NULL pointer.
175 struct timeval TIMEOUT = {25, 0};
177 if (clnt_call(clnt, NULLPROC, (xdrproc_t) xdr_void, NULL,
178 (xdrproc_t) xdr_void, NULL, TIMEOUT) != RPC_SUCCESS) {
181 return ((void *) clnt);
187 __rpc_socket2sockinfo(struct socket *so, struct __rpc_sockinfo *sip)
195 CURVNET_SET(so->so_vnet);
196 error = so->so_proto->pr_usrreqs->pru_sockaddr(so, &sa);
201 sip->si_alen = sa->sa_len;
202 family = sa->sa_family;
205 opt.sopt_dir = SOPT_GET;
206 opt.sopt_level = SOL_SOCKET;
207 opt.sopt_name = SO_TYPE;
208 opt.sopt_val = &type;
209 opt.sopt_valsize = sizeof type;
211 error = sogetopt(so, &opt);
216 if (family != AF_LOCAL) {
217 if (type == SOCK_STREAM)
219 else if (type == SOCK_DGRAM)
227 sip->si_proto = proto;
228 sip->si_socktype = type;
234 * Linear search, but the number of entries is small.
237 __rpc_nconf2sockinfo(const struct netconfig *nconf, struct __rpc_sockinfo *sip)
241 for (i = 0; i < (sizeof na_cvt) / (sizeof (struct netid_af)); i++)
242 if (strcmp(na_cvt[i].netid, nconf->nc_netid) == 0 || (
243 strcmp(nconf->nc_netid, "unix") == 0 &&
244 strcmp(na_cvt[i].netid, "local") == 0)) {
245 sip->si_af = na_cvt[i].af;
246 sip->si_proto = na_cvt[i].protocol;
248 __rpc_seman2socktype((int)nconf->nc_semantics);
249 if (sip->si_socktype == -1)
251 sip->si_alen = __rpc_get_a_size(sip->si_af);
259 __rpc_nconf2socket(const struct netconfig *nconf)
261 struct __rpc_sockinfo si;
265 if (!__rpc_nconf2sockinfo(nconf, &si))
269 error = socreate(si.si_af, &so, si.si_socktype, si.si_proto,
270 curthread->td_ucred, curthread);
279 taddr2uaddr(const struct netconfig *nconf, const struct netbuf *nbuf)
281 struct __rpc_sockinfo si;
283 if (!__rpc_nconf2sockinfo(nconf, &si))
285 return __rpc_taddr2uaddr_af(si.si_af, nbuf);
289 uaddr2taddr(const struct netconfig *nconf, const char *uaddr)
291 struct __rpc_sockinfo si;
293 if (!__rpc_nconf2sockinfo(nconf, &si))
295 return __rpc_uaddr2taddr_af(si.si_af, uaddr);
299 __rpc_taddr2uaddr_af(int af, const struct netbuf *nbuf)
303 struct sockaddr_in *sin;
304 struct sockaddr_un *sun;
305 char namebuf[INET_ADDRSTRLEN];
307 struct sockaddr_in6 *sin6;
308 char namebuf6[INET6_ADDRSTRLEN];
312 sbuf_new(&sb, NULL, 0, SBUF_AUTOEXTEND);
316 if (nbuf->len < sizeof(*sin))
319 if (inet_ntop(af, &sin->sin_addr, namebuf, sizeof namebuf)
322 port = ntohs(sin->sin_port);
323 if (sbuf_printf(&sb, "%s.%u.%u", namebuf,
324 ((uint32_t)port) >> 8,
330 if (nbuf->len < sizeof(*sin6))
333 if (inet_ntop(af, &sin6->sin6_addr, namebuf6, sizeof namebuf6)
336 port = ntohs(sin6->sin6_port);
337 if (sbuf_printf(&sb, "%s.%u.%u", namebuf6,
338 ((uint32_t)port) >> 8,
345 if (sbuf_printf(&sb, "%.*s", (int)(sun->sun_len -
346 offsetof(struct sockaddr_un, sun_path)),
355 ret = strdup(sbuf_data(&sb), M_RPC);
362 __rpc_uaddr2taddr_af(int af, const char *uaddr)
364 struct netbuf *ret = NULL;
366 unsigned port, portlo, porthi;
367 struct sockaddr_in *sin;
369 struct sockaddr_in6 *sin6;
371 struct sockaddr_un *sun;
379 addrstr = strdup(uaddr, M_RPC);
384 * AF_LOCAL addresses are expected to be absolute
385 * pathnames, anything else will be AF_INET or AF_INET6.
387 if (*addrstr != '/') {
388 p = strrchr(addrstr, '.');
391 portlo = (unsigned)strtol(p + 1, NULL, 10);
394 p = strrchr(addrstr, '.');
397 porthi = (unsigned)strtol(p + 1, NULL, 10);
399 port = (porthi << 8) | portlo;
402 ret = (struct netbuf *)malloc(sizeof *ret, M_RPC, M_WAITOK);
406 sin = (struct sockaddr_in *)malloc(sizeof *sin, M_RPC,
408 memset(sin, 0, sizeof *sin);
409 sin->sin_family = AF_INET;
410 sin->sin_port = htons(port);
411 if (inet_pton(AF_INET, addrstr, &sin->sin_addr) <= 0) {
417 sin->sin_len = ret->maxlen = ret->len = sizeof *sin;
422 sin6 = (struct sockaddr_in6 *)malloc(sizeof *sin6, M_RPC,
424 memset(sin6, 0, sizeof *sin6);
425 sin6->sin6_family = AF_INET6;
426 sin6->sin6_port = htons(port);
427 if (inet_pton(AF_INET6, addrstr, &sin6->sin6_addr) <= 0) {
433 sin6->sin6_len = ret->maxlen = ret->len = sizeof *sin6;
438 sun = (struct sockaddr_un *)malloc(sizeof *sun, M_RPC,
440 memset(sun, 0, sizeof *sun);
441 sun->sun_family = AF_LOCAL;
442 strncpy(sun->sun_path, addrstr, sizeof(sun->sun_path) - 1);
443 ret->len = ret->maxlen = sun->sun_len = SUN_LEN(sun);
450 free(addrstr, M_RPC);
455 __rpc_seman2socktype(int semantics)
460 case NC_TPI_COTS_ORD:
472 __rpc_socktype2seman(int socktype)
478 return NC_TPI_COTS_ORD;
489 * Returns the type of the network as defined in <rpc/nettype.h>
490 * If nettype is NULL, it defaults to NETPATH.
493 getnettype(const char *nettype)
497 if ((nettype == NULL) || (nettype[0] == 0)) {
498 return (_RPC_NETPATH); /* Default */
502 nettype = strlocase(nettype);
504 for (i = 0; _rpctypelist[i].name; i++)
505 if (strcasecmp(nettype, _rpctypelist[i].name) == 0) {
506 return (_rpctypelist[i].type);
508 return (_rpctypelist[i].type);
512 * For the given nettype (tcp or udp only), return the first structure found.
513 * This should be freed by calling freenetconfigent()
516 __rpc_getconfip(const char *nettype)
519 static char *netid_tcp = (char *) NULL;
520 static char *netid_udp = (char *) NULL;
521 struct netconfig *dummy;
523 if (!netid_udp && !netid_tcp) {
524 struct netconfig *nconf;
527 if (!(confighandle = setnetconfig())) {
528 log(LOG_ERR, "rpc: failed to open " NETCONFIG);
531 while ((nconf = getnetconfig(confighandle)) != NULL) {
532 if (strcmp(nconf->nc_protofmly, NC_INET) == 0) {
533 if (strcmp(nconf->nc_proto, NC_TCP) == 0) {
534 netid_tcp = strdup(nconf->nc_netid,
537 if (strcmp(nconf->nc_proto, NC_UDP) == 0) {
538 netid_udp = strdup(nconf->nc_netid,
543 endnetconfig(confighandle);
545 if (strcmp(nettype, "udp") == 0)
547 else if (strcmp(nettype, "tcp") == 0)
552 if ((netid == NULL) || (netid[0] == 0)) {
555 dummy = getnetconfigent(netid);
560 * Returns the type of the nettype, which should then be used with
563 * For simplicity in the kernel, we don't support the NETPATH
564 * environment variable. We behave as userland would then NETPATH is
565 * unset, i.e. iterate over all visible entries in netconfig.
568 __rpc_setconf(nettype)
571 struct handle *handle;
573 handle = (struct handle *) malloc(sizeof (struct handle),
575 switch (handle->nettype = getnettype(nettype)) {
578 case _RPC_DATAGRAM_N:
579 if (!(handle->nhandle = setnetconfig()))
581 handle->nflag = TRUE;
585 case _RPC_DATAGRAM_V:
588 if (!(handle->nhandle = setnetconfig())) {
589 log(LOG_ERR, "rpc: failed to open " NETCONFIG);
592 handle->nflag = FALSE;
606 * Returns the next netconfig struct for the given "net" type.
607 * __rpc_setconf() should have been called previously.
610 __rpc_getconf(void *vhandle)
612 struct handle *handle;
613 struct netconfig *nconf;
615 handle = (struct handle *)vhandle;
616 if (handle == NULL) {
621 nconf = getnetconfig(handle->nhandle);
622 if (nconf && !(nconf->nc_flag & NC_VISIBLE))
625 nconf = getnetconfig(handle->nhandle);
629 if ((nconf->nc_semantics != NC_TPI_CLTS) &&
630 (nconf->nc_semantics != NC_TPI_COTS) &&
631 (nconf->nc_semantics != NC_TPI_COTS_ORD))
633 switch (handle->nettype) {
635 if (!(nconf->nc_flag & NC_VISIBLE))
638 case _RPC_NETPATH: /* Be happy */
641 if (!(nconf->nc_flag & NC_VISIBLE))
645 if ((nconf->nc_semantics != NC_TPI_COTS) &&
646 (nconf->nc_semantics != NC_TPI_COTS_ORD))
649 case _RPC_DATAGRAM_V:
650 if (!(nconf->nc_flag & NC_VISIBLE))
653 case _RPC_DATAGRAM_N:
654 if (nconf->nc_semantics != NC_TPI_CLTS)
658 if (((nconf->nc_semantics != NC_TPI_COTS) &&
659 (nconf->nc_semantics != NC_TPI_COTS_ORD)) ||
660 (strcmp(nconf->nc_protofmly, NC_INET)
662 && strcmp(nconf->nc_protofmly, NC_INET6))
667 strcmp(nconf->nc_proto, NC_TCP))
671 if ((nconf->nc_semantics != NC_TPI_CLTS) ||
672 (strcmp(nconf->nc_protofmly, NC_INET)
674 && strcmp(nconf->nc_protofmly, NC_INET6))
679 strcmp(nconf->nc_proto, NC_UDP))
689 __rpc_endconf(vhandle)
692 struct handle *handle;
694 handle = (struct handle *) vhandle;
695 if (handle == NULL) {
698 endnetconfig(handle->nhandle);
703 __rpc_sockisbound(struct socket *so)
708 CURVNET_SET(so->so_vnet);
709 error = so->so_proto->pr_usrreqs->pru_sockaddr(so, &sa);
714 switch (sa->sa_family) {
716 bound = (((struct sockaddr_in *) sa)->sin_port != 0);
720 bound = (((struct sockaddr_in6 *) sa)->sin6_port != 0);
725 bound = (((struct sockaddr_un *) sa)->sun_path[0] != '\0');
738 * Implement XDR-style API for RPC call.
742 CLIENT *cl, /* client handle */
743 struct rpc_callextra *ext, /* call metadata */
744 rpcproc_t proc, /* procedure number */
745 xdrproc_t xargs, /* xdr routine for args */
746 void *argsp, /* pointer to args */
747 xdrproc_t xresults, /* xdr routine for results */
748 void *resultsp, /* pointer to results */
749 struct timeval utimeout) /* seconds to wait before giving up */
756 mreq = m_getcl(M_WAITOK, MT_DATA, 0);
758 xdrmbuf_create(&xdrs, mreq, XDR_ENCODE);
759 if (!xargs(&xdrs, argsp)) {
761 return (RPC_CANTENCODEARGS);
765 stat = CLNT_CALL_MBUF(cl, ext, proc, mreq, &mrep, utimeout);
768 if (stat == RPC_SUCCESS) {
769 xdrmbuf_create(&xdrs, mrep, XDR_DECODE);
770 if (!xresults(&xdrs, resultsp)) {
772 return (RPC_CANTDECODERES);
781 * Bind a socket to a privileged IP port
784 bindresvport(struct socket *so, struct sockaddr *sa)
787 bool_t freesa = FALSE;
788 struct sockaddr_in *sin;
790 struct sockaddr_in6 *sin6;
793 int proto, portrange, portlow;
798 CURVNET_SET(so->so_vnet);
799 error = so->so_proto->pr_usrreqs->pru_sockaddr(so, &sa);
806 memset(sa, 0, sa->sa_len);
815 portrange = IP_PORTRANGE;
816 portlow = IP_PORTRANGE_LOW;
817 sin = (struct sockaddr_in *)sa;
818 portp = &sin->sin_port;
822 proto = IPPROTO_IPV6;
823 portrange = IPV6_PORTRANGE;
824 portlow = IPV6_PORTRANGE_LOW;
825 sin6 = (struct sockaddr_in6 *)sa;
826 portp = &sin6->sin6_port;
830 return (EPFNOSUPPORT);
837 bzero(&opt, sizeof(opt));
838 opt.sopt_dir = SOPT_GET;
839 opt.sopt_level = proto;
840 opt.sopt_name = portrange;
842 opt.sopt_valsize = sizeof(old);
843 error = sogetopt(so, &opt);
848 opt.sopt_dir = SOPT_SET;
849 opt.sopt_val = &portlow;
850 error = sosetopt(so, &opt);
855 error = sobind(so, sa, curthread);
859 opt.sopt_dir = SOPT_SET;
875 krpc_modevent(module_t mod, int type, void *data)
880 static moduledata_t krpc_mod = {
885 DECLARE_MODULE(krpc, krpc_mod, SI_SUB_VFS, SI_ORDER_ANY);
887 /* So that loader and kldload(2) can find us, wherever we are.. */
888 MODULE_VERSION(krpc, 1);