-fix
[oweals/gnunet.git] / src / include / gnunet_dnsparser_lib.h
index ef2ec389f86f3603bfb1eb99f258c388c7d6af41..28cc4c0485b38bb27dce93139a60aaf1cc66b54a 100644 (file)
@@ -19,7 +19,7 @@
  */
 
 /**
- * @file include/gnunet_dnsparse_lib.h
+ * @file include/gnunet_dnsparser_lib.h
  * @brief API for helper library to parse DNS packets. 
  * @author Philipp Toelke
  * @author Christian Grothoff
@@ -41,8 +41,6 @@
 #define GNUNET_DNSPARSER_TYPE_MX 15
 #define GNUNET_DNSPARSER_TYPE_TXT 16
 #define GNUNET_DNSPARSER_TYPE_AAAA 28
-#define GNUNET_DNSPARSER_TYPE_IXFR 251
-#define GNUNET_DNSPARSER_TYPE_AXFR 252
 
 /**
  * A few common DNS classes (ok, only one is common, but I list a
@@ -130,7 +128,7 @@ struct GNUNET_DNSPARSER_Flags
    */
   unsigned int recursion_available  : 1 GNUNET_PACKED; 
   
-};
+} GNUNET_GCC_STRUCT_LAYOUT;
 
 
 /**
@@ -158,25 +156,127 @@ struct GNUNET_DNSPARSER_Query
 
 
 /**
- * A DNS response record.
+ * Information from MX records (RFC 1035).
  */
-struct GNUNET_DNSPARSER_Record
+struct GNUNET_DNSPARSER_MxRecord
 {
+  
+  /**
+   * Preference for this entry (lower value is higher preference).
+   */
+  uint16_t preference;
 
   /**
-   * Name of the record that the query is for (0-terminated).
+   * Name of the mail server.
    */
-  char *name;
+  char *mxhost;
+
+};
+
+  
+/**
+ * Information from SOA records (RFC 1035).
+ */
+struct GNUNET_DNSPARSER_SoaRecord
+{
+  
+  /**
+   *The domainname of the name server that was the
+   * original or primary source of data for this zone.
+   */
+  char *mname;
+
+  /**
+   * A domainname which specifies the mailbox of the
+   * person responsible for this zone.
+   */
+  char *rname;
+
+  /**
+   * The version number of the original copy of the zone.  
+   */
+  uint32_t serial;
+
+  /**
+   * Time interval before the zone should be refreshed.
+   */
+  uint32_t refresh;
 
   /**
-   * Raw data, NOT a 0-terminated string (at least not always).
+   * Time interval that should elapse before a failed refresh should
+   * be retried.
    */
-  char *data;
+  uint32_t retry;
+
+  /**
+   * Time value that specifies the upper limit on the time interval
+   * that can elapse before the zone is no longer authoritative.
+   */
+  uint32_t expire;
+
+  /**
+   * The bit minimum TTL field that should be exported with any RR
+   * from this zone.
+   */
+  uint32_t minimum_ttl;
+  
+};
+
+
+/**
+ * Binary record information (unparsed).
+ */
+struct GNUNET_DNSPARSER_RawRecord
+{
+
+  /**
+   * Binary record data.
+   */
+  void *data;
 
   /**
    * Number of bytes in data.
    */
   size_t data_len;
+};
+
+
+/**
+ * A DNS response record.
+ */
+struct GNUNET_DNSPARSER_Record
+{
+
+  /**
+   * Name of the record that the query is for (0-terminated).
+   */
+  char *name;
+
+  union 
+  {
+
+    /**
+     * For NS, CNAME and PTR records, this is the uncompressed 0-terminated hostname.
+     */
+    char *hostname;
+    
+    /**
+     * SOA data for SOA records.
+     */
+    struct GNUNET_DNSPARSER_SoaRecord *soa;
+    
+    /**
+     * MX data for MX records.
+     */
+    struct GNUNET_DNSPARSER_MxRecord *mx;
+
+    /**
+     * Raw data for all other types.
+     */
+    struct GNUNET_DNSPARSER_RawRecord raw;
+
+  } data;
+
 
   /**
    * When does the record expire?
@@ -280,6 +380,7 @@ GNUNET_DNSPARSER_free_packet (struct GNUNET_DNSPARSER_Packet *p);
  * Given a DNS packet, generate the corresponding UDP payload.
  *
  * @param p packet to pack
+ * @param max maximum allowed size for the resulting UDP payload
  * @param buf set to a buffer with the packed message
  * @param buf_length set to the length of buf
  * @return GNUNET_SYSERR if 'p' is invalid
@@ -287,102 +388,10 @@ GNUNET_DNSPARSER_free_packet (struct GNUNET_DNSPARSER_Packet *p);
  *         GNUNET_OK if 'p' was packed completely into '*buf'
  */
 int
-GNUNET_DNSPARSER_pack (struct GNUNET_DNSPARSER_Packet *p,
+GNUNET_DNSPARSER_pack (const struct GNUNET_DNSPARSER_Packet *p,
+                      uint16_t max,
                       char **buf,
                       size_t *buf_length);
 
 
-
-
-/* legacy API below */
-
-// DNS-Stuff
-GNUNET_NETWORK_STRUCT_BEGIN
-
-struct dns_static
-{
-  uint16_t id GNUNET_PACKED;
-
-  unsigned rd:1 GNUNET_PACKED;  // recursion desired (client -> server)
-  unsigned tc:1 GNUNET_PACKED;  // message is truncated
-  unsigned aa:1 GNUNET_PACKED;  // authoritative answer
-  unsigned op:4 GNUNET_PACKED;  // query:0, inverse q.:1, status: 2
-  unsigned qr:1 GNUNET_PACKED;  // query:0, response:1
-
-  unsigned rcode:4 GNUNET_PACKED;       // 0 No error
-  // 1 Format error
-  // 2 Server failure
-  // 3 Name Error
-  // 4 Not Implemented
-  // 5 Refused
-  unsigned z:3 GNUNET_PACKED;   // reserved
-  unsigned ra:1 GNUNET_PACKED;  // recursion available (server -> client)
-
-  uint16_t qdcount GNUNET_PACKED;       // number of questions
-  uint16_t ancount GNUNET_PACKED;       // number of answers
-  uint16_t nscount GNUNET_PACKED;       // number of authority-records
-  uint16_t arcount GNUNET_PACKED;       // number of additional records
-};
-GNUNET_NETWORK_STRUCT_END
-
-
-struct dns_pkt
-{
-  struct dns_static s;
-  unsigned char data[1];
-};
-
-struct dns_pkt_parsed
-{
-  struct dns_static s;
-  struct dns_query **queries;
-  struct dns_record **answers;
-  struct dns_record **nameservers;
-  struct dns_record **additional;
-};
-
-struct dns_query_line
-{
-  uint16_t type;
-  uint16_t class;
-};
-
-struct dns_query
-{
-  char *name;
-  unsigned char namelen;
-  uint16_t qtype;
-  uint16_t qclass;
-};
-
-struct dns_record_line
-{
-  uint16_t type;
-  uint16_t class;
-  uint32_t ttl;
-  uint16_t data_len;
-  unsigned char data;
-};
-
-struct dns_record
-{
-  char *name;
-  unsigned char namelen;
-  uint16_t type;
-  uint16_t class;
-  uint32_t ttl;
-  uint16_t data_len;
-  unsigned char *data;
-};
-
-
-struct dns_pkt_parsed *
-parse_dns_packet (struct dns_pkt *pkt);
-
-struct dns_pkt *
-unparse_dns_packet (struct dns_pkt_parsed *pkt);
-
-void
-free_parsed_dns_packet (struct dns_pkt_parsed *ppkt);
-
 #endif