include/dns.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                     E-mail:
   7  *              <brain@chatspike.net>
   8  *              <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *          the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 /*
  18 dns.h - dns library very very loosely based on
  19 firedns, Copyright (C) 2002 Ian Gulliver
  20
  21 This program is free software; you can redistribute it and/or modify
  22 it under the terms of version 2 of the GNU General Public License as
  23 published by the Free Software Foundation.
  24
  25 This program is distributed in the hope that it will be useful,
  26 but WITHOUT ANY WARRANTY; without even the implied warranty of
  27 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28 GNU General Public License for more details.
  29
  30 You should have received a copy of the GNU General Public License
  31 along with this program; if not, write to the Free Software
  32 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  33 */
  34
  35 #ifndef _DNS_H
  36 #define _DNS_H
  37
  38 #include <string>
  39 #include "inspircd_config.h"
  40 #include "base.h"
  41 #include "socketengine.h"
  42 #include "socket.h"
  43
  44 using namespace std;
  45 using irc::sockets::insp_aton;
  46 using irc::sockets::insp_ntoa;
  47 using irc::sockets::insp_sockaddr;
  48 using irc::sockets::insp_inaddr;
  49
  50 class InspIRCd;
  51
  52 /**
  53  * Result status, used internally
  54  */
  55 typedef std::pair<int,std::string> DNSResult;
  56
  57 /**
  58  * Information on a completed lookup, used internally
  59  */
  60 typedef std::pair<unsigned char*, std::string> DNSInfo;
  61
  62 /**
  63  * Error types that class Resolver can emit to its error method.
  64  */
  65 enum ResolverError
  66 {
  67         RESOLVER_NOERROR        =       0,
  68         RESOLVER_NSDOWN         =       1,
  69         RESOLVER_NXDOMAIN       =       2,
  70         RESOLVER_NOTREADY       =       3,
  71         RESOLVER_BADIP          =       4,
  72         RESOLVER_TIMEOUT        =       5
  73 };
  74
  75 /**
  76  * A DNS request
  77  */
  78 class DNSRequest;
  79
  80 /**
  81  * A DNS packet header
  82  */
  83 class DNSHeader;
  84
  85 /**
  86  * A DNS Resource Record (rr)
  87  */
  88 class ResourceRecord;
  89
  90 /**
  91  * A set of requests keyed by request id
  92  */
  93 typedef std::map<int,DNSRequest*> requestlist;
  94
  95 /**
  96  * An iterator into a set of requests
  97  */
  98 typedef requestlist::iterator requestlist_iter;
  99
 100 /**
 101  * Query and resource record types
 102  */
 103 enum QueryType
 104 {
 105         DNS_QUERY_A     = 1,      /* 'A' record: an ipv4 address */
 106         DNS_QUERY_CNAME = 5,      /* 'CNAME' record: An alias */
 107         DNS_QUERY_PTR   = 12,     /* 'PTR' record: a hostname */
 108         DNS_QUERY_AAAA  = 28,     /* 'AAAA' record: an ipv6 address */
 109
 110         DNS_QUERY_PTR4  = 0xFFFD, /* Force 'PTR' to use IPV4 scemantics */
 111         DNS_QUERY_PTR6  = 0xFFFE, /* Force 'PTR' to use IPV6 scemantics */
 112 };
 113
 114 #ifdef IPV6
 115 const QueryType DNS_QUERY_FORWARD = DNS_QUERY_AAAA;
 116 const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 117 #else
 118 const QueryType DNS_QUERY_FORWARD = DNS_QUERY_A;
 119 const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 120 #endif
 121
 122 /**
 123  * Used internally to force PTR lookups to use a certain protocol scemantics,
 124  * e.g. x.x.x.x.in-addr.arpa for v4, and *.ip6.arpa for v6.
 125  */
 126 enum ForceProtocol
 127 {
 128         PROTOCOL_IPV4 = 0,      /* Forced to use ipv4 */
 129         PROTOCOL_IPV6 = 1       /* Forced to use ipv6 */
 130 };
 131
 132 /**
 133  * The Resolver class is a high-level abstraction for resolving DNS entries.
 134  * It can do forward and reverse IPv4 lookups, and where IPv6 is supported, will
 135  * also be able to do those, transparent of protocols. Module developers must
 136  * extend this class via inheritence, and then insert a pointer to their derived
 137  * class into the core using Server::AddResolver(). Once you have done this,
 138  * the class will be able to receive callbacks. There are two callbacks which
 139  * can occur by calling virtual methods, one is a success situation, and the other
 140  * an error situation.
 141  */
 142 class Resolver : public Extensible
 143 {
 144  protected:
 145         /**
 146          * Pointer to creator
 147          */
 148         InspIRCd* ServerInstance;
 149         /**
 150          * The input data, either a host or an IP address
 151          */
 152         std::string input;
 153         /**
 154          * True if a forward lookup is being performed, false if otherwise
 155          */
 156         QueryType querytype;
 157         /**
 158          * The DNS erver being used for lookups. If this is an empty string,
 159          * the value of ServerConfig::DNSServer is used instead.
 160          */
 161         std::string server;
 162         /**
 163          * The ID allocated to your lookup. This is a pseudo-random number
 164          * between 0 and 65535, a value of -1 indicating a failure.
 165          * The core uses this to route results to the correct objects.
 166          */
 167         int myid;
 168  public:
 169         /**
 170          * Initiate DNS lookup. Your class should not attempt to delete or free these
 171          * objects, as the core will do this for you. They must always be created upon
 172          * the heap using new, as you cannot be sure at what time they will be deleted.
 173          * Allocating them on the stack or attempting to delete them yourself could cause
 174          * the object to go 'out of scope' and cause a segfault in the core if the result
 175          * arrives at a later time.
 176          * @param source The IP or hostname to resolve
 177          * @param qt The query type to perform. If you just want to perform a forward
 178          * or reverse lookup, and you don't care wether you get ipv4 or ipv6, then use
 179          * the constants DNS_QUERY_FORWARD and DNS_QUERY_REVERSE, which automatically
 180          * select from 'A' record or 'AAAA' record lookups. However, if you want to resolve
 181          * a specific record type, resolution of 'A', 'AAAA', 'PTR' and 'CNAME' records
 182          * is supported. Use one of the QueryType enum values to initiate this type of
 183          * lookup. Resolution of 'AAAA' ipv6 records is always supported, regardless of
 184          * wether InspIRCd is built with ipv6 support.
 185          * If you attempt to resolve a 'PTR' record using DNS_QUERY_PTR, and InspIRCd is
 186          * built with ipv6 support, the 'PTR' record will be formatted to ipv6 specs,
 187          * e.g. x.x.x.x.x....ip6.arpa. otherwise it will be formatted to ipv4 specs,
 188          * e.g. x.x.x.x.in-addr.arpa. This translation is automatic.
 189          * To get around this automatic behaviour, you must use one of the values
 190          * DNS_QUERY_PTR4 or DNS_QUERY_PTR6 to force ipv4 or ipv6 behaviour on the lookup,
 191          * irrespective of what protocol InspIRCd has been built for.
 192          * @throw ModuleException This class may throw an instance of ModuleException, in the
 193          * event a lookup could not be allocated, or a similar hard error occurs such as
 194          * the network being down. This will also be thrown if an invalid IP address is
 195          * passed when resolving a 'PTR' record.
 196          */
 197         Resolver(InspIRCd* Instance, const std::string &source, QueryType qt);
 198         /**
 199          * The default destructor does nothing.
 200          */
 201         virtual ~Resolver();
 202         /**
 203          * When your lookup completes, this method will be called.
 204          * @param result The resulting DNS lookup, either an IP address or a hostname.
 205          */
 206         virtual void OnLookupComplete(const std::string &result) = 0;
 207         /**
 208          * If an error occurs (such as NXDOMAIN, no domain name found) then this method
 209          * will be called.
 210          * @param e A ResolverError enum containing the error type which has occured.
 211          * @param errormessage The error text of the error that occured.
 212          */
 213         virtual void OnError(ResolverError e, const std::string &errormessage);
 214         /**
 215          * Returns the id value of this class. This is primarily used by the core
 216          * to determine where in various tables to place a pointer to your class, but it
 217          * is safe to call and use this method.
 218          * As specified in RFC1035, each dns request has a 16 bit ID value, ranging
 219          * from 0 to 65535. If there is an issue and the core cannot send your request,
 220          * this method will return -1.
 221          */
 222         int GetId();
 223 };
 224
 225 /** DNS is a singleton class used by the core to dispatch dns
 226  * requests to the dns server, and route incoming dns replies
 227  * back to Resolver objects, based upon the request ID. You
 228  * should never use this class yourself.
 229  */
 230 class DNS : public EventHandler
 231 {
 232  private:
 233
 234         InspIRCd* ServerInstance;
 235
 236         /**
 237          * The maximum value of a dns request id,
 238          * 16 bits wide, 0xFFFF.
 239          */
 240         static const int MAX_REQUEST_ID = 0xFFFF;
 241
 242         /**
 243          * Requests that are currently 'in flight'
 244          */
 245         requestlist requests;
 246
 247         /**
 248          * Server address being used currently
 249          */
 250         insp_inaddr myserver;
 251
 252         /**
 253          * A counter used to form part of the pseudo-random id
 254          */
 255         int currid;
 256
 257         /**
 258          * We have to turn off a few checks on received packets
 259          * when people are using 4in6 (e.g. ::ffff:xxxx). This is
 260          * a temporary kludge, Please let me know if you know how
 261          * to fix it.
 262          */
 263         bool ip6munge;
 264
 265         /**
 266          * Build a dns packet payload
 267          */
 268         int MakePayload(const char* name, const QueryType rr, const unsigned short rr_class, unsigned char* payload);
 269
 270  public:
 271         /**
 272          * Currently active Resolver classes
 273          */
 274         Resolver* Classes[MAX_REQUEST_ID];
 275         /**
 276          * The port number DNS requests are made on,
 277          * and replies have as a source-port number.
 278          */
 279         static const int QUERY_PORT = 53;
 280
 281         /**
 282          * Fill an rr (resource record) with data from input
 283          */
 284         static void FillResourceRecord(ResourceRecord* rr, const unsigned char* input);
 285         /**
 286          * Fill a header with data from input limited by a length
 287          */
 288         static void FillHeader(DNSHeader *header, const unsigned char *input, const int length);
 289         /**
 290          * Empty out a header into a data stream ready for transmission "on the wire"
 291          */
 292         static void EmptyHeader(unsigned char *output, const DNSHeader *header, const int length);
 293         /**
 294          * Start the lookup of an ipv4 from a hostname
 295          */
 296         int GetIP(const char* name);
 297
 298         /**
 299          * Start the lookup of a hostname from an ip,
 300          * always using the protocol inspircd is built for,
 301          * e.g. use ipv6 reverse lookup when built for ipv6,
 302          * or ipv4 lookup when built for ipv4.
 303          */
 304         int GetName(const insp_inaddr* ip);
 305
 306         /**
 307          * Start lookup of a hostname from an ip, but
 308          * force a specific protocol to be used for the lookup
 309          * for example to perform an ipv6 reverse lookup.
 310          */
 311         int GetNameForce(const char *ip, ForceProtocol fp);
 312
 313         /**
 314          * Start lookup of an ipv6 from a hostname
 315          */
 316         int GetIP6(const char *name);
 317
 318         /**
 319          * Start lookup of a CNAME from another hostname
 320          */
 321         int GetCName(const char* alias);
 322
 323         /**
 324          * Fetch the result string (an ip or host)
 325          * and/or an error message to go with it.
 326          */
 327         DNSResult GetResult();
 328
 329         /**
 330          * Handle a SocketEngine read event
 331          * Inherited from EventHandler
 332          */
 333         void HandleEvent(EventType et, int errornum = 0);
 334
 335         /**
 336          * Add a Resolver* to the list of active classes
 337          */
 338         bool AddResolverClass(Resolver* r);
 339
 340         /**
 341          * Add a query to the list to be sent
 342          */
 343         DNSRequest* AddQuery(DNSHeader *header, int &id);
 344
 345         /**
 346          * The constructor initialises the dns socket,
 347          * and clears the request lists.
 348          */
 349         DNS(InspIRCd* Instance);
 350
 351         /**
 352          * Destructor
 353          */
 354         ~DNS();
 355
 356         /** Portable random number generator, generates
 357          * its random number from the ircd stats counters,
 358          * effective user id, time of day and the rollover
 359          * counter (currid)
 360          */
 361         unsigned long PRNG();
 362
 363         /**
 364          * Turn an in6_addr into a .ip6.arpa domain
 365          */
 366         static void MakeIP6Int(char* query, const in6_addr *ip);
 367 };
 368
 369 #endif
 370