3 * Simple key manager program
5 * (c) 1999 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of Catacomb.
12 * Catacomb is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Library General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
17 * Catacomb is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
22 * You should have received a copy of the GNU Library General Public
23 * License along with Catacomb; if not, write to the Free
24 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
28 /*----- Header files ------------------------------------------------------*/
30 #define _FILE_OFFSET_BITS 64
41 #include <mLib/codec.h>
42 #include <mLib/base32.h>
43 #include <mLib/base64.h>
45 #include <mLib/macros.h>
46 #include <mLib/mdwopt.h>
47 #include <mLib/quis.h>
48 #include <mLib/report.h>
81 #include "sha256-mgf.h"
82 #include "sha224-mgf.h"
83 #include "sha384-mgf.h"
84 #include "sha512-mgf.h"
85 #include "tiger-mgf.h"
86 #include "rmd128-mgf.h"
87 #include "rmd160-mgf.h"
88 #include "rmd256-mgf.h"
89 #include "rmd320-mgf.h"
93 /*----- Handy global state ------------------------------------------------*/
95 static const char *keyfile
= "keyring";
97 /*----- Useful shared functions -------------------------------------------*/
101 * Arguments: @key_file *f@ = pointer to key file block
102 * @unsigned how@ = method to open file with
106 * Use: Opens a key file and handles errors by panicking
110 static void doopen(key_file
*f
, unsigned how
)
112 if (key_open(f
, keyfile
, how
, key_moan
, 0)){
113 die(EXIT_FAILURE
, "couldn't open keyring `%s': %s",
114 keyfile
, strerror(errno
));
118 /* --- @doclose@ --- *
120 * Arguments: @key_file *f@ = pointer to key file block
124 * Use: Closes a key file and handles errors by panicking
128 static void doclose(key_file
*f
)
130 switch (key_close(f
)) {
132 die(EXIT_FAILURE
, "couldn't write file `%s': %s",
133 keyfile
, strerror(errno
));
135 die(EXIT_FAILURE
, "keyring file `%s' broken: %s (repair manually)",
136 keyfile
, strerror(errno
));
140 /* --- @setattr@ --- *
142 * Arguments: @key_file *f@ = pointer to key file block
143 * @key *k@ = pointer to key block
144 * @char *v[]@ = array of assignments (overwritten!)
148 * Use: Applies the attribute assignments to the key.
151 static void setattr(key_file
*f
, key
*k
, char *v
[])
156 size_t eq
= strcspn(p
, "=");
158 moan("invalid assignment: `%s' (ignored)", p
);
164 if ((err
= key_putattr(f
, k
, *v
, *p ? p
: 0)) != 0)
165 die(EXIT_FAILURE
, "couldn't set attributes: %s", key_strerror(err
));
170 /*----- Seeding -----------------------------------------------------------*/
172 const struct seedalg
{ const char *p
; grand
*(*gen
)(const void *, size_t); }
174 { "dsarand", dsarand_create
},
175 { "rmd128-mgf", rmd128_mgfrand
},
176 { "rmd160-mgf", rmd160_mgfrand
},
177 { "rmd256-mgf", rmd256_mgfrand
},
178 { "rmd320-mgf", rmd320_mgfrand
},
179 { "sha-mgf", sha_mgfrand
},
180 { "sha224-mgf", sha224_mgfrand
},
181 { "sha256-mgf", sha256_mgfrand
},
182 { "sha384-mgf", sha384_mgfrand
},
183 { "sha512-mgf", sha512_mgfrand
},
184 { "tiger-mgf", tiger_mgfrand
},
188 #define SEEDALG_DEFAULT (seedtab + 2)
190 /*----- Key generation ----------------------------------------------------*/
192 /* --- Key generation parameters --- */
194 typedef struct keyopts
{
195 key_file
*kf
; /* Pointer to key file */
196 key
*k
; /* Pointer to the actual key */
197 dstr tag
; /* Full tag name for the key */
198 unsigned f
; /* Flags for the new key */
199 unsigned bits
, qbits
; /* Bit length for the new key */
200 const char *curve
; /* Elliptic curve name/info */
201 grand
*r
; /* Random number source */
202 mp
*e
; /* Public exponent */
203 key
*p
; /* Parameters key-data */
206 #define f_bogus 1u /* Error in parsing */
207 #define f_lock 2u /* Passphrase-lock private key */
208 #define f_quiet 4u /* Don't show a progress indicator */
209 #define f_limlee 8u /* Generate Lim-Lee primes */
210 #define f_subgroup 16u /* Generate a subgroup */
211 #define f_retag 32u /* Remove any existing tag */
212 #define f_kcdsa 64u /* Generate KCDSA primes */
214 /* --- @dolock@ --- *
216 * Arguments: @keyopts *k@ = key generation options
217 * @key_data **kd@ = pointer to key data to lock
218 * @const char *t@ = tag suffix or null
222 * Use: Does passphrase locking on new keys.
225 static void dolock(keyopts
*k
, key_data
**kd
, const char *t
)
227 if (!(k
->f
& f_lock
))
230 dstr_putf(&k
->tag
, ".%s", t
);
231 if (key_plock(kd
, 0, k
->tag
.buf
))
232 die(EXIT_FAILURE
, "couldn't lock key");
235 /* --- @copyparam@ --- *
237 * Arguments: @keyopts *k@ = pointer to key options
238 * @const char **pp@ = checklist of parameters, or null
240 * Returns: Nonzero if parameters copied; zero if you have to generate
243 * Use: Copies parameters from a source key to the current one.
246 static int copyparam(keyopts
*k
, const char **pp
)
257 /* --- Quick check if no parameters supplied --- */
262 /* --- Copy the key data if there's anything we want --- */
266 /* --- Run through the checklist --- */
268 key_fulltag(k
->p
, &t
);
269 if ((k
->p
->k
->e
& KF_ENCMASK
) != KENC_STRUCT
)
270 die(EXIT_FAILURE
, "parameter key `%s' is not structured", t
.buf
);
272 key_data
*kd
= key_structfind(k
->p
->k
, *pp
);
275 "bad parameter key `%s': parameter `%s' not found", t
.buf
, *pp
);
277 if (!KEY_MATCH(kd
, &kf
)) {
279 "bad parameter key `%s': subkey `%s' is not shared", t
.buf
, *pp
);
284 /* --- Copy over the parameters --- */
286 kd
= key_copydata(k
->p
->k
, &kf
);
288 key_setkeydata(k
->kf
, k
->k
, kd
);
292 /* --- Copy over attributes --- */
294 for (key_mkattriter(&i
, k
->p
); key_nextattr(&i
, &n
, &v
); )
295 key_putattr(k
->kf
, k
->k
, n
, v
);
305 * Arguments: @key_data *k@ = pointer to key data block
306 * @const char *tag@ = tag string to use
308 * Returns: Pointer to multiprecision integer key item.
310 * Use: Fetches an MP key component.
313 static mp
*getmp(key_data
*k
, const char *tag
)
315 k
= key_structfind(k
, tag
);
317 die(EXIT_FAILURE
, "unexpected failure looking up subkey `%s'", tag
);
318 if ((k
->e
& KF_ENCMASK
) != KENC_MP
)
319 die(EXIT_FAILURE
, "subkey `%s' has an incompatible type", tag
);
323 /* --- @keyrand@ --- *
325 * Arguments: @key_file *kf@ = pointer to key file
326 * @const char *id@ = pointer to key id (or null)
330 * Use: Keys the random number generator.
333 static void keyrand(key_file
*kf
, const char *id
)
337 /* --- Find the key --- */
340 if ((k
= key_bytag(kf
, id
)) == 0)
341 die(EXIT_FAILURE
, "key `%s' not found", id
);
343 k
= key_bytype(kf
, "catacomb-rand");
346 key_data
*kd
= k
->k
, *kkd
;
350 switch (kd
->e
& KF_ENCMASK
) {
356 if (key_punlock(&kkd
, kd
, d
.buf
))
357 die(EXIT_FAILURE
, "error unlocking key `%s'", d
.buf
);
365 die(EXIT_FAILURE
, "bad encoding type for key `%s'", d
.buf
);
369 /* --- Key the generator --- */
371 rand_key(RAND_GLOBAL
, kd
->u
.k
.k
, kd
->u
.k
.sz
);
376 /* --- Key generation algorithms --- */
378 static void alg_empty(keyopts
*k
)
381 key_setkeydata(k
->kf
, k
->k
,
382 key_newstring(KCAT_SHARE
, k
->curve ? k
->curve
: "."));
385 static void alg_binary(keyopts
*k
)
396 sz
= (k
->bits
+ 7) >> 3;
398 m
= (1 << (((k
->bits
- 1) & 7) + 1)) - 1;
399 k
->r
->ops
->fill(k
->r
, p
, sz
);
401 kd
= key_newbinary(KCAT_SYMM
| KF_BURN
, p
, sz
);
404 key_setkeydata(k
->kf
, k
->k
, kd
);
409 static void alg_des(keyopts
*k
)
419 if (k
->bits
% 56 || k
->bits
> 168)
420 die(EXIT_FAILURE
, "DES keys must be 56, 112 or 168 bits long");
424 k
->r
->ops
->fill(k
->r
, p
, sz
);
425 for (i
= 0; i
< sz
; i
++) {
426 octet x
= p
[i
] | 0x01;
430 p
[i
] = (p
[i
] & 0xfe) | (x
& 0x01);
432 kd
= key_newbinary(KCAT_SYMM
| KF_BURN
, p
, sz
);
435 key_setkeydata(k
->kf
, k
->k
, kd
);
440 static void alg_rsa(keyopts
*k
)
445 /* --- Sanity checking --- */
451 die(EXIT_FAILURE
, "RSA key too tiny");
453 k
->e
= mp_fromulong(MP_NEW
, 65537);
455 /* --- Generate the RSA parameters --- */
457 if (rsa_gen_e(&rp
, k
->bits
, k
->e
, k
->r
, 0,
458 (k
->f
& f_quiet
) ?
0 : pgen_ev
, 0))
459 die(EXIT_FAILURE
, "RSA key generation failed");
461 /* --- Run a test encryption --- */
464 grand
*g
= fibrand_create(k
->r
->ops
->word(k
->r
));
466 mp
*m
= mprand_range(MP_NEW
, rp
.n
, g
, 0);
471 c
= rsa_qpubop(&rpp
, MP_NEW
, m
);
472 c
= rsa_qprivop(&rp
, c
, c
, g
);
475 die(EXIT_FAILURE
, "test encryption failed");
481 /* --- Allrighty then --- */
483 kd
= key_newstruct();
484 key_structsteal(kd
, "n", key_newmp(KCAT_PUB
, rp
.n
));
485 key_structsteal(kd
, "e", key_newmp(KCAT_PUB
, rp
.e
));
487 kkd
= key_newstruct();
488 key_structsteal(kkd
, "d", key_newmp(KCAT_PRIV
| KF_BURN
, rp
.d
));
489 key_structsteal(kkd
, "p", key_newmp(KCAT_PRIV
| KF_BURN
, rp
.p
));
490 key_structsteal(kkd
, "q", key_newmp(KCAT_PRIV
| KF_BURN
, rp
.q
));
491 key_structsteal(kkd
, "q-inv", key_newmp(KCAT_PRIV
| KF_BURN
, rp
.q_inv
));
492 key_structsteal(kkd
, "d-mod-p", key_newmp(KCAT_PRIV
| KF_BURN
, rp
.dp
));
493 key_structsteal(kkd
, "d-mod-q", key_newmp(KCAT_PRIV
| KF_BURN
, rp
.dq
));
494 dolock(k
, &kkd
, "private");
495 key_structsteal(kd
, "private", kkd
);
496 key_setkeydata(k
->kf
, k
->k
, kd
);
501 static void alg_dsaparam(keyopts
*k
)
503 static const char *pl
[] = { "q", "p", "g", 0 };
504 if (!copyparam(k
, pl
)) {
513 /* --- Choose appropriate bit lengths if necessary --- */
520 /* --- Allocate a seed block --- */
522 sz
= (k
->qbits
+ 7) >> 3;
524 k
->r
->ops
->fill(k
->r
, p
, sz
);
526 /* --- Allocate the parameters --- */
528 if (dsa_gen(&dp
, k
->qbits
, k
->bits
, 0, p
, sz
, &ds
,
529 (k
->f
& f_quiet
) ?
0 : pgen_ev
, 0))
530 die(EXIT_FAILURE
, "DSA parameter generation failed");
532 /* --- Store the parameters --- */
534 kd
= key_newstruct();
535 key_structsteal(kd
, "q", key_newmp(KCAT_SHARE
, dp
.q
));
536 key_structsteal(kd
, "p", key_newmp(KCAT_SHARE
, dp
.p
));
537 key_structsteal(kd
, "g", key_newmp(KCAT_SHARE
, dp
.g
));
541 key_setkeydata(k
->kf
, k
->k
, kd
);
544 /* --- Store the seed for future verification --- */
546 c
= base64_class
.encoder(0, "", 0);
547 c
->ops
->code(c
, ds
.p
, ds
.sz
, &d
); c
->ops
->code(c
, 0, 0, &d
);
550 key_putattr(k
->kf
, k
->k
, "seed", d
.buf
);
552 dstr_putf(&d
, "%u", ds
.count
);
553 key_putattr(k
->kf
, k
->k
, "count", d
.buf
);
560 static void alg_dsa(keyopts
*k
)
567 /* --- Get the shared parameters --- */
570 key_split(&k
->k
->k
); kd
= k
->k
->k
;
575 /* --- Choose a private key --- */
577 x
= mprand_range(MP_NEWSEC
, q
, k
->r
, 0);
578 mpmont_create(&mm
, p
);
579 y
= mpmont_exp(&mm
, MP_NEW
, g
, x
);
581 /* --- Store everything away --- */
583 key_structsteal(kd
, "y", key_newmp(KCAT_PUB
, y
));
585 kkd
= key_newstruct();
586 key_structsteal(kkd
, "x", key_newmp(KCAT_PRIV
| KF_BURN
, x
));
587 dolock(k
, &kkd
, "private");
588 key_structsteal(kd
, "private", kkd
);
590 mp_drop(x
); mp_drop(y
);
593 static void alg_dhparam(keyopts
*k
)
595 static const char *pl
[] = { "p", "q", "g", 0 };
597 if (!copyparam(k
, pl
)) {
606 if (STRCMP(k
->curve
, ==, "list")) {
608 LIST("Built-in prime fields", stdout
, ptab
[i
].name
, ptab
[i
].name
);
612 if (dh_parse(&qd
, &dp
))
613 die(EXIT_FAILURE
, "error in field spec: %s", qd
.e
);
615 die(EXIT_FAILURE
, "junk at end of field spec");
616 if ((g
= group_prime(&dp
)) == 0)
617 die(EXIT_FAILURE
, "invalid prime field");
618 if (!(k
->f
& f_quiet
) && (e
= G_CHECK(g
, &rand_global
)) != 0)
619 moan("WARNING! group check failed: %s", e
);
627 /* --- Choose a large safe prime number --- */
629 if (k
->f
& f_limlee
) {
634 rc
= dh_limlee(&dp
, k
->qbits
, k
->bits
,
635 (k
->f
& f_subgroup
) ? DH_SUBGROUP
: 0,
636 0, k
->r
, (k
->f
& f_quiet
) ?
0 : pgen_ev
, 0,
637 (k
->f
& f_quiet
) ?
0 : pgen_evspin
, 0, &nf
, &f
);
641 for (i
= 0; i
< nf
; i
++) {
644 mp_writedstr(f
[i
], &d
, 10);
647 key_putattr(k
->kf
, k
->k
, "factors", d
.buf
);
650 } else if (k
->f
& f_kcdsa
) {
653 rc
= dh_kcdsagen(&dp
, k
->qbits
, k
->bits
, 0,
654 0, k
->r
, (k
->f
& f_quiet
) ?
0 : pgen_ev
, 0);
659 mp_writedstr(dp
.q
, &d
, 10);
660 mp_div(&v
, 0, dp
.p
, dp
.q
);
663 mp_writedstr(v
, &d
, 10);
665 key_putattr(k
->kf
, k
->k
, "factors", d
.buf
);
669 rc
= dh_gen(&dp
, k
->qbits
, k
->bits
, 0, k
->r
,
670 (k
->f
& f_quiet
) ?
0 : pgen_ev
, 0);
673 die(EXIT_FAILURE
, "Diffie-Hellman parameter generation failed");
676 kd
= key_newstruct();
677 key_structsteal(kd
, "p", key_newmp(KCAT_SHARE
, dp
.p
));
678 key_structsteal(kd
, "q", key_newmp(KCAT_SHARE
, dp
.q
));
679 key_structsteal(kd
, "g", key_newmp(KCAT_SHARE
, dp
.g
));
683 key_setkeydata(k
->kf
, k
->k
, kd
);
688 static void alg_dh(keyopts
*k
)
695 /* --- Get the shared parameters --- */
698 key_split(&k
->k
->k
); kd
= k
->k
->k
;
703 /* --- Choose a suitable private key --- *
705 * Since %$g$% has order %$q$%, choose %$x < q$%.
708 x
= mprand_range(MP_NEWSEC
, q
, k
->r
, 0);
710 /* --- Compute the public key %$y = g^x \bmod p$% --- */
712 mpmont_create(&mm
, p
);
713 y
= mpmont_exp(&mm
, MP_NEW
, g
, x
);
716 /* --- Store everything away --- */
718 key_structsteal(kd
, "y", key_newmp(KCAT_PUB
, y
));
720 kkd
= key_newstruct();
721 key_structsteal(kkd
, "x", key_newmp(KCAT_PRIV
| KF_BURN
, x
));
722 dolock(k
, &kkd
, "private");
723 key_structsteal(kd
, "private", kkd
);
725 mp_drop(x
); mp_drop(y
);
728 static void alg_bbs(keyopts
*k
)
733 /* --- Sanity checking --- */
739 /* --- Generate the BBS parameters --- */
741 if (bbs_gen(&bp
, k
->bits
, k
->r
, 0,
742 (k
->f
& f_quiet
) ?
0 : pgen_ev
, 0))
743 die(EXIT_FAILURE
, "Blum-Blum-Shub key generation failed");
745 /* --- Allrighty then --- */
747 kd
= key_newstruct();
748 key_structsteal(kd
, "n", key_newmp(KCAT_PUB
, bp
.n
));
750 kkd
= key_newstruct();
751 key_structsteal(kkd
, "p", key_newmp(KCAT_PRIV
| KF_BURN
, bp
.p
));
752 key_structsteal(kkd
, "q", key_newmp(KCAT_PRIV
| KF_BURN
, bp
.q
));
753 dolock(k
, &kkd
, "private");
754 key_structsteal(kd
, "private", kkd
);
755 key_setkeydata(k
->kf
, k
->k
, kd
);
761 static void alg_binparam(keyopts
*k
)
763 static const char *pl
[] = { "p", "q", "g", 0 };
764 if (!copyparam(k
, pl
)) {
771 /* --- Decide on a field --- */
773 if (!k
->bits
) k
->bits
= 128;
774 if (k
->curve
&& STRCMP(k
->curve
, ==, "list")) {
776 LIST("Built-in binary fields", stdout
,
777 bintab
[i
].name
, bintab
[i
].name
);
781 if (k
->bits
<= 40) k
->curve
= "p1363-40";
782 else if (k
->bits
<= 56) k
->curve
= "p1363-56";
783 else if (k
->bits
<= 64) k
->curve
= "p1363-64";
784 else if (k
->bits
<= 80) k
->curve
= "p1363-80";
785 else if (k
->bits
<= 112) k
->curve
= "p1363-112";
786 else if (k
->bits
<= 128) k
->curve
= "p1363-128";
789 "no built-in binary fields provide %u-bit security",
794 /* --- Check it --- */
798 if (dhbin_parse(&qd
, &gb
))
799 die(EXIT_FAILURE
, "error in field spec: %s", qd
.e
);
801 die(EXIT_FAILURE
, "junk at end of field spec");
802 if ((g
= group_binary(&gb
)) == 0)
803 die(EXIT_FAILURE
, "invalid binary field");
804 if (!(k
->f
& f_quiet
) && (e
= G_CHECK(g
, &rand_global
)) != 0)
805 moan("WARNING! group check failed: %s", e
);
808 /* --- Write out the answer --- */
810 kd
= key_newstruct();
811 key_structsteal(kd
, "p", key_newmp(KCAT_SHARE
, gb
.p
));
812 key_structsteal(kd
, "q", key_newmp(KCAT_SHARE
, gb
.q
));
813 key_structsteal(kd
, "g", key_newmp(KCAT_SHARE
, gb
.g
));
817 key_setkeydata(k
->kf
, k
->k
, kd
);
822 static void alg_bin(keyopts
*k
)
829 /* --- Get the shared parameters --- */
832 key_split(&k
->k
->k
); kd
= k
->k
->k
;
837 /* --- Choose a suitable private key --- *
839 * Since %$g$% has order %$q$%, choose %$x < q$%.
842 x
= mprand_range(MP_NEWSEC
, q
, k
->r
, 0);
844 /* --- Compute the public key %$y = g^x \bmod p$% --- */
846 gfreduce_create(&r
, p
);
847 y
= gfreduce_exp(&r
, MP_NEW
, g
, x
);
848 gfreduce_destroy(&r
);
850 /* --- Store everything away --- */
852 key_structsteal(kd
, "y", key_newmp(KCAT_PUB
, y
));
854 kkd
= key_newstruct();
855 key_structsteal(kkd
, "x", key_newmp(KCAT_PRIV
| KF_BURN
, x
));
856 dolock(k
, &kkd
, "private");
857 key_structsteal(kd
, "private", kkd
);
859 mp_drop(x
); mp_drop(y
);
862 static void alg_ecparam(keyopts
*k
)
864 static const char *pl
[] = { "curve", 0 };
865 if (!copyparam(k
, pl
)) {
870 /* --- Decide on a curve --- */
872 if (!k
->bits
) k
->bits
= 256;
873 if (k
->curve
&& STRCMP(k
->curve
, ==, "list")) {
875 LIST("Built-in elliptic curves", stdout
,
876 ectab
[i
].name
, ectab
[i
].name
);
880 if (k
->bits
<= 56) k
->curve
= "secp112r1";
881 else if (k
->bits
<= 64) k
->curve
= "secp128r1";
882 else if (k
->bits
<= 80) k
->curve
= "secp160r1";
883 else if (k
->bits
<= 96) k
->curve
= "secp192r1";
884 else if (k
->bits
<= 112) k
->curve
= "secp224r1";
885 else if (k
->bits
<= 128) k
->curve
= "secp256r1";
886 else if (k
->bits
<= 192) k
->curve
= "secp384r1";
887 else if (k
->bits
<= 256) k
->curve
= "secp521r1";
889 die(EXIT_FAILURE
, "no built-in curves provide %u-bit security",
893 /* --- Check it --- */
895 if ((e
= ec_getinfo(&ei
, k
->curve
)) != 0)
896 die(EXIT_FAILURE
, "error in curve spec: %s", e
);
897 if (!(k
->f
& f_quiet
) && (e
= ec_checkinfo(&ei
, k
->r
)) != 0)
898 moan("WARNING! curve check failed: %s", e
);
901 /* --- Write out the answer --- */
903 kd
= key_newstruct();
904 key_structsteal(kd
, "curve", key_newstring(KCAT_SHARE
, k
->curve
));
905 key_setkeydata(k
->kf
, k
->k
, kd
);
910 static void alg_ec(keyopts
*k
)
919 /* --- Get the curve --- */
922 key_split(&k
->k
->k
); kd
= k
->k
->k
;
923 if ((kkd
= key_structfind(kd
, "curve")) == 0)
924 die(EXIT_FAILURE
, "unexpected failure looking up subkey `curve')");
925 if ((kkd
->e
& KF_ENCMASK
) != KENC_STRING
)
926 die(EXIT_FAILURE
, "subkey `curve' is not a string");
927 if ((e
= ec_getinfo(&ei
, kkd
->u
.p
)) != 0)
928 die(EXIT_FAILURE
, "error in curve spec: %s", e
);
930 /* --- Invent a private exponent and compute the public key --- */
932 x
= mprand_range(MP_NEWSEC
, ei
.r
, k
->r
, 0);
933 ec_mul(ei
.c
, &p
, &ei
.g
, x
);
935 /* --- Store everything away --- */
937 key_structsteal(kd
, "p", key_newec(KCAT_PUB
, &p
));
939 kkd
= key_newstruct();
940 key_structsteal(kkd
, "x", key_newmp(KCAT_PRIV
| KF_BURN
, x
));
941 dolock(k
, &kkd
, "private");
942 key_structsteal(kd
, "private", kkd
);
951 _(x25519, X25519, "X25519") \
952 _(x448, X448, "X448")
954 #define XDHALG(xdh, XDH, name) \
956 static void alg_##xdh(keyopts *k) \
958 key_data *kd, *kkd; \
959 octet priv[XDH##_KEYSZ], pub[XDH##_PUBSZ]; \
962 k->r->ops->fill(k->r, priv, sizeof(priv)); \
963 xdh(pub, priv, xdh##_base); \
964 kkd = key_newstruct(); \
965 key_structsteal(kkd, "priv", \
966 key_newbinary(KCAT_PRIV | KF_BURN, \
967 priv, sizeof(priv))); \
968 kd = key_newstruct(); \
969 key_structsteal(kd, "private", kkd); \
970 key_structsteal(kd, "pub", \
971 key_newbinary(KCAT_PUB, pub, sizeof(pub))); \
973 key_setkeydata(k->kf, k->k, kd); \
980 _(ed25519, ED25519, "Ed25519") \
981 _(ed448, ED448, "Ed448")
983 #define EDDSAALG(ed, ED, name) \
985 static void alg_##ed(keyopts *k) \
987 key_data *kd, *kkd; \
988 octet priv[ED##_KEYSZ], pub[ED##_PUBSZ]; \
991 k->r->ops->fill(k->r, priv, sizeof(priv)); \
992 ed##_pubkey(pub, priv, sizeof(priv)); \
993 kkd = key_newstruct(); \
994 key_structsteal(kkd, "priv", \
995 key_newbinary(KCAT_PRIV | KF_BURN, \
996 priv, sizeof(priv))); \
997 kd = key_newstruct(); \
998 key_structsteal(kd, "private", kkd); \
999 key_structsteal(kd, "pub", \
1000 key_newbinary(KCAT_PUB, pub, sizeof(pub))); \
1002 key_setkeydata(k->kf, k->k, kd); \
1008 /* --- The algorithm tables --- */
1010 typedef struct keyalg
{
1012 void (*proc
)(keyopts
*o
);
1016 static keyalg algtab
[] = {
1017 { "binary", alg_binary
, "Plain binary data" },
1018 { "des", alg_des
, "Binary with DES-style parity" },
1019 { "rsa", alg_rsa
, "RSA public-key encryption" },
1020 { "bbs", alg_bbs
, "Blum-Blum-Shub generator" },
1021 { "dsa", alg_dsa
, "DSA digital signatures" },
1022 { "dsa-param", alg_dsaparam
, "DSA shared parameters" },
1023 { "dh", alg_dh
, "Diffie-Hellman key exchange" },
1024 { "dh-param", alg_dhparam
, "Diffie-Hellman parameters" },
1025 { "bindh", alg_bin
, "DH over a binary field" },
1026 { "bindh-param", alg_binparam
, "Binary-field DH parameters" },
1027 { "ec-param", alg_ecparam
, "Elliptic curve parameters" },
1028 { "ec", alg_ec
, "Elliptic curve crypto" },
1029 #define XDHTAB(xdh, XDH, name) \
1030 { #xdh, alg_##xdh, "" name " key exchange" },
1033 #define EDDSATAB(ed, ED, name) \
1034 { #ed, alg_##ed, "" name " digital signatures" },
1037 { "empty", alg_empty
, "Empty parametrs-only key" },
1041 /* --- @cmd_add@ --- */
1043 static int cmd_add(int argc
, char *argv
[])
1046 time_t exp
= KEXP_EXPIRE
;
1047 uint32 kid
= rand_global
.ops
->word(&rand_global
);
1048 const char *tag
= 0, *ptag
= 0;
1050 keyalg
*alg
= algtab
;
1051 const char *rtag
= 0;
1052 const struct seedalg
*sa
= SEEDALG_DEFAULT
;
1053 keyopts k
= { 0, 0, DSTR_INIT
, 0, 0, 0, 0, 0, 0 };
1054 const char *seed
= 0;
1057 /* --- Parse options for the subcommand --- */
1060 static struct option opt
[] = {
1061 { "algorithm", OPTF_ARGREQ
, 0, 'a' },
1062 { "bits", OPTF_ARGREQ
, 0, 'b' },
1063 { "qbits", OPTF_ARGREQ
, 0, 'B' },
1064 { "parameters", OPTF_ARGREQ
, 0, 'p' },
1065 { "expire", OPTF_ARGREQ
, 0, 'e' },
1066 { "comment", OPTF_ARGREQ
, 0, 'c' },
1067 { "tag", OPTF_ARGREQ
, 0, 't' },
1068 { "rand-id", OPTF_ARGREQ
, 0, 'R' },
1069 { "key-id", OPTF_ARGREQ
, 0, 'I' },
1070 { "curve", OPTF_ARGREQ
, 0, 'C' },
1071 { "seedalg", OPTF_ARGREQ
, 0, 'A' },
1072 { "seed", OPTF_ARGREQ
, 0, 's' },
1073 { "newseed", OPTF_ARGREQ
, 0, 'n' },
1074 { "public-exponent", OPTF_ARGREQ
, 0, 'E' },
1075 { "lock", 0, 0, 'l' },
1076 { "quiet", 0, 0, 'q' },
1077 { "lim-lee", 0, 0, 'L' },
1078 { "subgroup", 0, 0, 'S' },
1079 { "kcdsa", 0, 0, 'K' },
1082 int i
= mdwopt(argc
, argv
, "+a:b:B:p:e:c:t:R:I:C:A:s:n:E:lqrLKS",
1087 /* --- Handle the various options --- */
1091 /* --- Read an algorithm name --- */
1095 size_t sz
= strlen(optarg
);
1097 if (STRCMP(optarg
, ==, "list")) {
1098 for (a
= algtab
; a
->name
; a
++)
1099 printf("%-10s %s\n", a
->name
, a
->help
);
1104 for (a
= algtab
; a
->name
; a
++) {
1105 if (STRNCMP(optarg
, ==, a
->name
, sz
)) {
1106 if (a
->name
[sz
] == 0) {
1110 die(EXIT_FAILURE
, "ambiguous algorithm name `%s'", optarg
);
1116 die(EXIT_FAILURE
, "unknown algorithm name `%s'", optarg
);
1119 /* --- Bits must be nonzero and a multiple of 8 --- */
1123 k
.bits
= strtoul(optarg
, &p
, 0);
1124 if (k
.bits
== 0 || *p
!= 0)
1125 die(EXIT_FAILURE
, "bad bitlength `%s'", optarg
);
1130 k
.qbits
= strtoul(optarg
, &p
, 0);
1131 if (k
.qbits
== 0 || *p
!= 0)
1132 die(EXIT_FAILURE
, "bad bitlength `%s'", optarg
);
1135 /* --- Parameter selection --- */
1141 /* --- Expiry dates get passed to @get_date@ for parsing --- */
1144 if (STRCMP(optarg
, ==, "forever"))
1147 exp
= get_date(optarg
, 0);
1149 die(EXIT_FAILURE
, "bad expiry date `%s'", optarg
);
1153 /* --- Store comments without interpretation --- */
1156 if (key_chkcomment(optarg
))
1157 die(EXIT_FAILURE
, "bad comment string `%s'", optarg
);
1161 /* --- Elliptic curve parameters --- */
1167 /* --- Store tags --- */
1170 if (key_chkident(optarg
))
1171 die(EXIT_FAILURE
, "bad tag string `%s'", optarg
);
1178 /* --- Seeding --- */
1181 const struct seedalg
*ss
;
1182 if (STRCMP(optarg
, ==, "list")) {
1183 printf("Seed algorithms:\n");
1184 for (ss
= seedtab
; ss
->p
; ss
++)
1185 printf(" %s\n", ss
->p
);
1188 if (seed
) die(EXIT_FAILURE
, "seed already set -- put -A first");
1190 for (ss
= seedtab
; ss
->p
; ss
++) {
1191 if (STRCMP(optarg
, ==, ss
->p
))
1195 die(EXIT_FAILURE
, "seed algorithm `%s' not known", optarg
);
1202 if (seed
) die(EXIT_FAILURE
, "seed already set");
1203 c
= base64_class
.decoder(CDCF_IGNEQPAD
);
1204 if ((rc
= c
->ops
->code(c
, optarg
, strlen(optarg
), &d
)) != 0 ||
1205 (rc
= c
->ops
->code(c
, 0, 0, &d
)) != 0)
1206 die(EXIT_FAILURE
, "invalid seed base64: %s", codec_strerror(rc
));
1208 k
.r
= sa
->gen(d
.buf
, d
.len
);
1217 unsigned n
= strtoul(optarg
, &p
, 0);
1218 if (n
== 0 || *p
!= 0 || n
% 8 != 0)
1219 die(EXIT_FAILURE
, "bad seed length `%s'", optarg
);
1220 if (seed
) die(EXIT_FAILURE
, "seed already set");
1223 rand_get(RAND_GLOBAL
, p
, n
);
1224 c
= base64_class
.encoder(0, "", 0);
1225 c
->ops
->code(c
, p
, n
, &d
); c
->ops
->code(c
, 0, 0, &d
);
1228 k
.r
= sa
->gen(p
, n
);
1231 /* --- Key id --- */
1238 id
= strtoul(optarg
, &p
, 16);
1239 if (errno
|| *p
|| id
> MASK32
)
1240 die(EXIT_FAILURE
, "bad key-id `%s'", optarg
);
1244 /* --- Public exponent --- */
1248 k
.e
= mp_readstring(k
.e
, optarg
, &p
, 0);
1249 if (!k
.e
|| *p
|| MP_CMP(k
.e
, <, MP_THREE
) || MP_EVENP(k
.e
))
1250 die(EXIT_FAILURE
, "bad exponent `%s'", optarg
);
1253 /* --- Other flags --- */
1274 /* --- Other things are bogus --- */
1282 /* --- Various sorts of bogosity --- */
1284 if ((k
.f
& f_bogus
) || optind
+ 1 > argc
) {
1286 "Usage: add [OPTIONS] TYPE [ATTR...]");
1288 if (key_chkident(argv
[optind
]))
1289 die(EXIT_FAILURE
, "bad key type `%s'", argv
[optind
]);
1291 /* --- Set up various bits of the state --- */
1293 if (exp
== KEXP_EXPIRE
)
1294 exp
= time(0) + 14 * 24 * 60 * 60;
1296 /* --- Open the file and create the basic key block --- *
1298 * Keep on generating keyids until one of them doesn't collide.
1301 doopen(&f
, KOPEN_WRITE
);
1304 /* --- Key the generator --- */
1310 if ((err
= key_new(&f
, kid
, argv
[optind
], exp
, &k
.k
)) == 0)
1312 else if (err
!= KERR_DUPID
)
1313 die(EXIT_FAILURE
, "error adding new key: %s", key_strerror(err
));
1316 /* --- Set various simple attributes --- */
1321 if (k
.f
& f_retag
) {
1322 if ((kk
= key_bytag(&f
, tag
)) != 0 &&
1324 STRCMP(kk
->tag
, ==, tag
))
1325 key_settag(&f
, kk
, 0);
1327 if ((err
= key_settag(&f
, k
.k
, tag
)) != 0)
1328 die(EXIT_FAILURE
, "error setting key tag: %s", key_strerror(err
));
1332 int err
= key_setcomment(&f
, k
.k
, c
);
1334 die(EXIT_FAILURE
, "error setting key comment: %s", key_strerror(err
));
1337 setattr(&f
, k
.k
, argv
+ optind
+ 1);
1339 key_putattr(&f
, k
.k
, "genseed", seed
);
1340 key_putattr(&f
, k
.k
, "seedalg", sa
->p
);
1343 key_fulltag(k
.k
, &k
.tag
);
1345 /* --- Find the parameter key --- */
1347 if (ptag
&& (k
.p
= key_bytag(&f
, ptag
)) == 0)
1348 die(EXIT_FAILURE
, "parameter key `%s' not found", ptag
);
1350 /* --- Now generate the actual key data --- */
1356 dstr_destroy(&k
.tag
);
1361 /*----- Key listing -------------------------------------------------------*/
1363 /* --- Listing options --- */
1365 typedef struct listopts
{
1366 const char *tfmt
; /* Date format (@strftime@-style) */
1367 int v
; /* Verbosity level */
1368 unsigned f
; /* Various flags */
1369 time_t t
; /* Time now (for key expiry) */
1370 key_filter kf
; /* Filter for matching keys */
1373 /* --- Listing flags --- */
1375 #define f_newline 2u /* Write newline before next entry */
1376 #define f_attr 4u /* Written at least one attribute */
1377 #define f_utc 8u /* Emit UTC time, not local time */
1379 /* --- @showkeydata@ --- *
1381 * Arguments: @key_data *k@ = pointer to key to write
1382 * @int ind@ = indentation level
1383 * @listopts *o@ = listing options
1384 * @dstr *d@ = tag string for this subkey
1388 * Use: Emits a piece of key data in a human-readable format.
1391 static void showkeydata(key_data
*k
, int ind
, listopts
*o
, dstr
*d
)
1393 #define INDENT(i) do { \
1395 for (_i = 0; _i < (i); _i++) { \
1400 if ((k
->e
&KF_ENCMASK
) == KENC_ENCRYPT
&& o
->v
<= 4)
1401 { fputs(" encrypted\n", stdout
); return; }
1402 if ((k
->e
&KF_ENCMASK
) != KENC_STRUCT
&& !(k
->e
&KF_NONSECRET
) && o
->v
<= 3)
1403 { fputs(" secret\n", stdout
); return; }
1405 switch (k
->e
& KF_ENCMASK
) {
1407 /* --- Binary key data --- *
1409 * Emit as a simple hex dump.
1413 const octet
*p
= k
->u
.k
.k
;
1414 const octet
*l
= p
+ k
->u
.k
.sz
;
1417 fputs(" {", stdout
);
1422 } else if (sz
% 8 == 0)
1426 printf("%02x", *p
++);
1431 fputs("}\n", stdout
);
1434 /* --- Encrypted data --- *
1436 * If the user is sufficiently keen, ask for a passphrase and decrypt the
1437 * key. Otherwise just say that it's encrypted and move on.
1440 case KENC_ENCRYPT
: {
1442 if (key_punlock(&kd
, k
, d
->buf
))
1443 printf(" <failed to unlock %s>\n", d
->buf
);
1445 fputs(" encrypted", stdout
);
1446 showkeydata(kd
, ind
, o
, d
);
1451 /* --- Integer keys --- *
1453 * Emit as a large integer in decimal. This makes using the key in
1454 * `calc' or whatever easier.
1459 mp_writefile(k
->u
.m
, stdout
, 10);
1463 /* --- Strings --- */
1466 printf(" `%s'\n", k
->u
.p
);
1469 /* --- Elliptic curve points --- */
1472 if (EC_ATINF(&k
->u
.e
))
1473 fputs(" inf\n", stdout
);
1475 fputs(" 0x", stdout
); mp_writefile(k
->u
.e
.x
, stdout
, 16);
1476 fputs(", 0x", stdout
); mp_writefile(k
->u
.e
.y
, stdout
, 16);
1481 /* --- Structured keys --- *
1483 * Just iterate over the subkeys.
1491 fputs(" {\n", stdout
);
1492 for (key_mksubkeyiter(&i
, k
); key_nextsubkey(&i
, &tag
, &k
); ) {
1493 if (!key_match(k
, &o
->kf
))
1496 printf("%s =", tag
);
1498 dstr_putf(d
, ".%s", tag
);
1499 showkeydata(k
, ind
+ 2, o
, d
);
1502 fputs("}\n", stdout
);
1509 /* --- @showkey@ --- *
1511 * Arguments: @key *k@ = pointer to key to show
1512 * @listopts *o@ = pointer to listing options
1516 * Use: Emits a listing of a particular key.
1519 static void showkey(key
*k
, listopts
*o
)
1521 char ebuf
[24], dbuf
[24];
1524 /* --- Skip the key if the filter doesn't match --- */
1526 if (!key_match(k
->k
, &o
->kf
))
1529 /* --- Sort out the expiry and deletion times --- */
1531 if (KEY_EXPIRED(o
->t
, k
->exp
))
1532 strcpy(ebuf
, "expired");
1533 else if (k
->exp
== KEXP_FOREVER
)
1534 strcpy(ebuf
, "forever");
1536 tm
= (o
->f
& f_utc
) ?
gmtime(&k
->exp
) : localtime(&k
->exp
);
1537 strftime(ebuf
, sizeof(ebuf
), o
->tfmt
, tm
);
1540 if (KEY_EXPIRED(o
->t
, k
->del
))
1541 strcpy(dbuf
, "deleted");
1542 else if (k
->del
== KEXP_FOREVER
)
1543 strcpy(dbuf
, "forever");
1545 tm
= (o
->f
& f_utc
) ?
gmtime(&k
->del
) : localtime(&k
->del
);
1546 strftime(dbuf
, sizeof(dbuf
), o
->tfmt
, tm
);
1549 /* --- If in compact format, just display and quit --- */
1552 if (!(o
->f
& f_newline
)) {
1553 printf("%8s %-20s %-20s %-10s %s\n",
1554 "Id", "Tag", "Type", "Expire", "Delete");
1556 printf("%08lx %-20s %-20s %-10s %s\n",
1557 (unsigned long)k
->id
, k
->tag ? k
->tag
: "<none>",
1558 k
->type
, ebuf
, dbuf
);
1563 /* --- Display the standard header --- */
1565 if (o
->f
& f_newline
)
1566 fputc('\n', stdout
);
1567 printf("keyid: %08lx\n", (unsigned long)k
->id
);
1568 printf("tag: %s\n", k
->tag ? k
->tag
: "<none>");
1569 printf("type: %s\n", k
->type
);
1570 printf("expiry: %s\n", ebuf
);
1571 printf("delete: %s\n", dbuf
);
1572 printf("comment: %s\n", k
->c ? k
->c
: "<none>");
1574 /* --- Display the attributes --- */
1578 const char *av
, *an
;
1581 printf("attributes:");
1582 for (key_mkattriter(&i
, k
); key_nextattr(&i
, &an
, &av
); ) {
1583 printf("\n %s = %s", an
, av
);
1587 fputc('\n', stdout
);
1592 /* --- If dumping requested, dump the raw key data --- */
1596 fputs("key:", stdout
);
1598 showkeydata(k
->k
, 0, o
, &d
);
1605 /* --- @cmd_list@ --- */
1607 static int cmd_list(int argc
, char *argv
[])
1611 listopts o
= { 0, 0, 0, 0, { 0, 0 } };
1613 /* --- Parse subcommand options --- */
1616 static struct option opt
[] = {
1617 { "quiet", 0, 0, 'q' },
1618 { "verbose", 0, 0, 'v' },
1619 { "utc", 0, 0, 'u' },
1620 { "filter", OPTF_ARGREQ
, 0, 'f' },
1623 int i
= mdwopt(argc
, argv
, "+uqvf:", opt
, 0, 0, 0);
1640 int e
= key_readflags(optarg
, &p
, &o
.kf
.f
, &o
.kf
.m
);
1642 die(EXIT_FAILURE
, "bad filter string `%s'", optarg
);
1651 die(EXIT_FAILURE
, "Usage: list [-uqv] [-f FILTER] [TAG...]");
1653 /* --- Open the key file --- */
1655 doopen(&f
, KOPEN_READ
);
1658 /* --- Set up the time format --- */
1661 o
.tfmt
= "%Y-%m-%d";
1662 else if (o
.f
& f_utc
)
1663 o
.tfmt
= "%Y-%m-%d %H:%M:%S UTC";
1665 o
.tfmt
= "%Y-%m-%d %H:%M:%S %Z";
1667 /* --- If specific keys were requested use them, otherwise do all --- *
1669 * Some day, this might turn into a wildcard match.
1672 if (optind
< argc
) {
1674 if ((k
= key_bytag(&f
, argv
[optind
])) != 0)
1677 moan("key `%s' not found", argv
[optind
]);
1681 } while (optind
< argc
);
1684 for (key_mkiter(&i
, &f
); (k
= key_next(&i
)) != 0; )
1692 return (EXIT_FAILURE
);
1697 /*----- Command implementation --------------------------------------------*/
1699 /* --- @cmd_expire@ --- */
1701 static int cmd_expire(int argc
, char *argv
[])
1709 die(EXIT_FAILURE
, "Usage: expire TAG...");
1710 doopen(&f
, KOPEN_WRITE
);
1711 for (i
= 1; i
< argc
; i
++) {
1712 if ((k
= key_bytag(&f
, argv
[i
])) != 0)
1715 moan("key `%s' not found", argv
[i
]);
1723 /* --- @cmd_delete@ --- */
1725 static int cmd_delete(int argc
, char *argv
[])
1733 die(EXIT_FAILURE
, "Usage: delete TAG...");
1734 doopen(&f
, KOPEN_WRITE
);
1735 for (i
= 1; i
< argc
; i
++) {
1736 if ((k
= key_bytag(&f
, argv
[i
])) != 0)
1739 moan("key `%s' not found", argv
[i
]);
1747 /* --- @cmd_setattr@ --- */
1749 static int cmd_setattr(int argc
, char *argv
[])
1755 die(EXIT_FAILURE
, "Usage: setattr TAG ATTR...");
1756 doopen(&f
, KOPEN_WRITE
);
1757 if ((k
= key_bytag(&f
, argv
[1])) == 0)
1758 die(EXIT_FAILURE
, "key `%s' not found", argv
[1]);
1759 setattr(&f
, k
, argv
+ 2);
1764 /* --- @cmd_getattr@ --- */
1766 static int cmd_getattr(int argc
, char *argv
[])
1774 die(EXIT_FAILURE
, "Usage: getattr TAG ATTR");
1775 doopen(&f
, KOPEN_READ
);
1776 if ((k
= key_bytag(&f
, argv
[1])) == 0)
1777 die(EXIT_FAILURE
, "key `%s' not found", argv
[1]);
1779 if ((p
= key_getattr(&f
, k
, argv
[2])) == 0)
1780 die(EXIT_FAILURE
, "no attribute `%s' for key `%s'", argv
[2], d
.buf
);
1787 /* --- @cmd_finger@ --- */
1789 static const struct fpres
{
1791 const codec_class
*cdc
;
1792 unsigned short ival
;
1795 { "hex", &hex_class
, 8, "-:" },
1796 { "base32", &base32_class
, 6, ":" },
1800 static void fingerprint(key
*k
, const struct fpres
*fpres
,
1801 const gchash
*ch
, const key_filter
*kf
)
1804 dstr d
= DSTR_INIT
, dd
= DSTR_INIT
;
1810 if (key_fingerprint(k
, h
, kf
)) {
1812 c
= fpres
->cdc
->encoder(CDCF_LOWERC
| CDCF_NOEQPAD
, "", 0);
1813 c
->ops
->code(c
, p
, ch
->hashsz
, &dd
); c
->ops
->code(c
, 0, 0, &dd
);
1815 for (i
= 0; i
< dd
.len
; i
++) {
1816 if (i
&& i
%fpres
->ival
== 0) dstr_putc(&d
, fpres
->sep
[0]);
1817 dstr_putc(&d
, dd
.buf
[i
]);
1819 dstr_putc(&d
, ' '); key_fulltag(k
, &d
); dstr_putc(&d
, '\n');
1820 dstr_write(&d
, stdout
);
1822 dstr_destroy(&d
); dstr_destroy(&dd
);
1826 static const struct fpres
*lookup_fpres(const char *name
)
1828 const struct fpres
*fpres
;
1829 for (fpres
= fprestab
; fpres
->name
; fpres
++)
1830 if (STRCMP(fpres
->name
, ==, name
)) return (fpres
);
1831 die(EXIT_FAILURE
, "unknown presentation syle `%s'", name
);
1834 static int cmd_finger(int argc
, char *argv
[])
1838 const struct fpres
*fpres
= fprestab
;
1839 const gchash
*ch
= &rmd160
;
1840 key_filter kf
= { KF_NONSECRET
, KF_NONSECRET
};
1843 static struct option opt
[] = {
1844 { "filter", OPTF_ARGREQ
, 0, 'f' },
1845 { "presentation", OPTF_ARGREQ
, 0, 'p' },
1846 { "algorithm", OPTF_ARGREQ
, 0, 'a' },
1849 int i
= mdwopt(argc
, argv
, "+f:a:p:", opt
, 0, 0, 0);
1855 int err
= key_readflags(optarg
, &p
, &kf
.f
, &kf
.m
);
1857 die(EXIT_FAILURE
, "bad filter string `%s'", optarg
);
1860 fpres
= lookup_fpres(optarg
);
1863 if ((ch
= ghash_byname(optarg
)) == 0)
1864 die(EXIT_FAILURE
, "unknown hash algorithm `%s'", optarg
);
1872 argv
+= optind
; argc
-= optind
;
1875 "Usage: fingerprint [-a HASH] [-p STYLE] [-f FILTER] [TAG...]");
1878 doopen(&f
, KOPEN_READ
);
1882 for (i
= 0; i
< argc
; i
++) {
1883 key
*k
= key_bytag(&f
, argv
[i
]);
1885 fingerprint(k
, fpres
, ch
, &kf
);
1888 moan("key `%s' not found", argv
[i
]);
1894 for (key_mkiter(&i
, &f
); (k
= key_next(&i
)) != 0; )
1895 fingerprint(k
, fpres
, ch
, &kf
);
1900 /* --- @cmd_verify@ --- */
1902 static int cmd_verify(int argc
, char *argv
[])
1906 const gchash
*ch
= &rmd160
;
1910 dstr d
= DSTR_INIT
, dd
= DSTR_INIT
;
1913 const struct fpres
*fpres
= fprestab
;
1914 key_filter kf
= { KF_NONSECRET
, KF_NONSECRET
};
1917 static struct option opt
[] = {
1918 { "filter", OPTF_ARGREQ
, 0, 'f' },
1919 { "presentation", OPTF_ARGREQ
, 0, 'p' },
1920 { "algorithm", OPTF_ARGREQ
, 0, 'a' },
1923 int i
= mdwopt(argc
, argv
, "+f:a:p:", opt
, 0, 0, 0);
1929 int err
= key_readflags(optarg
, &p
, &kf
.f
, &kf
.m
);
1931 die(EXIT_FAILURE
, "bad filter string `%s'", optarg
);
1934 fpres
= lookup_fpres(optarg
);
1937 if ((ch
= ghash_byname(optarg
)) == 0)
1938 die(EXIT_FAILURE
, "unknown hash algorithm `%s'", optarg
);
1946 argv
+= optind
; argc
-= optind
;
1947 if (rc
|| argc
!= 2) {
1949 "Usage: verify [-a HASH] [-p STYLE] [-f FILTER] TAG FINGERPRINT");
1952 doopen(&f
, KOPEN_READ
);
1954 if ((k
= key_bytag(&f
, argv
[0])) == 0)
1955 die(EXIT_FAILURE
, "key `%s' not found", argv
[0]);
1956 for (p
= argv
[1]; *p
; p
++) {
1957 if (strchr(fpres
->sep
, *p
)) continue;
1960 c
= fpres
->cdc
->decoder(CDCF_IGNCASE
| CDCF_IGNEQPAD
|
1961 CDCF_IGNSPC
| CDCF_IGNNEWL
);
1962 if ((rc
= c
->ops
->code(c
, dd
.buf
, dd
.len
, &d
)) != 0 ||
1963 (rc
= c
->ops
->code(c
, 0, 0, &d
)) != 0)
1964 die(EXIT_FAILURE
, "invalid fingerprint: %s", codec_strerror(rc
));
1966 if (d
.len
!= ch
->hashsz
) {
1967 die(EXIT_FAILURE
, "incorrect fingerprint length (%lu != %lu)",
1968 (unsigned long)d
.len
, (unsigned long)ch
->hashsz
);
1971 if (!key_fingerprint(k
, h
, &kf
))
1972 die(EXIT_FAILURE
, "key has no fingerprintable components (as filtered)");
1973 fpr
= GH_DONE(h
, 0);
1974 if (MEMCMP(fpr
, !=, d
.buf
, ch
->hashsz
))
1975 die(EXIT_FAILURE
, "key fingerprint mismatch");
1976 dstr_destroy(&d
); dstr_destroy(&dd
);
1981 /* --- @cmd_comment@ --- */
1983 static int cmd_comment(int argc
, char *argv
[])
1989 if (argc
< 2 || argc
> 3)
1990 die(EXIT_FAILURE
, "Usage: comment TAG [COMMENT]");
1991 doopen(&f
, KOPEN_WRITE
);
1992 if ((k
= key_bytag(&f
, argv
[1])) == 0)
1993 die(EXIT_FAILURE
, "key `%s' not found", argv
[1]);
1994 if ((err
= key_setcomment(&f
, k
, argv
[2])) != 0)
1995 die(EXIT_FAILURE
, "bad comment `%s': %s", argv
[2], key_strerror(err
));
2000 /* --- @cmd_tag@ --- */
2002 static int cmd_tag(int argc
, char *argv
[])
2011 static struct option opt
[] = {
2012 { "retag", 0, 0, 'r' },
2015 int i
= mdwopt(argc
, argv
, "+r", opt
, 0, 0, 0);
2028 argv
+= optind
; argc
-= optind
;
2029 if (argc
< 1 || argc
> 2 || rc
)
2030 die(EXIT_FAILURE
, "Usage: tag [-r] TAG [NEW-TAG]");
2031 doopen(&f
, KOPEN_WRITE
);
2032 if (flags
& f_retag
) {
2033 if ((k
= key_bytag(&f
, argv
[1])) != 0 && STRCMP(k
->tag
, ==, argv
[1]))
2034 key_settag(&f
, k
, 0);
2036 if ((k
= key_bytag(&f
, argv
[0])) == 0)
2037 die(EXIT_FAILURE
, "key `%s' not found", argv
[0]);
2038 if ((err
= key_settag(&f
, k
, argv
[1])) != 0)
2039 die(EXIT_FAILURE
, "bad tag `%s': %s", argv
[1], key_strerror(err
));
2044 /* --- @cmd_lock@ --- */
2046 static int cmd_lock(int argc
, char *argv
[])
2054 die(EXIT_FAILURE
, "Usage: lock QTAG");
2055 doopen(&f
, KOPEN_WRITE
);
2056 if (key_qtag(&f
, argv
[1], &d
, &k
, &kd
))
2057 die(EXIT_FAILURE
, "key `%s' not found", argv
[1]);
2058 if ((*kd
)->e
== KENC_ENCRYPT
&& key_punlock(kd
, 0, d
.buf
))
2059 die(EXIT_FAILURE
, "couldn't unlock key `%s'", d
.buf
);
2060 if (key_plock(kd
, 0, d
.buf
))
2061 die(EXIT_FAILURE
, "failed to lock key `%s'", d
.buf
);
2067 /* --- @cmd_unlock@ --- */
2069 static int cmd_unlock(int argc
, char *argv
[])
2077 die(EXIT_FAILURE
, "Usage: unlock QTAG");
2078 doopen(&f
, KOPEN_WRITE
);
2079 if (key_qtag(&f
, argv
[1], &d
, &k
, &kd
))
2080 die(EXIT_FAILURE
, "key `%s' not found", argv
[1]);
2081 if ((*kd
)->e
!= KENC_ENCRYPT
)
2082 die(EXIT_FAILURE
, "key `%s' is not encrypted", d
.buf
);
2083 if (key_punlock(kd
, 0, d
.buf
))
2084 die(EXIT_FAILURE
, "couldn't unlock key `%s'", d
.buf
);
2090 /* --- @cmd_extract@ --- */
2092 static int cmd_extract(int argc
, char *argv
[])
2098 key_filter kf
= { 0, 0 };
2100 const char *outfile
= 0;
2104 static struct option opt
[] = {
2105 { "filter", OPTF_ARGREQ
, 0, 'f' },
2108 int i
= mdwopt(argc
, argv
, "f:", opt
, 0, 0, 0);
2114 int err
= key_readflags(optarg
, &p
, &kf
.f
, &kf
.m
);
2116 die(EXIT_FAILURE
, "bad filter string `%s'", optarg
);
2124 argv
+= optind
; argc
-= optind
;
2126 die(EXIT_FAILURE
, "Usage: extract [-f FILTER] FILE [TAG...]");
2127 if (STRCMP(*argv
, ==, "-"))
2131 dstr_putf(&d
, "%s.new", outfile
);
2132 if (!(fp
= fopen(d
.buf
, "w"))) {
2133 die(EXIT_FAILURE
, "couldn't open `%s' for writing: %s",
2134 d
.buf
, strerror(errno
));
2138 doopen(&f
, KOPEN_READ
);
2142 for (key_mkiter(&i
, &f
); (k
= key_next(&i
)) != 0; )
2143 key_extract(&f
, k
, fp
, &kf
);
2145 for (i
= 1; i
< argc
; i
++) {
2146 if ((k
= key_bytag(&f
, argv
[i
])) != 0)
2147 key_extract(&f
, k
, fp
, &kf
);
2149 moan("key `%s' not found", argv
[i
]);
2154 if (fclose(fp
) || (outfile
&& rename(d
.buf
, outfile
)))
2155 die(EXIT_FAILURE
, "error writing file: %s", strerror(errno
));
2161 /* --- @cmd_tidy@ --- */
2163 static int cmd_tidy(int argc
, char *argv
[])
2167 die(EXIT_FAILURE
, "Usage: tidy");
2168 doopen(&f
, KOPEN_WRITE
);
2169 f
.f
|= KF_MODIFIED
; /* Nasty hack */
2174 /* --- @cmd_merge@ --- */
2176 static int cmd_merge(int argc
, char *argv
[])
2182 die(EXIT_FAILURE
, "Usage: merge FILE");
2183 if (STRCMP(argv
[1], ==, "-"))
2185 else if (!(fp
= fopen(argv
[1], "r"))) {
2186 die(EXIT_FAILURE
, "couldn't open `%s' for reading: %s",
2187 argv
[1], strerror(errno
));
2190 doopen(&f
, KOPEN_WRITE
);
2191 key_merge(&f
, argv
[1], fp
, key_moan
, 0);
2196 /* --- @cmd_show@ --- */
2200 listtab[i].name, listtab[i].name) \
2201 LI("Hash functions", hash, \
2202 ghashtab[i], ghashtab[i]->name) \
2203 LI("Elliptic curves", ec, \
2204 ectab[i].name, ectab[i].name) \
2205 LI("Prime Diffie-Hellman groups", dh, \
2206 ptab[i].name, ptab[i].name) \
2207 LI("Binary Diffie-Hellman groups", bindh, \
2208 bintab[i].name, bintab[i].name) \
2209 LI("Key-generation algorithms", keygen, \
2210 algtab[i].name, algtab[i].name) \
2211 LI("Random seeding algorithms", seed, \
2212 seedtab[i].p, seedtab[i].p) \
2213 LI("Fingerprint presentation styles", fpres, \
2214 fprestab[i].name, fprestab[i].name)
2216 MAKELISTTAB(listtab
, LISTS
)
2218 static int cmd_show(int argc
, char *argv
[])
2220 return (displaylists(listtab
, argv
+ 1));
2223 /*----- Main command table ------------------------------------------------*/
2225 static int cmd_help(int argc
, char *argv
[]);
2227 static cmd cmds
[] = {
2228 { "help", cmd_help
, "help [COMMAND...]" },
2229 { "show", cmd_show
, "show [ITEM...]" },
2230 { "list", cmd_list
, "list [-uqv] [-f FILTER] [TAG...]", "\
2233 -u, --utc Display expiry times etc. in UTC, not local time.\n\
2234 -q, --quiet Show less information.\n\
2235 -v, --verbose Show more information.\n\
2237 { "fingerprint", cmd_finger
,
2238 "fingerprint [-a HASH] [-p STYLE] [-f FILTER] [TAG...]", "\
2241 -f, --filter=FILT Only hash key components matching FILT.\n\
2242 -p, --presentation=STYLE Use STYLE for presenting fingerprints.\n\
2243 -a, --algorithm=HASH Use the named HASH algorithm.\n\
2244 ($ show hash for list.)\n\
2246 { "verify", cmd_verify
,
2247 "verify [-a HASH] [-p STYLE] [-f FILTER] TAG FINGERPRINT", "\
2250 -f, --filter=FILT Only hash key components matching FILT.\n\
2251 -p, --presentation=STYLE Expect FINGERPRINT in the given STYLE.\n\
2252 -a, --algorithm=HASH Use the named HASH algorithm.\n\
2253 ($ show hash for list.)\n\
2255 { "extract", cmd_extract
, "extract [-f FILTER] FILE [TAG...]", "\
2258 -f, --filter=FILT Only extract key components matching FILT.\n\
2260 { "merge", cmd_merge
, "merge FILE" },
2261 { "expire", cmd_expire
, "expire TAG..." },
2262 { "delete", cmd_delete
, "delete TAG..." },
2263 { "setattr", cmd_setattr
, "setattr TAG ATTR..." },
2264 { "getattr", cmd_getattr
, "getattr TAG ATTR" },
2265 { "comment", cmd_comment
, "comment TAG [COMMENT]" },
2266 { "lock", cmd_lock
, "lock QTAG" },
2267 { "unlock", cmd_unlock
, "unlock QTAG" },
2268 { "tag", cmd_tag
, "tag [-r] TAG [NEW-TAG]", "\
2271 -r, --retag Untag any key currently called new-tag.\n\
2273 { "tidy", cmd_tidy
, "tidy" },
2275 "add [-OPTIONS] TYPE [ATTR...]\n\
2276 Options: [-lqrLKS] [-a ALG] [-bB BITS] [-p PARAM] [-R TAG]\n\
2277 [-A SEEDALG] [-s SEED] [-n BITS] [-I KEYID]\n\
2278 [-e EXPIRE] [-t TAG] [-c COMMENT]", "\
2281 -a, --algorithm=ALG Generate keys suitable for ALG.\n\
2282 ($ show keygen for list.)\n\
2283 -b, --bits=N Generate an N-bit key.\n\
2284 -B, --qbits=N Use an N-bit subgroup or factors.\n\
2285 -p, --parameters=TAG Get group parameters from TAG.\n\
2286 -C, --curve=NAME Use elliptic curve or DH group NAME.\n\
2287 ($ show ec or $ show dh for list.)\n\
2288 -A, --seedalg=ALG Use pseudorandom generator ALG to generate key.\n\
2289 ($ show seed for list.)\n\
2290 -s, --seed=BASE64 Use Base64-encoded string BASE64 as seed.\n\
2291 -n, --newseed=COUNT Generate new COUNT-bit seed.\n\
2292 -e, --expire=TIME Make the key expire after TIME.\n\
2293 -c, --comment=STRING Attach the command STRING to the key.\n\
2294 -t, --tag=TAG Tag the key with the name TAG.\n\
2295 -r, --retag Untag any key currently with that tag.\n\
2296 -R, --rand-id=TAG Use key named TAG for the random number generator.\n\
2297 -I, --key-id=ID Force the key-id for the new key.\n\
2298 -l, --lock Lock the generated key with a passphrase.\n\
2299 -q, --quiet Don't give progress indicators while working.\n\
2300 -L, --lim-lee Generate Lim-Lee primes for Diffie-Hellman groups.\n\
2301 -K, --kcdsa Generate KCDSA-style Lim-Lee primes for DH groups.\n\
2302 -S, --subgroup Use a prime-order subgroup for Diffie-Hellman.\n\
2307 static int cmd_help(int argc
, char *argv
[])
2309 sc_help(cmds
, stdout
, argv
+ 1);
2313 /*----- Main code ---------------------------------------------------------*/
2315 /* --- Helpful GNUy functions --- */
2317 static void usage(FILE *fp
)
2319 pquis(fp
, "Usage: $ [-k KEYRING] COMMAND [ARGS]\n");
2322 void version(FILE *fp
)
2324 pquis(fp
, "$, Catacomb version " VERSION
"\n");
2327 void help_global(FILE *fp
)
2331 Performs various simple key management operations.\n\
2333 Global command line options:\n\
2335 -h, --help [COMMAND...] Display this help text (or help for COMMANDs).\n\
2336 -v, --version Display version number.\n\
2337 -u, --usage Display short usage summary.\n\
2339 -k, --keyring=FILE Read and write keys in FILE.\n",
2345 * Arguments: @int argc@ = number of command line arguments
2346 * @char *argv[]@ = array of command line arguments
2348 * Returns: Nonzero on failure.
2350 * Use: Main program. Performs simple key management functions.
2353 int main(int argc
, char *argv
[])
2359 /* --- Initialization --- */
2364 /* --- Parse command line options --- */
2367 static struct option opt
[] = {
2369 /* --- Standard GNUy help options --- */
2371 { "help", 0, 0, 'h' },
2372 { "version", 0, 0, 'v' },
2373 { "usage", 0, 0, 'u' },
2375 /* --- Real live useful options --- */
2377 { "keyring", OPTF_ARGREQ
, 0, 'k' },
2379 /* --- Magic terminator --- */
2383 int i
= mdwopt(argc
, argv
, "+hvu k:", opt
, 0, 0, 0);
2389 /* --- GNU help options --- */
2392 sc_help(cmds
, stdout
, argv
+ optind
);
2401 /* --- Real useful options --- */
2407 /* --- Bogosity --- */
2415 /* --- Complain about excessive bogons --- */
2417 if (f
& f_bogus
|| optind
== argc
) {
2422 /* --- Initialize the Catacomb random number generator --- */
2424 rand_noisesrc(RAND_GLOBAL
, &noise_source
);
2425 rand_seed(RAND_GLOBAL
, 160);
2427 /* --- Dispatch to appropriate command handler --- */
2432 return (findcmd(cmds
, argv
[0])->cmd(argc
, argv
));
2435 /*----- That's all, folks -------------------------------------------------*/