2 * In-kernel rpcbind client supporting versions 2, 3, and 4 of the rpcbind
5 * Based on RFC 1833: "Binding Protocols for ONC RPC Version 2" and
6 * RFC 3530: "Network File System (NFS) version 4 Protocol"
8 * Original: Gilles Quillard, Bull Open Source, 2005 <gilles.quillard@bull.net>
9 * Updated: Chuck Lever, Oracle Corporation, 2007 <chuck.lever@oracle.com>
11 * Descended from net/sunrpc/pmap_clnt.c,
12 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
15 #include <linux/module.h>
17 #include <linux/types.h>
18 #include <linux/socket.h>
20 #include <linux/in6.h>
21 #include <linux/kernel.h>
22 #include <linux/errno.h>
24 #include <linux/sunrpc/clnt.h>
25 #include <linux/sunrpc/sched.h>
28 # define RPCDBG_FACILITY RPCDBG_BIND
31 #define RPCBIND_PROGRAM (100000u)
32 #define RPCBIND_PORT (111u)
39 RPCBPROC_GETADDR = 3, /* alias for GETPORT */
42 RPCBPROC_BCAST = 5, /* alias for CALLIT */
52 #define RPCB_HIGHPROC_2 RPCBPROC_CALLIT
53 #define RPCB_HIGHPROC_3 RPCBPROC_TADDR2UADDR
54 #define RPCB_HIGHPROC_4 RPCBPROC_GETSTAT
59 * Quoting RFC 3530, section 2.2:
61 * For TCP over IPv4 and for UDP over IPv4, the format of r_addr is the
66 * The prefix, "h1.h2.h3.h4", is the standard textual form for
67 * representing an IPv4 address, which is always four octets long.
68 * Assuming big-endian ordering, h1, h2, h3, and h4, are respectively,
69 * the first through fourth octets each converted to ASCII-decimal.
70 * Assuming big-endian ordering, p1 and p2 are, respectively, the first
71 * and second octets each converted to ASCII-decimal. For example, if a
72 * host, in big-endian order, has an address of 0x0A010307 and there is
73 * a service listening on, in big endian order, port 0x020F (decimal
74 * 527), then the complete universal address is "10.1.3.7.2.15".
78 * For TCP over IPv6 and for UDP over IPv6, the format of r_addr is the
81 * x1:x2:x3:x4:x5:x6:x7:x8.p1.p2
83 * The suffix "p1.p2" is the service port, and is computed the same way
84 * as with universal addresses for TCP and UDP over IPv4. The prefix,
85 * "x1:x2:x3:x4:x5:x6:x7:x8", is the standard textual form for
86 * representing an IPv6 address as defined in Section 2.2 of [RFC2373].
87 * Additionally, the two alternative forms specified in Section 2.2 of
88 * [RFC2373] are also acceptable.
90 * XXX: Currently this implementation does not explicitly convert the
91 * stored address to US-ASCII on non-ASCII systems.
93 #define RPCB_MAXADDRLEN (128u)
98 * Quoting RFC 3530, section 2.2:
100 * For TCP over IPv4 the value of r_netid is the string "tcp". For UDP
101 * over IPv4 the value of r_netid is the string "udp".
105 * For TCP over IPv6 the value of r_netid is the string "tcp6". For UDP
106 * over IPv6 the value of r_netid is the string "udp6".
108 #define RPCB_NETID_UDP "\165\144\160" /* "udp" */
109 #define RPCB_NETID_TCP "\164\143\160" /* "tcp" */
110 #define RPCB_NETID_UDP6 "\165\144\160\066" /* "udp6" */
111 #define RPCB_NETID_TCP6 "\164\143\160\066" /* "tcp6" */
113 #define RPCB_MAXNETIDLEN (4u)
118 * The "owner" is allowed to unset a service in the rpcbind database.
119 * We always use the following (arbitrary) fixed string.
121 #define RPCB_OWNER_STRING "rpcb"
122 #define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
124 static void rpcb_getport_done(struct rpc_task *, void *);
125 extern struct rpc_program rpcb_program;
127 struct rpcbind_args {
128 struct rpc_xprt * r_xprt;
133 unsigned short r_port;
135 char r_addr[RPCB_MAXADDRLEN];
139 static struct rpc_procinfo rpcb_procedures2[];
140 static struct rpc_procinfo rpcb_procedures3[];
144 struct rpc_procinfo * rpc_proc;
147 static struct rpcb_info rpcb_next_version[];
148 static struct rpcb_info rpcb_next_version6[];
150 static void rpcb_getport_prepare(struct rpc_task *task, void *calldata)
152 struct rpcbind_args *map = calldata;
153 struct rpc_xprt *xprt = map->r_xprt;
154 struct rpc_message msg = {
155 .rpc_proc = rpcb_next_version[xprt->bind_index].rpc_proc,
157 .rpc_resp = &map->r_port,
160 rpc_call_setup(task, &msg, 0);
163 static void rpcb_map_release(void *data)
165 struct rpcbind_args *map = data;
167 xprt_put(map->r_xprt);
171 static const struct rpc_call_ops rpcb_getport_ops = {
172 .rpc_call_prepare = rpcb_getport_prepare,
173 .rpc_call_done = rpcb_getport_done,
174 .rpc_release = rpcb_map_release,
177 static void rpcb_wake_rpcbind_waiters(struct rpc_xprt *xprt, int status)
179 xprt_clear_binding(xprt);
180 rpc_wake_up_status(&xprt->binding, status);
183 static struct rpc_clnt *rpcb_create(char *hostname, struct sockaddr *srvaddr,
184 int proto, int version, int privileged)
186 struct rpc_create_args args = {
189 .addrsize = sizeof(struct sockaddr_in),
190 .servername = hostname,
191 .program = &rpcb_program,
193 .authflavor = RPC_AUTH_UNIX,
194 .flags = (RPC_CLNT_CREATE_NOPING |
195 RPC_CLNT_CREATE_INTR),
198 switch (srvaddr->sa_family) {
200 ((struct sockaddr_in *)srvaddr)->sin_port = htons(RPCBIND_PORT);
203 ((struct sockaddr_in6 *)srvaddr)->sin6_port = htons(RPCBIND_PORT);
210 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
211 return rpc_create(&args);
215 * rpcb_register - set or unset a port registration with the local rpcbind svc
216 * @prog: RPC program number to bind
217 * @vers: RPC version number to bind
218 * @prot: transport protocol to use to make this request
219 * @port: port value to register
222 * port == 0 means unregister, port != 0 means register.
224 * This routine supports only rpcbind version 2.
226 int rpcb_register(u32 prog, u32 vers, int prot, unsigned short port, int *okay)
228 struct sockaddr_in sin = {
229 .sin_family = AF_INET,
230 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
232 struct rpcbind_args map = {
238 struct rpc_message msg = {
239 .rpc_proc = &rpcb_procedures2[port ?
240 RPCBPROC_SET : RPCBPROC_UNSET],
244 struct rpc_clnt *rpcb_clnt;
247 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
248 "rpcbind\n", (port ? "" : "un"),
249 prog, vers, prot, port);
251 rpcb_clnt = rpcb_create("localhost", (struct sockaddr *) &sin,
253 if (IS_ERR(rpcb_clnt))
254 return PTR_ERR(rpcb_clnt);
256 error = rpc_call_sync(rpcb_clnt, &msg, 0);
258 rpc_shutdown_client(rpcb_clnt);
260 printk(KERN_WARNING "RPC: failed to contact local rpcbind "
261 "server (errno %d).\n", -error);
262 dprintk("RPC: registration status %d/%d\n", error, *okay);
268 * rpcb_getport_sync - obtain the port for an RPC service on a given host
269 * @sin: address of remote peer
270 * @prog: RPC program number to bind
271 * @vers: RPC version number to bind
272 * @prot: transport protocol to use to make this request
274 * Called from outside the RPC client in a synchronous task context.
275 * Uses default timeout parameters specified by underlying transport.
277 * XXX: Needs to support IPv6, and rpcbind versions 3 and 4
279 int rpcb_getport_sync(struct sockaddr_in *sin, __u32 prog,
280 __u32 vers, int prot)
282 struct rpcbind_args map = {
288 struct rpc_message msg = {
289 .rpc_proc = &rpcb_procedures2[RPCBPROC_GETPORT],
291 .rpc_resp = &map.r_port,
293 struct rpc_clnt *rpcb_clnt;
297 dprintk("RPC: %s(" NIPQUAD_FMT ", %u, %u, %d)\n",
298 __FUNCTION__, NIPQUAD(sin->sin_addr.s_addr), prog, vers, prot);
300 sprintf(hostname, NIPQUAD_FMT, NIPQUAD(sin->sin_addr.s_addr));
301 rpcb_clnt = rpcb_create(hostname, (struct sockaddr *)sin, prot, 2, 0);
302 if (IS_ERR(rpcb_clnt))
303 return PTR_ERR(rpcb_clnt);
305 status = rpc_call_sync(rpcb_clnt, &msg, 0);
306 rpc_shutdown_client(rpcb_clnt);
315 EXPORT_SYMBOL_GPL(rpcb_getport_sync);
318 * rpcb_getport_async - obtain the port for a given RPC service on a given host
319 * @task: task that is waiting for portmapper request
321 * This one can be called for an ongoing RPC request, and can be used in
322 * an async (rpciod) context.
324 void rpcb_getport_async(struct rpc_task *task)
326 struct rpc_clnt *clnt = task->tk_client;
328 struct rpc_xprt *xprt = task->tk_xprt;
329 struct rpc_clnt *rpcb_clnt;
330 static struct rpcbind_args *map;
331 struct rpc_task *child;
332 struct sockaddr addr;
334 struct rpcb_info *info;
336 dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
337 task->tk_pid, __FUNCTION__,
338 clnt->cl_server, clnt->cl_prog, clnt->cl_vers, xprt->prot);
340 /* Autobind on cloned rpc clients is discouraged */
341 BUG_ON(clnt->cl_parent != clnt);
343 if (xprt_test_and_set_binding(xprt)) {
344 status = -EAGAIN; /* tell caller to check again */
345 dprintk("RPC: %5u %s: waiting for another binder\n",
346 task->tk_pid, __FUNCTION__);
350 /* Put self on queue before sending rpcbind request, in case
351 * rpcb_getport_done completes before we return from rpc_run_task */
352 rpc_sleep_on(&xprt->binding, task, NULL, NULL);
354 /* Someone else may have bound if we slept */
355 if (xprt_bound(xprt)) {
357 dprintk("RPC: %5u %s: already bound\n",
358 task->tk_pid, __FUNCTION__);
362 rpc_peeraddr(clnt, (void *)&addr, sizeof(addr));
364 /* Don't ever use rpcbind v2 for AF_INET6 requests */
365 switch (addr.sa_family) {
367 info = rpcb_next_version;
370 info = rpcb_next_version6;
373 status = -EAFNOSUPPORT;
374 dprintk("RPC: %5u %s: bad address family\n",
375 task->tk_pid, __FUNCTION__);
378 if (info[xprt->bind_index].rpc_proc == NULL) {
379 xprt->bind_index = 0;
380 status = -EPFNOSUPPORT;
381 dprintk("RPC: %5u %s: no more getport versions available\n",
382 task->tk_pid, __FUNCTION__);
385 bind_version = info[xprt->bind_index].rpc_vers;
387 dprintk("RPC: %5u %s: trying rpcbind version %u\n",
388 task->tk_pid, __FUNCTION__, bind_version);
390 rpcb_clnt = rpcb_create(clnt->cl_server, &addr, xprt->prot,
392 if (IS_ERR(rpcb_clnt)) {
393 status = PTR_ERR(rpcb_clnt);
394 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
395 task->tk_pid, __FUNCTION__, PTR_ERR(rpcb_clnt));
399 map = kzalloc(sizeof(struct rpcbind_args), GFP_ATOMIC);
402 dprintk("RPC: %5u %s: no memory available\n",
403 task->tk_pid, __FUNCTION__);
406 map->r_prog = clnt->cl_prog;
407 map->r_vers = clnt->cl_vers;
408 map->r_prot = xprt->prot;
410 map->r_xprt = xprt_get(xprt);
411 map->r_netid = (xprt->prot == IPPROTO_TCP) ? RPCB_NETID_TCP :
414 rpc_peeraddr2str(rpcb_clnt, RPC_DISPLAY_UNIVERSAL_ADDR),
415 sizeof(map->r_addr));
416 map->r_owner = RPCB_OWNER_STRING; /* ignored for GETADDR */
418 child = rpc_run_task(rpcb_clnt, RPC_TASK_ASYNC, &rpcb_getport_ops, map);
419 rpc_release_client(rpcb_clnt);
422 dprintk("RPC: %5u %s: rpc_run_task failed\n",
423 task->tk_pid, __FUNCTION__);
428 task->tk_xprt->stat.bind_count++;
435 rpcb_wake_rpcbind_waiters(xprt, status);
437 task->tk_status = status;
441 * Rpcbind child task calls this callback via tk_exit.
443 static void rpcb_getport_done(struct rpc_task *child, void *data)
445 struct rpcbind_args *map = data;
446 struct rpc_xprt *xprt = map->r_xprt;
447 int status = child->tk_status;
449 /* Garbage reply: retry with a lesser rpcbind version */
451 status = -EPROTONOSUPPORT;
453 /* rpcbind server doesn't support this rpcbind protocol version */
454 if (status == -EPROTONOSUPPORT)
458 /* rpcbind server not available on remote host? */
459 xprt->ops->set_port(xprt, 0);
460 } else if (map->r_port == 0) {
461 /* Requested RPC service wasn't registered on remote host */
462 xprt->ops->set_port(xprt, 0);
466 xprt->ops->set_port(xprt, map->r_port);
467 xprt_set_bound(xprt);
471 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
472 child->tk_pid, status, map->r_port);
474 rpcb_wake_rpcbind_waiters(xprt, status);
477 static int rpcb_encode_mapping(struct rpc_rqst *req, __be32 *p,
478 struct rpcbind_args *rpcb)
480 dprintk("RPC: rpcb_encode_mapping(%u, %u, %d, %u)\n",
481 rpcb->r_prog, rpcb->r_vers, rpcb->r_prot, rpcb->r_port);
482 *p++ = htonl(rpcb->r_prog);
483 *p++ = htonl(rpcb->r_vers);
484 *p++ = htonl(rpcb->r_prot);
485 *p++ = htonl(rpcb->r_port);
487 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
491 static int rpcb_decode_getport(struct rpc_rqst *req, __be32 *p,
492 unsigned short *portp)
494 *portp = (unsigned short) ntohl(*p++);
495 dprintk("RPC: rpcb_decode_getport result %u\n",
500 static int rpcb_decode_set(struct rpc_rqst *req, __be32 *p,
503 *boolp = (unsigned int) ntohl(*p++);
504 dprintk("RPC: rpcb_decode_set result %u\n",
509 static int rpcb_encode_getaddr(struct rpc_rqst *req, __be32 *p,
510 struct rpcbind_args *rpcb)
512 dprintk("RPC: rpcb_encode_getaddr(%u, %u, %s)\n",
513 rpcb->r_prog, rpcb->r_vers, rpcb->r_addr);
514 *p++ = htonl(rpcb->r_prog);
515 *p++ = htonl(rpcb->r_vers);
517 p = xdr_encode_string(p, rpcb->r_netid);
518 p = xdr_encode_string(p, rpcb->r_addr);
519 p = xdr_encode_string(p, rpcb->r_owner);
521 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
526 static int rpcb_decode_getaddr(struct rpc_rqst *req, __be32 *p,
527 unsigned short *portp)
531 int c, i, f, first, val;
534 addr_len = ntohl(*p++);
537 * Simple sanity check. The smallest possible universal
538 * address is an IPv4 address string containing 11 bytes.
540 if (addr_len < 11 || addr_len > RPCB_MAXADDRLEN)
544 * Start at the end and walk backwards until the first dot
545 * is encountered. When the second dot is found, we have
546 * both parts of the port number.
552 for (i = addr_len - 1; i > 0; i--) {
554 if (c >= '0' && c <= '9') {
555 val += (c - '0') * f;
557 } else if (c == '.') {
563 *portp |= (val << 8);
570 * Simple sanity check. If we never saw a dot in the reply,
571 * then this was probably just garbage.
576 dprintk("RPC: rpcb_decode_getaddr port=%u\n", *portp);
580 dprintk("RPC: rpcbind server returned malformed reply\n");
584 #define RPCB_program_sz (1u)
585 #define RPCB_version_sz (1u)
586 #define RPCB_protocol_sz (1u)
587 #define RPCB_port_sz (1u)
588 #define RPCB_boolean_sz (1u)
590 #define RPCB_netid_sz (1+XDR_QUADLEN(RPCB_MAXNETIDLEN))
591 #define RPCB_addr_sz (1+XDR_QUADLEN(RPCB_MAXADDRLEN))
592 #define RPCB_ownerstring_sz (1+XDR_QUADLEN(RPCB_MAXOWNERLEN))
594 #define RPCB_mappingargs_sz RPCB_program_sz+RPCB_version_sz+ \
595 RPCB_protocol_sz+RPCB_port_sz
596 #define RPCB_getaddrargs_sz RPCB_program_sz+RPCB_version_sz+ \
597 RPCB_netid_sz+RPCB_addr_sz+ \
600 #define RPCB_setres_sz RPCB_boolean_sz
601 #define RPCB_getportres_sz RPCB_port_sz
604 * Note that RFC 1833 does not put any size restrictions on the
605 * address string returned by the remote rpcbind database.
607 #define RPCB_getaddrres_sz RPCB_addr_sz
609 #define PROC(proc, argtype, restype) \
610 [RPCBPROC_##proc] = { \
611 .p_proc = RPCBPROC_##proc, \
612 .p_encode = (kxdrproc_t) rpcb_encode_##argtype, \
613 .p_decode = (kxdrproc_t) rpcb_decode_##restype, \
614 .p_arglen = RPCB_##argtype##args_sz, \
615 .p_replen = RPCB_##restype##res_sz, \
616 .p_statidx = RPCBPROC_##proc, \
622 * Not all rpcbind procedures described in RFC 1833 are implemented
623 * since the Linux kernel RPC code requires only these.
625 static struct rpc_procinfo rpcb_procedures2[] = {
626 PROC(SET, mapping, set),
627 PROC(UNSET, mapping, set),
628 PROC(GETADDR, mapping, getport),
631 static struct rpc_procinfo rpcb_procedures3[] = {
632 PROC(SET, mapping, set),
633 PROC(UNSET, mapping, set),
634 PROC(GETADDR, getaddr, getaddr),
637 static struct rpc_procinfo rpcb_procedures4[] = {
638 PROC(SET, mapping, set),
639 PROC(UNSET, mapping, set),
640 PROC(GETVERSADDR, getaddr, getaddr),
643 static struct rpcb_info rpcb_next_version[] = {
644 #ifdef CONFIG_SUNRPC_BIND34
645 { 4, &rpcb_procedures4[RPCBPROC_GETVERSADDR] },
646 { 3, &rpcb_procedures3[RPCBPROC_GETADDR] },
648 { 2, &rpcb_procedures2[RPCBPROC_GETPORT] },
652 static struct rpcb_info rpcb_next_version6[] = {
653 #ifdef CONFIG_SUNRPC_BIND34
654 { 4, &rpcb_procedures4[RPCBPROC_GETVERSADDR] },
655 { 3, &rpcb_procedures3[RPCBPROC_GETADDR] },
660 static struct rpc_version rpcb_version2 = {
662 .nrprocs = RPCB_HIGHPROC_2,
663 .procs = rpcb_procedures2
666 static struct rpc_version rpcb_version3 = {
668 .nrprocs = RPCB_HIGHPROC_3,
669 .procs = rpcb_procedures3
672 static struct rpc_version rpcb_version4 = {
674 .nrprocs = RPCB_HIGHPROC_4,
675 .procs = rpcb_procedures4
678 static struct rpc_version *rpcb_version[] = {
686 static struct rpc_stat rpcb_stats;
688 struct rpc_program rpcb_program = {
690 .number = RPCBIND_PROGRAM,
691 .nrvers = ARRAY_SIZE(rpcb_version),
692 .version = rpcb_version,
693 .stats = &rpcb_stats,