5 * Command-line encryption tool
7 * (c) 2004 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Header files ------------------------------------------------------*/
39 #include <mLib/base64.h>
40 #include <mLib/dstr.h>
41 #include <mLib/mdwopt.h>
42 #include <mLib/quis.h>
43 #include <mLib/report.h>
56 /*----- Utilities ---------------------------------------------------------*/
58 /*----- Static variables --------------------------------------------------*/
60 static const char *keyring
= "keyring";
62 /*----- Data format -------------------------------------------------------*/
66 * The encrypted message is divided into chunks, each preceded by a two-octet
67 * length. The chunks don't need to be large -- the idea is that we can
68 * stream the chunks in and out.
70 * The first chunk is a header. It contains the decryption key-id, and maybe
71 * the verification key-id if the message is signed.
73 * Next comes the key-encapsulation chunk. This is decrypted in some
74 * KEM-specific way to yield a secret hash. The hash is expanded using an
75 * MGF (or similar) to make a symmetric encryption and MAC key.
77 * If the message is signed, there comes a signature chunk. The signature is
78 * on the further output of the MGF. This means that the recipient can
79 * modify the message and still have a valid signature, so it's not useful
80 * for proving things to other people; but it also means that the recipient
81 * knows that the message is from someone who knows the hash, which limits
82 * the possiblities to (a) whoever encrypted the message (good!) and (b)
83 * whoever knows the recipient's private key.
85 * Then come message chunks. Each one begins with a MAC over an implicit
86 * sequence number and the ciphertext. The final chunk's ciphertext is
87 * empty; no other chunk is empty. Thus can the correct end-of-file be
91 /*----- Chunk I/O ---------------------------------------------------------*/
93 static void chunk_write(enc
*e
, buf
*b
)
99 if (e
->ops
->write(e
, l
, 2) ||
100 e
->ops
->write(e
, BBASE(b
), BLEN(b
)))
101 die(EXIT_FAILURE
, "error writing output: %s", strerror(errno
));
104 static void chunk_read(enc
*e
, dstr
*d
, buf
*b
)
111 if (e
->ops
->read(e
, l
, 2) != 2)
115 if (e
->ops
->read(e
, d
->buf
, n
) != n
)
118 buf_init(b
, d
->buf
, d
->len
);
122 if (!errno
) die(EXIT_FAILURE
, "unexpected end-of-file on input");
123 else die(EXIT_FAILURE
, "error reading input: %s", strerror(errno
));
126 /*----- Encryption --------------------------------------------------------*/
128 static int encrypt(int argc
, char *argv
[])
130 const char *of
= 0, *kn
= "ccrypt", *skn
= 0;
133 const char *ef
= "binary";
158 static const struct option opt
[] = {
159 { "key", OPTF_ARGREQ
, 0, 'k' },
160 { "sign-key", OPTF_ARGREQ
, 0, 's' },
161 { "armour", 0, 0, 'a' },
162 { "armor", 0, 0, 'a' },
163 { "format", OPTF_ARGREQ
, 0, 'f' },
164 { "output", OPTF_ARGREQ
, 0, 'o' },
167 i
= mdwopt(argc
, argv
, "k:s:af:o:", opt
, 0, 0, 0);
170 case 'k': kn
= optarg
; break;
171 case 's': skn
= optarg
; break;
172 case 'a': ef
= "pem"; break;
173 case 'f': ef
= optarg
; break;
174 case 'o': of
= optarg
; break;
175 default: f
|= f_bogus
; break;
178 if (argc
- optind
> 1 || (f
& f_bogus
))
179 die(EXIT_FAILURE
, "Usage: encrypt [-OPTIONS] [FILE]");
181 if (key_open(&kf
, keyring
, KOPEN_READ
, key_moan
, 0))
182 die(EXIT_FAILURE
, "can't open keyring `%s'", keyring
);
183 if ((k
= key_bytag(&kf
, kn
)) == 0)
184 die(EXIT_FAILURE
, "key `%s' not found", kn
);
185 if (skn
&& (sk
= key_bytag(&kf
, skn
)) == 0)
186 die(EXIT_FAILURE
, "key `%s' not found", skn
);
188 if ((eo
= getenc(ef
)) == 0)
189 die(EXIT_FAILURE
, "encoding `%s' not found", ef
);
193 else if (strcmp(argv
[optind
], "-") == 0) {
196 } else if ((fp
= fopen(argv
[optind
], "rb")) == 0) {
197 die(EXIT_FAILURE
, "couldn't open file `%s': %s",
198 argv
[optind
], strerror(errno
));
202 if (!of
|| strcmp(of
, "-") == 0)
204 else if ((ofp
= fopen(of
, eo
->wmode
)) == 0) {
205 die(EXIT_FAILURE
, "couldn't open file `%s' for output: %s",
206 ofp
, strerror(errno
));
211 e
= initenc(eo
, ofp
, "CATCRYPT ENCRYPTED MESSAGE");
212 km
= getkem(k
, "cckem", 0);
213 if ((err
= km
->ops
->check(km
)) != 0)
214 moan("key %s fails check: %s", d
.buf
, err
);
218 s
= getsig(sk
, "ccsig", 1);
219 if ((err
= s
->ops
->check(s
)) != 0)
220 moan("key %s fails check: %s", d
.buf
, err
);
223 /* --- Build the header chunk --- */
226 dstr_ensure(&d
, 256);
227 buf_init(&b
, d
.buf
, 256);
228 buf_putu32(&b
, k
->id
);
229 if (sk
) buf_putu32(&b
, sk
->id
);
233 /* --- Build the KEM chunk --- */
236 if (setupkem(km
, &d
, &cx
, &c
, &m
))
237 die(EXIT_FAILURE
, "failed to encapsulate key");
238 buf_init(&b
, d
.buf
, d
.len
);
242 /* --- Write the signature chunk --- */
245 GC_ENCRYPT(cx
, 0, bb
, 1024);
246 GH_HASH(s
->h
, bb
, 1024);
248 if ((en
= s
->ops
->doit(s
, &d
)) != 0)
249 die(EXIT_FAILURE
, "error creating signature: %s", key_strerror(en
));
250 buf_init(&b
, d
.buf
, d
.len
);
255 /* --- Now do the main crypto --- */
257 assert(GC_CLASS(c
)->blksz
<= sizeof(bb
));
258 dstr_ensure(&d
, sizeof(bb
) + GM_CLASS(m
)->hashsz
);
264 if (GC_CLASS(c
)->blksz
) {
265 GC_ENCRYPT(cx
, 0, bb
, GC_CLASS(c
)->blksz
);
268 n
= fread(bb
, 1, sizeof(bb
), fp
);
270 buf_init(&b
, d
.buf
, d
.sz
);
271 tag
= buf_get(&b
, GM_CLASS(m
)->hashsz
);
273 assert(tag
); assert(ct
);
274 GC_ENCRYPT(c
, bb
, ct
, n
);
281 /* --- Final terminator packet --- */
283 buf_init(&b
, d
.buf
, d
.sz
);
284 tag
= buf_get(&b
, GM_CLASS(m
)->hashsz
);
290 /* --- All done --- */
299 if (fp
!= stdin
) fclose(fp
);
308 /*---- Decryption ---------------------------------------------------------*/
310 static int decrypt(int argc
, char *argv
[])
313 FILE *ofp
= 0, *rfp
= 0;
315 const char *ef
= "binary";
342 static const struct option opt
[] = {
343 { "armour", 0, 0, 'a' },
344 { "armor", 0, 0, 'a' },
345 { "buffer", 0, 0, 'b' },
346 { "verbose", 0, 0, 'v' },
347 { "quiet", 0, 0, 'q' },
348 { "format", OPTF_ARGREQ
, 0, 'f' },
349 { "output", OPTF_ARGREQ
, 0, 'o' },
352 i
= mdwopt(argc
, argv
, "abf:o:qv", opt
, 0, 0, 0);
355 case 'a': ef
= "pem"; break;
356 case 'b': f
|= f_buffer
; break;
357 case 'v': verb
++; break;
358 case 'q': if (verb
) verb
--; break;
359 case 'f': ef
= optarg
; break;
360 case 'o': of
= optarg
; break;
361 default: f
|= f_bogus
; break;
364 if (argc
- optind
> 1 || (f
& f_bogus
))
365 die(EXIT_FAILURE
, "Usage: decrypt [-OPTIONS] [FILE]");
367 if ((eo
= getenc(ef
)) == 0)
368 die(EXIT_FAILURE
, "encoding `%s' not found", ef
);
372 else if (strcmp(argv
[optind
], "-") == 0) {
375 } else if ((fp
= fopen(argv
[optind
], eo
->rmode
)) == 0) {
376 die(EXIT_FAILURE
, "couldn't open file `%s': %s",
377 argv
[optind
], strerror(errno
));
381 if (key_open(&kf
, keyring
, KOPEN_READ
, key_moan
, 0))
382 die(EXIT_FAILURE
, "can't open keyring `%s'", keyring
);
384 e
= initdec(eo
, fp
, checkbdry
, "CATCRYPT ENCRYPTED MESSAGE");
386 /* --- Read the header chunk --- */
388 chunk_read(e
, &d
, &b
);
389 if (buf_getu32(&b
, &id
)) {
390 if (verb
) printf("FAIL malformed header: missing keyid\n");
393 if ((k
= key_byid(&kf
, id
)) == 0) {
394 if (verb
) printf("FAIL key id %08lx not found\n", (unsigned long)id
);
398 if (buf_getu32(&b
, &id
)) {
399 if (verb
) printf("FAIL malformed header: missing signature keyid\n");
402 if ((sk
= key_byid(&kf
, id
)) == 0) {
403 if (verb
) printf("FAIL key id %08lx not found\n", (unsigned long)id
);
408 if (verb
) printf("FAIL malformed header: junk at end\n");
412 /* --- Find the key --- */
414 km
= getkem(k
, "cckem", 1);
416 /* --- Read the KEM chunk --- */
418 chunk_read(e
, &d
, &b
);
419 if (setupkem(km
, &d
, &cx
, &c
, &m
)) {
420 if (verb
) printf("FAIL failed to decapsulate key\n");
424 /* --- Verify the signature, if there is one --- */
427 s
= getsig(sk
, "ccsig", 0);
430 if (verb
&& (err
= s
->ops
->check(s
)) != 0)
431 printf("WARN verification key %s fails check: %s\n", d
.buf
, err
);
433 dstr_ensure(&d
, 1024);
434 GC_ENCRYPT(cx
, 0, d
.buf
, 1024);
435 GH_HASH(s
->h
, d
.buf
, 1024);
436 chunk_read(e
, &d
, &b
);
437 if (s
->ops
->doit(s
, &d
)) {
438 if (verb
) printf("FAIL signature verification failed\n");
444 printf("INFO good-signature %s\n", d
.buf
);
448 printf("INFO no-signature\n");
450 /* --- Now decrypt the main body --- */
452 if (!of
|| strcmp(of
, "-") == 0) {
456 if (!(f
& f_buffer
)) {
457 if ((ofp
= fopen(of
, "wb")) == 0) {
458 die(EXIT_FAILURE
, "couldn't open file `%s' for output: %s",
459 ofp
, strerror(errno
));
462 } else if ((rfp
= tmpfile()) == 0)
463 die(EXIT_FAILURE
, "couldn't create temporary file: %s", strerror(errno
));
466 dstr_ensure(&d
, GC_CLASS(c
)->blksz
);
469 if (GC_CLASS(c
)->blksz
) {
470 GC_ENCRYPT(cx
, 0, d
.buf
, GC_CLASS(c
)->blksz
);
476 chunk_read(e
, &d
, &b
);
477 if ((tag
= buf_get(&b
, GM_CLASS(m
)->hashsz
)) == 0) {
478 if (verb
) printf("FAIL bad ciphertext chunk: no tag\n");
481 GH_HASH(h
, BCUR(&b
), BLEFT(&b
));
482 if (memcmp(tag
, GH_DONE(h
, 0), GM_CLASS(m
)->hashsz
) != 0) {
484 printf("FAIL bad ciphertext chunk: authentication failure\n");
490 GC_DECRYPT(c
, BCUR(&b
), BCUR(&b
), BLEFT(&b
));
491 if (fwrite(BCUR(&b
), 1, BLEFT(&b
), rfp
) != BLEFT(&b
)) {
492 if (verb
) printf("FAIL error writing output: %s\n", strerror(errno
));
497 if (fflush(rfp
) || ferror(rfp
)) {
498 if (verb
) printf("FAIL error writing output: %s\n", strerror(errno
));
502 if (!ofp
&& (ofp
= fopen(of
, "wb")) == 0) {
503 die(EXIT_FAILURE
, "couldn't open file `%s' for output: %s",
504 of
, strerror(errno
));
508 dstr_ensure(&d
, 65536);
509 if (verb
&& ofp
== stdout
) printf("DATA\n");
511 n
= fread(d
.buf
, 1, d
.sz
, rfp
);
513 if (fwrite(d
.buf
, 1, n
, ofp
) < n
)
514 die(EXIT_FAILURE
, "error writing output: %s", strerror(errno
));
516 if (ferror(rfp
) || fclose(rfp
))
517 die(EXIT_FAILURE
, "error unbuffering output: %s", strerror(errno
));
519 if (ofp
&& (fflush(ofp
) || ferror(ofp
) || fclose(ofp
)))
520 die(EXIT_FAILURE
, "error writing output: %s", strerror(errno
));
523 if (verb
&& ofp
!= stdout
)
524 printf("OK decrypted successfully\n");
530 if (fp
!= stdin
) fclose(fp
);
540 /*----- Main code ---------------------------------------------------------*/
544 listtab[i].name, listtab[i].name) \
545 LI("Key-encapsulation mechanisms", kem, \
546 kemtab[i].name, kemtab[i].name) \
547 LI("Signature schemes", sig, \
548 sigtab[i].name, sigtab[i].name) \
549 LI("Encodings", enc, \
550 enctab[i].name, enctab[i].name) \
551 LI("Symmetric encryption algorithms", cipher, \
552 gciphertab[i], gciphertab[i]->name) \
553 LI("Hash functions", hash, \
554 ghashtab[i], ghashtab[i]->name) \
555 LI("Message authentication codes", mac, \
556 gmactab[i], gmactab[i]->name)
558 MAKELISTTAB(listtab
, LISTS
)
560 int cmd_show(int argc
, char *argv
[])
562 return (displaylists(listtab
, argv
+ 1));
565 static int cmd_help(int, char **);
567 static cmd cmdtab
[] = {
568 { "help", cmd_help
, "help [COMMAND...]" },
569 { "show", cmd_show
, "show [ITEM...]" },
572 { "encrypt", encrypt
,
573 "encrypt [-a] [-k TAG] [-s TAG] [-f FORMAT]\n\t\
574 [-o OUTPUT] [FILE]", "\
577 -a, --armour Same as `-f pem'.\n\
578 -f, --format=FORMAT Encode as FORMAT.\n\
579 -k, --key=TAG Use public encryption key named by TAG.\n\
580 -s, --sign-key=TAG Use private signature key named by TAG.\n\
581 -o, --output=FILE Write output to FILE.\n\
583 { "decrypt", decrypt
,
584 "decrypt [-abqv] [-f FORMAT] [-o OUTPUT] [FILE]", "\
587 -a, --armour Same as `-f pem'.\n\
588 -b, --buffer Buffer output until we're sure we have it all.\n\
589 -f, --format=FORMAT Decode as FORMAT.\n\
590 -o, --output=FILE Write output to FILE.\n\
591 -q, --quiet Produce fewer messages.\n\
592 -v, --verbose Produce more verbose messages.\n\
593 " }, /* ' emacs is confused */
597 static int cmd_help(int argc
, char **argv
)
599 sc_help(cmdtab
, stdout
, argv
+ 1);
603 void version(FILE *fp
)
605 pquis(fp
, "$, Catacomb version " VERSION
"\n");
608 static void usage(FILE *fp
)
610 pquis(fp
, "Usage: $ [-k KEYRING] COMMAND [ARGS]\n");
613 void help_global(FILE *fp
)
617 Encrypt and decrypt files.\n\
619 Global command-line options:\n\
621 -h, --help [COMMAND...] Show this help message, or help for COMMANDs.\n\
622 -v, --version Show program version number.\n\
623 -u, --usage Show a terse usage message.\n\
625 -k, --keyring=FILE Read keys from FILE.\n",
631 * Arguments: @int argc@ = number of command line arguments
632 * @char *argv[]@ = vector of command line arguments
634 * Returns: Zero if successful, nonzero otherwise.
636 * Use: Encrypts or decrypts files.
639 int main(int argc
, char *argv
[])
645 /* --- Initialize the library --- */
649 rand_noisesrc(RAND_GLOBAL
, &noise_source
);
650 rand_seed(RAND_GLOBAL
, 160);
652 /* --- Parse options --- */
655 static struct option opts
[] = {
656 { "help", 0, 0, 'h' },
657 { "version", 0, 0, 'v' },
658 { "usage", 0, 0, 'u' },
659 { "keyring", OPTF_ARGREQ
, 0, 'k' },
662 int i
= mdwopt(argc
, argv
, "+hvu k:", opts
, 0, 0, 0);
667 sc_help(cmdtab
, stdout
, argv
+ optind
);
689 if (f
& f_bogus
|| argc
< 1) {
694 /* --- Dispatch to the correct subcommand handler --- */
696 return (findcmd(cmdtab
, argv
[0])->cmd(argc
, argv
));
701 /*----- That's all, folks -------------------------------------------------*/