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