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