2 * Copyright (C) 2004-2007, 2009-2011 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2002 Internet Software Consortium.
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: dnssec.h,v 1.42.178.2 2011-05-06 23:47:05 tbox Exp $ */
21 #define DNS_DNSSEC_H 1
23 /*! \file dns/dnssec.h */
26 #include <isc/stdtime.h>
29 #include <dns/types.h>
36 * Indicates how the signer found this key: in the key repository, at the
37 * zone apex, or specified by the user.
40 dns_keysource_unknown,
41 dns_keysource_repository,
42 dns_keysource_zoneapex,
47 * A DNSSEC key and hints about its intended use gleaned from metadata
49 struct dns_dnsseckey {
51 isc_boolean_t hint_publish; /*% metadata says to publish */
52 isc_boolean_t force_publish; /*% publish regardless of metadata */
53 isc_boolean_t hint_sign; /*% metadata says to sign with this key */
54 isc_boolean_t force_sign; /*% sign with key regardless of metadata */
55 isc_boolean_t hint_remove; /*% metadata says *don't* publish */
56 isc_boolean_t is_active; /*% key is already active */
57 isc_boolean_t first_sign; /*% key is newly becoming active */
58 unsigned int prepublish; /*% how long until active? */
59 dns_keysource_t source; /*% how the key was found */
60 isc_boolean_t ksk; /*% this is a key-signing key */
61 isc_boolean_t legacy; /*% this is old-style key with no
62 metadata (possibly generated by
63 an older version of BIND9) and
64 should be ignored when searching
65 for keys to import into the zone */
66 unsigned int index; /*% position in list */
67 ISC_LINK(dns_dnsseckey_t) link;
71 dns_dnssec_keyfromrdata(dns_name_t *name, dns_rdata_t *rdata, isc_mem_t *mctx,
74 * Creates a DST key from a DNS record. Basically a wrapper around
78 *\li 'name' is not NULL
79 *\li 'rdata' is not NULL
80 *\li 'mctx' is not NULL
81 *\li 'key' is not NULL
87 *\li DST_R_INVALIDPUBLICKEY
88 *\li various errors from dns_name_totext
92 dns_dnssec_sign(dns_name_t *name, dns_rdataset_t *set, dst_key_t *key,
93 isc_stdtime_t *inception, isc_stdtime_t *expire,
94 isc_mem_t *mctx, isc_buffer_t *buffer, dns_rdata_t *sigrdata);
96 * Generates a SIG record covering this rdataset. This has no effect
97 * on existing SIG records.
100 *\li 'name' (the owner name of the record) is a valid name
101 *\li 'set' is a valid rdataset
102 *\li 'key' is a valid key
103 *\li 'inception' is not NULL
104 *\li 'expire' is not NULL
105 *\li 'mctx' is not NULL
106 *\li 'buffer' is not NULL
107 *\li 'sigrdata' is not NULL
113 *\li #DNS_R_INVALIDTIME - the expiration is before the inception
114 *\li #DNS_R_KEYUNAUTHORIZED - the key cannot sign this data (either
115 * it is not a zone key or its flags prevent
121 dns_dnssec_verify(dns_name_t *name, dns_rdataset_t *set, dst_key_t *key,
122 isc_boolean_t ignoretime, isc_mem_t *mctx,
123 dns_rdata_t *sigrdata);
126 dns_dnssec_verify2(dns_name_t *name, dns_rdataset_t *set, dst_key_t *key,
127 isc_boolean_t ignoretime, isc_mem_t *mctx,
128 dns_rdata_t *sigrdata, dns_name_t *wild);
130 * Verifies the SIG record covering this rdataset signed by a specific
131 * key. This does not determine if the key's owner is authorized to
132 * sign this record, as this requires a resolver or database.
133 * If 'ignoretime' is ISC_TRUE, temporal validity will not be checked.
136 *\li 'name' (the owner name of the record) is a valid name
137 *\li 'set' is a valid rdataset
138 *\li 'key' is a valid key
139 *\li 'mctx' is not NULL
140 *\li 'sigrdata' is a valid rdata containing a SIG record
141 *\li 'wild' if non-NULL then is a valid and has a buffer.
146 *\li #DNS_R_FROMWILDCARD - the signature is valid and is from
147 * a wildcard expansion. dns_dnssec_verify2() only.
148 * 'wild' contains the name of the wildcard if non-NULL.
149 *\li #DNS_R_SIGINVALID - the signature fails to verify
150 *\li #DNS_R_SIGEXPIRED - the signature has expired
151 *\li #DNS_R_SIGFUTURE - the signature's validity period has not begun
152 *\li #DNS_R_KEYUNAUTHORIZED - the key cannot sign this data (either
153 * it is not a zone key or its flags prevent
160 dns_dnssec_findzonekeys(dns_db_t *db, dns_dbversion_t *ver, dns_dbnode_t *node,
161 dns_name_t *name, isc_mem_t *mctx,
162 unsigned int maxkeys, dst_key_t **keys,
163 unsigned int *nkeys);
165 dns_dnssec_findzonekeys2(dns_db_t *db, dns_dbversion_t *ver,
166 dns_dbnode_t *node, dns_name_t *name,
167 const char *directory, isc_mem_t *mctx,
168 unsigned int maxkeys, dst_key_t **keys,
169 unsigned int *nkeys);
171 * Finds a set of zone keys.
172 * XXX temporary - this should be handled in dns_zone_t.
177 dns_dnssec_signmessage(dns_message_t *msg, dst_key_t *key);
179 * Signs a message with a SIG(0) record. This is implicitly called by
180 * dns_message_renderend() if msg->sig0key is not NULL.
183 *\li 'msg' is a valid message
184 *\li 'key' is a valid key that can be used for signing
193 dns_dnssec_verifymessage(isc_buffer_t *source, dns_message_t *msg,
196 * Verifies a message signed by a SIG(0) record. This is not
197 * called implicitly by dns_message_parse(). If dns_message_signer()
198 * is called before dns_dnssec_verifymessage(), it will return
199 * #DNS_R_NOTVERIFIEDYET. dns_dnssec_verifymessage() will set
200 * the verified_sig0 flag in msg if the verify succeeds, and
201 * the sig0status field otherwise.
204 *\li 'source' is a valid buffer containing the unparsed message
205 *\li 'msg' is a valid message
206 *\li 'key' is a valid key
211 *\li #ISC_R_NOTFOUND - no SIG(0) was found
212 *\li #DNS_R_SIGINVALID - the SIG record is not well-formed or
213 * was not generated by the key.
218 dns_dnssec_selfsigns(dns_rdata_t *rdata, dns_name_t *name,
219 dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset,
220 isc_boolean_t ignoretime, isc_mem_t *mctx);
224 dns_dnssec_signs(dns_rdata_t *rdata, dns_name_t *name,
225 dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset,
226 isc_boolean_t ignoretime, isc_mem_t *mctx);
228 * Verify that 'rdataset' is validly signed in 'sigrdataset' by
229 * the key in 'rdata'.
231 * dns_dnssec_selfsigns() requires that rdataset be a DNSKEY or KEY
232 * rrset. dns_dnssec_signs() works on any rrset.
237 dns_dnsseckey_create(isc_mem_t *mctx, dst_key_t **dstkey,
238 dns_dnsseckey_t **dkp);
240 * Create and initialize a dns_dnsseckey_t structure.
243 *\li 'dkp' is not NULL and '*dkp' is NULL.
251 dns_dnsseckey_destroy(isc_mem_t *mctx, dns_dnsseckey_t **dkp);
253 * Reclaim a dns_dnsseckey_t structure.
256 *\li 'dkp' is not NULL and '*dkp' is not NULL.
263 dns_dnssec_findmatchingkeys(dns_name_t *origin, const char *directory,
264 isc_mem_t *mctx, dns_dnsseckeylist_t *keylist);
266 * Search 'directory' for K* key files matching the name in 'origin'.
267 * Append all such keys, along with use hints gleaned from their
268 * metadata, onto 'keylist'.
271 *\li 'keylist' is not NULL
277 *\li any error returned by dns_name_totext(), isc_dir_open(), or
278 * dst_key_fromnamedfile()
281 *\li On error, keylist is unchanged
285 dns_dnssec_keylistfromrdataset(dns_name_t *origin,
286 const char *directory, isc_mem_t *mctx,
287 dns_rdataset_t *keyset, dns_rdataset_t *keysigs,
288 dns_rdataset_t *soasigs, isc_boolean_t savekeys,
289 isc_boolean_t public,
290 dns_dnsseckeylist_t *keylist);
292 * Append the contents of a DNSKEY rdataset 'keyset' to 'keylist'.
293 * Omit duplicates. If 'public' is ISC_FALSE, search 'directory' for
294 * matching key files, and load the private keys that go with
295 * the public ones. If 'savekeys' is ISC_TRUE, mark the keys so
296 * they will not be deleted or inactivated regardless of metadata.
298 * 'keysigs' and 'soasigs', if not NULL and associated, contain the
299 * RRSIGS for the DNSKEY and SOA records respectively and are used to mark
300 * whether a key is already active in the zone.
304 dns_dnssec_updatekeys(dns_dnsseckeylist_t *keys, dns_dnsseckeylist_t *newkeys,
305 dns_dnsseckeylist_t *removed, dns_name_t *origin,
306 dns_ttl_t ttl, dns_diff_t *diff, isc_boolean_t allzsk,
307 isc_mem_t *mctx, void (*report)(const char *, ...));
309 * Update the list of keys in 'keys' with new key information in 'newkeys'.
311 * For each key in 'newkeys', see if it has a match in 'keys'.
312 * - If not, and if the metadata says the key should be published:
313 * add it to 'keys', and place a dns_difftuple into 'diff' so
314 * the key can be added to the DNSKEY set. If the metadata says it
315 * should be active, set the first_sign flag.
316 * - If so, and if the metadata says it should be removed:
317 * remove it from 'keys', and place a dns_difftuple into 'diff' so
318 * the key can be removed from the DNSKEY set. if 'removed' is non-NULL,
319 * copy the key into that list; otherwise destroy it.
320 * - Otherwise, make sure keys has current metadata.
322 * If 'allzsk' is true, we are allowing KSK-flagged keys to be used as
325 * 'ttl' is the TTL of the DNSKEY RRset; if it is longer than the
326 * time until a new key will be activated, then we have to delay the
329 * 'report' points to a function for reporting status.
331 * On completion, any remaining keys in 'newkeys' are freed.
335 #endif /* DNS_DNSSEC_H */