support/nfs/getport.c

   1 /*
   2  * Provide a variety of APIs that query an rpcbind daemon to
   3  * discover RPC service ports and allowed protocol version
   4  * numbers.
   5  *
   6  * Copyright (C) 2008 Oracle Corporation.  All rights reserved.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public
  19  * License along with this program; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 021110-1307, USA.
  22  *
  23  */
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include <config.h>
  27 #endif
  28
  29 #include <sys/types.h>
  30 #include <sys/time.h>
  31 #include <unistd.h>
  32 #include <fcntl.h>
  33 #include <errno.h>
  34
  35 #include <sys/socket.h>
  36 #include <netinet/in.h>
  37 #include <netdb.h>
  38 #include <arpa/inet.h>
  39
  40 #include <rpc/rpc.h>
  41 #include <rpc/pmap_prot.h>
  42
  43 #ifdef HAVE_LIBTIRPC
  44 #include <netconfig.h>
  45 #include <rpc/rpcb_prot.h>
  46 #endif
  47
  48 #include "nfsrpc.h"
  49
  50 /*
  51  * Try a local socket first to access the local rpcbind daemon
  52  *
  53  * Rpcbind's local socket service does not seem to be working.
  54  * Disable this logic for now.
  55  */
  56 #ifdef HAVE_LIBTIRPC
  57 #undef NFS_GP_LOCAL
  58 #else   /* !HAVE_LIBTIRPC */
  59 #undef NFS_GP_LOCAL
  60 #endif  /* !HAVE_LIBTIRPC */
  61
  62 #ifdef HAVE_LIBTIRPC
  63 static const rpcvers_t default_rpcb_version = RPCBVERS_4;
  64 #else   /* !HAVE_LIBTIRPC */
  65 static const rpcvers_t default_rpcb_version = PMAPVERS;
  66 #endif  /* !HAVE_LIBTIRPC */
  67
  68 /*
  69  * Historical: Map TCP connect timeouts to timeout
  70  * error code used by UDP.
  71  */
  72 static void
  73 nfs_gp_map_tcp_errorcodes(const unsigned short protocol)
  74 {
  75         if (protocol != IPPROTO_TCP)
  76                 return;
  77
  78         switch (rpc_createerr.cf_error.re_errno) {
  79         case ETIMEDOUT:
  80                 rpc_createerr.cf_stat = RPC_TIMEDOUT;
  81                 break;
  82         case ECONNREFUSED:
  83                 rpc_createerr.cf_stat = RPC_CANTRECV;
  84                 break;
  85         }
  86 }
  87
  88 /*
  89  * There's no easy way to tell how the local system's networking
  90  * and rpcbind is configured (ie. whether we want to use IPv6 or
  91  * IPv4 loopback to contact RPC services on the local host).  We
  92  * punt and simply try to look up "localhost".
  93  *
  94  * Returns TRUE on success.
  95  */
  96 static int nfs_gp_loopback_address(struct sockaddr *sap, socklen_t *salen)
  97 {
  98         struct addrinfo *gai_results;
  99         int ret = 0;
 100
 101         if (getaddrinfo("localhost", NULL, NULL, &gai_results))
 102                 return 0;
 103
 104         if (*salen >= gai_results->ai_addrlen) {
 105                 memcpy(sap, gai_results->ai_addr,
 106                                 gai_results->ai_addrlen);
 107                 *salen = gai_results->ai_addrlen;
 108                 ret = 1;
 109         }
 110
 111         freeaddrinfo(gai_results);
 112         return ret;
 113 }
 114
 115 /*
 116  * Look up a network service in /etc/services and return the
 117  * network-order port number of that service.
 118  */
 119 static in_port_t nfs_gp_getservbyname(const char *service,
 120                                       const unsigned short protocol)
 121 {
 122         const struct addrinfo gai_hint = {
 123                 .ai_family      = AF_INET,
 124                 .ai_protocol    = protocol,
 125                 .ai_flags       = AI_PASSIVE,
 126         };
 127         struct addrinfo *gai_results;
 128         const struct sockaddr_in *sin;
 129         in_port_t port;
 130
 131         if (getaddrinfo(NULL, service, &gai_hint, &gai_results) != 0)
 132                 return 0;
 133
 134         sin = (const struct sockaddr_in *)gai_results->ai_addr;
 135         port = sin->sin_port;
 136
 137         freeaddrinfo(gai_results);
 138         return port;
 139 }
 140
 141 /*
 142  * Discover the port number that should be used to contact an
 143  * rpcbind service.  This will detect if the port has a local
 144  * value that may have been set in /etc/services.
 145  *
 146  * Returns network byte-order port number of rpcbind service
 147  * on this system.
 148  */
 149 static in_port_t nfs_gp_get_rpcb_port(const unsigned short protocol)
 150 {
 151         static const char *rpcb_netnametbl[] = {
 152                 "rpcbind",
 153                 "portmapper",
 154                 "sunrpc",
 155                 NULL,
 156         };
 157         unsigned int i;
 158
 159         for (i = 0; rpcb_netnametbl[i] != NULL; i++) {
 160                 in_port_t port;
 161
 162                 port = nfs_gp_getservbyname(rpcb_netnametbl[i], protocol);
 163                 if (port != 0)
 164                         return port;
 165         }
 166
 167         return (in_port_t)htons((uint16_t)PMAPPORT);
 168 }
 169
 170 /*
 171  * Set up an RPC client for communicating with an rpcbind daemon at
 172  * @sap over @transport with protocol version @version.
 173  *
 174  * Returns a pointer to a prepared RPC client if successful, and
 175  * @timeout is initialized; caller must destroy a non-NULL returned RPC
 176  * client.  Otherwise returns NULL, and rpc_createerr.cf_stat is set to
 177  * reflect the error.
 178  */
 179 static CLIENT *nfs_gp_get_rpcbclient(struct sockaddr *sap,
 180                                      const socklen_t salen,
 181                                      const unsigned short transport,
 182                                      const rpcvers_t version,
 183                                      struct timeval *timeout)
 184 {
 185         static const char *rpcb_pgmtbl[] = {
 186                 "rpcbind",
 187                 "portmap",
 188                 "portmapper",
 189                 "sunrpc",
 190                 NULL,
 191         };
 192         rpcprog_t rpcb_prog = nfs_getrpcbyname(RPCBPROG, rpcb_pgmtbl);
 193         CLIENT *clnt;
 194
 195         nfs_set_port(sap, ntohs(nfs_gp_get_rpcb_port(transport)));
 196         clnt = nfs_get_rpcclient(sap, salen, transport, rpcb_prog,
 197                                                         version, timeout);
 198         nfs_gp_map_tcp_errorcodes(transport);
 199         return clnt;
 200 }
 201
 202 /*
 203  * One of the arguments passed when querying remote rpcbind services
 204  * via rpcbind v3 or v4 is a netid string.  This replaces the pm_prot
 205  * field used in legacy PMAP_GETPORT calls.
 206  *
 207  * RFC 1833 says netids are not standard but rather defined on the local
 208  * host.  There are, however, standard definitions for nc_protofmly and
 209  * nc_proto that can be used to derive a netid string on the local host,
 210  * based on the contents of /etc/netconfig.
 211  *
 212  * Walk through the local netconfig database and grab the netid of the
 213  * first entry that matches @family and @protocol and whose netid string
 214  * fits in the provided buffer.
 215  *
 216  * Returns a '\0'-terminated string if successful; otherwise NULL.
 217  * rpc_createerr.cf_stat is set to reflect the error.
 218  */
 219 #ifdef HAVE_LIBTIRPC
 220
 221 static char *nfs_gp_get_netid(const sa_family_t family,
 222                               const unsigned short protocol)
 223 {
 224         char *nc_protofmly, *nc_proto, *nc_netid;
 225         struct netconfig *nconf;
 226         struct protoent *proto;
 227         void *handle;
 228
 229         switch (family) {
 230         case AF_LOCAL:
 231         case AF_INET:
 232                 nc_protofmly = NC_INET;
 233                 break;
 234         case AF_INET6:
 235                 nc_protofmly = NC_INET6;
 236                 break;
 237         default:
 238                 goto out;
 239         }
 240
 241         proto = getprotobynumber(protocol);
 242         if (proto == NULL)
 243                 goto out;
 244         nc_proto = proto->p_name;
 245
 246         handle = setnetconfig();
 247         while ((nconf = getnetconfig(handle)) != NULL) {
 248
 249                 if (nconf->nc_protofmly != NULL &&
 250                     strcmp(nconf->nc_protofmly, nc_protofmly) != 0)
 251                         continue;
 252                 if (nconf->nc_proto != NULL &&
 253                     strcmp(nconf->nc_proto, nc_proto) != 0)
 254                         continue;
 255
 256                 nc_netid = strdup(nconf->nc_netid);
 257                 endnetconfig(handle);
 258                 return nc_netid;
 259         }
 260         endnetconfig(handle);
 261
 262 out:
 263         rpc_createerr.cf_stat = RPC_UNKNOWNPROTO;
 264         return NULL;
 265 }
 266
 267 #endif  /* HAVE_LIBTIRPC */
 268
 269 /*
 270  * Extract a port number from a universal address, and terminate the
 271  * string in @addrstr just after the address part.
 272  *
 273  * Returns -1 if unsuccesful; otherwise a decoded port number (possibly 0)
 274  * is returned.
 275  */
 276 static int nfs_gp_universal_porthelper(char *addrstr)
 277 {
 278         char *p, *endptr;
 279         unsigned long portlo, porthi;
 280         int port = -1;
 281
 282         p = strrchr(addrstr, '.');
 283         if (p == NULL)
 284                 goto out;
 285         portlo = strtoul(p + 1, &endptr, 10);
 286         if (*endptr != '\0' || portlo > 255)
 287                 goto out;
 288         *p = '\0';
 289
 290         p = strrchr(addrstr, '.');
 291         if (p == NULL)
 292                 goto out;
 293         porthi = strtoul(p + 1, &endptr, 10);
 294         if (*endptr != '\0' || porthi > 255)
 295                 goto out;
 296         *p = '\0';
 297         port = (porthi << 8) | portlo;
 298
 299 out:
 300         return port;
 301 }
 302
 303 /**
 304  * nfs_universal2port - extract port number from a "universal address"
 305  * @uaddr: '\0'-terminated C string containing a universal address
 306  *
 307  * Universal addresses (defined in RFC 1833) are used when calling an
 308  * rpcbind daemon via protocol versions 3 or 4..
 309  *
 310  * Returns -1 if unsuccesful; otherwise a decoded port number (possibly 0)
 311  * is returned.
 312  */
 313 int nfs_universal2port(const char *uaddr)
 314 {
 315         char *addrstr;
 316         int port = -1;
 317
 318         addrstr = strdup(uaddr);
 319         if (addrstr != NULL) {
 320                 port = nfs_gp_universal_porthelper(addrstr);
 321                 free(addrstr);
 322         }
 323         return port;
 324 }
 325
 326 /**
 327  * nfs_sockaddr2universal - convert a sockaddr to a "universal address"
 328  * @sap: pointer to a socket address
 329  *
 330  * Universal addresses (defined in RFC 1833) are used when calling an
 331  * rpcbind daemon via protocol versions 3 or 4..
 332  *
 333  * Returns a '\0'-terminated string if successful; caller must free
 334  * the returned string.  Otherwise NULL is returned and
 335  * rpc_createerr.cf_stat is set to reflect the error.
 336  *
 337  * inet_ntop(3) is used here, since getnameinfo(3) is not available
 338  * in some earlier glibc releases, and we don't require support for
 339  * scope IDs for universal addresses.
 340  */
 341 char *nfs_sockaddr2universal(const struct sockaddr *sap)
 342 {
 343         const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sap;
 344         const struct sockaddr_un *sun = (const struct sockaddr_un *)sap;
 345         const struct sockaddr_in *sin = (const struct sockaddr_in *)sap;
 346         char buf[INET6_ADDRSTRLEN + 8 /* for port information */];
 347         uint16_t port;
 348         size_t count;
 349         char *result;
 350         int len;
 351
 352         switch (sap->sa_family) {
 353         case AF_LOCAL:
 354                 return strndup(sun->sun_path, sizeof(sun->sun_path));
 355         case AF_INET:
 356                 if (inet_ntop(AF_INET, (const void *)&sin->sin_addr.s_addr,
 357                                         buf, (socklen_t)sizeof(buf)) == NULL)
 358                         goto out_err;
 359                 port = ntohs(sin->sin_port);
 360                 break;
 361         case AF_INET6:
 362                 if (inet_ntop(AF_INET6, (const void *)&sin6->sin6_addr,
 363                                         buf, (socklen_t)sizeof(buf)) == NULL)
 364                         goto out_err;
 365                 port = ntohs(sin6->sin6_port);
 366                 break;
 367         default:
 368                 goto out_err;
 369         }
 370
 371         count = sizeof(buf) - strlen(buf);
 372         len = snprintf(buf + strlen(buf), count, ".%u.%u",
 373                         (unsigned)(port >> 8), (unsigned)(port & 0xff));
 374         /* before glibc 2.0.6, snprintf(3) could return -1 */
 375         if (len < 0 || (size_t)len > count)
 376                 goto out_err;
 377
 378         result = strdup(buf);
 379         if (result != NULL)
 380                 return result;
 381
 382 out_err:
 383         rpc_createerr.cf_stat = RPC_N2AXLATEFAILURE;
 384         return NULL;
 385 }
 386
 387 /*
 388  * Send a NULL request to the indicated RPC service.
 389  *
 390  * Returns 1 if the service responded; otherwise 0;
 391  */
 392 static int nfs_gp_ping(CLIENT *client, struct timeval timeout)
 393 {
 394         enum clnt_stat status;
 395
 396         status = CLNT_CALL(client, NULLPROC,
 397                            (xdrproc_t)xdr_void, NULL,
 398                            (xdrproc_t)xdr_void, NULL,
 399                            timeout);
 400
 401         return (int)(status == RPC_SUCCESS);
 402 }
 403
 404 #ifdef HAVE_LIBTIRPC
 405
 406 /*
 407  * Initialize the rpcb argument for a GETADDR request.
 408  *
 409  * Returns 1 if successful, and caller must free strings pointed
 410  * to by r_netid and r_addr; otherwise 0.
 411  */
 412 static int nfs_gp_init_rpcb_parms(const struct sockaddr *sap,
 413                                   const rpcprog_t program,
 414                                   const rpcvers_t version,
 415                                   const unsigned short protocol,
 416                                   struct rpcb *parms)
 417 {
 418         char *netid, *addr;
 419
 420         netid = nfs_gp_get_netid(sap->sa_family, protocol);
 421         if (netid == NULL)
 422                 return 0;
 423
 424         addr = nfs_sockaddr2universal(sap);
 425         if (addr == NULL) {
 426                 free(netid);
 427                 return 0;
 428         }
 429
 430         memset(parms, 0, sizeof(*parms));
 431         parms->r_prog   = program;
 432         parms->r_vers   = version;
 433         parms->r_netid  = netid;
 434         parms->r_addr   = addr;
 435         parms->r_owner  = "";
 436
 437         return 1;
 438 }
 439
 440 static void nfs_gp_free_rpcb_parms(struct rpcb *parms)
 441 {
 442         free(parms->r_netid);
 443         free(parms->r_addr);
 444 }
 445
 446 /*
 447  * Try rpcbind GETADDR via version 4.  If that fails, try same
 448  * request via version 3.
 449  *
 450  * Returns non-zero port number on success; otherwise returns
 451  * zero.  rpccreateerr is set to reflect the nature of the error.
 452  */
 453 static unsigned short nfs_gp_rpcb_getaddr(CLIENT *client,
 454                                           struct rpcb *parms,
 455                                           struct timeval timeout)
 456 {
 457         rpcvers_t rpcb_version;
 458         struct rpc_err rpcerr;
 459         int port = 0;
 460
 461         for (rpcb_version = RPCBVERS_4;
 462              rpcb_version >= RPCBVERS_3;
 463              rpcb_version--) {
 464                 enum clnt_stat status;
 465                 char *uaddr = NULL;
 466
 467                 CLNT_CONTROL(client, CLSET_VERS, (void *)&rpcb_version);
 468                 status = CLNT_CALL(client, (rpcproc_t)RPCBPROC_GETADDR,
 469                                    (xdrproc_t)xdr_rpcb, (void *)parms,
 470                                    (xdrproc_t)xdr_wrapstring, (void *)&uaddr,
 471                                    timeout);
 472
 473                 switch (status) {
 474                 case RPC_SUCCESS:
 475                         if ((uaddr == NULL) || (uaddr[0] == '\0')) {
 476                                 rpc_createerr.cf_stat = RPC_PROGNOTREGISTERED;
 477                                 return 0;
 478                         }
 479
 480                         port = nfs_universal2port(uaddr);
 481                         xdr_free((xdrproc_t)xdr_wrapstring, (char *)&uaddr);
 482                         if (port == -1) {
 483                                 rpc_createerr.cf_stat = RPC_N2AXLATEFAILURE;
 484                                 return 0;
 485                         }
 486                         return (unsigned short)port;
 487                 case RPC_PROGVERSMISMATCH:
 488                         clnt_geterr(client, &rpcerr);
 489                         if (rpcerr.re_vers.low > RPCBVERS4)
 490                                 return 0;
 491                         continue;
 492                 case RPC_PROCUNAVAIL:
 493                 case RPC_PROGUNAVAIL:
 494                         continue;
 495                 default:
 496                         /* Most likely RPC_TIMEDOUT or RPC_CANTRECV */
 497                         rpc_createerr.cf_stat = status;
 498                         clnt_geterr(client, &rpc_createerr.cf_error);
 499                         return 0;
 500                 }
 501
 502         }
 503
 504         if (port == 0) {
 505                 rpc_createerr.cf_stat = RPC_PROGNOTREGISTERED;
 506                 clnt_geterr(client, &rpc_createerr.cf_error);
 507         }
 508         return port;
 509 }
 510
 511 #endif  /* HAVE_LIBTIRPC */
 512
 513 /*
 514  * Try GETPORT request via rpcbind version 2.
 515  *
 516  * Returns non-zero port number on success; otherwise returns
 517  * zero.  rpccreateerr is set to reflect the nature of the error.
 518  */
 519 static unsigned long nfs_gp_pmap_getport(CLIENT *client,
 520                                          struct pmap *parms,
 521                                          struct timeval timeout)
 522 {
 523         enum clnt_stat status;
 524         unsigned long port;
 525
 526         status = CLNT_CALL(client, (rpcproc_t)PMAPPROC_GETPORT,
 527                            (xdrproc_t)xdr_pmap, (void *)parms,
 528                            (xdrproc_t)xdr_u_long, (void *)&port,
 529                            timeout);
 530
 531         if (status != RPC_SUCCESS) {
 532                 rpc_createerr.cf_stat = status;
 533                 clnt_geterr(client, &rpc_createerr.cf_error);
 534                 port = 0;
 535         } else if (port == 0)
 536                 rpc_createerr.cf_stat = RPC_PROGNOTREGISTERED;
 537
 538         return port;
 539 }
 540
 541 #ifdef HAVE_LIBTIRPC
 542
 543 static unsigned short nfs_gp_getport_rpcb(CLIENT *client,
 544                                           const struct sockaddr *sap,
 545                                           const rpcprog_t program,
 546                                           const rpcvers_t version,
 547                                           const unsigned short protocol,
 548                                           struct timeval timeout)
 549 {
 550         unsigned short port = 0;
 551         struct rpcb parms;
 552
 553         if (nfs_gp_init_rpcb_parms(sap, program, version,
 554                                         protocol, &parms) != 0) {
 555                 port = nfs_gp_rpcb_getaddr(client, &parms, timeout);
 556                 nfs_gp_free_rpcb_parms(&parms);
 557         }
 558
 559         return port;
 560 }
 561
 562 #endif  /* HAVE_LIBTIRPC */
 563
 564 static unsigned long nfs_gp_getport_pmap(CLIENT *client,
 565                                          const rpcprog_t program,
 566                                          const rpcvers_t version,
 567                                          const unsigned short protocol,
 568                                          struct timeval timeout)
 569 {
 570         struct pmap parms = {
 571                 .pm_prog        = program,
 572                 .pm_vers        = version,
 573                 .pm_prot        = protocol,
 574         };
 575         rpcvers_t pmap_version = PMAPVERS;
 576
 577         CLNT_CONTROL(client, CLSET_VERS, (void *)&pmap_version);
 578         return nfs_gp_pmap_getport(client, &parms, timeout);
 579 }
 580
 581 /*
 582  * Try an AF_INET6 request via rpcbind v4/v3; try an AF_INET
 583  * request via rpcbind v2.
 584  *
 585  * Returns non-zero port number on success; otherwise returns
 586  * zero.  rpccreateerr is set to reflect the nature of the error.
 587  */
 588 static unsigned short nfs_gp_getport(CLIENT *client,
 589                                      const struct sockaddr *sap,
 590                                      const rpcprog_t program,
 591                                      const rpcvers_t version,
 592                                      const unsigned short protocol,
 593                                      struct timeval timeout)
 594 {
 595         switch (sap->sa_family) {
 596 #ifdef HAVE_LIBTIRPC
 597         case AF_INET6:
 598                 return nfs_gp_getport_rpcb(client, sap, program,
 599                                                 version, protocol, timeout);
 600 #endif  /* HAVE_LIBTIRPC */
 601         case AF_INET:
 602                 return nfs_gp_getport_pmap(client, program, version,
 603                                                         protocol, timeout);
 604         }
 605
 606         rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
 607         return 0;
 608 }
 609
 610 /**
 611  * nfs_rpc_ping - Determine if RPC service is responding to requests
 612  * @sap: pointer to address of server to query (port is already filled in)
 613  * @salen: length of server address
 614  * @program: requested RPC program number
 615  * @version: requested RPC version number
 616  * @protocol: requested IPPROTO_ value of transport protocol
 617  * @timeout: pointer to request timeout (NULL means use default timeout)
 618  *
 619  * Returns 1 if the remote service responded without an error; otherwise
 620  * zero.
 621  */
 622 int nfs_rpc_ping(const struct sockaddr *sap, const socklen_t salen,
 623                  const rpcprog_t program, const rpcvers_t version,
 624                  const unsigned short protocol, const struct timeval *timeout)
 625 {
 626         struct sockaddr_storage address;
 627         struct sockaddr *saddr = (struct sockaddr *)&address;
 628         CLIENT *client;
 629         struct timeval tout = { -1, 0 };
 630         int result = 0;
 631
 632         if (timeout != NULL)
 633                 tout = *timeout;
 634
 635         nfs_clear_rpc_createerr();
 636
 637         memcpy(saddr, sap, (size_t)salen);
 638         client = nfs_get_rpcclient(saddr, salen, protocol,
 639                                                 program, version, &tout);
 640         if (client != NULL) {
 641                 result = nfs_gp_ping(client, tout);
 642                 nfs_gp_map_tcp_errorcodes(protocol);
 643                 CLNT_DESTROY(client);
 644         }
 645
 646         return result;
 647 }
 648
 649 /**
 650  * nfs_getport - query server's rpcbind to get port number for an RPC service
 651  * @sap: pointer to address of server to query
 652  * @salen: length of server's address
 653  * @program: requested RPC program number
 654  * @version: requested RPC version number
 655  * @protocol: IPPROTO_ value of requested transport protocol
 656  *
 657  * Uses any acceptable rpcbind version to discover the port number for the
 658  * RPC service described by the given [program, version, transport] tuple.
 659  * Uses a quick timeout and an ephemeral source port.  Supports AF_INET and
 660  * AF_INET6 server addresses.
 661  *
 662  * Returns a positive integer representing the port number of the RPC
 663  * service advertised by the server (in host byte order), or zero if the
 664  * service is not advertised or there was some problem querying the server's
 665  * rpcbind daemon.  rpccreateerr is set to reflect the underlying cause of
 666  * the error.
 667  *
 668  * There are a variety of ways to choose which transport and rpcbind versions
 669  * to use.  We chose to conserve local resources and try to avoid incurring
 670  * timeouts.
 671  *
 672  * Transport
 673  * To provide rudimentary support for traversing firewalls, query the remote
 674  * using the same transport as the requested service.  This provides some
 675  * guarantee that the requested transport is available between this client
 676  * and the server, and if the caller specifically requests TCP, for example,
 677  * this may be becuase a firewall is in place that blocks UDP traffic.  We
 678  * could try both, but that could involve a lengthy timeout in several cases,
 679  * and would often consume an extra ephemeral port.
 680  *
 681  * Rpcbind version
 682  * To avoid using up too many ephemeral ports, AF_INET queries use tried-and-
 683  * true rpcbindv2, and don't try the newer versions; and AF_INET6 queries use
 684  * rpcbindv4, then rpcbindv3 on the same socket.  The newer rpcbind protocol
 685  * versions can adequately detect if a remote RPC service does not support
 686  * AF_INET6 at all.  The rpcbind socket is re-used in an attempt to keep the
 687  * overall number of consumed ephemeral ports low.
 688  */
 689 unsigned short nfs_getport(const struct sockaddr *sap,
 690                            const socklen_t salen,
 691                            const rpcprog_t program,
 692                            const rpcvers_t version,
 693                            const unsigned short protocol)
 694 {
 695         struct sockaddr_storage address;
 696         struct sockaddr *saddr = (struct sockaddr *)&address;
 697         struct timeval timeout = { -1, 0 };
 698         unsigned short port = 0;
 699         CLIENT *client;
 700
 701         nfs_clear_rpc_createerr();
 702
 703         memcpy(saddr, sap, (size_t)salen);
 704         client = nfs_gp_get_rpcbclient(saddr, salen, protocol,
 705                                                 default_rpcb_version, &timeout);
 706         if (client != NULL) {
 707                 port = nfs_gp_getport(client, saddr, program,
 708                                         version, protocol, timeout);
 709                 CLNT_DESTROY(client);
 710         }
 711
 712         return port;
 713 }
 714
 715 /**
 716  * nfs_getport_ping - query server's rpcbind and do RPC ping to verify result
 717  * @sap: IN: pointer to address of server to query;
 718  *       OUT: pointer to updated address
 719  * @salen: length of server's address
 720  * @program: requested RPC program number
 721  * @version: requested RPC version number
 722  * @protocol: IPPROTO_ value of requested transport protocol
 723  *
 724  * Uses any acceptable rpcbind version to discover the port number for the
 725  * RPC service described by the given [program, version, transport] tuple.
 726  * Uses a quick timeout and an ephemeral source port.  Supports AF_INET and
 727  * AF_INET6 server addresses.
 728  *
 729  * Returns a 1 and sets the port number in the passed-in server address
 730  * if both the query and the ping were successful; otherwise zero.
 731  * rpccreateerr is set to reflect the underlying cause of the error.
 732  */
 733 int nfs_getport_ping(struct sockaddr *sap, const socklen_t salen,
 734                      const rpcprog_t program, const rpcvers_t version,
 735                      const unsigned short protocol)
 736 {
 737         struct timeval timeout = { -1, 0 };
 738         unsigned short port = 0;
 739         CLIENT *client;
 740         int result = 0;
 741
 742         nfs_clear_rpc_createerr();
 743
 744         client = nfs_gp_get_rpcbclient(sap, salen, protocol,
 745                                                 default_rpcb_version, &timeout);
 746         if (client != NULL) {
 747                 port = nfs_gp_getport(client, sap, program,
 748                                         version, protocol, timeout);
 749                 CLNT_DESTROY(client);
 750                 client = NULL;
 751         }
 752
 753         if (port != 0) {
 754                 struct sockaddr_storage address;
 755                 struct sockaddr *saddr = (struct sockaddr *)&address;
 756
 757                 memcpy(saddr, sap, (size_t)salen);
 758                 nfs_set_port(saddr, port);
 759
 760                 nfs_clear_rpc_createerr();
 761
 762                 client = nfs_get_rpcclient(saddr, salen, protocol,
 763                                                 program, version, &timeout);
 764                 if (client != NULL) {
 765                         result = nfs_gp_ping(client, timeout);
 766                         nfs_gp_map_tcp_errorcodes(protocol);
 767                         CLNT_DESTROY(client);
 768                 }
 769         }
 770
 771         if (result)
 772                 nfs_set_port(sap, port);
 773
 774         return result;
 775 }
 776
 777 /**
 778  * nfs_getlocalport - query local rpcbind to get port number for an RPC service
 779  * @program: requested RPC program number
 780  * @version: requested RPC version number
 781  * @protocol: IPPROTO_ value of requested transport protocol
 782  *
 783  * Uses any acceptable rpcbind version to discover the port number for the
 784  * RPC service described by the given [program, version, transport] tuple.
 785  * Uses a quick timeout and an ephemeral source port.  Supports AF_INET and
 786  * AF_INET6 local addresses.
 787  *
 788  * Returns a positive integer representing the port number of the RPC
 789  * service advertised by the server (in host byte order), or zero if the
 790  * service is not advertised or there was some problem querying the server's
 791  * rpcbind daemon.  rpccreateerr is set to reflect the underlying cause of
 792  * the error.
 793  *
 794  * Try an AF_LOCAL connection first.  The rpcbind daemon implementation should
 795  * listen on AF_LOCAL.
 796  *
 797  * If that doesn't work (for example, if portmapper is running, or rpcbind
 798  * isn't listening on /var/run/rpcbind.sock), send a query via UDP to localhost
 799  * (UDP doesn't leave a socket in TIME_WAIT, and the timeout is a relatively
 800  * short 3 seconds).
 801  */
 802 unsigned short nfs_getlocalport(const rpcprot_t program,
 803                                 const rpcvers_t version,
 804                                 const unsigned short protocol)
 805 {
 806         struct sockaddr_storage address;
 807         struct sockaddr *lb_addr = (struct sockaddr *)&address;
 808         socklen_t lb_len = sizeof(*lb_addr);
 809         unsigned short port = 0;
 810
 811 #ifdef NFS_GP_LOCAL
 812         const struct sockaddr_un sun = {
 813                 .sun_family     = AF_LOCAL,
 814                 .sun_path       = _PATH_RPCBINDSOCK,
 815         };
 816         const struct sockaddr *sap = (struct sockaddr *)&sun;
 817         const socklen_t salen = SUN_LEN(&sun);
 818         CLIENT *client;
 819         struct timeval timeout = { -1, 0 };
 820
 821         nfs_clear_rpc_createerr();
 822
 823         client = nfs_gp_get_rpcbclient(sap, salen, 0, RPCBVERS_4, &timeout);
 824         if (client != NULL) {
 825                 struct rpcb parms;
 826
 827                 if (nfs_gp_init_rpcb_parms(sap, program, version,
 828                                                 protocol, &parms) != 0) {
 829                         port = nfs_gp_rpcb_getaddr(client, &parms, timeout);
 830                         nfs_gp_free_rpcb_parms(&parms);
 831                 }
 832                 CLNT_DESTROY(client);
 833         }
 834 #endif  /* NFS_GP_LOCAL */
 835
 836         if (port == 0) {
 837                 nfs_clear_rpc_createerr();
 838
 839                 if (nfs_gp_loopback_address(lb_addr, &lb_len)) {
 840                         port = nfs_getport(lb_addr, lb_len,
 841                                                 program, version, protocol);
 842                 } else
 843                         rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
 844         }
 845
 846         return port;
 847 }
 848
 849 /**
 850  * nfs_rpcb_getaddr - query rpcbind via rpcbind versions 4 and 3
 851  * @sap: pointer to address of server to query
 852  * @salen: length of server address
 853  * @transport: transport protocol to use for the query
 854  * @addr: pointer to r_addr address
 855  * @program: requested RPC program number
 856  * @version: requested RPC version number
 857  * @protocol: requested IPPROTO_ value of transport protocol
 858  * @timeout: pointer to request timeout (NULL means use default timeout)
 859  *
 860  * Returns a positive integer representing the port number of the RPC
 861  * service advertised by the server (in host byte order), or zero if the
 862  * service is not advertised or there was some problem querying the
 863  * server's rpcbind daemon.  rpccreateerr is set to reflect the
 864  * underlying cause of the error.
 865  *
 866  * This function provides similar functionality to nfs_pmap_getport(),
 867  * but performs the rpcbind lookup via rpcbind version 4.  If the server
 868  * doesn't support rpcbind version 4, it will retry with version 3.
 869  * The GETADDR procedure is exactly the same in these two versions of
 870  * the rpcbind protocol, so the socket, RPC client, and arguments are
 871  * re-used when retrying, saving ephemeral port space.
 872  *
 873  * These RPC procedures take a universal address as an argument, so the
 874  * query will fail if the remote rpcbind daemon doesn't find an entry
 875  * with a matching address.  A matching address includes an ANYADDR
 876  * address of the same address family.  In this way an RPC server can
 877  * advertise via rpcbind that it does not support AF_INET6.
 878  */
 879 #ifdef HAVE_LIBTIRPC
 880
 881 unsigned short nfs_rpcb_getaddr(const struct sockaddr *sap,
 882                                 const socklen_t salen,
 883                                 const unsigned short transport,
 884                                 const struct sockaddr *addr,
 885                                 const rpcprog_t program,
 886                                 const rpcvers_t version,
 887                                 const unsigned short protocol,
 888                                 const struct timeval *timeout)
 889 {
 890         struct sockaddr_storage address;
 891         struct sockaddr *saddr = (struct sockaddr *)&address;
 892         CLIENT *client;
 893         struct rpcb parms;
 894         struct timeval tout = { -1, 0 };
 895         unsigned short port = 0;
 896
 897         if (timeout != NULL)
 898                 tout = *timeout;
 899
 900         nfs_clear_rpc_createerr();
 901
 902         memcpy(saddr, sap, (size_t)salen);
 903         client = nfs_gp_get_rpcbclient(saddr, salen, transport,
 904                                                         RPCBVERS_4, &tout);
 905         if (client != NULL) {
 906                 if (nfs_gp_init_rpcb_parms(addr, program, version,
 907                                                 protocol, &parms) != 0) {
 908                         port = nfs_gp_rpcb_getaddr(client, &parms, tout);
 909                         nfs_gp_free_rpcb_parms(&parms);
 910                 }
 911                 CLNT_DESTROY(client);
 912         }
 913
 914         return port;
 915 }
 916
 917 #else   /* !HAVE_LIBTIRPC */
 918
 919 unsigned short nfs_rpcb_getaddr(__attribute__((unused)) const struct sockaddr *sap,
 920                                 __attribute__((unused)) const socklen_t salen,
 921                                 __attribute__((unused)) const unsigned short transport,
 922                                 __attribute__((unused)) const struct sockaddr *addr,
 923                                 __attribute__((unused)) const rpcprog_t program,
 924                                 __attribute__((unused)) const rpcvers_t version,
 925                                 __attribute__((unused)) const unsigned short protocol,
 926                                 __attribute__((unused)) const struct timeval *timeout)
 927 {
 928         nfs_clear_rpc_createerr();
 929
 930         rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
 931         return 0;
 932 }
 933
 934 #endif  /* !HAVE_LIBTIRPC */
 935
 936 /**
 937  * nfs_pmap_getport - query rpcbind via the portmap protocol (rpcbindv2)
 938  * @sin: pointer to AF_INET address of server to query
 939  * @transport: transport protocol to use for the query
 940  * @program: requested RPC program number
 941  * @version: requested RPC version number
 942  * @protocol: requested IPPROTO_ value of transport protocol
 943  * @timeout: pointer to request timeout (NULL means use default timeout)
 944  *
 945  * Returns a positive integer representing the port number of the RPC service
 946  * advertised by the server (in host byte order), or zero if the service is
 947  * not advertised or there was some problem querying the server's rpcbind
 948  * daemon.  rpccreateerr is set to reflect the underlying cause of the error.
 949  *
 950  * nfs_pmap_getport() is very similar to pmap_getport(), except that:
 951  *
 952  *  1.  This version always tries to use an ephemeral port, since reserved
 953  *      ports are not needed for GETPORT queries.  This conserves the very
 954  *      limited reserved port space, helping reduce failed socket binds
 955  *      during mount storms.
 956  *
 957  *  2.  This version times out quickly by default.  It time-limits the
 958  *      connect process as well as the actual RPC call, and even allows the
 959  *      caller to specify the timeout.
 960  *
 961  *  3.  This version shares code with the rpcbindv3 and rpcbindv4 query
 962  *      functions.  It can use a TI-RPC generated CLIENT.
 963  */
 964 unsigned long nfs_pmap_getport(const struct sockaddr_in *sin,
 965                                const unsigned short transport,
 966                                const unsigned long program,
 967                                const unsigned long version,
 968                                const unsigned long protocol,
 969                                const struct timeval *timeout)
 970 {
 971         struct sockaddr_in address;
 972         struct sockaddr *saddr = (struct sockaddr *)&address;
 973         CLIENT *client;
 974         struct pmap parms = {
 975                 .pm_prog        = program,
 976                 .pm_vers        = version,
 977                 .pm_prot        = protocol,
 978         };
 979         struct timeval tout = { -1, 0 };
 980         unsigned long port = 0;
 981
 982         if (timeout != NULL)
 983                 tout = *timeout;
 984
 985         nfs_clear_rpc_createerr();
 986
 987         memcpy(saddr, sin, sizeof(address));
 988         client = nfs_gp_get_rpcbclient(saddr, (socklen_t)sizeof(*sin),
 989                                         transport, PMAPVERS, &tout);
 990         if (client != NULL) {
 991                 port = nfs_gp_pmap_getport(client, &parms, tout);
 992                 CLNT_DESTROY(client);
 993         }
 994
 995         return port;
 996 }