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> 20a02d6926SChuck Lever #include <linux/sunrpc/clnt.h> 215a0e3ad6STejun Heo #include <linux/slab.h> 22bc3b2d7fSPaul Gortmaker #include <linux/export.h> 23a02d6926SChuck Lever 24dfd56b8bSEric Dumazet #if IS_ENABLED(CONFIG_IPV6) 25a02d6926SChuck Lever 26a02d6926SChuck Lever static size_t rpc_ntop6_noscopeid(const struct sockaddr *sap, 27a02d6926SChuck Lever char *buf, const int buflen) 28a02d6926SChuck Lever { 29a02d6926SChuck Lever const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap; 30a02d6926SChuck Lever const struct in6_addr *addr = &sin6->sin6_addr; 31a02d6926SChuck Lever 32a02d6926SChuck Lever /* 33a02d6926SChuck Lever * RFC 4291, Section 2.2.2 34a02d6926SChuck Lever * 35a02d6926SChuck Lever * Shorthanded ANY address 36a02d6926SChuck Lever */ 37a02d6926SChuck Lever if (ipv6_addr_any(addr)) 38a02d6926SChuck Lever return snprintf(buf, buflen, "::"); 39a02d6926SChuck Lever 40a02d6926SChuck Lever /* 41a02d6926SChuck Lever * RFC 4291, Section 2.2.2 42a02d6926SChuck Lever * 43a02d6926SChuck Lever * Shorthanded loopback address 44a02d6926SChuck Lever */ 45a02d6926SChuck Lever if (ipv6_addr_loopback(addr)) 46a02d6926SChuck Lever return snprintf(buf, buflen, "::1"); 47a02d6926SChuck Lever 48a02d6926SChuck Lever /* 49a02d6926SChuck Lever * RFC 4291, Section 2.2.3 50a02d6926SChuck Lever * 51a02d6926SChuck Lever * Special presentation address format for mapped v4 52a02d6926SChuck Lever * addresses. 53a02d6926SChuck Lever */ 54a02d6926SChuck Lever if (ipv6_addr_v4mapped(addr)) 55a02d6926SChuck Lever return snprintf(buf, buflen, "::ffff:%pI4", 56a02d6926SChuck Lever &addr->s6_addr32[3]); 57a02d6926SChuck Lever 58a02d6926SChuck Lever /* 59a02d6926SChuck Lever * RFC 4291, Section 2.2.1 60a02d6926SChuck Lever */ 61dd1fd90fSChuck Lever return snprintf(buf, buflen, "%pI6c", addr); 62a02d6926SChuck Lever } 63a02d6926SChuck Lever 64a02d6926SChuck Lever static size_t rpc_ntop6(const struct sockaddr *sap, 65a02d6926SChuck Lever char *buf, const size_t buflen) 66a02d6926SChuck Lever { 67a02d6926SChuck Lever const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap; 68a02d6926SChuck Lever char scopebuf[IPV6_SCOPE_ID_LEN]; 69a02d6926SChuck Lever size_t len; 70a02d6926SChuck Lever int rc; 71a02d6926SChuck Lever 72a02d6926SChuck Lever len = rpc_ntop6_noscopeid(sap, buf, buflen); 73a02d6926SChuck Lever if (unlikely(len == 0)) 74a02d6926SChuck Lever return len; 75a02d6926SChuck Lever 76f1a89a11SChuck Lever if (!(ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LINKLOCAL)) 77a02d6926SChuck Lever return len; 787a88efe9SChuck Lever if (sin6->sin6_scope_id == 0) 797a88efe9SChuck Lever return len; 80a02d6926SChuck Lever 81a02d6926SChuck Lever rc = snprintf(scopebuf, sizeof(scopebuf), "%c%u", 82a02d6926SChuck Lever IPV6_SCOPE_DELIMITER, sin6->sin6_scope_id); 83a02d6926SChuck Lever if (unlikely((size_t)rc > sizeof(scopebuf))) 84a02d6926SChuck Lever return 0; 85a02d6926SChuck Lever 86a02d6926SChuck Lever len += rc; 87a02d6926SChuck Lever if (unlikely(len > buflen)) 88a02d6926SChuck Lever return 0; 89a02d6926SChuck Lever 90a02d6926SChuck Lever strcat(buf, scopebuf); 91a02d6926SChuck Lever return len; 92a02d6926SChuck Lever } 93a02d6926SChuck Lever 94dfd56b8bSEric Dumazet #else /* !IS_ENABLED(CONFIG_IPV6) */ 95a02d6926SChuck Lever 96a02d6926SChuck Lever static size_t rpc_ntop6_noscopeid(const struct sockaddr *sap, 97a02d6926SChuck Lever char *buf, const int buflen) 98a02d6926SChuck Lever { 99a02d6926SChuck Lever return 0; 100a02d6926SChuck Lever } 101a02d6926SChuck Lever 102a02d6926SChuck Lever static size_t rpc_ntop6(const struct sockaddr *sap, 103a02d6926SChuck Lever char *buf, const size_t buflen) 104a02d6926SChuck Lever { 105a02d6926SChuck Lever return 0; 106a02d6926SChuck Lever } 107a02d6926SChuck Lever 108dfd56b8bSEric Dumazet #endif /* !IS_ENABLED(CONFIG_IPV6) */ 109a02d6926SChuck Lever 110a02d6926SChuck Lever static int rpc_ntop4(const struct sockaddr *sap, 111a02d6926SChuck Lever char *buf, const size_t buflen) 112a02d6926SChuck Lever { 113a02d6926SChuck Lever const struct sockaddr_in *sin = (struct sockaddr_in *)sap; 114a02d6926SChuck Lever 115a02d6926SChuck Lever return snprintf(buf, buflen, "%pI4", &sin->sin_addr); 116a02d6926SChuck Lever } 117a02d6926SChuck Lever 118a02d6926SChuck Lever /** 119a02d6926SChuck Lever * rpc_ntop - construct a presentation address in @buf 120a02d6926SChuck Lever * @sap: socket address 121a02d6926SChuck Lever * @buf: construction area 122a02d6926SChuck Lever * @buflen: size of @buf, in bytes 123a02d6926SChuck Lever * 124a02d6926SChuck Lever * Plants a %NUL-terminated string in @buf and returns the length 125a02d6926SChuck Lever * of the string, excluding the %NUL. Otherwise zero is returned. 126a02d6926SChuck Lever */ 127a02d6926SChuck Lever size_t rpc_ntop(const struct sockaddr *sap, char *buf, const size_t buflen) 128a02d6926SChuck Lever { 129a02d6926SChuck Lever switch (sap->sa_family) { 130a02d6926SChuck Lever case AF_INET: 131a02d6926SChuck Lever return rpc_ntop4(sap, buf, buflen); 132a02d6926SChuck Lever case AF_INET6: 133a02d6926SChuck Lever return rpc_ntop6(sap, buf, buflen); 134a02d6926SChuck Lever } 135a02d6926SChuck Lever 136a02d6926SChuck Lever return 0; 137a02d6926SChuck Lever } 138a02d6926SChuck Lever EXPORT_SYMBOL_GPL(rpc_ntop); 139a02d6926SChuck Lever 140a02d6926SChuck Lever static size_t rpc_pton4(const char *buf, const size_t buflen, 141a02d6926SChuck Lever struct sockaddr *sap, const size_t salen) 142a02d6926SChuck Lever { 143a02d6926SChuck Lever struct sockaddr_in *sin = (struct sockaddr_in *)sap; 144a02d6926SChuck Lever u8 *addr = (u8 *)&sin->sin_addr.s_addr; 145a02d6926SChuck Lever 146a02d6926SChuck Lever if (buflen > INET_ADDRSTRLEN || salen < sizeof(struct sockaddr_in)) 147a02d6926SChuck Lever return 0; 148a02d6926SChuck Lever 149a02d6926SChuck Lever memset(sap, 0, sizeof(struct sockaddr_in)); 150a02d6926SChuck Lever 151a02d6926SChuck Lever if (in4_pton(buf, buflen, addr, '\0', NULL) == 0) 152a02d6926SChuck Lever return 0; 153a02d6926SChuck Lever 154a02d6926SChuck Lever sin->sin_family = AF_INET; 1556eab04a8SJustin P. Mattock return sizeof(struct sockaddr_in); 156a02d6926SChuck Lever } 157a02d6926SChuck Lever 158dfd56b8bSEric Dumazet #if IS_ENABLED(CONFIG_IPV6) 1593065f1e2SStanislav Kinsbursky static int rpc_parse_scope_id(struct net *net, const char *buf, 1603065f1e2SStanislav Kinsbursky const size_t buflen, const char *delim, 1613065f1e2SStanislav Kinsbursky struct sockaddr_in6 *sin6) 162a02d6926SChuck Lever { 163a02d6926SChuck Lever char *p; 164a02d6926SChuck Lever size_t len; 165a02d6926SChuck Lever 166a02d6926SChuck Lever if ((buf + buflen) == delim) 167a02d6926SChuck Lever return 1; 168a02d6926SChuck Lever 169a02d6926SChuck Lever if (*delim != IPV6_SCOPE_DELIMITER) 170a02d6926SChuck Lever return 0; 171a02d6926SChuck Lever 172f1a89a11SChuck Lever if (!(ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LINKLOCAL)) 173a02d6926SChuck Lever return 0; 174a02d6926SChuck Lever 175a02d6926SChuck Lever len = (buf + buflen) - delim - 1; 176a02d6926SChuck Lever p = kstrndup(delim + 1, len, GFP_KERNEL); 177a02d6926SChuck Lever if (p) { 178a02d6926SChuck Lever unsigned long scope_id = 0; 179a02d6926SChuck Lever struct net_device *dev; 180a02d6926SChuck Lever 1813065f1e2SStanislav Kinsbursky dev = dev_get_by_name(net, p); 182a02d6926SChuck Lever if (dev != NULL) { 183a02d6926SChuck Lever scope_id = dev->ifindex; 184a02d6926SChuck Lever dev_put(dev); 185a02d6926SChuck Lever } else { 186a02d6926SChuck Lever if (strict_strtoul(p, 10, &scope_id) == 0) { 187a02d6926SChuck Lever kfree(p); 188a02d6926SChuck Lever return 0; 189a02d6926SChuck Lever } 190a02d6926SChuck Lever } 191a02d6926SChuck Lever 192a02d6926SChuck Lever kfree(p); 193a02d6926SChuck Lever 194a02d6926SChuck Lever sin6->sin6_scope_id = scope_id; 195a02d6926SChuck Lever return 1; 196a02d6926SChuck Lever } 197a02d6926SChuck Lever 198a02d6926SChuck Lever return 0; 199a02d6926SChuck Lever } 200a02d6926SChuck Lever 2018b147f74SStanislav Kinsbursky static size_t rpc_pton6(struct net *net, const char *buf, const size_t buflen, 202a02d6926SChuck Lever struct sockaddr *sap, const size_t salen) 203a02d6926SChuck Lever { 204a02d6926SChuck Lever struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap; 205a02d6926SChuck Lever u8 *addr = (u8 *)&sin6->sin6_addr.in6_u; 206a02d6926SChuck Lever const char *delim; 207a02d6926SChuck Lever 208a02d6926SChuck Lever if (buflen > (INET6_ADDRSTRLEN + IPV6_SCOPE_ID_LEN) || 209a02d6926SChuck Lever salen < sizeof(struct sockaddr_in6)) 210a02d6926SChuck Lever return 0; 211a02d6926SChuck Lever 212a02d6926SChuck Lever memset(sap, 0, sizeof(struct sockaddr_in6)); 213a02d6926SChuck Lever 214a02d6926SChuck Lever if (in6_pton(buf, buflen, addr, IPV6_SCOPE_DELIMITER, &delim) == 0) 215a02d6926SChuck Lever return 0; 216a02d6926SChuck Lever 2178b147f74SStanislav Kinsbursky if (!rpc_parse_scope_id(net, buf, buflen, delim, sin6)) 218a02d6926SChuck Lever return 0; 219a02d6926SChuck Lever 220a02d6926SChuck Lever sin6->sin6_family = AF_INET6; 221a02d6926SChuck Lever return sizeof(struct sockaddr_in6); 222a02d6926SChuck Lever } 223a02d6926SChuck Lever #else 2248b147f74SStanislav Kinsbursky static size_t rpc_pton6(struct net *net, const char *buf, const size_t buflen, 225a02d6926SChuck Lever struct sockaddr *sap, const size_t salen) 226a02d6926SChuck Lever { 227a02d6926SChuck Lever return 0; 228a02d6926SChuck Lever } 229a02d6926SChuck Lever #endif 230a02d6926SChuck Lever 231a02d6926SChuck Lever /** 232a02d6926SChuck Lever * rpc_pton - Construct a sockaddr in @sap 23390100b17SStanislav Kinsbursky * @net: applicable network namespace 234a02d6926SChuck Lever * @buf: C string containing presentation format IP address 235a02d6926SChuck Lever * @buflen: length of presentation address in bytes 236a02d6926SChuck Lever * @sap: buffer into which to plant socket address 237a02d6926SChuck Lever * @salen: size of buffer in bytes 238a02d6926SChuck Lever * 239a02d6926SChuck Lever * Returns the size of the socket address if successful; otherwise 240a02d6926SChuck Lever * zero is returned. 241a02d6926SChuck Lever * 242a02d6926SChuck Lever * Plants a socket address in @sap and returns the size of the 243a02d6926SChuck Lever * socket address, if successful. Returns zero if an error 244a02d6926SChuck Lever * occurred. 245a02d6926SChuck Lever */ 24690100b17SStanislav Kinsbursky size_t rpc_pton(struct net *net, const char *buf, const size_t buflen, 247a02d6926SChuck Lever struct sockaddr *sap, const size_t salen) 248a02d6926SChuck Lever { 249a02d6926SChuck Lever unsigned int i; 250a02d6926SChuck Lever 251a02d6926SChuck Lever for (i = 0; i < buflen; i++) 252a02d6926SChuck Lever if (buf[i] == ':') 25390100b17SStanislav Kinsbursky return rpc_pton6(net, buf, buflen, sap, salen); 254a02d6926SChuck Lever return rpc_pton4(buf, buflen, sap, salen); 255a02d6926SChuck Lever } 256a02d6926SChuck Lever EXPORT_SYMBOL_GPL(rpc_pton); 257a02d6926SChuck Lever 258a02d6926SChuck Lever /** 259a02d6926SChuck Lever * rpc_sockaddr2uaddr - Construct a universal address string from @sap. 260a02d6926SChuck Lever * @sap: socket address 261d77385f2STrond Myklebust * @gfp_flags: allocation mode 262a02d6926SChuck Lever * 263a02d6926SChuck Lever * Returns a %NUL-terminated string in dynamically allocated memory; 264a02d6926SChuck Lever * otherwise NULL is returned if an error occurred. Caller must 265a02d6926SChuck Lever * free the returned string. 266a02d6926SChuck Lever */ 267d77385f2STrond Myklebust char *rpc_sockaddr2uaddr(const struct sockaddr *sap, gfp_t gfp_flags) 268a02d6926SChuck Lever { 269a02d6926SChuck Lever char portbuf[RPCBIND_MAXUADDRPLEN]; 270a02d6926SChuck Lever char addrbuf[RPCBIND_MAXUADDRLEN]; 271a02d6926SChuck Lever unsigned short port; 272a02d6926SChuck Lever 273a02d6926SChuck Lever switch (sap->sa_family) { 274a02d6926SChuck Lever case AF_INET: 275a02d6926SChuck Lever if (rpc_ntop4(sap, addrbuf, sizeof(addrbuf)) == 0) 276a02d6926SChuck Lever return NULL; 277a02d6926SChuck Lever port = ntohs(((struct sockaddr_in *)sap)->sin_port); 278a02d6926SChuck Lever break; 279a02d6926SChuck Lever case AF_INET6: 280a02d6926SChuck Lever if (rpc_ntop6_noscopeid(sap, addrbuf, sizeof(addrbuf)) == 0) 281a02d6926SChuck Lever return NULL; 282a02d6926SChuck Lever port = ntohs(((struct sockaddr_in6 *)sap)->sin6_port); 283a02d6926SChuck Lever break; 284a02d6926SChuck Lever default: 285a02d6926SChuck Lever return NULL; 286a02d6926SChuck Lever } 287a02d6926SChuck Lever 288a02d6926SChuck Lever if (snprintf(portbuf, sizeof(portbuf), 289a02d6926SChuck Lever ".%u.%u", port >> 8, port & 0xff) > (int)sizeof(portbuf)) 290a02d6926SChuck Lever return NULL; 291a02d6926SChuck Lever 292a02d6926SChuck Lever if (strlcat(addrbuf, portbuf, sizeof(addrbuf)) > sizeof(addrbuf)) 293a02d6926SChuck Lever return NULL; 294a02d6926SChuck Lever 295d77385f2STrond Myklebust return kstrdup(addrbuf, gfp_flags); 296a02d6926SChuck Lever } 297a02d6926SChuck Lever 298a02d6926SChuck Lever /** 299a02d6926SChuck Lever * rpc_uaddr2sockaddr - convert a universal address to a socket address. 300f2ac4dc9SStanislav Kinsbursky * @net: applicable network namespace 301a02d6926SChuck Lever * @uaddr: C string containing universal address to convert 302a02d6926SChuck Lever * @uaddr_len: length of universal address string 303a02d6926SChuck Lever * @sap: buffer into which to plant socket address 304a02d6926SChuck Lever * @salen: size of buffer 305a02d6926SChuck Lever * 3061e360a60SChuck Lever * @uaddr does not have to be '\0'-terminated, but strict_strtoul() and 3071e360a60SChuck Lever * rpc_pton() require proper string termination to be successful. 3081e360a60SChuck Lever * 309a02d6926SChuck Lever * Returns the size of the socket address if successful; otherwise 310a02d6926SChuck Lever * zero is returned. 311a02d6926SChuck Lever */ 312f2ac4dc9SStanislav Kinsbursky size_t rpc_uaddr2sockaddr(struct net *net, const char *uaddr, 313f2ac4dc9SStanislav Kinsbursky const size_t uaddr_len, struct sockaddr *sap, 314f2ac4dc9SStanislav Kinsbursky const size_t salen) 315a02d6926SChuck Lever { 3161e360a60SChuck Lever char *c, buf[RPCBIND_MAXUADDRLEN + sizeof('\0')]; 317a02d6926SChuck Lever unsigned long portlo, porthi; 318a02d6926SChuck Lever unsigned short port; 319a02d6926SChuck Lever 3201e360a60SChuck Lever if (uaddr_len > RPCBIND_MAXUADDRLEN) 321a02d6926SChuck Lever return 0; 322a02d6926SChuck Lever 323a02d6926SChuck Lever memcpy(buf, uaddr, uaddr_len); 324a02d6926SChuck Lever 3251e360a60SChuck Lever buf[uaddr_len] = '\0'; 326a02d6926SChuck Lever c = strrchr(buf, '.'); 327a02d6926SChuck Lever if (unlikely(c == NULL)) 328a02d6926SChuck Lever return 0; 329a02d6926SChuck Lever if (unlikely(strict_strtoul(c + 1, 10, &portlo) != 0)) 330a02d6926SChuck Lever return 0; 331a02d6926SChuck Lever if (unlikely(portlo > 255)) 332a02d6926SChuck Lever return 0; 333a02d6926SChuck Lever 3341e360a60SChuck Lever *c = '\0'; 335a02d6926SChuck Lever c = strrchr(buf, '.'); 336a02d6926SChuck Lever if (unlikely(c == NULL)) 337a02d6926SChuck Lever return 0; 338a02d6926SChuck Lever if (unlikely(strict_strtoul(c + 1, 10, &porthi) != 0)) 339a02d6926SChuck Lever return 0; 340a02d6926SChuck Lever if (unlikely(porthi > 255)) 341a02d6926SChuck Lever return 0; 342a02d6926SChuck Lever 343a02d6926SChuck Lever port = (unsigned short)((porthi << 8) | portlo); 344a02d6926SChuck Lever 3451e360a60SChuck Lever *c = '\0'; 346f2ac4dc9SStanislav Kinsbursky if (rpc_pton(net, buf, strlen(buf), sap, salen) == 0) 347a02d6926SChuck Lever return 0; 348a02d6926SChuck Lever 349a02d6926SChuck Lever switch (sap->sa_family) { 350a02d6926SChuck Lever case AF_INET: 351a02d6926SChuck Lever ((struct sockaddr_in *)sap)->sin_port = htons(port); 352a02d6926SChuck Lever return sizeof(struct sockaddr_in); 353a02d6926SChuck Lever case AF_INET6: 354a02d6926SChuck Lever ((struct sockaddr_in6 *)sap)->sin6_port = htons(port); 355a02d6926SChuck Lever return sizeof(struct sockaddr_in6); 356a02d6926SChuck Lever } 357a02d6926SChuck Lever 358a02d6926SChuck Lever return 0; 359a02d6926SChuck Lever } 360a02d6926SChuck Lever EXPORT_SYMBOL_GPL(rpc_uaddr2sockaddr); 361