params.h revision 1.14 1 /* $NetBSD: params.h,v 1.14 2022/08/12 10:49:35 riastradh Exp $ */
2
3 /*-
4 * Copyright (c) 2002, 2003 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Roland C. Dowdeswell.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef PARAMS_H
33 #define PARAMS_H
34
35 #include "utils.h"
36
37 struct keygen {
38 int kg_method;
39 size_t kg_iterations;
40 size_t kg_memory; /* only used for Argon2 */
41 size_t kg_parallelism; /* only used for Argon2 */
42 size_t kg_version; /* only used for Argon2 */
43 bits_t *kg_salt;
44 bits_t *kg_key;
45 string_t *kg_cmd;
46 string_t *kg_sharedid;
47 int kg_sharedalg;
48 size_t kg_sharedlen;
49 bits_t *kg_sharedinfo;
50 struct keygen *next;
51 };
52
53 struct params {
54 string_t *algorithm;
55 string_t *ivmeth;
56 bits_t *key;
57 size_t keylen;
58 size_t bsize;
59 int verify_method;
60 struct keygen *dep_keygen;
61 struct keygen *keygen;
62 };
63
64 /* key generation methods */
65
66 #define KEYGEN_UNKNOWN 0x0
67 #define KEYGEN_RANDOMKEY 0x1
68 #define KEYGEN_PKCS5_PBKDF2_OLD 0x2
69 #define KEYGEN_STOREDKEY 0x3
70 #define KEYGEN_URANDOMKEY 0x4
71 #define KEYGEN_PKCS5_PBKDF2_SHA1 0x5
72 #define KEYGEN_SHELL_CMD 0x6
73 #define KEYGEN_ARGON2ID 0x7
74
75 /* verification methods */
76
77 #define VERIFY_UNKNOWN 0x0
78 #define VERIFY_NONE 0x1
79 #define VERIFY_DISKLABEL 0x2
80 #define VERIFY_FFS 0x3
81 #define VERIFY_REENTER 0x4
82 #define VERIFY_MBR 0x5
83 #define VERIFY_GPT 0x6
84
85 /* shared key derivation methods */
86
87 #define SHARED_ALG_UNKNOWN 0x0
88 #define SHARED_ALG_HKDF_HMAC_SHA256 0x1
89
90 __BEGIN_DECLS
91 struct params *params_new(void);
92 void params_free(struct params *);
93
94 int params_filldefaults(struct params *);
95 int params_verify(const struct params *);
96
97 struct params *params_combine(struct params *, struct params *);
98 struct params *params_algorithm(string_t *);
99 struct params *params_ivmeth(string_t *);
100 struct params *params_keylen(size_t);
101 struct params *params_bsize(size_t);
102 struct params *params_verify_method(string_t *);
103 struct params *params_keygen(struct keygen *);
104 struct params *params_dep_keygen(struct keygen *);
105
106 struct params *params_fget(FILE *);
107 struct params *params_cget(const char *);
108 int params_fput(struct params *, FILE *);
109 int params_cput(struct params *, const char *);
110
111 struct keygen *keygen_new(void);
112 void keygen_free(struct keygen *);
113
114 int keygen_filldefaults(struct keygen *, size_t);
115 void keygen_stripstored(struct keygen **);
116 int keygen_makeshared(struct keygen *);
117 int keygen_tweakshared(struct keygen *);
118 int keygen_verify(const struct keygen *);
119 void keygen_addlist(struct keygen **, struct keygen *);
120
121 struct keygen *keygen_combine(struct keygen *, struct keygen *);
122 struct keygen *keygen_generate(int);
123 struct keygen *keygen_method(string_t *);
124 struct keygen *keygen_set_method(struct keygen *, string_t *);
125 struct keygen *keygen_salt(bits_t *);
126 struct keygen *keygen_iterations(size_t);
127 struct keygen *keygen_memory(size_t);
128 struct keygen *keygen_parallelism(size_t);
129 struct keygen *keygen_version(size_t);
130 struct keygen *keygen_key(bits_t *);
131 struct keygen *keygen_cmd(string_t *);
132 struct keygen *keygen_shared(string_t *, string_t *, bits_t *);
133
134 int keygen_fput(struct keygen *, int, FILE *);
135 __END_DECLS
136
137 #endif
138