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