val_secalgo.h revision 294190 
1/*
2 * validator/val_secalgo.h - validator security algorithm functions.
3 *
4 * Copyright (c) 2012, NLnet Labs. All rights reserved.
5 *
6 * This software is open source.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * Neither the name of the NLNET LABS nor the names of its contributors may
20 * be used to endorse or promote products derived from this software without
21 * specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
29 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
35
36/**
37 * \file
38 *
39 * This file contains helper functions for the validator module.
40 * The functions take buffers with raw data and convert to library calls.
41 */
42
43#ifndef VALIDATOR_VAL_SECALGO_H
44#define VALIDATOR_VAL_SECALGO_H
45struct sldns_buffer;
46
47/** Return size of nsec3 hash algorithm, 0 if not supported */
48size_t nsec3_hash_algo_size_supported(int id);
49
50/**
51 * Hash a single hash call of an NSEC3 hash algorithm.
52 * Iterations and salt are done by the caller.
53 * @param algo: nsec3 hash algorithm.
54 * @param buf: the buffer to digest
55 * @param len: length of buffer to digest.
56 * @param res: result stored here (must have sufficient space).
57 * @return false on failure.
58*/
59int secalgo_nsec3_hash(int algo, unsigned char* buf, size_t len,
60        unsigned char* res);
61
62/**
63 * Return size of DS digest according to its hash algorithm.
64 * @param algo: DS digest algo.
65 * @return size in bytes of digest, or 0 if not supported.
66 */
67size_t ds_digest_size_supported(int algo);
68
69/**
70 * @param algo: the DS digest algo
71 * @param buf: the buffer to digest
72 * @param len: length of buffer to digest.
73 * @param res: result stored here (must have sufficient space).
74 * @return false on failure.
75 */
76int secalgo_ds_digest(int algo, unsigned char* buf, size_t len,
77	unsigned char* res);
78
79/** return true if DNSKEY algorithm id is supported */
80int dnskey_algo_id_is_supported(int id);
81
82/**
83 * Check a canonical sig+rrset and signature against a dnskey
84 * @param buf: buffer with data to verify, the first rrsig part and the
85 *	canonicalized rrset.
86 * @param algo: DNSKEY algorithm.
87 * @param sigblock: signature rdata field from RRSIG
88 * @param sigblock_len: length of sigblock data.
89 * @param key: public key data from DNSKEY RR.
90 * @param keylen: length of keydata.
91 * @param reason: bogus reason in more detail.
92 * @return secure if verification succeeded, bogus on crypto failure,
93 *	unchecked on format errors and alloc failures.
94 */
95enum sec_status verify_canonrrset(struct sldns_buffer* buf, int algo,
96	unsigned char* sigblock, unsigned int sigblock_len,
97	unsigned char* key, unsigned int keylen, char** reason);
98
99#endif /* VALIDATOR_VAL_SECALGO_H */
100