chiark / gitweb /
admin: Service ownership infrastructure and commands.
[tripe] / server / tripe.h
CommitLineData
410c8acf 1/* -*-c-*-
2 *
3cdc3f3a 3 * $Id$
410c8acf 4 *
5 * Main header file for TrIPE
6 *
7 * (c) 2001 Straylight/Edgeware
8 */
9
10/*----- Licensing notice --------------------------------------------------*
11 *
12 * This file is part of Trivial IP Encryption (TrIPE).
13 *
14 * TrIPE is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
18 *
19 * TrIPE 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 General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with TrIPE; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 */
28
410c8acf 29#ifndef TRIPE_H
30#define TRIPE_H
31
32#ifdef __cplusplus
33 extern "C" {
34#endif
35
36/*----- Header files ------------------------------------------------------*/
37
73189848 38#include "config.h"
39
410c8acf 40#include <assert.h>
41#include <ctype.h>
42#include <errno.h>
b9066fbb 43#include <limits.h>
410c8acf 44#include <signal.h>
45#include <stdarg.h>
46#include <stddef.h>
47#include <stdio.h>
48#include <stdlib.h>
49#include <string.h>
50#include <time.h>
51
52#include <sys/types.h>
53#include <sys/time.h>
54#include <unistd.h>
55#include <fcntl.h>
56#include <sys/stat.h>
57
58#include <sys/socket.h>
59#include <sys/un.h>
60#include <netinet/in.h>
61#include <arpa/inet.h>
62#include <netdb.h>
63
64#include <pwd.h>
65#include <grp.h>
66
67#include <mLib/alloc.h>
68#include <mLib/arena.h>
37941236 69#include <mLib/base64.h>
410c8acf 70#include <mLib/bres.h>
71#include <mLib/dstr.h>
72#include <mLib/env.h>
73#include <mLib/fdflags.h>
74#include <mLib/fwatch.h>
75#include <mLib/mdwopt.h>
76#include <mLib/quis.h>
77#include <mLib/report.h>
78#include <mLib/sel.h>
79#include <mLib/selbuf.h>
80#include <mLib/sig.h>
81#include <mLib/str.h>
82#include <mLib/sub.h>
83#include <mLib/trace.h>
0ba8de86 84#include <mLib/tv.h>
410c8acf 85
165db1a8 86#include <catacomb/buf.h>
87
410c8acf 88#include <catacomb/gcipher.h>
89#include <catacomb/gmac.h>
90#include <catacomb/grand.h>
91#include <catacomb/key.h>
92#include <catacomb/paranoia.h>
93
410c8acf 94#include <catacomb/noise.h>
95#include <catacomb/rand.h>
410c8acf 96
97#include <catacomb/mp.h>
410c8acf 98#include <catacomb/mprand.h>
99#include <catacomb/dh.h>
52c03a2a 100#include <catacomb/ec.h>
101#include <catacomb/ec-keys.h>
102#include <catacomb/group.h>
410c8acf 103
78698994 104#include "protocol.h"
410c8acf 105#include "util.h"
106
107#undef sun
108
109/*----- Magic numbers -----------------------------------------------------*/
110
410c8acf 111/* --- Trace flags --- */
112
113#define T_TUNNEL 1u
114#define T_PEER 2u
115#define T_PACKET 4u
116#define T_ADMIN 8u
117#define T_CRYPTO 16u
118#define T_KEYSET 32u
119#define T_KEYEXCH 64u
120#define T_KEYMGMT 128u
37941236 121#define T_CHAL 256u
410c8acf 122
37941236 123#define T_ALL 511u
410c8acf 124
125/* --- Units --- */
126
127#define SEC(n) (n##u)
128#define MIN(n) (n##u * 60u)
129#define MEG(n) (n##ul * 1024ul * 1024ul)
130
131/* --- Other things --- */
132
133#define PKBUFSZ 65536
134
832a2ab6 135/*----- Cipher selections -------------------------------------------------*/
136
b5c45da1 137typedef struct algswitch {
138 const gccipher *c; /* Symmetric encryption scheme */
139 const gccipher *mgf; /* Mask-generation function */
140 const gchash *h; /* Hash function */
141 const gcmac *m; /* Message authentication code */
142 size_t hashsz; /* Hash output size */
143 size_t tagsz; /* Length to truncate MAC tags */
144 size_t cksz, mksz; /* Key lengths for @c@ and @m@ */
145} algswitch;
832a2ab6 146
b5c45da1 147extern algswitch algs;
832a2ab6 148
b5c45da1 149#define MAXHASHSZ 64 /* Largest possible hash size */
832a2ab6 150
b5c45da1 151#define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
410c8acf 152
aeeb5611 153/*----- Data structures ---------------------------------------------------*/
410c8acf 154
155/* --- Socket addresses --- *
156 *
157 * A magic union of supported socket addresses.
158 */
159
160typedef union addr {
161 struct sockaddr sa;
162 struct sockaddr_in sin;
163} addr;
164
37941236 165/* --- Sequence number checking --- */
166
167typedef struct seqwin {
168 uint32 seq; /* First acceptable input sequence */
169 uint32 win; /* Window of acceptable numbers */
170} seqwin;
171
172#define SEQ_WINSZ 32 /* Bits in sequence number window */
173
410c8acf 174/* --- A symmetric keyset --- *
175 *
176 * A keyset contains a set of symmetric keys for encrypting and decrypting
177 * packets. Keysets are stored in a list, sorted in reverse order of
178 * creation, so that the most recent keyset (the one most likely to be used)
179 * is first.
180 *
181 * Each keyset has a time limit and a data limit. The keyset is destroyed
182 * when either it has existed for too long, or it has been used to encrypt
183 * too much data. New key exchanges are triggered when keys are close to
184 * expiry.
185 */
186
187typedef struct keyset {
188 struct keyset *next; /* Next active keyset in the list */
832a2ab6 189 unsigned ref; /* Reference count for keyset */
9466fafa 190 struct peer *p; /* Pointer to peer structure */
410c8acf 191 time_t t_exp; /* Expiry time for this keyset */
192 unsigned long sz_exp; /* Data limit for the keyset */
832a2ab6 193 T( unsigned seq; ) /* Sequence number for tracing */
194 unsigned f; /* Various useful flags */
195 gcipher *cin, *cout; /* Keyset ciphers for encryption */
b5c45da1 196 size_t tagsz; /* Length to truncate MAC tags */
832a2ab6 197 gmac *min, *mout; /* Keyset MACs for integrity */
1484d822 198 uint32 oseq; /* Outbound sequence number */
37941236 199 seqwin iseq; /* Inbound sequence number */
410c8acf 200} keyset;
201
832a2ab6 202#define KSF_LISTEN 1u /* Don't encrypt packets yet */
203#define KSF_LINK 2u /* Key is in a linked list */
204
410c8acf 205/* --- Key exchange --- *
206 *
207 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
208 * Protocol has a number of desirable features (e.g., perfect forward
209 * secrecy, and zero-knowledge authentication) which make it attractive for
210 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
211 * Clive Jones.
212 */
213
832a2ab6 214#define KX_NCHAL 16u
832a2ab6 215
216typedef struct kxchal {
217 struct keyexch *kx; /* Pointer back to key exchange */
52c03a2a 218 ge *c; /* Responder's challenge */
219 ge *r; /* My reply to the challenge */
832a2ab6 220 keyset *ks; /* Pointer to temporary keyset */
221 unsigned f; /* Various useful flags */
222 sel_timer t; /* Response timer for challenge */
b5c45da1 223 octet hc[MAXHASHSZ]; /* Hash of his challenge */
de7bd20b 224 octet ck[MAXHASHSZ]; /* His magical check value */
b5c45da1 225 octet hswrq_in[MAXHASHSZ]; /* Inbound switch request message */
226 octet hswok_in[MAXHASHSZ]; /* Inbound switch confirmation */
227 octet hswrq_out[MAXHASHSZ]; /* Outbound switch request message */
228 octet hswok_out[MAXHASHSZ]; /* Outbound switch confirmation */
832a2ab6 229} kxchal;
230
410c8acf 231typedef struct keyexch {
410c8acf 232 struct peer *p; /* Pointer back to the peer */
832a2ab6 233 keyset **ks; /* Peer's list of keysets */
410c8acf 234 unsigned f; /* Various useful flags */
832a2ab6 235 unsigned s; /* Current state in exchange */
410c8acf 236 sel_timer t; /* Timer for next exchange */
52c03a2a 237 ge *kpub; /* Peer's public key */
00e64b67 238 time_t texp_kpub; /* Expiry time for public key */
832a2ab6 239 mp *alpha; /* My temporary secret */
52c03a2a 240 ge *c; /* My challenge */
241 ge *rx; /* The expected response */
832a2ab6 242 unsigned nr; /* Number of extant responses */
410c8acf 243 time_t t_valid; /* When this exchange goes bad */
b5c45da1 244 octet hc[MAXHASHSZ]; /* Hash of my challenge */
832a2ab6 245 kxchal *r[KX_NCHAL]; /* Array of challenges */
410c8acf 246} keyexch;
247
248#define KXF_TIMER 1u /* Waiting for a timer to go off */
00e64b67 249#define KXF_DEAD 2u /* The key-exchanger isn't up */
250#define KXF_PUBKEY 4u /* Key exchanger has a public key */
832a2ab6 251
252enum {
253 KXS_DEAD, /* Uninitialized state (magical) */
254 KXS_CHAL, /* Main answer-challenges state */
255 KXS_COMMIT, /* Committed: send switch request */
256 KXS_SWITCH /* Switched: send confirmation */
257};
410c8acf 258
259/* --- Tunnel structure --- *
260 *
261 * Used to maintain system-specific information about the tunnel interface.
262 */
263
42da2a58 264typedef struct tunnel tunnel;
265struct peer;
110d564e 266
42da2a58 267typedef struct tunnel_ops {
268 const char *name; /* Name of this tunnel driver */
269 void (*init)(void); /* Initializes the system */
270 tunnel *(*create)(struct peer */*p*/); /* Initializes a new tunnel */
271 const char *(*ifname)(tunnel */*t*/); /* Returns tunnel's interface name */
272 void (*inject)(tunnel */*t*/, buf */*b*/); /* Sends packet through if */
273 void (*destroy)(tunnel */*t*/); /* Destroys a tunnel */
274} tunnel_ops;
b9066fbb 275
42da2a58 276#ifndef TUN_INTERNALS
277struct tunnel { const tunnel_ops *ops; };
410c8acf 278#endif
410c8acf 279
832a2ab6 280/* --- Peer statistics --- *
281 *
282 * Contains various interesting and not-so-interesting statistics about a
283 * peer. This is updated by various parts of the code. The format of the
284 * structure isn't considered private, and @p_stats@ returns a pointer to the
285 * statistics block for a given peer.
286 */
287
288typedef struct stats {
289 unsigned long sz_in, sz_out; /* Size of all data in and out */
290 unsigned long sz_kxin, sz_kxout; /* Size of key exchange messages */
291 unsigned long sz_ipin, sz_ipout; /* Size of encapsulated IP packets */
3cdc3f3a 292 time_t t_start, t_last, t_kx; /* Time peer created, last pk, kx */
832a2ab6 293 unsigned long n_reject; /* Number of rejected packets */
294 unsigned long n_in, n_out; /* Number of packets in and out */
295 unsigned long n_kxin, n_kxout; /* Number of key exchange packets */
296 unsigned long n_ipin, n_ipout; /* Number of encrypted packets */
297} stats;
298
410c8acf 299/* --- Peer structure --- *
300 *
301 * The main structure which glues everything else together.
302 */
303
0ba8de86 304typedef struct peerspec {
305 char *name; /* Peer's name */
306 const tunnel_ops *tops; /* Tunnel operations */
307 unsigned long t_ka; /* Keep alive interval */
308 addr sa; /* Socket address to speak to */
309 size_t sasz; /* Socket address size */
310} peerspec;
311
410c8acf 312typedef struct peer {
313 struct peer *next, *prev; /* Links to next and previous */
0ba8de86 314 struct ping *pings; /* Pings we're waiting for */
315 peerspec spec; /* Specifications for this peer */
42da2a58 316 tunnel *t; /* Tunnel for local packets */
64cf2223 317 char *ifname; /* Interface name for tunnel */
410c8acf 318 keyset *ks; /* List head for keysets */
410c8acf 319 buf b; /* Buffer for sending packets */
832a2ab6 320 stats st; /* Statistics */
321 keyexch kx; /* Key exchange protocol block */
0ba8de86 322 sel_timer tka; /* Timer for keepalives */
410c8acf 323} peer;
324
0ba8de86 325typedef struct ping {
326 struct ping *next, *prev; /* Links to next and previous */
327 peer *p; /* Peer so we can free it */
328 unsigned msg; /* Kind of response expected */
329 uint32 id; /* Id so we can recognize response */
330 octet magic[32]; /* Some random data */
331 sel_timer t; /* Timeout for ping */
332 void (*func)(int /*rc*/, void */*arg*/); /* Function to call when done */
333 void *arg; /* Argument for callback */
334} ping;
335
336enum {
337 PING_NONOTIFY = -1,
338 PING_OK = 0,
339 PING_TIMEOUT,
340 PING_PEERDIED,
341 PING_MAX
342};
343
410c8acf 344/* --- Admin structure --- */
345
fd3cf232 346#define OBUFSZ 16384u
347
348typedef struct obuf {
349 struct obuf *next; /* Next buffer in list */
350 char *p_in, *p_out; /* Pointers into the buffer */
351 char buf[OBUFSZ]; /* The actual buffer */
352} obuf;
353
de014da6 354typedef struct oqueue {
355 obuf *hd, *tl; /* Head and tail pointers */
356} oqueue;
357
358struct admin;
359
360typedef struct admin_bgop {
361 struct admin_bgop *next, *prev; /* Links to next and previous */
362 struct admin *a; /* Owner job */
363 char *tag; /* Tag string for messages */
364 void (*cancel)(struct admin_bgop *); /* Destructor function */
365} admin_bgop;
366
37941236 367typedef struct admin_resop {
de014da6 368 admin_bgop bg; /* Background operation header */
37941236 369 char *addr; /* Hostname to be resolved */
de014da6 370 bres_client r; /* Background resolver task */
371 sel_timer t; /* Timer for resolver */
37941236 372 addr sa; /* Socket address */
373 size_t sasz; /* Socket address size */
374 void (*func)(struct admin_resop *, int); /* Handler */
375} admin_resop;
376
377enum { ARES_OK, ARES_FAIL };
378
379typedef struct admin_addop {
380 admin_resop r; /* Name resolution header */
381 peerspec peer; /* Peer pending creation */
de014da6 382} admin_addop;
383
37941236 384typedef struct admin_greetop {
385 admin_resop r; /* Name resolution header */
386 void *c; /* Challenge block */
387 size_t sz; /* Length of challenge */
388} admin_greetop;
389
de014da6 390typedef struct admin_pingop {
391 admin_bgop bg; /* Background operation header */
392 ping ping; /* Ping pending response */
393 struct timeval pingtime; /* Time last ping was sent */
be6a1b7a
MW
394} admin_pingop;
395
396typedef struct admin_service {
397 sym_base _b; /* Hash table base structure */
398 char *version; /* The provided version */
399 struct admin *prov; /* Which client provides me */
400 struct admin_service *next, *prev; /* Client's list of services */
401} admin_service;
de014da6 402
410c8acf 403typedef struct admin {
404 struct admin *next, *prev; /* Links to next and previous */
fd3cf232 405 unsigned f; /* Various useful flags */
060ca767 406 unsigned ref; /* Reference counter */
410c8acf 407#ifndef NTRACE
408 unsigned seq; /* Sequence number for tracing */
409#endif
de014da6 410 oqueue out; /* Output buffer list */
411 oqueue delay; /* Delayed output buffer list */
412 admin_bgop *bg; /* Backgrounded operations */
be6a1b7a 413 admin_service *svcs; /* Which services I provide */
fd3cf232 414 selbuf b; /* Line buffer for commands */
415 sel_file w; /* Selector for write buffering */
410c8acf 416} admin;
417
fd3cf232 418#define AF_DEAD 1u /* Destroy this admin block */
060ca767 419#define AF_CLOSE 2u /* Client closed connection */
3cdc3f3a 420#define AF_NOTE 4u /* Catch notifications */
de014da6 421#define AF_WARN 8u /* Catch warning messages */
3cdc3f3a 422#ifndef NTRACE
de014da6 423 #define AF_TRACE 16u /* Catch tracing */
3cdc3f3a 424#endif
3cdc3f3a 425
426#ifndef NTRACE
427# define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
428#else
429# define AF_ALLMSGS (AF_NOTE | AF_WARN)
430#endif
fd3cf232 431
410c8acf 432/*----- Global variables --------------------------------------------------*/
433
434extern sel_state sel; /* Global I/O event state */
52c03a2a 435extern group *gg; /* The group we work in */
de7bd20b 436extern size_t indexsz; /* Size of exponent for the group */
52c03a2a 437extern mp *kpriv; /* Our private key */
9317aa92 438extern ge *kpub; /* Our public key */
832a2ab6 439extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ];
42da2a58 440extern const tunnel_ops *tunnels[]; /* Table of tunnels (0-term) */
441extern const tunnel_ops *tun_default; /* Default tunnel to use */
410c8acf 442
443#ifndef NTRACE
444extern const trace_opt tr_opts[]; /* Trace options array */
445extern unsigned tr_flags; /* Trace options flags */
446#endif
447
8d0c7a83 448/*----- Other macros ------------------------------------------------------*/
449
450#define TIMER noise_timer(RAND_GLOBAL)
451
410c8acf 452/*----- Key management ----------------------------------------------------*/
453
de014da6 454/* --- @km_reload@ --- *
410c8acf 455 *
456 * Arguments: ---
457 *
458 * Returns: Zero if OK, nonzero to force reloading of keys.
459 *
de014da6 460 * Use: Checks the keyrings to see if they need reloading.
410c8acf 461 */
462
de014da6 463extern int km_reload(void);
410c8acf 464
465/* --- @km_init@ --- *
466 *
467 * Arguments: @const char *kr_priv@ = private keyring file
468 * @const char *kr_pub@ = public keyring file
469 * @const char *tag@ = tag to load
470 *
471 * Returns: ---
472 *
473 * Use: Initializes, and loads the private key.
474 */
475
476extern void km_init(const char */*kr_priv*/, const char */*kr_pub*/,
477 const char */*tag*/);
478
479/* --- @km_getpubkey@ --- *
480 *
481 * Arguments: @const char *tag@ = public key tag to load
52c03a2a 482 * @ge *kpub@ = where to put the public key
00e64b67 483 * @time_t *t_exp@ = where to put the expiry time
410c8acf 484 *
485 * Returns: Zero if OK, nonzero if it failed.
486 *
487 * Use: Fetches a public key from the keyring.
488 */
489
52c03a2a 490extern int km_getpubkey(const char */*tag*/, ge */*kpub*/,
00e64b67 491 time_t */*t_exp*/);
410c8acf 492
493/*----- Key exchange ------------------------------------------------------*/
494
495/* --- @kx_start@ --- *
496 *
497 * Arguments: @keyexch *kx@ = pointer to key exchange context
de014da6 498 * @int forcep@ = nonzero to ignore the quiet timer
410c8acf 499 *
500 * Returns: ---
501 *
502 * Use: Stimulates a key exchange. If a key exchage is in progress,
503 * a new challenge is sent (unless the quiet timer forbids
504 * this); if no exchange is in progress, one is commenced.
505 */
506
de014da6 507extern void kx_start(keyexch */*kx*/, int /*forcep*/);
410c8acf 508
832a2ab6 509/* --- @kx_message@ --- *
410c8acf 510 *
511 * Arguments: @keyexch *kx@ = pointer to key exchange context
832a2ab6 512 * @unsigned msg@ = the message code
513 * @buf *b@ = pointer to buffer containing the packet
410c8acf 514 *
515 * Returns: ---
516 *
832a2ab6 517 * Use: Reads a packet containing key exchange messages and handles
518 * it.
410c8acf 519 */
520
832a2ab6 521extern void kx_message(keyexch */*kx*/, unsigned /*msg*/, buf */*b*/);
410c8acf 522
523/* --- @kx_free@ --- *
524 *
525 * Arguments: @keyexch *kx@ = pointer to key exchange context
526 *
527 * Returns: ---
528 *
529 * Use: Frees everything in a key exchange context.
530 */
531
532extern void kx_free(keyexch */*kx*/);
533
534/* --- @kx_newkeys@ --- *
535 *
536 * Arguments: @keyexch *kx@ = pointer to key exchange context
537 *
538 * Returns: ---
539 *
540 * Use: Informs the key exchange module that its keys may have
541 * changed. If fetching the new keys fails, the peer will be
542 * destroyed, we log messages and struggle along with the old
543 * keys.
544 */
545
546extern void kx_newkeys(keyexch */*kx*/);
547
548/* --- @kx_init@ --- *
549 *
550 * Arguments: @keyexch *kx@ = pointer to key exchange context
551 * @peer *p@ = pointer to peer context
552 * @keyset **ks@ = pointer to keyset list
553 *
554 * Returns: Zero if OK, nonzero if it failed.
555 *
556 * Use: Initializes a key exchange module. The module currently
557 * contains no keys, and will attempt to initiate a key
558 * exchange.
559 */
560
561extern int kx_init(keyexch */*kx*/, peer */*p*/, keyset **/*ks*/);
562
563/*----- Keysets and symmetric cryptography --------------------------------*/
564
832a2ab6 565/* --- @ks_drop@ --- *
566 *
567 * Arguments: @keyset *ks@ = pointer to a keyset
568 *
569 * Returns: ---
570 *
571 * Use: Decrements a keyset's reference counter. If the counter hits
572 * zero, the keyset is freed.
573 */
574
575extern void ks_drop(keyset */*ks*/);
576
577/* --- @ks_gen@ --- *
578 *
579 * Arguments: @const void *k@ = pointer to key material
580 * @size_t x, y, z@ = offsets into key material (see below)
9466fafa 581 * @peer *p@ = pointer to peer information
832a2ab6 582 *
583 * Returns: A pointer to the new keyset.
584 *
585 * Use: Derives a new keyset from the given key material. The
586 * offsets @x@, @y@ and @z@ separate the key material into three
587 * parts. Between the @k@ and @k + x@ is `my' contribution to
588 * the key material; between @k + x@ and @k + y@ is `your'
589 * contribution; and between @k + y@ and @k + z@ is a shared
590 * value we made together. These are used to construct two
591 * pairs of symmetric keys. Each pair consists of an encryption
592 * key and a message authentication key. One pair is used for
593 * outgoing messages, the other for incoming messages.
594 *
595 * The new key is marked so that it won't be selected for output
596 * by @ksl_encrypt@. You can still encrypt data with it by
597 * calling @ks_encrypt@ directly.
598 */
599
600extern keyset *ks_gen(const void */*k*/,
9466fafa 601 size_t /*x*/, size_t /*y*/, size_t /*z*/,
602 peer */*p*/);
832a2ab6 603
604/* --- @ks_tregen@ --- *
605 *
606 * Arguments: @keyset *ks@ = pointer to a keyset
607 *
608 * Returns: The time at which moves ought to be made to replace this key.
609 */
610
611extern time_t ks_tregen(keyset */*ks*/);
612
613/* --- @ks_activate@ --- *
614 *
615 * Arguments: @keyset *ks@ = pointer to a keyset
616 *
617 * Returns: ---
618 *
619 * Use: Activates a keyset, so that it can be used for encrypting
620 * outgoing messages.
621 */
622
623extern void ks_activate(keyset */*ks*/);
624
625/* --- @ks_encrypt@ --- *
626 *
627 * Arguments: @keyset *ks@ = pointer to a keyset
7ed14135 628 * @unsigned ty@ = message type
832a2ab6 629 * @buf *b@ = pointer to input buffer
630 * @buf *bb@ = pointer to output buffer
631 *
632 * Returns: Zero if OK, nonzero if the key needs replacing. If the
633 * encryption failed, the output buffer is broken and zero is
634 * returned.
635 *
636 * Use: Encrypts a block of data using the key. Note that the `key
637 * ought to be replaced' notification is only ever given once
638 * for each key. Also note that this call forces a keyset to be
639 * used even if it's marked as not for data output.
640 */
641
7ed14135 642extern int ks_encrypt(keyset */*ks*/, unsigned /*ty*/,
643 buf */*b*/, buf */*bb*/);
832a2ab6 644
645/* --- @ks_decrypt@ --- *
646 *
647 * Arguments: @keyset *ks@ = pointer to a keyset
7ed14135 648 * @unsigned ty@ = expected type code
832a2ab6 649 * @buf *b@ = pointer to an input buffer
650 * @buf *bb@ = pointer to an output buffer
651 *
652 * Returns: Zero on success, or nonzero if there was some problem.
653 *
654 * Use: Attempts to decrypt a message using a given key. Note that
655 * requesting decryption with a key directly won't clear a
656 * marking that it's not for encryption.
657 */
658
7ed14135 659extern int ks_decrypt(keyset */*ks*/, unsigned /*ty*/,
660 buf */*b*/, buf */*bb*/);
832a2ab6 661
662/* --- @ksl_free@ --- *
410c8acf 663 *
664 * Arguments: @keyset **ksroot@ = pointer to keyset list head
665 *
666 * Returns: ---
667 *
832a2ab6 668 * Use: Frees (releases references to) all of the keys in a keyset.
410c8acf 669 */
670
832a2ab6 671extern void ksl_free(keyset **/*ksroot*/);
410c8acf 672
832a2ab6 673/* --- @ksl_link@ --- *
410c8acf 674 *
675 * Arguments: @keyset **ksroot@ = pointer to keyset list head
832a2ab6 676 * @keyset *ks@ = pointer to a keyset
410c8acf 677 *
678 * Returns: ---
679 *
832a2ab6 680 * Use: Links a keyset into a list. A keyset can only be on one list
681 * at a time. Bad things happen otherwise.
410c8acf 682 */
683
832a2ab6 684extern void ksl_link(keyset **/*ksroot*/, keyset */*ks*/);
410c8acf 685
832a2ab6 686/* --- @ksl_prune@ --- *
410c8acf 687 *
688 * Arguments: @keyset **ksroot@ = pointer to keyset list head
410c8acf 689 *
832a2ab6 690 * Returns: ---
410c8acf 691 *
832a2ab6 692 * Use: Prunes the keyset list by removing keys which mustn't be used
693 * any more.
410c8acf 694 */
695
832a2ab6 696extern void ksl_prune(keyset **/*ksroot*/);
410c8acf 697
832a2ab6 698/* --- @ksl_encrypt@ --- *
410c8acf 699 *
700 * Arguments: @keyset **ksroot@ = pointer to keyset list head
7ed14135 701 * @unsigned ty@ = message type
410c8acf 702 * @buf *b@ = pointer to input buffer
703 * @buf *bb@ = pointer to output buffer
704 *
705 * Returns: Nonzero if a new key is needed.
706 *
707 * Use: Encrypts a packet.
708 */
709
7ed14135 710extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/,
711 buf */*b*/, buf */*bb*/);
410c8acf 712
832a2ab6 713/* --- @ksl_decrypt@ --- *
410c8acf 714 *
715 * Arguments: @keyset **ksroot@ = pointer to keyset list head
7ed14135 716 * @unsigned ty@ = expected type code
410c8acf 717 * @buf *b@ = pointer to input buffer
718 * @buf *bb@ = pointer to output buffer
719 *
720 * Returns: Nonzero if the packet couldn't be decrypted.
721 *
722 * Use: Decrypts a packet.
723 */
724
7ed14135 725extern int ksl_decrypt(keyset **/*ksroot*/, unsigned /*ty*/,
726 buf */*b*/, buf */*bb*/);
410c8acf 727
37941236 728/*----- Challenges --------------------------------------------------------*/
729
730/* --- @c_new@ --- *
731 *
732 * Arguments: @buf *b@ = where to put the challenge
733 *
734 * Returns: Zero if OK, nonzero on error.
735 *
736 * Use: Issues a new challenge.
737 */
738
739extern int c_new(buf */*b*/);
740
741/* --- @c_check@ --- *
742 *
743 * Arguments: @buf *b@ = where to find the challenge
744 *
745 * Returns: Zero if OK, nonzero if it didn't work.
746 *
747 * Use: Checks a challenge. On failure, the buffer is broken.
748 */
749
750extern int c_check(buf */*b*/);
751
410c8acf 752/*----- Administration interface ------------------------------------------*/
753
f43df819
MW
754#define A_END ((char *)0)
755
410c8acf 756/* --- @a_warn@ --- *
757 *
758 * Arguments: @const char *fmt@ = pointer to format string
759 * @...@ = other arguments
760 *
761 * Returns: ---
762 *
763 * Use: Informs all admin connections of a warning.
764 */
765
766extern void a_warn(const char */*fmt*/, ...);
767
3cdc3f3a 768/* --- @a_notify@ --- *
769 *
770 * Arguments: @const char *fmt@ = pointer to format string
771 * @...@ = other arguments
772 *
773 * Returns: ---
774 *
775 * Use: Sends a notification to interested admin connections.
776 */
777
778extern void a_notify(const char */*fmt*/, ...);
779
410c8acf 780/* --- @a_create@ --- *
781 *
782 * Arguments: @int fd_in, fd_out@ = file descriptors to use
3cdc3f3a 783 * @unsigned f@ = initial flags to set
410c8acf 784 *
785 * Returns: ---
786 *
787 * Use: Creates a new admin connection.
788 */
789
3cdc3f3a 790extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
410c8acf 791
792/* --- @a_quit@ --- *
793 *
794 * Arguments: ---
795 *
796 * Returns: ---
797 *
798 * Use: Shuts things down nicely.
799 */
800
801extern void a_quit(void);
802
c511e1f9
MW
803/* --- @a_preselect@ --- *
804 *
805 * Arguments: ---
806 *
807 * Returns: ---
808 *
809 * Use: Informs the admin module that we're about to select again,
810 * and that it should do cleanup things it has delayed until a
811 * `safe' time.
812 */
813
814extern void a_preselect(void);
815
410c8acf 816/* --- @a_daemon@ --- *
817 *
818 * Arguments: ---
819 *
820 * Returns: ---
821 *
822 * Use: Informs the admin module that it's a daemon.
823 */
824
825extern void a_daemon(void);
826
827/* --- @a_init@ --- *
828 *
829 * Arguments: @const char *sock@ = socket name to create
830 *
831 * Returns: ---
832 *
833 * Use: Creates the admin listening socket.
834 */
835
836extern void a_init(const char */*sock*/);
837
838/*----- Peer management ---------------------------------------------------*/
839
840/* --- @p_txstart@ --- *
841 *
842 * Arguments: @peer *p@ = pointer to peer block
843 * @unsigned msg@ = message type code
844 *
845 * Returns: A pointer to a buffer to write to.
846 *
847 * Use: Starts sending to a peer. Only one send can happen at a
848 * time.
849 */
850
851extern buf *p_txstart(peer */*p*/, unsigned /*msg*/);
852
853/* --- @p_txend@ --- *
854 *
855 * Arguments: @peer *p@ = pointer to peer block
856 *
857 * Returns: ---
858 *
859 * Use: Sends a packet to the peer.
860 */
861
862extern void p_txend(peer */*p*/);
863
0ba8de86 864/* --- @p_pingsend@ --- *
865 *
866 * Arguments: @peer *p@ = destination peer
867 * @ping *pg@ = structure to fill in
868 * @unsigned type@ = message type
869 * @unsigned long timeout@ = how long to wait before giving up
870 * @void (*func)(int, void *)@ = callback function
871 * @void *arg@ = argument for callback
872 *
873 * Returns: Zero if successful, nonzero if it failed.
874 *
875 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
876 * if we get an answer within the timeout, or zero if no answer.
877 */
878
879extern int p_pingsend(peer */*p*/, ping */*pg*/, unsigned /*type*/,
880 unsigned long /*timeout*/,
881 void (*/*func*/)(int, void *), void */*arg*/);
882
883/* --- @p_pingdone@ --- *
884 *
885 * Arguments: @ping *p@ = ping structure
886 * @int rc@ = return code to pass on
887 *
888 * Returns: ---
889 *
890 * Use: Disposes of a ping structure, maybe sending a notification.
891 */
892
893extern void p_pingdone(ping */*p*/, int /*rc*/);
894
37941236 895/* --- @p_greet@ --- *
896 *
897 * Arguments: @peer *p@ = peer to send to
898 * @const void *c@ = pointer to challenge
899 * @size_t sz@ = size of challenge
900 *
901 * Returns: ---
902 *
903 * Use: Sends a greeting packet.
904 */
905
906extern void p_greet(peer */*p*/, const void */*c*/, size_t /*sz*/);
907
410c8acf 908/* --- @p_tun@ --- *
909 *
910 * Arguments: @peer *p@ = pointer to peer block
911 * @buf *b@ = buffer containing incoming packet
912 *
913 * Returns: ---
914 *
915 * Use: Handles a packet which needs to be sent to a peer.
916 */
917
918extern void p_tun(peer */*p*/, buf */*b*/);
919
de014da6 920/* --- @p_keyreload@ --- *
921 *
922 * Arguments: ---
923 *
924 * Returns: ---
925 *
926 * Use: Forces a check of the daemon's keyring files.
927 */
928
929extern void p_keyreload(void);
930
410c8acf 931/* --- @p_interval@ --- *
932 *
933 * Arguments: ---
934 *
935 * Returns: ---
936 *
937 * Use: Called periodically to do tidying.
938 */
939
940extern void p_interval(void);
941
832a2ab6 942/* --- @p_stats@ --- *
943 *
944 * Arguments: @peer *p@ = pointer to a peer block
945 *
946 * Returns: A pointer to the peer's statistics.
947 */
948
949extern stats *p_stats(peer */*p*/);
950
410c8acf 951/* --- @p_ifname@ --- *
952 *
953 * Arguments: @peer *p@ = pointer to a peer block
954 *
955 * Returns: A pointer to the peer's interface name.
956 */
957
958extern const char *p_ifname(peer */*p*/);
959
64cf2223
MW
960/* --- @p_setifname@ --- *
961 *
962 * Arguments: @peer *p@ = pointer to a peer block
963 * @const char *name@ = pointer to the new name
964 *
965 * Returns: ---
966 *
967 * Use: Changes the name held for a peer's interface.
968 */
969
970extern void p_setifname(peer */*p*/, const char */*name*/);
971
410c8acf 972/* --- @p_addr@ --- *
973 *
974 * Arguments: @peer *p@ = pointer to a peer block
975 *
976 * Returns: A pointer to the peer's address.
977 */
978
979extern const addr *p_addr(peer */*p*/);
980
981/* --- @p_init@ --- *
982 *
767b36e2 983 * Arguments: @struct in_addr addr@ = address to bind to
984 * @unsigned port@ = port number to listen to
410c8acf 985 *
986 * Returns: ---
987 *
988 * Use: Initializes the peer system; creates the socket.
989 */
990
767b36e2 991extern void p_init(struct in_addr /*addr*/, unsigned /*port*/);
410c8acf 992
993/* --- @p_port@ --- *
994 *
995 * Arguments: ---
996 *
997 * Returns: Port number used for socket.
998 */
999
1000unsigned p_port(void);
1001
1002/* --- @p_create@ --- *
1003 *
0ba8de86 1004 * Arguments: @peerspec *spec@ = information about this peer
410c8acf 1005 *
1006 * Returns: Pointer to the peer block, or null if it failed.
1007 *
1008 * Use: Creates a new named peer block. No peer is actually attached
1009 * by this point.
1010 */
1011
0ba8de86 1012extern peer *p_create(peerspec */*spec*/);
410c8acf 1013
1014/* --- @p_name@ --- *
1015 *
1016 * Arguments: @peer *p@ = pointer to a peer block
1017 *
1018 * Returns: A pointer to the peer's name.
060ca767 1019 *
1020 * Use: Equivalent to @p_spec(p)->name@.
410c8acf 1021 */
1022
1023extern const char *p_name(peer */*p*/);
1024
060ca767 1025/* --- @p_spec@ --- *
1026 *
1027 * Arguments: @peer *p@ = pointer to a peer block
1028 *
1029 * Returns: Pointer to the peer's specification
1030 */
1031
1032extern const peerspec *p_spec(peer */*p*/);
1033
410c8acf 1034/* --- @p_find@ --- *
1035 *
1036 * Arguments: @const char *name@ = name to look up
1037 *
1038 * Returns: Pointer to the peer block, or null if not found.
1039 *
1040 * Use: Finds a peer by name.
1041 */
1042
1043extern peer *p_find(const char */*name*/);
1044
1045/* --- @p_destroy@ --- *
1046 *
1047 * Arguments: @peer *p@ = pointer to a peer
1048 *
1049 * Returns: ---
1050 *
1051 * Use: Destroys a peer.
1052 */
1053
1054extern void p_destroy(peer */*p*/);
1055
1056/* --- @p_first@, @p_next@ --- *
1057 *
1058 * Arguments: @peer *p@ = a peer block
1059 *
1060 * Returns: @peer_first@ returns the first peer in some ordering;
1061 * @peer_next@ returns the peer following a given one in the
1062 * same ordering. Null is returned for the end of the list.
1063 */
1064
1065extern peer *p_first(void);
1066extern peer *p_next(peer */*p*/);
1067
42da2a58 1068/*----- Tunnel drivers ----------------------------------------------------*/
410c8acf 1069
42da2a58 1070#ifdef TUN_LINUX
1071 extern const tunnel_ops tun_linux;
1072#endif
410c8acf 1073
42da2a58 1074#ifdef TUN_UNET
1075 extern const tunnel_ops tun_unet;
1076#endif
410c8acf 1077
42da2a58 1078#ifdef TUN_BSD
1079 extern const tunnel_ops tun_bsd;
1080#endif
410c8acf 1081
42da2a58 1082extern const tunnel_ops tun_slip;
410c8acf 1083
410c8acf 1084/*----- Other handy utilities ---------------------------------------------*/
1085
1086/* --- @mpstr@ --- *
1087 *
1088 * Arguments: @mp *m@ = a multiprecision integer
1089 *
1090 * Returns: A pointer to the integer's textual representation.
1091 *
1092 * Use: Converts a multiprecision integer to a string. Corrupts
832a2ab6 1093 * @buf_t@.
410c8acf 1094 */
1095
1096extern const char *mpstr(mp */*m*/);
1097
52c03a2a 1098/* --- @gestr@ --- *
1099 *
1100 * Arguments: @group *g@ = a group
1101 * @ge *x@ = a group element
1102 *
1103 * Returns: A pointer to the element's textual representation.
1104 *
1105 * Use: Converts a group element to a string. Corrupts
1106 * @buf_t@.
1107 */
1108
1109extern const char *gestr(group */*g*/, ge */*x*/);
1110
832a2ab6 1111/* --- @timestr@ --- *
1112 *
1113 * Arguments: @time_t t@ = a time to convert
1114 *
1115 * Returns: A pointer to a textual representation of the time.
1116 *
1117 * Use: Converts a time to a textual representation. Corrupts
1118 * @buf_t@.
1119 */
1120
1121extern const char *timestr(time_t /*t*/);
1122
42da2a58 1123/* --- @mystrieq@ --- *
1124 *
1125 * Arguments: @const char *x, *y@ = two strings
1126 *
1127 * Returns: True if @x@ and @y are equal, up to case.
1128 */
1129
1130extern int mystrieq(const char */*x*/, const char */*y*/);
1131
37941236 1132/* --- @seq_reset@ --- *
1133 *
1134 * Arguments: @seqwin *s@ = sequence-checking window
1135 *
1136 * Returns: ---
1137 *
1138 * Use: Resets a sequence number window.
1139 */
1140
1141extern void seq_reset(seqwin */*s*/);
1142
1143/* --- @seq_check@ --- *
1144 *
1145 * Arguments: @seqwin *s@ = sequence-checking window
1146 * @uint32 q@ = sequence number to check
f43df819 1147 * @const char *service@ = service to report message from
37941236 1148 *
1149 * Returns: A @SEQ_@ code.
1150 *
1151 * Use: Checks a sequence number against the window, updating things
1152 * as necessary.
1153 */
1154
f43df819 1155extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/);
37941236 1156
e6a3a553
MW
1157/* --- @versioncmp@ --- *
1158 *
1159 * Arguments: @const char *va, *vb@ = two version strings
1160 *
1161 * Returns: Less than, equal to, or greater than zero, according to
1162 * whether @va@ is less than, equal to, or greater than @vb@.
1163 *
1164 * Use: Compares version number strings.
1165 *
1166 * The algorithm is an extension of the Debian version
1167 * comparison algorithm. A version number consists of three
1168 * components:
1169 *
1170 * [EPOCH :] MAIN [- SUB]
1171 *
1172 * The MAIN part may contain colons or hyphens if there is an
1173 * EPOCH or SUB, respectively. Version strings are compared
1174 * componentwise: first epochs, then main parts, and finally
1175 * subparts.
1176 *
1177 * The component comparison is done as follows. First, the
1178 * initial subsequence of nondigit characters is extracted from
1179 * each string, and these are compared lexicographically, using
1180 * ASCII ordering, except that letters precede non-letters. If
1181 * both are the same, an initial sequence of digits is extracted
1182 * from the remaining parts of the version strings, and these
1183 * are compared numerically (an empty sequence being considered
1184 * to have the value zero). This process is repeated until we
1185 * have a winner or until both strings are exhausted.
1186 */
1187
1188extern int versioncmp(const char */*va*/, const char */*vb*/);
1189
410c8acf 1190/*----- That's all, folks -------------------------------------------------*/
1191
1192#ifdef __cplusplus
1193 }
1194#endif
1195
1196#endif