nameser.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. /*
  2. * Copyright (c) 1983, 1989, 1993
  3. * The Regents of the University of California. All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions
  7. * are met:
  8. * 1. Redistributions of source code must retain the above copyright
  9. * notice, this list of conditions and the following disclaimer.
  10. * 2. Redistributions in binary form must reproduce the above copyright
  11. * notice, this list of conditions and the following disclaimer in the
  12. * documentation and/or other materials provided with the distribution.
  13. * 4. Neither the name of the University nor the names of its contributors
  14. * may be used to endorse or promote products derived from this software
  15. * without specific prior written permission.
  16. *
  17. * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20. * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27. * SUCH DAMAGE.
  28. */
  29. /*
  30. * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
  31. * Copyright (c) 1996-1999 by Internet Software Consortium.
  32. *
  33. * Permission to use, copy, modify, and distribute this software for any
  34. * purpose with or without fee is hereby granted, provided that the above
  35. * copyright notice and this permission notice appear in all copies.
  36. *
  37. * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
  38. * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
  39. * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
  40. * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  41. * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  42. * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  43. * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  44. * SOFTWARE.
  45. */
  46. #ifndef _ARPA_NAMESER_H_
  47. #define _ARPA_NAMESER_H_
  48. #include <sys/param.h>
  49. #include <sys/types.h>
  50. #include <stdint.h>
  51. #ifdef _LIBC
  52. # define __NAMESER_DEPRECATED
  53. #else
  54. # define __NAMESER_DEPRECATED __attribute_deprecated__
  55. #endif
  56. /*
  57. * Define constants based on RFC 883, RFC 1034, RFC 1035
  58. */
  59. #define NS_PACKETSZ 512 /*%< default UDP packet size */
  60. #define NS_MAXDNAME 1025 /*%< maximum domain name */
  61. #define NS_MAXMSG 65535 /*%< maximum message size */
  62. #define NS_MAXCDNAME 255 /*%< maximum compressed domain name */
  63. #define NS_MAXLABEL 63 /*%< maximum length of domain label */
  64. #define NS_HFIXEDSZ 12 /*%< #/bytes of fixed data in header */
  65. #define NS_QFIXEDSZ 4 /*%< #/bytes of fixed data in query */
  66. #define NS_RRFIXEDSZ 10 /*%< #/bytes of fixed data in r record */
  67. #define NS_INT32SZ 4 /*%< #/bytes of data in a uint32_t */
  68. #define NS_INT16SZ 2 /*%< #/bytes of data in a uint16_t */
  69. #define NS_INT8SZ 1 /*%< #/bytes of data in a uint8_t */
  70. #define NS_INADDRSZ 4 /*%< IPv4 T_A */
  71. #define NS_IN6ADDRSZ 16 /*%< IPv6 T_AAAA */
  72. #define NS_CMPRSFLGS 0xc0 /*%< Flag bits indicating name compression. */
  73. #define NS_DEFAULTPORT 53 /*%< For both TCP and UDP. */
  74. /*
  75. * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
  76. * in synch with it.
  77. */
  78. typedef enum __ns_sect {
  79. ns_s_qd = 0, /*%< Query: Question. */
  80. ns_s_zn = 0, /*%< Update: Zone. */
  81. ns_s_an = 1, /*%< Query: Answer. */
  82. ns_s_pr = 1, /*%< Update: Prerequisites. */
  83. ns_s_ns = 2, /*%< Query: Name servers. */
  84. ns_s_ud = 2, /*%< Update: Update. */
  85. ns_s_ar = 3, /*%< Query|Update: Additional records. */
  86. ns_s_max = 4
  87. } ns_sect;
  88. /*%
  89. * This is a message handle. It is caller allocated and has no dynamic data.
  90. * This structure is intended to be opaque to all but ns_parse.c, thus the
  91. * leading _'s on the member names. Use the accessor functions, not the _'s.
  92. */
  93. typedef struct __ns_msg {
  94. const unsigned char *_msg, *_eom;
  95. uint16_t _id, _flags, _counts[ns_s_max];
  96. const unsigned char *_sections[ns_s_max];
  97. ns_sect _sect;
  98. int _rrnum;
  99. const unsigned char *_msg_ptr;
  100. } ns_msg;
  101. /* Private data structure - do not use from outside library. */
  102. struct _ns_flagdata { int mask, shift; };
  103. extern const struct _ns_flagdata _ns_flagdata[];
  104. /* Accessor macros - this is part of the public interface. */
  105. #define ns_msg_id(handle) ((handle)._id + 0)
  106. #define ns_msg_base(handle) ((handle)._msg + 0)
  107. #define ns_msg_end(handle) ((handle)._eom + 0)
  108. #define ns_msg_size(handle) ((handle)._eom - (handle)._msg)
  109. #define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
  110. /*%
  111. * This is a parsed record. It is caller allocated and has no dynamic data.
  112. */
  113. typedef struct __ns_rr {
  114. char name[NS_MAXDNAME];
  115. uint16_t type;
  116. uint16_t rr_class;
  117. uint32_t ttl;
  118. uint16_t rdlength;
  119. const unsigned char * rdata;
  120. } ns_rr;
  121. /* Accessor macros - this is part of the public interface. */
  122. #define ns_rr_name(rr) (((rr).name[0] != '\0') ? (rr).name : ".")
  123. #define ns_rr_type(rr) ((ns_type)((rr).type + 0))
  124. #define ns_rr_class(rr) ((ns_class)((rr).rr_class + 0))
  125. #define ns_rr_ttl(rr) ((rr).ttl + 0)
  126. #define ns_rr_rdlen(rr) ((rr).rdlength + 0)
  127. #define ns_rr_rdata(rr) ((rr).rdata + 0)
  128. /*%
  129. * These don't have to be in the same order as in the packet flags word,
  130. * and they can even overlap in some cases, but they will need to be kept
  131. * in synch with ns_parse.c:ns_flagdata[].
  132. */
  133. typedef enum __ns_flag {
  134. ns_f_qr, /*%< Question/Response. */
  135. ns_f_opcode, /*%< Operation code. */
  136. ns_f_aa, /*%< Authoritative Answer. */
  137. ns_f_tc, /*%< Truncation occurred. */
  138. ns_f_rd, /*%< Recursion Desired. */
  139. ns_f_ra, /*%< Recursion Available. */
  140. ns_f_z, /*%< MBZ. */
  141. ns_f_ad, /*%< Authentic Data (DNSSEC). */
  142. ns_f_cd, /*%< Checking Disabled (DNSSEC). */
  143. ns_f_rcode, /*%< Response code. */
  144. ns_f_max
  145. } ns_flag;
  146. /*%
  147. * Currently defined opcodes.
  148. */
  149. typedef enum __ns_opcode {
  150. ns_o_query = 0, /*%< Standard query. */
  151. ns_o_iquery = 1, /*%< Inverse query (deprecated/unsupported). */
  152. ns_o_status = 2, /*%< Name server status query (unsupported). */
  153. /* Opcode 3 is undefined/reserved. */
  154. ns_o_notify = 4, /*%< Zone change notification. */
  155. ns_o_update = 5, /*%< Zone update message. */
  156. ns_o_max = 6
  157. } ns_opcode;
  158. /*%
  159. * Currently defined response codes.
  160. */
  161. typedef enum __ns_rcode {
  162. ns_r_noerror = 0, /*%< No error occurred. */
  163. ns_r_formerr = 1, /*%< Format error. */
  164. ns_r_servfail = 2, /*%< Server failure. */
  165. ns_r_nxdomain = 3, /*%< Name error. */
  166. ns_r_notimpl = 4, /*%< Unimplemented. */
  167. ns_r_refused = 5, /*%< Operation refused. */
  168. /* these are for BIND_UPDATE */
  169. ns_r_yxdomain = 6, /*%< Name exists */
  170. ns_r_yxrrset = 7, /*%< RRset exists */
  171. ns_r_nxrrset = 8, /*%< RRset does not exist */
  172. ns_r_notauth = 9, /*%< Not authoritative for zone */
  173. ns_r_notzone = 10, /*%< Zone of record different from zone section */
  174. ns_r_max = 11,
  175. /* The following are EDNS extended rcodes */
  176. ns_r_badvers = 16,
  177. /* The following are TSIG errors */
  178. ns_r_badsig = 16,
  179. ns_r_badkey = 17,
  180. ns_r_badtime = 18
  181. } ns_rcode;
  182. /* BIND_UPDATE */
  183. typedef enum __ns_update_operation {
  184. ns_uop_delete = 0,
  185. ns_uop_add = 1,
  186. ns_uop_max = 2
  187. } ns_update_operation;
  188. /*%
  189. * This structure is used for TSIG authenticated messages
  190. */
  191. struct ns_tsig_key {
  192. char name[NS_MAXDNAME], alg[NS_MAXDNAME];
  193. unsigned char *data;
  194. int len;
  195. };
  196. typedef struct ns_tsig_key ns_tsig_key;
  197. /*%
  198. * This structure is used for TSIG authenticated TCP messages
  199. */
  200. struct ns_tcp_tsig_state {
  201. int counter;
  202. struct dst_key *key;
  203. void *ctx;
  204. unsigned char sig[NS_PACKETSZ];
  205. int siglen;
  206. };
  207. typedef struct ns_tcp_tsig_state ns_tcp_tsig_state;
  208. #define NS_TSIG_FUDGE 300
  209. #define NS_TSIG_TCP_COUNT 100
  210. #define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"
  211. #define NS_TSIG_ERROR_NO_TSIG -10
  212. #define NS_TSIG_ERROR_NO_SPACE -11
  213. #define NS_TSIG_ERROR_FORMERR -12
  214. /*%
  215. * Currently defined type values for resources and queries.
  216. */
  217. typedef enum __ns_type
  218. {
  219. ns_t_invalid = 0,
  220. ns_t_a = 1,
  221. ns_t_ns = 2,
  222. ns_t_md = 3,
  223. ns_t_mf = 4,
  224. ns_t_cname = 5,
  225. ns_t_soa = 6,
  226. ns_t_mb = 7,
  227. ns_t_mg = 8,
  228. ns_t_mr = 9,
  229. ns_t_null = 10,
  230. ns_t_wks = 11,
  231. ns_t_ptr = 12,
  232. ns_t_hinfo = 13,
  233. ns_t_minfo = 14,
  234. ns_t_mx = 15,
  235. ns_t_txt = 16,
  236. ns_t_rp = 17,
  237. ns_t_afsdb = 18,
  238. ns_t_x25 = 19,
  239. ns_t_isdn = 20,
  240. ns_t_rt = 21,
  241. ns_t_nsap = 22,
  242. ns_t_nsap_ptr = 23,
  243. ns_t_sig = 24,
  244. ns_t_key = 25,
  245. ns_t_px = 26,
  246. ns_t_gpos = 27,
  247. ns_t_aaaa = 28,
  248. ns_t_loc = 29,
  249. ns_t_nxt = 30,
  250. ns_t_eid = 31,
  251. ns_t_nimloc = 32,
  252. ns_t_srv = 33,
  253. ns_t_atma = 34,
  254. ns_t_naptr = 35,
  255. ns_t_kx = 36,
  256. ns_t_cert = 37,
  257. ns_t_a6 = 38,
  258. ns_t_dname = 39,
  259. ns_t_sink = 40,
  260. ns_t_opt = 41,
  261. ns_t_apl = 42,
  262. ns_t_ds = 43,
  263. ns_t_sshfp = 44,
  264. ns_t_ipseckey = 45,
  265. ns_t_rrsig = 46,
  266. ns_t_nsec = 47,
  267. ns_t_dnskey = 48,
  268. ns_t_dhcid = 49,
  269. ns_t_nsec3 = 50,
  270. ns_t_nsec3param = 51,
  271. ns_t_tlsa = 52,
  272. ns_t_smimea = 53,
  273. ns_t_hip = 55,
  274. ns_t_ninfo = 56,
  275. ns_t_rkey = 57,
  276. ns_t_talink = 58,
  277. ns_t_cds = 59,
  278. ns_t_cdnskey = 60,
  279. ns_t_openpgpkey = 61,
  280. ns_t_csync = 62,
  281. ns_t_spf = 99,
  282. ns_t_uinfo = 100,
  283. ns_t_uid = 101,
  284. ns_t_gid = 102,
  285. ns_t_unspec = 103,
  286. ns_t_nid = 104,
  287. ns_t_l32 = 105,
  288. ns_t_l64 = 106,
  289. ns_t_lp = 107,
  290. ns_t_eui48 = 108,
  291. ns_t_eui64 = 109,
  292. ns_t_tkey = 249,
  293. ns_t_tsig = 250,
  294. ns_t_ixfr = 251,
  295. ns_t_axfr = 252,
  296. ns_t_mailb = 253,
  297. ns_t_maila = 254,
  298. ns_t_any = 255,
  299. ns_t_uri = 256,
  300. ns_t_caa = 257,
  301. ns_t_avc = 258,
  302. ns_t_ta = 32768,
  303. ns_t_dlv = 32769,
  304. ns_t_max = 65536
  305. } ns_type;
  306. /*%
  307. * Values for class field
  308. */
  309. typedef enum __ns_class {
  310. ns_c_invalid = 0, /*%< Cookie. */
  311. ns_c_in = 1, /*%< Internet. */
  312. ns_c_2 = 2, /*%< unallocated/unsupported. */
  313. ns_c_chaos = 3, /*%< MIT Chaos-net. */
  314. ns_c_hs = 4, /*%< MIT Hesiod. */
  315. /* Query class values which do not appear in resource records */
  316. ns_c_none = 254, /*%< for prereq. sections in update requests */
  317. ns_c_any = 255, /*%< Wildcard match. */
  318. ns_c_max = 65536
  319. } ns_class;
  320. /* Certificate type values in CERT resource records. */
  321. typedef enum __ns_cert_types {
  322. cert_t_pkix = 1, /*%< PKIX (X.509v3) */
  323. cert_t_spki = 2, /*%< SPKI */
  324. cert_t_pgp = 3, /*%< PGP */
  325. cert_t_url = 253, /*%< URL private type */
  326. cert_t_oid = 254 /*%< OID private type */
  327. } ns_cert_types;
  328. /*%
  329. * EDNS0 extended flags and option codes, host order.
  330. */
  331. #define NS_OPT_DNSSEC_OK 0x8000U
  332. #define NS_OPT_NSID 3
  333. /*%
  334. * Inline versions of get/put short/long. Pointer is advanced.
  335. */
  336. #define NS_GET16(s, cp) do { \
  337. const unsigned char *t_cp = (const unsigned char *)(cp); \
  338. (s) = ((uint16_t)t_cp[0] << 8) \
  339. | ((uint16_t)t_cp[1]) \
  340. ; \
  341. (cp) += NS_INT16SZ; \
  342. } while (0)
  343. #define NS_GET32(l, cp) do { \
  344. const unsigned char *t_cp = (const unsigned char *)(cp); \
  345. (l) = ((uint32_t)t_cp[0] << 24) \
  346. | ((uint32_t)t_cp[1] << 16) \
  347. | ((uint32_t)t_cp[2] << 8) \
  348. | ((uint32_t)t_cp[3]) \
  349. ; \
  350. (cp) += NS_INT32SZ; \
  351. } while (0)
  352. #define NS_PUT16(s, cp) do { \
  353. uint16_t t_s = (uint16_t)(s); \
  354. unsigned char *t_cp = (unsigned char *)(cp); \
  355. *t_cp++ = t_s >> 8; \
  356. *t_cp = t_s; \
  357. (cp) += NS_INT16SZ; \
  358. } while (0)
  359. #define NS_PUT32(l, cp) do { \
  360. uint32_t t_l = (uint32_t)(l); \
  361. unsigned char *t_cp = (unsigned char *)(cp); \
  362. *t_cp++ = t_l >> 24; \
  363. *t_cp++ = t_l >> 16; \
  364. *t_cp++ = t_l >> 8; \
  365. *t_cp = t_l; \
  366. (cp) += NS_INT32SZ; \
  367. } while (0)
  368. __BEGIN_DECLS
  369. int ns_msg_getflag (ns_msg, int) __THROW;
  370. unsigned int ns_get16 (const unsigned char *) __THROW;
  371. unsigned long ns_get32 (const unsigned char *) __THROW;
  372. void ns_put16 (unsigned int, unsigned char *) __THROW;
  373. void ns_put32 (unsigned long, unsigned char *) __THROW;
  374. int ns_initparse (const unsigned char *, int, ns_msg *) __THROW;
  375. int ns_skiprr (const unsigned char *, const unsigned char *,
  376. ns_sect, int) __THROW;
  377. int ns_parserr (ns_msg *, ns_sect, int, ns_rr *) __THROW;
  378. int ns_sprintrr (const ns_msg *, const ns_rr *,
  379. const char *, const char *, char *, size_t)
  380. __THROW __NAMESER_DEPRECATED;
  381. int ns_sprintrrf (const unsigned char *, size_t, const char *,
  382. ns_class, ns_type, unsigned long,
  383. const unsigned char *, size_t, const char *,
  384. const char *, char *, size_t)
  385. __THROW __NAMESER_DEPRECATED;
  386. int ns_format_ttl (unsigned long, char *, size_t)
  387. __THROW __NAMESER_DEPRECATED;
  388. int ns_parse_ttl (const char *, unsigned long *)
  389. __THROW __NAMESER_DEPRECATED;
  390. uint32_t ns_datetosecs (const char *, int *)
  391. __THROW __NAMESER_DEPRECATED;
  392. int ns_name_ntol (const unsigned char *, unsigned char *, size_t)
  393. __THROW;
  394. int ns_name_ntop (const unsigned char *, char *, size_t) __THROW;
  395. int ns_name_pton (const char *, unsigned char *, size_t) __THROW;
  396. int ns_name_unpack (const unsigned char *, const unsigned char *,
  397. const unsigned char *, unsigned char *, size_t)
  398. __THROW;
  399. int ns_name_pack (const unsigned char *, unsigned char *, int,
  400. const unsigned char **, const unsigned char **)
  401. __THROW;
  402. int ns_name_uncompress (const unsigned char *,
  403. const unsigned char *,
  404. const unsigned char *,
  405. char *, size_t) __THROW;
  406. int ns_name_compress (const char *, unsigned char *, size_t,
  407. const unsigned char **,
  408. const unsigned char **) __THROW;
  409. int ns_name_skip (const unsigned char **, const unsigned char *)
  410. __THROW;
  411. void ns_name_rollback (const unsigned char *,
  412. const unsigned char **,
  413. const unsigned char **) __THROW;
  414. int ns_samedomain (const char *, const char *) __THROW
  415. __NAMESER_DEPRECATED;
  416. int ns_subdomain (const char *, const char *) __THROW
  417. __NAMESER_DEPRECATED;
  418. int ns_makecanon (const char *, char *, size_t) __THROW
  419. __NAMESER_DEPRECATED;
  420. int ns_samename (const char *, const char *) __THROW
  421. __NAMESER_DEPRECATED;
  422. __END_DECLS
  423. #include <arpa/nameser_compat.h>
  424. #endif /* !_ARPA_NAMESER_H_ */
  425. /*! \file */