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 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 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 = expires - 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 typedef nspace::hash_map<irc::string, CachedQuery, nspace::hash<irc::string> > dnscache;
 119
 120 /**
 121  * Error types that class Resolver can emit to its error method.
 122  */
 123 enum ResolverError
 124 {
 125         RESOLVER_NOERROR        =       0,
 126         RESOLVER_NSDOWN         =       1,
 127         RESOLVER_NXDOMAIN       =       2,
 128         RESOLVER_NOTREADY       =       3,
 129         RESOLVER_BADIP          =       4,
 130         RESOLVER_TIMEOUT        =       5,
 131         RESLOVER_FORCEUNLOAD    =       6
 132 };
 133
 134 /**
 135  * A DNS request
 136  */
 137 class DNSRequest;
 138
 139 /**
 140  * A DNS packet header
 141  */
 142 class DNSHeader;
 143
 144 /**
 145  * A DNS Resource Record (rr)
 146  */
 147 class ResourceRecord;
 148
 149 /**
 150  * Query and resource record types
 151  */
 152 enum QueryType
 153 {
 154         DNS_QUERY_NONE  = 0,      /* Uninitialized Query */
 155         DNS_QUERY_A     = 1,      /* 'A' record: an ipv4 address */
 156         DNS_QUERY_CNAME = 5,      /* 'CNAME' record: An alias */
 157         DNS_QUERY_PTR   = 12,     /* 'PTR' record: a hostname */
 158         DNS_QUERY_AAAA  = 28,     /* 'AAAA' record: an ipv6 address */
 159
 160         DNS_QUERY_PTR4  = 0xFFFD, /* Force 'PTR' to use IPV4 scemantics */
 161         DNS_QUERY_PTR6  = 0xFFFE, /* Force 'PTR' to use IPV6 scemantics */
 162 };
 163
 164 #ifdef IPV6
 165 const QueryType DNS_QUERY_FORWARD = DNS_QUERY_AAAA;
 166 const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 167 #else
 168 const QueryType DNS_QUERY_FORWARD = DNS_QUERY_A;
 169 const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 170 #endif
 171
 172 /**
 173  * Used internally to force PTR lookups to use a certain protocol scemantics,
 174  * e.g. x.x.x.x.in-addr.arpa for v4, and *.ip6.arpa for v6.
 175  */
 176 enum ForceProtocol
 177 {
 178         PROTOCOL_IPV4 = 0,      /* Forced to use ipv4 */
 179         PROTOCOL_IPV6 = 1       /* Forced to use ipv6 */
 180 };
 181
 182 /**
 183  * The Resolver class is a high-level abstraction for resolving DNS entries.
 184  * It can do forward and reverse IPv4 lookups, and where IPv6 is supported, will
 185  * also be able to do those, transparent of protocols. Module developers must
 186  * extend this class via inheritence, and then insert a pointer to their derived
 187  * class into the core using Server::AddResolver(). Once you have done this,
 188  * the class will be able to receive callbacks. There are two callbacks which
 189  * can occur by calling virtual methods, one is a success situation, and the other
 190  * an error situation.
 191  */
 192 class Resolver : public Extensible
 193 {
 194  protected:
 195         /**
 196          * Pointer to creator
 197          */
 198         InspIRCd* ServerInstance;
 199         /**
 200          * Pointer to creator module (if any, or NULL)
 201          */
 202         Module* Creator;
 203         /**
 204          * The input data, either a host or an IP address
 205          */
 206         std::string input;
 207         /**
 208          * True if a forward lookup is being performed, false if otherwise
 209          */
 210         QueryType querytype;
 211         /**
 212          * The DNS erver being used for lookups. If this is an empty string,
 213          * the value of ServerConfig::DNSServer is used instead.
 214          */
 215         std::string server;
 216         /**
 217          * The ID allocated to your lookup. This is a pseudo-random number
 218          * between 0 and 65535, a value of -1 indicating a failure.
 219          * The core uses this to route results to the correct objects.
 220          */
 221         int myid;
 222
 223         /**
 224          * Cached result, if there is one
 225          */
 226         CachedQuery *CQ;
 227
 228         /**
 229          * Time left before cache expiry
 230          */
 231         int time_left;
 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          * When your lookup completes, this method will be called.
 282          * @param result The resulting DNS lookup, either an IP address or a hostname.
 283          * @param ttl The time-to-live value of the result, in the instance of a cached
 284          * result, this is the number of seconds remaining before refresh/expiry.
 285          * @param cached True if the result is a cached result, false if it was requested
 286          * from the DNS server.
 287          */
 288         virtual void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached) = 0;
 289         /**
 290          * If an error occurs (such as NXDOMAIN, no domain name found) then this method
 291          * will be called.
 292          * @param e A ResolverError enum containing the error type which has occured.
 293          * @param errormessage The error text of the error that occured.
 294          */
 295         virtual void OnError(ResolverError e, const std::string &errormessage);
 296         /**
 297          * Returns the id value of this class. This is primarily used by the core
 298          * to determine where in various tables to place a pointer to your class, but it
 299          * is safe to call and use this method.
 300          * As specified in RFC1035, each dns request has a 16 bit ID value, ranging
 301          * from 0 to 65535. If there is an issue and the core cannot send your request,
 302          * this method will return -1.
 303          */
 304         int GetId();
 305         /**
 306          * Returns the creator module, or NULL
 307          */
 308         Module* GetCreator();
 309         /**
 310          * If the result is a cached result, this triggers the objects
 311          * OnLookupComplete. This is done because it is not safe to call
 312          * the abstract virtual method from the constructor.
 313          */
 314         void TriggerCachedResult();
 315 };
 316
 317 /** DNS is a singleton class used by the core to dispatch dns
 318  * requests to the dns server, and route incoming dns replies
 319  * back to Resolver objects, based upon the request ID. You
 320  * should never use this class yourself.
 321  */
 322 class DNS : public EventHandler
 323 {
 324  private:
 325
 326         /**
 327          * Creator/Owner object
 328          */
 329         InspIRCd* ServerInstance;
 330
 331         /**
 332          * The maximum value of a dns request id,
 333          * 16 bits wide, 0xFFFF.
 334          */
 335         static const int MAX_REQUEST_ID = 0xFFFF;
 336
 337         /**
 338          * Server address being used currently
 339          */
 340         insp_inaddr myserver;
 341
 342         /**
 343          * A counter used to form part of the pseudo-random id
 344          */
 345         int currid;
 346
 347         /**
 348          * We have to turn off a few checks on received packets
 349          * when people are using 4in6 (e.g. ::ffff:xxxx). This is
 350          * a temporary kludge, Please let me know if you know how
 351          * to fix it.
 352          */
 353         bool ip6munge;
 354
 355         /**
 356          * Currently cached items
 357          */
 358         dnscache* cache;
 359
 360         /** A timer which ticks every hour to remove expired
 361          * items from the DNS cache.
 362          */
 363         class CacheTimer* PruneTimer;
 364
 365         /**
 366          * Build a dns packet payload
 367          */
 368         int MakePayload(const char* name, const QueryType rr, const unsigned short rr_class, unsigned char* payload);
 369
 370  public:
 371
 372         /**
 373          * Currently active Resolver classes
 374          */
 375         Resolver* Classes[MAX_REQUEST_ID];
 376
 377         /**
 378          * Requests that are currently 'in flight'
 379          */
 380         DNSRequest* requests[MAX_REQUEST_ID];
 381
 382         /**
 383          * The port number DNS requests are made on,
 384          * and replies have as a source-port number.
 385          */
 386         static const int QUERY_PORT = 53;
 387
 388         /**
 389          * Fill an rr (resource record) with data from input
 390          */
 391         static void FillResourceRecord(ResourceRecord* rr, const unsigned char* input);
 392
 393         /**
 394          * Fill a header with data from input limited by a length
 395          */
 396         static void FillHeader(DNSHeader *header, const unsigned char *input, const int length);
 397
 398         /**
 399          * Empty out a header into a data stream ready for transmission "on the wire"
 400          */
 401         static void EmptyHeader(unsigned char *output, const DNSHeader *header, const int length);
 402
 403         /**
 404          * Start the lookup of an ipv4 from a hostname
 405          */
 406         int GetIP(const char* name);
 407
 408         /**
 409          * Start the lookup of a hostname from an ip,
 410          * always using the protocol inspircd is built for,
 411          * e.g. use ipv6 reverse lookup when built for ipv6,
 412          * or ipv4 lookup when built for ipv4.
 413          */
 414         int GetName(const insp_inaddr* ip);
 415
 416         /**
 417          * Start lookup of a hostname from an ip, but
 418          * force a specific protocol to be used for the lookup
 419          * for example to perform an ipv6 reverse lookup.
 420          */
 421         int GetNameForce(const char *ip, ForceProtocol fp);
 422
 423         /**
 424          * Start lookup of an ipv6 from a hostname
 425          */
 426         int GetIP6(const char *name);
 427
 428         /**
 429          * Start lookup of a CNAME from another hostname
 430          */
 431         int GetCName(const char* alias);
 432
 433         /**
 434          * Fetch the result string (an ip or host)
 435          * and/or an error message to go with it.
 436          */
 437         DNSResult GetResult();
 438
 439         /**
 440          * Handle a SocketEngine read event
 441          * Inherited from EventHandler
 442          */
 443         void HandleEvent(EventType et, int errornum = 0);
 444
 445         /**
 446          * Add a Resolver* to the list of active classes
 447          */
 448         bool AddResolverClass(Resolver* r);
 449
 450         /**
 451          * Add a query to the list to be sent
 452          */
 453         DNSRequest* AddQuery(DNSHeader *header, int &id, const char* original);
 454
 455         /**
 456          * The constructor initialises the dns socket,
 457          * and clears the request lists.
 458          */
 459         DNS(InspIRCd* Instance);
 460
 461         /**
 462          * Re-initialize the DNS subsystem.
 463          */
 464         void Rehash();
 465
 466         /**
 467          * Destructor
 468          */
 469         ~DNS();
 470
 471         /** Portable random number generator, generates
 472          * its random number from the ircd stats counters,
 473          * effective user id, time of day and the rollover
 474          * counter (currid)
 475          */
 476         unsigned long PRNG();
 477
 478         /**
 479          * Turn an in6_addr into a .ip6.arpa domain
 480          */
 481         static void MakeIP6Int(char* query, const in6_addr *ip);
 482
 483         /**
 484          * Clean out all dns resolvers owned by a particular
 485          * module, to make unloading a module safe if there
 486          * are dns requests currently in progress.
 487          */
 488         void CleanResolvers(Module* module);
 489
 490         /** Return the cached value of an IP or hostname
 491          * @param source An IP or hostname to find in the cache.
 492          * @return A pointer to a CachedQuery if the item exists,
 493          * otherwise NULL.
 494          */
 495         CachedQuery* GetCache(const std::string &source);
 496
 497         /** Delete a cached item from the DNS cache.
 498          * @param source An IP or hostname to remove
 499          */
 500         void DelCache(const std::string &source);
 501
 502         /** Clear all items from the DNS cache immediately.
 503          */
 504         int ClearCache();
 505
 506         /** Prune the DNS cache, e.g. remove all expired
 507          * items and rehash the cache buckets, but leave
 508          * items in the hash which are still valid.
 509          */
 510         int PruneCache();
 511 };
 512
 513 #endif
 514