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