OpenDNSSEC-enforcer  2.1.6
key_data.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 __key_data_h
31 #define __key_data_h
32 
33 #include "db_object.h"
34 
35 struct key_data;
36 struct key_data_list;
37 typedef struct key_data key_data_t;
38 typedef struct key_data_list key_data_list_t;
39 
40 typedef enum key_data_role {
46 extern const db_enum_t key_data_enum_set_role[];
47 
48 typedef enum key_data_ds_at_parent {
58 
59 #include "key_data_ext.h"
60 #include "zone_db.h"
61 #include "hsm_key.h"
62 
66 struct key_data {
76  unsigned int algorithm;
77  unsigned int inception;
79  unsigned int introducing;
80  unsigned int should_revoke;
81  unsigned int standby;
82  unsigned int active_zsk;
83  unsigned int publish;
84  unsigned int active_ksk;
86  unsigned int keytag;
87  unsigned int minimize;
89 };
90 
96 key_data_t* key_data_new(const db_connection_t* connection);
97 
104 
110 
118 
128 int key_data_cmp(const key_data_t* key_data_a, const key_data_t* key_data_b);
129 
137 
144 
151 
159 
166 
173 
180 
188 
194 unsigned int key_data_algorithm(const key_data_t* key_data);
195 
201 unsigned int key_data_inception(const key_data_t* key_data);
202 
209 
215 const char* key_data_role_text(const key_data_t* key_data);
216 
222 unsigned int key_data_introducing(const key_data_t* key_data);
223 
229 unsigned int key_data_active_zsk(const key_data_t* key_data);
230 
236 unsigned int key_data_publish(const key_data_t* key_data);
237 
243 unsigned int key_data_active_ksk(const key_data_t* key_data);
244 
251 
257 unsigned int key_data_keytag(const key_data_t* key_data);
258 
264 unsigned int key_data_minimize(const key_data_t* key_data);
265 
272 
281 
288 int key_data_set_zone_id(key_data_t* key_data, const db_value_t* zone_id);
289 
297 
304 int key_data_set_algorithm(key_data_t* key_data, unsigned int algorithm);
305 
312 int key_data_set_inception(key_data_t* key_data, unsigned int inception);
313 
321 
328 int key_data_set_introducing(key_data_t* key_data, unsigned int introducing);
329 
336 int key_data_set_active_zsk(key_data_t* key_data, unsigned int active_zsk);
337 
344 int key_data_set_publish(key_data_t* key_data, unsigned int publish);
345 
352 int key_data_set_active_ksk(key_data_t* key_data, unsigned int active_ksk);
353 
361 
368 int key_data_set_keytag(key_data_t* key_data, unsigned int keytag);
369 
376 int key_data_set_minimize(key_data_t* key_data, unsigned int minimize);
377 
387 db_clause_t* key_data_zone_id_clause(db_clause_list_t* clause_list, const db_value_t* zone_id);
388 
399 
410 
421 
431 db_clause_t* key_data_keytag_clause(db_clause_list_t* clause_list, unsigned int keytag);
432 
439 
447 
454 
461 
472 int key_data_count(key_data_t* key_data, db_clause_list_t* clause_list, size_t* count);
473 
490 };
491 
498 
505 
513 
519 
526 int key_data_list_copy(key_data_list_t* key_data_list, const key_data_list_t* from_key_data_list);
527 
534 
541 
549 
557 
565 
573 
582 
592 
602 
612 
620 
622 
624 #endif
key_data_list_get_by_clauses
int key_data_list_get_by_clauses(key_data_list_t *key_data_list, const db_clause_list_t *clause_list)
Definition: key_data.c:2119
key_data_list
Definition: key_data.h:477
db_result
Definition: db_result.h:56
key_data_get_hsm_key
hsm_key_t * key_data_get_hsm_key(const key_data_t *key_data)
Definition: key_data.c:649
KEY_DATA_DS_AT_PARENT_SEEN
@ KEY_DATA_DS_AT_PARENT_SEEN
Definition: key_data.h:53
key_data_set_minimize
int key_data_set_minimize(key_data_t *key_data, unsigned int minimize)
Definition: key_data.c:966
db_value
Definition: db_value.h:48
key_data_zone_id
const db_value_t * key_data_zone_id(const key_data_t *key_data)
Definition: key_data.c:561
key_data_list_new_get_by_clauses
key_data_list_t * key_data_list_new_get_by_clauses(const db_connection_t *connection, const db_clause_list_t *clause_list)
Definition: key_data.c:2161
key_data::private_hsm_key_id
hsm_key_t * private_hsm_key_id
Definition: key_data.h:75
key_data_inception
unsigned int key_data_inception(const key_data_t *key_data)
Definition: key_data.c:695
hsm_key_id
const db_value_t * hsm_key_id(const hsm_key_t *hsm_key)
Definition: hsm_key.c:504
key_data_list::hsm_key_id_list
hsm_key_list_t * hsm_key_id_list
Definition: key_data.h:489
key_data_free
void key_data_free(key_data_t *key_data)
Definition: key_data.c:304
KEY_DATA_DS_AT_PARENT_INVALID
@ KEY_DATA_DS_AT_PARENT_INVALID
Definition: key_data.h:49
key_data_list_free
void key_data_list_free(key_data_list_t *key_data_list)
Definition: key_data.c:1694
key_data::ds_at_parent
key_data_ds_at_parent_t ds_at_parent
Definition: key_data.h:85
key_data_list::object_list
key_data_t ** object_list
Definition: key_data.h:483
KEY_DATA_DS_AT_PARENT_SUBMITTED
@ KEY_DATA_DS_AT_PARENT_SUBMITTED
Definition: key_data.h:52
key_data_list::key_data
key_data_t * key_data
Definition: key_data.h:481
key_data::private_zone_id
zone_db_t * private_zone_id
Definition: key_data.h:72
key_data_list_object_store
int key_data_list_object_store(key_data_list_t *key_data_list)
Definition: key_data.c:1684
key_data::should_revoke
unsigned int should_revoke
Definition: key_data.h:80
key_data_set_keytag
int key_data_set_keytag(key_data_t *key_data, unsigned int keytag)
Definition: key_data.c:956
key_data_delete
int key_data_delete(key_data_t *key_data)
Definition: key_data.c:1587
key_data_zone_id_clause
db_clause_t * key_data_zone_id_clause(db_clause_list_t *clause_list, const db_value_t *zone_id)
Definition: key_data.c:976
key_data_key_state_list
key_state_list_t * key_data_key_state_list(key_data_t *key_data)
Definition: key_data.c:783
db_object
Definition: db_object.h:201
key_data_retrieve_key_state_list
int key_data_retrieve_key_state_list(key_data_t *key_data)
Definition: key_data.c:801
key_data_list_get_by_zone_id
int key_data_list_get_by_zone_id(key_data_list_t *key_data_list, const db_value_t *zone_id)
Definition: key_data.c:2181
key_data_get_by_id
int key_data_get_by_id(key_data_t *key_data, const db_value_t *id)
Definition: key_data.c:1296
key_data_list::object_list_size
size_t object_list_size
Definition: key_data.h:484
key_data_update
int key_data_update(key_data_t *key_data)
Definition: key_data.c:1349
key_data_list::result_list
db_result_list_t * result_list
Definition: key_data.h:479
KEY_DATA_DS_AT_PARENT_RETRACTED
@ KEY_DATA_DS_AT_PARENT_RETRACTED
Definition: key_data.h:55
key_data_list_new_get
key_data_list_t * key_data_list_new_get(const db_connection_t *connection)
Definition: key_data.c:2102
key_data_set_role
int key_data_set_role(key_data_t *key_data, key_data_role_t role)
Definition: key_data.c:890
key_data_set_ds_at_parent
int key_data_set_ds_at_parent(key_data_t *key_data, key_data_ds_at_parent_t ds_at_parent)
Definition: key_data.c:943
key_data_set_hsm_key_id
int key_data_set_hsm_key_id(key_data_t *key_data, const db_value_t *hsm_key_id)
Definition: key_data.c:851
key_data_list_next
const key_data_t * key_data_list_next(key_data_list_t *key_data_list)
Definition: key_data.c:2359
zone_db.h
key_data::associated_zone_id
const zone_db_t * associated_zone_id
Definition: key_data.h:71
key_data_list::object_store
int object_store
Definition: key_data.h:482
key_data_enum_set_role
const db_enum_t key_data_enum_set_role[]
Definition: key_data.c:36
key_data_keytag_clause
db_clause_t * key_data_keytag_clause(db_clause_list_t *clause_list, unsigned int keytag)
Definition: key_data.c:1072
key_data::active_ksk
unsigned int active_ksk
Definition: key_data.h:84
db_clause_list
Definition: db_clause.h:226
key_data_list::object_list_position
size_t object_list_position
Definition: key_data.h:485
key_data_list::result
const db_result_t * result
Definition: key_data.h:480
key_data_get_by_hsm_key_id
int key_data_get_by_hsm_key_id(key_data_t *key_data, const db_value_t *hsm_key_id)
Definition: key_data.c:2479
KEY_DATA_ROLE_KSK
@ KEY_DATA_ROLE_KSK
Definition: key_data.h:42
key_data::algorithm
unsigned int algorithm
Definition: key_data.h:76
key_data::standby
unsigned int standby
Definition: key_data.h:81
key_data_list_get
int key_data_list_get(key_data_list_t *key_data_list)
Definition: key_data.c:2063
key_data_ds_at_parent
key_data_ds_at_parent
Definition: key_data.h:48
key_data_list_get_next
key_data_t * key_data_list_get_next(key_data_list_t *key_data_list)
Definition: key_data.c:2425
key_data_id
const db_value_t * key_data_id(const key_data_t *key_data)
Definition: key_data.c:553
key_data::id
db_value_t id
Definition: key_data.h:68
zone_db
Definition: zone_db.h:46
key_data_role_text
const char * key_data_role_text(const key_data_t *key_data)
Definition: key_data.c:711
key_data_hsm_key
const hsm_key_t * key_data_hsm_key(const key_data_t *key_data)
Definition: key_data.c:638
key_data_new
key_data_t * key_data_new(const db_connection_t *connection)
Definition: key_data.c:264
key_data_set_active_ksk
int key_data_set_active_ksk(key_data_t *key_data, unsigned int active_ksk)
Definition: key_data.c:933
KEY_DATA_ROLE_ZSK
@ KEY_DATA_ROLE_ZSK
Definition: key_data.h:43
key_data_role
key_data_role
Definition: key_data.h:40
hsm_key
Definition: hsm_key.h:77
key_data_list::associated_fetch
int associated_fetch
Definition: key_data.h:487
zone_list_db
Definition: zone_db.h:466
key_data_list_new
key_data_list_t * key_data_list_new(const db_connection_t *connection)
Definition: key_data.c:1651
key_data_ds_at_parent_t
enum key_data_ds_at_parent key_data_ds_at_parent_t
key_data::key_state_list
key_state_list_t * key_state_list
Definition: key_data.h:88
db_result_list
Definition: db_result.h:114
key_data_role_t
enum key_data_role key_data_role_t
key_data_set_zone_id
int key_data_set_zone_id(key_data_t *key_data, const db_value_t *zone_id)
Definition: key_data.c:832
key_data_list_begin
const key_data_t * key_data_list_begin(key_data_list_t *key_data_list)
Definition: key_data.c:2267
key_data_ext.h
key_data_count
int key_data_count(key_data_t *key_data, db_clause_list_t *clause_list, size_t *count)
Definition: key_data.c:1633
key_data_publish
unsigned int key_data_publish(const key_data_t *key_data)
Definition: key_data.c:743
key_data_list_copy
int key_data_list_copy(key_data_list_t *key_data_list, const key_data_list_t *from_key_data_list)
Definition: key_data.c:1725
db_clause
Definition: db_clause.h:118
key_data_from_result
int key_data_from_result(key_data_t *key_data, const db_result_t *result)
Definition: key_data.c:477
key_data_set_introducing
int key_data_set_introducing(key_data_t *key_data, unsigned int introducing)
Definition: key_data.c:903
key_data_list::object_list_first
int object_list_first
Definition: key_data.h:486
key_data_introducing
unsigned int key_data_introducing(const key_data_t *key_data)
Definition: key_data.c:727
key_data::inception
unsigned int inception
Definition: key_data.h:77
key_data_create
int key_data_create(key_data_t *key_data)
Definition: key_data.c:1093
db_enum
Definition: db_enum.h:38
key_data::role
key_data_role_t role
Definition: key_data.h:78
key_data::keytag
unsigned int keytag
Definition: key_data.h:86
key_data_active_ksk
unsigned int key_data_active_ksk(const key_data_t *key_data)
Definition: key_data.c:751
key_data::associated_hsm_key_id
const hsm_key_t * associated_hsm_key_id
Definition: key_data.h:74
key_data_list_new_copy
key_data_list_t * key_data_list_new_copy(const key_data_list_t *key_data_copy)
Definition: key_data.c:1665
KEY_DATA_DS_AT_PARENT_SUBMIT
@ KEY_DATA_DS_AT_PARENT_SUBMIT
Definition: key_data.h:51
key_data_get_zone
zone_db_t * key_data_get_zone(const key_data_t *key_data)
Definition: key_data.c:569
key_data::introducing
unsigned int introducing
Definition: key_data.h:79
key_data_set_publish
int key_data_set_publish(key_data_t *key_data, unsigned int publish)
Definition: key_data.c:923
key_data_list::dbo
db_object_t * dbo
Definition: key_data.h:478
key_data_new_get_by_hsm_key_id
key_data_t * key_data_new_get_by_hsm_key_id(const db_connection_t *connection, const db_value_t *hsm_key_id)
Definition: key_data.c:2530
key_data_list_get_begin
key_data_t * key_data_list_get_begin(key_data_list_t *key_data_list)
Definition: key_data.c:2323
KEY_DATA_ROLE_CSK
@ KEY_DATA_ROLE_CSK
Definition: key_data.h:44
key_data_cache_hsm_key
int key_data_cache_hsm_key(key_data_t *key_data)
Definition: key_data.c:615
KEY_DATA_ROLE_INVALID
@ KEY_DATA_ROLE_INVALID
Definition: key_data.h:41
key_data_list_new_get_by_zone_id
key_data_list_t * key_data_list_new_get_by_zone_id(const db_connection_t *connection, const db_value_t *zone_id)
Definition: key_data.c:2244
key_data_keytag
unsigned int key_data_keytag(const key_data_t *key_data)
Definition: key_data.c:767
key_data_algorithm
unsigned int key_data_algorithm(const key_data_t *key_data)
Definition: key_data.c:687
key_data_list_size
size_t key_data_list_size(key_data_list_t *key_data_list)
Definition: key_data.c:2461
key_data::dbo
db_object_t * dbo
Definition: key_data.h:67
key_data_list::zone_id_list
zone_list_db_t * zone_id_list
Definition: key_data.h:488
key_data_minimize
unsigned int key_data_minimize(const key_data_t *key_data)
Definition: key_data.c:775
key_data::rev
db_value_t rev
Definition: key_data.h:69
key_data_new_copy
key_data_t * key_data_new_copy(const key_data_t *key_data)
Definition: key_data.c:285
hsm_key.h
ds_at_parent
const int ds_at_parent[5]
Definition: keystate_import_cmd.c:54
key_data_hsm_key_id
const db_value_t * key_data_hsm_key_id(const key_data_t *key_data)
Definition: key_data.c:607
KEY_DATA_DS_AT_PARENT_RETRACT
@ KEY_DATA_DS_AT_PARENT_RETRACT
Definition: key_data.h:54
key_data_copy
int key_data_copy(key_data_t *key_data, const key_data_t *key_data_copy)
Definition: key_data.c:326
key_data_enum_set_ds_at_parent
const db_enum_t key_data_enum_set_ds_at_parent[]
Definition: key_data.c:43
db_connection
Definition: db_connection.h:46
key_data::publish
unsigned int publish
Definition: key_data.h:83
key_data::active_zsk
unsigned int active_zsk
Definition: key_data.h:82
key_data::zone_id
db_value_t zone_id
Definition: key_data.h:70
key_data_hsm_key_id_clause
db_clause_t * key_data_hsm_key_id_clause(db_clause_list_t *clause_list, const db_value_t *hsm_key_id)
Definition: key_data.c:1003
key_data_set_algorithm
int key_data_set_algorithm(key_data_t *key_data, unsigned int algorithm)
Definition: key_data.c:870
key_data::hsm_key_id
db_value_t hsm_key_id
Definition: key_data.h:73
key_data_ds_at_parent_clause
db_clause_t * key_data_ds_at_parent_clause(db_clause_list_t *clause_list, key_data_ds_at_parent_t ds_at_parent)
Definition: key_data.c:1051
db_object.h
key_data_cmp
int key_data_cmp(const key_data_t *key_data_a, const key_data_t *key_data_b)
Definition: key_data.c:402
key_data_set_inception
int key_data_set_inception(key_data_t *key_data, unsigned int inception)
Definition: key_data.c:880
KEY_DATA_DS_AT_PARENT_UNSUBMITTED
@ KEY_DATA_DS_AT_PARENT_UNSUBMITTED
Definition: key_data.h:50
hsm_key_list
Definition: hsm_key.h:434
key_data
Definition: key_data.h:66
key_data_role_clause
db_clause_t * key_data_role_clause(db_clause_list_t *clause_list, key_data_role_t role)
Definition: key_data.c:1030
key_data_set_active_zsk
int key_data_set_active_zsk(key_data_t *key_data, unsigned int active_zsk)
Definition: key_data.c:913
key_data::minimize
unsigned int minimize
Definition: key_data.h:87
key_state_list
Definition: key_state.h:262
key_data_active_zsk
unsigned int key_data_active_zsk(const key_data_t *key_data)
Definition: key_data.c:735