/usr/include/dnsdb/zdb.h is in libyadifa-dev 2.1.6-1.
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 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 | /*------------------------------------------------------------------------------
*
* 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 dnsdb Zone database
* @brief The zone database
*
* Implementation of structures and functions for the database
*
* Memory usage approxymation:
*
* let:
*
* "digest" the size of a digest
* "n3pc" the number of nsec3param
* "r" the number of records
*
* Memory usage =~ (233.3333 + ((446.666+digest) * n3pc) * r
*
* Or, if the digest size is different for each n3p:
*
* With "digest(n)" being the size of the digest for the n-th nsec3param
*
* =~ (233.3333 + SUM[n=1..n3pc](446.666+digest(n))) * r
*
* @{
*/
#ifndef _ZDB_H
#define _ZDB_H
#include <dnscore/message.h>
#include <dnscore/fingerprint.h>
#include <dnsdb/zdb_config.h>
#include <dnsdb/zdb_types.h>
#include <dnsdb/zdb_error.h>
#include <dnsdb/zdb-lock.h>
/* EDNS -> */
/* <- EDNS */
#ifdef __cplusplus
extern "C"
{
#endif
#define ZDB_ROOT_TAG 0x544f4f5242445a /* "ZDBROOT" */
#define ZDB_DOMAIN_ROOT_TAG 0x524e4d4442445a /* "ZDBDMNR" */
#define ZDBZONE_TAG 0x454e4f5a42445a /* "ZDBZONE" */
/*
* This fingerprint feature has been added so libraries could check they are compatible
*/
dnslib_fingerprint
dnsdb_getfingerprint();
u32
dnsdb_fingerprint_mask();
/** @brief Initializes the database internals.
*
* Initializes the database internals.
* Multiple calls is a NOP.
*
* This is not thread safe.
*
*/
void zdb_init();
void zdb_init_ex(u32 thread_pool_count);
/** @brief Destroys the database internals.
*
* Destroys the database internals.
* Multiple calls is a NOP.
*
* This is not thread safe.
*
*/
void zdb_finalize();
/** @brief Initializes a database.
*
* Initializes a database.
*
* @param[in] db a pointer to the zdb structure that will be initialized.
*
*/
void zdb_create(zdb *db);
/**
*
* Puts a zone in the DB.
*
* If a zone with the same name did exist, returns the old zone (to be released)
* and replaces it with the one given as a parameter.
*
* This function temporarily locks the database for writing.
* The zone added gets its RC increased.
*
* @param db
* @param zone
*
* @return
*/
zdb_zone *zdb_set_zone(zdb *db, zdb_zone* zone);
zdb_zone *zdb_remove_zone(zdb *db, dnsname_vector *name);
zdb_zone *zdb_remove_zone_from_dnsname(zdb *db, const u8 *dnsname);
/** @brief Search for a single match in the database
*
* Search for a match in the database.
* Only the most relevant match will be returned (ONE record set)
*
* @param[in] db the database
* @param[in] dnsname_name the name dnsname to search for
* @param[in] class the class to match
* @param[in] type the type to match
* @param[out] ttl_rdara_out a pointer to a pointer set of results (single linked list)
*
* @return SUCCESS in case of success.
*/
ya_result zdb_query(zdb* db, const u8 *dnsname_name, u16 type, zdb_packed_ttlrdata** ttlrdara_out);
static inline void zdb_query_ex_answer_create(zdb_query_ex_answer *ans_auth_add)
{
ZEROMEMORY(ans_auth_add, sizeof(zdb_query_ex_answer));
}
/**
* @brief Build a dns answer from a query.
*
* Build a dns answer from a query.
*
* Records are stored in the zdb_query_ex_answer structure (four lists)
*
* After the answer has been processed, it must be destroyed using zdb_query_ex_answer_destroy
*
* @param db
* @param mesg
* @param ans_auth_add
* @param pool_buffer
*
* @return
*/
finger_print zdb_query_ex(zdb *db, message_data *mesg, zdb_query_ex_answer *ans_auth_add, u8 *restrict pool_buffer);
/**
* Destroys a zdb_query_ex_answer structure created with zdb_query_ex
*
* @param ans_auth_add
*/
// void zdb_query_ex_answer_destroy(zdb_query_ex_answer* ans_auth_add);
#define zdb_query_ex_answer_destroy(unused__) ((void)unused__)
/**
* @brief Writes the answer into the message.
*
* Writes the content of a zdb_query_ex_answer into a message_data.
*
* Returns the offset in the packet.
*
* CANNOT FAIL !
*
* @param message
* @param answer_set
* @return
*/
ya_result zdb_query_message_update(message_data* message, zdb_query_ex_answer* answer_set);
/**
* This function should not be used anymore. Please consider using zdb_append_ip_records instead.
*
* @param db
* @param name_
* @param ttlrdata_out_a
* @param ttlrdata_out_aaaa
* @return
*/
ya_result zdb_query_ip_records(zdb* db, const u8* name_, zdb_packed_ttlrdata **ttlrdata_out_a, zdb_packed_ttlrdata **ttlrdata_out_aaaa);
/**
*
* Appends all A and AAAA records found in the database for the given fqdn
* Given the nature of the list, what is returned is a copy.
* The call locks the database for reading, then each involved zone for reading.
* Locks are released before the function returns.
*
* @param db database
* @param name_ fqdn
* @param target_list list
* @return
*/
ya_result zdb_append_ip_records(zdb* db, const u8* name_, host_address *target_list);
#if 0
/**
* Get a label from the database.
* Optionally, the zone can be retrieved (zonep != NULL) and the zone can be locked by a specific owner.
* Note that lock without retrieval of the zone is forbidden (and will abort on debug code)
* The zone of the label may be locked as well.
*
* Release the zone with: zdb_zone_release_unlock(*zonep, owner);
*
* Note that using the returned pointer without locking the zone may have undefined results on a multi threaded environment.
*
* @param db
* @param name
* @param zonep
* @param owner
*
* @return
*/
zdb_rr_label *zdb_get_rr_label(zdb* db, const u8* name, zdb_zone **zonep, u8 owner);
/**
* Get an rr set from the database.
* The type must be specific (TYPE_ANY will return NULL)
* Optionally, the zone can be retrieved (zonep != NULL) and the zone can be locked by a specific owner.
* Note that lock without retrieval of the zone is forbidden (and will abort on debug code)
* The zone of the label may be locked as well.
*
* Release the zone with: zdb_zone_release_unlock(*zonep, owner);
*
* Note that using the returned pointer without locking the zone may have undefined results on a multi threaded environment.
*
* @param db
* @param name
* @param type
* @param zonep
* @param owner
*
* @return
*/
const zdb_packed_ttlrdata *zdb_get_rr_set(zdb* db, const u8* name, u16 rtype, zdb_zone **zonep, u8 owner);
#endif
#if OBSOLETE
/** @brief Adds an entry in a zone of the database
*
* Adds an entry in a zone of the database
*
* @param[in] db the database
* @param[in] origin_ the zone where to add the record
* @param[in] name_ the full name of the record (dns form)
* @param[in] zclass the class of the record
* @param[in] type the type of the record
* @param[in] ttl the ttl of the record
* @param[in] rdata_size the size of the rdata of the record
* @param[in] rdata a pointer to the rdata of the record
*
* @return SUCCESS in case of success.
*/
ya_result zdb_add(zdb* db, u8* origin_, u8* name_, u16 type, u32 ttl, u16 rdata_size, void* rdata); /* 4 match, add 1 */
/** @brief Deletes an entry from a zone in the database
*
* Matches and deletes an entry from a zone in the database
*
* @param[in] db the database
* @param[in] origin_ the zone from which to remove the record
* @param[in] name_ the name of the record
* @param[in] zclass the class of the record
* @param[in] type the type of the record
* @param[in] ttl the ttl of the record
* @param[in] rdata_size the size of the rdata of the record
* @param[in] rdata a pointer to the rdata of the record
*
* @return SUCCESS in case of success.
*/
ya_result zdb_delete(zdb* db, u8* origin, u8* name, u16 type, u32 ttl, u16 rdata_size, void* rdata); /* 5 match, delete 1 */
#endif
/** @brief Destroys the database
*
* Destroys a database. (Empties it)
*
* @param[in] db the database to destroy
*
*/
void zdb_destroy(zdb* db);
/**
* Looks for a zone and tells if zone is marked as invalid.
* The zone can only be invalid if it exists.
*
* @param db
* @param origin
* @param zclass
* @return
*/
bool zdb_is_zone_invalid(zdb *db, const u8 *origin);
/** @brief DEBUG: Prints the content of the database.
*
* DEBUG: Prints the content of the database.
*
* @param[in] db the database to print
*
*/
void zdb_signature_check(int so_zdb, int so_zdb_zone, int so_zdb_zone_label, int so_zdb_rr_label, int so_mutex_t);
#define ZDB_API_CHECK() zdb_signature_check(sizeof(zdb),sizeof(zdb_zone),sizeof(zdb_zone_label),sizeof(zdb_rr_label),sizeof(mutex_t))
#ifdef DEBUG
/**
* DEBUG
*/
void zdb_print(zdb *db, output_stream *os);
#endif
#ifdef __cplusplus
}
#endif
#endif /* _ZDB_H */
/** @} */
|