include/dns.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                     E-mail:
   7  *              <brain@chatspike.net>
   8  *              <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *          the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 /*
  18 dns.h - dns library very very loosely based on
  19 firedns, Copyright (C) 2002 Ian Gulliver
  20
  21 This program is free software; you can redistribute it and/or modify
  22 it under the terms of version 2 of the GNU General Public License as
  23 published by the Free Software Foundation.
  24
  25 This program is distributed in the hope that it will be useful,
  26 but WITHOUT ANY WARRANTY; without even the implied warranty of
  27 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28 GNU General Public License for more details.
  29
  30 You should have received a copy of the GNU General Public License
  31 along with this program; if not, write to the Free Software
  32 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  33 */
  34
  35 #ifndef _DNS_H
  36 #define _DNS_H
  37
  38 #include <string>
  39 #include "inspircd_config.h"
  40 #include "base.h"
  41 #include "socketengine.h"
  42 #include "socket.h"
  43
  44 using namespace std;
  45 using irc::sockets::insp_aton;
  46 using irc::sockets::insp_ntoa;
  47 using irc::sockets::insp_sockaddr;
  48 using irc::sockets::insp_inaddr;
  49
  50 class InspIRCd;
  51 class Module;
  52
  53 /**
  54  * Result status, used internally
  55  */
  56 typedef std::pair<int,std::string> DNSResult;
  57
  58 /**
  59  * Information on a completed lookup, used internally
  60  */
  61 typedef std::pair<unsigned char*, std::string> DNSInfo;
  62
  63 /**
  64  * Error types that class Resolver can emit to its error method.
  65  */
  66 enum ResolverError
  67 {
  68         RESOLVER_NOERROR        =       0,
  69         RESOLVER_NSDOWN         =       1,
  70         RESOLVER_NXDOMAIN       =       2,
  71         RESOLVER_NOTREADY       =       3,
  72         RESOLVER_BADIP          =       4,
  73         RESOLVER_TIMEOUT        =       5,
  74         RESLOVER_FORCEUNLOAD    =       6
  75 };
  76
  77 /**
  78  * A DNS request
  79  */
  80 class DNSRequest;
  81
  82 /**
  83  * A DNS packet header
  84  */
  85 class DNSHeader;
  86
  87 /**
  88  * A DNS Resource Record (rr)
  89  */
  90 class ResourceRecord;
  91
  92 /**
  93  * A set of requests keyed by request id
  94  */
  95 typedef std::map<int,DNSRequest*> requestlist;
  96
  97 /**
  98  * An iterator into a set of requests
  99  */
 100 typedef requestlist::iterator requestlist_iter;
 101
 102 /**
 103  * Query and resource record types
 104  */
 105 enum QueryType
 106 {
 107         DNS_QUERY_NONE  = 0,      /* Uninitialized Query */
 108         DNS_QUERY_A     = 1,      /* 'A' record: an ipv4 address */
 109         DNS_QUERY_CNAME = 5,      /* 'CNAME' record: An alias */
 110         DNS_QUERY_PTR   = 12,     /* 'PTR' record: a hostname */
 111         DNS_QUERY_AAAA  = 28,     /* 'AAAA' record: an ipv6 address */
 112
 113         DNS_QUERY_PTR4  = 0xFFFD, /* Force 'PTR' to use IPV4 scemantics */
 114         DNS_QUERY_PTR6  = 0xFFFE, /* Force 'PTR' to use IPV6 scemantics */
 115 };
 116
 117 #ifdef IPV6
 118 const QueryType DNS_QUERY_FORWARD = DNS_QUERY_AAAA;
 119 const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 120 #else
 121 const QueryType DNS_QUERY_FORWARD = DNS_QUERY_A;
 122 const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 123 #endif
 124
 125 /**
 126  * Used internally to force PTR lookups to use a certain protocol scemantics,
 127  * e.g. x.x.x.x.in-addr.arpa for v4, and *.ip6.arpa for v6.
 128  */
 129 enum ForceProtocol
 130 {
 131         PROTOCOL_IPV4 = 0,      /* Forced to use ipv4 */
 132         PROTOCOL_IPV6 = 1       /* Forced to use ipv6 */
 133 };
 134
 135 /**
 136  * The Resolver class is a high-level abstraction for resolving DNS entries.
 137  * It can do forward and reverse IPv4 lookups, and where IPv6 is supported, will
 138  * also be able to do those, transparent of protocols. Module developers must
 139  * extend this class via inheritence, and then insert a pointer to their derived
 140  * class into the core using Server::AddResolver(). Once you have done this,
 141  * the class will be able to receive callbacks. There are two callbacks which
 142  * can occur by calling virtual methods, one is a success situation, and the other
 143  * an error situation.
 144  */
 145 class Resolver : public Extensible
 146 {
 147  protected:
 148         /**
 149          * Pointer to creator
 150          */
 151         InspIRCd* ServerInstance;
 152         /**
 153          * Pointer to creator module (if any, or NULL)
 154          */
 155         Module* Creator;
 156         /**
 157          * The input data, either a host or an IP address
 158          */
 159         std::string input;
 160         /**
 161          * True if a forward lookup is being performed, false if otherwise
 162          */
 163         QueryType querytype;
 164         /**
 165          * The DNS erver being used for lookups. If this is an empty string,
 166          * the value of ServerConfig::DNSServer is used instead.
 167          */
 168         std::string server;
 169         /**
 170          * The ID allocated to your lookup. This is a pseudo-random number
 171          * between 0 and 65535, a value of -1 indicating a failure.
 172          * The core uses this to route results to the correct objects.
 173          */
 174         int myid;
 175  public:
 176         /**
 177          * Initiate DNS lookup. Your class should not attempt to delete or free these
 178          * objects, as the core will do this for you. They must always be created upon
 179          * the heap using new, as you cannot be sure at what time they will be deleted.
 180          * Allocating them on the stack or attempting to delete them yourself could cause
 181          * the object to go 'out of scope' and cause a segfault in the core if the result
 182          * arrives at a later time.
 183          * @param source The IP or hostname to resolve
 184          * @param qt The query type to perform. If you just want to perform a forward
 185          * or reverse lookup, and you don't care wether you get ipv4 or ipv6, then use
 186          * the constants DNS_QUERY_FORWARD and DNS_QUERY_REVERSE, which automatically
 187          * select from 'A' record or 'AAAA' record lookups. However, if you want to resolve
 188          * a specific record type, resolution of 'A', 'AAAA', 'PTR' and 'CNAME' records
 189          * is supported. Use one of the QueryType enum values to initiate this type of
 190          * lookup. Resolution of 'AAAA' ipv6 records is always supported, regardless of
 191          * wether InspIRCd is built with ipv6 support.
 192          * If you attempt to resolve a 'PTR' record using DNS_QUERY_PTR, and InspIRCd is
 193          * built with ipv6 support, the 'PTR' record will be formatted to ipv6 specs,
 194          * e.g. x.x.x.x.x....ip6.arpa. otherwise it will be formatted to ipv4 specs,
 195          * e.g. x.x.x.x.in-addr.arpa. This translation is automatic.
 196          * To get around this automatic behaviour, you must use one of the values
 197          * DNS_QUERY_PTR4 or DNS_QUERY_PTR6 to force ipv4 or ipv6 behaviour on the lookup,
 198          * irrespective of what protocol InspIRCd has been built for.
 199          * @throw ModuleException This class may throw an instance of ModuleException, in the
 200          * event a lookup could not be allocated, or a similar hard error occurs such as
 201          * the network being down. This will also be thrown if an invalid IP address is
 202          * passed when resolving a 'PTR' record.
 203          *
 204          * NOTE: If you are instantiating your DNS lookup from a module, you should set the
 205          * value of creator to point at your Module class. This way if your module is unloaded
 206          * whilst lookups are in progress, they can be safely removed and your module will not
 207          * crash the server.
 208          */
 209         Resolver(InspIRCd* Instance, const std::string &source, QueryType qt, Module* creator = NULL);
 210
 211         /**
 212          * The default destructor does nothing.
 213          */
 214         virtual ~Resolver();
 215         /**
 216          * When your lookup completes, this method will be called.
 217          * @param result The resulting DNS lookup, either an IP address or a hostname.
 218          */
 219         virtual void OnLookupComplete(const std::string &result) = 0;
 220         /**
 221          * If an error occurs (such as NXDOMAIN, no domain name found) then this method
 222          * will be called.
 223          * @param e A ResolverError enum containing the error type which has occured.
 224          * @param errormessage The error text of the error that occured.
 225          */
 226         virtual void OnError(ResolverError e, const std::string &errormessage);
 227         /**
 228          * Returns the id value of this class. This is primarily used by the core
 229          * to determine where in various tables to place a pointer to your class, but it
 230          * is safe to call and use this method.
 231          * As specified in RFC1035, each dns request has a 16 bit ID value, ranging
 232          * from 0 to 65535. If there is an issue and the core cannot send your request,
 233          * this method will return -1.
 234          */
 235         int GetId();
 236
 237         /**
 238          * Returns the creator module, or NULL
 239          */
 240         Module* GetCreator();
 241 };
 242
 243 /** DNS is a singleton class used by the core to dispatch dns
 244  * requests to the dns server, and route incoming dns replies
 245  * back to Resolver objects, based upon the request ID. You
 246  * should never use this class yourself.
 247  */
 248 class DNS : public EventHandler
 249 {
 250  private:
 251
 252         InspIRCd* ServerInstance;
 253
 254         /**
 255          * The maximum value of a dns request id,
 256          * 16 bits wide, 0xFFFF.
 257          */
 258         static const int MAX_REQUEST_ID = 0xFFFF;
 259
 260         /**
 261          * Requests that are currently 'in flight'
 262          */
 263         requestlist requests;
 264
 265         /**
 266          * Server address being used currently
 267          */
 268         insp_inaddr myserver;
 269
 270         /**
 271          * A counter used to form part of the pseudo-random id
 272          */
 273         int currid;
 274
 275         /**
 276          * We have to turn off a few checks on received packets
 277          * when people are using 4in6 (e.g. ::ffff:xxxx). This is
 278          * a temporary kludge, Please let me know if you know how
 279          * to fix it.
 280          */
 281         bool ip6munge;
 282
 283         /**
 284          * Build a dns packet payload
 285          */
 286         int MakePayload(const char* name, const QueryType rr, const unsigned short rr_class, unsigned char* payload);
 287
 288  public:
 289         /**
 290          * Currently active Resolver classes
 291          */
 292         Resolver* Classes[MAX_REQUEST_ID];
 293         /**
 294          * The port number DNS requests are made on,
 295          * and replies have as a source-port number.
 296          */
 297         static const int QUERY_PORT = 53;
 298
 299         /**
 300          * Fill an rr (resource record) with data from input
 301          */
 302         static void FillResourceRecord(ResourceRecord* rr, const unsigned char* input);
 303         /**
 304          * Fill a header with data from input limited by a length
 305          */
 306         static void FillHeader(DNSHeader *header, const unsigned char *input, const int length);
 307         /**
 308          * Empty out a header into a data stream ready for transmission "on the wire"
 309          */
 310         static void EmptyHeader(unsigned char *output, const DNSHeader *header, const int length);
 311         /**
 312          * Start the lookup of an ipv4 from a hostname
 313          */
 314         int GetIP(const char* name);
 315
 316         /**
 317          * Start the lookup of a hostname from an ip,
 318          * always using the protocol inspircd is built for,
 319          * e.g. use ipv6 reverse lookup when built for ipv6,
 320          * or ipv4 lookup when built for ipv4.
 321          */
 322         int GetName(const insp_inaddr* ip);
 323
 324         /**
 325          * Start lookup of a hostname from an ip, but
 326          * force a specific protocol to be used for the lookup
 327          * for example to perform an ipv6 reverse lookup.
 328          */
 329         int GetNameForce(const char *ip, ForceProtocol fp);
 330
 331         /**
 332          * Start lookup of an ipv6 from a hostname
 333          */
 334         int GetIP6(const char *name);
 335
 336         /**
 337          * Start lookup of a CNAME from another hostname
 338          */
 339         int GetCName(const char* alias);
 340
 341         /**
 342          * Fetch the result string (an ip or host)
 343          * and/or an error message to go with it.
 344          */
 345         DNSResult GetResult();
 346
 347         /**
 348          * Handle a SocketEngine read event
 349          * Inherited from EventHandler
 350          */
 351         void HandleEvent(EventType et, int errornum = 0);
 352
 353         /**
 354          * Add a Resolver* to the list of active classes
 355          */
 356         bool AddResolverClass(Resolver* r);
 357
 358         /**
 359          * Add a query to the list to be sent
 360          */
 361         DNSRequest* AddQuery(DNSHeader *header, int &id);
 362
 363         /**
 364          * The constructor initialises the dns socket,
 365          * and clears the request lists.
 366          */
 367         DNS(InspIRCd* Instance);
 368
 369         /**
 370          * Destructor
 371          */
 372         ~DNS();
 373
 374         /** Portable random number generator, generates
 375          * its random number from the ircd stats counters,
 376          * effective user id, time of day and the rollover
 377          * counter (currid)
 378          */
 379         unsigned long PRNG();
 380
 381         /**
 382          * Turn an in6_addr into a .ip6.arpa domain
 383          */
 384         static void MakeIP6Int(char* query, const in6_addr *ip);
 385
 386         /**
 387          * Clean out all dns resolvers owned by a particular
 388          * module, to make unloading a module safe if there
 389          * are dns requests currently in progress.
 390          */
 391         void CleanResolvers(Module* module);
 392 };
 393
 394 #endif
 395