/usr/include/dnsdb/rrsig.h is in libyadifa-dev 2.3.7-1build1.
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 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 | /*------------------------------------------------------------------------------
*
* Copyright (c) 2011-2017, 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 rrsig RRSIG functions
* @ingroup dnsdbdnssec
* @brief
*
*
*
* @{
*
*----------------------------------------------------------------------------*/
#ifndef _RRSIG_H
#define _RRSIG_H
#include <dnscore/threaded_queue.h>
#include <dnscore/ptr_vector.h>
#include <dnscore/dnskey.h>
#include <dnsdb/zdb_types.h>
#include <dnsdb/rr_canonize.h>
#if ZDB_HAS_NSEC3_SUPPORT != 0
#include <dnsdb/nsec3.h>
#endif
#define RRSIG_TTLRDATA_TAG 0x52544749535252 /* RRSIGTR */
#define DNSSEC_KEY_SLL_TAG 0x59454b43455344 /* DSECKEY */
#define DNSSEC_DEBUGLEVEL 0 // NOT FOR RELEASE (put a 0 here on RELEASE code)
#define DNSSEC_DUMPSIGNCOUNT 0
#ifndef DEBUG
#define SIGNER_THREAD_COUNT 2
#else
#define SIGNER_THREAD_COUNT 1 /* EASIER FOR DEBUGGING */
#endif
#define SIGNATURES_COUNT 1000
#define QUEUE_MAX_SIZE 65536
#define MAX_ENGINE_PRESET_COUNT 128
/** The label is not signed */
#define RRSIG_VERIFIER_RESULT_LABELNOTSIGNED 4
/** The type is not signed */
#define RRSIG_VERIFIER_RESULT_NOTSIGNED 3
/** The signature has not been verified */
#define RRSIG_VERIFIER_RESULT_BADSIGNATURE 2
/** The parameters of the RRSIG does not match the context */
#define RRSIG_VERIFIER_RESULT_BADRECORD 1
/** The signature has been verified */
#define RRSIG_VERIFIER_RESULT_OK 0
#define RRSIG_VERIFIER_RESULT_MAXVALUE 4
#define NO_SIGNATURES 0
#define HAD_SIGNATURES 1
#define UPDATED_SIGNATURES 2
#define RRSIG_DEFAULT_VALIDITY_DURATION (86400*31)
/*
* Extract fields from a packed record
*/
#define RRSIG_TYPE_COVERED(x__) (GET_U16_AT((x__)->rdata_start[0])) /** @note : NATIVETYPE */
#define RRSIG_ALGORITHM(x__) ((x__)->rdata_start[2])
#define RRSIG_LABELS(x__) ((x__)->rdata_start[3])
#define RRSIG_ORIGINAL_TTL(x__) (ntohl(GET_U32_AT((x__)->rdata_start[4])))
#define RRSIG_VALID_UNTIL(x__) (ntohl(GET_U32_AT((x__)->rdata_start[8])))
#define RRSIG_VALID_SINCE(x__) (ntohl(GET_U32_AT((x__)->rdata_start[12])))
#define RRSIG_KEY_TAG(x__) (ntohs(GET_U16_AT((x__)->rdata_start[16]))) /** @note : NATIVETAG (LOOK FOR ALL OF THEM) */
#define RRSIG_KEY_NATIVETAG(x__) (GET_U16_AT((x__)->rdata_start[16]))
#define RRSIG_SIGNER_NAME(x__) (&(x__)->rdata_start[18])
#define RRSIG_RDATA_TO_TYPE_COVERED(x__) GET_U16_AT(x__)
#define RRSIG_CONTEXT_NSEC 1
#define RRSIG_CONTEXT_NSEC3 2
#define RRSIG_CONTEXT_NSEC3_OPTOUT 3
#ifdef __cplusplus
extern "C" {
#endif
static inline u16 rrsig_get_type_covered_from_rdata(const void *rdata, u16 rdata_size)
{
u16 tc = TYPE_NONE;
if(rdata_size >= 2)
{
tc = GET_U16_AT_P(rdata);
}
return tc;
}
static inline u8 rrsig_get_algorithm_from_rdata(const void *rdata, u16 rdata_size)
{
u8 a = 0;
if(rdata_size >= 3)
{
a = ((const u8*)rdata)[2];
}
return a;
}
static inline u8 rrsig_get_labels_from_rdata(const void *rdata, u16 rdata_size)
{
u8 l = 0;
if(rdata_size >= 4)
{
l = ((const u8*)rdata)[3];
}
return l;
}
static inline s32 rrsig_get_original_ttl_from_rdata(const void *rdata, u16 rdata_size)
{
s32 ottl = 0;
if(rdata_size >= 8)
{
ottl = GET_U32_AT(((const u8*)rdata)[4]);
}
return ottl;
}
static inline s32 rrsig_get_valid_until_from_rdata(const void *rdata, u16 rdata_size)
{
s32 t = 0;
if(rdata_size >= 12)
{
t = ntohl(GET_U32_AT(((const u8*)rdata)[8]));
}
return t;
}
static inline s32 rrsig_get_valid_from_from_rdata(const void *rdata, u16 rdata_size)
{
s32 t = 0;
if(rdata_size >= 16)
{
t = ntohl(GET_U32_AT(((const u8*)rdata)[12]));
}
return t;
}
static inline u16 rrsig_get_key_tag_from_rdata(const void *rdata, u16 rdata_size)
{
u16 tag = 0;
if(rdata_size >= 18)
{
tag = ntohs(GET_U16_AT(((const u8*)rdata)[16]));
}
return tag;
}
static inline const u8* rrsig_get_signer_name_from_rdata(const void *rdata, u16 rdata_size)
{
const u8 *signer_name = NULL;
if(rdata_size >= 18)
{
signer_name = &((const u8*)rdata)[18];
}
return signer_name;
}
typedef struct rrsig_context_s rrsig_context_s;
#define RRSIGCTX_TAG 0x5854434749535252
struct rrsig_context_s
{
ENGINE *engine;
dnssec_key_sll *key_sll;
/*
* Current rrsig_sll (ZALLOC)
*/
zdb_packed_ttlrdata *rrsig_sll;
/*
* New rrsig_ssl (MALLOC)
*/
zdb_packed_ttlrdata *added_rrsig_sll;
/*
* Expired/invalid rrsig_ssl (MALLOC)
*/
zdb_packed_ttlrdata *removed_rrsig_sll;
const zdb_packed_ttlrdata *canonised_rrset;
/* Used for RR canonization */
ptr_vector rrs;
u8 *origin; /* Origin of the zone. The rrsig has to match
* this.
*/
smp_int *loose_quota; // each signature will decrease this by 1
// since signatures are made by label, this
// is a best effort deal and this value will
// most likely drop below zero
/**/
u32 rr_dnsname_len;
u32 origin_len; /* dnsname_len(origin) */
u32 original_ttl;
u32 min_ttl;
/**/
u32 valid_from; /* epoch */
/**/
u32 sig_validity_regeneration_seconds;
u32 sig_validity_interval_seconds;
u32 sig_jitter_seconds;
u32 sig_invalid_first;
u32 sig_pre_validate_seconds; // the amounts of seconds before "now" the signature will be made valid (1h)
/**/
u32 expired_signatures;
u32 soon_expired_signatures;
/**/
u32 wrong_signatures;
u32 good_signatures;
/**/
u32 rrsig_header_length;
u32 record_header_label_type_class_ttl_length;
/**/
u32 canonized_rr_type_offset;
u16 zclass;
u8 label_depth;
u8 flags;
u8 nsec_flags;
bool must_verify_signatures; // once the signatures are in, there is no point doing it again
// if we do them, they are right
// if the master do them, he is right
// the only time they should be verified is at load time
bool signatures_are_invalid; // signatures verification will immediately see them as wrong.
// must_verify_signatures must be set to TRUE for this to be used.
bool rr_dnsname_processing_apex;
/**/
/*
* Owner of the RR
*
* STACK!
*/
dnsname_stack rr_dnsname;
/*
* Will contain the label + type + class + ttl
* Common for all the records of the same label/type
* The type will be edited in order to avoid computing it for
* other records of the same label
*
* Candidate for the context
*/
u8 record_header_label_type_class_ttl[MAX_DOMAIN_LENGTH + 1 + 2 + 2];
/*
* Will contain the type + alg + labels + orgttl + from + to + tag + name
* Common for all the records of the same label
* The type will be edited in order to avoid computing it for
* other records of the same label
*
* Candidate for the context
*/
u8 rrsig_header[2+1+1+4+4+4+2+MAX_DOMAIN_LENGTH];
};
#define ZDB_RRSIGUPQ_TAG 0x5150554749535252 /* RRSIGUPQ */
struct rrsig_update_item_s
{
/// The zone being updated
zdb_zone* zone;
/// The label being processed
zdb_rr_label* label;
/// An rrset of records (mallocated) to add in the label
zdb_packed_ttlrdata* added_rrsig_sll;
/// An rrset of records (mallocated) to remove (and free) from the label
zdb_packed_ttlrdata* removed_rrsig_sll;
// The fqdn of the label
dnsname_stack path;
};
typedef struct rrsig_update_item_s rrsig_update_item_s;
static inline rrsig_update_item_s* rrsig_update_item_alloc()
{
rrsig_update_item_s *ret;
ZALLOC_OR_DIE(rrsig_update_item_s*, ret, rrsig_update_item_s, ZDB_RRSIGUPQ_TAG);
return ret;
}
static inline void rrsig_update_item_free(rrsig_update_item_s *rui)
{
ZFREE(rui, rrsig_update_item_s);
}
#if ZDB_HAS_NSEC3_SUPPORT != 0
struct nsec3_rrsig_update_item_s
{
zdb_zone* zone;
nsec3_zone_item* item;
nsec3_zone_item* next;
/*
* New rrsig (MALLOC)
*/
zdb_packed_ttlrdata* added_rrsig_sll;
/*
* Expired/invalid rrsig (MALLOC)
*/
zdb_packed_ttlrdata* removed_rrsig_sll;
};
typedef struct nsec3_rrsig_update_item_s nsec3_rrsig_update_item_s;
#endif
/**
*
* @param context the signature context to be initialised
* @param zone the zone that will be signed
* @param engine_name the engine name (this parameter will be removed soon for a global setup)
* @param sign_from the time to sign from
* @param quota for multi-threaded operation, the amount of signature to target (this is not meant to be accurate)
*
* @return an error code if the initialisation failed
*/
ya_result rrsig_context_initialize(rrsig_context_s *context, const zdb_zone *zone, const char *engine_name, u32 sign_from, smp_int *quota);
void rrsig_context_destroy(rrsig_context_s *context);
static inline void rrsig_context_update_quota(rrsig_context_s *context, s32 sig_count)
{
if((sig_count > 0) && (context->loose_quota != NULL))
{
smp_int_sub(context->loose_quota, sig_count);
}
}
static inline s32 rrsig_context_get_quota(rrsig_context_s *context)
{
if(context->loose_quota != NULL)
{
s32 quota = smp_int_get(context->loose_quota);
return quota;
}
else
{
return MAX_S32;
}
}
/**
* Updates the current algorithm and tag of a context using the given key
* Meant to modify the current pre-computed header of the signature
*
* @param context
* @param key
*/
void rrsig_context_set_current_key(rrsig_context_s *context, const dnssec_key* key);
/*
* Adds/Removes a label in the path in order to process it
*/
void rrsig_context_push_name_rrsigsll(rrsig_context_s *context, const u8 *name, zdb_packed_ttlrdata* rrsig_sll);
/* Calls rrsig_update_context_push_name_rrsigsll using the label's fields */
void rrsig_context_push_label(rrsig_context_s *context, zdb_rr_label* label);
void rrsig_context_pop_label(rrsig_context_s *context);
/**
* Adds the signature to the "to-be-deleted" set of the context.
*
* @param context
* @param rrsig
*/
void rrsig_context_append_delete_signature(rrsig_context_s *context, zdb_packed_ttlrdata *rrsig);
/**
* Compute (the need for) updates by a DNSKEY over an RR set of a given type.
* Updates timings of resignature in the context.
*
* If a public key is given instead of a private key, do_update is assumed FALSE
*
* @param context the signature context
* @param key the signing key (can be public only)
* @param rr_sll the rrset records
* @param type the rrset type
* @param do_update if TRUE, generated and pushes updates in the context, else only update timings
*
* @return the number of signatures computed
*/
ya_result rrsig_update_rrset_with_key(rrsig_context_s *context, const zdb_packed_ttlrdata *rr_sll, u16 type, const dnssec_key* key, bool do_update);
/**
* Computes the updates of an rrset of a given type (cannot be TYPE_ANY, obviously)
* Changes are stored into the context and still needs to be committed.
*
* @param context the signature context
* @param records_sll the rrset records
* @param rrset_type the rrset type
* @param delegation the signature is on a delegation (result of ZDB_LABEL_ATDELEGATION(label))
*
* @return an error code or the number of signatures that have been made
*/
ya_result rrsig_update_rrset(rrsig_context_s *context, const zdb_packed_ttlrdata *records_sll, u16 rrset_type, bool delegation);
/*
* Takes the result of an update and commits it to the label
*/
void rrsig_update_commit(zdb_packed_ttlrdata* removed_rrsig_sll, zdb_packed_ttlrdata* added_rrsig_sll, zdb_rr_label* label, zdb_zone* zone, dnsname_stack* name);
/**
*
* Returns the first RRSIG record that applies to the give type.
*
* @param label the label where to do the search
* @param covered_type the type covered by the RRSIG
*
* @return the first RRSIG covering the type or NULL
*/
zdb_packed_ttlrdata* rrsig_find_first(const zdb_rr_label* label, u16 covered_type);
/**
*
* Returns the next RRSIG record that applies to the give type.
*
* @param rrsig the previous RRSIG covering the type
* @param covered_type the type covered by the RRSIG
*
* @return covered_type the next RRSIG covering the type or NULL
*/
zdb_packed_ttlrdata* rrsig_find_next(const zdb_packed_ttlrdata* rrsig, u16 covered_type);
/**
*
* Removes all the RRSIG covering the type
*
* @param dname the fqdn of the label
* @param label the label
* @param covered_type the type covered by the RRSIG
*/
void rrsig_delete(const zdb_zone *zone, const u8 *dname, zdb_rr_label* label, u16 covered_type);
void rrsig_delete_by_tag(const zdb_zone *zone, u16 tag);
/**
*
* Signs an RRSET using a context. This is done single-threaded.
*
* @param context
* @param fqdn
* @param rtype
* @param rrset
* @return
*/
ya_result rrsig_generate_signatures(rrsig_context_s *context, const u8 *fqdn, u16 rtype, const zdb_packed_ttlrdata *rrset, zdb_packed_ttlrdata **out_rrsig_sll);
/**
*
* Does all the steps required to update an rrset in a zone.
* The zone is expected to be suitably locked.
*
* @param zone
* @param fqdn
* @param label
* @param rtype
* @return
*/
ya_result rrsig_rrset_update_helper(zdb_zone *zone, const u8 *fqdn, zdb_rr_label *label, u16 rtype);
bool rrsig_should_label_be_signed(zdb_zone *zone, const u8 *fqdn, zdb_rr_label *rr_label);
#ifdef __cplusplus
}
#endif
#endif /* _RRSIGN_H */
/** @} */
/*----------------------------------------------------------------------------*/
|