1238106Sdes/* 2238106Sdes * validator/val_sigcrypt.h - validator signature crypto functions. 3238106Sdes * 4238106Sdes * Copyright (c) 2007, NLnet Labs. All rights reserved. 5238106Sdes * 6238106Sdes * This software is open source. 7238106Sdes * 8238106Sdes * Redistribution and use in source and binary forms, with or without 9238106Sdes * modification, are permitted provided that the following conditions 10238106Sdes * are met: 11238106Sdes * 12238106Sdes * Redistributions of source code must retain the above copyright notice, 13238106Sdes * this list of conditions and the following disclaimer. 14238106Sdes * 15238106Sdes * Redistributions in binary form must reproduce the above copyright notice, 16238106Sdes * this list of conditions and the following disclaimer in the documentation 17238106Sdes * and/or other materials provided with the distribution. 18238106Sdes * 19238106Sdes * Neither the name of the NLNET LABS nor the names of its contributors may 20238106Sdes * be used to endorse or promote products derived from this software without 21238106Sdes * specific prior written permission. 22238106Sdes * 23238106Sdes * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 24238106Sdes * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 25238106Sdes * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 26238106Sdes * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE 27238106Sdes * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 28238106Sdes * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 29238106Sdes * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 30238106Sdes * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 31238106Sdes * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 32238106Sdes * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 33238106Sdes * POSSIBILITY OF SUCH DAMAGE. 34238106Sdes */ 35238106Sdes 36238106Sdes/** 37238106Sdes * \file 38238106Sdes * 39238106Sdes * This file contains helper functions for the validator module. 40238106Sdes * The functions help with signature verification and checking, the 41238106Sdes * bridging between RR wireformat data and crypto calls. 42238106Sdes */ 43238106Sdes 44238106Sdes#ifndef VALIDATOR_VAL_SIGCRYPT_H 45238106Sdes#define VALIDATOR_VAL_SIGCRYPT_H 46238106Sdes#include "util/data/packed_rrset.h" 47238106Sdesstruct val_env; 48238106Sdesstruct module_env; 49238106Sdesstruct ub_packed_rrset_key; 50238106Sdesstruct rbtree_t; 51238106Sdesstruct regional; 52238106Sdes 53238106Sdes/** number of entries in algorithm needs array */ 54238106Sdes#define ALGO_NEEDS_MAX 256 55238106Sdes 56238106Sdes/** 57238106Sdes * Storage for algorithm needs. DNSKEY algorithms. 58238106Sdes */ 59238106Sdesstruct algo_needs { 60238106Sdes /** the algorithms (8-bit) with each a number. 61238106Sdes * 0: not marked. 62238106Sdes * 1: marked 'necessary but not yet fulfilled' 63238106Sdes * 2: marked bogus. 64238106Sdes * Indexed by algorithm number. 65238106Sdes */ 66238106Sdes uint8_t needs[ALGO_NEEDS_MAX]; 67238106Sdes /** the number of entries in the array that are unfulfilled */ 68238106Sdes size_t num; 69238106Sdes}; 70238106Sdes 71238106Sdes/** 72238106Sdes * Initialize algo needs structure, set algos from rrset as needed. 73238106Sdes * Results are added to an existing need structure. 74238106Sdes * @param n: struct with storage. 75238106Sdes * @param dnskey: algos from this struct set as necessary. DNSKEY set. 76238106Sdes * @param sigalg: adds to signalled algorithm list too. 77238106Sdes */ 78238106Sdesvoid algo_needs_init_dnskey_add(struct algo_needs* n, 79238106Sdes struct ub_packed_rrset_key* dnskey, uint8_t* sigalg); 80238106Sdes 81238106Sdes/** 82238106Sdes * Initialize algo needs structure from a signalled algo list. 83238106Sdes * @param n: struct with storage. 84238106Sdes * @param sigalg: signalled algorithm list, numbers ends with 0. 85238106Sdes */ 86238106Sdesvoid algo_needs_init_list(struct algo_needs* n, uint8_t* sigalg); 87238106Sdes 88238106Sdes/** 89238106Sdes * Initialize algo needs structure, set algos from rrset as needed. 90238106Sdes * @param n: struct with storage. 91238106Sdes * @param ds: algos from this struct set as necessary. DS set. 92238106Sdes * @param fav_ds_algo: filter to use only this DS algo. 93238106Sdes * @param sigalg: list of signalled algos, constructed as output, 94238106Sdes * provide size ALGO_NEEDS_MAX+1. list of algonumbers, ends with a zero. 95238106Sdes */ 96238106Sdesvoid algo_needs_init_ds(struct algo_needs* n, struct ub_packed_rrset_key* ds, 97238106Sdes int fav_ds_algo, uint8_t* sigalg); 98238106Sdes 99238106Sdes/** 100238106Sdes * Mark this algorithm as a success, sec_secure, and see if we are done. 101238106Sdes * @param n: storage structure processed. 102238106Sdes * @param algo: the algorithm processed to be secure. 103238106Sdes * @return if true, processing has finished successfully, we are satisfied. 104238106Sdes */ 105238106Sdesint algo_needs_set_secure(struct algo_needs* n, uint8_t algo); 106238106Sdes 107238106Sdes/** 108238106Sdes * Mark this algorithm a failure, sec_bogus. It can later be overridden 109238106Sdes * by a success for this algorithm (with a different signature). 110238106Sdes * @param n: storage structure processed. 111238106Sdes * @param algo: the algorithm processed to be bogus. 112238106Sdes */ 113238106Sdesvoid algo_needs_set_bogus(struct algo_needs* n, uint8_t algo); 114238106Sdes 115238106Sdes/** 116238106Sdes * See how many algorithms are missing (not bogus or secure, but not processed) 117238106Sdes * @param n: storage structure processed. 118238106Sdes * @return number of algorithms missing after processing. 119238106Sdes */ 120238106Sdessize_t algo_needs_num_missing(struct algo_needs* n); 121238106Sdes 122238106Sdes/** 123238106Sdes * See which algo is missing. 124238106Sdes * @param n: struct after processing. 125238106Sdes * @return if 0 an algorithm was bogus, if a number, this algorithm was 126238106Sdes * missing. So on 0, report why that was bogus, on number report a missing 127238106Sdes * algorithm. There could be multiple missing, this reports the first one. 128238106Sdes */ 129238106Sdesint algo_needs_missing(struct algo_needs* n); 130238106Sdes 131238106Sdes/** 132238106Sdes * Format error reason for algorithm missing. 133238106Sdes * @param env: module env with scratch for temp storage of string. 134238106Sdes * @param alg: DNSKEY-algorithm missing. 135238106Sdes * @param reason: destination. 136238106Sdes * @param s: string, appended with 'with algorithm ..'. 137238106Sdes */ 138238106Sdesvoid algo_needs_reason(struct module_env* env, int alg, char** reason, char* s); 139238106Sdes 140238106Sdes/** 141238106Sdes * Check if dnskey matches a DS digest 142238106Sdes * Does not check dnskey-keyid footprint, just the digest. 143238106Sdes * @param env: module environment. Uses scratch space. 144238106Sdes * @param dnskey_rrset: DNSKEY rrset. 145238106Sdes * @param dnskey_idx: index of RR in rrset. 146238106Sdes * @param ds_rrset: DS rrset 147238106Sdes * @param ds_idx: index of RR in DS rrset. 148238106Sdes * @return true if it matches, false on error, not supported or no match. 149238106Sdes */ 150238106Sdesint ds_digest_match_dnskey(struct module_env* env, 151238106Sdes struct ub_packed_rrset_key* dnskey_rrset, size_t dnskey_idx, 152238106Sdes struct ub_packed_rrset_key* ds_rrset, size_t ds_idx); 153238106Sdes 154238106Sdes/** 155238106Sdes * Get dnskey keytag, footprint value 156238106Sdes * @param dnskey_rrset: DNSKEY rrset. 157238106Sdes * @param dnskey_idx: index of RR in rrset. 158238106Sdes * @return the keytag or 0 for badly formatted DNSKEYs. 159238106Sdes */ 160238106Sdesuint16_t dnskey_calc_keytag(struct ub_packed_rrset_key* dnskey_rrset, 161238106Sdes size_t dnskey_idx); 162238106Sdes 163238106Sdes/** 164238106Sdes * Get DS keytag, footprint value that matches the DNSKEY keytag it signs. 165238106Sdes * @param ds_rrset: DS rrset 166238106Sdes * @param ds_idx: index of RR in DS rrset. 167238106Sdes * @return the keytag or 0 for badly formatted DSs. 168238106Sdes */ 169238106Sdesuint16_t ds_get_keytag(struct ub_packed_rrset_key* ds_rrset, size_t ds_idx); 170238106Sdes 171238106Sdes/** 172238106Sdes * See if DNSKEY algorithm is supported 173238106Sdes * @param dnskey_rrset: DNSKEY rrset. 174238106Sdes * @param dnskey_idx: index of RR in rrset. 175238106Sdes * @return true if supported. 176238106Sdes */ 177238106Sdesint dnskey_algo_is_supported(struct ub_packed_rrset_key* dnskey_rrset, 178238106Sdes size_t dnskey_idx); 179238106Sdes 180238106Sdes/** 181238106Sdes * See if DS digest algorithm is supported 182238106Sdes * @param ds_rrset: DS rrset 183238106Sdes * @param ds_idx: index of RR in DS rrset. 184238106Sdes * @return true if supported. 185238106Sdes */ 186238106Sdesint ds_digest_algo_is_supported(struct ub_packed_rrset_key* ds_rrset, 187238106Sdes size_t ds_idx); 188238106Sdes 189238106Sdes/** 190238106Sdes * Get DS RR digest algorithm 191238106Sdes * @param ds_rrset: DS rrset. 192238106Sdes * @param ds_idx: which DS. 193238106Sdes * @return algorithm or 0 if DS too short. 194238106Sdes */ 195238106Sdesint ds_get_digest_algo(struct ub_packed_rrset_key* ds_rrset, size_t ds_idx); 196238106Sdes 197238106Sdes/** 198238106Sdes * See if DS key algorithm is supported 199238106Sdes * @param ds_rrset: DS rrset 200238106Sdes * @param ds_idx: index of RR in DS rrset. 201238106Sdes * @return true if supported. 202238106Sdes */ 203238106Sdesint ds_key_algo_is_supported(struct ub_packed_rrset_key* ds_rrset, 204238106Sdes size_t ds_idx); 205238106Sdes 206238106Sdes/** 207238106Sdes * Get DS RR key algorithm. This value should match with the DNSKEY algo. 208238106Sdes * @param k: DS rrset. 209238106Sdes * @param idx: which DS. 210238106Sdes * @return algorithm or 0 if DS too short. 211238106Sdes */ 212238106Sdesint ds_get_key_algo(struct ub_packed_rrset_key* k, size_t idx); 213238106Sdes 214238106Sdes/** 215238106Sdes * Get DNSKEY RR signature algorithm 216238106Sdes * @param k: DNSKEY rrset. 217238106Sdes * @param idx: which DNSKEY RR. 218238106Sdes * @return algorithm or 0 if DNSKEY too short. 219238106Sdes */ 220238106Sdesint dnskey_get_algo(struct ub_packed_rrset_key* k, size_t idx); 221238106Sdes 222238106Sdes/** 223238106Sdes * Get DNSKEY RR flags 224238106Sdes * @param k: DNSKEY rrset. 225238106Sdes * @param idx: which DNSKEY RR. 226238106Sdes * @return flags or 0 if DNSKEY too short. 227238106Sdes */ 228238106Sdesuint16_t dnskey_get_flags(struct ub_packed_rrset_key* k, size_t idx); 229238106Sdes 230238106Sdes/** 231238106Sdes * Verify rrset against dnskey rrset. 232238106Sdes * @param env: module environment, scratch space is used. 233238106Sdes * @param ve: validator environment, date settings. 234238106Sdes * @param rrset: to be validated. 235238106Sdes * @param dnskey: DNSKEY rrset, keyset to try. 236238106Sdes * @param sigalg: if nonNULL provide downgrade protection otherwise one 237238106Sdes * algorithm is enough. 238238106Sdes * @param reason: if bogus, a string returned, fixed or alloced in scratch. 239238106Sdes * @return SECURE if one key in the set verifies one rrsig. 240238106Sdes * UNCHECKED on allocation errors, unsupported algorithms, malformed data, 241238106Sdes * and BOGUS on verification failures (no keys match any signatures). 242238106Sdes */ 243238106Sdesenum sec_status dnskeyset_verify_rrset(struct module_env* env, 244238106Sdes struct val_env* ve, struct ub_packed_rrset_key* rrset, 245238106Sdes struct ub_packed_rrset_key* dnskey, uint8_t* sigalg, char** reason); 246238106Sdes 247238106Sdes/** 248238106Sdes * verify rrset against one specific dnskey (from rrset) 249238106Sdes * @param env: module environment, scratch space is used. 250238106Sdes * @param ve: validator environment, date settings. 251238106Sdes * @param rrset: to be validated. 252238106Sdes * @param dnskey: DNSKEY rrset, keyset. 253238106Sdes * @param dnskey_idx: which key from the rrset to try. 254238106Sdes * @param reason: if bogus, a string returned, fixed or alloced in scratch. 255238106Sdes * @return secure if *this* key signs any of the signatures on rrset. 256238106Sdes * unchecked on error or and bogus on bad signature. 257238106Sdes */ 258238106Sdesenum sec_status dnskey_verify_rrset(struct module_env* env, 259238106Sdes struct val_env* ve, struct ub_packed_rrset_key* rrset, 260238106Sdes struct ub_packed_rrset_key* dnskey, size_t dnskey_idx, char** reason); 261238106Sdes 262238106Sdes/** 263238106Sdes * verify rrset, with dnskey rrset, for a specific rrsig in rrset 264238106Sdes * @param env: module environment, scratch space is used. 265238106Sdes * @param ve: validator environment, date settings. 266238106Sdes * @param now: current time for validation (can be overridden). 267238106Sdes * @param rrset: to be validated. 268238106Sdes * @param dnskey: DNSKEY rrset, keyset to try. 269238106Sdes * @param sig_idx: which signature to try to validate. 270238106Sdes * @param sortree: reused sorted order. Stored in region. Pass NULL at start, 271238106Sdes * and for a new rrset. 272238106Sdes * @param reason: if bogus, a string returned, fixed or alloced in scratch. 273238106Sdes * @return secure if any key signs *this* signature. bogus if no key signs it, 274238106Sdes * or unchecked on error. 275238106Sdes */ 276238106Sdesenum sec_status dnskeyset_verify_rrset_sig(struct module_env* env, 277238106Sdes struct val_env* ve, uint32_t now, struct ub_packed_rrset_key* rrset, 278238106Sdes struct ub_packed_rrset_key* dnskey, size_t sig_idx, 279238106Sdes struct rbtree_t** sortree, char** reason); 280238106Sdes 281238106Sdes/** 282238106Sdes * verify rrset, with specific dnskey(from set), for a specific rrsig 283238106Sdes * @param region: scratch region used for temporary allocation. 284238106Sdes * @param buf: scratch buffer used for canonicalized rrset data. 285238106Sdes * @param ve: validator environment, date settings. 286238106Sdes * @param now: current time for validation (can be overridden). 287238106Sdes * @param rrset: to be validated. 288238106Sdes * @param dnskey: DNSKEY rrset, keyset. 289238106Sdes * @param dnskey_idx: which key from the rrset to try. 290238106Sdes * @param sig_idx: which signature to try to validate. 291238106Sdes * @param sortree: pass NULL at start, the sorted rrset order is returned. 292238106Sdes * pass it again for the same rrset. 293238106Sdes * @param buf_canon: if true, the buffer is already canonical. 294238106Sdes * pass false at start. pass old value only for same rrset and same 295238106Sdes * signature (but perhaps different key) for reuse. 296238106Sdes * @param reason: if bogus, a string returned, fixed or alloced in scratch. 297238106Sdes * @return secure if this key signs this signature. unchecked on error or 298238106Sdes * bogus if it did not validate. 299238106Sdes */ 300238106Sdesenum sec_status dnskey_verify_rrset_sig(struct regional* region, 301238106Sdes ldns_buffer* buf, struct val_env* ve, uint32_t now, 302238106Sdes struct ub_packed_rrset_key* rrset, struct ub_packed_rrset_key* dnskey, 303238106Sdes size_t dnskey_idx, size_t sig_idx, 304238106Sdes struct rbtree_t** sortree, int* buf_canon, char** reason); 305238106Sdes 306238106Sdes/** 307238106Sdes * canonical compare for two tree entries 308238106Sdes */ 309238106Sdesint canonical_tree_compare(const void* k1, const void* k2); 310238106Sdes 311238106Sdes#endif /* VALIDATOR_VAL_SIGCRYPT_H */ 312