include/rfc1035.h

   1 /*
   2  * $Id: rfc1035.h,v 1.20 2008/01/11 03:49:20 amosjeffries Exp $
   3  *
   4  * AUTHOR: Duane Wessels
   5  *
   6  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   7  * ----------------------------------------------------------
   8  *
   9  *  Squid is the result of efforts by numerous individuals from
  10  *  the Internet community; see the CONTRIBUTORS file for full
  11  *  details.   Many organizations have provided support for Squid's
  12  *  development; see the SPONSORS file for full details.  Squid is
  13  *  Copyrighted (C) 2001 by the Regents of the University of
  14  *  California; see the COPYRIGHT file for full details.  Squid
  15  *  incorporates software developed and/or copyrighted by other
  16  *  sources; see the CREDITS file for full details.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify
  19  *  it under the terms of the GNU General Public License as published by
  20  *  the Free Software Foundation; either version 2 of the License, or
  21  *  (at your option) any later version.
  22  *
  23  *  This program is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with this program; if not, write to the Free Software
  30  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  31  *
  32  */
  33 #ifndef SQUID_RFC1035_H
  34 #define SQUID_RFC1035_H
  35
  36 #include "config.h"
  37
  38 #if HAVE_SYS_TYPES_H
  39 #include <sys/types.h>
  40 #endif
  41 #if HAVE_NETINET_IN_H
  42 #include <netinet/in.h>
  43 #endif
  44 #if HAVE_ARPA_INET_H
  45 #include <arpa/inet.h>
  46 #endif
  47
  48 #include "rfc2181.h"
  49
  50 /**
  51  \par RFC 1035 Section 3.1:
  52  *  To simplify implementations, the total length of a domain name (i.e.,
  53  *  label octets and label length octets) is restricted to 255 octets or
  54  *  less.
  55  *\par
  56  *  Clarified by RFC 2181 Section 11. (RFC2181_MAXHOSTNAMELEN)
  57  */
  58 #define RFC1035_MAXHOSTNAMESZ RFC2181_MAXHOSTNAMELEN
  59
  60
  61 typedef struct _rfc1035_rr rfc1035_rr;
  62 struct _rfc1035_rr {
  63     char name[RFC1035_MAXHOSTNAMESZ];
  64     unsigned short type;
  65     unsigned short _class;
  66     unsigned int ttl;
  67     unsigned short rdlength;
  68     char *rdata;
  69 };
  70
  71 typedef struct _rfc1035_query rfc1035_query;
  72 struct _rfc1035_query {
  73     char name[RFC1035_MAXHOSTNAMESZ];
  74     unsigned short qtype;
  75     unsigned short qclass;
  76 };
  77
  78 typedef struct _rfc1035_message rfc1035_message;
  79 struct _rfc1035_message {
  80     unsigned short id;
  81     unsigned int qr:1;
  82     unsigned int opcode:4;
  83     unsigned int aa:1;
  84     unsigned int tc:1;
  85     unsigned int rd:1;
  86     unsigned int ra:1;
  87     unsigned int rcode:4;
  88     unsigned short qdcount;
  89     unsigned short ancount;
  90     unsigned short nscount;
  91     unsigned short arcount;
  92     rfc1035_query *query;
  93     rfc1035_rr *answer;
  94 };
  95
  96 SQUIDCEXTERN ssize_t rfc1035BuildAQuery(const char *hostname,
  97                                         char *buf,
  98                                         size_t sz,
  99                                         unsigned short qid,
 100                                         rfc1035_query * query);
 101 SQUIDCEXTERN ssize_t rfc1035BuildPTRQuery(const struct in_addr,
 102         char *buf,
 103         size_t sz,
 104         unsigned short qid,
 105         rfc1035_query * query);
 106 SQUIDCEXTERN void rfc1035SetQueryID(char *, unsigned short qid);
 107 SQUIDCEXTERN int rfc1035MessageUnpack(const char *buf,
 108                                       size_t sz,
 109                                       rfc1035_message ** answer);
 110 SQUIDCEXTERN int rfc1035QueryCompare(const rfc1035_query *, const rfc1035_query *);
 111 SQUIDCEXTERN void rfc1035RRDestroy(rfc1035_rr ** rr, int n);
 112 SQUIDCEXTERN void rfc1035MessageDestroy(rfc1035_message ** message);
 113 SQUIDCEXTERN int rfc1035_errno;
 114 SQUIDCEXTERN const char *rfc1035_error_message;
 115
 116 #define RFC1035_TYPE_A 1
 117 #define RFC1035_TYPE_CNAME 5
 118 #define RFC1035_TYPE_PTR 12
 119 #define RFC1035_CLASS_IN 1
 120
 121
 122 /* Child Library RFC3596 Depends on some otherwise internal functions */
 123 SQUIDCEXTERN int rfc1035HeaderPack(char *buf,
 124                                    size_t sz,
 125                                    rfc1035_message * hdr);
 126 SQUIDCEXTERN int rfc1035HeaderUnpack(const char *buf,
 127                                      size_t sz,
 128                                      unsigned int *off,
 129                                      rfc1035_message * h);
 130 SQUIDCEXTERN int rfc1035QuestionPack(char *buf,
 131                                      size_t sz,
 132                                      const char *name,
 133                                      const unsigned short type,
 134                                      const unsigned short _class);
 135
 136 #endif /* SQUID_RFC1035_H */