/usr/include/dnsdb/dnssec-keystore.h is in libyadifa-dev 2.2.3-1+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 | /*------------------------------------------------------------------------------
*
* Copyright (c) 2011-2016, EURid. All rights reserved.
* The YADIFA TM software product is provided under the BSD 3-clause license:
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of EURid nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*------------------------------------------------------------------------------
*
*/
/** @defgroup dnskey DNSSEC keys functions
* @ingroup dnsdbdnssec
* @brief
*
* The dnssec keystore handles loading and updating of keys system-wide.
*
* It is required for an efficient key management and smart signing.
*
* It has knowledge of how to find keys for a zone.
* It has the responsibility to update the keys when asked.
*
* Its responsibilities may be extended to notify the system about timings.
*
* @{
*/
#pragma once
/*------------------------------------------------------------------------------
*
* USE INCLUDES */
#include <openssl/engine.h>
#include <dnscore/sys_types.h>
#include <dnscore/dnskey.h>
#include <dnsdb/zdb_zone.h>
#if !ZDB_HAS_DNSSEC_SUPPORT
#error "Please do not include dnssec_keystore.h if ZDB_HAS_DNSSEC_SUPPORT is 0 (Not NSEC3 nor NSEC)"
#endif
#ifdef __cplusplus
extern "C" {
#endif
struct dnssec_keystore;
/**
*
* Initialises the keystore
*
* @param ks
*/
void dnssec_keystore_init();
/**
* Adds the knowledge of domain<->path
* Set path to NULL to use the default value
*
* Can overwrite a previous value
*
* @param ks
* @param domain
* @param path
*/
void dnssec_keystore_add_domain(const u8 *domain, const char *path);
/**
* Remove the knowledge of domain<->path
*
* @param ks
* @param domain
* @param path
*/
void dnssec_keystore_remove_domain(const u8 *domain, const char *path);
/**
*
* Add a key to the keystore, do nothing if a key with the same tag and algorithm is
* in the keystore for that domain already
*
* RC ok
*
* @param ks
* @param key
*
* @return TRUE iff the key was added
*/
bool dnssec_keystore_add_key(dnssec_key *key);
/**
*
* Removes a key from the keystore
* Does not releases the key
*
* RC ok
*
* @param ks
* @param key
*
* @return the instance of the key from the keystore, or NULL if the key was not found
*/
dnssec_key *dnssec_keystore_remove_key(dnssec_key *key);
/**
* Removes a key from the keystore, if possible.
* Renames both key files adding suffix of the creation time plus bak
* Does not return any error code as it's a best effort kind of thing.
*
* @param key
*/
void dnssec_keystore_delete_key(dnssec_key *key);
/**
*
* Retrieves a key from the keystore
*
* RC ok
*
* @param ks
* @param domain
* @param tag
* @return the key or NULL if it does not exist
*/
dnssec_key *dnssec_keystore_acquire_key_from_fqdn(const u8 *domain, u16 tag);
/**
* Returns the nth key from the domain or NULL if no such key exist
*
* RC ok
*
* @return a dnskey
*/
dnssec_key *dnssec_keystore_acquire_key_from_fqdn_by_index(const u8 *domain, int idx);
/**
*
* Retrieves a key from the keystore
*
* RC ok
*
* @param ks
* @param domain
* @param tag
* @return
*/
dnssec_key *dnssec_keystore_acquire_key_from_name(const char *domain, u16 tag);
/**
* Returns the nth key from the domain or NULL if no such key exist
*
* RC ok
*
* @return a dnskey
*/
dnssec_key *dnssec_keystore_acquire_key_from_name_by_index(const char *domain, int idx);
/**
*
* (Re)loads keys found in the paths of the keystore
*
* @param ks
* @return
*/
ya_result dnssec_keystore_reload();
/**
*
* (Re)loads keys found in the path of the keystore for the specified domain
*
* @param fqdn
* @return
*/
ya_result dnssec_keystore_reload_domain(const u8 *fqdn);
/**
* Adds all the valid keys of the domain in the keyring
*
* @param fqdn the domain name
* @param at_time the epoch at which the test is done ie: time(NULL)
* @param kr the target keyring
*
* @return the number of keys effectively added in the keyring
*/
u32 dnssec_keystore_add_valid_keys_from_fqdn(const u8 *fqdn, time_t at_time, struct dnskey_keyring *kr);
////////////////////////////////////////////////////////
void dnssec_keystore_resetpath();
const char *dnssec_keystore_getpath();
void dnssec_keystore_setpath(const char* path);
/*
ya_result dnssec_keystore_add(dnssec_key* key);
dnssec_key* dnssec_keystore_get(u8 algorithm,u16 tag,u16 flags,const char *origin);
dnssec_key* dnssec_keystore_remove(u8 algorithm,u16 tag,u16 flags,const char *origin);
*/
void dnssec_keystore_destroy();
/** Generates a private key, store in the keystore */
ya_result dnssec_keystore_new_key(u8 algorithm, u32 size, u16 flags, const char *origin, dnssec_key **out_key);
/**
* Loads a public key from the rdata, store in the keystore, then sets out_key to point to it
*
* RC ok
*
* @param rdata
* @param rdata_size
* @param origin
* @param out_key
* @return
*/
ya_result dnssec_keystore_load_public_key_from_rdata(const u8 *rdata, u16 rdata_size, const u8 *origin, dnssec_key **out_key);
/**
* Loads a private key from the disk or the keystore, then returns it.
* NOTE: If the key already existed as a public-only key, the public version is released.
*
* RC ok
*
* @param algorithm
* @param tag
* @param flags
* @param origin
* @param out_key
* @return
*/
ya_result dnssec_keystore_load_private_key_from_rdata(const u8 *rdata, u16 rdata_size, const u8 *fqdn, dnssec_key **out_key);
/**
* Loads a private key from the disk or the keystore, then returns it.
* NOTE: If the key already existed as a public-only key, the public version is destroyed.
*
* RC ok
*
* @param algorithm
* @param tag
* @param flags
* @param origin
* @param out_key
* @return
*/
ya_result dnssec_keystore_load_private_key_from_parameters(u8 algorithm, u16 tag, u16 flags, const u8 *fqdn, dnssec_key **out_key);
/** Writes the key into g_keystore_path (which should be changed to whatever is the right path of the key */
ya_result dnssec_keystore_store_private_key(dnssec_key *key);
/** Writes the key into g_keystore_path (which should be changed to whatever is the right path of the key */
ya_result dnssec_keystore_store_public_key(dnssec_key *key);
/*
void dnssec_key_addrecord_to_zone(dnssec_key* key, zdb_zone* zone);
*/
dnssec_key *dnssec_keystore_acquire_key(const u8 *domain, int index);
#ifdef __cplusplus
}
#endif
/** @} */
|