xref: /netbsd-src/external/mpl/bind/dist/lib/dns/dst_parse.h (revision bcda20f65a8566e103791ec395f7f499ef322704)
1 /*	$NetBSD: dst_parse.h,v 1.9 2025/01/26 16:25:22 christos Exp $	*/
2 
3 /*
4  * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
5  *
6  * SPDX-License-Identifier: MPL-2.0 AND ISC
7  *
8  * This Source Code Form is subject to the terms of the Mozilla Public
9  * License, v. 2.0. If a copy of the MPL was not distributed with this
10  * file, you can obtain one at https://mozilla.org/MPL/2.0/.
11  *
12  * See the COPYRIGHT file distributed with this work for additional
13  * information regarding copyright ownership.
14  */
15 
16 /*
17  * Copyright (C) Network Associates, Inc.
18  *
19  * Permission to use, copy, modify, and/or distribute this software for any
20  * purpose with or without fee is hereby granted, provided that the above
21  * copyright notice and this permission notice appear in all copies.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC AND NETWORK ASSOCIATES DISCLAIMS
24  * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
25  * WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE
26  * FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
27  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
28  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
29  * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30  */
31 
32 /*! \file */
33 #pragma once
34 
35 #include <isc/lang.h>
36 
37 #include <dst/dst.h>
38 
39 #define MAXFIELDSIZE 512
40 
41 /*
42  * Maximum number of fields in a private file is 18 (12 algorithm-
43  * specific fields for RSA, plus 6 generic fields).
44  */
45 #define MAXFIELDS 12 + 6
46 
47 #define TAG_SHIFT     4
48 #define TAG_ALG(tag)  ((unsigned int)(tag) >> TAG_SHIFT)
49 #define TAG(alg, off) (((alg) << TAG_SHIFT) + (off))
50 
51 /* These are used by RSA-SHA1, RSASHA256 and RSASHA512 */
52 #define RSA_NTAGS		11
53 #define TAG_RSA_MODULUS		((DST_ALG_RSA << TAG_SHIFT) + 0)
54 #define TAG_RSA_PUBLICEXPONENT	((DST_ALG_RSA << TAG_SHIFT) + 1)
55 #define TAG_RSA_PRIVATEEXPONENT ((DST_ALG_RSA << TAG_SHIFT) + 2)
56 #define TAG_RSA_PRIME1		((DST_ALG_RSA << TAG_SHIFT) + 3)
57 #define TAG_RSA_PRIME2		((DST_ALG_RSA << TAG_SHIFT) + 4)
58 #define TAG_RSA_EXPONENT1	((DST_ALG_RSA << TAG_SHIFT) + 5)
59 #define TAG_RSA_EXPONENT2	((DST_ALG_RSA << TAG_SHIFT) + 6)
60 #define TAG_RSA_COEFFICIENT	((DST_ALG_RSA << TAG_SHIFT) + 7)
61 #define TAG_RSA_ENGINE		((DST_ALG_RSA << TAG_SHIFT) + 8)
62 #define TAG_RSA_LABEL		((DST_ALG_RSA << TAG_SHIFT) + 9)
63 
64 #define ECDSA_NTAGS	     4
65 #define TAG_ECDSA_PRIVATEKEY ((DST_ALG_ECDSA256 << TAG_SHIFT) + 0)
66 #define TAG_ECDSA_ENGINE     ((DST_ALG_ECDSA256 << TAG_SHIFT) + 1)
67 #define TAG_ECDSA_LABEL	     ((DST_ALG_ECDSA256 << TAG_SHIFT) + 2)
68 
69 #define EDDSA_NTAGS	     4
70 #define TAG_EDDSA_PRIVATEKEY ((DST_ALG_ED25519 << TAG_SHIFT) + 0)
71 #define TAG_EDDSA_ENGINE     ((DST_ALG_ED25519 << TAG_SHIFT) + 1)
72 #define TAG_EDDSA_LABEL	     ((DST_ALG_ED25519 << TAG_SHIFT) + 2)
73 
74 #define OLD_HMACMD5_NTAGS 1
75 #define HMACMD5_NTAGS	  2
76 #define TAG_HMACMD5_KEY	  ((DST_ALG_HMACMD5 << TAG_SHIFT) + 0)
77 #define TAG_HMACMD5_BITS  ((DST_ALG_HMACMD5 << TAG_SHIFT) + 1)
78 
79 #define HMACSHA1_NTAGS	  2
80 #define TAG_HMACSHA1_KEY  ((DST_ALG_HMACSHA1 << TAG_SHIFT) + 0)
81 #define TAG_HMACSHA1_BITS ((DST_ALG_HMACSHA1 << TAG_SHIFT) + 1)
82 
83 #define HMACSHA224_NTAGS    2
84 #define TAG_HMACSHA224_KEY  ((DST_ALG_HMACSHA224 << TAG_SHIFT) + 0)
85 #define TAG_HMACSHA224_BITS ((DST_ALG_HMACSHA224 << TAG_SHIFT) + 1)
86 
87 #define HMACSHA256_NTAGS    2
88 #define TAG_HMACSHA256_KEY  ((DST_ALG_HMACSHA256 << TAG_SHIFT) + 0)
89 #define TAG_HMACSHA256_BITS ((DST_ALG_HMACSHA256 << TAG_SHIFT) + 1)
90 
91 #define HMACSHA384_NTAGS    2
92 #define TAG_HMACSHA384_KEY  ((DST_ALG_HMACSHA384 << TAG_SHIFT) + 0)
93 #define TAG_HMACSHA384_BITS ((DST_ALG_HMACSHA384 << TAG_SHIFT) + 1)
94 
95 #define HMACSHA512_NTAGS    2
96 #define TAG_HMACSHA512_KEY  ((DST_ALG_HMACSHA512 << TAG_SHIFT) + 0)
97 #define TAG_HMACSHA512_BITS ((DST_ALG_HMACSHA512 << TAG_SHIFT) + 1)
98 
99 struct dst_private_element {
100 	unsigned short tag;
101 	unsigned short length;
102 	unsigned char *data;
103 };
104 
105 typedef struct dst_private_element dst_private_element_t;
106 
107 struct dst_private {
108 	unsigned short nelements;
109 	dst_private_element_t elements[MAXFIELDS];
110 };
111 
112 typedef struct dst_private dst_private_t;
113 
114 ISC_LANG_BEGINDECLS
115 
116 void
117 dst__privstruct_free(dst_private_t *priv, isc_mem_t *mctx);
118 
119 isc_result_t
120 dst__privstruct_parse(dst_key_t *key, unsigned int alg, isc_lex_t *lex,
121 		      isc_mem_t *mctx, dst_private_t *priv);
122 
123 isc_result_t
124 dst__privstruct_writefile(const dst_key_t *key, const dst_private_t *priv,
125 			  const char *directory);
126 
127 ISC_LANG_ENDDECLS
128