]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/dns.h
EventHandler class, an abstraction for raw i/o
[user/henk/code/inspircd.git] / include / dns.h
index 7b96f792d97065e923f9308ef610b460d1ef6008..6c690dc8756550a4c958d26239ed6f4133793e9d 100644 (file)
@@ -37,8 +37,17 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 #include <string>
 #include "inspircd_config.h"
-#include "socket.h"
 #include "base.h"
+#include "socketengine.h"
+#include "socket.h"
+
+using namespace std;
+using irc::sockets::insp_aton;
+using irc::sockets::insp_ntoa;
+using irc::sockets::insp_sockaddr;
+using irc::sockets::insp_inaddr;
+
+class InspIRCd;
 
 /**
  * Result status, used internally
@@ -92,10 +101,13 @@ typedef requestlist::iterator requestlist_iter;
  */
 enum QueryType
 {
-       DNS_QUERY_A     = 1,    /* 'A' record: an ipv4 address */
-       DNS_QUERY_CNAME = 5,    /* 'CNAME' record: An alias */
-       DNS_QUERY_PTR   = 12,   /* 'PTR' record: a hostname */
-       DNS_QUERY_AAAA  = 28,    /* 'AAAA' record: an ipv6 address */
+       DNS_QUERY_A     = 1,      /* 'A' record: an ipv4 address */
+       DNS_QUERY_CNAME = 5,      /* 'CNAME' record: An alias */
+       DNS_QUERY_PTR   = 12,     /* 'PTR' record: a hostname */
+       DNS_QUERY_AAAA  = 28,     /* 'AAAA' record: an ipv6 address */
+
+       DNS_QUERY_PTR4  = 0xFFFD, /* Force 'PTR' to use IPV4 scemantics */
+       DNS_QUERY_PTR6  = 0xFFFE, /* Force 'PTR' to use IPV6 scemantics */
 };
 
 #ifdef IPV6
@@ -106,6 +118,16 @@ const QueryType DNS_QUERY_FORWARD = DNS_QUERY_A;
 const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 #endif
 
+/**
+ * Used internally to force PTR lookups to use a certain protocol scemantics,
+ * e.g. x.x.x.x.in-addr.arpa for v4, and *.ip6.arpa for v6.
+ */
+enum ForceProtocol
+{
+       PROTOCOL_IPV4 = 0,      /* Forced to use ipv4 */
+       PROTOCOL_IPV6 = 1       /* Forced to use ipv6 */
+};
+
 /**
  * The Resolver class is a high-level abstraction for resolving DNS entries.
  * It can do forward and reverse IPv4 lookups, and where IPv6 is supported, will
@@ -119,6 +141,10 @@ const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 class Resolver : public Extensible
 {
  protected:
+       /**
+        * Pointer to creator
+        */
+       InspIRCd* ServerInstance;
        /**
         * The input data, either a host or an IP address
         */
@@ -147,16 +173,27 @@ class Resolver : public Extensible
         * the object to go 'out of scope' and cause a segfault in the core if the result
         * arrives at a later time.
         * @param source The IP or hostname to resolve
-        * @param forward Set to true to perform a forward lookup (hostname to ip) or false
-        * to perform a reverse lookup (ip to hostname). Lookups on A records and PTR
-        * records are supported. CNAME and MX are not supported by this resolver.
-        * If InspIRCd is compiled with ipv6 support, lookups on AAAA records are preferred
-        * and supported over A records.
+        * @param qt The query type to perform. If you just want to perform a forward
+        * or reverse lookup, and you don't care wether you get ipv4 or ipv6, then use
+        * the constants DNS_QUERY_FORWARD and DNS_QUERY_REVERSE, which automatically
+        * select from 'A' record or 'AAAA' record lookups. However, if you want to resolve
+        * a specific record type, resolution of 'A', 'AAAA', 'PTR' and 'CNAME' records
+        * is supported. Use one of the QueryType enum values to initiate this type of
+        * lookup. Resolution of 'AAAA' ipv6 records is always supported, regardless of
+        * wether InspIRCd is built with ipv6 support.
+        * If you attempt to resolve a 'PTR' record using DNS_QUERY_PTR, and InspIRCd is
+        * built with ipv6 support, the 'PTR' record will be formatted to ipv6 specs,
+        * e.g. x.x.x.x.x....ip6.arpa. otherwise it will be formatted to ipv4 specs,
+        * e.g. x.x.x.x.in-addr.arpa. This translation is automatic.
+        * To get around this automatic behaviour, you must use one of the values
+        * DNS_QUERY_PTR4 or DNS_QUERY_PTR6 to force ipv4 or ipv6 behaviour on the lookup,
+        * irrespective of what protocol InspIRCd has been built for.
         * @throw ModuleException This class may throw an instance of ModuleException, in the
         * event a lookup could not be allocated, or a similar hard error occurs such as
-        * the network being down.
+        * the network being down. This will also be thrown if an invalid IP address is
+        * passed when resolving a 'PTR' record.
         */
-       Resolver(const std::string &source, QueryType qt);
+       Resolver(InspIRCd* Instance, const std::string &source, QueryType qt);
        /**
         * The default destructor does nothing.
         */
@@ -189,10 +226,12 @@ class Resolver : public Extensible
  * back to Resolver objects, based upon the request ID. You
  * should never use this class yourself.
  */
-class DNS : public Extensible
+class DNS : public EventHandler
 {
  private:
 
+       InspIRCd* ServerInstance;
+
        /**
         * The maximum value of a dns request id,
         * 16 bits wide, 0xFFFF.
@@ -209,11 +248,6 @@ class DNS : public Extensible
         */
        insp_inaddr myserver;
 
-       /**
-        * File descriptor being used to perform queries
-        */
-       static int MasterSocket;
-
        /**
         * A counter used to form part of the pseudo-random id
         */
@@ -224,6 +258,14 @@ class DNS : public Extensible
         */
        Resolver* Classes[MAX_REQUEST_ID];
 
+       /**
+        * We have to turn off a few checks on received packets
+        * when people are using 4in6 (e.g. ::ffff:xxxx). This is
+        * a temporary kludge, Please let me know if you know how
+        * to fix it.
+        */
+       bool ip6munge;
+
        /**
         * Build a dns packet payload
         */
@@ -248,21 +290,26 @@ class DNS : public Extensible
         * Empty out a header into a data stream ready for transmission "on the wire"
         */
        static void EmptyHeader(unsigned char *output, const DNSHeader *header, const int length);
-       /**
-        * Get the master socket fd, used internally
-        */
-       static int GetMasterSocket();
-
        /**
         * Start the lookup of an ipv4 from a hostname
         */
        int GetIP(const char* name);
 
        /**
-        * Start the lookup of a hostname from an ip
+        * Start the lookup of a hostname from an ip,
+        * always using the protocol inspircd is built for,
+        * e.g. use ipv6 reverse lookup when built for ipv6,
+        * or ipv4 lookup when built for ipv4.
         */
        int GetName(const insp_inaddr* ip);
 
+       /**
+        * Start lookup of a hostname from an ip, but
+        * force a specific protocol to be used for the lookup
+        * for example to perform an ipv6 reverse lookup.
+        */
+       int GetNameForce(const char *ip, ForceProtocol fp);
+
        /**
         * Start lookup of an ipv6 from a hostname
         */
@@ -281,8 +328,9 @@ class DNS : public Extensible
 
        /**
         * Handle a SocketEngine read event
+        * Inherited from EventHandler
         */
-       void MarshallReads(int fd);
+       void HandleEvent(EventType et);
 
        /**
         * Add a Resolver* to the list of active classes
@@ -298,7 +346,7 @@ class DNS : public Extensible
         * The constructor initialises the dns socket,
         * and clears the request lists.
         */
-       DNS();
+       DNS(InspIRCd* Instance);
 
        /**
         * Destructor
@@ -311,6 +359,11 @@ class DNS : public Extensible
         * counter (currid)
         */
        unsigned long PRNG();
+
+       /**
+        * Turn an in6_addr into a .ip6.arpa domain
+        */
+       static void MakeIP6Int(char* query, const in6_addr *ip);
 };
 
 #endif