include/dns.h

   1 /*
   2 dns.h - dns library declarations based on firedns Copyright (C) 2002 Ian Gulliver
   3
   4 This program is free software; you can redistribute it and/or modify
   5 it under the terms of version 2 of the GNU General Public License as
   6 published by the Free Software Foundation.
   7
   8 This program is distributed in the hope that it will be useful,
   9 but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 GNU General Public License for more details.
  12
  13 You should have received a copy of the GNU General Public License
  14 along with this program; if not, write to the Free Software
  15 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  16 */
  17
  18 #ifndef _DNS_H
  19 #define _DNS_H
  20
  21 #include <string>
  22 #include "inspircd_config.h"
  23 #include "socket.h"
  24 #include "base.h"
  25
  26 typedef std::pair<int,std::string> DNSResult;
  27 typedef std::pair<unsigned char*, std::string> DNSInfo;
  28
  29 /**
  30  * Error types that class Resolver can emit to its error method.
  31  */
  32 enum ResolverError
  33 {
  34         RESOLVER_NOERROR        =       0,
  35         RESOLVER_NSDOWN         =       1,
  36         RESOLVER_NXDOMAIN       =       2,
  37         RESOLVER_NOTREADY       =       3,
  38         RESOLVER_BADIP          =       4
  39 };
  40
  41 class DNSRequest;
  42 class DNSHeader;
  43
  44 /**
  45  * The Resolver class is a high-level abstraction for resolving DNS entries.
  46  * It can do forward and reverse IPv4 lookups, and where IPv6 is supported, will
  47  * also be able to do those, transparent of protocols. Module developers must
  48  * extend this class via inheritence, and then insert a pointer to their derived
  49  * class into the core using Server::AddResolver(). Once you have done this,
  50  * the class will be able to receive callbacks. There are two callbacks which
  51  * can occur by calling virtual methods, one is a success situation, and the other
  52  * an error situation.
  53  */
  54 class Resolver : public Extensible
  55 {
  56  protected:
  57         /**
  58          * The input data, either a host or an IP address
  59          */
  60         std::string input;
  61         /**
  62          * True if a forward lookup is being performed, false if otherwise
  63          */
  64         bool fwd;
  65         /**
  66          * The DNS erver being used for lookups. If this is an empty string,
  67          * the value of ServerConfig::DNSServer is used instead.
  68          */
  69         std::string server;
  70         /**
  71          * The ID allocated to your lookup. This is a pseud-random number
  72          * between 0 and 65535, a value of -1 indicating a failure.
  73          * The core uses this to route results to the correct objects.
  74          */
  75         int myid;
  76  public:
  77         /**
  78          * Initiate DNS lookup. Your class should not attempt to delete or free these
  79          * objects, as the core will do this for you. They must always be created upon
  80          * the heap using new, as you cannot be sure at what time they will be deleted.
  81          * Allocating them on the stack or attempting to delete them yourself could cause
  82          * the object to go 'out of scope' and cause a segfault in the core if the result
  83          * arrives at a later time.
  84          * @param source The IP or hostname to resolve
  85          * @param forward Set to true to perform a forward lookup (hostname to ip) or false
  86          * to perform a reverse lookup (ip to hostname). Lookups on A records and PTR
  87          * records are supported. CNAME and MX are not supported by this resolver.
  88          * If InspIRCd is compiled with ipv6 support, lookups on AAAA records are preferred
  89          * and supported over A records.
  90          * @throw ModuleException This class may throw an instance of ModuleException, in the
  91          * event a lookup could not be allocated, or a similar hard error occurs such as
  92          * the network being down.
  93          */
  94         Resolver(const std::string &source, bool forward);
  95         /**
  96          * The default destructor does nothing.
  97          */
  98         virtual ~Resolver();
  99         /**
 100          * When your lookup completes, this method will be called.
 101          * @param result The resulting DNS lookup, either an IP address or a hostname.
 102          */
 103         virtual void OnLookupComplete(const std::string &result) = 0;
 104         /**
 105          * If an error occurs (such as NXDOMAIN, no domain name found) then this method
 106          * will be called.
 107          * @param e A ResolverError enum containing the error type which has occured.
 108          * @param errormessage The error text of the error that occured.
 109          */
 110         virtual void OnError(ResolverError e, const std::string &errormessage);
 111         /**
 112          * Returns the id value of this class. This is primarily used by the core
 113          * to determine where in various tables to place a pointer to your class, but it
 114          * is safe to call and use this method.
 115          * As specified in RFC1035, each dns request has a 16 bit ID value, ranging
 116          * from 0 to 65535. If there is an issue and the core cannot send your request,
 117          * this method will return -1.
 118          */
 119         int GetId();
 120 };
 121
 122 /** DNS is a singleton class used by the core to dispatch dns
 123  * requests to the dns server, and route incoming dns replies
 124  * back to Resolver objects, based upon the request ID. You
 125  * should never use this class yourself.
 126  */
 127 class DNS : public Extensible
 128 {
 129  private:
 130         insp_inaddr myserver;
 131         static int MasterSocket;
 132  public:
 133         static int GetMasterSocket();
 134         int GetIP(const char* name);
 135         int GetName(const insp_inaddr* ip);
 136         DNSResult GetResult();
 137         void MarshallReads(int fd);
 138         bool AddResolverClass(Resolver* r);
 139         DNSRequest* DNSAddQuery(DNSHeader *header, int &id);
 140         DNS();
 141         ~DNS();
 142 };
 143
 144 #endif