include/dns.h

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