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