3 * Request a key over UDP, or respond to such a request
5 * (c) 2012 Mark Wooding
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of udpkey.
12 * The udpkey program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * The udpkey program 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 General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with udpkey; if not, write to the Free Software Foundation,
24 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 /*----- Header files ------------------------------------------------------*/
36 #include <sys/types.h>
43 #include <sys/socket.h>
44 #include <arpa/inet.h>
45 #include <netinet/in.h>
48 #include <mLib/alloc.h>
50 #include <mLib/daemonize.h>
51 #include <mLib/dstr.h>
52 #include <mLib/fdflags.h>
53 #include <mLib/fwatch.h>
55 #include <mLib/mdwopt.h>
56 #include <mLib/quis.h>
57 #include <mLib/report.h>
61 #include <catacomb/buf.h>
62 #include <catacomb/ct.h>
63 #include <catacomb/dh.h>
64 #include <catacomb/ec.h>
65 #include <catacomb/ec-keys.h>
66 #include <catacomb/gcipher.h>
67 #include <catacomb/gmac.h>
68 #include <catacomb/group.h>
69 #include <catacomb/key.h>
70 #include <catacomb/mp.h>
71 #include <catacomb/mprand.h>
72 #include <catacomb/noise.h>
73 #include <catacomb/rand.h>
75 #include <catacomb/rijndael-counter.h>
76 #include <catacomb/sha256.h>
84 /*---- Static variables ---------------------------------------------------*/
86 static unsigned flags
= 0;
93 static unsigned char ibuf
[BUFSZ
], obuf
[BUFSZ
];
96 static const char *kfname
= "keyring";
97 static const char *pidfile
;
98 static fwatch kfwatch
;
101 /*----- Miscellaneous utilities -------------------------------------------*/
103 /* Resolve NAME, storing the address in *ADDR. Exit on error. */
104 static void resolve(const char *name
, struct in_addr
*addr
)
108 if ((h
= gethostbyname(name
)) == 0)
109 die(1, "failed to resolve `%s': %s", name
, hstrerror(h_errno
));
110 if (h
->h_addrtype
!= AF_INET
)
111 die(1, "unexpected address type %d", h
->h_addrtype
);
112 memcpy(addr
, h
->h_addr
, sizeof(struct in_addr
));
115 /* Convert PORT to a port number (in host byte order). Exit on error. */
116 static unsigned short getport(const char *port
)
123 if (!isdigit(*port
) ||
124 (i
= strtoul(port
, &q
, 0)) == 0 ||
125 i
>= 65536 || *q
|| errno
)
126 die(1, "invalid port number `%s'", port
);
128 return ((unsigned short)i
);
131 /* Read the file named by NAME into a buffer -- or at least an initial
132 * portion of it; set *P to the start and *SZ to the length. Return -1 if it
133 * didn't work. The buffer doesn't need to be freed: the data is stashed in
136 static int snarf(const char *name
, void **p
, size_t *sz
)
141 if ((fd
= open(name
, O_RDONLY
)) < 0) return (-1);
142 n
= read(fd
, ibuf
, sizeof(ibuf
));
144 if (n
< 0) return (-1);
149 /* Complain about something. If f_syslog is set then complain to that;
150 * otherwise write to stderr. Don't use `%m' because that won't work when
153 static void PRINTF_LIKE(2, 3) complain(int sev
, const char *msg
, ...)
158 if (flags
& f_syslog
)
159 vsyslog(sev
, msg
, ap
);
161 fprintf(stderr
, "%s: ", QUIS
);
162 vfprintf(stderr
, msg
, ap
);
167 /*----- Reading key data --------------------------------------------------*/
174 const gcmac
*mc
; size_t tagsz
;
178 /* Clear a kinfo structure so it can be freed without trouble. */
179 static void k_init(struct kinfo
*k
) { k
->g
= 0; k
->x
= 0; k
->X
= 0; }
181 /* Free a kinfo structure. This is safe on any initialized kinfo
184 static void k_free(struct kinfo
*k
)
186 if (k
->X
) { G_DESTROY(k
->g
, k
->X
); k
->X
= 0; }
187 if (k
->x
) { MP_DROP(k
->x
); k
->x
= 0; }
188 if (k
->g
) { G_DESTROYGROUP(k
->g
); k
->g
= 0; }
191 /* Empty macro arguments are forbidden. But arguments are expended during
192 * replacement, not while the call is being processed, so this hack is OK.
193 * Unfortunately, if a potentially empty argument is passed on to another
194 * macro then it needs to be guarded with a use of EMPTY too...
198 /* Table of key types. Entries have the form
200 * _(name, NAME, SETGROUP, SETPRIV, SETPUB)
202 * The name and NAME are lower- and uppercase names for the type used for
203 * constructing various type name constant names. The code fragment SETGROUP
204 * initializes k->g given the name_{pub,priv} structure in p; SETPRIV and
205 * SETPUB set up k->x and k->X respectively. (In this last case, k->X will
206 * have been created as a group element already.)
208 #define KEYTYPES(_) \
211 { k->g = group_prime(&p.dp); }, \
212 { k->x = MP_COPY(p.x); }, \
213 { if (G_FROMINT(k->g, k->X, p.y)) { \
214 complain(LOG_ERR, "bad public key in `%s'", t->buf); \
220 { ec_info ei; const char *e; \
221 if ((e = ec_getinfo(&ei, p.cstr)) != 0) { \
222 complain(LOG_ERR, "bad elliptic curve in `%s': %s", t->buf, e); \
225 k->g = group_ec(&ei); \
227 { k->x = MP_COPY(p.x); }, \
228 { if (G_FROMEC(k->g, k->X, &p.p)) { \
229 complain(LOG_ERR, "bad public point in `%s'", t->buf); \
234 /* Define load_tywhich, where which is `pub' or `priv', to load a public or
235 * private key. Other parameters are as for the KEYTYPES list above.
237 #define KLOAD(ty, TY, which, WHICH, setgroup, setpriv, setpub) \
238 static int load_##ty##which(key_data *kd, struct kinfo *k, dstr *t) \
240 key_packstruct kps[TY##_##WHICH##FETCHSZ]; \
245 /* Extract the key data from the keydata. */ \
246 kp = key_fetchinit(ty##_##which##fetch, kps, &p); \
247 if ((rc = key_unpack(kp, kd, t)) != 0) { \
248 complain(LOG_ERR, "failed to unpack key `%s': %s", \
249 t->buf, key_strerror(rc)); \
253 /* Extract the components as abstract group elements. */ \
256 k->X = G_CREATE(k->g); \
259 /* Dispose of stuff we don't need. */ \
263 /* Tidy up after mishaps. */ \
270 /* Map over the KEYTYPES to declare the load_tywhich functions using KLOAD
273 #define KEYTYPE_KLOAD(ty, TY, setgroup, setpriv, setpub) \
274 KLOAD(ty, TY, priv, PRIV, setgroup, setpriv, \
275 { G_EXP(k->g, k->X, k->g->g, k->x); }) \
276 KLOAD(ty, TY, pub, PUB, setgroup, { }, setpub)
277 KEYTYPES(KEYTYPE_KLOAD
)
279 /* Define a table of group key-loading operations. */
282 int (*loadpriv
)(key_data
*, struct kinfo
*, dstr
*);
283 int (*loadpub
)(key_data
*, struct kinfo
*, dstr
*);
286 static const struct kload_ops kload_ops
[] = {
287 #define KEYTYPE_OPS(ty, TY, setgroup, setpriv, setpub) \
288 { #ty, load_##ty##priv, load_##ty##pub },
289 KEYTYPES(KEYTYPE_OPS
)
293 /* Load a private or public (indicated by PRIVP) key named TAG into a kinfo
294 * structure K. Also fill in the cipher suite selections extracted from the
297 static int loadkey(const char *tag
, struct kinfo
*k
, int privp
)
299 const struct kload_ops
*ops
;
300 dstr d
= DSTR_INIT
, dd
= DSTR_INIT
;
308 /* Find the key data. */
309 if (key_qtag(kf
, tag
, &d
, &ky
, &kd
)) {
310 complain(LOG_ERR
, "unknown key tag `%s'", tag
);
314 /* Find the key's group type and locate the group operations. */
315 ty
= key_getattr(kf
, ky
, "group");
316 if (!ty
&& strncmp(ky
->type
, "udpkey-", 7) == 0) ty
= ky
->type
+ 7;
318 complain(LOG_ERR
, "no group type for key %s", d
.buf
);
321 for (ops
= kload_ops
; ops
->name
; ops
++) {
322 if (strcmp(ty
, ops
->name
) == 0)
325 complain(LOG_ERR
, "unknown group type `%s' in key %s", ty
, d
.buf
);
329 /* Extract the key data into an appropriately abstract form. */
330 k
->g
= 0; k
->x
= 0; k
->X
= 0;
331 if ((rc
= (privp ? ops
->loadpriv
: ops
->loadpub
)(*kd
, k
, &d
)) != 0)
334 /* Extract the chosen symmetric cipher. */
335 if ((p
= key_getattr(kf
, ky
, "cipher")) == 0)
336 k
->cc
= &rijndael_counter
;
337 else if ((k
->cc
= gcipher_byname(p
)) == 0) {
338 complain(LOG_ERR
, "unknown cipher `%s' in key %s", p
, d
.buf
);
342 /* And the chosen hash function. */
343 if ((p
= key_getattr(kf
, ky
, "hash")) == 0)
345 else if ((k
->hc
= ghash_byname(p
)) == 0) {
346 complain(LOG_ERR
, "unknown hash `%s' in key %s", p
, d
.buf
);
350 /* And finally a MAC. This is more fiddly because we must handle (a)
351 * truncation and (b) defaulting based on the hash.
353 if ((p
= key_getattr(kf
, ky
, "mac")) == 0)
354 dstr_putf(&dd
, "%s-hmac", k
->hc
->name
);
357 if ((q
= strchr(dd
.buf
, '/')) != 0) *q
++ = 0;
359 if ((k
->mc
= gmac_byname(dd
.buf
)) == 0) {
360 complain(LOG_ERR
, "unknown mac `%s' in key %s", dd
.buf
, d
.buf
);
364 k
->tagsz
= k
->mc
->hashsz
/2;
367 if (tsz
<= 0 || tsz
%8 || tsz
/8 > k
->mc
->hashsz
) {
368 complain(LOG_ERR
, "bad tag size `%s' for mac `%s' in key %s",
369 q
, k
->mc
->name
, d
.buf
);
387 static void keymoan(const char *file
, int line
, const char *err
, void *p
)
388 { complain(LOG_ERR
, "%s:%d: %s", file
, line
, err
); }
390 /* Update the keyring `kf' if the file has been changed since we last looked.
392 static void kfupdate(void)
396 if (!fwatch_update(&kfwatch
, kfname
)) return;
397 kfnew
= CREATE(key_file
);
398 if (key_open(kfnew
, kfname
, KOPEN_READ
, keymoan
, 0)) {
407 /*----- Low-level crypto operations ---------------------------------------*/
409 /* Derive a key, writing its address to *KK and size to *N. The size is
410 * compatible with the keysz rules KSZ. It is generated for the purpose of
411 * keying a WHAT (used for key separation and in error messages), and NAME is
412 * the name of the specific instance (e.g., `twofish-counter') from the class
413 * name. The kinfo structure K tells us which algorithms to use for the
414 * derivation. The group elements U and Z are the cryptographic inputs
415 * for the derivation.
417 * Basically all we do is compute H(what || U || Z).
419 static int derive(struct kinfo
*k
, ge
*U
, ge
*Z
,
420 const char *what
, const char *name
, const octet
*ksz
,
421 octet
**kk
, size_t *n
)
427 /* Find a suitable key size. */
428 if ((*n
= keysz(k
->hc
->hashsz
, ksz
)) == 0) {
430 "failed to find suitable key size for %s `%s' and hash `%s'",
431 what
, name
, k
->hc
->name
);
435 /* Build the hash preimage. */
436 buf_init(&b
, obuf
, sizeof(obuf
));
437 buf_put(&b
, "udpkey-", 7);
438 buf_putstrz(&b
, what
);
439 G_TORAW(k
->g
, &b
, U
);
440 G_TORAW(k
->g
, &b
, Z
);
442 complain(LOG_ERR
, "overflow while deriving key (prepare preimage)!");
446 /* Derive the output key. */
448 GH_HASH(h
, BBASE(&b
), BLEN(&b
));
449 buf_init(&b
, obuf
, sizeof(obuf
));
450 if ((p
= buf_get(&b
, h
->ops
->c
->hashsz
)) == 0) {
451 complain(LOG_ERR
, "overflow while deriving key (output hash)!");
462 static void debug_mp(const char *what
, mp
*x
)
463 { fprintf(stderr
, "%s: *** ", QUIS
); MP_EPRINT(what
, x
); }
464 static void debug_ge(const char *what
, group
*g
, ge
*X
)
466 fprintf(stderr
, "%s: *** %s = ", QUIS
, what
);
467 group_writefile(g
, X
, stderr
);
472 /*----- Protocol summary --------------------------------------------------*
475 * memz KEYTAG tag of wanted secret
479 * ge V public vector: V = v P
480 * ge W encrypted clue: W = R - Y = r P - v U
481 * mem[TAGSZ] TAG MAC tag on ciphertext
482 * mem[KSZ] CT secret, encrypted with Z = r X
485 /*----- Listening for requests --------------------------------------------*/
487 /* Rate limiting parameters.
489 * There's a probabilistic rate-limiting mechanism. A counter starts at 0.
490 * Every time we process a request, we increment the counter. The counter
491 * drops by RATE_REFILL every second. If the counter is below RATE_CREDIT
492 * then the request is processed; otherwise it is processed with probability
493 * 1/(counter - RATE_CREDIT).
495 #define RATE_REFILL 10 /* Credits per second. */
496 #define RATE_CREDIT 1000 /* Initial credit. */
500 static int fetch_key(const char *tag
, struct sockaddr_in
*sin
,
501 key
**ky
, struct kinfo
*k
)
503 dstr d
= DSTR_INIT
, dd
= DSTR_INIT
;
508 int ch
, mlen
, rc
= -1;
512 if (key_qtag(kf
, tag
, &d
, ky
, &kkd
)) {
513 complain(LOG_WARNING
, "unknown key tag `%s' from %s:%d",
514 tag
, inet_ntoa(sin
->sin_addr
), ntohs(sin
->sin_port
));
518 /* And make sure that it has the right shape. */
519 if (((*ky
)->k
->e
& KF_ENCMASK
) != KENC_BINARY
) {
520 complain(LOG_ERR
, "key %s is not plain binary data", d
.buf
);
524 /* Find the list of clients, and look up the caller's address in the
525 * list. Entries have the form ADDRESS[/LEN][=TAG] and are separated by
528 if ((pp
= key_getattr(kf
, *ky
, "clients")) == 0) {
529 complain(LOG_WARNING
,
530 "key %s requested from %s:%d has no `clients' attribute",
531 d
.buf
, inet_ntoa(sin
->sin_addr
), ntohs(sin
->sin_port
));
538 while (isdigit((unsigned char)*q
) || *q
== '.') q
++;
540 if (!inet_aton(p
, &in
)) goto skip
;
545 while (isdigit((unsigned char)*q
)) q
++;
549 if (((sin
->sin_addr
.s_addr
^ in
.s_addr
) &
550 htonl(0xffffffff << (32 - mlen
))) == 0)
555 while (*p
&& *p
!= ';') p
++;
558 complain(LOG_WARNING
, "access to key %s denied to %s:%d",
559 d
.buf
, inet_ntoa(sin
->sin_addr
), ntohs(sin
->sin_port
));
563 /* Build a tag name for the caller's KEM key, either from the client
564 * match or the source address.
568 dstr_puts(&dd
, "client-");
569 dstr_puts(&dd
, inet_ntoa(sin
->sin_addr
));
573 while (*q
&& *q
!= ';') q
++;
574 if (*q
== ';') *q
++ = 0;
577 /* Report the match. */
578 complain(LOG_NOTICE
, "client %s:%d (`%s') requests key %s",
579 inet_ntoa(sin
->sin_addr
), ntohs(sin
->sin_port
), p
, d
.buf
);
581 /* Load the KEM key. */
582 if (loadkey(p
, k
, 0)) goto done
;
583 D( debug_ge("X", k
.g
, k
.X
); )
589 /* Clean everything up. */
596 static int respond_v0(buf
*bin
, buf
*bout
, struct sockaddr_in
*sin
)
598 ge
*R
= 0, *U
= 0, *V
= 0, *W
= 0, *Y
= 0, *Z
= 0;
599 mp
*r
= MP_NEW
, *v
= MP_NEW
;
611 /* Clear out the key state. */
614 /* Extract the key tag name. */
615 if ((p
= buf_getmemz(bin
, &sz
)) == 0) {
616 complain(LOG_WARNING
, "invalid key tag from %s:%d",
617 inet_ntoa(sin
->sin_addr
), ntohs(sin
->sin_port
));
621 /* Find the client's key and check that it's allowed. */
622 if (fetch_key(p
, sin
, &ky
, &k
)) goto done
;
624 /* Read the caller's ephemeral key. */
625 R
= G_CREATE(k
.g
); W
= G_CREATE(k
.g
);
626 U
= G_CREATE(k
.g
); V
= G_CREATE(k
.g
);
627 Y
= G_CREATE(k
.g
); Z
= G_CREATE(k
.g
);
628 if (G_FROMBUF(k
.g
, bin
, U
)) {
629 complain(LOG_WARNING
, "failed to read ephemeral vector from %s:%d",
630 inet_ntoa(sin
->sin_addr
), ntohs(sin
->sin_port
));
633 D( debug_ge("U", k
.g
, U
); )
635 complain(LOG_WARNING
, "trailing junk in request from %s:%d",
636 inet_ntoa(sin
->sin_addr
), ntohs(sin
->sin_port
));
640 /* Ephemeral Diffie--Hellman. Choose v in GF(q) at random; compute
641 * V = v P and -Y = (-v) U.
643 v
= mprand_range(v
, k
.g
->r
, &rand_global
, 0);
644 G_EXP(k
.g
, V
, k
.g
->g
, v
);
645 D( debug_mp("v", v
); debug_ge("V", k
.g
, V
); )
646 v
= mp_sub(v
, k
.g
->r
, v
);
648 D( debug_ge("-Y", k
.g
, Y
); )
650 /* DLIES. Choose r in GF(q) at random; compute R = r P and Z = r X. Mask
651 * the clue R as W = R - Y. (Doing the subtraction here makes life easier
652 * at the other end, since we can determine -Y by negating v whereas the
653 * recipient must subtract vectors which may be less efficient.)
655 r
= mprand_range(r
, k
.g
->r
, &rand_global
, 0);
656 G_EXP(k
.g
, R
, k
.g
->g
, r
);
657 D( debug_mp("r", r
); debug_ge("R", k
.g
, R
); )
658 G_EXP(k
.g
, Z
, k
.X
, r
);
660 D( debug_ge("Z", k
.g
, Z
); debug_ge("W", k
.g
, W
); )
662 /* Derive encryption and integrity keys. */
663 derive(&k
, R
, Z
, "cipher", k
.cc
->name
, k
.cc
->keysz
, &kk
, &ksz
);
664 c
= GC_INIT(k
.cc
, kk
, ksz
);
665 derive(&k
, R
, Z
, "mac", k
.mc
->name
, k
.mc
->keysz
, &kk
, &ksz
);
666 m
= GM_KEY(k
.mc
, kk
, ksz
);
668 /* Build the ciphertext and compute a MAC tag over it. */
670 if (G_TOBUF(k
.g
, bout
, V
) ||
671 G_TOBUF(k
.g
, bout
, W
))
673 if ((t
= buf_get(bout
, k
.tagsz
)) == 0) goto done
;
675 if (BENSURE(bout
, sz
)) goto done
;
676 GC_ENCRYPT(c
, ky
->k
->u
.k
.k
, BCUR(bout
), sz
);
678 GH_HASH(h
, BCUR(bout
), sz
);
679 tt
= GH_DONE(h
, 0); memcpy(t
, tt
, k
.tagsz
);
683 /* Clear everything up and go home. */
684 if (R
) G_DESTROY(k
.g
, R
);
685 if (U
) G_DESTROY(k
.g
, U
);
686 if (V
) G_DESTROY(k
.g
, V
);
687 if (W
) G_DESTROY(k
.g
, W
);
688 if (Y
) G_DESTROY(k
.g
, Y
);
689 if (Z
) G_DESTROY(k
.g
, Z
);
690 if (c
) GC_DESTROY(c
);
691 if (m
) GM_DESTROY(m
);
692 if (h
) GH_DESTROY(h
);
699 static int dolisten(int argc
, char *argv
[])
706 struct sockaddr_in sin
;
710 unsigned bucket
= 0, toks
;
713 /* Set up the socket address. */
714 sin
.sin_family
= AF_INET
;
715 aspec
= xstrdup(argv
[0]);
716 if ((p
= strchr(aspec
, ':')) == 0) {
718 sin
.sin_addr
.s_addr
= INADDR_ANY
;
721 resolve(aspec
, &sin
.sin_addr
);
723 sin
.sin_port
= htons(getport(p
));
725 /* Create and set up the socket itself. */
726 if ((sk
= socket(PF_INET
, SOCK_DGRAM
, 0)) < 0 ||
727 fdflags(sk
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
) ||
728 bind(sk
, (struct sockaddr
*)&sin
, sizeof(sin
)))
729 die(1, "failed to create socket: %s", strerror(errno
));
731 /* That's enough initialization. If we should fork, then do that. */
732 if (flags
& f_daemon
) {
733 if (pidfile
&& (fp
= fopen(pidfile
, "w")) == 0)
734 die(1, "failed to open pidfile `%s': %s", pidfile
, strerror(errno
));
735 openlog(QUIS
, LOG_PID
, LOG_DAEMON
);
737 die(1, "failed to become background process: %s", strerror(errno
));
738 if (pidfile
) { fprintf(fp
, "%ld\n", (long)getpid()); fclose(fp
); }
744 /* Wait for something to happen. */
747 if (select(sk
+ 1, &fdin
, 0, 0, 0) < 0)
748 die(1, "select failed: %s", strerror(errno
));
749 noise_timer(RAND_GLOBAL
);
751 /* Fetch a packet. */
753 n
= recvfrom(sk
, ibuf
, sizeof(ibuf
), 0, (struct sockaddr
*)&sin
, &len
);
755 if (errno
!= EAGAIN
&& errno
!= EINTR
)
756 complain(LOG_ERR
, "unexpected receive error: %s", strerror(errno
));
760 /* Refill the bucket, and see whether we should reject this packet. */
762 if (bucket
&& now
!= last
) {
763 toks
= (now
- last
)*RATE_REFILL
;
764 bucket
= bucket
< toks ?
0 : bucket
- toks
;
767 if (bucket
> RATE_CREDIT
&&
768 grand_range(&rand_global
, bucket
- RATE_CREDIT
))
772 /* Set up the input buffer for parsing the request. */
773 buf_init(&bin
, ibuf
, n
);
774 buf_init(&bout
, obuf
, sizeof(obuf
));
776 /* Handle the client's message. */
777 if (respond_v0(&bin
, &bout
, &sin
)) continue;
779 /* Send the reply packet back to the caller. */
780 if (!BOK(&bout
)) goto bad
;
781 if (sendto(sk
, BBASE(&bout
), BLEN(&bout
), 0,
782 (struct sockaddr
*)&sin
, len
) < 0) {
783 complain(LOG_ERR
, "failed to send response to %s:%d: %s",
784 inet_ntoa(sin
.sin_addr
), ntohs(sin
.sin_port
),
792 /* Report a problem building the reply. */
793 complain(LOG_ERR
, "failed to construct response to %s:%d",
794 inet_ntoa(sin
.sin_addr
), ntohs(sin
.sin_port
));
800 /*----- Sending requests and processing responses -------------------------*/
812 struct sockaddr_in sin
;
814 const struct client_protocol
*proto
;
820 struct client_protocol
{
822 int (*setup
)(struct query
*, struct server
*);
823 int (*receive
)(struct query
*, struct server
*, buf
*, buf
*);
824 int (*retransmit
)(struct query
*, struct server
*, buf
*);
827 /* Record a successful fetch of key material for a query Q. The data starts
828 * at K and is SZ bytes long. The data is copied: it's safe to overwrite it.
830 static int donequery(struct query
*q
, struct server
*s
,
831 const void *k
, size_t sz
)
837 /* If we have a hash, check that the fragment matches it. */
839 h
= GH_INIT(s
->k
.hc
);
842 diffp
= memcmp(tt
, s
->h
, h
->ops
->c
->hashsz
);
845 moan("response from %s:%d doesn't match hash",
846 inet_ntoa(s
->sin
.sin_addr
), ntohs(s
->sin
.sin_port
));
851 /* Stash a copy of the key fragment for later. */
860 static int setup_v0(struct query
*q
, struct server
*s
)
862 /* Choose an ephemeral private key u. Let x be our private key. We
863 * compute U = u P and transmit this.
865 s
->u
= mprand_range(MP_NEW
, s
->k
.g
->r
, &rand_global
, 0);
866 s
->U
= G_CREATE(s
->k
.g
);
867 G_EXP(s
->k
.g
, s
->U
, s
->k
.g
->g
, s
->u
);
868 D( debug_mp("u", s
->u
); debug_ge("U", s
->k
.g
, s
->U
); )
873 static int retransmit_v0(struct query
*q
, struct server
*s
, buf
*bout
)
875 buf_putstrz(bout
, q
->tag
);
876 G_TOBUF(s
->k
.g
, bout
, s
->U
);
880 static int receive_v0(struct query
*q
, struct server
*s
, buf
*bin
, buf
*bout
)
882 ge
*R
, *V
= 0, *W
= 0, *Y
= 0, *Z
= 0;
891 R
= G_CREATE(s
->k
.g
);
892 V
= G_CREATE(s
->k
.g
); W
= G_CREATE(s
->k
.g
);
893 Y
= G_CREATE(s
->k
.g
); Z
= G_CREATE(s
->k
.g
);
894 if (G_FROMBUF(s
->k
.g
, bin
, V
)) {
895 moan("invalid Diffie--Hellman vector from %s:%d",
896 inet_ntoa(s
->sin
.sin_addr
), ntohs(s
->sin
.sin_port
));
899 if (G_FROMBUF(s
->k
.g
, bin
, W
)) {
900 moan("invalid clue vector from %s:%d",
901 inet_ntoa(s
->sin
.sin_addr
), ntohs(s
->sin
.sin_port
));
904 D( debug_ge("V", s
->k
.g
, V
); debug_ge("W", s
->k
.g
, W
); )
906 /* We have V and W from the server; determine Y = u V, R = W + Y and
907 * Z = x R, and then derive the symmetric keys.
909 G_EXP(s
->k
.g
, Y
, V
, s
->u
);
910 G_MUL(s
->k
.g
, R
, W
, Y
);
911 G_EXP(s
->k
.g
, Z
, R
, s
->k
.x
);
912 D( debug_ge("R", s
->k
.g
, R
);
913 debug_ge("Y", s
->k
.g
, Y
);
914 debug_ge("Z", s
->k
.g
, Z
); )
915 derive(&s
->k
, R
, Z
, "cipher", s
->k
.cc
->name
, s
->k
.cc
->keysz
, &kk
, &ksz
);
916 c
= GC_INIT(s
->k
.cc
, kk
, ksz
);
917 derive(&s
->k
, R
, Z
, "mac", s
->k
.cc
->name
, s
->k
.cc
->keysz
, &kk
, &ksz
);
918 m
= GM_KEY(s
->k
.mc
, kk
, ksz
);
920 /* Find where the MAC tag is. */
921 if ((t
= buf_get(bin
, s
->k
.tagsz
)) == 0) {
922 moan("missing tag from %s:%d",
923 inet_ntoa(s
->sin
.sin_addr
), ntohs(s
->sin
.sin_port
));
927 /* Check the integrity of the ciphertext against the tag. */
928 p
= BCUR(bin
); n
= BLEFT(bin
);
932 if (!ct_memeq(t
, tt
, s
->k
.tagsz
)) {
933 moan("incorrect tag from %s:%d",
934 inet_ntoa(s
->sin
.sin_addr
), ntohs(s
->sin
.sin_port
));
938 /* Decrypt the result and declare this server done. */
939 GC_DECRYPT(c
, p
, p
, n
);
940 rc
= donequery(q
, s
, p
, n
);
943 /* Clear up and go home. */
944 if (R
) G_DESTROY(s
->k
.g
, R
);
945 if (V
) G_DESTROY(s
->k
.g
, V
);
946 if (W
) G_DESTROY(s
->k
.g
, W
);
947 if (Y
) G_DESTROY(s
->k
.g
, Y
);
948 if (Z
) G_DESTROY(s
->k
.g
, Z
);
949 if (c
) GC_DESTROY(c
);
950 if (m
) GM_DESTROY(m
);
951 if (h
) GH_DESTROY(h
);
955 static const struct client_protocol prototab
[] = {
956 { "v0", setup_v0
, receive_v0
, retransmit_v0
},
960 /* Initialize a query to a remote server. */
961 static struct query
*qinit_net(const char *tag
, const char *spec
)
964 struct server
*s
, **stail
;
965 dstr d
= DSTR_INIT
, dd
= DSTR_INIT
;
966 const struct client_protocol
*proto
;
970 /* Allocate the query block. */
971 q
= CREATE(struct query
);
975 /* Put the spec somewhere we can hack at it. */
979 /* Parse the query spec. Entries have the form ADDRESS:PORT[=TAG][#HASH]
980 * and are separated by `;'.
984 /* Allocate a new server node. */
985 s
= CREATE(struct server
);
986 s
->sin
.sin_family
= AF_INET
;
988 /* Extract the server address. */
989 if ((pp
= strchr(p
, ':')) == 0)
990 die(1, "invalid syntax: missing `:PORT'");
992 resolve(p
, &s
->sin
.sin_addr
);
994 /* Extract the port number. */
996 while (isdigit((unsigned char)*pp
)) pp
++;
998 s
->sin
.sin_port
= htons(getport(p
));
1000 /* See if there's a protocol name. */
1005 pp
+= strcspn(pp
, ";#=");
1006 ch
= *pp
; *pp
++ = 0;
1008 for (proto
= prototab
; proto
->name
; proto
++)
1009 if (strcmp(proto
->name
, p
) == 0) goto found_proto
;
1010 die(1, "unknown protocol name `%s'", p
);
1014 /* If there's a key tag then extract that; otherwise use a default. */
1019 pp
+= strcspn(pp
, ";#");
1020 ch
= *pp
; *pp
++ = 0;
1022 if (loadkey(p
, &s
->k
, 1)) exit(1);
1023 D( debug_mp("x", s
->k
.x
); debug_ge("X", s
->k
.g
, s
->k
.X
); )
1025 /* Link the server on. */
1026 *stail
= s
; stail
= &s
->next
;
1028 /* If there's a trailing hash then extract it. */
1033 while (*pp
== '-' || isxdigit((unsigned char)*pp
)) pp
++;
1036 hex_decode(&hc
, p
, pp
- p
, &dd
);
1037 if (dd
.len
!= s
->k
.hc
->hashsz
) die(1, "incorrect hash length");
1038 s
->h
= xmalloc(dd
.len
);
1039 memcpy(s
->h
, dd
.buf
, dd
.len
);
1043 /* Initialize the protocol. */
1044 if (s
->proto
->setup(q
, s
)) die(1, "failed to initialize protocol");
1046 /* If there are more servers, then continue parsing. */
1048 else if (ch
!= ';') die(1, "invalid syntax: expected `;'");
1052 /* Terminate the server list and return. */
1060 /* Handle a `query' to a local file. */
1061 static struct query
*qinit_file(const char *tag
, const char *file
)
1067 /* Snarf the file. */
1068 q
= CREATE(struct query
);
1069 if (snarf(file
, &k
, &sz
))
1070 die(1, "failed to read `%s': %s", file
, strerror(errno
));
1072 donequery(q
, 0, k
, sz
);
1076 /* Retransmission and timeout parameters. */
1077 #define TO_NEXT(t) (((t) + 2)*4/3) /* Timeout growth function */
1078 #define TO_MAX 30 /* When to give up */
1080 static int doquery(int argc
, char *argv
[])
1082 struct query
*q
= 0, *qq
, **qtail
= &qq
;
1083 struct server
*s
= 0;
1084 const char *tag
= argv
[0];
1089 struct timeval now
, when
, tv
;
1090 struct sockaddr_in sin
;
1097 /* Create a socket. We just use the one socket for everything. We don't
1098 * care which port we get allocated.
1100 if ((sk
= socket(PF_INET
, SOCK_DGRAM
, 0)) < 0 ||
1101 fdflags(sk
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
))
1102 die(1, "failed to create socket: %s", strerror(errno
));
1104 /* Parse the query target specifications. The adjustments of `nq' aren't
1105 * in the right order but that doesn't matter.
1107 for (i
= 1; i
< argc
; i
++) {
1108 if (*argv
[i
] == '.' || *argv
[i
] == '/') q
= qinit_file(tag
, argv
[i
]);
1109 else if (strchr(argv
[i
], ':')) q
= qinit_net(tag
, argv
[i
]);
1110 else die(1, "unrecognized query target `%s'", argv
[i
]);
1111 *qtail
= q
; qtail
= &q
->next
; nq
++;
1115 /* Find the current time so we can compute retransmission times properly.
1117 gettimeofday(&now
, 0);
1120 /* Continue retransmitting until we have all the answers. */
1123 /* Work out when we next want to wake up. */
1124 if (TV_CMP(&now
, >=, &when
)) {
1126 if (next
>= TO_MAX
) die(1, "no responses: giving up");
1127 next
= TO_NEXT(next
);
1128 TV_ADDL(&when
, &when
, next
, 0);
1129 } while (TV_CMP(&when
, <=, &now
));
1130 for (q
= qq
; q
; q
= q
->next
) {
1132 for (s
= q
->s
; s
; s
= s
->next
) {
1133 buf_init(&bout
, obuf
, sizeof(obuf
));
1134 if (s
->proto
->retransmit(q
, s
, &bout
)) continue;
1136 moan("overflow while constructing request!");
1139 sendto(sk
, BBASE(&bout
), BLEN(&bout
), 0,
1140 (struct sockaddr
*)&s
->sin
, sizeof(s
->sin
));
1145 /* Wait until something interesting happens. */
1148 TV_SUB(&tv
, &when
, &now
);
1149 if (select(sk
+ 1, &fdin
, 0, 0, &tv
) < 0)
1150 die(1, "select failed: %s", strerror(errno
));
1151 gettimeofday(&now
, 0);
1153 /* If we have an input event, process incoming packets. */
1154 if (FD_ISSET(sk
, &fdin
)) {
1157 /* Read a packet and capture its address. */
1159 nn
= recvfrom(sk
, ibuf
, sizeof(ibuf
), 0,
1160 (struct sockaddr
*)&sin
, &len
);
1162 if (errno
== EAGAIN
) break;
1163 else if (errno
== EINTR
) continue;
1165 moan("error receiving reply: %s", strerror(errno
));
1170 /* See whether this corresponds to any of our servers. Don't just
1171 * check the active servers, since this may be late a reply caused by
1172 * retransmissions or similar.
1174 for (q
= qq
; q
; q
= q
->next
) {
1175 for (s
= q
->s
; s
; s
= s
->next
) {
1176 if (s
->sin
.sin_addr
.s_addr
== sin
.sin_addr
.s_addr
&&
1177 s
->sin
.sin_port
== sin
.sin_port
)
1181 moan("received reply from unexpected source %s:%d",
1182 inet_ntoa(sin
.sin_addr
), ntohs(sin
.sin_port
));
1186 /* If the query we found has now been satisfied, ignore this packet.
1190 /* Parse the reply, and either finish the job or get a message to
1191 * send back to the server.
1193 buf_init(&bin
, ibuf
, nn
);
1194 buf_init(&bout
, obuf
, sizeof(obuf
));
1195 if (s
->proto
->receive(q
, s
, &bin
, &bout
)) continue;
1197 if (!BLEN(&bout
) && s
->proto
->retransmit(q
, s
, &bout
)) continue;
1199 moan("overflow while constructing request!");
1202 sendto(sk
, BBASE(&bout
), BLEN(&bout
), 0,
1203 (struct sockaddr
*)&s
->sin
, sizeof(s
->sin
));
1208 /* Check that all of the responses match up and XOR them together. */
1210 if (n
> BUFSZ
) die(1, "response too large");
1212 for (q
= qq
; q
; q
= q
->next
) {
1213 if (!q
->k
) die(1, "INTERNAL: query not complete");
1214 if (q
->sz
!= n
) die(1, "inconsistent response sizes");
1215 for (j
= 0; j
< n
; j
++) obuf
[j
] ^= q
->k
[j
];
1218 /* Write out the completed answer. */
1221 if ((nn
= write(STDOUT_FILENO
, p
, n
)) < 0)
1222 die(1, "error writing response: %s", strerror(errno
));
1228 /*----- Main program ------------------------------------------------------*/
1230 static void usage(FILE *fp
)
1232 pquis(fp
, "Usage: \n\
1233 $ [-OPTS] LABEL {ADDR:PORT[=TAG][#HASH];... | FILE} ...\n\
1234 $ [-OPTS] -l [ADDR:]PORT\n\
1238 static void version(FILE *fp
)
1239 { pquis(fp
, "$, version " VERSION
"\n"); }
1241 static void help(FILE *fp
)
1249 -d, --daemon Run in the background while listening.\n\
1250 -k, --keyring=FILE Read keys from FILE. [default = `keyring']\n\
1251 -l, --listen Listen for incoming requests and serve keys.\n\
1252 -p, --pidfile=FILE Write process id to FILE if in daemon mode.\n\
1253 -r, --random=FILE Key random number generator with contents of FILE.\n\
1257 int main(int argc
, char *argv
[])
1265 static const struct option opts
[] = {
1266 { "help", 0, 0, 'h' },
1267 { "version", 0, 0, 'v' },
1268 { "usage", 0, 0, 'u' },
1269 { "daemon", 0, 0, 'd' },
1270 { "keyfile", OPTF_ARGREQ
, 0, 'k' },
1271 { "listen", 0, 0, 'l' },
1272 { "pidfile", OPTF_ARGREQ
, 0, 'p' },
1273 { "random", OPTF_ARGREQ
, 0, 'r' },
1277 int i
= mdwopt(argc
, argv
, "hvu" "dk:lp:r:", opts
, 0, 0, 0);
1281 case 'h': help(stdout
); exit(0);
1282 case 'v': version(stdout
); exit(0);
1283 case 'u': usage(stdout
); exit(0);
1285 case 'd': flags
|= f_daemon
; break;
1286 case 'k': kfname
= optarg
; break;
1287 case 'l': flags
|= f_listen
; break;
1288 case 'p': pidfile
= optarg
; break;
1290 if (snarf(optarg
, &k
, &sz
))
1291 die(1, "failed to read `%s': %s", optarg
, strerror(errno
));
1292 rand_key(RAND_GLOBAL
, k
, sz
);
1295 default: flags
|= f_bogus
; break;
1299 argv
+= optind
; argc
-= optind
;
1300 if (flags
& f_listen
) argmin
= argmax
= 1;
1301 else argmin
= 2, argmax
= -1;
1302 if ((flags
& f_bogus
) || argc
< argmin
|| (argmax
>= 0 && argc
> argmax
))
1303 { usage(stderr
); exit(1); }
1305 fwatch_init(&kfwatch
, kfname
);
1306 kf
= CREATE(key_file
);
1307 if (key_open(kf
, kfname
, KOPEN_READ
, keymoan
, 0))
1308 die(1, "failed to open keyring file `%s'", kfname
);
1310 rand_noisesrc(RAND_GLOBAL
, &noise_source
);
1311 rand_seed(RAND_GLOBAL
, 512);
1313 if (flags
& f_listen
) return dolisten(argc
, argv
);
1314 else return doquery(argc
, argv
);
1317 /*----- That's all, folks -------------------------------------------------*/