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