1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * In-kernel rpcbind client supporting versions 2, 3, and 4 of the rpcbind
4 * protocol
5 *
6 * Based on RFC 1833: "Binding Protocols for ONC RPC Version 2" and
7 * RFC 3530: "Network File System (NFS) version 4 Protocol"
8 *
9 * Original: Gilles Quillard, Bull Open Source, 2005 <gilles.quillard@bull.net>
10 * Updated: Chuck Lever, Oracle Corporation, 2007 <chuck.lever@oracle.com>
11 *
12 * Descended from net/sunrpc/pmap_clnt.c,
13 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
14 */
15
16 #include <linux/module.h>
17
18 #include <linux/types.h>
19 #include <linux/socket.h>
20 #include <linux/un.h>
21 #include <linux/in.h>
22 #include <linux/in6.h>
23 #include <linux/kernel.h>
24 #include <linux/errno.h>
25 #include <linux/mutex.h>
26 #include <linux/slab.h>
27 #include <net/ipv6.h>
28
29 #include <linux/sunrpc/clnt.h>
30 #include <linux/sunrpc/addr.h>
31 #include <linux/sunrpc/sched.h>
32 #include <linux/sunrpc/xprtsock.h>
33
34 #include <trace/events/sunrpc.h>
35
36 #include "netns.h"
37
38 #define RPCBIND_SOCK_PATHNAME "/var/run/rpcbind.sock"
39
40 #define RPCBIND_PROGRAM (100000u)
41 #define RPCBIND_PORT (111u)
42
43 #define RPCBVERS_2 (2u)
44 #define RPCBVERS_3 (3u)
45 #define RPCBVERS_4 (4u)
46
47 enum {
48 RPCBPROC_NULL,
49 RPCBPROC_SET,
50 RPCBPROC_UNSET,
51 RPCBPROC_GETPORT,
52 RPCBPROC_GETADDR = 3, /* alias for GETPORT */
53 RPCBPROC_DUMP,
54 RPCBPROC_CALLIT,
55 RPCBPROC_BCAST = 5, /* alias for CALLIT */
56 RPCBPROC_GETTIME,
57 RPCBPROC_UADDR2TADDR,
58 RPCBPROC_TADDR2UADDR,
59 RPCBPROC_GETVERSADDR,
60 RPCBPROC_INDIRECT,
61 RPCBPROC_GETADDRLIST,
62 RPCBPROC_GETSTAT,
63 };
64
65 /*
66 * r_owner
67 *
68 * The "owner" is allowed to unset a service in the rpcbind database.
69 *
70 * For AF_LOCAL SET/UNSET requests, rpcbind treats this string as a
71 * UID which it maps to a local user name via a password lookup.
72 * In all other cases it is ignored.
73 *
74 * For SET/UNSET requests, user space provides a value, even for
75 * network requests, and GETADDR uses an empty string. We follow
76 * those precedents here.
77 */
78 #define RPCB_OWNER_STRING "0"
79 #define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
80
81 /*
82 * XDR data type sizes
83 */
84 #define RPCB_program_sz (1)
85 #define RPCB_version_sz (1)
86 #define RPCB_protocol_sz (1)
87 #define RPCB_port_sz (1)
88 #define RPCB_boolean_sz (1)
89
90 #define RPCB_netid_sz (1 + XDR_QUADLEN(RPCBIND_MAXNETIDLEN))
91 #define RPCB_addr_sz (1 + XDR_QUADLEN(RPCBIND_MAXUADDRLEN))
92 #define RPCB_ownerstring_sz (1 + XDR_QUADLEN(RPCB_MAXOWNERLEN))
93
94 /*
95 * XDR argument and result sizes
96 */
97 #define RPCB_mappingargs_sz (RPCB_program_sz + RPCB_version_sz + \
98 RPCB_protocol_sz + RPCB_port_sz)
99 #define RPCB_getaddrargs_sz (RPCB_program_sz + RPCB_version_sz + \
100 RPCB_netid_sz + RPCB_addr_sz + \
101 RPCB_ownerstring_sz)
102
103 #define RPCB_getportres_sz RPCB_port_sz
104 #define RPCB_setres_sz RPCB_boolean_sz
105
106 /*
107 * Note that RFC 1833 does not put any size restrictions on the
108 * address string returned by the remote rpcbind database.
109 */
110 #define RPCB_getaddrres_sz RPCB_addr_sz
111
112 static void rpcb_getport_done(struct rpc_task *, void *);
113 static void rpcb_map_release(void *data);
114 static const struct rpc_program rpcb_program;
115
116 struct rpcbind_args {
117 struct rpc_xprt * r_xprt;
118
119 u32 r_prog;
120 u32 r_vers;
121 u32 r_prot;
122 unsigned short r_port;
123 const char * r_netid;
124 const char * r_addr;
125 const char * r_owner;
126
127 int r_status;
128 };
129
130 static const struct rpc_procinfo rpcb_procedures2[];
131 static const struct rpc_procinfo rpcb_procedures3[];
132 static const struct rpc_procinfo rpcb_procedures4[];
133
134 struct rpcb_info {
135 u32 rpc_vers;
136 const struct rpc_procinfo *rpc_proc;
137 };
138
139 static const struct rpcb_info rpcb_next_version[];
140 static const struct rpcb_info rpcb_next_version6[];
141
142 static const struct rpc_call_ops rpcb_getport_ops = {
143 .rpc_call_done = rpcb_getport_done,
144 .rpc_release = rpcb_map_release,
145 };
146
rpcb_wake_rpcbind_waiters(struct rpc_xprt *xprt, int status)147 static void rpcb_wake_rpcbind_waiters(struct rpc_xprt *xprt, int status)
148 {
149 xprt_clear_binding(xprt);
150 rpc_wake_up_status(&xprt->binding, status);
151 }
152
rpcb_map_release(void *data)153 static void rpcb_map_release(void *data)
154 {
155 struct rpcbind_args *map = data;
156
157 rpcb_wake_rpcbind_waiters(map->r_xprt, map->r_status);
158 xprt_put(map->r_xprt);
159 kfree(map->r_addr);
160 kfree(map);
161 }
162
rpcb_get_local(struct net *net)163 static int rpcb_get_local(struct net *net)
164 {
165 int cnt;
166 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
167
168 spin_lock(&sn->rpcb_clnt_lock);
169 if (sn->rpcb_users)
170 sn->rpcb_users++;
171 cnt = sn->rpcb_users;
172 spin_unlock(&sn->rpcb_clnt_lock);
173
174 return cnt;
175 }
176
rpcb_put_local(struct net *net)177 void rpcb_put_local(struct net *net)
178 {
179 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
180 struct rpc_clnt *clnt = sn->rpcb_local_clnt;
181 struct rpc_clnt *clnt4 = sn->rpcb_local_clnt4;
182 int shutdown = 0;
183
184 spin_lock(&sn->rpcb_clnt_lock);
185 if (sn->rpcb_users) {
186 if (--sn->rpcb_users == 0) {
187 sn->rpcb_local_clnt = NULL;
188 sn->rpcb_local_clnt4 = NULL;
189 }
190 shutdown = !sn->rpcb_users;
191 }
192 spin_unlock(&sn->rpcb_clnt_lock);
193
194 if (shutdown) {
195 /*
196 * cleanup_rpcb_clnt - remove xprtsock's sysctls, unregister
197 */
198 if (clnt4)
199 rpc_shutdown_client(clnt4);
200 if (clnt)
201 rpc_shutdown_client(clnt);
202 }
203 }
204
rpcb_set_local(struct net *net, struct rpc_clnt *clnt, struct rpc_clnt *clnt4, bool is_af_local)205 static void rpcb_set_local(struct net *net, struct rpc_clnt *clnt,
206 struct rpc_clnt *clnt4,
207 bool is_af_local)
208 {
209 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
210
211 /* Protected by rpcb_create_local_mutex */
212 sn->rpcb_local_clnt = clnt;
213 sn->rpcb_local_clnt4 = clnt4;
214 sn->rpcb_is_af_local = is_af_local ? 1 : 0;
215 smp_wmb();
216 sn->rpcb_users = 1;
217 }
218
219 /*
220 * Returns zero on success, otherwise a negative errno value
221 * is returned.
222 */
rpcb_create_local_unix(struct net *net)223 static int rpcb_create_local_unix(struct net *net)
224 {
225 static const struct sockaddr_un rpcb_localaddr_rpcbind = {
226 .sun_family = AF_LOCAL,
227 .sun_path = RPCBIND_SOCK_PATHNAME,
228 };
229 struct rpc_create_args args = {
230 .net = net,
231 .protocol = XPRT_TRANSPORT_LOCAL,
232 .address = (struct sockaddr *)&rpcb_localaddr_rpcbind,
233 .addrsize = sizeof(rpcb_localaddr_rpcbind),
234 .servername = "localhost",
235 .program = &rpcb_program,
236 .version = RPCBVERS_2,
237 .authflavor = RPC_AUTH_NULL,
238 .cred = current_cred(),
239 /*
240 * We turn off the idle timeout to prevent the kernel
241 * from automatically disconnecting the socket.
242 * Otherwise, we'd have to cache the mount namespace
243 * of the caller and somehow pass that to the socket
244 * reconnect code.
245 */
246 .flags = RPC_CLNT_CREATE_NO_IDLE_TIMEOUT,
247 };
248 struct rpc_clnt *clnt, *clnt4;
249 int result = 0;
250
251 /*
252 * Because we requested an RPC PING at transport creation time,
253 * this works only if the user space portmapper is rpcbind, and
254 * it's listening on AF_LOCAL on the named socket.
255 */
256 clnt = rpc_create(&args);
257 if (IS_ERR(clnt)) {
258 result = PTR_ERR(clnt);
259 goto out;
260 }
261
262 clnt4 = rpc_bind_new_program(clnt, &rpcb_program, RPCBVERS_4);
263 if (IS_ERR(clnt4))
264 clnt4 = NULL;
265
266 rpcb_set_local(net, clnt, clnt4, true);
267
268 out:
269 return result;
270 }
271
272 /*
273 * Returns zero on success, otherwise a negative errno value
274 * is returned.
275 */
rpcb_create_local_net(struct net *net)276 static int rpcb_create_local_net(struct net *net)
277 {
278 static const struct sockaddr_in rpcb_inaddr_loopback = {
279 .sin_family = AF_INET,
280 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
281 .sin_port = htons(RPCBIND_PORT),
282 };
283 struct rpc_create_args args = {
284 .net = net,
285 .protocol = XPRT_TRANSPORT_TCP,
286 .address = (struct sockaddr *)&rpcb_inaddr_loopback,
287 .addrsize = sizeof(rpcb_inaddr_loopback),
288 .servername = "localhost",
289 .program = &rpcb_program,
290 .version = RPCBVERS_2,
291 .authflavor = RPC_AUTH_UNIX,
292 .cred = current_cred(),
293 .flags = RPC_CLNT_CREATE_NOPING,
294 };
295 struct rpc_clnt *clnt, *clnt4;
296 int result = 0;
297
298 clnt = rpc_create(&args);
299 if (IS_ERR(clnt)) {
300 result = PTR_ERR(clnt);
301 goto out;
302 }
303
304 /*
305 * This results in an RPC ping. On systems running portmapper,
306 * the v4 ping will fail. Proceed anyway, but disallow rpcb
307 * v4 upcalls.
308 */
309 clnt4 = rpc_bind_new_program(clnt, &rpcb_program, RPCBVERS_4);
310 if (IS_ERR(clnt4))
311 clnt4 = NULL;
312
313 rpcb_set_local(net, clnt, clnt4, false);
314
315 out:
316 return result;
317 }
318
319 /*
320 * Returns zero on success, otherwise a negative errno value
321 * is returned.
322 */
rpcb_create_local(struct net *net)323 int rpcb_create_local(struct net *net)
324 {
325 static DEFINE_MUTEX(rpcb_create_local_mutex);
326 int result = 0;
327
328 if (rpcb_get_local(net))
329 return result;
330
331 mutex_lock(&rpcb_create_local_mutex);
332 if (rpcb_get_local(net))
333 goto out;
334
335 if (rpcb_create_local_unix(net) != 0)
336 result = rpcb_create_local_net(net);
337
338 out:
339 mutex_unlock(&rpcb_create_local_mutex);
340 return result;
341 }
342
rpcb_create(struct net *net, const char *nodename, const char *hostname, struct sockaddr *srvaddr, size_t salen, int proto, u32 version, const struct cred *cred)343 static struct rpc_clnt *rpcb_create(struct net *net, const char *nodename,
344 const char *hostname,
345 struct sockaddr *srvaddr, size_t salen,
346 int proto, u32 version,
347 const struct cred *cred)
348 {
349 struct rpc_create_args args = {
350 .net = net,
351 .protocol = proto,
352 .address = srvaddr,
353 .addrsize = salen,
354 .servername = hostname,
355 .nodename = nodename,
356 .program = &rpcb_program,
357 .version = version,
358 .authflavor = RPC_AUTH_UNIX,
359 .cred = cred,
360 .flags = (RPC_CLNT_CREATE_NOPING |
361 RPC_CLNT_CREATE_NONPRIVPORT),
362 };
363
364 switch (srvaddr->sa_family) {
365 case AF_INET:
366 ((struct sockaddr_in *)srvaddr)->sin_port = htons(RPCBIND_PORT);
367 break;
368 case AF_INET6:
369 ((struct sockaddr_in6 *)srvaddr)->sin6_port = htons(RPCBIND_PORT);
370 break;
371 default:
372 return ERR_PTR(-EAFNOSUPPORT);
373 }
374
375 return rpc_create(&args);
376 }
377
rpcb_register_call(struct sunrpc_net *sn, struct rpc_clnt *clnt, struct rpc_message *msg, bool is_set)378 static int rpcb_register_call(struct sunrpc_net *sn, struct rpc_clnt *clnt, struct rpc_message *msg, bool is_set)
379 {
380 int flags = RPC_TASK_NOCONNECT;
381 int error, result = 0;
382
383 if (is_set || !sn->rpcb_is_af_local)
384 flags = RPC_TASK_SOFTCONN;
385 msg->rpc_resp = &result;
386
387 error = rpc_call_sync(clnt, msg, flags);
388 if (error < 0)
389 return error;
390
391 if (!result)
392 return -EACCES;
393 return 0;
394 }
395
396 /**
397 * rpcb_register - set or unset a port registration with the local rpcbind svc
398 * @net: target network namespace
399 * @prog: RPC program number to bind
400 * @vers: RPC version number to bind
401 * @prot: transport protocol to register
402 * @port: port value to register
403 *
404 * Returns zero if the registration request was dispatched successfully
405 * and the rpcbind daemon returned success. Otherwise, returns an errno
406 * value that reflects the nature of the error (request could not be
407 * dispatched, timed out, or rpcbind returned an error).
408 *
409 * RPC services invoke this function to advertise their contact
410 * information via the system's rpcbind daemon. RPC services
411 * invoke this function once for each [program, version, transport]
412 * tuple they wish to advertise.
413 *
414 * Callers may also unregister RPC services that are no longer
415 * available by setting the passed-in port to zero. This removes
416 * all registered transports for [program, version] from the local
417 * rpcbind database.
418 *
419 * This function uses rpcbind protocol version 2 to contact the
420 * local rpcbind daemon.
421 *
422 * Registration works over both AF_INET and AF_INET6, and services
423 * registered via this function are advertised as available for any
424 * address. If the local rpcbind daemon is listening on AF_INET6,
425 * services registered via this function will be advertised on
426 * IN6ADDR_ANY (ie available for all AF_INET and AF_INET6
427 * addresses).
428 */
rpcb_register(struct net *net, u32 prog, u32 vers, int prot, unsigned short port)429 int rpcb_register(struct net *net, u32 prog, u32 vers, int prot, unsigned short port)
430 {
431 struct rpcbind_args map = {
432 .r_prog = prog,
433 .r_vers = vers,
434 .r_prot = prot,
435 .r_port = port,
436 };
437 struct rpc_message msg = {
438 .rpc_argp = &map,
439 };
440 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
441 bool is_set = false;
442
443 trace_pmap_register(prog, vers, prot, port);
444
445 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_UNSET];
446 if (port != 0) {
447 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_SET];
448 is_set = true;
449 }
450
451 return rpcb_register_call(sn, sn->rpcb_local_clnt, &msg, is_set);
452 }
453
454 /*
455 * Fill in AF_INET family-specific arguments to register
456 */
rpcb_register_inet4(struct sunrpc_net *sn, const struct sockaddr *sap, struct rpc_message *msg)457 static int rpcb_register_inet4(struct sunrpc_net *sn,
458 const struct sockaddr *sap,
459 struct rpc_message *msg)
460 {
461 const struct sockaddr_in *sin = (const struct sockaddr_in *)sap;
462 struct rpcbind_args *map = msg->rpc_argp;
463 unsigned short port = ntohs(sin->sin_port);
464 bool is_set = false;
465 int result;
466
467 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_KERNEL);
468
469 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
470 if (port != 0) {
471 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
472 is_set = true;
473 }
474
475 result = rpcb_register_call(sn, sn->rpcb_local_clnt4, msg, is_set);
476 kfree(map->r_addr);
477 return result;
478 }
479
480 /*
481 * Fill in AF_INET6 family-specific arguments to register
482 */
rpcb_register_inet6(struct sunrpc_net *sn, const struct sockaddr *sap, struct rpc_message *msg)483 static int rpcb_register_inet6(struct sunrpc_net *sn,
484 const struct sockaddr *sap,
485 struct rpc_message *msg)
486 {
487 const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sap;
488 struct rpcbind_args *map = msg->rpc_argp;
489 unsigned short port = ntohs(sin6->sin6_port);
490 bool is_set = false;
491 int result;
492
493 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_KERNEL);
494
495 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
496 if (port != 0) {
497 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
498 is_set = true;
499 }
500
501 result = rpcb_register_call(sn, sn->rpcb_local_clnt4, msg, is_set);
502 kfree(map->r_addr);
503 return result;
504 }
505
rpcb_unregister_all_protofamilies(struct sunrpc_net *sn, struct rpc_message *msg)506 static int rpcb_unregister_all_protofamilies(struct sunrpc_net *sn,
507 struct rpc_message *msg)
508 {
509 struct rpcbind_args *map = msg->rpc_argp;
510
511 trace_rpcb_unregister(map->r_prog, map->r_vers, map->r_netid);
512
513 map->r_addr = "";
514 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
515
516 return rpcb_register_call(sn, sn->rpcb_local_clnt4, msg, false);
517 }
518
519 /**
520 * rpcb_v4_register - set or unset a port registration with the local rpcbind
521 * @net: target network namespace
522 * @program: RPC program number of service to (un)register
523 * @version: RPC version number of service to (un)register
524 * @address: address family, IP address, and port to (un)register
525 * @netid: netid of transport protocol to (un)register
526 *
527 * Returns zero if the registration request was dispatched successfully
528 * and the rpcbind daemon returned success. Otherwise, returns an errno
529 * value that reflects the nature of the error (request could not be
530 * dispatched, timed out, or rpcbind returned an error).
531 *
532 * RPC services invoke this function to advertise their contact
533 * information via the system's rpcbind daemon. RPC services
534 * invoke this function once for each [program, version, address,
535 * netid] tuple they wish to advertise.
536 *
537 * Callers may also unregister RPC services that are registered at a
538 * specific address by setting the port number in @address to zero.
539 * They may unregister all registered protocol families at once for
540 * a service by passing a NULL @address argument. If @netid is ""
541 * then all netids for [program, version, address] are unregistered.
542 *
543 * This function uses rpcbind protocol version 4 to contact the
544 * local rpcbind daemon. The local rpcbind daemon must support
545 * version 4 of the rpcbind protocol in order for these functions
546 * to register a service successfully.
547 *
548 * Supported netids include "udp" and "tcp" for UDP and TCP over
549 * IPv4, and "udp6" and "tcp6" for UDP and TCP over IPv6,
550 * respectively.
551 *
552 * The contents of @address determine the address family and the
553 * port to be registered. The usual practice is to pass INADDR_ANY
554 * as the raw address, but specifying a non-zero address is also
555 * supported by this API if the caller wishes to advertise an RPC
556 * service on a specific network interface.
557 *
558 * Note that passing in INADDR_ANY does not create the same service
559 * registration as IN6ADDR_ANY. The former advertises an RPC
560 * service on any IPv4 address, but not on IPv6. The latter
561 * advertises the service on all IPv4 and IPv6 addresses.
562 */
rpcb_v4_register(struct net *net, const u32 program, const u32 version, const struct sockaddr *address, const char *netid)563 int rpcb_v4_register(struct net *net, const u32 program, const u32 version,
564 const struct sockaddr *address, const char *netid)
565 {
566 struct rpcbind_args map = {
567 .r_prog = program,
568 .r_vers = version,
569 .r_netid = netid,
570 .r_owner = RPCB_OWNER_STRING,
571 };
572 struct rpc_message msg = {
573 .rpc_argp = &map,
574 };
575 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
576
577 if (sn->rpcb_local_clnt4 == NULL)
578 return -EPROTONOSUPPORT;
579
580 if (address == NULL)
581 return rpcb_unregister_all_protofamilies(sn, &msg);
582
583 trace_rpcb_register(map.r_prog, map.r_vers, map.r_addr, map.r_netid);
584
585 switch (address->sa_family) {
586 case AF_INET:
587 return rpcb_register_inet4(sn, address, &msg);
588 case AF_INET6:
589 return rpcb_register_inet6(sn, address, &msg);
590 }
591
592 return -EAFNOSUPPORT;
593 }
594
rpcb_call_async(struct rpc_clnt *rpcb_clnt, struct rpcbind_args *map, const struct rpc_procinfo *proc)595 static struct rpc_task *rpcb_call_async(struct rpc_clnt *rpcb_clnt,
596 struct rpcbind_args *map, const struct rpc_procinfo *proc)
597 {
598 struct rpc_message msg = {
599 .rpc_proc = proc,
600 .rpc_argp = map,
601 .rpc_resp = map,
602 };
603 struct rpc_task_setup task_setup_data = {
604 .rpc_client = rpcb_clnt,
605 .rpc_message = &msg,
606 .callback_ops = &rpcb_getport_ops,
607 .callback_data = map,
608 .flags = RPC_TASK_ASYNC | RPC_TASK_SOFTCONN,
609 };
610
611 return rpc_run_task(&task_setup_data);
612 }
613
614 /*
615 * In the case where rpc clients have been cloned, we want to make
616 * sure that we use the program number/version etc of the actual
617 * owner of the xprt. To do so, we walk back up the tree of parents
618 * to find whoever created the transport and/or whoever has the
619 * autobind flag set.
620 */
rpcb_find_transport_owner(struct rpc_clnt *clnt)621 static struct rpc_clnt *rpcb_find_transport_owner(struct rpc_clnt *clnt)
622 {
623 struct rpc_clnt *parent = clnt->cl_parent;
624 struct rpc_xprt_switch *xps = rcu_access_pointer(clnt->cl_xpi.xpi_xpswitch);
625
626 while (parent != clnt) {
627 if (rcu_access_pointer(parent->cl_xpi.xpi_xpswitch) != xps)
628 break;
629 if (clnt->cl_autobind)
630 break;
631 clnt = parent;
632 parent = parent->cl_parent;
633 }
634 return clnt;
635 }
636
637 /**
638 * rpcb_getport_async - obtain the port for a given RPC service on a given host
639 * @task: task that is waiting for portmapper request
640 *
641 * This one can be called for an ongoing RPC request, and can be used in
642 * an async (rpciod) context.
643 */
rpcb_getport_async(struct rpc_task *task)644 void rpcb_getport_async(struct rpc_task *task)
645 {
646 struct rpc_clnt *clnt;
647 const struct rpc_procinfo *proc;
648 u32 bind_version;
649 struct rpc_xprt *xprt;
650 struct rpc_clnt *rpcb_clnt;
651 struct rpcbind_args *map;
652 struct rpc_task *child;
653 struct sockaddr_storage addr;
654 struct sockaddr *sap = (struct sockaddr *)&addr;
655 size_t salen;
656 int status;
657
658 rcu_read_lock();
659 clnt = rpcb_find_transport_owner(task->tk_client);
660 rcu_read_unlock();
661 xprt = xprt_get(task->tk_xprt);
662
663 /* Put self on the wait queue to ensure we get notified if
664 * some other task is already attempting to bind the port */
665 rpc_sleep_on_timeout(&xprt->binding, task,
666 NULL, jiffies + xprt->bind_timeout);
667
668 if (xprt_test_and_set_binding(xprt)) {
669 xprt_put(xprt);
670 return;
671 }
672
673 /* Someone else may have bound if we slept */
674 if (xprt_bound(xprt)) {
675 status = 0;
676 goto bailout_nofree;
677 }
678
679 /* Parent transport's destination address */
680 salen = rpc_peeraddr(clnt, sap, sizeof(addr));
681
682 /* Don't ever use rpcbind v2 for AF_INET6 requests */
683 switch (sap->sa_family) {
684 case AF_INET:
685 proc = rpcb_next_version[xprt->bind_index].rpc_proc;
686 bind_version = rpcb_next_version[xprt->bind_index].rpc_vers;
687 break;
688 case AF_INET6:
689 proc = rpcb_next_version6[xprt->bind_index].rpc_proc;
690 bind_version = rpcb_next_version6[xprt->bind_index].rpc_vers;
691 break;
692 default:
693 status = -EAFNOSUPPORT;
694 goto bailout_nofree;
695 }
696 if (proc == NULL) {
697 xprt->bind_index = 0;
698 status = -EPFNOSUPPORT;
699 goto bailout_nofree;
700 }
701
702 trace_rpcb_getport(clnt, task, bind_version);
703
704 rpcb_clnt = rpcb_create(xprt->xprt_net,
705 clnt->cl_nodename,
706 xprt->servername, sap, salen,
707 xprt->prot, bind_version,
708 clnt->cl_cred);
709 if (IS_ERR(rpcb_clnt)) {
710 status = PTR_ERR(rpcb_clnt);
711 goto bailout_nofree;
712 }
713
714 map = kzalloc(sizeof(struct rpcbind_args), GFP_NOFS);
715 if (!map) {
716 status = -ENOMEM;
717 goto bailout_release_client;
718 }
719 map->r_prog = clnt->cl_prog;
720 map->r_vers = clnt->cl_vers;
721 map->r_prot = xprt->prot;
722 map->r_port = 0;
723 map->r_xprt = xprt;
724 map->r_status = -EIO;
725
726 switch (bind_version) {
727 case RPCBVERS_4:
728 case RPCBVERS_3:
729 map->r_netid = xprt->address_strings[RPC_DISPLAY_NETID];
730 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_NOFS);
731 if (!map->r_addr) {
732 status = -ENOMEM;
733 goto bailout_free_args;
734 }
735 map->r_owner = "";
736 break;
737 case RPCBVERS_2:
738 map->r_addr = NULL;
739 break;
740 default:
741 BUG();
742 }
743
744 child = rpcb_call_async(rpcb_clnt, map, proc);
745 rpc_release_client(rpcb_clnt);
746 if (IS_ERR(child)) {
747 /* rpcb_map_release() has freed the arguments */
748 return;
749 }
750
751 xprt->stat.bind_count++;
752 rpc_put_task(child);
753 return;
754
755 bailout_free_args:
756 kfree(map);
757 bailout_release_client:
758 rpc_release_client(rpcb_clnt);
759 bailout_nofree:
760 rpcb_wake_rpcbind_waiters(xprt, status);
761 task->tk_status = status;
762 xprt_put(xprt);
763 }
764 EXPORT_SYMBOL_GPL(rpcb_getport_async);
765
766 /*
767 * Rpcbind child task calls this callback via tk_exit.
768 */
rpcb_getport_done(struct rpc_task *child, void *data)769 static void rpcb_getport_done(struct rpc_task *child, void *data)
770 {
771 struct rpcbind_args *map = data;
772 struct rpc_xprt *xprt = map->r_xprt;
773
774 map->r_status = child->tk_status;
775
776 /* Garbage reply: retry with a lesser rpcbind version */
777 if (map->r_status == -EIO)
778 map->r_status = -EPROTONOSUPPORT;
779
780 /* rpcbind server doesn't support this rpcbind protocol version */
781 if (map->r_status == -EPROTONOSUPPORT)
782 xprt->bind_index++;
783
784 if (map->r_status < 0) {
785 /* rpcbind server not available on remote host? */
786 map->r_port = 0;
787
788 } else if (map->r_port == 0) {
789 /* Requested RPC service wasn't registered on remote host */
790 map->r_status = -EACCES;
791 } else {
792 /* Succeeded */
793 map->r_status = 0;
794 }
795
796 trace_rpcb_setport(child, map->r_status, map->r_port);
797 xprt->ops->set_port(xprt, map->r_port);
798 if (map->r_port)
799 xprt_set_bound(xprt);
800 }
801
802 /*
803 * XDR functions for rpcbind
804 */
805
rpcb_enc_mapping(struct rpc_rqst *req, struct xdr_stream *xdr, const void *data)806 static void rpcb_enc_mapping(struct rpc_rqst *req, struct xdr_stream *xdr,
807 const void *data)
808 {
809 const struct rpcbind_args *rpcb = data;
810 __be32 *p;
811
812 p = xdr_reserve_space(xdr, RPCB_mappingargs_sz << 2);
813 *p++ = cpu_to_be32(rpcb->r_prog);
814 *p++ = cpu_to_be32(rpcb->r_vers);
815 *p++ = cpu_to_be32(rpcb->r_prot);
816 *p = cpu_to_be32(rpcb->r_port);
817 }
818
rpcb_dec_getport(struct rpc_rqst *req, struct xdr_stream *xdr, void *data)819 static int rpcb_dec_getport(struct rpc_rqst *req, struct xdr_stream *xdr,
820 void *data)
821 {
822 struct rpcbind_args *rpcb = data;
823 unsigned long port;
824 __be32 *p;
825
826 rpcb->r_port = 0;
827
828 p = xdr_inline_decode(xdr, 4);
829 if (unlikely(p == NULL))
830 return -EIO;
831
832 port = be32_to_cpup(p);
833 if (unlikely(port > USHRT_MAX))
834 return -EIO;
835
836 rpcb->r_port = port;
837 return 0;
838 }
839
rpcb_dec_set(struct rpc_rqst *req, struct xdr_stream *xdr, void *data)840 static int rpcb_dec_set(struct rpc_rqst *req, struct xdr_stream *xdr,
841 void *data)
842 {
843 unsigned int *boolp = data;
844 __be32 *p;
845
846 p = xdr_inline_decode(xdr, 4);
847 if (unlikely(p == NULL))
848 return -EIO;
849
850 *boolp = 0;
851 if (*p != xdr_zero)
852 *boolp = 1;
853 return 0;
854 }
855
encode_rpcb_string(struct xdr_stream *xdr, const char *string, const u32 maxstrlen)856 static void encode_rpcb_string(struct xdr_stream *xdr, const char *string,
857 const u32 maxstrlen)
858 {
859 __be32 *p;
860 u32 len;
861
862 len = strlen(string);
863 WARN_ON_ONCE(len > maxstrlen);
864 if (len > maxstrlen)
865 /* truncate and hope for the best */
866 len = maxstrlen;
867 p = xdr_reserve_space(xdr, 4 + len);
868 xdr_encode_opaque(p, string, len);
869 }
870
rpcb_enc_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr, const void *data)871 static void rpcb_enc_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr,
872 const void *data)
873 {
874 const struct rpcbind_args *rpcb = data;
875 __be32 *p;
876
877 p = xdr_reserve_space(xdr, (RPCB_program_sz + RPCB_version_sz) << 2);
878 *p++ = cpu_to_be32(rpcb->r_prog);
879 *p = cpu_to_be32(rpcb->r_vers);
880
881 encode_rpcb_string(xdr, rpcb->r_netid, RPCBIND_MAXNETIDLEN);
882 encode_rpcb_string(xdr, rpcb->r_addr, RPCBIND_MAXUADDRLEN);
883 encode_rpcb_string(xdr, rpcb->r_owner, RPCB_MAXOWNERLEN);
884 }
885
rpcb_dec_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr, void *data)886 static int rpcb_dec_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr,
887 void *data)
888 {
889 struct rpcbind_args *rpcb = data;
890 struct sockaddr_storage address;
891 struct sockaddr *sap = (struct sockaddr *)&address;
892 __be32 *p;
893 u32 len;
894
895 rpcb->r_port = 0;
896
897 p = xdr_inline_decode(xdr, 4);
898 if (unlikely(p == NULL))
899 goto out_fail;
900 len = be32_to_cpup(p);
901
902 /*
903 * If the returned universal address is a null string,
904 * the requested RPC service was not registered.
905 */
906 if (len == 0)
907 return 0;
908
909 if (unlikely(len > RPCBIND_MAXUADDRLEN))
910 goto out_fail;
911
912 p = xdr_inline_decode(xdr, len);
913 if (unlikely(p == NULL))
914 goto out_fail;
915
916 if (rpc_uaddr2sockaddr(req->rq_xprt->xprt_net, (char *)p, len,
917 sap, sizeof(address)) == 0)
918 goto out_fail;
919 rpcb->r_port = rpc_get_port(sap);
920
921 return 0;
922
923 out_fail:
924 return -EIO;
925 }
926
927 /*
928 * Not all rpcbind procedures described in RFC 1833 are implemented
929 * since the Linux kernel RPC code requires only these.
930 */
931
932 static const struct rpc_procinfo rpcb_procedures2[] = {
933 [RPCBPROC_SET] = {
934 .p_proc = RPCBPROC_SET,
935 .p_encode = rpcb_enc_mapping,
936 .p_decode = rpcb_dec_set,
937 .p_arglen = RPCB_mappingargs_sz,
938 .p_replen = RPCB_setres_sz,
939 .p_statidx = RPCBPROC_SET,
940 .p_timer = 0,
941 .p_name = "SET",
942 },
943 [RPCBPROC_UNSET] = {
944 .p_proc = RPCBPROC_UNSET,
945 .p_encode = rpcb_enc_mapping,
946 .p_decode = rpcb_dec_set,
947 .p_arglen = RPCB_mappingargs_sz,
948 .p_replen = RPCB_setres_sz,
949 .p_statidx = RPCBPROC_UNSET,
950 .p_timer = 0,
951 .p_name = "UNSET",
952 },
953 [RPCBPROC_GETPORT] = {
954 .p_proc = RPCBPROC_GETPORT,
955 .p_encode = rpcb_enc_mapping,
956 .p_decode = rpcb_dec_getport,
957 .p_arglen = RPCB_mappingargs_sz,
958 .p_replen = RPCB_getportres_sz,
959 .p_statidx = RPCBPROC_GETPORT,
960 .p_timer = 0,
961 .p_name = "GETPORT",
962 },
963 };
964
965 static const struct rpc_procinfo rpcb_procedures3[] = {
966 [RPCBPROC_SET] = {
967 .p_proc = RPCBPROC_SET,
968 .p_encode = rpcb_enc_getaddr,
969 .p_decode = rpcb_dec_set,
970 .p_arglen = RPCB_getaddrargs_sz,
971 .p_replen = RPCB_setres_sz,
972 .p_statidx = RPCBPROC_SET,
973 .p_timer = 0,
974 .p_name = "SET",
975 },
976 [RPCBPROC_UNSET] = {
977 .p_proc = RPCBPROC_UNSET,
978 .p_encode = rpcb_enc_getaddr,
979 .p_decode = rpcb_dec_set,
980 .p_arglen = RPCB_getaddrargs_sz,
981 .p_replen = RPCB_setres_sz,
982 .p_statidx = RPCBPROC_UNSET,
983 .p_timer = 0,
984 .p_name = "UNSET",
985 },
986 [RPCBPROC_GETADDR] = {
987 .p_proc = RPCBPROC_GETADDR,
988 .p_encode = rpcb_enc_getaddr,
989 .p_decode = rpcb_dec_getaddr,
990 .p_arglen = RPCB_getaddrargs_sz,
991 .p_replen = RPCB_getaddrres_sz,
992 .p_statidx = RPCBPROC_GETADDR,
993 .p_timer = 0,
994 .p_name = "GETADDR",
995 },
996 };
997
998 static const struct rpc_procinfo rpcb_procedures4[] = {
999 [RPCBPROC_SET] = {
1000 .p_proc = RPCBPROC_SET,
1001 .p_encode = rpcb_enc_getaddr,
1002 .p_decode = rpcb_dec_set,
1003 .p_arglen = RPCB_getaddrargs_sz,
1004 .p_replen = RPCB_setres_sz,
1005 .p_statidx = RPCBPROC_SET,
1006 .p_timer = 0,
1007 .p_name = "SET",
1008 },
1009 [RPCBPROC_UNSET] = {
1010 .p_proc = RPCBPROC_UNSET,
1011 .p_encode = rpcb_enc_getaddr,
1012 .p_decode = rpcb_dec_set,
1013 .p_arglen = RPCB_getaddrargs_sz,
1014 .p_replen = RPCB_setres_sz,
1015 .p_statidx = RPCBPROC_UNSET,
1016 .p_timer = 0,
1017 .p_name = "UNSET",
1018 },
1019 [RPCBPROC_GETADDR] = {
1020 .p_proc = RPCBPROC_GETADDR,
1021 .p_encode = rpcb_enc_getaddr,
1022 .p_decode = rpcb_dec_getaddr,
1023 .p_arglen = RPCB_getaddrargs_sz,
1024 .p_replen = RPCB_getaddrres_sz,
1025 .p_statidx = RPCBPROC_GETADDR,
1026 .p_timer = 0,
1027 .p_name = "GETADDR",
1028 },
1029 };
1030
1031 static const struct rpcb_info rpcb_next_version[] = {
1032 {
1033 .rpc_vers = RPCBVERS_2,
1034 .rpc_proc = &rpcb_procedures2[RPCBPROC_GETPORT],
1035 },
1036 {
1037 .rpc_proc = NULL,
1038 },
1039 };
1040
1041 static const struct rpcb_info rpcb_next_version6[] = {
1042 {
1043 .rpc_vers = RPCBVERS_4,
1044 .rpc_proc = &rpcb_procedures4[RPCBPROC_GETADDR],
1045 },
1046 {
1047 .rpc_vers = RPCBVERS_3,
1048 .rpc_proc = &rpcb_procedures3[RPCBPROC_GETADDR],
1049 },
1050 {
1051 .rpc_proc = NULL,
1052 },
1053 };
1054
1055 static unsigned int rpcb_version2_counts[ARRAY_SIZE(rpcb_procedures2)];
1056 static const struct rpc_version rpcb_version2 = {
1057 .number = RPCBVERS_2,
1058 .nrprocs = ARRAY_SIZE(rpcb_procedures2),
1059 .procs = rpcb_procedures2,
1060 .counts = rpcb_version2_counts,
1061 };
1062
1063 static unsigned int rpcb_version3_counts[ARRAY_SIZE(rpcb_procedures3)];
1064 static const struct rpc_version rpcb_version3 = {
1065 .number = RPCBVERS_3,
1066 .nrprocs = ARRAY_SIZE(rpcb_procedures3),
1067 .procs = rpcb_procedures3,
1068 .counts = rpcb_version3_counts,
1069 };
1070
1071 static unsigned int rpcb_version4_counts[ARRAY_SIZE(rpcb_procedures4)];
1072 static const struct rpc_version rpcb_version4 = {
1073 .number = RPCBVERS_4,
1074 .nrprocs = ARRAY_SIZE(rpcb_procedures4),
1075 .procs = rpcb_procedures4,
1076 .counts = rpcb_version4_counts,
1077 };
1078
1079 static const struct rpc_version *rpcb_version[] = {
1080 NULL,
1081 NULL,
1082 &rpcb_version2,
1083 &rpcb_version3,
1084 &rpcb_version4
1085 };
1086
1087 static struct rpc_stat rpcb_stats;
1088
1089 static const struct rpc_program rpcb_program = {
1090 .name = "rpcbind",
1091 .number = RPCBIND_PROGRAM,
1092 .nrvers = ARRAY_SIZE(rpcb_version),
1093 .version = rpcb_version,
1094 .stats = &rpcb_stats,
1095 };
1096