1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
18 dns.h - dns library very very loosely based on
19 firedns, Copyright (C) 2002 Ian Gulliver
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.
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.
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
39 #include "inspircd_config.h"
41 #include "socketengine.h"
45 using irc::sockets::insp_aton;
46 using irc::sockets::insp_ntoa;
47 using irc::sockets::insp_sockaddr;
48 using irc::sockets::insp_inaddr;
54 * Result status, used internally
56 typedef std::pair<int,std::string> DNSResult;
59 * Information on a completed lookup, used internally
61 typedef std::pair<unsigned char*, std::string> DNSInfo;
64 * Error types that class Resolver can emit to its error method.
70 RESOLVER_NXDOMAIN = 2,
71 RESOLVER_NOTREADY = 3,
74 RESLOVER_FORCEUNLOAD = 6
88 * A DNS Resource Record (rr)
93 * A set of requests keyed by request id
95 typedef std::map<int,DNSRequest*> requestlist;
98 * An iterator into a set of requests
100 typedef requestlist::iterator requestlist_iter;
103 * Query and resource record types
107 DNS_QUERY_A = 1, /* 'A' record: an ipv4 address */
108 DNS_QUERY_CNAME = 5, /* 'CNAME' record: An alias */
109 DNS_QUERY_PTR = 12, /* 'PTR' record: a hostname */
110 DNS_QUERY_AAAA = 28, /* 'AAAA' record: an ipv6 address */
112 DNS_QUERY_PTR4 = 0xFFFD, /* Force 'PTR' to use IPV4 scemantics */
113 DNS_QUERY_PTR6 = 0xFFFE, /* Force 'PTR' to use IPV6 scemantics */
117 const QueryType DNS_QUERY_FORWARD = DNS_QUERY_AAAA;
118 const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
120 const QueryType DNS_QUERY_FORWARD = DNS_QUERY_A;
121 const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
125 * Used internally to force PTR lookups to use a certain protocol scemantics,
126 * e.g. x.x.x.x.in-addr.arpa for v4, and *.ip6.arpa for v6.
130 PROTOCOL_IPV4 = 0, /* Forced to use ipv4 */
131 PROTOCOL_IPV6 = 1 /* Forced to use ipv6 */
135 * The Resolver class is a high-level abstraction for resolving DNS entries.
136 * It can do forward and reverse IPv4 lookups, and where IPv6 is supported, will
137 * also be able to do those, transparent of protocols. Module developers must
138 * extend this class via inheritence, and then insert a pointer to their derived
139 * class into the core using Server::AddResolver(). Once you have done this,
140 * the class will be able to receive callbacks. There are two callbacks which
141 * can occur by calling virtual methods, one is a success situation, and the other
142 * an error situation.
144 class Resolver : public Extensible
150 InspIRCd* ServerInstance;
152 * Pointer to creator module (if any, or NULL)
156 * The input data, either a host or an IP address
160 * True if a forward lookup is being performed, false if otherwise
164 * The DNS erver being used for lookups. If this is an empty string,
165 * the value of ServerConfig::DNSServer is used instead.
169 * The ID allocated to your lookup. This is a pseudo-random number
170 * between 0 and 65535, a value of -1 indicating a failure.
171 * The core uses this to route results to the correct objects.
176 * Initiate DNS lookup. Your class should not attempt to delete or free these
177 * objects, as the core will do this for you. They must always be created upon
178 * the heap using new, as you cannot be sure at what time they will be deleted.
179 * Allocating them on the stack or attempting to delete them yourself could cause
180 * the object to go 'out of scope' and cause a segfault in the core if the result
181 * arrives at a later time.
182 * @param source The IP or hostname to resolve
183 * @param qt The query type to perform. If you just want to perform a forward
184 * or reverse lookup, and you don't care wether you get ipv4 or ipv6, then use
185 * the constants DNS_QUERY_FORWARD and DNS_QUERY_REVERSE, which automatically
186 * select from 'A' record or 'AAAA' record lookups. However, if you want to resolve
187 * a specific record type, resolution of 'A', 'AAAA', 'PTR' and 'CNAME' records
188 * is supported. Use one of the QueryType enum values to initiate this type of
189 * lookup. Resolution of 'AAAA' ipv6 records is always supported, regardless of
190 * wether InspIRCd is built with ipv6 support.
191 * If you attempt to resolve a 'PTR' record using DNS_QUERY_PTR, and InspIRCd is
192 * built with ipv6 support, the 'PTR' record will be formatted to ipv6 specs,
193 * e.g. x.x.x.x.x....ip6.arpa. otherwise it will be formatted to ipv4 specs,
194 * e.g. x.x.x.x.in-addr.arpa. This translation is automatic.
195 * To get around this automatic behaviour, you must use one of the values
196 * DNS_QUERY_PTR4 or DNS_QUERY_PTR6 to force ipv4 or ipv6 behaviour on the lookup,
197 * irrespective of what protocol InspIRCd has been built for.
198 * @throw ModuleException This class may throw an instance of ModuleException, in the
199 * event a lookup could not be allocated, or a similar hard error occurs such as
200 * the network being down. This will also be thrown if an invalid IP address is
201 * passed when resolving a 'PTR' record.
203 * NOTE: If you are instantiating your DNS lookup from a module, you should set the
204 * value of creator to point at your Module class. This way if your module is unloaded
205 * whilst lookups are in progress, they can be safely removed and your module will not
208 Resolver(InspIRCd* Instance, const std::string &source, QueryType qt, Module* creator = NULL);
211 * The default destructor does nothing.
215 * When your lookup completes, this method will be called.
216 * @param result The resulting DNS lookup, either an IP address or a hostname.
218 virtual void OnLookupComplete(const std::string &result) = 0;
220 * If an error occurs (such as NXDOMAIN, no domain name found) then this method
222 * @param e A ResolverError enum containing the error type which has occured.
223 * @param errormessage The error text of the error that occured.
225 virtual void OnError(ResolverError e, const std::string &errormessage);
227 * Returns the id value of this class. This is primarily used by the core
228 * to determine where in various tables to place a pointer to your class, but it
229 * is safe to call and use this method.
230 * As specified in RFC1035, each dns request has a 16 bit ID value, ranging
231 * from 0 to 65535. If there is an issue and the core cannot send your request,
232 * this method will return -1.
237 * Returns the creator module, or NULL
239 Module* GetCreator();
242 /** DNS is a singleton class used by the core to dispatch dns
243 * requests to the dns server, and route incoming dns replies
244 * back to Resolver objects, based upon the request ID. You
245 * should never use this class yourself.
247 class DNS : public EventHandler
251 InspIRCd* ServerInstance;
254 * The maximum value of a dns request id,
255 * 16 bits wide, 0xFFFF.
257 static const int MAX_REQUEST_ID = 0xFFFF;
260 * Requests that are currently 'in flight'
262 requestlist requests;
265 * Server address being used currently
267 insp_inaddr myserver;
270 * A counter used to form part of the pseudo-random id
275 * We have to turn off a few checks on received packets
276 * when people are using 4in6 (e.g. ::ffff:xxxx). This is
277 * a temporary kludge, Please let me know if you know how
283 * Build a dns packet payload
285 int MakePayload(const char* name, const QueryType rr, const unsigned short rr_class, unsigned char* payload);
289 * Currently active Resolver classes
291 Resolver* Classes[MAX_REQUEST_ID];
293 * The port number DNS requests are made on,
294 * and replies have as a source-port number.
296 static const int QUERY_PORT = 53;
299 * Fill an rr (resource record) with data from input
301 static void FillResourceRecord(ResourceRecord* rr, const unsigned char* input);
303 * Fill a header with data from input limited by a length
305 static void FillHeader(DNSHeader *header, const unsigned char *input, const int length);
307 * Empty out a header into a data stream ready for transmission "on the wire"
309 static void EmptyHeader(unsigned char *output, const DNSHeader *header, const int length);
311 * Start the lookup of an ipv4 from a hostname
313 int GetIP(const char* name);
316 * Start the lookup of a hostname from an ip,
317 * always using the protocol inspircd is built for,
318 * e.g. use ipv6 reverse lookup when built for ipv6,
319 * or ipv4 lookup when built for ipv4.
321 int GetName(const insp_inaddr* ip);
324 * Start lookup of a hostname from an ip, but
325 * force a specific protocol to be used for the lookup
326 * for example to perform an ipv6 reverse lookup.
328 int GetNameForce(const char *ip, ForceProtocol fp);
331 * Start lookup of an ipv6 from a hostname
333 int GetIP6(const char *name);
336 * Start lookup of a CNAME from another hostname
338 int GetCName(const char* alias);
341 * Fetch the result string (an ip or host)
342 * and/or an error message to go with it.
344 DNSResult GetResult();
347 * Handle a SocketEngine read event
348 * Inherited from EventHandler
350 void HandleEvent(EventType et, int errornum = 0);
353 * Add a Resolver* to the list of active classes
355 bool AddResolverClass(Resolver* r);
358 * Add a query to the list to be sent
360 DNSRequest* AddQuery(DNSHeader *header, int &id);
363 * The constructor initialises the dns socket,
364 * and clears the request lists.
366 DNS(InspIRCd* Instance);
373 /** Portable random number generator, generates
374 * its random number from the ircd stats counters,
375 * effective user id, time of day and the rollover
378 unsigned long PRNG();
381 * Turn an in6_addr into a .ip6.arpa domain
383 static void MakeIP6Int(char* query, const in6_addr *ip);
386 * Clean out all dns resolvers owned by a particular
387 * module, to make unloading a module safe if there
388 * are dns requests currently in progress.
390 void CleanResolvers(Module* module);