1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*
* Copyright (c) 2017, [Ribose Inc](https://www.ribose.com).
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef RNP_CFG_H_
#define RNP_CFG_H_
#include <stdbool.h>
#include <stdint.h>
#include <string>
#include <vector>
#include <unordered_map>
/* cfg variables known by rnp */
#define CFG_OVERWRITE "overwrite" /* overwrite output file if it is already exist or fail */
#define CFG_ARMOR "armor" /* armor output data or not */
#define CFG_ARMOR_DATA_TYPE "armor_type" /* armor data type, used with ``enarmor`` option */
#define CFG_COMMAND "command" /* command to execute over input data */
#define CFG_DETACHED "detached" /* produce the detached signature */
#define CFG_CLEARTEXT "cleartext" /* cleartext signing should be used */
#define CFG_SIGN_NEEDED "sign_needed" /* signing is needed during data protection */
#define CFG_OUTFILE "outfile" /* name/path of the output file */
#define CFG_NO_OUTPUT "no_output" /* do not output any data - just verify or process */
#define CFG_INFILE "infile" /* name/path of the input file */
#define CFG_SETFNAME "setfname" /* file name to embed into the literal data packet */
#define CFG_RESULTS "results" /* name/path for results, not used right now */
#define CFG_KEYSTOREFMT "keystorefmt" /* keyring format : GPG, G10, KBX */
#define CFG_COREDUMPS "coredumps" /* enable/disable core dumps. 1 or 0. */
#define CFG_NEEDSSECKEY "needsseckey" /* needs secret key for the ongoing operation */
#define CFG_USERID "userid" /* userid for the ongoing operation */
#define CFG_RECIPIENTS "recipients" /* list of encrypted data recipients */
#define CFG_SIGNERS "signers" /* list of signers */
#define CFG_HOMEDIR "homedir" /* home directory - folder with keyrings and so on */
#define CFG_KEYFILE "keyfile" /* path to the file with key(s), used instead of keyring */
#define CFG_PASSFD "pass-fd" /* password file descriptor */
#define CFG_PASSWD "password" /* password as command-line constant */
#define CFG_PASSWORDC "passwordc" /* number of passwords for symmetric encryption */
#define CFG_USERINPUTFD "user-input-fd" /* user input file descriptor */
#define CFG_NUMTRIES "numtries" /* number of password request tries, or 'unlimited' */
#define CFG_EXPIRATION "expiration" /* signature expiration time */
#define CFG_CREATION "creation" /* signature validity start */
#define CFG_CIPHER "cipher" /* symmetric encryption algorithm as string */
#define CFG_HASH "hash" /* hash algorithm used, string like 'SHA1'*/
#define CFG_WEAK_HASH "weak-hash" /* allow weak algorithms */
#define CFG_S2K_ITER "s2k-iter" /* number of S2K hash iterations to perform */
#define CFG_S2K_MSEC "s2k-msec" /* number of milliseconds S2K should target */
#define CFG_ENCRYPT_PK "encrypt_pk" /* public key should be used during encryption */
#define CFG_ENCRYPT_SK "encrypt_sk" /* password encryption should be used */
#define CFG_IO_RESS "ress" /* results stream */
#define CFG_NUMBITS "numbits" /* number of bits in generated key */
#define CFG_EXPERT "expert" /* expert key generation mode */
#define CFG_ZLEVEL "zlevel" /* compression level: 0..9 (0 for no compression) */
#define CFG_ZALG "zalg" /* compression algorithm: zip, zlib or bzip2 */
#define CFG_AEAD "aead" /* if nonzero then AEAD enryption mode, int */
#define CFG_AEAD_CHUNK "aead_chunk" /* AEAD chunk size bits, int from 0 to 56 */
#define CFG_KEYSTORE_DISABLED \
"disable_keystore" /* indicates whether keystore must be initialized */
#define CFG_FORCE "force" /* force command to succeed operation */
#define CFG_SECRET "secret" /* indicates operation on secret key */
#define CFG_WITH_SIGS "with-sigs" /* list keys with signatures */
#define CFG_JSON "json" /* list packets with JSON output */
#define CFG_GRIPS "grips" /* dump grips when dumping key packets */
#define CFG_MPIS "mpis" /* dump MPI values when dumping packets */
#define CFG_RAW "raw" /* dump raw packet contents */
#define CFG_REV_TYPE "rev-type" /* revocation reason code */
#define CFG_REV_REASON "rev-reason" /* revocation reason human-readable string */
#define CFG_PERMISSIVE "permissive" /* ignore bad packets during key import */
#define CFG_NOTTY "notty" /* disable tty usage and do input/output via stdin/stdout */
#define CFG_FIX_25519_BITS "fix-25519-bits" /* fix Cv25519 secret key via --edit-key */
#define CFG_CHK_25519_BITS "check-25519-bits" /* check Cv25519 secret key bits */
#define CFG_ADD_SUBKEY "add-subkey" /* add subkey to existing primary */
#define CFG_SET_KEY_EXPIRE "key-expire" /* set/update key expiration time */
#define CFG_SOURCE "source" /* source for the detached signature */
#define CFG_NOWRAP "no-wrap" /* do not wrap the output in a literal data packet */
#define CFG_CURTIME "curtime" /* date or timestamp to override the system's time */
#define CFG_ALLOW_HIDDEN "allow-hidden" /* allow hidden recipients */
/* rnp keyring setup variables */
#define CFG_KR_PUB_FORMAT "kr-pub-format"
#define CFG_KR_SEC_FORMAT "kr-sec-format"
#define CFG_KR_PUB_PATH "kr-pub-path"
#define CFG_KR_SEC_PATH "kr-sec-path"
#define CFG_KR_DEF_KEY "kr-def-key"
/* key generation variables */
#define CFG_KG_PRIMARY_ALG "kg-primary-alg"
#define CFG_KG_PRIMARY_BITS "kg-primary-bits"
#define CFG_KG_PRIMARY_CURVE "kg-primary-curve"
#define CFG_KG_PRIMARY_EXPIRATION "kg-primary-expiration"
#define CFG_KG_SUBKEY_ALG "kg-subkey-alg"
#define CFG_KG_SUBKEY_BITS "kg-subkey-bits"
#define CFG_KG_SUBKEY_CURVE "kg-subkey-curve"
#define CFG_KG_SUBKEY_EXPIRATION "kg-subkey-expiration"
#define CFG_KG_HASH "kg-hash"
#define CFG_KG_PROT_HASH "kg-prot-hash"
#define CFG_KG_PROT_ALG "kg-prot-alg"
#define CFG_KG_PROT_ITERATIONS "kg-prot-iterations"
/* rnp CLI config : contains all the system-dependent and specified by the user configuration
* options */
class rnp_cfg_val;
class rnp_cfg {
private:
std::unordered_map<std::string, rnp_cfg_val *> vals_;
std::string empty_str_;
/** @brief Parse date from the string in %Y-%m-%d format (using "-", "/", "." as a
* separator)
*
* @param s string with the date
* @param t UNIX timestamp of successfully parsed date
* @return true when parsed successfully or false otherwise
*/
bool parse_date(const std::string &s, uint64_t &t) const;
bool extract_timestamp(const std::string &st, uint64_t &t) const;
public:
/** @brief load default settings */
void load_defaults();
/** @brief set string value for the key in config */
void set_str(const std::string &key, const std::string &val);
void set_str(const std::string &key, const char *val);
/** @brief set int value for the key in config */
void set_int(const std::string &key, int val);
/** @brief set bool value for the key in config */
void set_bool(const std::string &key, bool val);
/** @brief remove key and corresponding value from the config */
void unset(const std::string &key);
/** @brief add string item to the list value */
void add_str(const std::string &key, const std::string &val);
/** @brief check whether config has value for the key */
bool has(const std::string &key) const;
/** @brief get string value from the config. If it is absent then empty string will be
* returned */
const std::string &get_str(const std::string &key) const;
/** @brief get C string value from the config. Will return 0 instead of empty string if
* value is absent. */
const char *get_cstr(const std::string &key) const;
/** @brief get int value from the config. If it is absent then def will be returned */
int get_int(const std::string &key, int def = 0) const;
/** @brief get bool value from the config. If it is absent then false will be returned */
bool get_bool(const std::string &key) const;
/** @brief get number of items in the string list value. If it is absent then 0 will be
* returned. */
size_t get_count(const std::string &key) const;
/** @brief get string from the list value at the corresponding position. If there is no
* corresponding value or index too large then empty string will be returned. */
const std::string &get_str(const std::string &key, size_t idx) const;
/** @brief get all strings from the list value */
std::vector<std::string> get_list(const std::string &key) const;
/** @brief get number of the password tries */
int get_pswdtries() const;
/** @brief get hash algorithm */
const std::string get_hashalg() const;
/** @brief Get expiration time from the cfg variable, as value relative to the current
* time. As per OpenPGP standard it should fit in 32 bit value, otherwise error is
* returned.
*
* Expiration may be specified in different formats:
* - 10d : 10 days (you can use [h]ours, d[ays], [w]eeks, [m]onthes)
* - 2017-07-12 : as the exact date
* - 60000 : number of seconds
*
* @param seconds On successful return result will be placed here
* @return true on success or false otherwise
*/
bool get_expiration(const std::string &key, uint32_t &seconds) const;
/** @brief Get signature creation time from the config.
* Creation time may be specified in different formats:
* - 2017-07-12 : as the exact date
* - 1499334073 : timestamp
*
* @return timestamp of the signature creation.
*/
uint64_t get_sig_creation() const;
/** @brief Get current time from the config.
*
* @return timestamp which should be considered as current time.
*/
uint64_t time() const;
/** @brief copy or override a configuration.
* @param src vals will be overridden (if key exist) or copied (if not) from this object
*/
void copy(const rnp_cfg &src);
void clear();
/* delete unneeded operators */
rnp_cfg &operator=(const rnp_cfg &src) = delete;
rnp_cfg &operator=(const rnp_cfg &&src) = delete;
/** @brief destructor */
~rnp_cfg();
};
#endif
|
