2 * Copyright (C) 2008, 2009 Internet Systems Consortium, Inc. ("ISC")
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14 * PERFORMANCE OF THIS SOFTWARE.
17 /* $Id: nsec3.h,v 1.5.48.2 2009/01/18 23:47:41 tbox Exp $ */
23 #include <isc/iterated_hash.h>
28 #include <dns/rdatastruct.h>
29 #include <dns/types.h>
32 * hash = 1, flags =1, iterations = 2, salt length = 1, salt = 255 (max)
33 * hash length = 1, hash = 255 (max), bitmap = 8192 + 512 (max)
35 #define DNS_NSEC3_BUFFERSIZE (6 + 255 + 255 + 8192 + 512)
37 * hash = 1, flags = 1, iterations = 2, salt length = 1, salt = 255 (max)
39 #define DNS_NSEC3PARAM_BUFFERSIZE (5 + 255)
42 * Test "unknown" algorithm. Is mapped to dns_hash_sha1.
44 #define DNS_NSEC3_UNKNOWNALG 245U
49 dns_nsec3_buildrdata(dns_db_t *db, dns_dbversion_t *version,
50 dns_dbnode_t *node, unsigned int hashalg,
51 unsigned int optin, unsigned int iterations,
52 const unsigned char *salt, size_t salt_length,
53 const unsigned char *nexthash, size_t hash_length,
54 unsigned char *buffer, dns_rdata_t *rdata);
56 * Build the rdata of a NSEC3 record for the data at 'node'.
57 * Note: 'node' is not the node where the NSEC3 record will be stored.
60 * buffer Points to a temporary buffer of at least
61 * DNS_NSEC_BUFFERSIZE bytes.
62 * rdata Points to an initialized dns_rdata_t.
65 * *rdata Contains a valid NSEC3 rdata. The 'data' member refers
70 dns_nsec3_typepresent(dns_rdata_t *nsec, dns_rdatatype_t type);
72 * Determine if a type is marked as present in an NSEC3 record.
75 * 'nsec' points to a valid rdataset of type NSEC3
79 dns_nsec3_hashname(dns_fixedname_t *result,
80 unsigned char rethash[NSEC3_MAX_HASH_LENGTH],
81 size_t *hash_length, dns_name_t *name, dns_name_t *origin,
82 dns_hash_t hashalg, unsigned int iterations,
83 const unsigned char *salt, size_t saltlength);
85 * Make a hashed domain name from an unhashed one. If rethash is not NULL
86 * the raw hash is stored there.
90 dns_nsec3_hashlength(dns_hash_t hash);
92 * Return the length of the hash produced by the specified algorithm
93 * or zero when unknown.
97 dns_nsec3_supportedhash(dns_hash_t hash);
99 * Return whether we support this hash algorithm or not.
103 dns_nsec3_addnsec3(dns_db_t *db, dns_dbversion_t *version,
104 dns_name_t *name, const dns_rdata_nsec3param_t *nsec3param,
105 dns_ttl_t nsecttl, isc_boolean_t unsecure, dns_diff_t *diff);
108 dns_nsec3_addnsec3s(dns_db_t *db, dns_dbversion_t *version,
109 dns_name_t *name, dns_ttl_t nsecttl,
110 isc_boolean_t unsecure, dns_diff_t *diff);
112 * Add NSEC3 records for 'name', recording the change in 'diff'.
113 * Adjust previous NSEC3 records, if any, to reflect the addition.
114 * The existing NSEC3 records are removed.
116 * dns_nsec3_addnsec3() will only add records to the chain identified by
119 * 'unsecure' should be set to reflect if this is a potentially
120 * unsecure delegation (no DS record).
122 * dns_nsec3_addnsec3s() will examine the NSEC3PARAM RRset to determine which
123 * chains to be updated. NSEC3PARAM records with the DNS_NSEC3FLAG_CREATE
124 * will be preferentially chosen over NSEC3PARAM records without
125 * DNS_NSEC3FLAG_CREATE set. NSEC3PARAM records with DNS_NSEC3FLAG_REMOVE
126 * set will be ignored by dns_nsec3_addnsec3s(). If DNS_NSEC3FLAG_CREATE
127 * is set then the new NSEC3 will have OPTOUT set to match the that in the
128 * NSEC3PARAM record otherwise OPTOUT will be inherited from the previous
129 * record in the chain.
133 * 'version' to be valid or NULL.
134 * 'name' to be valid.
135 * 'nsec3param' to be valid.
136 * 'diff' to be valid.
140 dns_nsec3_delnsec3(dns_db_t *db, dns_dbversion_t *version, dns_name_t *name,
141 const dns_rdata_nsec3param_t *nsec3param, dns_diff_t *diff);
144 dns_nsec3_delnsec3s(dns_db_t *db, dns_dbversion_t *version, dns_name_t *name,
147 * Remove NSEC3 records for 'name', recording the change in 'diff'.
148 * Adjust previous NSEC3 records, if any, to reflect the removal.
150 * dns_nsec3_delnsec3() performs the above for the chain identified by
153 * dns_nsec3_delnsec3s() examines the NSEC3PARAM RRset in a similar manner
154 * to dns_nsec3_addnsec3s(). Unlike dns_nsec3_addnsec3s() updated NSEC3
155 * records have the OPTOUT flag preserved.
159 * 'version' to be valid or NULL.
160 * 'name' to be valid.
161 * 'nsec3param' to be valid.
162 * 'diff' to be valid.
166 dns_nsec3_active(dns_db_t *db, dns_dbversion_t *version,
167 isc_boolean_t complete, isc_boolean_t *answer);
169 * Check if there are any complete/to be built NSEC3 chains.
170 * If 'complete' is ISC_TRUE only complete chains will be recognized.
174 * 'version' to be valid or NULL.
175 * 'answer' to be non NULL.
179 dns_nsec3_maxiterations(dns_db_t *db, dns_dbversion_t *version,
180 isc_mem_t *mctx, unsigned int *iterationsp);
182 * Find the maximum permissible number of iterations allowed based on
187 * 'version' to be valid or NULL.
188 * 'mctx' to be valid.
189 * 'iterationsp' to be non NULL.
194 #endif /* DNS_NSEC3_H */