]> git.ipfire.org Git - thirdparty/glibc.git/blobdiff - inet/getnameinfo.c
Update copyright dates with scripts/update-copyrights.
[thirdparty/glibc.git] / inet / getnameinfo.c
index 709f9ecbfe5663f3ec92825af7677497400f6816..a20d20b7cd52fbf191b79a190a42cf7e78f5d9d3 100644 (file)
@@ -1,3 +1,21 @@
+/* Convert socket address to string using Name Service Switch modules.
+   Copyright (C) 1997-2018 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
+
+   The GNU C Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   The GNU C Library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, see
+   <http://www.gnu.org/licenses/>.  */
+
 /* The Inner Net License, Version 2.00
 
   The author(s) grant permission for redistribution and use in source and
@@ -15,14 +33,7 @@ provided that the following conditions are met:
 3. Redistributions in binary form must reproduce the authors' copyright
    notice(s), this list of conditions, and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
-4. All advertising materials mentioning features or use of this software
-   must display the following acknowledgement with the name(s) of the
-   authors as specified in the copyright notice(s) substituted where
-   indicated:
-
-       This product includes software developed by <name(s)>, The Inner
-       Net, and other contributors.
-
+4. [The copyright holder has authorized the removal of this clause.]
 5. Neither the name(s) of the author(s) nor the names of its contributors
    may be used to endorse or promote products derived from this software
    without specific prior written permission.
@@ -42,31 +53,39 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 /* This software is Copyright 1996 by Craig Metz, All Rights Reserved.  */
 
-#include <sys/types.h>
-#include <sys/socket.h>
-
-#include <netinet/in.h>
-#include <sys/un.h>
-#include <sys/utsname.h>
-#include <netdb.h>
 #include <errno.h>
-#include <string.h>
+#include <netdb.h>
+#include <stddef.h>
+#include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <unistd.h>
-#include <alloca.h>
-#include <bits/libc-lock.h>
+#include <stdint.h>
 #include <arpa/inet.h>
+#include <net/if.h>
+#include <netinet/in.h>
+#include <sys/param.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <sys/un.h>
+#include <sys/utsname.h>
+#include <libc-lock.h>
+#include <scratch_buffer.h>
+
+#ifdef HAVE_LIBIDN
+# include <idna.h>
+#endif
 
 #ifndef min
 # define min(x,y) (((x) > (y)) ? (y) : (x))
 #endif /* min */
 
+libc_freeres_ptr (static char *domain);
+
 
 static char *
-internal_function
 nrl_domainname (void)
 {
-  static char *domain;
   static int not_first;
 
   if (! not_first)
@@ -78,19 +97,20 @@ nrl_domainname (void)
        {
          char *c;
          struct hostent *h, th;
-         size_t tmpbuflen = 1024;
-         char *tmpbuf = alloca (tmpbuflen);
          int herror;
+         struct scratch_buffer tmpbuf;
 
+         scratch_buffer_init (&tmpbuf);
          not_first = 1;
 
-         while (__gethostbyname_r ("localhost", &th, tmpbuf, tmpbuflen, &h,
-                                   &herror))
+         while (__gethostbyname_r ("localhost", &th,
+                                   tmpbuf.data, tmpbuf.length,
+                                   &h, &herror))
            {
              if (herror == NETDB_INTERNAL && errno == ERANGE)
                {
-                 tmpbuflen *= 2;
-                 tmpbuf = alloca (tmpbuflen);
+                 if (!scratch_buffer_grow (&tmpbuf))
+                   goto done;
                }
              else
                break;
@@ -102,26 +122,25 @@ nrl_domainname (void)
            {
              /* The name contains no domain information.  Use the name
                 now to get more information.  */
-             while (__gethostname (tmpbuf, tmpbuflen))
-               {
-                 tmpbuflen *= 2;
-                 tmpbuf = alloca (tmpbuflen);
-               }
+             while (__gethostname (tmpbuf.data, tmpbuf.length))
+               if (!scratch_buffer_grow (&tmpbuf))
+                 goto done;
 
-             if ((c = strchr (tmpbuf, '.')))
+             if ((c = strchr (tmpbuf.data, '.')))
                domain = __strdup (++c);
              else
                {
                  /* We need to preserve the hostname.  */
-                 const char *hstname = strdupa (tmpbuf);
+                 const char *hstname = strdupa (tmpbuf.data);
 
-                 while (__gethostbyname_r (hstname, &th, tmpbuf, tmpbuflen,
+                 while (__gethostbyname_r (hstname, &th,
+                                           tmpbuf.data, tmpbuf.length,
                                            &h, &herror))
                    {
                      if (herror == NETDB_INTERNAL && errno == ERANGE)
                        {
-                         tmpbuflen *= 2;
-                         tmpbuf = alloca (tmpbuflen);
+                         if (!scratch_buffer_grow (&tmpbuf))
+                           goto done;
                        }
                      else
                        break;
@@ -133,17 +152,18 @@ nrl_domainname (void)
                    {
                      struct in_addr in_addr;
 
-                     in_addr.s_addr = htonl (0x7f000001);
+                     in_addr.s_addr = htonl (INADDR_LOOPBACK);
 
                      while (__gethostbyaddr_r ((const char *) &in_addr,
                                                sizeof (struct in_addr),
-                                               AF_INET, &th, tmpbuf,
-                                               tmpbuflen, &h, &herror))
+                                               AF_INET, &th,
+                                               tmpbuf.data, tmpbuf.length,
+                                               &h, &herror))
                        {
                          if (herror == NETDB_INTERNAL && errno == ERANGE)
                            {
-                             tmpbuflen *= 2;
-                             tmpbuf = alloca (tmpbuflen);
+                             if (!scratch_buffer_grow (&tmpbuf))
+                               goto done;
                            }
                          else
                            break;
@@ -154,6 +174,8 @@ nrl_domainname (void)
                    }
                }
            }
+       done:
+         scratch_buffer_free (&tmpbuf);
        }
 
       __libc_lock_unlock (lock);
@@ -162,196 +184,377 @@ nrl_domainname (void)
   return domain;
 };
 
+/* Copy a string to a destination buffer with length checking.  Return
+   EAI_OVERFLOW if the buffer is not large enough, and 0 on
+   success.  */
+static int
+checked_copy (char *dest, size_t destlen, const char *source)
+{
+  size_t source_length = strlen (source);
+  if (source_length + 1 > destlen)
+    return EAI_OVERFLOW;
+  memcpy (dest, source, source_length + 1);
+  return 0;
+}
 
-int
-getnameinfo (const struct sockaddr *sa, socklen_t addrlen, char *host,
-            size_t hostlen, char *serv, size_t servlen, int flags)
+/* Helper function for CHECKED_SNPRINTF below.  */
+static int
+check_sprintf_result (int result, size_t destlen)
+{
+  if (result < 0)
+    return EAI_SYSTEM;
+  if ((size_t) result >= destlen)
+    /* If ret == destlen, there was no room for the terminating NUL
+       character.  */
+    return EAI_OVERFLOW;
+  return 0;
+}
+
+/* Format a string in the destination buffer.  Return 0 on success,
+   EAI_OVERFLOW in case the buffer is too small, or EAI_SYSTEM on any
+   other error.  */
+#define CHECKED_SNPRINTF(dest, destlen, format, ...)                   \
+  check_sprintf_result                                                 \
+    (__snprintf (dest, destlen, format, __VA_ARGS__), destlen)
+
+/* Convert host name, AF_INET/AF_INET6 case, name only.  */
+static int
+gni_host_inet_name (struct scratch_buffer *tmpbuf,
+                   const struct sockaddr *sa, socklen_t addrlen,
+                   char *host, socklen_t hostlen, int flags)
 {
-  int serrno = errno;
-  int tmpbuflen = 1024;
   int herrno;
-  char *tmpbuf = alloca (tmpbuflen);
   struct hostent th;
-
-  if (sa == NULL)
-    return -1;
-
-  if (host != NULL && hostlen > 0)
-    switch(sa->sa_family)
-      {
-      case AF_INET:
-      case AF_INET6:
-       if (!(flags & NI_NUMERICHOST))
+  struct hostent *h = NULL;
+  if (sa->sa_family == AF_INET6)
+    {
+      const struct sockaddr_in6 *sin6p = (const struct sockaddr_in6 *) sa;
+      while (__gethostbyaddr_r (&sin6p->sin6_addr, sizeof(struct in6_addr),
+                               AF_INET6, &th, tmpbuf->data, tmpbuf->length,
+                               &h, &herrno))
+       if (herrno == NETDB_INTERNAL && errno == ERANGE)
          {
-           struct hostent *h = NULL;
-           if (h == NULL)
+           if (!scratch_buffer_grow (tmpbuf))
              {
-               if (sa->sa_family == AF_INET6)
-                 {
-                   while (__gethostbyaddr_r ((void *) &(((struct sockaddr_in6 *) sa)->sin6_addr),
-                                             sizeof(struct in6_addr),
-                                             AF_INET6, &th, tmpbuf, tmpbuflen,
-                                             &h, &herrno))
-                     {
-                       if (herrno == NETDB_INTERNAL)
-                         {
-                           if (errno == ERANGE)
-                             {
-                               tmpbuflen *= 2;
-                               tmpbuf = alloca (tmpbuflen);
-                             }
-                           else
-                             {
-                               __set_h_errno (herrno);
-                               __set_errno (serrno);
-                               return -1;
-                             }
-                         }
-                       else
-                         {
-                           break;
-                         }
-                     }
-                 }
-               else
-                 {
-                   while (__gethostbyaddr_r ((void *) &(((struct sockaddr_in *)sa)->sin_addr),
-                                             sizeof(struct in_addr), AF_INET,
-                                             &th, tmpbuf, tmpbuflen,
-                                             &h, &herrno))
-                     {
-                       if (errno == ERANGE)
-                         {
-                           tmpbuflen *= 2;
-                           tmpbuf = alloca (tmpbuflen);
-                         }
-                       else
-                         {
-                           break;
-                         }
-                     }
-                 }
-             }
-
-           if (h)
-             {
-               if (flags & NI_NOFQDN)
-                 {
-                   char *c;
-                   if ((c = nrl_domainname ()) && (c = strstr(h->h_name, c))
-                       && (c != h->h_name) && (*(--c) == '.'))
-                     {
-                       strncpy (host, h->h_name,
-                                min(hostlen, (size_t) (c - h->h_name)));
-                       host[min(hostlen - 1, (size_t) (c - h->h_name))]
-                         = '\0';
-                       break;
-                     }
-                 }
-               strncpy (host, h->h_name, hostlen);
-               break;
+               __set_h_errno (herrno);
+               return EAI_MEMORY;
              }
          }
-
-       if (flags & NI_NAMEREQD)
-         {
-           __set_errno (serrno);
-           return -1;
-         }
        else
-         {
-           const char *c;
-           if (sa->sa_family == AF_INET6)
-             c = inet_ntop (AF_INET6,
-                            (void *) &(((struct sockaddr_in6 *) sa)->sin6_addr),
-                            host, hostlen);
-           else
-             c = inet_ntop (AF_INET,
-                            (void *) &(((struct sockaddr_in *) sa)->sin_addr),
-                            host, hostlen);
-
-           if (c == NULL)
-             {
-               __set_errno (serrno);
-               return -1;
-             }
-         }
-       break;
+         break;
+    }
+  else
+    {
+      const struct sockaddr_in *sinp = (const struct sockaddr_in *) sa;
+      while (__gethostbyaddr_r (&sinp->sin_addr, sizeof(struct in_addr),
+                               AF_INET, &th, tmpbuf->data, tmpbuf->length,
+                               &h, &herrno))
+       if (herrno == NETDB_INTERNAL && errno == ERANGE)
+           {
+             if (!scratch_buffer_grow (tmpbuf))
+               {
+                 __set_h_errno (herrno);
+                 return EAI_MEMORY;
+               }
+           }
+       else
+         break;
+    }
 
-      case AF_LOCAL:
-       if (!(flags & NI_NUMERICHOST))
-         {
-           struct utsname utsname;
+  if (h == NULL)
+    {
+      if (herrno == NETDB_INTERNAL)
+       {
+         __set_h_errno (herrno);
+         return EAI_SYSTEM;
+       }
+      if (herrno == TRY_AGAIN)
+       {
+         __set_h_errno (herrno);
+         return EAI_AGAIN;
+       }
+    }
 
-           if (!uname (&utsname))
-             {
-               strncpy (host, utsname.nodename, hostlen);
-               break;
-             };
-         };
+  if (h)
+    {
+      char *c;
+      if ((flags & NI_NOFQDN)
+         && (c = nrl_domainname ())
+         && (c = strstr (h->h_name, c))
+         && (c != h->h_name) && (*(--c) == '.'))
+       /* Terminate the string after the prefix.  */
+       *c = '\0';
+
+#ifdef HAVE_LIBIDN
+      /* If requested, convert from the IDN format.  */
+      if (flags & NI_IDN)
+       {
+         int idn_flags = 0;
+         if  (flags & NI_IDN_ALLOW_UNASSIGNED)
+           idn_flags |= IDNA_ALLOW_UNASSIGNED;
+         if (flags & NI_IDN_USE_STD3_ASCII_RULES)
+           idn_flags |= IDNA_USE_STD3_ASCII_RULES;
+
+         char *out;
+         int rc = __idna_to_unicode_lzlz (h->h_name, &out,
+                                          idn_flags);
+         if (rc != IDNA_SUCCESS)
+           {
+             if (rc == IDNA_MALLOC_ERROR)
+               return EAI_MEMORY;
+             if (rc == IDNA_DLOPEN_ERROR)
+               return EAI_SYSTEM;
+             return EAI_IDN_ENCODE;
+           }
 
-       if (flags & NI_NAMEREQD)
-          {
-           __set_errno (serrno);
-           return -1;
-         }
+         if (out != h->h_name)
+           {
+             h->h_name = strdupa (out);
+             free (out);
+           }
+       }
+#endif
 
-       strncpy (host, "localhost", hostlen);
-       break;
+      size_t len = strlen (h->h_name) + 1;
+      if (len > hostlen)
+       return EAI_OVERFLOW;
 
-      default:
-        return -1;
+      memcpy (host, h->h_name, len);
+
+      return 0;
     }
 
-  if (serv && (servlen > 0))
-    switch(sa->sa_family)
-      {
-      case AF_INET:
-      case AF_INET6:
-       if (!(flags & NI_NUMERICSERV))
-         {
-           struct servent *s, ts;
-           while (__getservbyport_r (((struct sockaddr_in *) sa)->sin_port,
-                                     ((flags & NI_DGRAM) ? "udp" : "tcp"),
-                                     &ts, tmpbuf, tmpbuflen, &s))
-             {
-               if (herrno == NETDB_INTERNAL)
-                 {
-                   if (errno == ERANGE)
-                     {
-                       tmpbuflen *= 2;
-                       tmpbuf = __alloca (tmpbuflen);
-                     }
-                   else
-                     {
-                       __set_errno (serrno);
-                       return -1;
-                     }
-                 }
-               else
-                 {
-                   break;
-                 }
-             }
-           if (s)
-             {
-               strncpy (serv, s->s_name, servlen);
-               break;
-             }
-         }
-       __snprintf (serv, servlen, "%d",
-                   ntohs (((struct sockaddr_in *) sa)->sin_port));
-       break;
+  return EAI_NONAME;
+}
+
+/* Convert host name, AF_INET/AF_INET6 case, numeric conversion.  */
+static int
+gni_host_inet_numeric (struct scratch_buffer *tmpbuf,
+                      const struct sockaddr *sa, socklen_t addrlen,
+                      char *host, socklen_t hostlen, int flags)
+{
+  if (sa->sa_family == AF_INET6)
+    {
+      const struct sockaddr_in6 *sin6p = (const struct sockaddr_in6 *) sa;
+      if (inet_ntop (AF_INET6, &sin6p->sin6_addr, host, hostlen) == NULL)
+       return EAI_OVERFLOW;
+
+      uint32_t scopeid = sin6p->sin6_scope_id;
+      if (scopeid != 0)
+       {
+         size_t used_hostlen = __strnlen (host, hostlen);
+         /* Location of the scope string in the host buffer.  */
+         char *scope_start = host + used_hostlen;
+         size_t scope_length = hostlen - used_hostlen;
+
+         if (IN6_IS_ADDR_LINKLOCAL (&sin6p->sin6_addr)
+             || IN6_IS_ADDR_MC_LINKLOCAL (&sin6p->sin6_addr))
+           {
+             char scopebuf[IFNAMSIZ];
+             if (if_indextoname (scopeid, scopebuf) != NULL)
+               return CHECKED_SNPRINTF
+                 (scope_start, scope_length,
+                  "%c%s", SCOPE_DELIMITER, scopebuf);
+           }
+         return CHECKED_SNPRINTF
+           (scope_start, scope_length, "%c%u", SCOPE_DELIMITER, scopeid);
+       }
+    }
+  else
+    {
+      const struct sockaddr_in *sinp = (const struct sockaddr_in *) sa;
+      if (inet_ntop (AF_INET, &sinp->sin_addr, host, hostlen) == NULL)
+       return EAI_OVERFLOW;
+    }
+  return 0;
+}
+
+/* Convert AF_INET or AF_INET6 socket address, host part.  */
+static int
+gni_host_inet (struct scratch_buffer *tmpbuf,
+              const struct sockaddr *sa, socklen_t addrlen,
+              char *host, socklen_t hostlen, int flags)
+{
+  if (!(flags & NI_NUMERICHOST))
+    {
+      int result = gni_host_inet_name
+       (tmpbuf, sa, addrlen, host, hostlen, flags);
+      if (result != EAI_NONAME)
+       return result;
+    }
+
+  if (flags & NI_NAMEREQD)
+    return EAI_NONAME;
+  else
+    return gni_host_inet_numeric
+      (tmpbuf, sa, addrlen, host, hostlen, flags);
+}
+
+/* Convert AF_LOCAL socket address, host part.   */
+static int
+gni_host_local (struct scratch_buffer *tmpbuf,
+               const struct sockaddr *sa, socklen_t addrlen,
+               char *host, socklen_t hostlen, int flags)
+{
+  if (!(flags & NI_NUMERICHOST))
+    {
+      struct utsname utsname;
+      if (uname (&utsname) == 0)
+       return checked_copy (host, hostlen, utsname.nodename);
+    }
+
+  if (flags & NI_NAMEREQD)
+    return EAI_NONAME;
+
+  return checked_copy (host, hostlen, "localhost");
+}
 
-      case AF_LOCAL:
-       strncpy (serv, ((struct sockaddr_un *) sa)->sun_path, servlen);
-       break;
+/* Convert the host part of an AF_LOCAK socket address.   */
+static int
+gni_host (struct scratch_buffer *tmpbuf,
+         const struct sockaddr *sa, socklen_t addrlen,
+         char *host, socklen_t hostlen, int flags)
+{
+  switch (sa->sa_family)
+    {
+    case AF_INET:
+    case AF_INET6:
+      return gni_host_inet (tmpbuf, sa, addrlen, host, hostlen, flags);
+
+    case AF_LOCAL:
+      return gni_host_local (tmpbuf, sa, addrlen, host, hostlen, flags);
+
+    default:
+      return EAI_FAMILY;
+    }
+}
+
+/* Convert service to string, AF_INET and AF_INET6 variant.  */
+static int
+gni_serv_inet (struct scratch_buffer *tmpbuf,
+              const struct sockaddr *sa, socklen_t addrlen,
+              char *serv, socklen_t servlen, int flags)
+{
+  _Static_assert
+    (offsetof (struct sockaddr_in, sin_port)
+     == offsetof (struct sockaddr_in6, sin6_port)
+     && sizeof (((struct sockaddr_in) {}).sin_port) == sizeof (in_port_t)
+     && sizeof (((struct sockaddr_in6) {}).sin6_port) == sizeof (in_port_t),
+     "AF_INET and AF_INET6 port consistency");
+  const struct sockaddr_in *sinp = (const struct sockaddr_in *) sa;
+  if (!(flags & NI_NUMERICSERV))
+    {
+      struct servent *s, ts;
+      int e;
+      while ((e = __getservbyport_r (sinp->sin_port,
+                                    ((flags & NI_DGRAM)
+                                     ? "udp" : "tcp"), &ts,
+                                    tmpbuf->data, tmpbuf->length, &s)))
+       {
+         if (e == ERANGE)
+           {
+             if (!scratch_buffer_grow (tmpbuf))
+               return EAI_MEMORY;
+           }
+         else
+           break;
+       }
+      if (s)
+       return checked_copy (serv, servlen, s->s_name);
+      /* Fall through to numeric conversion.  */
+    }
+  return CHECKED_SNPRINTF (serv, servlen, "%d", ntohs (sinp->sin_port));
+}
+
+/* Convert service to string, AF_LOCAL variant.  */
+static int
+gni_serv_local (struct scratch_buffer *tmpbuf,
+              const struct sockaddr *sa, socklen_t addrlen,
+              char *serv, socklen_t servlen, int flags)
+{
+  return checked_copy
+    (serv, servlen, ((const struct sockaddr_un *) sa)->sun_path);
+}
+
+/* Convert service to string, dispatching to the implementations
+   above.  */
+static int
+gni_serv (struct scratch_buffer *tmpbuf,
+         const struct sockaddr *sa, socklen_t addrlen,
+         char *serv, socklen_t servlen, int flags)
+{
+  switch (sa->sa_family)
+    {
+    case AF_INET:
+    case AF_INET6:
+      return gni_serv_inet (tmpbuf, sa, addrlen, serv, servlen, flags);
+    case AF_LOCAL:
+      return gni_serv_local (tmpbuf, sa, addrlen, serv, servlen, flags);
+    default:
+      return EAI_FAMILY;
+    }
+}
+
+int
+getnameinfo (const struct sockaddr *sa, socklen_t addrlen, char *host,
+            socklen_t hostlen, char *serv, socklen_t servlen,
+            int flags)
+{
+  if (flags & ~(NI_NUMERICHOST|NI_NUMERICSERV|NI_NOFQDN|NI_NAMEREQD|NI_DGRAM
+#ifdef HAVE_LIBIDN
+               |NI_IDN|NI_IDN_ALLOW_UNASSIGNED|NI_IDN_USE_STD3_ASCII_RULES
+#endif
+               ))
+    return EAI_BADFLAGS;
+
+  if (sa == NULL || addrlen < sizeof (sa_family_t))
+    return EAI_FAMILY;
+
+  if ((flags & NI_NAMEREQD) && host == NULL && serv == NULL)
+    return EAI_NONAME;
+
+  switch (sa->sa_family)
+    {
+    case AF_LOCAL:
+      if (addrlen < (socklen_t) offsetof (struct sockaddr_un, sun_path))
+       return EAI_FAMILY;
+      break;
+    case AF_INET:
+      if (addrlen < sizeof (struct sockaddr_in))
+       return EAI_FAMILY;
+      break;
+    case AF_INET6:
+      if (addrlen < sizeof (struct sockaddr_in6))
+       return EAI_FAMILY;
+      break;
+    default:
+      return EAI_FAMILY;
+    }
+
+  struct scratch_buffer tmpbuf;
+  scratch_buffer_init (&tmpbuf);
+
+  if (host != NULL && hostlen > 0)
+    {
+      int result = gni_host (&tmpbuf, sa, addrlen, host, hostlen, flags);
+      if (result != 0)
+       {
+         scratch_buffer_free (&tmpbuf);
+         return result;
+       }
     }
 
-  if (host && (hostlen > 0))
-    host[hostlen-1] = 0;
   if (serv && (servlen > 0))
-    serv[servlen-1] = 0;
-  errno = serrno;
+    {
+      int result = gni_serv (&tmpbuf, sa, addrlen, serv, servlen, flags);
+      if (result != 0)
+       {
+         scratch_buffer_free (&tmpbuf);
+         return result;
+       }
+    }
+
+  scratch_buffer_free (&tmpbuf);
   return 0;
 }
+libc_hidden_def (getnameinfo)