2 * validator/autotrust.h - RFC5011 trust anchor management for unbound.
4 * Copyright (c) 2009, NLnet Labs. All rights reserved.
6 * This software is open source.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
15 * Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
19 * Neither the name of the NLNET LABS nor the names of its contributors may
20 * be used to endorse or promote products derived from this software without
21 * specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
29 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * Contains autotrust definitions.
42 #ifndef VALIDATOR_AUTOTRUST_H
43 #define VALIDATOR_AUTOTRUST_H
44 #include "util/rbtree.h"
45 #include "util/data/packed_rrset.h"
48 struct ub_packed_rrset_key;
54 /** Autotrust anchor states */
57 AUTR_STATE_ADDPEND = 1,
59 AUTR_STATE_MISSING = 3,
60 AUTR_STATE_REVOKED = 4,
61 AUTR_STATE_REMOVED = 5
65 * Autotrust metadata for one trust anchor key.
73 size_t rr_len, dname_len;
74 /** last update of key state (new pending count keeps date the same) */
79 uint8_t pending_count;
80 /** fresh TA was seen */
82 /** revoked TA was seen */
87 * Autotrust metadata for a trust point.
88 * This is part of the struct trust_anchor data.
90 struct autr_point_data {
91 /** file to store the trust point in. chrootdir already applied. */
93 /** rbtree node for probe sort, key is struct trust_anchor */
99 /** last queried DNSKEY set
100 * Not all failures are captured in this entry.
101 * If the validator did not even start (e.g. timeout or localservfail),
102 * then the last_queried and query_failed values are not updated.
105 /** last successful DNSKEY set */
107 /** next probe time */
108 time_t next_probe_time;
110 /** when to query if !failed */
111 time_t query_interval;
112 /** when to retry if failed */
116 * How many times did it fail. diagnostic only (has no effect).
117 * Only updated if there was a dnskey rrset that failed to verify.
119 uint8_t query_failed;
120 /** true if the trust point has been revoked */
125 * Autotrust global metadata.
127 struct autr_global_data {
128 /** rbtree of autotrust anchors sorted by next probe time.
129 * When time is equal, sorted by anchor class, name. */
134 * Create new global 5011 data structure.
135 * @return new structure or NULL on malloc failure.
137 struct autr_global_data* autr_global_create(void);
140 * Delete global 5011 data structure.
141 * @param global: global autotrust state to delete.
143 void autr_global_delete(struct autr_global_data* global);
146 * See if autotrust anchors are configured and how many.
147 * @param anchors: the trust anchors structure.
148 * @return number of autotrust trust anchors
150 size_t autr_get_num_anchors(struct val_anchors* anchors);
153 * Process probe timer. Add new probes if needed.
154 * @param env: module environment with time, with anchors and with the mesh.
155 * @return time of next probe (in seconds from now).
156 * If 0, then there is no next probe anymore (trust points deleted).
158 time_t autr_probe_timer(struct module_env* env);
160 /** probe tree compare function */
161 int probetree_cmp(const void* x, const void* y);
164 * Read autotrust file.
165 * @param anchors: the anchors structure.
166 * @param nm: name of the file (copied).
167 * @return false on failure.
169 int autr_read_file(struct val_anchors* anchors, const char* nm);
172 * Write autotrust file.
173 * @param env: environment with scratch space.
174 * @param tp: trust point to write.
176 void autr_write_file(struct module_env* env, struct trust_anchor* tp);
179 * Delete autr anchor, deletes the autr data but does not do
180 * unlinking from trees, caller does that.
181 * @param tp: trust point to delete.
183 void autr_point_delete(struct trust_anchor* tp);
186 * Perform autotrust processing.
187 * @param env: qstate environment with the anchors structure.
188 * @param ve: validator environment for verification of rrsigs.
189 * @param tp: trust anchor to process.
190 * @param dnskey_rrset: DNSKEY rrset probed (can be NULL if bad prime result).
191 * allocated in a region. Has not been validated yet.
192 * @param qstate: qstate with region.
193 * @return false if trust anchor was revoked completely.
194 * Otherwise logs errors to log, does not change return value.
195 * On errors, likely the trust point has been unchanged.
197 int autr_process_prime(struct module_env* env, struct val_env* ve,
198 struct trust_anchor* tp, struct ub_packed_rrset_key* dnskey_rrset,
199 struct module_qstate* qstate);
202 * Debug printout of rfc5011 tracked anchors
203 * @param anchors: all the anchors.
205 void autr_debug_print(struct val_anchors* anchors);
207 /** callback for query answer to 5011 probe */
208 void probe_answer_cb(void* arg, int rcode, struct sldns_buffer* buf,
209 enum sec_status sec, char* errinf);
211 #endif /* VALIDATOR_AUTOTRUST_H */