1a02d6926SChuck Lever /* 2a02d6926SChuck Lever * Copyright 2009, Oracle. All rights reserved. 3a02d6926SChuck Lever * 4a02d6926SChuck Lever * Convert socket addresses to presentation addresses and universal 5a02d6926SChuck Lever * addresses, and vice versa. 6a02d6926SChuck Lever * 7a02d6926SChuck Lever * Universal addresses are introduced by RFC 1833 and further refined by 8a02d6926SChuck Lever * recent RFCs describing NFSv4. The universal address format is part 9a02d6926SChuck Lever * of the external (network) interface provided by rpcbind version 3 10a02d6926SChuck Lever * and 4, and by NFSv4. Such an address is a string containing a 11a02d6926SChuck Lever * presentation format IP address followed by a port number in 12a02d6926SChuck Lever * "hibyte.lobyte" format. 13a02d6926SChuck Lever * 14a02d6926SChuck Lever * IPv6 addresses can also include a scope ID, typically denoted by 15a02d6926SChuck Lever * a '%' followed by a device name or a non-negative integer. Refer to 16a02d6926SChuck Lever * RFC 4291, Section 2.2 for details on IPv6 presentation formats. 17a02d6926SChuck Lever */ 18a02d6926SChuck Lever 19a02d6926SChuck Lever #include <net/ipv6.h> 205976687aSJeff Layton #include <linux/sunrpc/addr.h> 215976687aSJeff Layton #include <linux/sunrpc/msg_prot.h> 225a0e3ad6STejun Heo #include <linux/slab.h> 23bc3b2d7fSPaul Gortmaker #include <linux/export.h> 24a02d6926SChuck Lever 25dfd56b8bSEric Dumazet #if IS_ENABLED(CONFIG_IPV6) 26a02d6926SChuck Lever 27a02d6926SChuck Lever static size_t rpc_ntop6_noscopeid(const struct sockaddr *sap, 28a02d6926SChuck Lever char *buf, const int buflen) 29a02d6926SChuck Lever { 30a02d6926SChuck Lever const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap; 31a02d6926SChuck Lever const struct in6_addr *addr = &sin6->sin6_addr; 32a02d6926SChuck Lever 33a02d6926SChuck Lever /* 34a02d6926SChuck Lever * RFC 4291, Section 2.2.2 35a02d6926SChuck Lever * 36a02d6926SChuck Lever * Shorthanded ANY address 37a02d6926SChuck Lever */ 38a02d6926SChuck Lever if (ipv6_addr_any(addr)) 39a02d6926SChuck Lever return snprintf(buf, buflen, "::"); 40a02d6926SChuck Lever 41a02d6926SChuck Lever /* 42a02d6926SChuck Lever * RFC 4291, Section 2.2.2 43a02d6926SChuck Lever * 44a02d6926SChuck Lever * Shorthanded loopback address 45a02d6926SChuck Lever */ 46a02d6926SChuck Lever if (ipv6_addr_loopback(addr)) 47a02d6926SChuck Lever return snprintf(buf, buflen, "::1"); 48a02d6926SChuck Lever 49a02d6926SChuck Lever /* 50a02d6926SChuck Lever * RFC 4291, Section 2.2.3 51a02d6926SChuck Lever * 52a02d6926SChuck Lever * Special presentation address format for mapped v4 53a02d6926SChuck Lever * addresses. 54a02d6926SChuck Lever */ 55a02d6926SChuck Lever if (ipv6_addr_v4mapped(addr)) 56a02d6926SChuck Lever return snprintf(buf, buflen, "::ffff:%pI4", 57a02d6926SChuck Lever &addr->s6_addr32[3]); 58a02d6926SChuck Lever 59a02d6926SChuck Lever /* 60a02d6926SChuck Lever * RFC 4291, Section 2.2.1 61a02d6926SChuck Lever */ 62dd1fd90fSChuck Lever return snprintf(buf, buflen, "%pI6c", addr); 63a02d6926SChuck Lever } 64a02d6926SChuck Lever 65a02d6926SChuck Lever static size_t rpc_ntop6(const struct sockaddr *sap, 66a02d6926SChuck Lever char *buf, const size_t buflen) 67a02d6926SChuck Lever { 68a02d6926SChuck Lever const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap; 69a02d6926SChuck Lever char scopebuf[IPV6_SCOPE_ID_LEN]; 70a02d6926SChuck Lever size_t len; 71a02d6926SChuck Lever int rc; 72a02d6926SChuck Lever 73a02d6926SChuck Lever len = rpc_ntop6_noscopeid(sap, buf, buflen); 74a02d6926SChuck Lever if (unlikely(len == 0)) 75a02d6926SChuck Lever return len; 76a02d6926SChuck Lever 77f1a89a11SChuck Lever if (!(ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LINKLOCAL)) 78a02d6926SChuck Lever return len; 797a88efe9SChuck Lever if (sin6->sin6_scope_id == 0) 807a88efe9SChuck Lever return len; 81a02d6926SChuck Lever 82a02d6926SChuck Lever rc = snprintf(scopebuf, sizeof(scopebuf), "%c%u", 83a02d6926SChuck Lever IPV6_SCOPE_DELIMITER, sin6->sin6_scope_id); 84a02d6926SChuck Lever if (unlikely((size_t)rc > sizeof(scopebuf))) 85a02d6926SChuck Lever return 0; 86a02d6926SChuck Lever 87a02d6926SChuck Lever len += rc; 88a02d6926SChuck Lever if (unlikely(len > buflen)) 89a02d6926SChuck Lever return 0; 90a02d6926SChuck Lever 91a02d6926SChuck Lever strcat(buf, scopebuf); 92a02d6926SChuck Lever return len; 93a02d6926SChuck Lever } 94a02d6926SChuck Lever 95dfd56b8bSEric Dumazet #else /* !IS_ENABLED(CONFIG_IPV6) */ 96a02d6926SChuck Lever 97a02d6926SChuck Lever static size_t rpc_ntop6_noscopeid(const struct sockaddr *sap, 98a02d6926SChuck Lever char *buf, const int buflen) 99a02d6926SChuck Lever { 100a02d6926SChuck Lever return 0; 101a02d6926SChuck Lever } 102a02d6926SChuck Lever 103a02d6926SChuck Lever static size_t rpc_ntop6(const struct sockaddr *sap, 104a02d6926SChuck Lever char *buf, const size_t buflen) 105a02d6926SChuck Lever { 106a02d6926SChuck Lever return 0; 107a02d6926SChuck Lever } 108a02d6926SChuck Lever 109dfd56b8bSEric Dumazet #endif /* !IS_ENABLED(CONFIG_IPV6) */ 110a02d6926SChuck Lever 111a02d6926SChuck Lever static int rpc_ntop4(const struct sockaddr *sap, 112a02d6926SChuck Lever char *buf, const size_t buflen) 113a02d6926SChuck Lever { 114a02d6926SChuck Lever const struct sockaddr_in *sin = (struct sockaddr_in *)sap; 115a02d6926SChuck Lever 116a02d6926SChuck Lever return snprintf(buf, buflen, "%pI4", &sin->sin_addr); 117a02d6926SChuck Lever } 118a02d6926SChuck Lever 119a02d6926SChuck Lever /** 120a02d6926SChuck Lever * rpc_ntop - construct a presentation address in @buf 121a02d6926SChuck Lever * @sap: socket address 122a02d6926SChuck Lever * @buf: construction area 123a02d6926SChuck Lever * @buflen: size of @buf, in bytes 124a02d6926SChuck Lever * 125a02d6926SChuck Lever * Plants a %NUL-terminated string in @buf and returns the length 126a02d6926SChuck Lever * of the string, excluding the %NUL. Otherwise zero is returned. 127a02d6926SChuck Lever */ 128a02d6926SChuck Lever size_t rpc_ntop(const struct sockaddr *sap, char *buf, const size_t buflen) 129a02d6926SChuck Lever { 130a02d6926SChuck Lever switch (sap->sa_family) { 131a02d6926SChuck Lever case AF_INET: 132a02d6926SChuck Lever return rpc_ntop4(sap, buf, buflen); 133a02d6926SChuck Lever case AF_INET6: 134a02d6926SChuck Lever return rpc_ntop6(sap, buf, buflen); 135a02d6926SChuck Lever } 136a02d6926SChuck Lever 137a02d6926SChuck Lever return 0; 138a02d6926SChuck Lever } 139a02d6926SChuck Lever EXPORT_SYMBOL_GPL(rpc_ntop); 140a02d6926SChuck Lever 141a02d6926SChuck Lever static size_t rpc_pton4(const char *buf, const size_t buflen, 142a02d6926SChuck Lever struct sockaddr *sap, const size_t salen) 143a02d6926SChuck Lever { 144a02d6926SChuck Lever struct sockaddr_in *sin = (struct sockaddr_in *)sap; 145a02d6926SChuck Lever u8 *addr = (u8 *)&sin->sin_addr.s_addr; 146a02d6926SChuck Lever 147a02d6926SChuck Lever if (buflen > INET_ADDRSTRLEN || salen < sizeof(struct sockaddr_in)) 148a02d6926SChuck Lever return 0; 149a02d6926SChuck Lever 150a02d6926SChuck Lever memset(sap, 0, sizeof(struct sockaddr_in)); 151a02d6926SChuck Lever 152a02d6926SChuck Lever if (in4_pton(buf, buflen, addr, '\0', NULL) == 0) 153a02d6926SChuck Lever return 0; 154a02d6926SChuck Lever 155a02d6926SChuck Lever sin->sin_family = AF_INET; 1566eab04a8SJustin P. Mattock return sizeof(struct sockaddr_in); 157a02d6926SChuck Lever } 158a02d6926SChuck Lever 159dfd56b8bSEric Dumazet #if IS_ENABLED(CONFIG_IPV6) 1603065f1e2SStanislav Kinsbursky static int rpc_parse_scope_id(struct net *net, const char *buf, 1613065f1e2SStanislav Kinsbursky const size_t buflen, const char *delim, 1623065f1e2SStanislav Kinsbursky struct sockaddr_in6 *sin6) 163a02d6926SChuck Lever { 164a02d6926SChuck Lever char *p; 165a02d6926SChuck Lever size_t len; 166a02d6926SChuck Lever 167a02d6926SChuck Lever if ((buf + buflen) == delim) 168a02d6926SChuck Lever return 1; 169a02d6926SChuck Lever 170a02d6926SChuck Lever if (*delim != IPV6_SCOPE_DELIMITER) 171a02d6926SChuck Lever return 0; 172a02d6926SChuck Lever 173f1a89a11SChuck Lever if (!(ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LINKLOCAL)) 174a02d6926SChuck Lever return 0; 175a02d6926SChuck Lever 176a02d6926SChuck Lever len = (buf + buflen) - delim - 1; 177a02d6926SChuck Lever p = kstrndup(delim + 1, len, GFP_KERNEL); 178a02d6926SChuck Lever if (p) { 179a02d6926SChuck Lever unsigned long scope_id = 0; 180a02d6926SChuck Lever struct net_device *dev; 181a02d6926SChuck Lever 1823065f1e2SStanislav Kinsbursky dev = dev_get_by_name(net, p); 183a02d6926SChuck Lever if (dev != NULL) { 184a02d6926SChuck Lever scope_id = dev->ifindex; 185a02d6926SChuck Lever dev_put(dev); 186a02d6926SChuck Lever } else { 187a02d6926SChuck Lever if (strict_strtoul(p, 10, &scope_id) == 0) { 188a02d6926SChuck Lever kfree(p); 189a02d6926SChuck Lever return 0; 190a02d6926SChuck Lever } 191a02d6926SChuck Lever } 192a02d6926SChuck Lever 193a02d6926SChuck Lever kfree(p); 194a02d6926SChuck Lever 195a02d6926SChuck Lever sin6->sin6_scope_id = scope_id; 196a02d6926SChuck Lever return 1; 197a02d6926SChuck Lever } 198a02d6926SChuck Lever 199a02d6926SChuck Lever return 0; 200a02d6926SChuck Lever } 201a02d6926SChuck Lever 2028b147f74SStanislav Kinsbursky static size_t rpc_pton6(struct net *net, const char *buf, const size_t buflen, 203a02d6926SChuck Lever struct sockaddr *sap, const size_t salen) 204a02d6926SChuck Lever { 205a02d6926SChuck Lever struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap; 206a02d6926SChuck Lever u8 *addr = (u8 *)&sin6->sin6_addr.in6_u; 207a02d6926SChuck Lever const char *delim; 208a02d6926SChuck Lever 209a02d6926SChuck Lever if (buflen > (INET6_ADDRSTRLEN + IPV6_SCOPE_ID_LEN) || 210a02d6926SChuck Lever salen < sizeof(struct sockaddr_in6)) 211a02d6926SChuck Lever return 0; 212a02d6926SChuck Lever 213a02d6926SChuck Lever memset(sap, 0, sizeof(struct sockaddr_in6)); 214a02d6926SChuck Lever 215a02d6926SChuck Lever if (in6_pton(buf, buflen, addr, IPV6_SCOPE_DELIMITER, &delim) == 0) 216a02d6926SChuck Lever return 0; 217a02d6926SChuck Lever 2188b147f74SStanislav Kinsbursky if (!rpc_parse_scope_id(net, buf, buflen, delim, sin6)) 219a02d6926SChuck Lever return 0; 220a02d6926SChuck Lever 221a02d6926SChuck Lever sin6->sin6_family = AF_INET6; 222a02d6926SChuck Lever return sizeof(struct sockaddr_in6); 223a02d6926SChuck Lever } 224a02d6926SChuck Lever #else 2258b147f74SStanislav Kinsbursky static size_t rpc_pton6(struct net *net, const char *buf, const size_t buflen, 226a02d6926SChuck Lever struct sockaddr *sap, const size_t salen) 227a02d6926SChuck Lever { 228a02d6926SChuck Lever return 0; 229a02d6926SChuck Lever } 230a02d6926SChuck Lever #endif 231a02d6926SChuck Lever 232a02d6926SChuck Lever /** 233a02d6926SChuck Lever * rpc_pton - Construct a sockaddr in @sap 23490100b17SStanislav Kinsbursky * @net: applicable network namespace 235a02d6926SChuck Lever * @buf: C string containing presentation format IP address 236a02d6926SChuck Lever * @buflen: length of presentation address in bytes 237a02d6926SChuck Lever * @sap: buffer into which to plant socket address 238a02d6926SChuck Lever * @salen: size of buffer in bytes 239a02d6926SChuck Lever * 240a02d6926SChuck Lever * Returns the size of the socket address if successful; otherwise 241a02d6926SChuck Lever * zero is returned. 242a02d6926SChuck Lever * 243a02d6926SChuck Lever * Plants a socket address in @sap and returns the size of the 244a02d6926SChuck Lever * socket address, if successful. Returns zero if an error 245a02d6926SChuck Lever * occurred. 246a02d6926SChuck Lever */ 24790100b17SStanislav Kinsbursky size_t rpc_pton(struct net *net, const char *buf, const size_t buflen, 248a02d6926SChuck Lever struct sockaddr *sap, const size_t salen) 249a02d6926SChuck Lever { 250a02d6926SChuck Lever unsigned int i; 251a02d6926SChuck Lever 252a02d6926SChuck Lever for (i = 0; i < buflen; i++) 253a02d6926SChuck Lever if (buf[i] == ':') 25490100b17SStanislav Kinsbursky return rpc_pton6(net, buf, buflen, sap, salen); 255a02d6926SChuck Lever return rpc_pton4(buf, buflen, sap, salen); 256a02d6926SChuck Lever } 257a02d6926SChuck Lever EXPORT_SYMBOL_GPL(rpc_pton); 258a02d6926SChuck Lever 259a02d6926SChuck Lever /** 260a02d6926SChuck Lever * rpc_sockaddr2uaddr - Construct a universal address string from @sap. 261a02d6926SChuck Lever * @sap: socket address 262d77385f2STrond Myklebust * @gfp_flags: allocation mode 263a02d6926SChuck Lever * 264a02d6926SChuck Lever * Returns a %NUL-terminated string in dynamically allocated memory; 265a02d6926SChuck Lever * otherwise NULL is returned if an error occurred. Caller must 266a02d6926SChuck Lever * free the returned string. 267a02d6926SChuck Lever */ 268d77385f2STrond Myklebust char *rpc_sockaddr2uaddr(const struct sockaddr *sap, gfp_t gfp_flags) 269a02d6926SChuck Lever { 270a02d6926SChuck Lever char portbuf[RPCBIND_MAXUADDRPLEN]; 271a02d6926SChuck Lever char addrbuf[RPCBIND_MAXUADDRLEN]; 272a02d6926SChuck Lever unsigned short port; 273a02d6926SChuck Lever 274a02d6926SChuck Lever switch (sap->sa_family) { 275a02d6926SChuck Lever case AF_INET: 276a02d6926SChuck Lever if (rpc_ntop4(sap, addrbuf, sizeof(addrbuf)) == 0) 277a02d6926SChuck Lever return NULL; 278a02d6926SChuck Lever port = ntohs(((struct sockaddr_in *)sap)->sin_port); 279a02d6926SChuck Lever break; 280a02d6926SChuck Lever case AF_INET6: 281a02d6926SChuck Lever if (rpc_ntop6_noscopeid(sap, addrbuf, sizeof(addrbuf)) == 0) 282a02d6926SChuck Lever return NULL; 283a02d6926SChuck Lever port = ntohs(((struct sockaddr_in6 *)sap)->sin6_port); 284a02d6926SChuck Lever break; 285a02d6926SChuck Lever default: 286a02d6926SChuck Lever return NULL; 287a02d6926SChuck Lever } 288a02d6926SChuck Lever 289a02d6926SChuck Lever if (snprintf(portbuf, sizeof(portbuf), 290a02d6926SChuck Lever ".%u.%u", port >> 8, port & 0xff) > (int)sizeof(portbuf)) 291a02d6926SChuck Lever return NULL; 292a02d6926SChuck Lever 293a02d6926SChuck Lever if (strlcat(addrbuf, portbuf, sizeof(addrbuf)) > sizeof(addrbuf)) 294a02d6926SChuck Lever return NULL; 295a02d6926SChuck Lever 296d77385f2STrond Myklebust return kstrdup(addrbuf, gfp_flags); 297a02d6926SChuck Lever } 298a02d6926SChuck Lever 299a02d6926SChuck Lever /** 300a02d6926SChuck Lever * rpc_uaddr2sockaddr - convert a universal address to a socket address. 301f2ac4dc9SStanislav Kinsbursky * @net: applicable network namespace 302a02d6926SChuck Lever * @uaddr: C string containing universal address to convert 303a02d6926SChuck Lever * @uaddr_len: length of universal address string 304a02d6926SChuck Lever * @sap: buffer into which to plant socket address 305a02d6926SChuck Lever * @salen: size of buffer 306a02d6926SChuck Lever * 3071e360a60SChuck Lever * @uaddr does not have to be '\0'-terminated, but strict_strtoul() and 3081e360a60SChuck Lever * rpc_pton() require proper string termination to be successful. 3091e360a60SChuck Lever * 310a02d6926SChuck Lever * Returns the size of the socket address if successful; otherwise 311a02d6926SChuck Lever * zero is returned. 312a02d6926SChuck Lever */ 313f2ac4dc9SStanislav Kinsbursky size_t rpc_uaddr2sockaddr(struct net *net, const char *uaddr, 314f2ac4dc9SStanislav Kinsbursky const size_t uaddr_len, struct sockaddr *sap, 315f2ac4dc9SStanislav Kinsbursky const size_t salen) 316a02d6926SChuck Lever { 3171e360a60SChuck Lever char *c, buf[RPCBIND_MAXUADDRLEN + sizeof('\0')]; 318a02d6926SChuck Lever unsigned long portlo, porthi; 319a02d6926SChuck Lever unsigned short port; 320a02d6926SChuck Lever 3211e360a60SChuck Lever if (uaddr_len > RPCBIND_MAXUADDRLEN) 322a02d6926SChuck Lever return 0; 323a02d6926SChuck Lever 324a02d6926SChuck Lever memcpy(buf, uaddr, uaddr_len); 325a02d6926SChuck Lever 3261e360a60SChuck Lever buf[uaddr_len] = '\0'; 327a02d6926SChuck Lever c = strrchr(buf, '.'); 328a02d6926SChuck Lever if (unlikely(c == NULL)) 329a02d6926SChuck Lever return 0; 330a02d6926SChuck Lever if (unlikely(strict_strtoul(c + 1, 10, &portlo) != 0)) 331a02d6926SChuck Lever return 0; 332a02d6926SChuck Lever if (unlikely(portlo > 255)) 333a02d6926SChuck Lever return 0; 334a02d6926SChuck Lever 3351e360a60SChuck Lever *c = '\0'; 336a02d6926SChuck Lever c = strrchr(buf, '.'); 337a02d6926SChuck Lever if (unlikely(c == NULL)) 338a02d6926SChuck Lever return 0; 339a02d6926SChuck Lever if (unlikely(strict_strtoul(c + 1, 10, &porthi) != 0)) 340a02d6926SChuck Lever return 0; 341a02d6926SChuck Lever if (unlikely(porthi > 255)) 342a02d6926SChuck Lever return 0; 343a02d6926SChuck Lever 344a02d6926SChuck Lever port = (unsigned short)((porthi << 8) | portlo); 345a02d6926SChuck Lever 3461e360a60SChuck Lever *c = '\0'; 347f2ac4dc9SStanislav Kinsbursky if (rpc_pton(net, buf, strlen(buf), sap, salen) == 0) 348a02d6926SChuck Lever return 0; 349a02d6926SChuck Lever 350a02d6926SChuck Lever switch (sap->sa_family) { 351a02d6926SChuck Lever case AF_INET: 352a02d6926SChuck Lever ((struct sockaddr_in *)sap)->sin_port = htons(port); 353a02d6926SChuck Lever return sizeof(struct sockaddr_in); 354a02d6926SChuck Lever case AF_INET6: 355a02d6926SChuck Lever ((struct sockaddr_in6 *)sap)->sin6_port = htons(port); 356a02d6926SChuck Lever return sizeof(struct sockaddr_in6); 357a02d6926SChuck Lever } 358a02d6926SChuck Lever 359a02d6926SChuck Lever return 0; 360a02d6926SChuck Lever } 361a02d6926SChuck Lever EXPORT_SYMBOL_GPL(rpc_uaddr2sockaddr); 362