include/dns.h

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