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