include/dns.h

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