include/dns.h

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