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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
//! A command-line frontend for Sequoia.
//!
//! # Usage
//!
//! ```text
//! Sequoia is an implementation of OpenPGP. This is a command-line frontend.
//!
//! USAGE:
//! sq [OPTIONS] [SUBCOMMAND]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -d, --domain <DOMAIN> Sets the domain to use
//! -p, --policy <NETWORK-POLICY> Sets the network policy to use
//! -s, --store <STORE> Sets the store to use (default: 'default')
//!
//! SUBCOMMANDS:
//! dearmor Removes ASCII Armor from a file
//! decrypt Decrypts an OpenPGP message
//! dump Lists OpenPGP packets
//! enarmor Applies ASCII Armor to a file
//! encrypt Encrypts a message
//! help Prints this message or the help of the given subcommand(s)
//! keyserver Interacts with keyservers
//! list Lists key stores and known keys
//! split Splits a message into OpenPGP packets
//! store Interacts with key stores
//! ```
//!
//! ## Subcommand dearmor
//!
//! ```text
//! Removes ASCII Armor from a file
//!
//! USAGE:
//! sq dearmor [OPTIONS]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -i, --input <FILE> Sets the input file to use
//! -o, --output <FILE> Sets the output file to use
//! ```
//!
//! ## Subcommand decrypt
//!
//! ```text
//! Decrypts an OpenPGP message
//!
//! USAGE:
//! sq decrypt [FLAGS] [OPTIONS]
//!
//! FLAGS:
//! --dump Print a packet dump to stderr
//! -h, --help Prints help information
//! -x, --hex Print a hexdump (implies --dump)
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -i, --input <FILE> Sets the input file to use
//! -o, --output <FILE> Sets the output file to use
//! ```
//!
//! ## Subcommand dump
//!
//! ```text
//! Lists OpenPGP packets
//!
//! USAGE:
//! sq dump [FLAGS] [OPTIONS]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -x, --hex Print a hexdump
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -i, --input <FILE> Sets the input file to use
//! -o, --output <FILE> Sets the output file to use
//! ```
//!
//! ## Subcommand enarmor
//!
//! ```text
//! Applies ASCII Armor to a file
//!
//! USAGE:
//! sq enarmor [OPTIONS]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -i, --input <FILE> Sets the input file to use
//! -o, --output <FILE> Sets the output file to use
//! ```
//!
//! ## Subcommand encrypt
//!
//! ```text
//! Encrypts a message
//!
//! USAGE:
//! sq encrypt [FLAGS] [OPTIONS]
//!
//! FLAGS:
//! -A, --armor Write armored data to file
//! -h, --help Prints help information
//! -s, --symmetric Encrypt with a password (can be given multiple times)
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -i, --input <FILE> Sets the input file to use
//! -o, --output <FILE> Sets the output file to use
//! -r, --recipient <LABEL>... Recipient to encrypt for (can be given multiple times)
//! ```
//!
//! ## Subcommand keyserver
//!
//! ```text
//! Interacts with keyservers
//!
//! USAGE:
//! sq keyserver [OPTIONS] [SUBCOMMAND]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -s, --server <URI> Sets the keyserver to use
//!
//! SUBCOMMANDS:
//! get Retrieves a key
//! help Prints this message or the help of the given subcommand(s)
//! send Sends a key
//! ```
//!
//! ### Subcommand keyserver get
//!
//! ```text
//! Retrieves a key
//!
//! USAGE:
//! sq keyserver get [FLAGS] [OPTIONS] <KEYID>
//!
//! FLAGS:
//! -A, --armor Write armored data to file
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -o, --output <FILE> Sets the output file to use
//!
//! ARGS:
//! <KEYID> ID of the key to retrieve
//! ```
//!
//! ### Subcommand keyserver send
//!
//! ```text
//! Sends a key
//!
//! USAGE:
//! sq keyserver send [OPTIONS]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -i, --input <FILE> Sets the input file to use
//! ```
//!
//! ## Subcommand list
//!
//! ```text
//! Lists key stores and known keys
//!
//! USAGE:
//! sq list [SUBCOMMAND]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! SUBCOMMANDS:
//! bindings Lists all bindings in all key stores
//! help Prints this message or the help of the given subcommand(s)
//! keys Lists all keys in the common key pool
//! log Lists the server log
//! stores Lists key stores
//! ```
//!
//! ### Subcommand list bindings
//!
//! ```text
//! Lists all bindings in all key stores
//!
//! USAGE:
//! sq list bindings [PREFIX]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! ARGS:
//! <PREFIX> List only bindings from stores with the given domain prefix
//! ```
//!
//! ### Subcommand list keys
//!
//! ```text
//! Lists all keys in the common key pool
//!
//! USAGE:
//! sq list keys
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//! ```
//!
//! ### Subcommand list log
//!
//! ```text
//! Lists the server log
//!
//! USAGE:
//! sq list log
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//! ```
//!
//! ### Subcommand list stores
//!
//! ```text
//! Lists key stores
//!
//! USAGE:
//! sq list stores [PREFIX]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! ARGS:
//! <PREFIX> List only stores with the given domain prefix
//! ```
//!
//! ## Subcommand split
//!
//! ```text
//! Splits a message into OpenPGP packets
//!
//! USAGE:
//! sq split [OPTIONS]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -i, --input <FILE> Sets the input file to use
//! -p, --prefix <FILE> Sets the prefix to use for output files (defaults to the input filename with a dash, or
//! 'output')
//! ```
//!
//! ## Subcommand store
//!
//! ```text
//! Interacts with key stores
//!
//! USAGE:
//! sq store [SUBCOMMAND]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! SUBCOMMANDS:
//! add Add a key identified by fingerprint
//! delete Deletes bindings or stores
//! export Exports a key
//! help Prints this message or the help of the given subcommand(s)
//! import Imports a key
//! list Lists keys in the store
//! log Lists the keystore log
//! stats Get stats for the given label
//! ```
//!
//! ### Subcommand store add
//!
//! ```text
//! Add a key identified by fingerprint
//!
//! USAGE:
//! sq store add <LABEL> <FINGERPRINT>
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! ARGS:
//! <LABEL> Label to use
//! <FINGERPRINT> Key to add
//! ```
//!
//! ### Subcommand store delete
//!
//! ```text
//! Deletes bindings or stores
//!
//! USAGE:
//! sq store delete [FLAGS] [LABEL]
//!
//! FLAGS:
//! -h, --help Prints help information
//! --the-store Delete the whole store
//! -V, --version Prints version information
//!
//! ARGS:
//! <LABEL> Delete binding with this label
//! ```
//!
//! ### Subcommand store export
//!
//! ```text
//! Exports a key
//!
//! USAGE:
//! sq store export [FLAGS] [OPTIONS] <LABEL>
//!
//! FLAGS:
//! -A, --armor Write armored data to file
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -o, --output <FILE> Sets the output file to use
//!
//! ARGS:
//! <LABEL> Label to use
//! ```
//!
//! ### Subcommand store import
//!
//! ```text
//! Imports a key
//!
//! USAGE:
//! sq store import [OPTIONS] <LABEL>
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -i, --input <FILE> Sets the input file to use
//!
//! ARGS:
//! <LABEL> Label to use
//! ```
//!
//! ### Subcommand store list
//!
//! ```text
//! Lists keys in the store
//!
//! USAGE:
//! sq store list
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//! ```
//!
//! ### Subcommand store log
//!
//! ```text
//! Lists the keystore log
//!
//! USAGE:
//! sq store log [LABEL]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! ARGS:
//! <LABEL> List messages related to this label
//! ```
//!
//! ### Subcommand store stats
//!
//! ```text
//! Get stats for the given label
//!
//! USAGE:
//! sq store stats <LABEL>
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! ARGS:
//! <LABEL> Label to use
//! ```
include!("sq.rs");
|