1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/*
* Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
* Copyright (C) 2000, 2001 Internet Software Consortium.
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
* REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
* INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
* LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
* OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
/* $ISC: keytable.h,v 1.10.206.1 2004/03/06 08:13:56 marka Exp $ */
#ifndef DNS_KEYTABLE_H
#define DNS_KEYTABLE_H 1
/*****
***** Module Info
*****/
/*
* Key Tables
*
* The keytable module provides services for storing and retrieving DNSSEC
* trusted keys, as well as the ability to find the deepest matching key
* for a given domain name.
*
* MP:
* The module ensures appropriate synchronization of data structures it
* creates and manipulates.
*
* Resources:
* <TBS>
*
* Security:
* No anticipated impact.
*/
#include <isc/lang.h>
#include <dns/types.h>
#include <dst/dst.h>
ISC_LANG_BEGINDECLS
isc_result_t
dns_keytable_create(isc_mem_t *mctx, dns_keytable_t **keytablep);
/*
* Create a keytable.
*
* Requires:
*
* 'mctx' is a valid memory context.
*
* keytablep != NULL && *keytablep == NULL
*
* Ensures:
*
* On success, *keytablep is a valid, empty key table.
*
* Returns:
*
* ISC_R_SUCCESS
*
* Any other result indicates failure.
*/
void
dns_keytable_attach(dns_keytable_t *source, dns_keytable_t **targetp);
/*
* Attach *targetp to source.
*
* Requires:
*
* 'source' is a valid keytable.
*
* 'targetp' points to a NULL dns_keytable_t *.
*
* Ensures:
*
* *targetp is attached to source.
*/
void
dns_keytable_detach(dns_keytable_t **keytablep);
/*
* Detach *keytablep from its keytable.
*
* Requires:
*
* 'keytablep' points to a valid keytable.
*
* Ensures:
*
* *keytablep is NULL.
*
* If '*keytablep' is the last reference to the keytable,
*
* All resources used by the keytable will be freed
*/
isc_result_t
dns_keytable_add(dns_keytable_t *keytable, dst_key_t **keyp);
/*
* Add '*keyp' to 'keytable'.
*
* Notes:
*
* Ownership of *keyp is transferred to the keytable.
*
* Requires:
*
* keyp != NULL && *keyp is a valid dst_key_t *.
*
* Ensures:
*
* On success, *keyp == NULL
*
* Returns:
*
* ISC_R_SUCCESS
*
* Any other result indicates failure.
*/
isc_result_t
dns_keytable_findkeynode(dns_keytable_t *keytable, dns_name_t *name,
dns_secalg_t algorithm, dns_keytag_t tag,
dns_keynode_t **keynodep);
/*
* Search for a key named 'name', matching 'algorithm' and 'tag' in
* 'keytable'.
*
* Requires:
*
* 'keytable' is a valid keytable.
*
* 'name' is a valid absolute name.
*
* keynodep != NULL && *keynodep == NULL
*
* Returns:
*
* ISC_R_SUCCESS
* ISC_R_NOTFOUND
*
* Any other result indicates an error.
*/
isc_result_t
dns_keytable_findnextkeynode(dns_keytable_t *keytable, dns_keynode_t *keynode,
dns_keynode_t **nextnodep);
/*
* Search for the next key with the same properties as 'keynode' in
* 'keytable'.
*
* Requires:
*
* 'keytable' is a valid keytable.
*
* 'keynode' is a valid keynode.
*
* nextnodep != NULL && *nextnodep == NULL
*
* Returns:
*
* ISC_R_SUCCESS
* ISC_R_NOTFOUND
*
* Any other result indicates an error.
*/
isc_result_t
dns_keytable_finddeepestmatch(dns_keytable_t *keytable, dns_name_t *name,
dns_name_t *foundname);
/*
* Search for the deepest match of 'name' in 'keytable'.
*
* Requires:
*
* 'keytable' is a valid keytable.
*
* 'name' is a valid absolute name.
*
* 'foundname' is a name with a dedicated buffer.
*
* Returns:
*
* ISC_R_SUCCESS
* ISC_R_NOTFOUND
*
* Any other result indicates an error.
*/
void
dns_keytable_detachkeynode(dns_keytable_t *keytable,
dns_keynode_t **keynodep);
/*
* Give back a keynode found via dns_keytable_findkeynode().
*
* Requires:
*
* 'keytable' is a valid keytable.
*
* *keynodep is a valid keynode returned by a call to
* dns_keytable_findkeynode().
*
* Ensures:
*
* *keynodep == NULL
*/
isc_result_t
dns_keytable_issecuredomain(dns_keytable_t *keytable, dns_name_t *name,
isc_boolean_t *wantdnssecp);
/*
* Is 'name' at or beneath a trusted key?
*
* Requires:
*
* 'keytable' is a valid keytable.
*
* 'name' is a valid absolute name.
*
* '*wantsdnssecp' is a valid isc_boolean_t.
*
* Ensures:
*
* On success, *wantsdnssecp will be ISC_TRUE if and only if 'name'
* is at or beneath a trusted key.
*
* Returns:
*
* ISC_R_SUCCESS
*
* Any other result is an error.
*/
dst_key_t *
dns_keynode_key(dns_keynode_t *keynode);
/*
* Get the DST key associated with keynode.
*/
ISC_LANG_ENDDECLS
#endif /* DNS_KEYTABLE_H */
|
