/usr/include/dnsdb/zdb_zone.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 | /*------------------------------------------------------------------------------
*
* 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 dnsdbzone Zone related functions
* @ingroup dnsdb
* @brief Functions used to manipulate a zone
*
* Functions used to manipulate a zone
*
* @{
*/
#ifndef _ZDB_ZONE_H
#define _ZDB_ZONE_H
#include <dnscore/input_stream.h>
#include <dnscore/output_stream.h>
#include <dnsdb/zdb_types.h>
#include <dnsdb/dnsrdata.h>
#include <dnsdb/zdb-zone-lock.h>
#include <dnsdb/zdb-zone-arc.h>
#include "nsec3_types.h"
#ifdef __cplusplus
extern "C"
{
#endif
#define ZDB_ZONETAG 0x454e4f5a52445a /* "ZDBZONE" */
/**
* @brief Get the zone with the given name
*
* Get the zone with the given name
*
* @param[in] db a pointer to the database
* @param[in] exact_match_origin the name of the zone
*
* @return a pointer to zone or NULL if the zone is not in the database
*
*/
/* 2 USES */
zdb_zone *zdb_zone_find(zdb *db, dnsname_vector* exact_match_origin);
/**
* @brief Get the zone with the given name
*
* Get the zone with the given name
*
* @param[in] db a pointer to the database
* @param[in] name the name of the zone (dotted c-string)
*
* @return a pointer to zone or NULL if the zone is not in the database
*
*/
zdb_zone *zdb_zone_find_from_name(zdb *db, const char* name);
/**
* @brief Adds a record to a zone
*
* Adds a record to a zone.
*
* @param[in] zone the zone
* @param[in] labels the stack of labels of the dns name
* @param[in] labels_top the index of the top of the stack (the level)
* @param[in] type the type of the record
* @param[in] ttlrdata the ttl and rdata of the record. NOTE: the zone becomes its new owner !!!
*/
/* 2 USES */
void zdb_zone_record_add(zdb_zone* zone, dnslabel_vector_reference labels, s32 labels_top, u16 type, zdb_packed_ttlrdata* ttlrdata); /* class is implicit */
/**
* @brief Removes a record from a zone
*
* Removes a record from a zone
*
* @param[in] zone the zone
* @param[in] labels the stack of labels of the dns name
* @param[in] labels_top the index of the top of the stack (the level)
* @param[in] type the type of the record
* @param[in] ttlrdata the ttl and rdata of the record. NOTE: the caller stays the owner
*
* @return an error code
*/
ya_result zdb_zone_record_delete(zdb_zone* zone, dnslabel_vector_reference labels, s32 labels_top, u16 type, zdb_packed_ttlrdata* ttlrdata); /* class is implicit */
/**
* @brief Search for a record in a zone
*
* Search for a record in a zone
*
* @param[in] zone the zone
* @param[in] labels the stack of labels of the dns name
* @param[in] labels_top the index of the top of the stack (the level)
* @param[in] type the type of the record
*/
/* 4 USES */
zdb_packed_ttlrdata* zdb_zone_record_find(zdb_zone *zone, dnslabel_vector_reference labels, s32 labels_top, u16 type);
/**
* @brief Creates a zone
*
* Creates a zone
*
* @param[in] zone a pointer to the zone
*/
/* 2 USES */
zdb_zone *zdb_zone_create(const u8 *origin);
/*
* Sets a zone as invalid.
* This will put the (content of the) zone in a garbage to be freed at some point in the future (when nolonger used)
* Also an invalid zone ... the .axfr and journal files should probably be trashed
*
*/
void zdb_zone_invalidate(zdb_zone *zone);
void zdb_zone_truncate_invalidate(zdb_zone *zone);
/**
* @brief Destroys a zone and all its content
*
* Destroys a zone and all its content
*
* @param[in] zone a pointer to the zone
*/
/* 10 USES */
void zdb_zone_destroy(zdb_zone *zone);
/**
* @brief Copies the soa of a zone to an soa_rdata structure.
*
* Copies the soa of a zone to an soa_rdata structure.
* No memory is allocated for the soa_rdata. If the zone is destroyed,
* the soa_rdata becomes invalid.
*
* @param[in] zone a pointer to the zone
* @param[out] soa_out a pointer to an soa_rdata structure
*/
ya_result zdb_zone_getsoa(const zdb_zone *zone, soa_rdata *soa_out);
ya_result zdb_zone_getsoa_ttl_rdata(const zdb_zone* zone, u32 *ttl, u16 *rdata_size, const u8 **rdata);
/**
* @brief Retrieve the serial of a zone
*
* Retrieve the serial of a zone
*
* @param[in] zone a pointer to the zone
* @param[out] serial a pointer to an u32 that will get the serial
*/
ya_result zdb_zone_getserial(const zdb_zone* zone, u32 *serial);
/**
* @brief Retrieve the minttl of a zone
*
* Retrieve the serial of a zone
*
* @param[in] zone a pointer to the zone
* @param[out] serial a pointer to an u32 that will get the minttl
*/
static inline ya_result zdb_zone_getminttl(const zdb_zone *zone, u32 *minttl)
{
*minttl = zone->min_ttl;
return SUCCESS;
}
#if ZDB_RECORDS_MAX_CLASS == 1
static inline u16 zdb_zone_getclass(const zdb_zone *zone)
{
return CLASS_IN;
}
#else
static inline u16 zdb_zone_getclass(const zdb_zone *zone)
{
return zone->zclass;
}
#endif
/**
* @brief Updates a zone from an IXFR input stream
*
* Loads a zone from an IXFR input stream
*
* The function does not closes the input stream
*
* If the IXFR is wrong, the zone will be messed up.
* Please check that the general structure of the stream is right
* before calling this.
*
* SOA x+n
* SOA x+0
* ...
* SOA x+1
* ...
*
* SOA x+1
* ...
* SOA x+2
* ...
* SOA x+n
*
* @param[in] db a pointer to the database
* @param[in] is a pointer to an input stream containing the IXFR
*
* @return an error code
*/
ya_result zdb_zone_update_ixfr(zdb *db, input_stream *is);
ya_result zdb_zone_store_axfr(zdb_zone *zone, output_stream* os);
const zdb_packed_ttlrdata*
zdb_zone_get_dnskey_rrset(zdb_zone *zone);
static inline bool zdb_zone_is_nsec3(const zdb_zone* zone)
{
#if ZDB_HAS_NSEC3_SUPPORT != 0
return (zone->apex->flags & ZDB_RR_LABEL_NSEC3) != 0;
#else
return FALSE;
#endif
}
static inline bool zdb_zone_is_nsec3_optout(const zdb_zone* zone)
{
return ((zone->apex->flags & ZDB_RR_LABEL_NSEC3_OPTOUT) != 0);
}
static inline bool zdb_zone_is_nsec3_optin(const zdb_zone* zone)
{
return ((zone->apex->flags & ZDB_RR_LABEL_NSEC3_OPTOUT) == 0);
}
static inline nsec3_zone* zdb_zone_get_nsec3chain(const zdb_zone* zone, s8 idx)
{
#if ZDB_HAS_NSEC3_SUPPORT != 0
nsec3_zone *n3 = zone->nsec.nsec3;;
while(n3 != NULL && --idx >= 0)
{
n3 = n3->next;
}
return n3;
#else
return NULL;
#endif
}
static inline bool zdb_zone_is_nsec(const zdb_zone *zone)
{
#if ZDB_HAS_NSEC_SUPPORT != 0
return (zone->apex->flags & ZDB_RR_LABEL_NSEC) != 0;
#else
return FALSE;
#endif
}
static inline bool zdb_zone_is_dnssec(const zdb_zone *zone)
{
#if ZDB_HAS_DNSSEC_SUPPORT != 0
return (zone->apex->flags & (ZDB_RR_LABEL_NSEC | ZDB_RR_LABEL_NSEC3)) != 0;
#else
return FALSE;
#endif
}
bool zdb_zone_isinvalid(zdb_zone *zone);
static inline bool zdb_zone_isvalid(zdb_zone *zone)
{
return !zdb_zone_isinvalid(zone);
}
#ifdef DEBUG
/**
* DEBUG
*/
void zdb_zone_print_indented(zdb_zone* zone, output_stream *os, int indent);
void zdb_zone_print(zdb_zone *zone, output_stream *os);
#endif
#ifdef __cplusplus
}
#endif
#endif /* _ZDB_ZONE_H */
/** @} */
|