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 /* Provide an entry point hook for the rpcsec_gss module. */
71 struct rpc_gss_entries rpc_gss_entries;
74 NCONF_HANDLE *nhandle;
75 int nflag; /* Whether NETPATH or NETCONFIG */
79 static const struct _rpcnettype {
83 { "netpath", _RPC_NETPATH },
84 { "visible", _RPC_VISIBLE },
85 { "circuit_v", _RPC_CIRCUIT_V },
86 { "datagram_v", _RPC_DATAGRAM_V },
87 { "circuit_n", _RPC_CIRCUIT_N },
88 { "datagram_n", _RPC_DATAGRAM_N },
100 static const struct netid_af na_cvt[] = {
101 { "udp", AF_INET, IPPROTO_UDP },
102 { "tcp", AF_INET, IPPROTO_TCP },
104 { "udp6", AF_INET6, IPPROTO_UDP },
105 { "tcp6", AF_INET6, IPPROTO_TCP },
107 { "local", AF_LOCAL, 0 }
110 struct rpc_createerr rpc_createerr;
113 * Find the appropriate buffer size
117 __rpc_get_t_size(int af, int proto, int size)
123 defsize = 64 * 1024; /* XXX */
126 defsize = UDPMSGSIZE;
129 defsize = RPC_MAXDATASIZE;
135 /* Check whether the value is within the upper max limit */
136 return (size > sb_max_adj ? (u_int)sb_max_adj : (u_int)size);
140 * Find the appropriate address buffer size
148 return sizeof (struct sockaddr_in);
151 return sizeof (struct sockaddr_in6);
154 return sizeof (struct sockaddr_un);
158 return ((u_int)RPC_MAXADDRSIZE);
164 * Used to ping the NULL procedure for clnt handle.
165 * Returns NULL if fails, else a non-NULL pointer.
171 struct timeval TIMEOUT = {25, 0};
173 if (clnt_call(clnt, NULLPROC, (xdrproc_t) xdr_void, NULL,
174 (xdrproc_t) xdr_void, NULL, TIMEOUT) != RPC_SUCCESS) {
177 return ((void *) clnt);
183 __rpc_socket2sockinfo(struct socket *so, struct __rpc_sockinfo *sip)
191 CURVNET_SET(so->so_vnet);
192 error = so->so_proto->pr_usrreqs->pru_sockaddr(so, &sa);
197 sip->si_alen = sa->sa_len;
198 family = sa->sa_family;
201 opt.sopt_dir = SOPT_GET;
202 opt.sopt_level = SOL_SOCKET;
203 opt.sopt_name = SO_TYPE;
204 opt.sopt_val = &type;
205 opt.sopt_valsize = sizeof type;
207 error = sogetopt(so, &opt);
212 if (family != AF_LOCAL) {
213 if (type == SOCK_STREAM)
215 else if (type == SOCK_DGRAM)
223 sip->si_proto = proto;
224 sip->si_socktype = type;
230 * Linear search, but the number of entries is small.
233 __rpc_nconf2sockinfo(const struct netconfig *nconf, struct __rpc_sockinfo *sip)
237 for (i = 0; i < (sizeof na_cvt) / (sizeof (struct netid_af)); i++)
238 if (strcmp(na_cvt[i].netid, nconf->nc_netid) == 0 || (
239 strcmp(nconf->nc_netid, "unix") == 0 &&
240 strcmp(na_cvt[i].netid, "local") == 0)) {
241 sip->si_af = na_cvt[i].af;
242 sip->si_proto = na_cvt[i].protocol;
244 __rpc_seman2socktype((int)nconf->nc_semantics);
245 if (sip->si_socktype == -1)
247 sip->si_alen = __rpc_get_a_size(sip->si_af);
255 __rpc_nconf2socket(const struct netconfig *nconf)
257 struct __rpc_sockinfo si;
261 if (!__rpc_nconf2sockinfo(nconf, &si))
265 error = socreate(si.si_af, &so, si.si_socktype, si.si_proto,
266 curthread->td_ucred, curthread);
275 taddr2uaddr(const struct netconfig *nconf, const struct netbuf *nbuf)
277 struct __rpc_sockinfo si;
279 if (!__rpc_nconf2sockinfo(nconf, &si))
281 return __rpc_taddr2uaddr_af(si.si_af, nbuf);
285 uaddr2taddr(const struct netconfig *nconf, const char *uaddr)
287 struct __rpc_sockinfo si;
289 if (!__rpc_nconf2sockinfo(nconf, &si))
291 return __rpc_uaddr2taddr_af(si.si_af, uaddr);
295 __rpc_taddr2uaddr_af(int af, const struct netbuf *nbuf)
299 struct sockaddr_in *sin;
300 struct sockaddr_un *sun;
301 char namebuf[INET_ADDRSTRLEN];
303 struct sockaddr_in6 *sin6;
304 char namebuf6[INET6_ADDRSTRLEN];
308 sbuf_new(&sb, NULL, 0, SBUF_AUTOEXTEND);
312 if (nbuf->len < sizeof(*sin))
315 if (inet_ntop(af, &sin->sin_addr, namebuf, sizeof namebuf)
318 port = ntohs(sin->sin_port);
319 if (sbuf_printf(&sb, "%s.%u.%u", namebuf,
320 ((uint32_t)port) >> 8,
326 if (nbuf->len < sizeof(*sin6))
329 if (inet_ntop(af, &sin6->sin6_addr, namebuf6, sizeof namebuf6)
332 port = ntohs(sin6->sin6_port);
333 if (sbuf_printf(&sb, "%s.%u.%u", namebuf6,
334 ((uint32_t)port) >> 8,
341 if (sbuf_printf(&sb, "%.*s", (int)(sun->sun_len -
342 offsetof(struct sockaddr_un, sun_path)),
351 ret = strdup(sbuf_data(&sb), M_RPC);
358 __rpc_uaddr2taddr_af(int af, const char *uaddr)
360 struct netbuf *ret = NULL;
362 unsigned port, portlo, porthi;
363 struct sockaddr_in *sin;
365 struct sockaddr_in6 *sin6;
367 struct sockaddr_un *sun;
375 addrstr = strdup(uaddr, M_RPC);
380 * AF_LOCAL addresses are expected to be absolute
381 * pathnames, anything else will be AF_INET or AF_INET6.
383 if (*addrstr != '/') {
384 p = strrchr(addrstr, '.');
387 portlo = (unsigned)strtol(p + 1, NULL, 10);
390 p = strrchr(addrstr, '.');
393 porthi = (unsigned)strtol(p + 1, NULL, 10);
395 port = (porthi << 8) | portlo;
398 ret = (struct netbuf *)malloc(sizeof *ret, M_RPC, M_WAITOK);
402 sin = (struct sockaddr_in *)malloc(sizeof *sin, M_RPC,
404 memset(sin, 0, sizeof *sin);
405 sin->sin_family = AF_INET;
406 sin->sin_port = htons(port);
407 if (inet_pton(AF_INET, addrstr, &sin->sin_addr) <= 0) {
413 sin->sin_len = ret->maxlen = ret->len = sizeof *sin;
418 sin6 = (struct sockaddr_in6 *)malloc(sizeof *sin6, M_RPC,
420 memset(sin6, 0, sizeof *sin6);
421 sin6->sin6_family = AF_INET6;
422 sin6->sin6_port = htons(port);
423 if (inet_pton(AF_INET6, addrstr, &sin6->sin6_addr) <= 0) {
429 sin6->sin6_len = ret->maxlen = ret->len = sizeof *sin6;
434 sun = (struct sockaddr_un *)malloc(sizeof *sun, M_RPC,
436 memset(sun, 0, sizeof *sun);
437 sun->sun_family = AF_LOCAL;
438 strncpy(sun->sun_path, addrstr, sizeof(sun->sun_path) - 1);
439 ret->len = ret->maxlen = sun->sun_len = SUN_LEN(sun);
446 free(addrstr, M_RPC);
451 __rpc_seman2socktype(int semantics)
456 case NC_TPI_COTS_ORD:
468 __rpc_socktype2seman(int socktype)
474 return NC_TPI_COTS_ORD;
485 * Returns the type of the network as defined in <rpc/nettype.h>
486 * If nettype is NULL, it defaults to NETPATH.
489 getnettype(const char *nettype)
493 if ((nettype == NULL) || (nettype[0] == 0)) {
494 return (_RPC_NETPATH); /* Default */
498 nettype = strlocase(nettype);
500 for (i = 0; _rpctypelist[i].name; i++)
501 if (strcasecmp(nettype, _rpctypelist[i].name) == 0) {
502 return (_rpctypelist[i].type);
504 return (_rpctypelist[i].type);
508 * For the given nettype (tcp or udp only), return the first structure found.
509 * This should be freed by calling freenetconfigent()
512 __rpc_getconfip(const char *nettype)
515 static char *netid_tcp = (char *) NULL;
516 static char *netid_udp = (char *) NULL;
517 struct netconfig *dummy;
519 if (!netid_udp && !netid_tcp) {
520 struct netconfig *nconf;
523 if (!(confighandle = setnetconfig())) {
524 log(LOG_ERR, "rpc: failed to open " NETCONFIG);
527 while ((nconf = getnetconfig(confighandle)) != NULL) {
528 if (strcmp(nconf->nc_protofmly, NC_INET) == 0) {
529 if (strcmp(nconf->nc_proto, NC_TCP) == 0) {
530 netid_tcp = strdup(nconf->nc_netid,
533 if (strcmp(nconf->nc_proto, NC_UDP) == 0) {
534 netid_udp = strdup(nconf->nc_netid,
539 endnetconfig(confighandle);
541 if (strcmp(nettype, "udp") == 0)
543 else if (strcmp(nettype, "tcp") == 0)
548 if ((netid == NULL) || (netid[0] == 0)) {
551 dummy = getnetconfigent(netid);
556 * Returns the type of the nettype, which should then be used with
559 * For simplicity in the kernel, we don't support the NETPATH
560 * environment variable. We behave as userland would then NETPATH is
561 * unset, i.e. iterate over all visible entries in netconfig.
564 __rpc_setconf(nettype)
567 struct handle *handle;
569 handle = (struct handle *) malloc(sizeof (struct handle),
571 switch (handle->nettype = getnettype(nettype)) {
574 case _RPC_DATAGRAM_N:
575 if (!(handle->nhandle = setnetconfig()))
577 handle->nflag = TRUE;
581 case _RPC_DATAGRAM_V:
584 if (!(handle->nhandle = setnetconfig())) {
585 log(LOG_ERR, "rpc: failed to open " NETCONFIG);
588 handle->nflag = FALSE;
602 * Returns the next netconfig struct for the given "net" type.
603 * __rpc_setconf() should have been called previously.
606 __rpc_getconf(void *vhandle)
608 struct handle *handle;
609 struct netconfig *nconf;
611 handle = (struct handle *)vhandle;
612 if (handle == NULL) {
617 nconf = getnetconfig(handle->nhandle);
618 if (nconf && !(nconf->nc_flag & NC_VISIBLE))
621 nconf = getnetconfig(handle->nhandle);
625 if ((nconf->nc_semantics != NC_TPI_CLTS) &&
626 (nconf->nc_semantics != NC_TPI_COTS) &&
627 (nconf->nc_semantics != NC_TPI_COTS_ORD))
629 switch (handle->nettype) {
631 if (!(nconf->nc_flag & NC_VISIBLE))
634 case _RPC_NETPATH: /* Be happy */
637 if (!(nconf->nc_flag & NC_VISIBLE))
641 if ((nconf->nc_semantics != NC_TPI_COTS) &&
642 (nconf->nc_semantics != NC_TPI_COTS_ORD))
645 case _RPC_DATAGRAM_V:
646 if (!(nconf->nc_flag & NC_VISIBLE))
649 case _RPC_DATAGRAM_N:
650 if (nconf->nc_semantics != NC_TPI_CLTS)
654 if (((nconf->nc_semantics != NC_TPI_COTS) &&
655 (nconf->nc_semantics != NC_TPI_COTS_ORD)) ||
656 (strcmp(nconf->nc_protofmly, NC_INET)
658 && strcmp(nconf->nc_protofmly, NC_INET6))
663 strcmp(nconf->nc_proto, NC_TCP))
667 if ((nconf->nc_semantics != NC_TPI_CLTS) ||
668 (strcmp(nconf->nc_protofmly, NC_INET)
670 && strcmp(nconf->nc_protofmly, NC_INET6))
675 strcmp(nconf->nc_proto, NC_UDP))
685 __rpc_endconf(vhandle)
688 struct handle *handle;
690 handle = (struct handle *) vhandle;
691 if (handle == NULL) {
694 endnetconfig(handle->nhandle);
699 __rpc_sockisbound(struct socket *so)
704 CURVNET_SET(so->so_vnet);
705 error = so->so_proto->pr_usrreqs->pru_sockaddr(so, &sa);
710 switch (sa->sa_family) {
712 bound = (((struct sockaddr_in *) sa)->sin_port != 0);
716 bound = (((struct sockaddr_in6 *) sa)->sin6_port != 0);
721 bound = (((struct sockaddr_un *) sa)->sun_path[0] != '\0');
734 * Implement XDR-style API for RPC call.
738 CLIENT *cl, /* client handle */
739 struct rpc_callextra *ext, /* call metadata */
740 rpcproc_t proc, /* procedure number */
741 xdrproc_t xargs, /* xdr routine for args */
742 void *argsp, /* pointer to args */
743 xdrproc_t xresults, /* xdr routine for results */
744 void *resultsp, /* pointer to results */
745 struct timeval utimeout) /* seconds to wait before giving up */
752 mreq = m_getcl(M_WAITOK, MT_DATA, 0);
754 xdrmbuf_create(&xdrs, mreq, XDR_ENCODE);
755 if (!xargs(&xdrs, argsp)) {
757 return (RPC_CANTENCODEARGS);
761 stat = CLNT_CALL_MBUF(cl, ext, proc, mreq, &mrep, utimeout);
764 if (stat == RPC_SUCCESS) {
765 xdrmbuf_create(&xdrs, mrep, XDR_DECODE);
766 if (!xresults(&xdrs, resultsp)) {
768 return (RPC_CANTDECODERES);
777 * Bind a socket to a privileged IP port
780 bindresvport(struct socket *so, struct sockaddr *sa)
783 bool_t freesa = FALSE;
784 struct sockaddr_in *sin;
786 struct sockaddr_in6 *sin6;
789 int proto, portrange, portlow;
794 CURVNET_SET(so->so_vnet);
795 error = so->so_proto->pr_usrreqs->pru_sockaddr(so, &sa);
802 memset(sa, 0, sa->sa_len);
811 portrange = IP_PORTRANGE;
812 portlow = IP_PORTRANGE_LOW;
813 sin = (struct sockaddr_in *)sa;
814 portp = &sin->sin_port;
818 proto = IPPROTO_IPV6;
819 portrange = IPV6_PORTRANGE;
820 portlow = IPV6_PORTRANGE_LOW;
821 sin6 = (struct sockaddr_in6 *)sa;
822 portp = &sin6->sin6_port;
826 return (EPFNOSUPPORT);
833 bzero(&opt, sizeof(opt));
834 opt.sopt_dir = SOPT_GET;
835 opt.sopt_level = proto;
836 opt.sopt_name = portrange;
838 opt.sopt_valsize = sizeof(old);
839 error = sogetopt(so, &opt);
844 opt.sopt_dir = SOPT_SET;
845 opt.sopt_val = &portlow;
846 error = sosetopt(so, &opt);
851 error = sobind(so, sa, curthread);
855 opt.sopt_dir = SOPT_SET;
871 krpc_modevent(module_t mod, int type, void *data)
876 static moduledata_t krpc_mod = {
881 DECLARE_MODULE(krpc, krpc_mod, SI_SUB_VFS, SI_ORDER_ANY);
883 /* So that loader and kldload(2) can find us, wherever we are.. */
884 MODULE_VERSION(krpc, 1);
885 MODULE_DEPEND(krpc, xdr, 1, 1, 1);