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