X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fdns.h;h=6c690dc8756550a4c958d26239ed6f4133793e9d;hb=383caa90d568d8d997a9624a9e6174ddc1a9a3da;hp=522b58ee51c13435995514ee06ed620cda0693e0;hpb=ce9d870efaab76a3a4d5d64c4c873b43c7b831a3;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/dns.h b/include/dns.h index 522b58ee5..6c690dc87 100644 --- a/include/dns.h +++ b/include/dns.h @@ -1,5 +1,22 @@ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ + /* -dns.h - dns library declarations based on firedns Copyright (C) 2002 Ian Gulliver +dns.h - dns library very very loosely based on +firedns, Copyright (C) 2002 Ian Gulliver This program is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as @@ -20,11 +37,28 @@ 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; + +/** + * Result status, used internally + */ typedef std::pair DNSResult; +/** + * Information on a completed lookup, used internally + */ +typedef std::pair DNSInfo; + /** * Error types that class Resolver can emit to its error method. */ @@ -33,31 +67,70 @@ enum ResolverError RESOLVER_NOERROR = 0, RESOLVER_NSDOWN = 1, RESOLVER_NXDOMAIN = 2, - RESOLVER_NOTREADY = 3 + RESOLVER_NOTREADY = 3, + RESOLVER_BADIP = 4 }; +/** + * A DNS request + */ +class DNSRequest; -/** DNS is a singleton class used by the core to dispatch dns - * requests to the dns server, and route incoming dns replies - * back to Resolver objects, based upon the request ID. You - * should never use this class yourself. +/** + * 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; + +/** + * An iterator into a set of requests + */ +typedef requestlist::iterator requestlist_iter; + +/** + * Query and resource record types */ -class DNS : public Extensible +enum QueryType { - private: - int t; - int myid; - public: - int dns_getip4(const char* name); - int dns_getname4(const insp_inaddr* ip); - DNSResult dns_getresult(); - DNS(); - ~DNS(); + 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 */ + + 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. - * It can do forward and reverse IPv4 lookups, and when IPv6 is supported, will + * It can do forward and reverse IPv4 lookups, and where IPv6 is supported, will * also be able to do those, transparent of protocols. Module developers must * extend this class via inheritence, and then insert a pointer to their derived * class into the core using Server::AddResolver(). Once you have done this, @@ -68,6 +141,10 @@ class DNS : public Extensible class Resolver : public Extensible { protected: + /** + * Pointer to creator + */ + InspIRCd* ServerInstance; /** * The input data, either a host or an IP address */ @@ -75,14 +152,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. */ @@ -96,16 +173,27 @@ 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. */ - Resolver(const std::string &source, bool forward); + Resolver(InspIRCd* Instance, const std::string &source, QueryType qt); /** * The default destructor does nothing. */ @@ -114,40 +202,169 @@ class Resolver : public Extensible * When your lookup completes, this method will be called. * @param result The resulting DNS lookup, either an IP address or a hostname. */ - virtual void OnLookupComplete(const std::string &result); + virtual void OnLookupComplete(const std::string &result) = 0; /** * If an error occurs (such as NXDOMAIN, no domain name found) then this method * will be called. * @param e A ResolverError enum containing the error type which has occured. + * @param errormessage The error text of the error that occured. */ - virtual void OnError(ResolverError e); - /** - * This method is called by the core when the object's file descriptor is ready - * for reading, and will then dispatch a call to either OnLookupComplete or - * OnError. You should never call this method yourself. - */ - bool ProcessResult(const std::string &result); + virtual void OnError(ResolverError e, const std::string &errormessage); /** - * Returns the file descriptor of this class. This is primarily used by the core + * Returns the id value of this class. This is primarily used by the core * to determine where in various tables to place a pointer to your class, but it * is safe to call and use this method. + * As specified in RFC1035, each dns request has a 16 bit ID value, ranging + * from 0 to 65535. If there is an issue and the core cannot send your request, + * this method will return -1. */ int GetId(); }; -/** - * Clear the pointer table used for Resolver classes, - * translate ServerConfig::DNSServer into an insp_inaddr, - * establish binding on UDP socket for DNS requests. - */ -void init_dns(); -/** - * Deal with a Resolver class which has become readable - */ -void dns_deal_with_classes(int fd); -/** - * Add a resolver class to our active table +/** DNS is a singleton class used by the core to dispatch dns + * requests to the dns server, and route incoming dns replies + * back to Resolver objects, based upon the request ID. You + * should never use this class yourself. */ -bool dns_add_class(Resolver* r); +class DNS : public EventHandler +{ + private: + + InspIRCd* ServerInstance; + + /** + * The maximum value of a dns request id, + * 16 bits wide, 0xFFFF. + */ + static const int MAX_REQUEST_ID = 0xFFFF; + + /** + * Requests that are currently 'in flight' + */ + requestlist requests; + + /** + * Server address being used currently + */ + insp_inaddr myserver; + + /** + * A counter used to form part of the pseudo-random id + */ + int currid; + + /** + * Currently active Resolver classes + */ + 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: + /** + * 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); + /** + * 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(); + + /** + * Handle a SocketEngine read event + * Inherited from EventHandler + */ + void HandleEvent(EventType et); + + /** + * 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); + + /** + * 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); +}; #endif +