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