include/rfc1035.h

   1 /*
   2  * Copyright (C) 1996-2014 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 #ifndef SQUID_RFC1035_H
  10 #define SQUID_RFC1035_H
  11
  12 #if HAVE_SYS_TYPES_H
  13 #include <sys/types.h>
  14 #endif
  15 #if HAVE_NETINET_IN_H
  16 #include <netinet/in.h>
  17 #endif
  18 #if HAVE_ARPA_INET_H
  19 #include <arpa/inet.h>
  20 #endif
  21
  22 #include "rfc2181.h"
  23
  24 /**
  25  \par RFC 1035 Section 3.1:
  26  *  To simplify implementations, the total length of a domain name (i.e.,
  27  *  label octets and label length octets) is restricted to 255 octets or
  28  *  less.
  29  *\par
  30  *  Clarified by RFC 2181 Section 11. (RFC2181_MAXHOSTNAMELEN)
  31  */
  32 #define RFC1035_MAXHOSTNAMESZ RFC2181_MAXHOSTNAMELEN
  33
  34 #define RFC1035_DEFAULT_PACKET_SZ 512
  35
  36 typedef struct _rfc1035_rr rfc1035_rr;
  37 struct _rfc1035_rr {
  38     char name[RFC1035_MAXHOSTNAMESZ];
  39     unsigned short type;
  40     unsigned short _class;
  41     unsigned int ttl;
  42     unsigned short rdlength;
  43     char *rdata;
  44 };
  45
  46 typedef struct _rfc1035_query rfc1035_query;
  47 struct _rfc1035_query {
  48     char name[RFC1035_MAXHOSTNAMESZ];
  49     unsigned short qtype;
  50     unsigned short qclass;
  51 };
  52
  53 typedef struct _rfc1035_message rfc1035_message;
  54 struct _rfc1035_message {
  55     unsigned short id;
  56     unsigned int qr:1;
  57     unsigned int opcode:4;
  58     unsigned int aa:1;
  59     unsigned int tc:1;
  60     unsigned int rd:1;
  61     unsigned int ra:1;
  62     unsigned int rcode:4;
  63     unsigned short qdcount;
  64     unsigned short ancount;
  65     unsigned short nscount;
  66     unsigned short arcount;
  67     rfc1035_query *query;
  68     rfc1035_rr *answer;
  69 };
  70
  71 SQUIDCEXTERN ssize_t rfc1035BuildAQuery(const char *hostname,
  72                                         char *buf,
  73                                         size_t sz,
  74                                         unsigned short qid,
  75                                         rfc1035_query * query,
  76                                         ssize_t edns_sz);
  77 SQUIDCEXTERN ssize_t rfc1035BuildPTRQuery(const struct in_addr,
  78         char *buf,
  79         size_t sz,
  80         unsigned short qid,
  81         rfc1035_query * query,
  82         ssize_t edns_sz);
  83 SQUIDCEXTERN void rfc1035SetQueryID(char *, unsigned short qid);
  84 SQUIDCEXTERN int rfc1035MessageUnpack(const char *buf,
  85                                       size_t sz,
  86                                       rfc1035_message ** answer);
  87 SQUIDCEXTERN int rfc1035QueryCompare(const rfc1035_query *, const rfc1035_query *);
  88 SQUIDCEXTERN void rfc1035RRDestroy(rfc1035_rr ** rr, int n);
  89 SQUIDCEXTERN void rfc1035MessageDestroy(rfc1035_message ** message);
  90 SQUIDCEXTERN const char * rfc1035ErrorMessage(int n);
  91
  92 #define RFC1035_TYPE_A 1
  93 #define RFC1035_TYPE_CNAME 5
  94 #define RFC1035_TYPE_PTR 12
  95 #define RFC1035_CLASS_IN 1
  96
  97 /* Child Library RFC3596 Depends on some otherwise internal functions */
  98 SQUIDCEXTERN int rfc1035HeaderPack(char *buf,
  99                                    size_t sz,
 100                                    rfc1035_message * hdr);
 101 SQUIDCEXTERN int rfc1035HeaderUnpack(const char *buf,
 102                                      size_t sz,
 103                                      unsigned int *off,
 104                                      rfc1035_message * h);
 105 SQUIDCEXTERN int rfc1035QuestionPack(char *buf,
 106                                      size_t sz,
 107                                      const char *name,
 108                                      const unsigned short type,
 109                                      const unsigned short _class);
 110 SQUIDCEXTERN int rfc1035RRPack(char *buf, size_t sz, const rfc1035_rr * RR);
 111
 112 #endif /* SQUID_RFC1035_H */