include/dns.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 /*
  15 dns.h - dns library very very loosely based on
  16 firedns, Copyright (C) 2002 Ian Gulliver
  17
  18 This program is free software; you can redistribute it and/or modify
  19 it under the terms of version 2 of the GNU General Public License as
  20 published by the Free Software Foundation.
  21
  22 This program is distributed in the hope that it will be useful,
  23 but WITHOUT ANY WARRANTY; without even the implied warranty of
  24 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25 GNU General Public License for more details.
  26
  27 You should have received a copy of the GNU General Public License
  28 along with this program; if not, write to the Free Software
  29 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  30 */
  31
  32 #ifndef _DNS_H
  33 #define _DNS_H
  34
  35 #include "socket.h"
  36 #include "hashcomp.h"
  37
  38 /**
  39  * Result status, used internally
  40  */
  41 class CoreExport DNSResult
  42 {
  43  public:
  44         /** Result ID
  45          */
  46         int id;
  47         /** Result body, a hostname or IP address
  48          */
  49         std::string result;
  50         /** Time-to-live value of the result
  51          */
  52         unsigned long ttl;
  53         /** The original request, a hostname or IP address
  54          */
  55         std::string original;
  56
  57         /** Build a DNS result.
  58          * @param i The request ID
  59          * @param res The request result, a hostname or IP
  60          * @param timetolive The request time-to-live
  61          * @param orig The original request, a hostname or IP
  62          */
  63         DNSResult(int i, const std::string &res, unsigned long timetolive, const std::string &orig) : id(i), result(res), ttl(timetolive), original(orig) { }
  64 };
  65
  66 /**
  67  * Information on a completed lookup, used internally
  68  */
  69 typedef std::pair<unsigned char*, std::string> DNSInfo;
  70
  71 /** Cached item stored in the query cache.
  72  */
  73 class CoreExport CachedQuery
  74 {
  75  public:
  76         /** The cached result data, an IP or hostname
  77          */
  78         std::string data;
  79         /** The time when the item is due to expire
  80          */
  81         time_t expires;
  82
  83         /** Build a cached query
  84          * @param res The result data, an IP or hostname
  85          * @param ttl The time-to-live value of the query result
  86          */
  87         CachedQuery(const std::string &res, unsigned int ttl) : data(res)
  88         {
  89                 expires = time(NULL) + ttl;
  90         }
  91
  92         /** Returns the number of seconds remaining before this
  93          * cache item has expired and should be removed.
  94          */
  95         int CalcTTLRemaining()
  96         {
  97                 int n = (int)expires - (int)time(NULL);
  98                 return (n < 0 ? 0 : n);
  99         }
 100 };
 101
 102 /** DNS cache information. Holds IPs mapped to hostnames, and hostnames mapped to IPs.
 103  */
 104 #if defined(WINDOWS) && !defined(HASHMAP_DEPRECATED)
 105 typedef nspace::hash_map<irc::string, CachedQuery, nspace::hash_compare<irc::string> > dnscache;
 106 #else
 107 typedef nspace::hash_map<irc::string, CachedQuery, nspace::hash<irc::string> > dnscache;
 108 #endif
 109
 110 /**
 111  * Error types that class Resolver can emit to its error method.
 112  */
 113 enum ResolverError
 114 {
 115         RESOLVER_NOERROR        =       0,
 116         RESOLVER_NSDOWN         =       1,
 117         RESOLVER_NXDOMAIN       =       2,
 118         RESOLVER_BADIP          =       3,
 119         RESOLVER_TIMEOUT        =       4,
 120         RESOLVER_FORCEUNLOAD    =       5
 121 };
 122
 123 /**
 124  * Query and resource record types
 125  */
 126 enum QueryType
 127 {
 128         /** Uninitialized Query */
 129         DNS_QUERY_NONE  = 0,
 130         /** 'A' record: an ipv4 address */
 131         DNS_QUERY_A     = 1,
 132         /** 'CNAME' record: An alias */
 133         DNS_QUERY_CNAME = 5,
 134         /** 'PTR' record: a hostname */
 135         DNS_QUERY_PTR   = 12,
 136         /** 'AAAA' record: an ipv6 address */
 137         DNS_QUERY_AAAA  = 28,
 138
 139         /** Force 'PTR' to use IPV4 scemantics */
 140         DNS_QUERY_PTR4  = 0xFFFD,
 141         /** Force 'PTR' to use IPV6 scemantics */
 142         DNS_QUERY_PTR6  = 0xFFFE
 143 };
 144
 145 /**
 146  * Used internally to force PTR lookups to use a certain protocol scemantics,
 147  * e.g. x.x.x.x.in-addr.arpa for v4, and *.ip6.arpa for v6.
 148  */
 149 enum ForceProtocol
 150 {
 151         /** Forced to use ipv4 */
 152         PROTOCOL_IPV4 = 0,
 153         /** Forced to use ipv6 */
 154         PROTOCOL_IPV6 = 1
 155 };
 156
 157 /**
 158  * The Resolver class is a high-level abstraction for resolving DNS entries.
 159  * It can do forward and reverse IPv4 lookups, and where IPv6 is supported, will
 160  * also be able to do those, transparent of protocols. Module developers must
 161  * extend this class via inheritence, and then insert a pointer to their derived
 162  * class into the core using Server::AddResolver(). Once you have done this,
 163  * the class will be able to receive callbacks. There are two callbacks which
 164  * can occur by calling virtual methods, one is a success situation, and the other
 165  * an error situation.
 166  */
 167 class CoreExport Resolver
 168 {
 169  protected:
 170         /**
 171          * Pointer to creator module (if any, or NULL)
 172          */
 173         ModuleRef Creator;
 174         /**
 175          * The input data, either a host or an IP address
 176          */
 177         std::string input;
 178         /**
 179          * True if a forward lookup is being performed, false if otherwise
 180          */
 181         QueryType querytype;
 182         /**
 183          * The DNS erver being used for lookups. If this is an empty string,
 184          * the value of ServerConfig::DNSServer is used instead.
 185          */
 186         std::string server;
 187         /**
 188          * The ID allocated to your lookup. This is a pseudo-random number
 189          * between 0 and 65535, a value of -1 indicating a failure.
 190          * The core uses this to route results to the correct objects.
 191          */
 192         int myid;
 193
 194         /**
 195          * Cached result, if there is one
 196          */
 197         CachedQuery *CQ;
 198
 199         /**
 200          * Time left before cache expiry
 201          */
 202         int time_left;
 203
 204  public:
 205         /**
 206          * Initiate DNS lookup. Your class should not attempt to delete or free these
 207          * objects, as the core will do this for you. They must always be created upon
 208          * the heap using new, as you cannot be sure at what time they will be deleted.
 209          * Allocating them on the stack or attempting to delete them yourself could cause
 210          * the object to go 'out of scope' and cause a segfault in the core if the result
 211          * arrives at a later time.
 212          * @param source The IP or hostname to resolve
 213          * @param qt The query type to perform. Resolution of 'A', 'AAAA', 'PTR' and 'CNAME' records
 214          * is supported. Use one of the QueryType enum values to initiate this type of
 215          * lookup. Resolution of 'AAAA' ipv6 records is always supported, regardless of
 216          * wether InspIRCd is built with ipv6 support.
 217          * To look up reverse records, specify one of DNS_QUERY_PTR4 or DNS_QUERY_PTR6 depending
 218          * on the type of address you are looking up.
 219          * @param cached The constructor will set this boolean to true or false depending
 220          * on whether the DNS lookup you are attempting is cached (and not expired) or not.
 221          * If the value is cached, upon return this will be set to true, otherwise it will
 222          * be set to false. You should pass this value to InspIRCd::AddResolver(), which
 223          * will then influence the behaviour of the method and determine whether a cached
 224          * or non-cached result is obtained. The value in this variable is always correct
 225          * for the given request when the constructor exits.
 226          * @param creator See the note below.
 227          * @throw ModuleException This class may throw an instance of ModuleException, in the
 228          * event a lookup could not be allocated, or a similar hard error occurs such as
 229          * the network being down. This will also be thrown if an invalid IP address is
 230          * passed when resolving a 'PTR' record.
 231          *
 232          * NOTE: If you are instantiating your DNS lookup from a module, you should set the
 233          * value of creator to point at your Module class. This way if your module is unloaded
 234          * whilst lookups are in progress, they can be safely removed and your module will not
 235          * crash the server.
 236          */
 237         Resolver(const std::string &source, QueryType qt, bool &cached, Module* creator);
 238
 239         /**
 240          * The default destructor does nothing.
 241          */
 242         virtual ~Resolver();
 243
 244         /**
 245          * When your lookup completes, this method will be called.
 246          * @param result The resulting DNS lookup, either an IP address or a hostname.
 247          * @param ttl The time-to-live value of the result, in the instance of a cached
 248          * result, this is the number of seconds remaining before refresh/expiry.
 249          * @param cached True if the result is a cached result, false if it was requested
 250          * from the DNS server.
 251          */
 252         virtual void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached) = 0;
 253
 254         /**
 255          * If an error occurs (such as NXDOMAIN, no domain name found) then this method
 256          * will be called.
 257          * @param e A ResolverError enum containing the error type which has occured.
 258          * @param errormessage The error text of the error that occured.
 259          */
 260         virtual void OnError(ResolverError e, const std::string &errormessage);
 261
 262         /**
 263          * Returns the id value of this class. This is primarily used by the core
 264          * to determine where in various tables to place a pointer to your class, but it
 265          * is safe to call and use this method.
 266          * As specified in RFC1035, each dns request has a 16 bit ID value, ranging
 267          * from 0 to 65535. If there is an issue and the core cannot send your request,
 268          * this method will return -1.
 269          */
 270         int GetId();
 271
 272         /**
 273          * Returns the creator module, or NULL
 274          */
 275         Module* GetCreator();
 276
 277         /**
 278          * If the result is a cached result, this triggers the objects
 279          * OnLookupComplete. This is done because it is not safe to call
 280          * the abstract virtual method from the constructor.
 281          */
 282         void TriggerCachedResult();
 283 };
 284
 285 /** DNS is a singleton class used by the core to dispatch dns
 286  * requests to the dns server, and route incoming dns replies
 287  * back to Resolver objects, based upon the request ID. You
 288  * should never use this class yourself.
 289  */
 290 class CoreExport DNS : public EventHandler
 291 {
 292  private:
 293
 294         /**
 295          * The maximum value of a dns request id,
 296          * 16 bits wide, 0xFFFF.
 297          */
 298         static const int MAX_REQUEST_ID = 0xFFFF;
 299
 300         /**
 301          * A counter used to form part of the pseudo-random id
 302          */
 303         int currid;
 304
 305         /**
 306          * Currently cached items
 307          */
 308         dnscache* cache;
 309
 310         /** A timer which ticks every hour to remove expired
 311          * items from the DNS cache.
 312          */
 313         class CacheTimer* PruneTimer;
 314
 315         /**
 316          * Build a dns packet payload
 317          */
 318         int MakePayload(const char* name, const QueryType rr, const unsigned short rr_class, unsigned char* payload);
 319
 320  public:
 321
 322         irc::sockets::sockaddrs myserver;
 323
 324         /**
 325          * Currently active Resolver classes
 326          */
 327         Resolver* Classes[MAX_REQUEST_ID];
 328
 329         /**
 330          * Requests that are currently 'in flight'
 331          */
 332         DNSRequest* requests[MAX_REQUEST_ID];
 333
 334         /**
 335          * The port number DNS requests are made on,
 336          * and replies have as a source-port number.
 337          */
 338         static const int QUERY_PORT = 53;
 339
 340         /**
 341          * Fill an rr (resource record) with data from input
 342          */
 343         static void FillResourceRecord(ResourceRecord* rr, const unsigned char* input);
 344
 345         /**
 346          * Fill a header with data from input limited by a length
 347          */
 348         static void FillHeader(DNSHeader *header, const unsigned char *input, const int length);
 349
 350         /**
 351          * Empty out a header into a data stream ready for transmission "on the wire"
 352          */
 353         static void EmptyHeader(unsigned char *output, const DNSHeader *header, const int length);
 354
 355         /**
 356          * Start the lookup of an ipv4 from a hostname
 357          */
 358         int GetIP(const char* name);
 359
 360         /**
 361          * Start lookup of a hostname from an ip, but
 362          * force a specific protocol to be used for the lookup
 363          * for example to perform an ipv6 reverse lookup.
 364          */
 365         int GetNameForce(const char *ip, ForceProtocol fp);
 366
 367         /**
 368          * Start lookup of an ipv6 from a hostname
 369          */
 370         int GetIP6(const char *name);
 371
 372         /**
 373          * Start lookup of a CNAME from another hostname
 374          */
 375         int GetCName(const char* alias);
 376
 377         /**
 378          * Fetch the result string (an ip or host)
 379          * and/or an error message to go with it.
 380          */
 381         DNSResult GetResult();
 382
 383         /**
 384          * Handle a SocketEngine read event
 385          * Inherited from EventHandler
 386          */
 387         void HandleEvent(EventType et, int errornum = 0);
 388
 389         /**
 390          * Add a Resolver* to the list of active classes
 391          */
 392         bool AddResolverClass(Resolver* r);
 393
 394         /**
 395          * Add a query to the list to be sent
 396          */
 397         DNSRequest* AddQuery(DNSHeader *header, int &id, const char* original);
 398
 399         /**
 400          * The constructor initialises the dns socket,
 401          * and clears the request lists.
 402          */
 403         DNS();
 404
 405         /**
 406          * Re-initialize the DNS subsystem.
 407          */
 408         void Rehash();
 409
 410         /**
 411          * Destructor
 412          */
 413         ~DNS();
 414
 415         /** Portable random number generator, generates
 416          * its random number from the ircd stats counters,
 417          * effective user id, time of day and the rollover
 418          * counter (currid)
 419          */
 420         unsigned long PRNG();
 421
 422         /**
 423          * Turn an in6_addr into a .ip6.arpa domain
 424          */
 425         static void MakeIP6Int(char* query, const in6_addr *ip);
 426
 427         /**
 428          * Clean out all dns resolvers owned by a particular
 429          * module, to make unloading a module safe if there
 430          * are dns requests currently in progress.
 431          */
 432         void CleanResolvers(Module* module);
 433
 434         /** Return the cached value of an IP or hostname
 435          * @param source An IP or hostname to find in the cache.
 436          * @return A pointer to a CachedQuery if the item exists,
 437          * otherwise NULL.
 438          */
 439         CachedQuery* GetCache(const std::string &source);
 440
 441         /** Delete a cached item from the DNS cache.
 442          * @param source An IP or hostname to remove
 443          */
 444         void DelCache(const std::string &source);
 445
 446         /** Clear all items from the DNS cache immediately.
 447          */
 448         int ClearCache();
 449
 450         /** Prune the DNS cache, e.g. remove all expired
 451          * items and rehash the cache buckets, but leave
 452          * items in the hash which are still valid.
 453          */
 454         int PruneCache();
 455 };
 456
 457 #endif
 458