OpenDNSSEC-enforcer  2.1.7
zone_db.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 Jerry Lundström <lundstrom.jerry@gmail.com>
3  * Copyright (c) 2014 .SE (The Internet Infrastructure Foundation).
4  * Copyright (c) 2014 OpenDNSSEC AB (svb)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
22  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
24  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
25  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
26  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  */
29 
30 #ifndef __zone_db_h
31 #define __zone_db_h
32 
33 #include "db_object.h"
34 
35 struct zone_db;
36 struct zone_list_db;
37 typedef struct zone_db zone_db_t;
38 typedef struct zone_list_db zone_list_db_t;
39 
40 #include "zone_db_ext.h"
41 #include "policy.h"
42 
46 struct zone_db {
53  char* name;
54  unsigned int signconf_needs_writing;
57  unsigned int ttl_end_ds;
58  unsigned int ttl_end_dk;
59  unsigned int ttl_end_rs;
60  unsigned int roll_ksk_now;
61  unsigned int roll_zsk_now;
62  unsigned int roll_csk_now;
67  unsigned int next_ksk_roll;
68  unsigned int next_zsk_roll;
69  unsigned int next_csk_roll;
72 };
73 
79 extern zone_db_t* zone_db_new(const db_connection_t* connection);
80 
86 extern zone_db_t* zone_db_new_copy(const zone_db_t* zone);
87 
92 extern void zone_db_free(zone_db_t* zone);
93 
100 extern int zone_db_copy(zone_db_t* zone, const zone_db_t* zone_copy);
101 
108 extern int zone_db_from_result(zone_db_t* zone, const db_result_t* result);
109 
115 extern const db_value_t* zone_db_id(const zone_db_t* zone);
116 
122 extern const db_value_t* zone_db_policy_id(const zone_db_t* zone);
123 
130 extern policy_t* zone_db_get_policy(const zone_db_t* zone);
131 
137 extern const char* zone_db_name(const zone_db_t* zone);
138 
144 extern unsigned int zone_db_signconf_needs_writing(const zone_db_t* zone);
145 
151 extern const char* zone_db_signconf_path(const zone_db_t* zone);
152 
158 extern int zone_db_next_change(const zone_db_t* zone);
159 
165 extern unsigned int zone_db_ttl_end_ds(const zone_db_t* zone);
166 
172 extern unsigned int zone_db_ttl_end_dk(const zone_db_t* zone);
173 
179 extern unsigned int zone_db_ttl_end_rs(const zone_db_t* zone);
180 
186 extern unsigned int zone_db_roll_ksk_now(const zone_db_t* zone);
187 
193 extern unsigned int zone_db_roll_zsk_now(const zone_db_t* zone);
194 
200 extern unsigned int zone_db_roll_csk_now(const zone_db_t* zone);
201 
207 extern const char* zone_db_input_adapter_type(const zone_db_t* zone);
208 
214 extern const char* zone_db_input_adapter_uri(const zone_db_t* zone);
215 
221 extern const char* zone_db_output_adapter_type(const zone_db_t* zone);
222 
228 extern const char* zone_db_output_adapter_uri(const zone_db_t* zone);
229 
235 extern unsigned int zone_db_next_ksk_roll(const zone_db_t* zone);
236 
242 extern unsigned int zone_db_next_zsk_roll(const zone_db_t* zone);
243 
249 extern unsigned int zone_db_next_csk_roll(const zone_db_t* zone);
250 
257 extern int zone_db_set_policy_id(zone_db_t* zone, const db_value_t* policy_id);
258 
265 extern int zone_db_set_name(zone_db_t* zone, const char* name_text);
266 
273 extern int zone_db_set_signconf_needs_writing(zone_db_t* zone, unsigned int signconf_needs_writing);
274 
281 extern int zone_db_set_signconf_path(zone_db_t* zone, const char* signconf_path_text);
282 
289 extern int zone_db_set_next_change(zone_db_t* zone, int next_change);
290 
297 extern int zone_db_set_ttl_end_ds(zone_db_t* zone, unsigned int ttl_end_ds);
298 
305 extern int zone_db_set_ttl_end_dk(zone_db_t* zone, unsigned int ttl_end_dk);
306 
313 extern int zone_db_set_ttl_end_rs(zone_db_t* zone, unsigned int ttl_end_rs);
314 
321 extern int zone_db_set_roll_ksk_now(zone_db_t* zone, unsigned int roll_ksk_now);
322 
329 extern int zone_db_set_roll_zsk_now(zone_db_t* zone, unsigned int roll_zsk_now);
330 
337 extern int zone_db_set_roll_csk_now(zone_db_t* zone, unsigned int roll_csk_now);
338 
345 extern int zone_db_set_input_adapter_type(zone_db_t* zone, const char* input_adapter_type_text);
346 
353 extern int zone_db_set_input_adapter_uri(zone_db_t* zone, const char* input_adapter_uri_text);
354 
361 extern int zone_db_set_output_adapter_type(zone_db_t* zone, const char* output_adapter_type_text);
362 
369 extern int zone_db_set_output_adapter_uri(zone_db_t* zone, const char* output_adapter_uri_text);
370 
377 extern int zone_db_set_next_ksk_roll(zone_db_t* zone, unsigned int next_ksk_roll);
378 
385 extern int zone_db_set_next_zsk_roll(zone_db_t* zone, unsigned int next_zsk_roll);
386 
393 extern int zone_db_set_next_csk_roll(zone_db_t* zone, unsigned int next_csk_roll);
394 
405 
411 extern int zone_db_create(zone_db_t* zone);
412 
419 extern int zone_db_get_by_id(zone_db_t* zone, const db_value_t* id);
420 
427 extern int zone_db_get_by_name(zone_db_t* zone, const char* name);
428 
435 extern zone_db_t* zone_db_new_get_by_name(const db_connection_t* connection, const char* name);
436 
442 extern int zone_db_update(zone_db_t* zone);
443 
449 extern int zone_db_delete(zone_db_t* zone);
450 
461 extern int zone_db_count(zone_db_t* zone, db_clause_list_t* clause_list, size_t* count);
462 
466 struct zone_list_db {
478 };
479 
485 extern zone_list_db_t* zone_list_db_new(const db_connection_t* connection);
486 
492 extern zone_list_db_t* zone_list_db_new_copy(const zone_list_db_t* zone_copy);
493 
501 
507 
514 extern int zone_list_db_copy(zone_list_db_t* zone_list_db, const zone_list_db_t* from_zone_list_db);
515 
522 
528 extern zone_list_db_t* zone_list_db_new_get(const db_connection_t* connection);
529 
537 
545 
553 
562 
572 
582 
590 
591 #endif
policy.h
zone_db_ext.h
zone_db::policy_id
db_value_t policy_id
Definition: zone_db.h:50
zone_db::roll_ksk_now
unsigned int roll_ksk_now
Definition: zone_db.h:60
key_data_list
Definition: key_data.h:479
zone_db_output_adapter_type
const char * zone_db_output_adapter_type(const zone_db_t *zone)
Definition: zone_db.c:878
db_result
Definition: db_result.h:56
zone_list_db_get_by_policy_id
int zone_list_db_get_by_policy_id(zone_list_db_t *zone_list_db, const db_value_t *policy_id)
Definition: zone_db.c:2461
zone_list_db_object_store
int zone_list_db_object_store(zone_list_db_t *zone_list_db)
Definition: zone_db.c:1979
zone_db_set_next_ksk_roll
int zone_db_set_next_ksk_roll(zone_db_t *zone, unsigned int next_ksk_roll)
Definition: zone_db.c:1149
zone_list_db::object_list_position
size_t object_list_position
Definition: zone_db.h:474
zone_list_db::policy_id_list
policy_list_t * policy_id_list
Definition: zone_db.h:477
zone_db_create
int zone_db_create(zone_db_t *zone)
Definition: zone_db.c:1206
zone_list_db_get
int zone_list_db_get(zone_list_db_t *zone_list_db)
Definition: zone_db.c:2363
zone_list_db_new_get
zone_list_db_t * zone_list_db_new_get(const db_connection_t *connection)
Definition: zone_db.c:2402
db_value
Definition: db_value.h:48
zone_db_set_output_adapter_uri
int zone_db_set_output_adapter_uri(zone_db_t *zone, const char *output_adapter_uri_text)
Definition: zone_db.c:1127
zone_db::next_zsk_roll
unsigned int next_zsk_roll
Definition: zone_db.h:68
zone_db_set_input_adapter_type
int zone_db_set_input_adapter_type(zone_db_t *zone, const char *input_adapter_type_text)
Definition: zone_db.c:1061
zone_db_next_change
int zone_db_next_change(const zone_db_t *zone)
Definition: zone_db.c:806
zone_db::name
char * name
Definition: zone_db.h:53
zone_db_next_zsk_roll
unsigned int zone_db_next_zsk_roll(const zone_db_t *zone)
Definition: zone_db.c:902
zone_db_policy_id_clause
db_clause_t * zone_db_policy_id_clause(db_clause_list_t *clause_list, const db_value_t *policy_id)
Definition: zone_db.c:1179
zone_db_next_ksk_roll
unsigned int zone_db_next_ksk_roll(const zone_db_t *zone)
Definition: zone_db.c:894
zone_db_set_name
int zone_db_set_name(zone_db_t *zone, const char *name_text)
Definition: zone_db.c:937
zone_list_db::object_list
zone_db_t ** object_list
Definition: zone_db.h:472
zone_db_next_csk_roll
unsigned int zone_db_next_csk_roll(const zone_db_t *zone)
Definition: zone_db.c:910
zone_list_db::result_list
db_result_list_t * result_list
Definition: zone_db.h:468
db_object
Definition: db_object.h:201
zone_list_db::object_list_first
int object_list_first
Definition: zone_db.h:475
zone_db::next_ksk_roll
unsigned int next_ksk_roll
Definition: zone_db.h:67
zone_db_signconf_needs_writing
unsigned int zone_db_signconf_needs_writing(const zone_db_t *zone)
Definition: zone_db.c:790
zone_list_db_begin
const zone_db_t * zone_list_db_begin(zone_list_db_t *zone_list_db)
Definition: zone_db.c:2547
zone_db_set_output_adapter_type
int zone_db_set_output_adapter_type(zone_db_t *zone, const char *output_adapter_type_text)
Definition: zone_db.c:1105
zone_db_output_adapter_uri
const char * zone_db_output_adapter_uri(const zone_db_t *zone)
Definition: zone_db.c:886
zone_db_get_by_name
int zone_db_get_by_name(zone_db_t *zone, const char *name)
Definition: zone_db.c:1519
zone_db_delete
int zone_db_delete(zone_db_t *zone)
Definition: zone_db.c:1884
zone_db::private_policy_id
policy_t * private_policy_id
Definition: zone_db.h:52
zone_db_id
const db_value_t * zone_db_id(const zone_db_t *zone)
Definition: zone_db.c:728
zone_db::roll_zsk_now
unsigned int roll_zsk_now
Definition: zone_db.h:61
zone_list_db::zone
zone_db_t * zone
Definition: zone_db.h:470
zone_db_ttl_end_ds
unsigned int zone_db_ttl_end_ds(const zone_db_t *zone)
Definition: zone_db.c:814
zone_db::signconf_path
char * signconf_path
Definition: zone_db.h:55
zone_db::dbo
db_object_t * dbo
Definition: zone_db.h:47
db_clause_list
Definition: db_clause.h:226
zone_list_db_get_by_clauses
int zone_list_db_get_by_clauses(zone_list_db_t *zone_list_db, const db_clause_list_t *clause_list)
Definition: zone_db.c:2419
zone_list_db_new_get_by_policy_id
zone_list_db_t * zone_list_db_new_get_by_policy_id(const db_connection_t *connection, const db_value_t *policy_id)
Definition: zone_db.c:2524
zone_db_get_policy
policy_t * zone_db_get_policy(const zone_db_t *zone)
Definition: zone_db.c:744
zone_list_db::associated_fetch
int associated_fetch
Definition: zone_db.h:476
zone_list_db::object_store
int object_store
Definition: zone_db.h:471
zone_list_db_size
size_t zone_list_db_size(zone_list_db_t *zone_list_db)
Definition: zone_db.c:2705
zone_db_roll_zsk_now
unsigned int zone_db_roll_zsk_now(const zone_db_t *zone)
Definition: zone_db.c:846
zone_db::next_csk_roll
unsigned int next_csk_roll
Definition: zone_db.h:69
zone_db::key_dependency_list
key_dependency_list_t * key_dependency_list
Definition: zone_db.h:71
zone_db_new
zone_db_t * zone_db_new(const db_connection_t *connection)
Definition: zone_db.c:287
zone_list_db_copy
int zone_list_db_copy(zone_list_db_t *zone_list_db, const zone_list_db_t *from_zone_list_db)
Definition: zone_db.c:2017
zone_db_update
int zone_db_update(zone_db_t *zone)
Definition: zone_db.c:1589
zone_db
Definition: zone_db.h:46
zone_list_db_next
const zone_db_t * zone_list_db_next(zone_list_db_t *zone_list_db)
Definition: zone_db.c:2603
zone_db_free
void zone_db_free(zone_db_t *zone)
Definition: zone_db.c:325
zone_db_set_next_change
int zone_db_set_next_change(zone_db_t *zone, int next_change)
Definition: zone_db.c:991
zone_db_set_ttl_end_ds
int zone_db_set_ttl_end_ds(zone_db_t *zone, unsigned int ttl_end_ds)
Definition: zone_db.c:1001
zone_list_db_get_next
zone_db_t * zone_list_db_get_next(zone_list_db_t *zone_list_db)
Definition: zone_db.c:2669
zone_db_new_get_by_name
zone_db_t * zone_db_new_get_by_name(const db_connection_t *connection, const char *name)
Definition: zone_db.c:1569
zone_db::key_data_list
key_data_list_t * key_data_list
Definition: zone_db.h:70
zone_db_set_roll_csk_now
int zone_db_set_roll_csk_now(zone_db_t *zone, unsigned int roll_csk_now)
Definition: zone_db.c:1051
zone_db_new_copy
zone_db_t * zone_db_new_copy(const zone_db_t *zone)
Definition: zone_db.c:306
zone_list_db
Definition: zone_db.h:466
key_dependency_list
Definition: key_dependency.h:201
zone_db::ttl_end_dk
unsigned int ttl_end_dk
Definition: zone_db.h:58
zone_db_input_adapter_type
const char * zone_db_input_adapter_type(const zone_db_t *zone)
Definition: zone_db.c:862
db_result_list
Definition: db_result.h:114
zone_db_ttl_end_rs
unsigned int zone_db_ttl_end_rs(const zone_db_t *zone)
Definition: zone_db.c:830
zone_db_copy
int zone_db_copy(zone_db_t *zone, const zone_db_t *zone_copy)
Definition: zone_db.c:365
zone_db_set_roll_ksk_now
int zone_db_set_roll_ksk_now(zone_db_t *zone, unsigned int roll_ksk_now)
Definition: zone_db.c:1031
zone_db_set_signconf_needs_writing
int zone_db_set_signconf_needs_writing(zone_db_t *zone, unsigned int signconf_needs_writing)
Definition: zone_db.c:959
zone_list_db::result
const db_result_t * result
Definition: zone_db.h:469
zone_list_db::object_list_size
size_t object_list_size
Definition: zone_db.h:473
db_clause
Definition: db_clause.h:118
zone_list_db_free
void zone_list_db_free(zone_list_db_t *zone_list_db)
Definition: zone_db.c:1989
zone_list_db_new
zone_list_db_t * zone_list_db_new(const db_connection_t *connection)
Definition: zone_db.c:1946
zone_list_db_new_copy
zone_list_db_t * zone_list_db_new_copy(const zone_list_db_t *zone_copy)
Definition: zone_db.c:1960
zone_db_ttl_end_dk
unsigned int zone_db_ttl_end_dk(const zone_db_t *zone)
Definition: zone_db.c:822
zone_db_set_roll_zsk_now
int zone_db_set_roll_zsk_now(zone_db_t *zone, unsigned int roll_zsk_now)
Definition: zone_db.c:1041
zone_db_roll_ksk_now
unsigned int zone_db_roll_ksk_now(const zone_db_t *zone)
Definition: zone_db.c:838
zone_db_from_result
int zone_db_from_result(zone_db_t *zone, const db_result_t *result)
Definition: zone_db.c:662
zone_db::input_adapter_type
char * input_adapter_type
Definition: zone_db.h:63
policy
Definition: policy.h:60
zone_db_set_signconf_path
int zone_db_set_signconf_path(zone_db_t *zone, const char *signconf_path_text)
Definition: zone_db.c:969
zone_db_set_input_adapter_uri
int zone_db_set_input_adapter_uri(zone_db_t *zone, const char *input_adapter_uri_text)
Definition: zone_db.c:1083
zone_db::output_adapter_type
char * output_adapter_type
Definition: zone_db.h:65
zone_db::rev
db_value_t rev
Definition: zone_db.h:49
zone_db_count
int zone_db_count(zone_db_t *zone, db_clause_list_t *clause_list, size_t *count)
Definition: zone_db.c:1930
policy_list
Definition: policy.h:733
zone_db::roll_csk_now
unsigned int roll_csk_now
Definition: zone_db.h:62
zone_db::associated_policy_id
const policy_t * associated_policy_id
Definition: zone_db.h:51
zone_db_set_next_csk_roll
int zone_db_set_next_csk_roll(zone_db_t *zone, unsigned int next_csk_roll)
Definition: zone_db.c:1169
zone_db_policy_id
const db_value_t * zone_db_policy_id(const zone_db_t *zone)
Definition: zone_db.c:736
zone_db_roll_csk_now
unsigned int zone_db_roll_csk_now(const zone_db_t *zone)
Definition: zone_db.c:854
zone_db::input_adapter_uri
char * input_adapter_uri
Definition: zone_db.h:64
db_connection
Definition: db_connection.h:46
zone_db_set_policy_id
int zone_db_set_policy_id(zone_db_t *zone, const db_value_t *policy_id)
Definition: zone_db.c:918
zone_db::ttl_end_rs
unsigned int ttl_end_rs
Definition: zone_db.h:59
zone_db::id
db_value_t id
Definition: zone_db.h:48
zone_db_set_ttl_end_dk
int zone_db_set_ttl_end_dk(zone_db_t *zone, unsigned int ttl_end_dk)
Definition: zone_db.c:1011
zone_db::next_change
int next_change
Definition: zone_db.h:56
zone_db_input_adapter_uri
const char * zone_db_input_adapter_uri(const zone_db_t *zone)
Definition: zone_db.c:870
zone_db_set_next_zsk_roll
int zone_db_set_next_zsk_roll(zone_db_t *zone, unsigned int next_zsk_roll)
Definition: zone_db.c:1159
zone_db_signconf_path
const char * zone_db_signconf_path(const zone_db_t *zone)
Definition: zone_db.c:798
db_object.h
zone_list_db::dbo
db_object_t * dbo
Definition: zone_db.h:467
zone_db_name
const char * zone_db_name(const zone_db_t *zone)
Definition: zone_db.c:782
zone_db::signconf_needs_writing
unsigned int signconf_needs_writing
Definition: zone_db.h:54
zone_db_get_by_id
int zone_db_get_by_id(zone_db_t *zone, const db_value_t *id)
Definition: zone_db.c:1466
zone_db::ttl_end_ds
unsigned int ttl_end_ds
Definition: zone_db.h:57
zone_db::output_adapter_uri
char * output_adapter_uri
Definition: zone_db.h:66
zone_db_set_ttl_end_rs
int zone_db_set_ttl_end_rs(zone_db_t *zone, unsigned int ttl_end_rs)
Definition: zone_db.c:1021
policy_id
const db_value_t * policy_id(const policy_t *policy)
Definition: policy.c:805