1 /*
2  * Copyright (c) 2009 NLNet Labs. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
19  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
21  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
22  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
23  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  */
26 
27 #ifndef SIGNER_NSEC3PARAMS_H
28 #define SIGNER_NSEC3PARAMS_H
29 
30 #include "config.h"
31 #include <ctype.h>
32 #include <stdint.h>
33 #ifdef HAVE_SYS_TYPES_H
34 # include <sys/types.h>
35 #endif
36 #ifdef HAVE_UNISTD_H
37 # include <unistd.h>
38 #endif
39 
40 #include <ldns/ldns.h>
41 
42 typedef struct nsec3params_struct nsec3params_type;
43 
44 #include "status.h"
45 #include "signconf.h"
46 
47 struct nsec3params_struct {
48     signconf_type* sc;
49     uint8_t        algorithm;
50     uint8_t        flags;
51     uint16_t       iterations;
52     uint8_t        salt_len;
53     uint8_t*       salt_data;
54     ldns_rr*       rr;
55 };
56 
57 /**
58  * Create NSEC3 salt.
59  * \param[in] salt_str the salt in string format
60  * \param[out] salt_len lenght of the salt data
61  * \param[out] salt salt in raw data format
62  * \return ods_status status
63  *
64  */
65 extern ods_status nsec3params_create_salt(const char* salt_str, uint8_t* salt_len,
66     uint8_t** salt);
67 
68 /**
69  * Create new NSEC3 parameters.
70  * \param[in] sc signer configuration reference
71  * \param[in] algo algorithm
72  * \param[in] flags flags, Opt-Out or Opt-In
73  * \param[in] iter number of iterations
74  * \param[in] salt salt
75  * \return nsec3params_type* the created nsec3params
76  *
77  */
78 extern nsec3params_type* nsec3params_create(void* sc, uint8_t algo, uint8_t flags,
79     uint16_t iter, const char* salt);
80 
81 /**
82  * Backup NSEC3 parameters.
83  * \param[in] fd file descriptor
84  * \param[in] algo algorithm
85  * \param[in] flags glags, Opt-Out or Opt-In
86  * \param[in] iter number of iterations
87  * \param[in] salt salt
88  * \param[in] rr NSEC3PARAM RR
89  * \param[in] version version string
90  *
91  */
92 void nsec3params_backup(FILE* fd, uint8_t algo, uint8_t flags,
93     uint16_t iter, const char* salt, ldns_rr* rr, const char* version);
94 
95 /**
96  * Clean up the NSEC3 parameters.
97  * \param[in] nsec3params the nsec3param to be deleted
98  *
99  */
100 extern void nsec3params_cleanup(nsec3params_type* nsec3params);
101 
102 #endif /* SIGNER_NSEC3PARAMS_H */
103