[irc/quakenet/snircd.git] / include / res.h

/** @file
 * @brief IRC resolver API.
 * @version $Id: res.h,v 1.17.2.2 2006/03/14 03:45:52 entrope Exp $
 */

#ifndef INCLUDED_res_h
#define INCLUDED_res_h

#ifndef INCLUDED_config_h
#include "config.h"
#endif

#ifndef INCLUDED_sys_types_h
#include <sys/types.h>
#define INCLUDED_sys_types_h
#endif

#ifndef INCLUDED_sys_socket_h
#include <sys/socket.h>
#define INCLUDED_sys_socket_h
#endif

#include <netdb.h>

#ifndef INCLUDED_netinet_in_h
#include <netinet/in.h>
#define INCLUDED_netinet_in_h
#endif

#ifdef HAVE_STDINT_H
#ifndef INCLUDED_stdint_h
#include <stdint.h>
#define INCLUDED_stdint_h
#endif
#endif

struct Client;
struct StatDesc;

/* Here we define some values lifted from nameser.h */
#define NS_INT16SZ 2 /**< Size of a 16-bit value. */
#define NS_INT32SZ 4 /**< Size of a 32-bit value. */
#define NS_CMPRSFLGS 0xc0 /**< Prefix flags that indicate special types */
#define NS_MAXCDNAME 255 /**< Maximum length of a compressed domain name. */
#define QUERY 0      /**< Forward (normal) DNS query operation. */
#define NO_ERRORS 0  /**< No errors processing a query. */
#define SERVFAIL 2   /**< Server error while processing a query. */
#define NXDOMAIN 3   /**< Domain name in query does not exist. */
#define T_A 1        /**< Hostname -> IPv4 query type. */
#define T_AAAA 28    /**< Hostname -> IPv6 query type. */
#define T_PTR 12     /**< IP(v4 or v6) -> hostname query type. */
#define T_CNAME 5    /**< Canonical name resolution query type. */
#define C_IN 1       /**< Internet query class. */
#define QFIXEDSZ 4   /**< Length of fixed-size part of query. */
#define HFIXEDSZ 12  /**< Length of fixed-size DNS header. */

/** Structure to store an IP address. */
struct irc_in_addr
{
  unsigned short in6_16[8]; /**< IPv6 encoded parts, little-endian. */
};

/** Structure to store an IP address and port number. */
struct irc_sockaddr
{
  struct irc_in_addr addr; /**< IP address. */
  unsigned short port;     /**< Port number, host-endian. */
};

/** DNS callback function signature. */
typedef void (*dns_callback_f)(void *vptr, const struct irc_in_addr *addr, const char *h_name);

/** DNS query and response header. */
typedef struct
{
	unsigned	id :16;		/**< query identification number */
#ifdef WORDS_BIGENDIAN
			/* fields in third byte */
	unsigned	qr: 1;		/**< response flag */
	unsigned	opcode: 4;	/**< purpose of message */
	unsigned	aa: 1;		/**< authoritive answer */
	unsigned	tc: 1;		/**< truncated message */
	unsigned	rd: 1;		/**< recursion desired */
			/* fields in fourth byte */
	unsigned	ra: 1;		/**< recursion available */
	unsigned	unused :1;	/**< unused bits (MBZ as of 4.9.3a3) */
	unsigned	ad: 1;		/**< authentic data from named */
	unsigned	cd: 1;		/**< checking disabled by resolver */
	unsigned	rcode :4;	/**< response code */
#else
			/* fields in third byte */
	unsigned	rd :1;		/**< recursion desired */
	unsigned	tc :1;		/**< truncated message */
	unsigned	aa :1;		/**< authoritive answer */
	unsigned	opcode :4;	/**< purpose of message */
	unsigned	qr :1;		/**< response flag */
			/* fields in fourth byte */
	unsigned	rcode :4;	/**< response code */
	unsigned	cd: 1;		/**< checking disabled by resolver */
	unsigned	ad: 1;		/**< authentic data from named */
	unsigned	unused :1;	/**< unused bits (MBZ as of 4.9.3a3) */
	unsigned	ra :1;		/**< recursion available */
#endif
			/* remaining bytes */
	unsigned	qdcount :16;	/**< number of question entries */
	unsigned	ancount :16;	/**< number of answer entries */
	unsigned	nscount :16;	/**< number of authority entries */
	unsigned	arcount :16;	/**< number of resource entries */
} HEADER;

extern void restart_resolver(void);
extern void add_local_domain(char *hname, size_t size);
extern size_t cres_mem(struct Client* cptr);
extern void delete_resolver_queries(const void *vptr);
extern void report_dns_servers(struct Client *source_p, const struct StatDesc *sd, char *param);
extern void gethost_byname(const char *name, dns_callback_f callback, void *ctx);
extern void gethost_byaddr(const struct irc_in_addr *addr, dns_callback_f callback, void *ctx);

/** Evaluate to non-zero if \a ADDR is an unspecified (all zeros) address. */
#define irc_in_addr_unspec(ADDR) (((ADDR)->in6_16[0] == 0) \
                                  && ((ADDR)->in6_16[1] == 0) \
                                  && ((ADDR)->in6_16[2] == 0) \
                                  && ((ADDR)->in6_16[3] == 0) \
                                  && ((ADDR)->in6_16[4] == 0) \
                                  && ((ADDR)->in6_16[6] == 0) \
                                  && ((ADDR)->in6_16[7] == 0) \
                                  && ((ADDR)->in6_16[5] == 0 \
                                      || (ADDR)->in6_16[5] == 65535))
/** Evaluate to non-zero if \a ADDR is a valid address (not all 0s and not all 1s). */
#define irc_in_addr_valid(ADDR) (((ADDR)->in6_16[0] && ~(ADDR)->in6_16[0]) \
                                 || (ADDR)->in6_16[1] != (ADDR)->in6_16[0] \
                                 || (ADDR)->in6_16[2] != (ADDR)->in6_16[0] \
                                 || (ADDR)->in6_16[3] != (ADDR)->in6_16[0] \
                                 || (ADDR)->in6_16[4] != (ADDR)->in6_16[0] \
                                 || (ADDR)->in6_16[5] != (ADDR)->in6_16[0] \
                                 || (ADDR)->in6_16[6] != (ADDR)->in6_16[0] \
                                 || (ADDR)->in6_16[7] != (ADDR)->in6_16[0])
/** Evaluate to non-zero if \a ADDR (of type struct irc_in_addr) is an IPv4 address. */
#define irc_in_addr_is_ipv4(ADDR) (!(ADDR)->in6_16[0] && !(ADDR)->in6_16[1] && !(ADDR)->in6_16[2] \
                                   && !(ADDR)->in6_16[3] && !(ADDR)->in6_16[4] && (ADDR)->in6_16[6] \
                                   && (!(ADDR)->in6_16[5] || (ADDR)->in6_16[5] == 65535))
/** Evaluate to non-zero if \a A is a different IP than \a B. */
#define irc_in_addr_cmp(A,B) (irc_in_addr_is_ipv4(A) ? ((A)->in6_16[6] != (B)->in6_16[6] \
                                  || (A)->in6_16[7] != (B)->in6_16[7] || !irc_in_addr_is_ipv4(B)) \
                              : memcmp((A), (B), sizeof(struct irc_in_addr)))
/** Evaluate to non-zero if \a ADDR is a loopback address. */
#define irc_in_addr_is_loopback(ADDR) (!(ADDR)->in6_16[0] && !(ADDR)->in6_16[1] && !(ADDR)->in6_16[2] \
                                       && !(ADDR)->in6_16[3] && !(ADDR)->in6_16[4] \
                                       && ((!(ADDR)->in6_16[5] \
                                            && ((!(ADDR)->in6_16[6] && (ADDR)->in6_16[7] == htons(1)) \
                                                || (ntohs((ADDR)->in6_16[6]) & 0xff00) == 0x7f00)) \
                                           || (((ADDR)->in6_16[5] == 65535) \
                                               && (ntohs((ADDR)->in6_16[6]) & 0xff00) == 0x7f00)))

#endif
Commit	Line	Data
189935b1	1	/** @file
189935b1	2	* @brief IRC resolver API.
9f8856e9	3	* @version $Id: res.h,v 1.17.2.2 2006/03/14 03:45:52 entrope Exp $
189935b1	4	*/
	5
	6	#ifndef INCLUDED_res_h
	7	#define INCLUDED_res_h
	8
	9	#ifndef INCLUDED_config_h
	10	#include "config.h"
	11	#endif
	12
	13	#ifndef INCLUDED_sys_types_h
	14	#include <sys/types.h>
	15	#define INCLUDED_sys_types_h
	16	#endif
	17
	18	#ifndef INCLUDED_sys_socket_h
	19	#include <sys/socket.h>
	20	#define INCLUDED_sys_socket_h
	21	#endif
	22
	23	#include <netdb.h>
	24
	25	#ifndef INCLUDED_netinet_in_h
	26	#include <netinet/in.h>
	27	#define INCLUDED_netinet_in_h
	28	#endif
	29
	30	#ifdef HAVE_STDINT_H
	31	#ifndef INCLUDED_stdint_h
	32	#include <stdint.h>
	33	#define INCLUDED_stdint_h
	34	#endif
	35	#endif
	36
	37	struct Client;
	38	struct StatDesc;
	39
	40	/* Here we define some values lifted from nameser.h */
	41	#define NS_INT16SZ 2 /*< Size of a 16-bit value. /
	42	#define NS_INT32SZ 4 /*< Size of a 32-bit value. /
	43	#define NS_CMPRSFLGS 0xc0 /*< Prefix flags that indicate special types /
	44	#define NS_MAXCDNAME 255 /*< Maximum length of a compressed domain name. /
	45	#define QUERY 0 /*< Forward (normal) DNS query operation. /
	46	#define NO_ERRORS 0 /*< No errors processing a query. /
	47	#define SERVFAIL 2 /*< Server error while processing a query. /
9f8856e9	48	#define NXDOMAIN 3 /*< Domain name in query does not exist. /
189935b1	49	#define T_A 1 /*< Hostname -> IPv4 query type. /
	50	#define T_AAAA 28 /*< Hostname -> IPv6 query type. /
	51	#define T_PTR 12 /*< IP(v4 or v6) -> hostname query type. /
	52	#define T_CNAME 5 /*< Canonical name resolution query type. /
	53	#define C_IN 1 /*< Internet query class. /
	54	#define QFIXEDSZ 4 /*< Length of fixed-size part of query. /
	55	#define HFIXEDSZ 12 /*< Length of fixed-size DNS header. /
	56
	57	/** Structure to store an IP address. */
	58	struct irc_in_addr
	59	{
	60	unsigned short in6_16[8]; /*< IPv6 encoded parts, little-endian. /
	61	};
	62
	63	/** Structure to store an IP address and port number. */
	64	struct irc_sockaddr
	65	{
	66	struct irc_in_addr addr; /*< IP address. /
	67	unsigned short port; /*< Port number, host-endian. /
	68	};
	69
	70	/** DNS callback function signature. */
	71	typedef void (dns_callback_f)(void vptr, const struct irc_in_addr addr, const char h_name);
	72
	73	/** DNS query and response header. */
	74	typedef struct
	75	{
	76	unsigned id :16; /*< query identification number /
	77	#ifdef WORDS_BIGENDIAN
	78	/* fields in third byte */
	79	unsigned qr: 1; /*< response flag /
	80	unsigned opcode: 4; /*< purpose of message /
	81	unsigned aa: 1; /*< authoritive answer /
	82	unsigned tc: 1; /*< truncated message /
	83	unsigned rd: 1; /*< recursion desired /
	84	/* fields in fourth byte */
	85	unsigned ra: 1; /*< recursion available /
	86	unsigned unused :1; /*< unused bits (MBZ as of 4.9.3a3) /
	87	unsigned ad: 1; /*< authentic data from named /
	88	unsigned cd: 1; /*< checking disabled by resolver /
	89	unsigned rcode :4; /*< response code /
	90	#else
	91	/* fields in third byte */
	92	unsigned rd :1; /*< recursion desired /
	93	unsigned tc :1; /*< truncated message /
	94	unsigned aa :1; /*< authoritive answer /
	95	unsigned opcode :4; /*< purpose of message /
	96	unsigned qr :1; /*< response flag /
	97	/* fields in fourth byte */
	98	unsigned rcode :4; /*< response code /
	99	unsigned cd: 1; /*< checking disabled by resolver /
	100	unsigned ad: 1; /*< authentic data from named /
	101	unsigned unused :1; /*< unused bits (MBZ as of 4.9.3a3) /
	102	unsigned ra :1; /*< recursion available /
	103	#endif
	104	/* remaining bytes */
	105	unsigned qdcount :16; /*< number of question entries /
	106	unsigned ancount :16; /*< number of answer entries /
	107	unsigned nscount :16; /*< number of authority entries /
	108	unsigned arcount :16; /*< number of resource entries /
	109	} HEADER;
	110
	111	extern void restart_resolver(void);
	112	extern void add_local_domain(char *hname, size_t size);
113	extern size_t cres_mem(struct Client* cptr);
114	extern void delete_resolver_queries(const void *vptr);
115	extern void report_dns_servers(struct Client source_p, const struct StatDesc sd, char *param);
116	extern void gethost_byname(const char name, dns_callback_f callback, void ctx);
117	extern void gethost_byaddr(const struct irc_in_addr addr, dns_callback_f callback, void ctx);
118
9f8856e9	119	/** Evaluate to non-zero if \a ADDR is an unspecified (all zeros) address. */
	120	#define irc_in_addr_unspec(ADDR) (((ADDR)->in6_16[0] == 0) \
	121	&& ((ADDR)->in6_16[1] == 0) \
	122	&& ((ADDR)->in6_16[2] == 0) \
	123	&& ((ADDR)->in6_16[3] == 0) \
	124	&& ((ADDR)->in6_16[4] == 0) \
	125	&& ((ADDR)->in6_16[6] == 0) \
	126	&& ((ADDR)->in6_16[7] == 0) \
	127	&& ((ADDR)->in6_16[5] == 0 \
	128	\|\| (ADDR)->in6_16[5] == 65535))
189935b1	129	/** Evaluate to non-zero if \a ADDR is a valid address (not all 0s and not all 1s). */
	130	#define irc_in_addr_valid(ADDR) (((ADDR)->in6_16[0] && ~(ADDR)->in6_16[0]) \
	131	\|\| (ADDR)->in6_16[1] != (ADDR)->in6_16[0] \
	132	\|\| (ADDR)->in6_16[2] != (ADDR)->in6_16[0] \
	133	\|\| (ADDR)->in6_16[3] != (ADDR)->in6_16[0] \
	134	\|\| (ADDR)->in6_16[4] != (ADDR)->in6_16[0] \
	135	\|\| (ADDR)->in6_16[5] != (ADDR)->in6_16[0] \
	136	\|\| (ADDR)->in6_16[6] != (ADDR)->in6_16[0] \
	137	\|\| (ADDR)->in6_16[7] != (ADDR)->in6_16[0])
	138	/** Evaluate to non-zero if \a ADDR (of type struct irc_in_addr) is an IPv4 address. */
	139	#define irc_in_addr_is_ipv4(ADDR) (!(ADDR)->in6_16[0] && !(ADDR)->in6_16[1] && !(ADDR)->in6_16[2] \
	140	&& !(ADDR)->in6_16[3] && !(ADDR)->in6_16[4] && (ADDR)->in6_16[6] \
	141	&& (!(ADDR)->in6_16[5] \|\| (ADDR)->in6_16[5] == 65535))
	142	/** Evaluate to non-zero if \a A is a different IP than \a B. */
	143	#define irc_in_addr_cmp(A,B) (irc_in_addr_is_ipv4(A) ? ((A)->in6_16[6] != (B)->in6_16[6] \
	144	\|\| (A)->in6_16[7] != (B)->in6_16[7] \|\| !irc_in_addr_is_ipv4(B)) \
	145	: memcmp((A), (B), sizeof(struct irc_in_addr)))
	146	/** Evaluate to non-zero if \a ADDR is a loopback address. */
	147	#define irc_in_addr_is_loopback(ADDR) (!(ADDR)->in6_16[0] && !(ADDR)->in6_16[1] && !(ADDR)->in6_16[2] \
	148	&& !(ADDR)->in6_16[3] && !(ADDR)->in6_16[4] \
	149	&& ((!(ADDR)->in6_16[5] \
	150	&& ((!(ADDR)->in6_16[6] && (ADDR)->in6_16[7] == htons(1)) \
	151	\|\| (ntohs((ADDR)->in6_16[6]) & 0xff00) == 0x7f00)) \
	152	\|\| (((ADDR)->in6_16[5] == 65535) \
	153	&& (ntohs((ADDR)->in6_16[6]) & 0xff00) == 0x7f00)))
	154
	155	#endif