include/dns.h

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