chiark / gitweb /
Fix typo in changelog entry for 1.6.1
[adns.git] / src / addrfam.c
1 /*
2  * addrfam.c
3  * - address-family specific code
4  */
5 /*
6  *  This file is part of adns, which is Copyright Ian Jackson
7  *  and contributors (see the file INSTALL for full details).
8  *  
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License as published by
11  *  the Free Software Foundation; either version 3, or (at your option)
12  *  any later version.
13  *  
14  *  This program is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *  GNU General Public License for more details.
18  *  
19  *  You should have received a copy of the GNU General Public License
20  *  along with this program; if not, write to the Free Software Foundation.
21  */
22
23 #include <stdlib.h>
24 #include <errno.h>
25 #include <limits.h>
26 #include <unistd.h>
27 #include <inttypes.h>
28 #include <stddef.h>
29 #include <stdbool.h>
30
31 #include <sys/types.h>
32 #include <sys/socket.h>
33 #include <netinet/in.h>
34 #include <arpa/inet.h>
35 #include <net/if.h>
36
37 #include "internal.h"
38
39 /*
40  * General address-family operations.
41  */
42
43 #define SIN(cnst, sa) ((void)(sa)->sa_family, (cnst struct sockaddr_in *)(sa))
44 #define SIN6(cnst, sa) ((void)(sa)->sa_family, (cnst struct sockaddr_in6 *)(sa))
45
46 static void unknown_af(int af) NONRETURNING;
47 static void unknown_af(int af) {
48   fprintf(stderr, "ADNS INTERNAL: unknown address family %d\n", af);
49   abort();
50 }
51
52 /*
53  * SOCKADDR_IN_IN6(CNST, struct sockaddr *sa, SIN, {
54  *     // struct sockaddr_in *const SIN; // implicitly
55  *     code for inet;
56  *   }, {
57  *     // struct sockaddr_in6 *const SIN6; // implicitly
58  *     code for inet6;
59  *   })
60  *
61  * SOCKADDR_IN_IN6_PAIR(CNST, struct sockaddr *sa, SINA,
62  *                            struct sockaddr *sb, SINB, {
63  *     // struct sockaddr_in *const SINA; // implicitly
64  *     // struct sockaddr_in *const SINB; // implicitly
65  *     code for inet;
66  *   },{
67  *     // struct sockaddr_in6 *const SINA6; // implicitly
68  *     // struct sockaddr_in6 *const SINB6; // implicitly
69  *     code for inet6;
70  *   });
71  *
72  * SOCKADDR_IN_IN6_OTHER(CNST, struct sockaddr *sa, SIN, { in }, { in6 }, {
73  *     code for other address family
74  *   })
75  *
76  * AF_IN_IN6_OTHER(af, { in }, { in6 }, { other })
77  *
78  * Executes the first or second block according to the AF in sa.  CNST
79  * may be `const' or empty.  For _PAIR, sa and sb must be same AF.
80  *
81  * All except _OTHER handle unknown AFs with unknown_af.
82  *
83  * Code blocks may not contain , outside parens.
84  */
85 #define AF_IN_IN6_OTHER(af, for_inet, for_inet6, other) \
86   if ((af) == AF_INET) {                                        \
87     for_inet                                                    \
88   } else if ((af) == AF_INET6) {                                \
89     for_inet6                                                   \
90   } else {                                                      \
91     other                                                       \
92   }
93 #define SOCKADDR_IN_IN6_OTHER(cnst, sa, sin, for_inet, for_inet6, other) \
94   AF_IN_IN6_OTHER((sa)->sa_family, {                                    \
95       cnst struct sockaddr_in *const sin = SIN(cnst,(sa));              \
96       for_inet                                                          \
97   }, {                                                                  \
98       cnst struct sockaddr_in6 *const sin##6 = SIN6(cnst,(sa));         \
99       for_inet6                                                         \
100   },                                                                    \
101     other                                                               \
102   )
103 #define SOCKADDR_IN_IN6(cnst, sa, sin, for_inet, for_inet6)             \
104   SOCKADDR_IN_IN6_OTHER(cnst, sa, sin, for_inet, for_inet6, {   \
105       unknown_af((sa)->sa_family);                                      \
106   })
107 #define SOCKADDR_IN_IN6_PAIR(cnst, sa, sina, sb, sinb, for_inet, for_inet6) \
108   do{                                                                   \
109     assert((sa)->sa_family == (sb)->sa_family);                         \
110     SOCKADDR_IN_IN6(cnst, sa, sina, {                                   \
111         cnst struct sockaddr_in *const sinb = SIN(cnst,(sb));           \
112         for_inet                                                        \
113       }, {                                                              \
114         cnst struct sockaddr_in6 *const sinb##6 = SIN6(cnst,(sb));      \
115         for_inet6                                                       \
116     });                                                                 \
117   }while(0)
118
119 int adns__addrs_equal_raw(const struct sockaddr *a,
120                          int bf, const void *b) {
121   if (a->sa_family != bf) return 0;
122
123   SOCKADDR_IN_IN6(const, a, sin, {
124     return sin->sin_addr.s_addr == ((const struct in_addr*)b)->s_addr;
125   }, {
126     return !memcmp(&sin6->sin6_addr, b, sizeof(struct in6_addr));
127   });
128 }
129
130 int adns__addrs_equal(const adns_sockaddr *a, const adns_sockaddr *b) {
131   return adns__addrs_equal_raw(&a->sa, b->sa.sa_family,
132                                adns__sockaddr_addr(&b->sa));
133 }
134
135 int adns__sockaddrs_equal(const struct sockaddr *sa,
136                           const struct sockaddr *sb) {
137   if (!adns__addrs_equal_raw(sa, sb->sa_family, adns__sockaddr_addr(sb)))
138     return 0;
139   SOCKADDR_IN_IN6_PAIR(const, sa, sina, sb, sinb, {
140       return sina->sin_port == sinb->sin_port;
141     }, {
142       return sina6->sin6_port == sinb6->sin6_port &&
143              sina6->sin6_scope_id == sinb6->sin6_scope_id;
144     });
145 }
146
147 int adns__addr_width(int af) {
148   AF_IN_IN6_OTHER(af, {
149       return 32;
150     }, {
151       return 128;
152     }, {
153       unknown_af(af);
154     });
155 }
156
157 void adns__prefix_mask(adns_sockaddr *sa, int len) {
158   SOCKADDR_IN_IN6(, &sa->sa, sin, {
159       assert(len <= 32);
160       sin->sin_addr.s_addr= htonl(!len ? 0 : 0xffffffff << (32-len));
161     }, {
162       int i= len/8;
163       int j= len%8;
164       unsigned char *m= sin6->sin6_addr.s6_addr;
165       assert(len <= 128);
166       memset(m, 0xff, i);
167       if (j) m[i++]= (0xff << (8-j)) & 0xff;
168       memset(m+i, 0, 16-i);
169     });
170 }
171
172 int adns__guess_prefix_length(const adns_sockaddr *sa) {
173   SOCKADDR_IN_IN6(const, &sa->sa, sin, {
174       unsigned a= (ntohl(sin->sin_addr.s_addr) >> 24) & 0xff;
175       if (a < 128) return 8;
176       else if (a < 192) return 16;
177       else if (a < 224) return 24;
178       else return -1;
179     }, {
180       (void)sin6;
181       return 64;
182     });
183 }
184
185 int adns__addr_matches(int af, const void *addr,
186                        const adns_sockaddr *base, const adns_sockaddr *mask)
187 {
188   if (af != base->sa.sa_family) return 0;
189   SOCKADDR_IN_IN6_PAIR(const, &base->sa, sbase, &mask->sa, smask, {
190       const struct in_addr *v4 = addr;
191       return (v4->s_addr & smask->sin_addr.s_addr)
192         == sbase->sin_addr.s_addr;
193     }, {
194       int i;
195       const char *a= addr;
196       const char *b= sbase6->sin6_addr.s6_addr;
197       const char *m= smask6->sin6_addr.s6_addr;
198       for (i = 0; i < 16; i++)
199         if ((a[i] & m[i]) != b[i]) return 0;
200       return 1;
201     });
202 }
203
204 const void *adns__sockaddr_addr(const struct sockaddr *sa) {
205   SOCKADDR_IN_IN6(const, sa, sin, {
206       return &sin->sin_addr;
207     }, {
208       return &sin6->sin6_addr;
209     });
210 }
211
212 void adns__addr_inject(const void *a, adns_sockaddr *sa) {
213   SOCKADDR_IN_IN6( , &sa->sa, sin, {
214       memcpy(&sin->sin_addr, a, sizeof(sin->sin_addr));
215     }, {
216       memcpy(&sin6->sin6_addr, a, sizeof(sin6->sin6_addr));
217     });
218 }
219
220 /*
221  * addr2text and text2addr
222  */
223
224 #define ADDRFAM_DEBUG
225 #ifdef ADDRFAM_DEBUG
226 static void af_debug_func(const char *fmt, ...) {
227   int esave= errno;
228   va_list al;
229   va_start(al,fmt);
230   vfprintf(stderr,fmt,al);
231   va_end(al);
232   errno= esave;
233 }
234 # define af_debug(fmt,...) \
235   (af_debug_func("%s: " fmt "\n", __func__, __VA_ARGS__))
236 #else
237 # define af_debug(fmt,...) ((void)("" fmt "", __VA_ARGS__))
238 #endif
239
240 static bool addrtext_our_errno(int e) {
241   return
242     e==EAFNOSUPPORT ||
243     e==EINVAL ||
244     e==ENOSPC ||
245     e==ENOSYS;
246 }
247
248 static bool addrtext_scope_use_ifname(const struct sockaddr *sa) {
249   const struct in6_addr *in6= &SIN6(const,sa)->sin6_addr;
250   return
251     IN6_IS_ADDR_LINKLOCAL(in6) ||
252     IN6_IS_ADDR_MC_LINKLOCAL(in6);
253 }
254
255 static int textaddr_check_qf(adns_queryflags flags) {
256   if (flags & ~(adns_queryflags)(adns_qf_addrlit_scope_forbid|
257                                  adns_qf_addrlit_scope_numeric|
258                                  adns_qf_addrlit_ipv4_quadonly|
259                                  0x40000000))
260     return ENOSYS;
261   return 0;
262 }
263
264 int adns_text2addr(const char *text, uint16_t port, adns_queryflags flags,
265                    struct sockaddr *sa, socklen_t *salen_io) {
266   int r, af;
267   char copybuf[INET6_ADDRSTRLEN];
268   const char *parse=text;
269   const char *scopestr=0;
270   socklen_t needlen;
271   void *dst;
272   uint16_t *portp;
273
274   r= textaddr_check_qf(flags);  if (r) return r;
275
276 #define INVAL(how) do{                          \
277   af_debug("invalid: %s: `%s'", how, text);     \
278   return EINVAL;                                \
279 }while(0)
280
281 #define AFCORE(INETx,SINx,sinx)                 \
282     af= AF_##INETx;                             \
283     dst = &SINx(,sa)->sinx##_addr;              \
284     portp = &SINx(,sa)->sinx##_port;            \
285     needlen= sizeof(*SINx(,sa));
286
287   if (!strchr(text, ':')) { /* INET */
288
289     AFCORE(INET,SIN,sin);
290
291   } else { /* INET6 */
292
293     AFCORE(INET6,SIN6,sin6);
294
295     const char *percent= strchr(text, '%');
296     if (percent) {
297       ptrdiff_t lhslen = percent - text;
298       if (lhslen >= INET6_ADDRSTRLEN) INVAL("scoped addr lhs too long");
299       memcpy(copybuf, text, lhslen);
300       copybuf[lhslen]= 0;
301
302       parse= copybuf;
303       scopestr= percent+1;
304
305       af_debug("will parse scoped addr `%s' %% `%s'", parse, scopestr);
306     }
307
308   }
309
310 #undef AFCORE
311
312   if (scopestr && (flags & adns_qf_addrlit_scope_forbid))
313     INVAL("scoped addr but _scope_forbid");
314
315   if (*salen_io < needlen) {
316     *salen_io = needlen;
317     return ENOSPC;
318   }
319
320   memset(sa, 0, needlen);
321
322   sa->sa_family= af;
323   *portp = htons(port);
324
325   if (af == AF_INET && !(flags & adns_qf_addrlit_ipv4_quadonly)) {
326     /* we have to use inet_aton to deal with non-dotted-quad literals */
327     int r= inet_aton(parse,&SIN(,sa)->sin_addr);
328     if (!r) INVAL("inet_aton rejected");
329   } else {
330     int r= inet_pton(af,parse,dst);
331     if (!r) INVAL("inet_pton rejected");
332     assert(r>0);
333   }
334
335   if (scopestr) {
336     errno=0;
337     char *ep;
338     unsigned long scope= strtoul(scopestr,&ep,10);
339     if (errno==ERANGE) INVAL("numeric scope id too large for unsigned long");
340     assert(!errno);
341     if (!*ep) {
342       if (scope > ~(uint32_t)0)
343         INVAL("numeric scope id too large for uint32_t");
344     } else { /* !!*ep */
345       if (flags & adns_qf_addrlit_scope_numeric)
346         INVAL("non-numeric scope but _scope_numeric");
347       if (!addrtext_scope_use_ifname(sa)) {
348         af_debug("cannot convert non-numeric scope"
349                  " in non-link-local addr `%s'", text);
350         return ENOSYS;
351       }
352       errno= 0;
353       scope= if_nametoindex(scopestr);
354       if (!scope) {
355         /* RFC3493 says "No errors are defined".  It's not clear
356          * whether that is supposed to mean if_nametoindex "can't
357          * fail" (other than by the supplied name not being that of an
358          * interface) which seems unrealistic, or that it conflates
359          * all its errors together by failing to set errno, or simply
360          * that they didn't bother to document the errors.
361          *
362          * glibc, FreeBSD and OpenBSD all set errno (to ENXIO when
363          * appropriate).  See Debian bug #749349.
364          *
365          * We attempt to deal with this by clearing errno to start
366          * with, and then perhaps mapping the results. */
367         af_debug("if_nametoindex rejected scope name (errno=%s)",
368                  strerror(errno));
369         if (errno==0) {
370           return ENXIO;
371         } else if (addrtext_our_errno(errno)) {
372           /* we use these for other purposes, urgh. */
373           perror("adns: adns_text2addr: if_nametoindex"
374                  " failed with unexpected error");
375           return EIO;
376         } else {
377           return errno;
378         }
379       } else { /* ix>0 */
380         if (scope > ~(uint32_t)0) {
381           fprintf(stderr,"adns: adns_text2addr: if_nametoindex"
382                   " returned an interface index >=2^32 which will not fit"
383                   " in sockaddr_in6.sin6_scope_id");
384           return EIO;
385         }
386       }
387     } /* else; !!*ep */
388
389     SIN6(,sa)->sin6_scope_id= scope;
390   } /* if (scopestr) */
391
392   *salen_io = needlen;
393   return 0;
394 }
395
396 int adns_addr2text(const struct sockaddr *sa, adns_queryflags flags,
397                    char *buffer, int *buflen_io, int *port_r) {
398   const void *src;
399   int r, port;
400
401   r= textaddr_check_qf(flags);  if (r) return r;
402
403   if (*buflen_io < ADNS_ADDR2TEXT_BUFLEN) {
404     *buflen_io = ADNS_ADDR2TEXT_BUFLEN;
405     return ENOSPC;
406   }
407
408   SOCKADDR_IN_IN6_OTHER(const, sa, sin, {
409       src= &sin->sin_addr;    port= sin->sin_port;
410     }, {
411       src= &sin6->sin6_addr;  port= sin6->sin6_port;
412     }, {
413       return EAFNOSUPPORT;
414     });
415
416   const char *ok= inet_ntop(sa->sa_family, src, buffer, *buflen_io);
417   assert(ok);
418
419   if (sa->sa_family == AF_INET6) {
420     uint32_t scope = SIN6(const,sa)->sin6_scope_id;
421     if (scope) {
422       if (flags & adns_qf_addrlit_scope_forbid)
423         return EINVAL;
424       int scopeoffset = strlen(buffer);
425       int remain = *buflen_io - scopeoffset;
426       char *scopeptr =  buffer + scopeoffset;
427       assert(remain >= IF_NAMESIZE+1/*%*/);
428       *scopeptr++= '%'; remain--;
429       bool parsedname = 0;
430       af_debug("will print scoped addr `%.*s' %% %"PRIu32"",
431                scopeoffset,buffer, scope);
432       if (scope <= UINT_MAX /* so we can pass it to if_indextoname */
433           && !(flags & adns_qf_addrlit_scope_numeric)
434           && addrtext_scope_use_ifname(sa)) {
435         parsedname = if_indextoname(scope, scopeptr);
436         if (!parsedname) {
437           af_debug("if_indextoname rejected scope (errno=%s)",
438                    strerror(errno));
439           if (errno==ENXIO) {
440             /* fair enough, show it as a number then */
441           } else if (addrtext_our_errno(errno)) {
442             /* we use these for other purposes, urgh. */
443             perror("adns: adns_addr2text: if_indextoname"
444                    " failed with unexpected error");
445             return EIO;
446           } else {
447             return errno;
448           }
449         }
450       }
451       if (!parsedname) {
452         int r = snprintf(scopeptr, remain,
453                          "%"PRIu32"", scope);
454         assert(r < *buflen_io - scopeoffset);
455       }
456       af_debug("printed scoped addr `%s'", buffer);
457     }
458   }
459
460   if (port_r) *port_r= ntohs(port);
461   return 0;
462 }
463
464 char *adns__sockaddr_ntoa(const struct sockaddr *sa, char *buf) {
465   int err;
466   int len= ADNS_ADDR2TEXT_BUFLEN;
467
468   err= adns_addr2text(sa, 0, buf, &len, 0);
469   if (err == EIO)
470     err= adns_addr2text(sa, adns_qf_addrlit_scope_numeric, buf, &len, 0);
471   assert(!err);
472   return buf;
473 }
474
475 /*
476  * Reverse-domain parsing and construction.
477  */
478
479 int adns__make_reverse_domain(const struct sockaddr *sa, const char *zone,
480                               char **buf_io, size_t bufsz,
481                               char **buf_free_r) {
482   size_t req;
483   char *p;
484   unsigned c, y;
485   unsigned long aa;
486   const unsigned char *ap;
487   int i, j;
488
489   AF_IN_IN6_OTHER(sa->sa_family, {
490       req= 4 * 4;
491       if (!zone) zone= "in-addr.arpa";
492     }, {
493       req = 2 * 32;
494       if (!zone) zone= "ip6.arpa";
495     }, {
496       return ENOSYS;
497     });
498
499   req += strlen(zone) + 1;
500   if (req <= bufsz)
501     p= *buf_io;
502   else {
503     p= malloc(req); if (!p) return errno;
504     *buf_free_r = p;
505   }
506
507   *buf_io= p;
508   SOCKADDR_IN_IN6(const, sa, sin, {
509       aa= ntohl(sin->sin_addr.s_addr);
510       for (i=0; i<4; i++) {
511         p += sprintf(p, "%d", (int)(aa & 0xff));
512         *p++= '.';
513         aa >>= 8;
514       }
515     }, {
516       ap= sin6->sin6_addr.s6_addr + 16;
517       for (i=0; i<16; i++) {
518         c= *--ap;
519         for (j=0; j<2; j++) {
520           y= c & 0xf;
521           *p++= (y < 10) ? y + '0' : y - 10 + 'a';
522           c >>= 4;
523           *p++= '.';
524         }
525       }
526     });
527
528   strcpy(p, zone);
529   return 0;
530 }
531
532
533 #define REVPARSE_P_L(labnum)                    \
534   const char *p= dgram + rps->labstart[labnum]; \
535   int l= rps->lablen[labnum]
536   /*
537    * REVPARSE_P_L(int labnum);
538    *   expects:
539    *     const char *dgram;
540    *     const struct revparse_state *rps;
541    *   produces:
542    *     const char *p; // start of label labnum in dgram
543    *     int l; // length of label in dgram
544    */
545
546 static bool revparse_check_tail(struct revparse_state *rps,
547                                 const char *dgram, int nlabels,
548                                 int bodylen, const char *inarpa) {
549   int i;
550
551   if (nlabels != bodylen+2) return 0;
552   for (i=0; i<2; i++) {
553     REVPARSE_P_L(bodylen+i);
554     const char *want= !i ? inarpa : "arpa";
555     if (!adns__labels_equal(p,l, want,strlen(want))) return 0;
556   }
557   return 1;
558 }
559
560 static bool revparse_atoi(const char *p, int l, int base,
561                           unsigned max, unsigned *v_r) {
562   if (l>3) return 0;
563   if (l>1 && p[0]=='0') return 0;
564   unsigned v=0;
565   while (l-- > 0) {
566     int tv;
567     int c= ctype_toupper(*p++);
568     if ('0'<=c && c<='9') tv = c-'0';
569     else if ('A'<=c && c<='Z') tv = c-'A'+10;
570     else return 0;
571     if (tv >= base) return 0;
572     v *= base;
573     v += tv;
574   }
575   if (v>max) return 0;
576   *v_r= v;
577   return 1;
578 }
579
580 static bool revparse_inet(struct revparse_state *rps,
581                           const char *dgram, int nlabels,
582                           adns_rrtype *rrtype_r, adns_sockaddr *addr_r) {
583   if (!revparse_check_tail(rps,dgram,nlabels,4,"in-addr")) return 0;
584
585   uint32_t a=0;
586   int i;
587   for (i=3; i>=0; i--) {
588     REVPARSE_P_L(i);
589     unsigned v;
590     if (!revparse_atoi(p,l,10,255,&v)) return 0;
591     a <<= 8;
592     a |= v;
593   }
594   *rrtype_r= adns_r_a;
595   addr_r->inet.sin_family= AF_INET;
596   addr_r->inet.sin_addr.s_addr= htonl(a);
597   return 1;
598 }
599
600 static bool revparse_inet6(struct revparse_state *rps,
601                            const char *dgram, int nlabels,
602                            adns_rrtype *rrtype_r, adns_sockaddr *addr_r) {
603   if (!revparse_check_tail(rps,dgram,nlabels,32,"ip6")) return 0;
604
605   int i, j;
606   memset(addr_r,0,sizeof(*addr_r));
607   unsigned char *a= addr_r->inet6.sin6_addr.s6_addr+16;
608   for (i=0; i<32; ) { /* i incremented in inner loop */
609     unsigned b=0;
610     for (j=0; j<2; j++, i++) {
611       REVPARSE_P_L(i);
612       unsigned v;
613       if (!revparse_atoi(p,l,16,15,&v)) return 0;
614       b >>= 4;
615       b |= v << 4;
616     }
617     *--a= b;
618   }
619   *rrtype_r= adns_r_aaaa;
620   addr_r->inet.sin_family= AF_INET6;
621   return 1;
622 }
623
624 bool adns__revparse_label(struct revparse_state *rps, int labnum,
625                           const char *dgram, int labstart, int lablen) {
626   if (labnum >= MAXREVLABELS)
627     return 0;
628
629   assert(labstart <= 65535);
630   assert(lablen <= 255);
631   rps->labstart[labnum] = labstart;
632   rps->lablen[labnum] = lablen;
633   return 1;
634 }
635
636 bool adns__revparse_done(struct revparse_state *rps,
637                          const char *dgram, int nlabels,
638                          adns_rrtype *rrtype_r, adns_sockaddr *addr_r) {
639   return
640     revparse_inet(rps,dgram,nlabels,rrtype_r,addr_r) ||
641     revparse_inet6(rps,dgram,nlabels,rrtype_r,addr_r);
642 }