X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fdns.h;h=038323a4362b6b3e557cb3068614f16058915e71;hb=5e9a6b9186a8cbaaf65ae7d9cd9c0c033c91b497;hp=834f401aefaa8099261e349e73bb339534d691d5;hpb=be9ffd24301fedb5aadb8657fe46bc0d52fa88db;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/dns.h b/include/dns.h index 834f401ae..038323a43 100644 --- a/include/dns.h +++ b/include/dns.h @@ -2,14 +2,11 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * + * InspIRCd: (C) 2002-2007 InspIRCd Development Team + * See: http://www.inspircd.org/wiki/index.php/Credits * - * Written by Craig Edwards, Craig McLure, and others. * This program is free but copyrighted software; see - * the file COPYING for details. + * the file COPYING for details. * * --------------------------------------------------- */ @@ -37,10 +34,27 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA #include #include "inspircd_config.h" -#include "socket.h" #include "base.h" +#include "socketengine.h" +#include "socket.h" + +using namespace std; +using irc::sockets::insp_aton; +using irc::sockets::insp_ntoa; +using irc::sockets::insp_sockaddr; +using irc::sockets::insp_inaddr; + +class InspIRCd; +class Module; +/** + * Result status, used internally + */ typedef std::pair DNSResult; + +/** + * Information on a completed lookup, used internally + */ typedef std::pair DNSInfo; /** @@ -52,18 +66,58 @@ enum ResolverError RESOLVER_NSDOWN = 1, RESOLVER_NXDOMAIN = 2, RESOLVER_NOTREADY = 3, - RESOLVER_BADIP = 4 + RESOLVER_BADIP = 4, + RESOLVER_TIMEOUT = 5, + RESLOVER_FORCEUNLOAD = 6 }; +/** + * A DNS request + */ class DNSRequest; + +/** + * A DNS packet header + */ class DNSHeader; + +/** + * A DNS Resource Record (rr) + */ class ResourceRecord; -/* A set of requests keyed by request id */ -typedef std::map requestlist; +/** + * Query and resource record types + */ +enum QueryType +{ + DNS_QUERY_NONE = 0, /* Uninitialized Query */ + DNS_QUERY_A = 1, /* 'A' record: an ipv4 address */ + DNS_QUERY_CNAME = 5, /* 'CNAME' record: An alias */ + DNS_QUERY_PTR = 12, /* 'PTR' record: a hostname */ + DNS_QUERY_AAAA = 28, /* 'AAAA' record: an ipv6 address */ -/* An iterator into a set of requests */ -typedef requestlist::iterator requestlist_iter; + DNS_QUERY_PTR4 = 0xFFFD, /* Force 'PTR' to use IPV4 scemantics */ + DNS_QUERY_PTR6 = 0xFFFE, /* Force 'PTR' to use IPV6 scemantics */ +}; + +#ifdef IPV6 +const QueryType DNS_QUERY_FORWARD = DNS_QUERY_AAAA; +const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR; +#else +const QueryType DNS_QUERY_FORWARD = DNS_QUERY_A; +const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR; +#endif + +/** + * Used internally to force PTR lookups to use a certain protocol scemantics, + * e.g. x.x.x.x.in-addr.arpa for v4, and *.ip6.arpa for v6. + */ +enum ForceProtocol +{ + PROTOCOL_IPV4 = 0, /* Forced to use ipv4 */ + PROTOCOL_IPV6 = 1 /* Forced to use ipv6 */ +}; /** * The Resolver class is a high-level abstraction for resolving DNS entries. @@ -78,6 +132,14 @@ typedef requestlist::iterator requestlist_iter; class Resolver : public Extensible { protected: + /** + * Pointer to creator + */ + InspIRCd* ServerInstance; + /** + * Pointer to creator module (if any, or NULL) + */ + Module* Creator; /** * The input data, either a host or an IP address */ @@ -85,14 +147,14 @@ class Resolver : public Extensible /** * True if a forward lookup is being performed, false if otherwise */ - bool fwd; + QueryType querytype; /** * The DNS erver being used for lookups. If this is an empty string, * the value of ServerConfig::DNSServer is used instead. */ std::string server; /** - * The ID allocated to your lookup. This is a pseud-random number + * The ID allocated to your lookup. This is a pseudo-random number * between 0 and 65535, a value of -1 indicating a failure. * The core uses this to route results to the correct objects. */ @@ -106,16 +168,33 @@ class Resolver : public Extensible * the object to go 'out of scope' and cause a segfault in the core if the result * arrives at a later time. * @param source The IP or hostname to resolve - * @param forward Set to true to perform a forward lookup (hostname to ip) or false - * to perform a reverse lookup (ip to hostname). Lookups on A records and PTR - * records are supported. CNAME and MX are not supported by this resolver. - * If InspIRCd is compiled with ipv6 support, lookups on AAAA records are preferred - * and supported over A records. + * @param qt The query type to perform. If you just want to perform a forward + * or reverse lookup, and you don't care wether you get ipv4 or ipv6, then use + * the constants DNS_QUERY_FORWARD and DNS_QUERY_REVERSE, which automatically + * select from 'A' record or 'AAAA' record lookups. However, if you want to resolve + * a specific record type, resolution of 'A', 'AAAA', 'PTR' and 'CNAME' records + * is supported. Use one of the QueryType enum values to initiate this type of + * lookup. Resolution of 'AAAA' ipv6 records is always supported, regardless of + * wether InspIRCd is built with ipv6 support. + * If you attempt to resolve a 'PTR' record using DNS_QUERY_PTR, and InspIRCd is + * built with ipv6 support, the 'PTR' record will be formatted to ipv6 specs, + * e.g. x.x.x.x.x....ip6.arpa. otherwise it will be formatted to ipv4 specs, + * e.g. x.x.x.x.in-addr.arpa. This translation is automatic. + * To get around this automatic behaviour, you must use one of the values + * DNS_QUERY_PTR4 or DNS_QUERY_PTR6 to force ipv4 or ipv6 behaviour on the lookup, + * irrespective of what protocol InspIRCd has been built for. * @throw ModuleException This class may throw an instance of ModuleException, in the * event a lookup could not be allocated, or a similar hard error occurs such as - * the network being down. + * the network being down. This will also be thrown if an invalid IP address is + * passed when resolving a 'PTR' record. + * + * NOTE: If you are instantiating your DNS lookup from a module, you should set the + * value of creator to point at your Module class. This way if your module is unloaded + * whilst lookups are in progress, they can be safely removed and your module will not + * crash the server. */ - Resolver(const std::string &source, bool forward); + Resolver(InspIRCd* Instance, const std::string &source, QueryType qt, Module* creator = NULL); + /** * The default destructor does nothing. */ @@ -141,13 +220,11 @@ class Resolver : public Extensible * this method will return -1. */ int GetId(); -}; -/* Query and resource record types */ -enum QueryType -{ - DNS_QUERY_A = 1, /* 'A' record: an IP address */ - DNS_QUERY_PTR = 12 /* 'PTR' record: a hostname */ + /** + * Returns the creator module, or NULL + */ + Module* GetCreator(); }; /** DNS is a singleton class used by the core to dispatch dns @@ -155,34 +232,149 @@ enum QueryType * back to Resolver objects, based upon the request ID. You * should never use this class yourself. */ -class DNS : public Extensible +class DNS : public EventHandler { private: - static const int MAX_REQUEST_ID = 65535; + InspIRCd* ServerInstance; - requestlist requests; + /** + * The maximum value of a dns request id, + * 16 bits wide, 0xFFFF. + */ + static const int MAX_REQUEST_ID = 0xFFFF; + + /** + * Server address being used currently + */ insp_inaddr myserver; - static int MasterSocket; + + /** + * A counter used to form part of the pseudo-random id + */ int currid; - Resolver* Classes[MAX_REQUEST_ID]; + + /** + * We have to turn off a few checks on received packets + * when people are using 4in6 (e.g. ::ffff:xxxx). This is + * a temporary kludge, Please let me know if you know how + * to fix it. + */ + bool ip6munge; + + /** + * Build a dns packet payload + */ int MakePayload(const char* name, const QueryType rr, const unsigned short rr_class, unsigned char* payload); public: + /** + * Currently active Resolver classes + */ + Resolver* Classes[MAX_REQUEST_ID]; + /** + * Requests that are currently 'in flight' + */ + DNSRequest* requests[MAX_REQUEST_ID]; + /** + * The port number DNS requests are made on, + * and replies have as a source-port number. + */ + static const int QUERY_PORT = 53; + /** + * Fill an rr (resource record) with data from input + */ static void FillResourceRecord(ResourceRecord* rr, const unsigned char* input); + /** + * Fill a header with data from input limited by a length + */ static void FillHeader(DNSHeader *header, const unsigned char *input, const int length); + /** + * Empty out a header into a data stream ready for transmission "on the wire" + */ static void EmptyHeader(unsigned char *output, const DNSHeader *header, const int length); - static int GetMasterSocket(); - + /** + * Start the lookup of an ipv4 from a hostname + */ int GetIP(const char* name); + + /** + * Start the lookup of a hostname from an ip, + * always using the protocol inspircd is built for, + * e.g. use ipv6 reverse lookup when built for ipv6, + * or ipv4 lookup when built for ipv4. + */ int GetName(const insp_inaddr* ip); + + /** + * Start lookup of a hostname from an ip, but + * force a specific protocol to be used for the lookup + * for example to perform an ipv6 reverse lookup. + */ + int GetNameForce(const char *ip, ForceProtocol fp); + + /** + * Start lookup of an ipv6 from a hostname + */ + int GetIP6(const char *name); + + /** + * Start lookup of a CNAME from another hostname + */ + int GetCName(const char* alias); + + /** + * Fetch the result string (an ip or host) + * and/or an error message to go with it. + */ DNSResult GetResult(); - void MarshallReads(int fd); + + /** + * Handle a SocketEngine read event + * Inherited from EventHandler + */ + void HandleEvent(EventType et, int errornum = 0); + + /** + * Add a Resolver* to the list of active classes + */ bool AddResolverClass(Resolver* r); + + /** + * Add a query to the list to be sent + */ DNSRequest* AddQuery(DNSHeader *header, int &id); - DNS(); + + /** + * The constructor initialises the dns socket, + * and clears the request lists. + */ + DNS(InspIRCd* Instance); + + /** + * Destructor + */ ~DNS(); + + /** Portable random number generator, generates + * its random number from the ircd stats counters, + * effective user id, time of day and the rollover + * counter (currid) + */ + unsigned long PRNG(); + + /** + * Turn an in6_addr into a .ip6.arpa domain + */ + static void MakeIP6Int(char* query, const in6_addr *ip); + + /** + * Clean out all dns resolvers owned by a particular + * module, to make unloading a module safe if there + * are dns requests currently in progress. + */ + void CleanResolvers(Module* module); }; #endif