chiark / gitweb /
Parsing code revamped, not compiled yet.
[adns.git] / src / internal.h
index bf6d3ac3aa44fa5518238fc5d67bae46e20be097..1eecc60d3f47099d7e64649d6060732b1691d1a5 100644 (file)
@@ -22,12 +22,21 @@ typedef unsigned char byte;
 #define TCPMS 30000
 #define LOCALRESOURCEMS 20
 
-#define DNS_UDPPORT 53
+#define DNS_PORT 53
 #define DNS_MAXUDP 512
 #define DNS_MAXDOMAIN 255
 #define DNS_HDRSIZE 12
 #define DNS_CLASS_IN 1
 
+typedef enum {
+  rcode_noerror,
+  rcode_formaterror,
+  rcode_servfail,
+  rcode_nxdomain,
+  rcode_notimp,
+  rcode_refused
+} dns_rcode;
+
 /* Shared data structures */
 
 typedef union {
@@ -49,27 +58,54 @@ typedef union {
   int dmaddr_index;
 } qcontext;
 
+typedef struct {
+  adns_rrtype type;
+  int rrsz;
+  adns_status (*parse)(adns_state ads, adns_query qu, int serv, vbuf *vb,
+                      const byte *dgram, int dglen, int cbyte, int max,
+                      void *store_r);
+  /* Parse one RR, in dgram of length dglen, starting at cbyte and
+   * extending until at most max.
+   *
+   * The RR should be stored at *store_r, of length qu->typei->rrsz.
+   *
+   * If there is an overrun which might indicate truncation, it should set
+   * *rdstart to -1; otherwise it may set it to anything else positive.
+   *
+   * This function may use vb (which has been initialised) however it likes.
+   */
+} typeinfo;
+
 struct adns__query {
   /* FIXME: make sure this is all init'd properly */
   enum { query_udp, query_tcpwait, query_tcpsent, query_child, query_done } state;
   adns_query back, next, parent;
   struct { adns_query head, tail; } children;
   struct { adns_query back, next; } siblings;
-  adns_rrtype type;
-  vbuf ans;
+  
+  const typeinfo *typei;
+  
+#error make sure all this is init'd properly
+#error make sure all this is freed properly
+  byte *querymsg;
+  int querylen;
+  
+  vbuf ansbuf; /* Used for answer RRs */
+  char *cname_str; 
+  byte *cname_dgram;
+  int cname_dglen, cname_begin;
+  
   int id, flags, udpretries;
   int udpnextserver;
   unsigned long udpsent, tcpfailed; /* bitmap indexed by server */
   struct timeval timeout;
-  byte *querymsg;
-  int querylen;
   qcontext context;
   char owner[1];
   /* After the owner name and nul comes the query message, pointed to by querymsg */
 
   /* Possible states:
    *
-   *  state   Queue   child  id   answer    nextudpserver  sentudp     failedtcp
+   *  state   Queue   child  id   ansbuf    nextudpserver  sentudp     failedtcp
    *
    *  udp     NONE    null   >=0  null      0              zero        zero
    *  udp     timew   null   >=0  null      any            nonzero     zero
@@ -138,11 +174,16 @@ struct adns__state {
 
 void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
                 int serv, const char *fmt, va_list al);
-void adns__debug(adns_state ads, int serv, const char *fmt, ...) PRINTFFORMAT(3,4);
-void adns__warn(adns_state ads, int serv, const char *fmt, ...) PRINTFFORMAT(3,4);
-void adns__diag(adns_state ads, int serv, const char *fmt, ...) PRINTFFORMAT(3,4);
+
+void adns__debug(adns_state ads, int serv, adns_query qu,
+                const char *fmt, ...) PRINTFFORMAT(3,4);
+void adns__warn(adns_state ads, int serv, adns_query qu,
+               const char *fmt, ...) PRINTFFORMAT(3,4);
+void adns__diag(adns_state ads, int serv, adns_query qu,
+               const char *fmt, ...) PRINTFFORMAT(3,4);
 
 int adns__vbuf_ensure(vbuf *vb, int want);
+int adns__vbuf_appendstr(vbuf *vb, const char *data);
 int adns__vbuf_append(vbuf *vb, const byte *data, int len);
 /* 1=>success, 0=>realloc failed */
 void adns__vbuf_appendq(vbuf *vb, const byte *data, int len);
@@ -153,6 +194,7 @@ int adns__setnonblock(adns_state ads, int fd); /* => errno value */
 /* From submit.c: */
 
 void adns__query_nomem(adns_state ads, adns_query qu);
+void adns__query_finish(adns_state ads, adns_query qu, adns_status stat);
 void adns__query_fail(adns_state ads, adns_query qu, adns_status stat);
 
 /* From query.c: */
@@ -160,11 +202,103 @@ void adns__query_fail(adns_state ads, adns_query qu, adns_status stat);
 void adns__query_udp(adns_state ads, adns_query qu, struct timeval now);
 void adns__query_tcp(adns_state ads, adns_query qu, struct timeval now);
 adns_status adns__mkquery(adns_state ads, const char *owner, int ol, int id,
-                         adns_rrtype type, adns_queryflags flags);
+                         const typeinfo *typei, adns_queryflags flags);
 
 /* From reply.c: */
 
-void adns__procdgram(adns_state ads, const byte *dgram, int len, int serv);
+void adns__procdgram(adns_state ads, const byte *dgram, int len,
+                    int serv, struct timeval now);
+
+/* From types.c: */
+
+const typeinfo *adns__findtype(adns_rrtype type);
+
+/* From parse.c: */
+
+typedef struct {
+  adns_state ads, int serv;
+  const byte *dgram;
+  int dglen, max, cbyte, namelen;
+  int *dmend_rlater, *namelen_rlater;
+} findlabel_state;
+
+void adns__findlabel_start(findlabel_state *fls,
+                          adns_state ads, int serv,
+                          const byte *dgram, int dglen, int max,
+                          int dmbegin, int *dmend_rlater);
+/* Finds labels in a domain in a datagram.
+ *
+ * Call this routine first.
+ * endpoint_rlater may be null.
+ */
+
+adns_status adns__findlabel_next(findlabel_state *fls,
+                                int *lablen_r, int *labstart_r);
+/* Then, call this one repeatedly.
+ *
+ * It will return adns_s_ok if all is well, and tell you the length
+ * and start of successive labels.  labstart_r may be null, but
+ * lablen_r must not be.
+ *
+ * After the last label, it will return with *lablen_r zero.
+ * Do not then call it again; instead, just throw away the findlabel_state.
+ *
+ * *dmend_rlater will have been set to point to the next part of
+ * the datagram after the label (or after the uncompressed part,
+ * if compression was used).  *namelen_rlater will have been set
+ * to the length of the domain name (total length of labels plus
+ * 1 for each intervening dot).
+ *
+ * If the datagram appears to be truncated, *lablen_r will be -1.
+ * *dmend_rlater, *labstart_r and *namelen_r may contain garbage.
+ * Do not call _next again.
+ *
+ * There may also be errors, in which case *dmend_rlater,
+ * *namelen_rlater, *lablen_r and *labstart_r may contain garbage.
+ * Do not then call findlabel_next again.
+ */
+
+adns_status adns__parse_domain(adns_state ads, int serv, vbuf *vb,
+                              const byte *dgram, int dglen,
+                              int *cbyte_io, int max);
+/* vb must already have been initialised; it will be reset if necessary.
+ * If there is truncation, vb->used will be set to 0; otherwise
+ * (if there is no error) vb will be null-terminated.
+ * If there is an error vb and *cbyte_io may be left indeterminate.
+ */
+
+adns_status adns__findrr(adns_state ads, int serv,
+                        const byte *dgram, int dglen, int *cbyte_io,
+                        int *type_r, int *class_r, int *rdlen_r, int *rdstart_r,
+                        const byte *eo_dgram, int eo_dglen, int eo_cbyte,
+                        int *eo_matched_r);
+  /* Finds the extent and some of the contents of an RR in a datagram
+   * and does some checks.  The datagram is *dgram, length dglen, and
+   * the RR starts at *cbyte_io (which is updated afterwards to point
+   * to the end of the RR).
+   *
+   * The type, class and RRdata length and start are returned iff
+   * the corresponding pointer variables are not null.  type_r and
+   * class_r may not be null.
+   *
+   * If the caller thinks they know what the owner of the RR ought to
+   * be they can pass in details in eo_*: this is another (or perhaps
+   * the same datagram), and a pointer to where the putative owner
+   * starts in that datagram.  In this case *eo_matched_r will be set
+   * to 1 if the datagram matched or 0 if it did not.  Either
+   * both eo_dgram and eo_matched_r must both be non-null, or they
+   * must both be null (in which case eo_dglen and eo_cbyte will be ignored).
+   * The eo datagram and contained owner domain MUST be valid and
+   * untruncated.
+   *
+   * If there is truncation then *type_r will be set to -1 and
+   * *cbyte_io, *class_r, *rdlen_r, *rdstart_r and *eo_matched_r will be
+   * undefined.
+   *
+   * If an error is returned then *type_r will be undefined too.
+   */
+
+int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
 
 /* From event.c: */
 
@@ -186,6 +320,9 @@ static inline void timevaladd(struct timeval *tv_io, long ms) {
 
 static inline int ctype_whitespace(int c) { return c==' ' || c=='\n' || c=='\t'; }
 static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
+static inline int ctype_alpha(int c) {
+  return (c >= 'a' && c <= 'z') || (c >= 'A' || c <= 'Z');
+}
 
 /* Useful macros */
 
@@ -210,4 +347,8 @@ static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
 #define LIST_UNLINK(list,node) LIST_UNLINK_PART(list,node,)
 #define LIST_LINK_TAIL(list,node) LIST_LINK_TAIL_PART(list,node,)
 
+#define GETIL_B(cb) (dgram[(cb)++])
+#define GET_B(cb,tv) ((tv)= GETIL_B((cb)))
+#define GET_W(cb,tv) ((tv)=0, (tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv))
+
 #endif