SourceFormat Enforcement

[thirdparty/squid.git] / include / rfc1035.h

diff --git a/include/rfc1035.h b/include/rfc1035.h
index 348eeb9357c4dfb3fff6c8cce33e91424a37048b..cd6783cf2a9288d9cdd6b18a127bf9898c00c822 100644 (file)
--- a/include/rfc1035.h
+++ b/include/rfc1035.h
@@ -1,36 +1,14 @@
 /*
- * $Id: rfc1035.h,v 1.4 2000/07/18 06:47:06 wessels Exp $
+ * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
  *
- * AUTHOR: Duane Wessels
- *
- * SQUID Internet Object Cache  http://squid.nlanr.net/Squid/
- * --------------------------------------------------------
- *
- *  Squid is the result of efforts by numerous individuals from the
- *  Internet community.  Development is led by Duane Wessels of the
- *  National Laboratory for Applied Network Research and funded by
- *  the National Science Foundation.
- *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- *  
- *  This program 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 General Public License for more details.
- *  
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
- *  
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
  */
 
-#ifndef _RFC1035_H_
-#define _RFC1035_H_
+#ifndef SQUID_RFC1035_H
+#define SQUID_RFC1035_H
 
-#include "config.h"
 #if HAVE_SYS_TYPES_H
 #include <sys/types.h>
 #endif
@@ -41,34 +19,95 @@
 #include <arpa/inet.h>
 #endif
 
-/* rfc1035 - DNS */
-#define RFC1035_MAXHOSTNAMESZ 128
+#include "rfc2181.h"
+
+/**
+ \par RFC 1035 Section 3.1:
+ *  To simplify implementations, the total length of a domain name (i.e.,
+ *  label octets and label length octets) is restricted to 255 octets or
+ *  less.
+ *\par
+ *  Clarified by RFC 2181 Section 11. (RFC2181_MAXHOSTNAMELEN)
+ */
+#define RFC1035_MAXHOSTNAMESZ RFC2181_MAXHOSTNAMELEN
+
+#define RFC1035_DEFAULT_PACKET_SZ 512
+
 typedef struct _rfc1035_rr rfc1035_rr;
 struct _rfc1035_rr {
     char name[RFC1035_MAXHOSTNAMESZ];
     unsigned short type;
-    unsigned short class;
+    unsigned short _class;
     unsigned int ttl;
     unsigned short rdlength;
     char *rdata;
 };
-extern unsigned short rfc1035BuildAQuery(const char *hostname,
-    char *buf,
-    size_t * szp);
-extern unsigned short rfc1035BuildPTRQuery(const struct in_addr,
-    char *buf,
-    size_t * szp);
-extern unsigned short rfc1035RetryQuery(char *);
-extern int rfc1035AnswersUnpack(const char *buf,
-    size_t sz,
-    rfc1035_rr ** records,
-    unsigned short *id);
-extern void rfc1035RRDestroy(rfc1035_rr * rr, int n);
-extern int rfc1035_errno;
-extern const char *rfc1035_error_message;
+
+typedef struct _rfc1035_query rfc1035_query;
+struct _rfc1035_query {
+    char name[RFC1035_MAXHOSTNAMESZ];
+    unsigned short qtype;
+    unsigned short qclass;
+};
+
+typedef struct _rfc1035_message rfc1035_message;
+struct _rfc1035_message {
+    unsigned short id;
+    unsigned int qr:1;
+    unsigned int opcode:4;
+    unsigned int aa:1;
+    unsigned int tc:1;
+    unsigned int rd:1;
+    unsigned int ra:1;
+    unsigned int rcode:4;
+    unsigned short qdcount;
+    unsigned short ancount;
+    unsigned short nscount;
+    unsigned short arcount;
+    rfc1035_query *query;
+    rfc1035_rr *answer;
+};
+
+SQUIDCEXTERN ssize_t rfc1035BuildAQuery(const char *hostname,
+                                        char *buf,
+                                        size_t sz,
+                                        unsigned short qid,
+                                        rfc1035_query * query,
+                                        ssize_t edns_sz);
+SQUIDCEXTERN ssize_t rfc1035BuildPTRQuery(const struct in_addr,
+        char *buf,
+        size_t sz,
+        unsigned short qid,
+        rfc1035_query * query,
+        ssize_t edns_sz);
+SQUIDCEXTERN void rfc1035SetQueryID(char *, unsigned short qid);
+SQUIDCEXTERN int rfc1035MessageUnpack(const char *buf,
+                                      size_t sz,
+                                      rfc1035_message ** answer);
+SQUIDCEXTERN int rfc1035QueryCompare(const rfc1035_query *, const rfc1035_query *);
+SQUIDCEXTERN void rfc1035RRDestroy(rfc1035_rr ** rr, int n);
+SQUIDCEXTERN void rfc1035MessageDestroy(rfc1035_message ** message);
+SQUIDCEXTERN const char * rfc1035ErrorMessage(int n);
 
 #define RFC1035_TYPE_A 1
+#define RFC1035_TYPE_CNAME 5
 #define RFC1035_TYPE_PTR 12
 #define RFC1035_CLASS_IN 1
 
-#endif /* ndef _RFC1035_H_ */
+/* Child Library RFC3596 Depends on some otherwise internal functions */
+SQUIDCEXTERN int rfc1035HeaderPack(char *buf,
+                                   size_t sz,
+                                   rfc1035_message * hdr);
+SQUIDCEXTERN int rfc1035HeaderUnpack(const char *buf,
+                                     size_t sz,
+                                     unsigned int *off,
+                                     rfc1035_message * h);
+SQUIDCEXTERN int rfc1035QuestionPack(char *buf,
+                                     size_t sz,
+                                     const char *name,
+                                     const unsigned short type,
+                                     const unsigned short _class);
+SQUIDCEXTERN int rfc1035RRPack(char *buf, size_t sz, const rfc1035_rr * RR);
+
+#endif /* SQUID_RFC1035_H */
+