ares_expand_name.c

   1 /* $Id$ */
   2
   3 /* Copyright 1998 by the Massachusetts Institute of Technology.
   4  *
   5  * Permission to use, copy, modify, and distribute this
   6  * software and its documentation for any purpose and without
   7  * fee is hereby granted, provided that the above copyright
   8  * notice appear in all copies and that both that copyright
   9  * notice and this permission notice appear in supporting
  10  * documentation, and that the name of M.I.T. not be used in
  11  * advertising or publicity pertaining to distribution of the
  12  * software without specific, written prior permission.
  13  * M.I.T. makes no representations about the suitability of
  14  * this software for any purpose.  It is provided "as is"
  15  * without express or implied warranty.
  16  */
  17
  18 #include "setup.h"
  19
  20 #ifdef HAVE_SYS_SOCKET_H
  21 #  include <sys/socket.h>
  22 #endif
  23 #ifdef HAVE_NETINET_IN_H
  24 #  include <netinet/in.h>
  25 #endif
  26 #ifdef HAVE_ARPA_NAMESER_H
  27 #  include <arpa/nameser.h>
  28 #else
  29 #  include "nameser.h"
  30 #endif
  31 #ifdef HAVE_ARPA_NAMESER_COMPAT_H
  32 #  include <arpa/nameser_compat.h>
  33 #endif
  34
  35 #include <stdlib.h>
  36 #include "ares.h"
  37 #include "ares_private.h" /* for the memdebug */
  38
  39 static int name_length(const unsigned char *encoded, const unsigned char *abuf,
  40                        int alen);
  41
  42 /* Expand an RFC1035-encoded domain name given by encoded.  The
  43  * containing message is given by abuf and alen.  The result given by
  44  * *s, which is set to a NUL-terminated allocated buffer.  *enclen is
  45  * set to the length of the encoded name (not the length of the
  46  * expanded name; the goal is to tell the caller how many bytes to
  47  * move forward to get past the encoded name).
  48  *
  49  * In the simple case, an encoded name is a series of labels, each
  50  * composed of a one-byte length (limited to values between 0 and 63
  51  * inclusive) followed by the label contents.  The name is terminated
  52  * by a zero-length label.
  53  *
  54  * In the more complicated case, a label may be terminated by an
  55  * indirection pointer, specified by two bytes with the high bits of
  56  * the first byte (corresponding to INDIR_MASK) set to 11.  With the
  57  * two high bits of the first byte stripped off, the indirection
  58  * pointer gives an offset from the beginning of the containing
  59  * message with more labels to decode.  Indirection can happen an
  60  * arbitrary number of times, so we have to detect loops.
  61  *
  62  * Since the expanded name uses '.' as a label separator, we use
  63  * backslashes to escape periods or backslashes in the expanded name.
  64  */
  65
  66 int ares_expand_name(const unsigned char *encoded, const unsigned char *abuf,
  67                      int alen, char **s, long *enclen)
  68 {
  69   int len, indir = 0;
  70   char *q;
  71   const unsigned char *p;
  72
  73   len = name_length(encoded, abuf, alen);
  74   if (len == -1)
  75     return ARES_EBADNAME;
  76
  77   *s = malloc(len + 1);
  78   if (!*s)
  79     return ARES_ENOMEM;
  80   q = *s;
  81
  82   if (len == 0) {
  83     /* RFC2181 says this should be ".": the root of the DNS tree.
  84      * Since this function strips trailing dots though, it becomes ""
  85      */
  86     q[0] = '\0';
  87     *enclen = 1;  /* the caller should move one byte to get past this */
  88     return ARES_SUCCESS;
  89   }
  90
  91   /* No error-checking necessary; it was all done by name_length(). */
  92   p = encoded;
  93   while (*p)
  94     {
  95       if ((*p & INDIR_MASK) == INDIR_MASK)
  96         {
  97           if (!indir)
  98             {
  99               *enclen = p + 2 - encoded;
 100               indir = 1;
 101             }
 102           p = abuf + ((*p & ~INDIR_MASK) << 8 | *(p + 1));
 103         }
 104       else
 105         {
 106           len = *p;
 107           p++;
 108           while (len--)
 109             {
 110               if (*p == '.' || *p == '\\')
 111                 *q++ = '\\';
 112               *q++ = *p;
 113               p++;
 114             }
 115           *q++ = '.';
 116         }
 117     }
 118   if (!indir)
 119     *enclen = p + 1 - encoded;
 120
 121   /* Nuke the trailing period if we wrote one. */
 122   if (q > *s)
 123     *(q - 1) = 0;
 124   else
 125     *q = 0; /* zero terminate */
 126
 127   return ARES_SUCCESS;
 128 }
 129
 130 /* Return the length of the expansion of an encoded domain name, or
 131  * -1 if the encoding is invalid.
 132  */
 133 static int name_length(const unsigned char *encoded, const unsigned char *abuf,
 134                        int alen)
 135 {
 136   int n = 0, offset, indir = 0;
 137
 138   /* Allow the caller to pass us abuf + alen and have us check for it. */
 139   if (encoded == abuf + alen)
 140     return -1;
 141
 142   while (*encoded)
 143     {
 144       if ((*encoded & INDIR_MASK) == INDIR_MASK)
 145         {
 146           /* Check the offset and go there. */
 147           if (encoded + 1 >= abuf + alen)
 148             return -1;
 149           offset = (*encoded & ~INDIR_MASK) << 8 | *(encoded + 1);
 150           if (offset >= alen)
 151             return -1;
 152           encoded = abuf + offset;
 153
 154           /* If we've seen more indirects than the message length,
 155            * then there's a loop.
 156            */
 157           if (++indir > alen)
 158             return -1;
 159         }
 160       else
 161         {
 162           offset = *encoded;
 163           if (encoded + offset + 1 >= abuf + alen)
 164             return -1;
 165           encoded++;
 166           while (offset--)
 167             {
 168               n += (*encoded == '.' || *encoded == '\\') ? 2 : 1;
 169               encoded++;
 170             }
 171           n++;
 172         }
 173     }
 174
 175   /* If there were any labels at all, then the number of dots is one
 176    * less than the number of labels, so subtract one.
 177    */
 178   return (n) ? n - 1 : n;
 179 }