Commit | Line | Data |
---|---|---|
410c8acf | 1 | /* -*-c-*- |
410c8acf | 2 | * |
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 | * | |
11ad66c2 MW |
12 | * TrIPE is free software: you can redistribute it and/or modify it under |
13 | * the terms of the GNU General Public License as published by the Free | |
14 | * Software Foundation; either version 3 of the License, or (at your | |
15 | * option) any later version. | |
e04c2d50 | 16 | * |
11ad66c2 MW |
17 | * TrIPE is distributed in the hope that it will be useful, but WITHOUT |
18 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
19 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
20 | * for more details. | |
e04c2d50 | 21 | * |
410c8acf | 22 | * You should have received a copy of the GNU General Public License |
11ad66c2 | 23 | * along with TrIPE. If not, see <https://www.gnu.org/licenses/>. |
410c8acf | 24 | */ |
25 | ||
410c8acf | 26 | #ifndef TRIPE_H |
27 | #define TRIPE_H | |
28 | ||
29 | #ifdef __cplusplus | |
30 | extern "C" { | |
31 | #endif | |
32 | ||
33 | /*----- Header files ------------------------------------------------------*/ | |
34 | ||
73189848 | 35 | #include "config.h" |
36 | ||
410c8acf | 37 | #include <assert.h> |
38 | #include <ctype.h> | |
39 | #include <errno.h> | |
b9066fbb | 40 | #include <limits.h> |
410c8acf | 41 | #include <signal.h> |
42 | #include <stdarg.h> | |
43 | #include <stddef.h> | |
44 | #include <stdio.h> | |
45 | #include <stdlib.h> | |
46 | #include <string.h> | |
47 | #include <time.h> | |
48 | ||
49 | #include <sys/types.h> | |
50 | #include <sys/time.h> | |
51 | #include <unistd.h> | |
52 | #include <fcntl.h> | |
53 | #include <sys/stat.h> | |
388e0319 | 54 | #include <sys/wait.h> |
410c8acf | 55 | |
56 | #include <sys/socket.h> | |
57 | #include <sys/un.h> | |
58 | #include <netinet/in.h> | |
59 | #include <arpa/inet.h> | |
60 | #include <netdb.h> | |
61 | ||
62 | #include <pwd.h> | |
63 | #include <grp.h> | |
64 | ||
65 | #include <mLib/alloc.h> | |
66 | #include <mLib/arena.h> | |
37941236 | 67 | #include <mLib/base64.h> |
410c8acf | 68 | #include <mLib/bres.h> |
37d4c59e | 69 | #include <mLib/codec.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> |
04ed79b8 | 92 | #include <catacomb/ct.h> |
165db1a8 | 93 | |
de8edc7f | 94 | #include <catacomb/chacha.h> |
410c8acf | 95 | #include <catacomb/gcipher.h> |
96 | #include <catacomb/gmac.h> | |
97 | #include <catacomb/grand.h> | |
98 | #include <catacomb/key.h> | |
99 | #include <catacomb/paranoia.h> | |
de8edc7f MW |
100 | #include <catacomb/poly1305.h> |
101 | #include <catacomb/salsa20.h> | |
410c8acf | 102 | |
410c8acf | 103 | #include <catacomb/noise.h> |
104 | #include <catacomb/rand.h> | |
410c8acf | 105 | |
106 | #include <catacomb/mp.h> | |
5b9f3d37 | 107 | #include <catacomb/mpmont.h> |
410c8acf | 108 | #include <catacomb/mprand.h> |
109 | #include <catacomb/dh.h> | |
52c03a2a | 110 | #include <catacomb/ec.h> |
5b9f3d37 | 111 | #include <catacomb/ec-raw.h> |
52c03a2a | 112 | #include <catacomb/ec-keys.h> |
26936c83 MW |
113 | #include <catacomb/x25519.h> |
114 | #include <catacomb/x448.h> | |
410c8acf | 115 | |
388e0319 | 116 | #include "priv.h" |
78698994 | 117 | #include "protocol.h" |
10f681b1 | 118 | #include "slip.h" |
410c8acf | 119 | #include "util.h" |
120 | ||
121 | #undef sun | |
122 | ||
123 | /*----- Magic numbers -----------------------------------------------------*/ | |
124 | ||
410c8acf | 125 | /* --- Trace flags --- */ |
126 | ||
127 | #define T_TUNNEL 1u | |
128 | #define T_PEER 2u | |
129 | #define T_PACKET 4u | |
130 | #define T_ADMIN 8u | |
131 | #define T_CRYPTO 16u | |
132 | #define T_KEYSET 32u | |
133 | #define T_KEYEXCH 64u | |
134 | #define T_KEYMGMT 128u | |
37941236 | 135 | #define T_CHAL 256u |
388e0319 | 136 | /* T_PRIVSEP in priv.h */ |
410c8acf | 137 | |
388e0319 | 138 | #define T_ALL 1023u |
410c8acf | 139 | |
140 | /* --- Units --- */ | |
141 | ||
142 | #define SEC(n) (n##u) | |
143 | #define MIN(n) (n##u * 60u) | |
a06d57a3 | 144 | #define F_2P32 (65536.0*65536.0) |
410c8acf | 145 | #define MEG(n) (n##ul * 1024ul * 1024ul) |
146 | ||
e9fac70c MW |
147 | /* --- Timing parameters --- */ |
148 | ||
149 | #define T_EXP MIN(60) /* Expiry time for a key */ | |
150 | #define T_REGEN MIN(40) /* Regeneration time for a key */ | |
151 | ||
152 | #define T_VALID SEC(20) /* Challenge validity period */ | |
a06d57a3 MW |
153 | #define T_RETRYMIN SEC(2) /* Minimum retry interval */ |
154 | #define T_RETRYMAX MIN(5) /* Maximum retry interval */ | |
155 | #define T_RETRYGROW (5.0/4.0) /* Retry interval growth factor */ | |
156 | ||
157 | #define T_WOBBLE (1.0/3.0) /* Relative timer randomness */ | |
e9fac70c | 158 | |
410c8acf | 159 | /* --- Other things --- */ |
160 | ||
161 | #define PKBUFSZ 65536 | |
162 | ||
832a2ab6 | 163 | /*----- Cipher selections -------------------------------------------------*/ |
164 | ||
a93aacce MW |
165 | typedef struct keyset keyset; |
166 | typedef struct algswitch algswitch; | |
5b9f3d37 | 167 | typedef struct kdata kdata; |
c70a7c5c MW |
168 | typedef struct admin admin; |
169 | ||
5b9f3d37 MW |
170 | typedef struct dhgrp { |
171 | const struct dhops *ops; | |
172 | size_t scsz; | |
173 | } dhgrp; | |
174 | ||
175 | typedef struct dhsc dhsc; | |
176 | typedef struct dhge dhge; | |
177 | ||
178 | enum { | |
179 | DHFMT_STD, /* Fixed-width format, suitable for encryption */ | |
180 | DHFMT_HASH, /* Deterministic format, suitable for hashing */ | |
181 | DHFMT_VAR /* Variable-width-format, mostly a bad idea */ | |
182 | }; | |
183 | ||
c70a7c5c MW |
184 | typedef struct bulkalgs { |
185 | const struct bulkops *ops; | |
186 | } bulkalgs; | |
187 | ||
188 | typedef struct bulkctx { | |
189 | const struct bulkops *ops; | |
190 | } bulkctx; | |
191 | ||
192 | typedef struct bulkchal { | |
193 | const struct bulkops *ops; | |
194 | size_t tagsz; | |
195 | } bulkchal; | |
196 | ||
197 | struct rawkey; | |
a93aacce | 198 | |
5b9f3d37 MW |
199 | typedef struct dhops { |
200 | const char *name; | |
201 | ||
202 | int (*ldpriv)(key_file */*kf*/, key */*k*/, key_data */*d*/, | |
203 | kdata */*kd*/, dstr */*t*/, dstr */*e*/); | |
204 | /* Load a private key from @d@, storing the data in @kd@. The key's | |
f1165777 | 205 | * file and key object are in @kf@ and @k@, mostly in case its |
5b9f3d37 MW |
206 | * attributes are interesting; the key tag is in @t@; errors are |
207 | * reported by writing tokens to @e@ and returning nonzero. | |
208 | */ | |
209 | ||
210 | int (*ldpub)(key_file */*kf*/, key */*k*/, key_data */*d*/, | |
211 | kdata */*kd*/, dstr */*t*/, dstr */*e*/); | |
212 | /* Load a public key from @d@, storing the data in @kd@. The key's | |
f1165777 | 213 | * file and key object are in @kf@ and @k@, mostly in case its |
5b9f3d37 MW |
214 | * attributes are interesting; the key tag is in @t@; errors are |
215 | * reported by writing tokens to @e@ and returning nonzero. | |
216 | */ | |
217 | ||
218 | const char *(*checkgrp)(const dhgrp */*g*/); | |
219 | /* Check that the group is valid; return null on success, or an error | |
220 | * string. | |
221 | */ | |
222 | ||
223 | void (*grpinfo)(const dhgrp */*g*/, admin */*a*/); | |
224 | /* Report on the group to an admin client. */ | |
225 | ||
226 | T( void (*tracegrp)(const dhgrp */*g*/); ) | |
227 | /* Trace a description of the group. */ | |
228 | ||
229 | int (*samegrpp)(const dhgrp */*g*/, const dhgrp */*gg*/); | |
230 | /* Return nonzero if the two group objects represent the same | |
231 | * group. | |
232 | */ | |
233 | ||
234 | void (*freegrp)(dhgrp */*g*/); | |
235 | /* Free a group and the resources it holds. */ | |
236 | ||
237 | dhsc *(*ldsc)(const dhgrp */*g*/, const void */*p*/, size_t /*sz*/); | |
238 | /* Load a scalar from @p@, @sz@ and return it. Return null on | |
239 | * error. | |
240 | */ | |
241 | ||
242 | int (*stsc)(const dhgrp */*g*/, | |
243 | void */*p*/, size_t /*sz*/, const dhsc */*x*/); | |
244 | /* Store a scalar at @p@, @sz@. Return nonzero on error. */ | |
245 | ||
246 | dhsc *(*randsc)(const dhgrp */*g*/); | |
247 | /* Return a random scalar. */ | |
248 | ||
249 | T( const char *(*scstr)(const dhgrp */*g*/, const dhsc */*x*/); ) | |
250 | /* Return a human-readable representation of @x@; @buf_t@ may be used | |
251 | * to hold it. | |
252 | */ | |
253 | ||
254 | void (*freesc)(const dhgrp */*g*/, dhsc */*x*/); | |
255 | /* Free a scalar and the resources it holds. */ | |
256 | ||
257 | dhge *(*ldge)(const dhgrp */*g*/, buf */*b*/, int /*fmt*/); | |
258 | /* Load a group element from @b@, encoded using format @fmt@. Return | |
259 | * null on error. | |
260 | */ | |
261 | ||
262 | int (*stge)(const dhgrp */*g*/, buf */*b*/, | |
263 | const dhge */*Y*/, int /*fmt*/); | |
264 | /* Store a group element in @b@, encoded using format @fmt@. Return | |
265 | * nonzero on error. | |
266 | */ | |
267 | ||
268 | int (*checkge)(const dhgrp */*h*/, const dhge */*Y*/); | |
269 | /* Check a group element for validity. Return zero if everything | |
270 | * checks out; nonzero on failure. | |
271 | */ | |
272 | ||
273 | int (*eq)(const dhgrp */*g*/, const dhge */*Y*/, const dhge */*Z*/); | |
274 | /* Return nonzero if @Y@ and @Z@ are equal. */ | |
275 | ||
276 | dhge *(*mul)(const dhgrp */*g*/, const dhsc */*x*/, const dhge */*Y*/); | |
277 | /* Multiply a group element by a scalar, resulting in a shared-secret | |
278 | * group element. If @y@ is null, then multiply the well-known | |
279 | * generator. | |
280 | */ | |
281 | ||
282 | T( const char *(*gestr)(const dhgrp */*g*/, const dhge */*Y*/); ) | |
283 | /* Return a human-readable representation of @Y@; @buf_t@ may be used | |
284 | * to hold it. | |
285 | */ | |
286 | ||
287 | void (*freege)(const dhgrp */*g*/, dhge */*Y*/); | |
288 | /* Free a group element and the resources it holds. */ | |
289 | ||
290 | } dhops; | |
291 | ||
fddd7fb7 | 292 | typedef struct bulkops { |
a93aacce | 293 | const char *name; |
c70a7c5c MW |
294 | |
295 | bulkalgs *(*getalgs)(const algswitch */*asw*/, dstr */*e*/, | |
296 | key_file */*kf*/, key */*k*/); | |
297 | /* Determine algorithms to use and return a @bulkalgs@ object | |
298 | * representing the decision. On error, write tokens to @e@ and | |
299 | * return null. | |
300 | */ | |
301 | ||
302 | T( void (*tracealgs)(const bulkalgs */*a*/); ) | |
303 | /* Write trace information about the algorithm selection. */ | |
304 | ||
305 | int (*checkalgs)(bulkalgs */*a*/, const algswitch */*asw*/, dstr */*e*/); | |
306 | /* Check that the algorithms in @a@ and @asw@ are acceptable. On | |
307 | * error, write tokens to @e@ and return @-1@; otherwise return zero. | |
308 | */ | |
309 | ||
310 | int (*samealgsp)(const bulkalgs */*a*/, const bulkalgs */*aa*/); | |
311 | /* If @a@ and @aa@ represent the same algorithm selection, return | |
312 | * nonzero; if not, return zero. | |
313 | */ | |
314 | ||
315 | void (*alginfo)(const bulkalgs */*a*/, admin */*adm*/); | |
316 | /* Report on the algorithm selection to an admin client: call | |
317 | * @a_info@ with appropriate key-value pairs. | |
318 | */ | |
319 | ||
320 | size_t (*overhead)(const bulkalgs */*a*/); | |
321 | /* Return the per-packet overhead of the bulk transform, in bytes. */ | |
322 | ||
323 | size_t (*expsz)(const bulkalgs */*a*/); | |
324 | /* Return the total size limit for the bulk transform, in bytes, | |
325 | * after which the keys must no longer be used. | |
326 | */ | |
327 | ||
328 | bulkctx *(*genkeys)(const bulkalgs */*a*/, const struct rawkey */*rk*/); | |
329 | /* Generate session keys and construct and return an appropriate | |
330 | * context for using them, by calling @ks_derive@. | |
331 | */ | |
332 | ||
333 | bulkchal *(*genchal)(const bulkalgs */*a*/); | |
334 | /* Construct and return a challenge issuing and verification | |
335 | * context with a fresh random key. | |
336 | */ | |
337 | ||
338 | void (*freealgs)(bulkalgs */*a*/); | |
339 | /* Release an algorithm selection object. (Associated bulk | |
340 | * encryption contexts and challenge contexts may still exist and | |
341 | * must remain valid.) | |
342 | */ | |
343 | ||
344 | int (*encrypt)(bulkctx */*bc*/, unsigned /*ty*/, | |
345 | buf */*b*/, buf */*bb*/, uint32 /*seq*/); | |
346 | /* Encrypt the packet in @b@, with type @ty@ (which doesn't need | |
347 | * encoding separately) and sequence number @seq@ (which must be | |
348 | * recoverable by @decrypt@), and write the result to @bb@. On | |
349 | * error, return a @KSERR_...@ code and/or break the output buffer. | |
350 | */ | |
351 | ||
352 | int (*decrypt)(bulkctx */*bc*/, unsigned /*ty*/, | |
a93aacce | 353 | buf */*b*/, buf */*bb*/, uint32 */*seq*/); |
c70a7c5c MW |
354 | /* Decrypt the packet in @b@, with type @ty@, writing the result to |
355 | * @bb@ and storing the incoming (claimed) sequence number in @seq@. | |
356 | * On error, return a @KSERR_...@ code. | |
357 | */ | |
358 | ||
359 | void (*freectx)(bulkctx */*a*/); | |
360 | /* Release a bulk encryption context and the resources it holds. */ | |
361 | ||
362 | int (*chaltag)(bulkchal */*bc*/, const void */*m*/, size_t /*msz*/, | |
363 | void */*t*/); | |
364 | /* Calculate a tag for the challenge in @m@, @msz@, and write it to | |
365 | * @t@. Return @-1@ on error, zero on success. | |
366 | */ | |
367 | ||
368 | int (*chalvrf)(bulkchal */*bc*/, const void */*m*/, size_t /*msz*/, | |
369 | const void */*t*/); | |
370 | /* Check the tag @t@ on @m@, @msz@: return zero if the tag is OK, | |
371 | * nonzero if it's bad. | |
372 | */ | |
373 | ||
374 | void (*freechal)(bulkchal */*bc*/); | |
375 | /* Release a challenge context and the resources it holds. */ | |
a93aacce | 376 | |
c70a7c5c | 377 | } bulkops; |
a93aacce MW |
378 | |
379 | struct algswitch { | |
c70a7c5c | 380 | const gchash *h; size_t hashsz; /* Hash function */ |
a93aacce | 381 | const gccipher *mgf; /* Mask-generation function */ |
c70a7c5c | 382 | bulkalgs *bulk; /* Bulk crypto algorithms */ |
a93aacce | 383 | }; |
832a2ab6 | 384 | |
5b9f3d37 | 385 | struct kdata { |
799e58b9 MW |
386 | unsigned ref; /* Reference counter */ |
387 | struct knode *kn; /* Pointer to cache entry */ | |
388 | char *tag; /* Full tag name of the key */ | |
5b9f3d37 MW |
389 | dhgrp *grp; /* The group we work in */ |
390 | dhsc *k; /* The private key (or null) */ | |
391 | dhge *K; /* The public key */ | |
799e58b9 MW |
392 | time_t t_exp; /* Expiry time of the key */ |
393 | algswitch algs; /* Collection of algorithms */ | |
5b9f3d37 | 394 | }; |
799e58b9 MW |
395 | |
396 | typedef struct knode { | |
397 | sym_base _b; /* Symbol table intrusion */ | |
398 | unsigned f; /* Various flags */ | |
399 | #define KNF_BROKEN 1u /* Don't use this key any more */ | |
400 | struct keyhalf *kh; /* Pointer to the home keyhalf */ | |
401 | kdata *kd; /* Pointer to the key data */ | |
402 | } knode; | |
832a2ab6 | 403 | |
b5c45da1 | 404 | #define MAXHASHSZ 64 /* Largest possible hash size */ |
832a2ab6 | 405 | |
b5c45da1 | 406 | #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s)) |
410c8acf | 407 | |
5b9f3d37 | 408 | extern const dhops dhtab[]; |
fddd7fb7 | 409 | extern const bulkops bulktab[]; |
a93aacce | 410 | |
aeeb5611 | 411 | /*----- Data structures ---------------------------------------------------*/ |
410c8acf | 412 | |
413 | /* --- Socket addresses --- * | |
414 | * | |
415 | * A magic union of supported socket addresses. | |
416 | */ | |
417 | ||
418 | typedef union addr { | |
419 | struct sockaddr sa; | |
420 | struct sockaddr_in sin; | |
421 | } addr; | |
422 | ||
c8e02c8a MW |
423 | /* --- Mapping keyed on addresses --- */ |
424 | ||
425 | typedef struct addrmap { | |
426 | hash_table t; | |
427 | size_t load; | |
428 | } addrmap; | |
429 | ||
430 | typedef struct addrmap_base { | |
431 | hash_base b; | |
432 | addr a; | |
433 | } addrmap_base; | |
434 | ||
37941236 | 435 | /* --- Sequence number checking --- */ |
436 | ||
437 | typedef struct seqwin { | |
438 | uint32 seq; /* First acceptable input sequence */ | |
439 | uint32 win; /* Window of acceptable numbers */ | |
440 | } seqwin; | |
441 | ||
442 | #define SEQ_WINSZ 32 /* Bits in sequence number window */ | |
443 | ||
410c8acf | 444 | /* --- A symmetric keyset --- * |
445 | * | |
446 | * A keyset contains a set of symmetric keys for encrypting and decrypting | |
447 | * packets. Keysets are stored in a list, sorted in reverse order of | |
448 | * creation, so that the most recent keyset (the one most likely to be used) | |
449 | * is first. | |
450 | * | |
451 | * Each keyset has a time limit and a data limit. The keyset is destroyed | |
452 | * when either it has existed for too long, or it has been used to encrypt | |
453 | * too much data. New key exchanges are triggered when keys are close to | |
454 | * expiry. | |
455 | */ | |
456 | ||
c70a7c5c MW |
457 | enum { DIR_IN, DIR_OUT, NDIR }; |
458 | ||
a93aacce | 459 | struct keyset { |
410c8acf | 460 | struct keyset *next; /* Next active keyset in the list */ |
832a2ab6 | 461 | unsigned ref; /* Reference count for keyset */ |
9466fafa | 462 | struct peer *p; /* Pointer to peer structure */ |
410c8acf | 463 | time_t t_exp; /* Expiry time for this keyset */ |
383a9d71 | 464 | unsigned long sz_exp, sz_regen; /* Data limits for the keyset */ |
832a2ab6 | 465 | T( unsigned seq; ) /* Sequence number for tracing */ |
466 | unsigned f; /* Various useful flags */ | |
c70a7c5c | 467 | bulkctx *bulk; /* Bulk crypto transform */ |
1484d822 | 468 | uint32 oseq; /* Outbound sequence number */ |
37941236 | 469 | seqwin iseq; /* Inbound sequence number */ |
a93aacce | 470 | }; |
410c8acf | 471 | |
832a2ab6 | 472 | #define KSF_LISTEN 1u /* Don't encrypt packets yet */ |
473 | #define KSF_LINK 2u /* Key is in a linked list */ | |
474 | ||
a50f9a0e MW |
475 | #define KSERR_REGEN -1 /* Regenerate keys */ |
476 | #define KSERR_NOKEYS -2 /* No keys left */ | |
477 | #define KSERR_DECRYPT -3 /* Unable to decrypt message */ | |
12a26b8b MW |
478 | #define KSERR_SEQ -4 /* Incorrect sequence number */ |
479 | #define KSERR_MALFORMED -5 /* Input ciphertext is broken */ | |
a50f9a0e | 480 | |
410c8acf | 481 | /* --- Key exchange --- * |
482 | * | |
483 | * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers | |
484 | * Protocol has a number of desirable features (e.g., perfect forward | |
485 | * secrecy, and zero-knowledge authentication) which make it attractive for | |
486 | * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and | |
487 | * Clive Jones. | |
488 | */ | |
489 | ||
a06d57a3 MW |
490 | typedef struct retry { |
491 | double t; /* Current retry time */ | |
492 | } retry; | |
493 | ||
832a2ab6 | 494 | #define KX_NCHAL 16u |
832a2ab6 | 495 | |
496 | typedef struct kxchal { | |
497 | struct keyexch *kx; /* Pointer back to key exchange */ | |
5b9f3d37 MW |
498 | dhge *C; /* Responder's challenge */ |
499 | dhge *R; /* My reply to the challenge */ | |
832a2ab6 | 500 | keyset *ks; /* Pointer to temporary keyset */ |
501 | unsigned f; /* Various useful flags */ | |
502 | sel_timer t; /* Response timer for challenge */ | |
a06d57a3 | 503 | retry rs; /* Retry state */ |
b5c45da1 | 504 | octet hc[MAXHASHSZ]; /* Hash of his challenge */ |
de7bd20b | 505 | octet ck[MAXHASHSZ]; /* His magical check value */ |
b5c45da1 | 506 | octet hswrq_in[MAXHASHSZ]; /* Inbound switch request message */ |
507 | octet hswok_in[MAXHASHSZ]; /* Inbound switch confirmation */ | |
508 | octet hswrq_out[MAXHASHSZ]; /* Outbound switch request message */ | |
509 | octet hswok_out[MAXHASHSZ]; /* Outbound switch confirmation */ | |
832a2ab6 | 510 | } kxchal; |
511 | ||
410c8acf | 512 | typedef struct keyexch { |
410c8acf | 513 | struct peer *p; /* Pointer back to the peer */ |
35c8b547 MW |
514 | kdata *kpriv; /* Private key and related info */ |
515 | kdata *kpub; /* Peer's public key */ | |
832a2ab6 | 516 | keyset **ks; /* Peer's list of keysets */ |
410c8acf | 517 | unsigned f; /* Various useful flags */ |
832a2ab6 | 518 | unsigned s; /* Current state in exchange */ |
410c8acf | 519 | sel_timer t; /* Timer for next exchange */ |
a06d57a3 | 520 | retry rs; /* Retry state */ |
5b9f3d37 MW |
521 | dhsc *a; /* My temporary secret */ |
522 | dhge *C; /* My challenge */ | |
523 | dhge *RX; /* The expected response */ | |
832a2ab6 | 524 | unsigned nr; /* Number of extant responses */ |
410c8acf | 525 | time_t t_valid; /* When this exchange goes bad */ |
b5c45da1 | 526 | octet hc[MAXHASHSZ]; /* Hash of my challenge */ |
832a2ab6 | 527 | kxchal *r[KX_NCHAL]; /* Array of challenges */ |
410c8acf | 528 | } keyexch; |
529 | ||
530 | #define KXF_TIMER 1u /* Waiting for a timer to go off */ | |
00e64b67 | 531 | #define KXF_DEAD 2u /* The key-exchanger isn't up */ |
532 | #define KXF_PUBKEY 4u /* Key exchanger has a public key */ | |
010e6f63 | 533 | #define KXF_CORK 8u /* Don't send anything yet */ |
832a2ab6 | 534 | |
535 | enum { | |
536 | KXS_DEAD, /* Uninitialized state (magical) */ | |
537 | KXS_CHAL, /* Main answer-challenges state */ | |
538 | KXS_COMMIT, /* Committed: send switch request */ | |
539 | KXS_SWITCH /* Switched: send confirmation */ | |
540 | }; | |
410c8acf | 541 | |
542 | /* --- Tunnel structure --- * | |
543 | * | |
544 | * Used to maintain system-specific information about the tunnel interface. | |
545 | */ | |
546 | ||
42da2a58 | 547 | typedef struct tunnel tunnel; |
548 | struct peer; | |
110d564e | 549 | |
42da2a58 | 550 | typedef struct tunnel_ops { |
551 | const char *name; /* Name of this tunnel driver */ | |
388e0319 MW |
552 | unsigned flags; /* Various interesting flags */ |
553 | #define TUNF_PRIVOPEN 1u /* Need helper to open file */ | |
42da2a58 | 554 | void (*init)(void); /* Initializes the system */ |
eb5f3fea | 555 | tunnel *(*create)(struct peer */*p*/, int /*fd*/, char **/*ifn*/); |
72917fe7 MW |
556 | /* Initializes a new tunnel */ |
557 | void (*setifname)(tunnel */*t*/, const char */*ifn*/); | |
558 | /* Notifies ifname change */ | |
42da2a58 | 559 | void (*inject)(tunnel */*t*/, buf */*b*/); /* Sends packet through if */ |
560 | void (*destroy)(tunnel */*t*/); /* Destroys a tunnel */ | |
561 | } tunnel_ops; | |
b9066fbb | 562 | |
42da2a58 | 563 | #ifndef TUN_INTERNALS |
564 | struct tunnel { const tunnel_ops *ops; }; | |
410c8acf | 565 | #endif |
410c8acf | 566 | |
832a2ab6 | 567 | /* --- Peer statistics --- * |
568 | * | |
569 | * Contains various interesting and not-so-interesting statistics about a | |
570 | * peer. This is updated by various parts of the code. The format of the | |
571 | * structure isn't considered private, and @p_stats@ returns a pointer to the | |
572 | * statistics block for a given peer. | |
573 | */ | |
574 | ||
575 | typedef struct stats { | |
576 | unsigned long sz_in, sz_out; /* Size of all data in and out */ | |
577 | unsigned long sz_kxin, sz_kxout; /* Size of key exchange messages */ | |
578 | unsigned long sz_ipin, sz_ipout; /* Size of encapsulated IP packets */ | |
3cdc3f3a | 579 | time_t t_start, t_last, t_kx; /* Time peer created, last pk, kx */ |
832a2ab6 | 580 | unsigned long n_reject; /* Number of rejected packets */ |
581 | unsigned long n_in, n_out; /* Number of packets in and out */ | |
582 | unsigned long n_kxin, n_kxout; /* Number of key exchange packets */ | |
583 | unsigned long n_ipin, n_ipout; /* Number of encrypted packets */ | |
584 | } stats; | |
585 | ||
410c8acf | 586 | /* --- Peer structure --- * |
587 | * | |
588 | * The main structure which glues everything else together. | |
589 | */ | |
590 | ||
0ba8de86 | 591 | typedef struct peerspec { |
592 | char *name; /* Peer's name */ | |
fe2a5dcf | 593 | char *privtag; /* Private key tag */ |
48b84569 | 594 | char *tag; /* Public key tag */ |
0ba8de86 | 595 | const tunnel_ops *tops; /* Tunnel operations */ |
596 | unsigned long t_ka; /* Keep alive interval */ | |
597 | addr sa; /* Socket address to speak to */ | |
8743c776 | 598 | unsigned f; /* Flags for the peer */ |
6411163d MW |
599 | #define PSF_KXMASK 255u /* Key-exchange flags to set */ |
600 | #define PSF_MOBILE 256u /* Address may change rapidly */ | |
0ba8de86 | 601 | } peerspec; |
602 | ||
c8e02c8a MW |
603 | typedef struct peer_byname { |
604 | sym_base _b; | |
605 | struct peer *p; | |
606 | } peer_byname; | |
607 | ||
608 | typedef struct peer_byaddr { | |
609 | addrmap_base _b; | |
610 | struct peer *p; | |
611 | } peer_byaddr; | |
612 | ||
410c8acf | 613 | typedef struct peer { |
c8e02c8a MW |
614 | peer_byname *byname; /* Lookup-by-name block */ |
615 | peer_byaddr *byaddr; /* Lookup-by-address block */ | |
0ba8de86 | 616 | struct ping *pings; /* Pings we're waiting for */ |
617 | peerspec spec; /* Specifications for this peer */ | |
42da2a58 | 618 | tunnel *t; /* Tunnel for local packets */ |
64cf2223 | 619 | char *ifname; /* Interface name for tunnel */ |
410c8acf | 620 | keyset *ks; /* List head for keysets */ |
410c8acf | 621 | buf b; /* Buffer for sending packets */ |
832a2ab6 | 622 | stats st; /* Statistics */ |
623 | keyexch kx; /* Key exchange protocol block */ | |
0ba8de86 | 624 | sel_timer tka; /* Timer for keepalives */ |
410c8acf | 625 | } peer; |
626 | ||
c8e02c8a MW |
627 | typedef struct peer_iter { sym_iter i; } peer_iter; |
628 | ||
0ba8de86 | 629 | typedef struct ping { |
630 | struct ping *next, *prev; /* Links to next and previous */ | |
631 | peer *p; /* Peer so we can free it */ | |
632 | unsigned msg; /* Kind of response expected */ | |
633 | uint32 id; /* Id so we can recognize response */ | |
634 | octet magic[32]; /* Some random data */ | |
635 | sel_timer t; /* Timeout for ping */ | |
636 | void (*func)(int /*rc*/, void */*arg*/); /* Function to call when done */ | |
637 | void *arg; /* Argument for callback */ | |
638 | } ping; | |
639 | ||
640 | enum { | |
641 | PING_NONOTIFY = -1, | |
642 | PING_OK = 0, | |
643 | PING_TIMEOUT, | |
644 | PING_PEERDIED, | |
645 | PING_MAX | |
646 | }; | |
647 | ||
410c8acf | 648 | /* --- Admin structure --- */ |
649 | ||
fd3cf232 | 650 | #define OBUFSZ 16384u |
651 | ||
652 | typedef struct obuf { | |
653 | struct obuf *next; /* Next buffer in list */ | |
654 | char *p_in, *p_out; /* Pointers into the buffer */ | |
655 | char buf[OBUFSZ]; /* The actual buffer */ | |
656 | } obuf; | |
657 | ||
de014da6 | 658 | typedef struct oqueue { |
659 | obuf *hd, *tl; /* Head and tail pointers */ | |
660 | } oqueue; | |
661 | ||
662 | struct admin; | |
663 | ||
664 | typedef struct admin_bgop { | |
665 | struct admin_bgop *next, *prev; /* Links to next and previous */ | |
666 | struct admin *a; /* Owner job */ | |
667 | char *tag; /* Tag string for messages */ | |
668 | void (*cancel)(struct admin_bgop *); /* Destructor function */ | |
669 | } admin_bgop; | |
670 | ||
37941236 | 671 | typedef struct admin_resop { |
de014da6 | 672 | admin_bgop bg; /* Background operation header */ |
37941236 | 673 | char *addr; /* Hostname to be resolved */ |
de014da6 | 674 | bres_client r; /* Background resolver task */ |
675 | sel_timer t; /* Timer for resolver */ | |
37941236 | 676 | addr sa; /* Socket address */ |
677 | size_t sasz; /* Socket address size */ | |
678 | void (*func)(struct admin_resop *, int); /* Handler */ | |
679 | } admin_resop; | |
680 | ||
681 | enum { ARES_OK, ARES_FAIL }; | |
682 | ||
683 | typedef struct admin_addop { | |
684 | admin_resop r; /* Name resolution header */ | |
685 | peerspec peer; /* Peer pending creation */ | |
de014da6 | 686 | } admin_addop; |
687 | ||
688 | typedef struct admin_pingop { | |
689 | admin_bgop bg; /* Background operation header */ | |
690 | ping ping; /* Ping pending response */ | |
691 | struct timeval pingtime; /* Time last ping was sent */ | |
be6a1b7a MW |
692 | } admin_pingop; |
693 | ||
694 | typedef struct admin_service { | |
695 | sym_base _b; /* Hash table base structure */ | |
696 | char *version; /* The provided version */ | |
697 | struct admin *prov; /* Which client provides me */ | |
698 | struct admin_service *next, *prev; /* Client's list of services */ | |
699 | } admin_service; | |
de014da6 | 700 | |
5d46c0f8 MW |
701 | typedef struct admin_svcop { |
702 | admin_bgop bg; /* Background operation header */ | |
703 | struct admin *prov; /* Client servicing this job */ | |
cc921fba | 704 | unsigned index; /* This job's index */ |
5d46c0f8 MW |
705 | struct admin_svcop *next, *prev; /* Links for provider's jobs */ |
706 | } admin_svcop; | |
707 | ||
708 | typedef struct admin_jobentry { | |
709 | unsigned short seq; /* Zero if unused */ | |
710 | union { | |
711 | admin_svcop *op; /* Operation, if slot in use, ... */ | |
712 | uint32 next; /* ... or index of next free slot */ | |
713 | } u; | |
714 | } admin_jobentry; | |
715 | ||
716 | typedef struct admin_jobtable { | |
717 | uint32 n, sz; /* Used slots and table size */ | |
718 | admin_svcop *active; /* List of active jobs */ | |
719 | uint32 free; /* Index of first free slot */ | |
720 | admin_jobentry *v; /* And the big array of entries */ | |
721 | } admin_jobtable; | |
722 | ||
c70a7c5c | 723 | struct admin { |
410c8acf | 724 | struct admin *next, *prev; /* Links to next and previous */ |
fd3cf232 | 725 | unsigned f; /* Various useful flags */ |
060ca767 | 726 | unsigned ref; /* Reference counter */ |
410c8acf | 727 | #ifndef NTRACE |
728 | unsigned seq; /* Sequence number for tracing */ | |
729 | #endif | |
de014da6 | 730 | oqueue out; /* Output buffer list */ |
731 | oqueue delay; /* Delayed output buffer list */ | |
732 | admin_bgop *bg; /* Backgrounded operations */ | |
be6a1b7a | 733 | admin_service *svcs; /* Which services I provide */ |
5d46c0f8 | 734 | admin_jobtable j; /* Table of outstanding jobs */ |
fd3cf232 | 735 | selbuf b; /* Line buffer for commands */ |
736 | sel_file w; /* Selector for write buffering */ | |
c70a7c5c | 737 | }; |
410c8acf | 738 | |
fd3cf232 | 739 | #define AF_DEAD 1u /* Destroy this admin block */ |
060ca767 | 740 | #define AF_CLOSE 2u /* Client closed connection */ |
3cdc3f3a | 741 | #define AF_NOTE 4u /* Catch notifications */ |
de014da6 | 742 | #define AF_WARN 8u /* Catch warning messages */ |
3cdc3f3a | 743 | #ifndef NTRACE |
de014da6 | 744 | #define AF_TRACE 16u /* Catch tracing */ |
3cdc3f3a | 745 | #endif |
46dde080 | 746 | #define AF_FOREGROUND 32u /* Quit server when client closes */ |
3cdc3f3a | 747 | |
748 | #ifndef NTRACE | |
749 | # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN) | |
750 | #else | |
751 | # define AF_ALLMSGS (AF_NOTE | AF_WARN) | |
752 | #endif | |
fd3cf232 | 753 | |
410c8acf | 754 | /*----- Global variables --------------------------------------------------*/ |
755 | ||
756 | extern sel_state sel; /* Global I/O event state */ | |
a4b808b0 | 757 | extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ], buf_u[PKBUFSZ]; |
42da2a58 | 758 | extern const tunnel_ops *tunnels[]; /* Table of tunnels (0-term) */ |
759 | extern const tunnel_ops *tun_default; /* Default tunnel to use */ | |
799e58b9 MW |
760 | extern kdata *master; /* Default private key */ |
761 | extern const char *tag_priv; /* Default private key tag */ | |
410c8acf | 762 | |
763 | #ifndef NTRACE | |
764 | extern const trace_opt tr_opts[]; /* Trace options array */ | |
765 | extern unsigned tr_flags; /* Trace options flags */ | |
766 | #endif | |
767 | ||
8d0c7a83 | 768 | /*----- Other macros ------------------------------------------------------*/ |
769 | ||
36b9f99a MW |
770 | #define QUICKRAND \ |
771 | do { rand_quick(RAND_GLOBAL); noise_timer(RAND_GLOBAL); } while (0) | |
8d0c7a83 | 772 | |
410c8acf | 773 | /*----- Key management ----------------------------------------------------*/ |
774 | ||
799e58b9 MW |
775 | /* --- @km_init@ --- * |
776 | * | |
777 | * Arguments: @const char *privkr@ = private keyring file | |
778 | * @const char *pubkr@ = public keyring file | |
779 | * @const char *ptag@ = default private-key tag | |
780 | * | |
781 | * Returns: --- | |
782 | * | |
783 | * Use: Initializes the key-management machinery, loading the | |
784 | * keyrings and so on. | |
785 | */ | |
786 | ||
787 | extern void km_init(const char */*privkr*/, const char */*pubkr*/, | |
788 | const char */*ptag*/); | |
789 | ||
de014da6 | 790 | /* --- @km_reload@ --- * |
410c8acf | 791 | * |
792 | * Arguments: --- | |
793 | * | |
794 | * Returns: Zero if OK, nonzero to force reloading of keys. | |
795 | * | |
de014da6 | 796 | * Use: Checks the keyrings to see if they need reloading. |
410c8acf | 797 | */ |
798 | ||
de014da6 | 799 | extern int km_reload(void); |
410c8acf | 800 | |
799e58b9 MW |
801 | /* --- @km_findpub@, @km_findpriv@ --- * |
802 | * | |
803 | * Arguments: @const char *tag@ = key tag to load | |
804 | * | |
805 | * Returns: Pointer to the kdata object if successful, or null on error. | |
806 | * | |
807 | * Use: Fetches a public or private key from the keyring. | |
808 | */ | |
809 | ||
810 | extern kdata *km_findpub(const char */*tag*/); | |
811 | extern kdata *km_findpriv(const char */*tag*/); | |
812 | ||
813 | /* --- @km_samealgsp@ --- * | |
814 | * | |
815 | * Arguments: @const kdata *kdx, *kdy@ = two key data objects | |
410c8acf | 816 | * |
799e58b9 MW |
817 | * Returns: Nonzero if their two algorithm selections are the same. |
818 | * | |
819 | * Use: Checks sameness of algorithm selections: used to ensure that | |
820 | * peers are using sensible algorithms. | |
821 | */ | |
822 | ||
823 | extern int km_samealgsp(const kdata */*kdx*/, const kdata */*kdy*/); | |
824 | ||
825 | /* --- @km_ref@ --- * | |
410c8acf | 826 | * |
799e58b9 | 827 | * Arguments: @kdata *kd@ = pointer to the kdata object |
410c8acf | 828 | * |
829 | * Returns: --- | |
830 | * | |
799e58b9 | 831 | * Use: Claim a new reference to a kdata object. |
410c8acf | 832 | */ |
833 | ||
799e58b9 | 834 | extern void km_ref(kdata */*kd*/); |
410c8acf | 835 | |
799e58b9 | 836 | /* --- @km_unref@ --- * |
410c8acf | 837 | * |
799e58b9 | 838 | * Arguments: @kdata *kd@ = pointer to the kdata object |
410c8acf | 839 | * |
799e58b9 | 840 | * Returns: --- |
410c8acf | 841 | * |
799e58b9 | 842 | * Use: Releases a reference to a kdata object. |
410c8acf | 843 | */ |
844 | ||
799e58b9 MW |
845 | extern void km_unref(kdata */*kd*/); |
846 | ||
847 | /* --- @km_tag@ --- * | |
848 | * | |
849 | * Arguments: @kdata *kd@ - pointer to the kdata object | |
850 | * | |
851 | * Returns: A pointer to the short tag by which the kdata was loaded. | |
410c8acf | 852 | */ |
853 | ||
799e58b9 | 854 | extern const char *km_tag(kdata */*kd*/); |
410c8acf | 855 | |
856 | /*----- Key exchange ------------------------------------------------------*/ | |
857 | ||
858 | /* --- @kx_start@ --- * | |
859 | * | |
860 | * Arguments: @keyexch *kx@ = pointer to key exchange context | |
de014da6 | 861 | * @int forcep@ = nonzero to ignore the quiet timer |
410c8acf | 862 | * |
863 | * Returns: --- | |
864 | * | |
865 | * Use: Stimulates a key exchange. If a key exchage is in progress, | |
866 | * a new challenge is sent (unless the quiet timer forbids | |
867 | * this); if no exchange is in progress, one is commenced. | |
868 | */ | |
869 | ||
de014da6 | 870 | extern void kx_start(keyexch */*kx*/, int /*forcep*/); |
410c8acf | 871 | |
832a2ab6 | 872 | /* --- @kx_message@ --- * |
410c8acf | 873 | * |
874 | * Arguments: @keyexch *kx@ = pointer to key exchange context | |
832a2ab6 | 875 | * @unsigned msg@ = the message code |
876 | * @buf *b@ = pointer to buffer containing the packet | |
410c8acf | 877 | * |
878 | * Returns: --- | |
879 | * | |
832a2ab6 | 880 | * Use: Reads a packet containing key exchange messages and handles |
881 | * it. | |
410c8acf | 882 | */ |
883 | ||
832a2ab6 | 884 | extern void kx_message(keyexch */*kx*/, unsigned /*msg*/, buf */*b*/); |
410c8acf | 885 | |
886 | /* --- @kx_free@ --- * | |
887 | * | |
888 | * Arguments: @keyexch *kx@ = pointer to key exchange context | |
889 | * | |
890 | * Returns: --- | |
891 | * | |
892 | * Use: Frees everything in a key exchange context. | |
893 | */ | |
894 | ||
895 | extern void kx_free(keyexch */*kx*/); | |
896 | ||
897 | /* --- @kx_newkeys@ --- * | |
898 | * | |
899 | * Arguments: @keyexch *kx@ = pointer to key exchange context | |
900 | * | |
901 | * Returns: --- | |
902 | * | |
903 | * Use: Informs the key exchange module that its keys may have | |
904 | * changed. If fetching the new keys fails, the peer will be | |
905 | * destroyed, we log messages and struggle along with the old | |
906 | * keys. | |
907 | */ | |
908 | ||
909 | extern void kx_newkeys(keyexch */*kx*/); | |
910 | ||
911 | /* --- @kx_init@ --- * | |
912 | * | |
913 | * Arguments: @keyexch *kx@ = pointer to key exchange context | |
914 | * @peer *p@ = pointer to peer context | |
915 | * @keyset **ks@ = pointer to keyset list | |
010e6f63 | 916 | * @unsigned f@ = various useful flags |
410c8acf | 917 | * |
918 | * Returns: Zero if OK, nonzero if it failed. | |
919 | * | |
920 | * Use: Initializes a key exchange module. The module currently | |
921 | * contains no keys, and will attempt to initiate a key | |
922 | * exchange. | |
923 | */ | |
924 | ||
010e6f63 MW |
925 | extern int kx_init(keyexch */*kx*/, peer */*p*/, |
926 | keyset **/*ks*/, unsigned /*f*/); | |
410c8acf | 927 | |
928 | /*----- Keysets and symmetric cryptography --------------------------------*/ | |
929 | ||
832a2ab6 | 930 | /* --- @ks_drop@ --- * |
931 | * | |
932 | * Arguments: @keyset *ks@ = pointer to a keyset | |
933 | * | |
934 | * Returns: --- | |
935 | * | |
936 | * Use: Decrements a keyset's reference counter. If the counter hits | |
937 | * zero, the keyset is freed. | |
938 | */ | |
939 | ||
940 | extern void ks_drop(keyset */*ks*/); | |
941 | ||
c70a7c5c MW |
942 | /* --- @ks_derivekey@ --- * |
943 | * | |
944 | * Arguments: @octet *k@ = pointer to an output buffer of at least | |
945 | * @MAXHASHSZ@ bytes | |
946 | * @size_t ksz@ = actual size wanted (for tracing) | |
947 | * @const struct rawkey *rk@ = a raw key, as passed into | |
948 | * @genkeys@ | |
949 | * @int dir@ = direction for the key (@DIR_IN@ or @DIR_OUT@) | |
950 | * @const char *what@ = label for the key (input to derivation) | |
951 | * | |
952 | * Returns: --- | |
953 | * | |
954 | * Use: Derives a session key, for use on incoming or outgoing data. | |
955 | * This function is part of a private protocol between @ks_gen@ | |
956 | * and the bulk crypto transform @genkeys@ operation. | |
957 | */ | |
958 | ||
959 | extern void ks_derivekey(octet */*k*/, size_t /*ksz*/, | |
960 | const struct rawkey */*rk*/, | |
961 | int /*dir*/, const char */*what*/); | |
962 | ||
832a2ab6 | 963 | /* --- @ks_gen@ --- * |
964 | * | |
965 | * Arguments: @const void *k@ = pointer to key material | |
966 | * @size_t x, y, z@ = offsets into key material (see below) | |
9466fafa | 967 | * @peer *p@ = pointer to peer information |
832a2ab6 | 968 | * |
969 | * Returns: A pointer to the new keyset. | |
970 | * | |
971 | * Use: Derives a new keyset from the given key material. The | |
972 | * offsets @x@, @y@ and @z@ separate the key material into three | |
973 | * parts. Between the @k@ and @k + x@ is `my' contribution to | |
974 | * the key material; between @k + x@ and @k + y@ is `your' | |
975 | * contribution; and between @k + y@ and @k + z@ is a shared | |
976 | * value we made together. These are used to construct two | |
ba487ab5 MW |
977 | * collections of symmetric keys: one for outgoing messages, the |
978 | * other for incoming messages. | |
832a2ab6 | 979 | * |
980 | * The new key is marked so that it won't be selected for output | |
981 | * by @ksl_encrypt@. You can still encrypt data with it by | |
982 | * calling @ks_encrypt@ directly. | |
983 | */ | |
984 | ||
985 | extern keyset *ks_gen(const void */*k*/, | |
9466fafa | 986 | size_t /*x*/, size_t /*y*/, size_t /*z*/, |
987 | peer */*p*/); | |
832a2ab6 | 988 | |
832a2ab6 | 989 | /* --- @ks_activate@ --- * |
990 | * | |
991 | * Arguments: @keyset *ks@ = pointer to a keyset | |
992 | * | |
993 | * Returns: --- | |
994 | * | |
995 | * Use: Activates a keyset, so that it can be used for encrypting | |
996 | * outgoing messages. | |
997 | */ | |
998 | ||
999 | extern void ks_activate(keyset */*ks*/); | |
1000 | ||
1001 | /* --- @ks_encrypt@ --- * | |
1002 | * | |
1003 | * Arguments: @keyset *ks@ = pointer to a keyset | |
7ed14135 | 1004 | * @unsigned ty@ = message type |
832a2ab6 | 1005 | * @buf *b@ = pointer to input buffer |
1006 | * @buf *bb@ = pointer to output buffer | |
1007 | * | |
a50f9a0e MW |
1008 | * Returns: Zero if successful; @KSERR_REGEN@ if we should negotiate a |
1009 | * new key; @KSERR_NOKEYS@ if the key is not usable. Also | |
1010 | * returns zero if there was insufficient buffer (but the output | |
1011 | * buffer is broken in this case). | |
832a2ab6 | 1012 | * |
1013 | * Use: Encrypts a block of data using the key. Note that the `key | |
1014 | * ought to be replaced' notification is only ever given once | |
1015 | * for each key. Also note that this call forces a keyset to be | |
1016 | * used even if it's marked as not for data output. | |
a93aacce MW |
1017 | * |
1018 | * The encryption transform is permitted to corrupt @buf_u@ for | |
1019 | * its own purposes. Neither the source nor destination should | |
1020 | * be within @buf_u@; and callers mustn't expect anything stored | |
1021 | * in @buf_u@ to still | |
832a2ab6 | 1022 | */ |
1023 | ||
7ed14135 | 1024 | extern int ks_encrypt(keyset */*ks*/, unsigned /*ty*/, |
1025 | buf */*b*/, buf */*bb*/); | |
832a2ab6 | 1026 | |
1027 | /* --- @ks_decrypt@ --- * | |
1028 | * | |
1029 | * Arguments: @keyset *ks@ = pointer to a keyset | |
7ed14135 | 1030 | * @unsigned ty@ = expected type code |
832a2ab6 | 1031 | * @buf *b@ = pointer to an input buffer |
1032 | * @buf *bb@ = pointer to an output buffer | |
1033 | * | |
a50f9a0e MW |
1034 | * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns |
1035 | * zero if there was insufficient buffer (but the output buffer | |
1036 | * is broken in this case). | |
832a2ab6 | 1037 | * |
1038 | * Use: Attempts to decrypt a message using a given key. Note that | |
1039 | * requesting decryption with a key directly won't clear a | |
1040 | * marking that it's not for encryption. | |
a93aacce MW |
1041 | * |
1042 | * The decryption transform is permitted to corrupt @buf_u@ for | |
1043 | * its own purposes. Neither the source nor destination should | |
1044 | * be within @buf_u@; and callers mustn't expect anything stored | |
1045 | * in @buf_u@ to still | |
832a2ab6 | 1046 | */ |
1047 | ||
7ed14135 | 1048 | extern int ks_decrypt(keyset */*ks*/, unsigned /*ty*/, |
1049 | buf */*b*/, buf */*bb*/); | |
832a2ab6 | 1050 | |
1051 | /* --- @ksl_free@ --- * | |
410c8acf | 1052 | * |
1053 | * Arguments: @keyset **ksroot@ = pointer to keyset list head | |
1054 | * | |
1055 | * Returns: --- | |
1056 | * | |
832a2ab6 | 1057 | * Use: Frees (releases references to) all of the keys in a keyset. |
410c8acf | 1058 | */ |
1059 | ||
832a2ab6 | 1060 | extern void ksl_free(keyset **/*ksroot*/); |
410c8acf | 1061 | |
832a2ab6 | 1062 | /* --- @ksl_link@ --- * |
410c8acf | 1063 | * |
1064 | * Arguments: @keyset **ksroot@ = pointer to keyset list head | |
832a2ab6 | 1065 | * @keyset *ks@ = pointer to a keyset |
410c8acf | 1066 | * |
1067 | * Returns: --- | |
1068 | * | |
832a2ab6 | 1069 | * Use: Links a keyset into a list. A keyset can only be on one list |
1070 | * at a time. Bad things happen otherwise. | |
410c8acf | 1071 | */ |
1072 | ||
832a2ab6 | 1073 | extern void ksl_link(keyset **/*ksroot*/, keyset */*ks*/); |
410c8acf | 1074 | |
832a2ab6 | 1075 | /* --- @ksl_prune@ --- * |
410c8acf | 1076 | * |
1077 | * Arguments: @keyset **ksroot@ = pointer to keyset list head | |
410c8acf | 1078 | * |
832a2ab6 | 1079 | * Returns: --- |
410c8acf | 1080 | * |
832a2ab6 | 1081 | * Use: Prunes the keyset list by removing keys which mustn't be used |
1082 | * any more. | |
410c8acf | 1083 | */ |
1084 | ||
832a2ab6 | 1085 | extern void ksl_prune(keyset **/*ksroot*/); |
410c8acf | 1086 | |
832a2ab6 | 1087 | /* --- @ksl_encrypt@ --- * |
410c8acf | 1088 | * |
1089 | * Arguments: @keyset **ksroot@ = pointer to keyset list head | |
7ed14135 | 1090 | * @unsigned ty@ = message type |
410c8acf | 1091 | * @buf *b@ = pointer to input buffer |
1092 | * @buf *bb@ = pointer to output buffer | |
1093 | * | |
a50f9a0e MW |
1094 | * Returns: Zero if successful; @KSERR_REGEN@ if it's time to negotiate a |
1095 | * new key; @KSERR_NOKEYS@ if there are no suitable keys | |
1096 | * available. Also returns zero if there was insufficient | |
1097 | * buffer space (but the output buffer is broken in this case). | |
410c8acf | 1098 | * |
1099 | * Use: Encrypts a packet. | |
1100 | */ | |
1101 | ||
7ed14135 | 1102 | extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/, |
1103 | buf */*b*/, buf */*bb*/); | |
410c8acf | 1104 | |
832a2ab6 | 1105 | /* --- @ksl_decrypt@ --- * |
410c8acf | 1106 | * |
1107 | * Arguments: @keyset **ksroot@ = pointer to keyset list head | |
7ed14135 | 1108 | * @unsigned ty@ = expected type code |
410c8acf | 1109 | * @buf *b@ = pointer to input buffer |
1110 | * @buf *bb@ = pointer to output buffer | |
1111 | * | |
a50f9a0e MW |
1112 | * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns |
1113 | * zero if there was insufficient buffer (but the output buffer | |
1114 | * is broken in this case). | |
410c8acf | 1115 | * |
1116 | * Use: Decrypts a packet. | |
1117 | */ | |
1118 | ||
7ed14135 | 1119 | extern int ksl_decrypt(keyset **/*ksroot*/, unsigned /*ty*/, |
1120 | buf */*b*/, buf */*bb*/); | |
410c8acf | 1121 | |
37941236 | 1122 | /*----- Challenges --------------------------------------------------------*/ |
1123 | ||
1124 | /* --- @c_new@ --- * | |
1125 | * | |
1126 | * Arguments: @buf *b@ = where to put the challenge | |
1127 | * | |
1128 | * Returns: Zero if OK, nonzero on error. | |
1129 | * | |
1130 | * Use: Issues a new challenge. | |
1131 | */ | |
1132 | ||
1133 | extern int c_new(buf */*b*/); | |
1134 | ||
1135 | /* --- @c_check@ --- * | |
1136 | * | |
1137 | * Arguments: @buf *b@ = where to find the challenge | |
1138 | * | |
1139 | * Returns: Zero if OK, nonzero if it didn't work. | |
1140 | * | |
1141 | * Use: Checks a challenge. On failure, the buffer is broken. | |
1142 | */ | |
1143 | ||
1144 | extern int c_check(buf */*b*/); | |
1145 | ||
410c8acf | 1146 | /*----- Administration interface ------------------------------------------*/ |
1147 | ||
f43df819 MW |
1148 | #define A_END ((char *)0) |
1149 | ||
7f73baaf MW |
1150 | /* --- @a_vformat@ --- * |
1151 | * | |
1152 | * Arguments: @dstr *d@ = where to leave the formatted message | |
1153 | * @const char *fmt@ = pointer to format string | |
b730d38c | 1154 | * @va_list *ap@ = arguments in list |
7f73baaf MW |
1155 | * |
1156 | * Returns: --- | |
1157 | * | |
1158 | * Use: Main message token formatting driver. The arguments are | |
1159 | * interleaved formatting tokens and their parameters, finally | |
1160 | * terminated by an entry @A_END@. | |
1161 | * | |
1162 | * Tokens recognized: | |
1163 | * | |
1164 | * * "*..." ... -- pretokenized @dstr_putf@-like string | |
1165 | * | |
1166 | * * "?ADDR" SOCKADDR -- a socket address, to be converted | |
1167 | * | |
1168 | * * "?B64" BUFFER SIZE -- binary data to be base64-encoded | |
1169 | * | |
1170 | * * "?TOKENS" VECTOR -- null-terminated vector of tokens | |
1171 | * | |
1172 | * * "?PEER" PEER -- peer's name | |
1173 | * | |
1174 | * * "?ERRNO" ERRNO -- system error code | |
1175 | * | |
1176 | * * "[!]..." ... -- @dstr_putf@-like string as single token | |
1177 | */ | |
1178 | ||
b730d38c | 1179 | extern void a_vformat(dstr */*d*/, const char */*fmt*/, va_list */*ap*/); |
7f73baaf | 1180 | |
f241e36c MW |
1181 | /* --- @a_format@ --- * |
1182 | * | |
1183 | * Arguments: @dstr *d@ = where to leave the formatted message | |
1184 | * @const char *fmt@ = pointer to format string | |
1185 | * | |
1186 | * Returns: --- | |
1187 | * | |
1188 | * Use: Writes a tokenized message into a string, for later | |
1189 | * presentation. | |
1190 | */ | |
1191 | ||
ddb384f1 | 1192 | extern void EXECL_LIKE(0) a_format(dstr */*d*/, const char */*fmt*/, ...); |
f241e36c | 1193 | |
fe182f61 MW |
1194 | /* --- @a_info@ --- * |
1195 | * | |
1196 | * Arguments: @admin *a@ = connection | |
1197 | * @const char *fmt@ = format string | |
1198 | * @...@ = other arguments | |
1199 | * | |
1200 | * Returns: --- | |
1201 | * | |
1202 | * Use: Report information to an admin client. | |
1203 | */ | |
1204 | ||
1205 | extern void EXECL_LIKE(0) a_info(admin */*a*/, const char */*fmt*/, ...); | |
1206 | ||
410c8acf | 1207 | /* --- @a_warn@ --- * |
1208 | * | |
1209 | * Arguments: @const char *fmt@ = pointer to format string | |
1210 | * @...@ = other arguments | |
1211 | * | |
1212 | * Returns: --- | |
1213 | * | |
1214 | * Use: Informs all admin connections of a warning. | |
1215 | */ | |
1216 | ||
ddb384f1 | 1217 | extern void EXECL_LIKE(0) a_warn(const char */*fmt*/, ...); |
410c8acf | 1218 | |
3cdc3f3a | 1219 | /* --- @a_notify@ --- * |
1220 | * | |
1221 | * Arguments: @const char *fmt@ = pointer to format string | |
1222 | * @...@ = other arguments | |
1223 | * | |
1224 | * Returns: --- | |
1225 | * | |
1226 | * Use: Sends a notification to interested admin connections. | |
1227 | */ | |
1228 | ||
ddb384f1 | 1229 | extern void EXECL_LIKE(0) a_notify(const char */*fmt*/, ...); |
3cdc3f3a | 1230 | |
410c8acf | 1231 | /* --- @a_create@ --- * |
1232 | * | |
1233 | * Arguments: @int fd_in, fd_out@ = file descriptors to use | |
3cdc3f3a | 1234 | * @unsigned f@ = initial flags to set |
410c8acf | 1235 | * |
1236 | * Returns: --- | |
1237 | * | |
1238 | * Use: Creates a new admin connection. | |
1239 | */ | |
1240 | ||
3cdc3f3a | 1241 | extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/); |
410c8acf | 1242 | |
1243 | /* --- @a_quit@ --- * | |
1244 | * | |
1245 | * Arguments: --- | |
1246 | * | |
1247 | * Returns: --- | |
1248 | * | |
1249 | * Use: Shuts things down nicely. | |
1250 | */ | |
1251 | ||
1252 | extern void a_quit(void); | |
1253 | ||
c511e1f9 MW |
1254 | /* --- @a_preselect@ --- * |
1255 | * | |
1256 | * Arguments: --- | |
1257 | * | |
1258 | * Returns: --- | |
1259 | * | |
1260 | * Use: Informs the admin module that we're about to select again, | |
1261 | * and that it should do cleanup things it has delayed until a | |
1262 | * `safe' time. | |
1263 | */ | |
1264 | ||
1265 | extern void a_preselect(void); | |
1266 | ||
410c8acf | 1267 | /* --- @a_daemon@ --- * |
1268 | * | |
1269 | * Arguments: --- | |
1270 | * | |
1271 | * Returns: --- | |
1272 | * | |
1273 | * Use: Informs the admin module that it's a daemon. | |
1274 | */ | |
1275 | ||
1276 | extern void a_daemon(void); | |
1277 | ||
1278 | /* --- @a_init@ --- * | |
1279 | * | |
1280 | * Arguments: @const char *sock@ = socket name to create | |
aa2405e8 MW |
1281 | * @uid_t u@ = user to own the socket |
1282 | * @gid_t g@ = group to own the socket | |
a9279e37 | 1283 | * @mode_t m@ = permissions to set on the socket |
410c8acf | 1284 | * |
1285 | * Returns: --- | |
1286 | * | |
1287 | * Use: Creates the admin listening socket. | |
1288 | */ | |
1289 | ||
a9279e37 MW |
1290 | extern void a_init(const char */*sock*/, |
1291 | uid_t /*u*/, gid_t /*g*/, mode_t /*m*/); | |
410c8acf | 1292 | |
c8e02c8a MW |
1293 | /*----- Mapping with addresses as keys ------------------------------------*/ |
1294 | ||
1295 | /* --- @am_create@ --- * | |
1296 | * | |
1297 | * Arguments: @addrmap *m@ = pointer to map | |
1298 | * | |
1299 | * Returns: --- | |
1300 | * | |
1301 | * Use: Create an address map, properly set up. | |
1302 | */ | |
1303 | ||
1304 | extern void am_create(addrmap */*m*/); | |
1305 | ||
1306 | /* --- @am_destroy@ --- * | |
1307 | * | |
1308 | * Arguments: @addrmap *m@ = pointer to map | |
1309 | * | |
1310 | * Returns: --- | |
1311 | * | |
1312 | * Use: Destroy an address map, throwing away all the entries. | |
1313 | */ | |
1314 | ||
1315 | extern void am_destroy(addrmap */*m*/); | |
1316 | ||
1317 | /* --- @am_find@ --- * | |
1318 | * | |
1319 | * Arguments: @addrmap *m@ = pointer to map | |
1320 | * @const addr *a@ = address to look up | |
1321 | * @size_t sz@ = size of block to allocate | |
1322 | * @unsigned *f@ = where to store flags | |
1323 | * | |
1324 | * Returns: Pointer to found item, or null. | |
1325 | * | |
1326 | * Use: Finds a record with the given IP address, set @*f@ nonzero | |
1327 | * and returns it. If @sz@ is zero, and no match was found, | |
1328 | * return null; otherwise allocate a new block of @sz@ bytes, | |
1329 | * clear @*f@ to zero and return the block pointer. | |
1330 | */ | |
1331 | ||
1332 | extern void *am_find(addrmap */*m*/, const addr */*a*/, | |
1333 | size_t /*sz*/, unsigned */*f*/); | |
1334 | ||
1335 | /* --- @am_remove@ --- * | |
1336 | * | |
1337 | * Arguments: @addrmap *m@ = pointer to map | |
1338 | * @void *i@ = pointer to the item | |
1339 | * | |
1340 | * Returns: --- | |
1341 | * | |
1342 | * Use: Removes an item from the map. | |
1343 | */ | |
1344 | ||
1345 | extern void am_remove(addrmap */*m*/, void */*i*/); | |
1346 | ||
388e0319 MW |
1347 | /*----- Privilege separation ----------------------------------------------*/ |
1348 | ||
1349 | /* --- @ps_trace@ --- * | |
1350 | * | |
1351 | * Arguments: @unsigned mask@ = trace mask to check | |
1352 | * @const char *fmt@ = message format | |
1353 | * @...@ = values for placeholders | |
1354 | * | |
1355 | * Returns: --- | |
1356 | * | |
1357 | * Use: Writes a trace message. | |
1358 | */ | |
1359 | ||
ddb384f1 MW |
1360 | T( extern void PRINTF_LIKE(2, 3) |
1361 | ps_trace(unsigned /*mask*/, const char */*fmt*/, ...); ) | |
388e0319 MW |
1362 | |
1363 | /* --- @ps_warn@ --- * | |
1364 | * | |
1365 | * Arguments: @const char *fmt@ = message format | |
1366 | * @...@ = values for placeholders | |
1367 | * | |
1368 | * Returns: --- | |
1369 | * | |
1370 | * Use: Writes a warning message. | |
1371 | */ | |
1372 | ||
ddb384f1 | 1373 | extern void PRINTF_LIKE(1, 2) ps_warn(const char */*fmt*/, ...); |
388e0319 MW |
1374 | |
1375 | /* --- @ps_tunfd@ --- * | |
1376 | * | |
1377 | * Arguments: @const tunnel_ops *tops@ = pointer to tunnel operations | |
1378 | * @char **ifn@ = where to put the interface name | |
1379 | * | |
1380 | * Returns: The file descriptor, or @-1@ on error. | |
1381 | * | |
1382 | * Use: Fetches a file descriptor for a tunnel driver. | |
1383 | */ | |
1384 | ||
1385 | extern int ps_tunfd(const tunnel_ops */*tops*/, char **/*ifn*/); | |
1386 | ||
1387 | /* --- @ps_split@ --- * | |
1388 | * | |
1389 | * Arguments: @int detachp@ = whether to detach the child from its terminal | |
1390 | * | |
1391 | * Returns: --- | |
1392 | * | |
1393 | * Use: Separates off the privileged tunnel-opening service from the | |
1394 | * rest of the server. | |
1395 | */ | |
1396 | ||
1397 | extern void ps_split(int /*detachp*/); | |
1398 | ||
1399 | /* --- @ps_quit@ --- * | |
1400 | * | |
1401 | * Arguments: --- | |
1402 | * | |
1403 | * Returns: --- | |
1404 | * | |
1405 | * Use: Detaches from the helper process. | |
1406 | */ | |
1407 | ||
1408 | extern void ps_quit(void); | |
1409 | ||
410c8acf | 1410 | /*----- Peer management ---------------------------------------------------*/ |
1411 | ||
23bbe601 MW |
1412 | /* --- @p_updateaddr@ --- * |
1413 | * | |
1414 | * Arguments: @peer *p@ = pointer to peer block | |
1415 | * @const addr *a@ = address to associate with this peer | |
1416 | * | |
1417 | * Returns: Zero if the address was changed; @+1@ if it was already | |
1418 | * right. | |
1419 | * | |
1420 | * Use: Updates our idea of @p@'s address. | |
1421 | */ | |
1422 | ||
1423 | extern int p_updateaddr(peer */*p*/, const addr */*a*/); | |
1424 | ||
410c8acf | 1425 | /* --- @p_txstart@ --- * |
1426 | * | |
1427 | * Arguments: @peer *p@ = pointer to peer block | |
1428 | * @unsigned msg@ = message type code | |
1429 | * | |
1430 | * Returns: A pointer to a buffer to write to. | |
1431 | * | |
1432 | * Use: Starts sending to a peer. Only one send can happen at a | |
1433 | * time. | |
1434 | */ | |
1435 | ||
1436 | extern buf *p_txstart(peer */*p*/, unsigned /*msg*/); | |
1437 | ||
1438 | /* --- @p_txend@ --- * | |
1439 | * | |
1440 | * Arguments: @peer *p@ = pointer to peer block | |
1441 | * | |
1442 | * Returns: --- | |
1443 | * | |
1444 | * Use: Sends a packet to the peer. | |
1445 | */ | |
1446 | ||
1447 | extern void p_txend(peer */*p*/); | |
1448 | ||
0ba8de86 | 1449 | /* --- @p_pingsend@ --- * |
1450 | * | |
1451 | * Arguments: @peer *p@ = destination peer | |
1452 | * @ping *pg@ = structure to fill in | |
1453 | * @unsigned type@ = message type | |
1454 | * @unsigned long timeout@ = how long to wait before giving up | |
1455 | * @void (*func)(int, void *)@ = callback function | |
1456 | * @void *arg@ = argument for callback | |
1457 | * | |
1458 | * Returns: Zero if successful, nonzero if it failed. | |
1459 | * | |
1460 | * Use: Sends a ping to a peer. Call @func@ with a nonzero argument | |
1461 | * if we get an answer within the timeout, or zero if no answer. | |
1462 | */ | |
1463 | ||
1464 | extern int p_pingsend(peer */*p*/, ping */*pg*/, unsigned /*type*/, | |
1465 | unsigned long /*timeout*/, | |
1466 | void (*/*func*/)(int, void *), void */*arg*/); | |
1467 | ||
1468 | /* --- @p_pingdone@ --- * | |
1469 | * | |
1470 | * Arguments: @ping *p@ = ping structure | |
1471 | * @int rc@ = return code to pass on | |
1472 | * | |
1473 | * Returns: --- | |
1474 | * | |
1475 | * Use: Disposes of a ping structure, maybe sending a notification. | |
1476 | */ | |
1477 | ||
1478 | extern void p_pingdone(ping */*p*/, int /*rc*/); | |
1479 | ||
37941236 | 1480 | /* --- @p_greet@ --- * |
1481 | * | |
1482 | * Arguments: @peer *p@ = peer to send to | |
1483 | * @const void *c@ = pointer to challenge | |
1484 | * @size_t sz@ = size of challenge | |
1485 | * | |
1486 | * Returns: --- | |
1487 | * | |
1488 | * Use: Sends a greeting packet. | |
1489 | */ | |
1490 | ||
1491 | extern void p_greet(peer */*p*/, const void */*c*/, size_t /*sz*/); | |
1492 | ||
410c8acf | 1493 | /* --- @p_tun@ --- * |
1494 | * | |
1495 | * Arguments: @peer *p@ = pointer to peer block | |
1496 | * @buf *b@ = buffer containing incoming packet | |
1497 | * | |
1498 | * Returns: --- | |
1499 | * | |
1500 | * Use: Handles a packet which needs to be sent to a peer. | |
1501 | */ | |
1502 | ||
1503 | extern void p_tun(peer */*p*/, buf */*b*/); | |
1504 | ||
de014da6 | 1505 | /* --- @p_keyreload@ --- * |
1506 | * | |
1507 | * Arguments: --- | |
1508 | * | |
1509 | * Returns: --- | |
1510 | * | |
1511 | * Use: Forces a check of the daemon's keyring files. | |
1512 | */ | |
1513 | ||
1514 | extern void p_keyreload(void); | |
1515 | ||
410c8acf | 1516 | /* --- @p_interval@ --- * |
1517 | * | |
1518 | * Arguments: --- | |
1519 | * | |
1520 | * Returns: --- | |
1521 | * | |
1522 | * Use: Called periodically to do tidying. | |
1523 | */ | |
1524 | ||
1525 | extern void p_interval(void); | |
1526 | ||
832a2ab6 | 1527 | /* --- @p_stats@ --- * |
1528 | * | |
1529 | * Arguments: @peer *p@ = pointer to a peer block | |
1530 | * | |
1531 | * Returns: A pointer to the peer's statistics. | |
1532 | */ | |
1533 | ||
1534 | extern stats *p_stats(peer */*p*/); | |
1535 | ||
410c8acf | 1536 | /* --- @p_ifname@ --- * |
1537 | * | |
1538 | * Arguments: @peer *p@ = pointer to a peer block | |
1539 | * | |
1540 | * Returns: A pointer to the peer's interface name. | |
1541 | */ | |
1542 | ||
1543 | extern const char *p_ifname(peer */*p*/); | |
1544 | ||
64cf2223 MW |
1545 | /* --- @p_setifname@ --- * |
1546 | * | |
1547 | * Arguments: @peer *p@ = pointer to a peer block | |
1548 | * @const char *name@ = pointer to the new name | |
1549 | * | |
1550 | * Returns: --- | |
1551 | * | |
1552 | * Use: Changes the name held for a peer's interface. | |
1553 | */ | |
1554 | ||
1555 | extern void p_setifname(peer */*p*/, const char */*name*/); | |
1556 | ||
410c8acf | 1557 | /* --- @p_addr@ --- * |
1558 | * | |
1559 | * Arguments: @peer *p@ = pointer to a peer block | |
1560 | * | |
1561 | * Returns: A pointer to the peer's address. | |
1562 | */ | |
1563 | ||
1564 | extern const addr *p_addr(peer */*p*/); | |
1565 | ||
1566 | /* --- @p_init@ --- * | |
1567 | * | |
767b36e2 | 1568 | * Arguments: @struct in_addr addr@ = address to bind to |
1569 | * @unsigned port@ = port number to listen to | |
410c8acf | 1570 | * |
1571 | * Returns: --- | |
1572 | * | |
1573 | * Use: Initializes the peer system; creates the socket. | |
1574 | */ | |
1575 | ||
767b36e2 | 1576 | extern void p_init(struct in_addr /*addr*/, unsigned /*port*/); |
410c8acf | 1577 | |
1578 | /* --- @p_port@ --- * | |
1579 | * | |
1580 | * Arguments: --- | |
1581 | * | |
1582 | * Returns: Port number used for socket. | |
1583 | */ | |
1584 | ||
1585 | unsigned p_port(void); | |
1586 | ||
1587 | /* --- @p_create@ --- * | |
1588 | * | |
0ba8de86 | 1589 | * Arguments: @peerspec *spec@ = information about this peer |
410c8acf | 1590 | * |
1591 | * Returns: Pointer to the peer block, or null if it failed. | |
1592 | * | |
1593 | * Use: Creates a new named peer block. No peer is actually attached | |
1594 | * by this point. | |
1595 | */ | |
1596 | ||
0ba8de86 | 1597 | extern peer *p_create(peerspec */*spec*/); |
410c8acf | 1598 | |
1599 | /* --- @p_name@ --- * | |
1600 | * | |
1601 | * Arguments: @peer *p@ = pointer to a peer block | |
1602 | * | |
1603 | * Returns: A pointer to the peer's name. | |
060ca767 | 1604 | * |
1605 | * Use: Equivalent to @p_spec(p)->name@. | |
410c8acf | 1606 | */ |
1607 | ||
1608 | extern const char *p_name(peer */*p*/); | |
1609 | ||
48b84569 MW |
1610 | /* --- @p_tag@ --- * |
1611 | * | |
1612 | * Arguments: @peer *p@ = pointer to a peer block | |
1613 | * | |
1614 | * Returns: A pointer to the peer's public key tag. | |
1615 | */ | |
1616 | ||
1617 | extern const char *p_tag(peer */*p*/); | |
1618 | ||
fe2a5dcf MW |
1619 | /* --- @p_privtag@ --- * |
1620 | * | |
1621 | * Arguments: @peer *p@ = pointer to a peer block | |
1622 | * | |
1623 | * Returns: A pointer to the peer's private key tag. | |
1624 | */ | |
1625 | ||
1626 | extern const char *p_privtag(peer */*p*/); | |
1627 | ||
060ca767 | 1628 | /* --- @p_spec@ --- * |
1629 | * | |
1630 | * Arguments: @peer *p@ = pointer to a peer block | |
1631 | * | |
1632 | * Returns: Pointer to the peer's specification | |
1633 | */ | |
1634 | ||
1635 | extern const peerspec *p_spec(peer */*p*/); | |
1636 | ||
c8e02c8a MW |
1637 | /* --- @p_findbyaddr@ --- * |
1638 | * | |
1639 | * Arguments: @const addr *a@ = address to look up | |
1640 | * | |
1641 | * Returns: Pointer to the peer block, or null if not found. | |
1642 | * | |
1643 | * Use: Finds a peer by address. | |
1644 | */ | |
1645 | ||
1646 | extern peer *p_findbyaddr(const addr */*a*/); | |
1647 | ||
410c8acf | 1648 | /* --- @p_find@ --- * |
1649 | * | |
1650 | * Arguments: @const char *name@ = name to look up | |
1651 | * | |
1652 | * Returns: Pointer to the peer block, or null if not found. | |
1653 | * | |
1654 | * Use: Finds a peer by name. | |
1655 | */ | |
1656 | ||
1657 | extern peer *p_find(const char */*name*/); | |
1658 | ||
1659 | /* --- @p_destroy@ --- * | |
1660 | * | |
1661 | * Arguments: @peer *p@ = pointer to a peer | |
1662 | * | |
1663 | * Returns: --- | |
1664 | * | |
1665 | * Use: Destroys a peer. | |
1666 | */ | |
1667 | ||
1668 | extern void p_destroy(peer */*p*/); | |
1669 | ||
c8e02c8a MW |
1670 | /* --- @FOREACH_PEER@ --- * |
1671 | * | |
1672 | * Arguments: @p@ = name to bind to each peer | |
1673 | * @stuff@ = thing to do for each item | |
1674 | * | |
1675 | * Use: Does something for each current peer. | |
1676 | */ | |
1677 | ||
1678 | #define FOREACH_PEER(p, stuff) do { \ | |
1679 | peer_iter i_; \ | |
1680 | peer *p; \ | |
46401b81 | 1681 | for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) stuff \ |
c8e02c8a MW |
1682 | } while (0) |
1683 | ||
1684 | /* --- @p_mkiter@ --- * | |
1685 | * | |
1686 | * Arguments: @peer_iter *i@ = pointer to an iterator | |
1687 | * | |
1688 | * Returns: --- | |
1689 | * | |
1690 | * Use: Initializes the iterator. | |
1691 | */ | |
1692 | ||
1693 | extern void p_mkiter(peer_iter */*i*/); | |
1694 | ||
1695 | /* --- @p_next@ --- * | |
1696 | * | |
1697 | * Arguments: @peer_iter *i@ = pointer to an iterator | |
410c8acf | 1698 | * |
c8e02c8a | 1699 | * Returns: Next peer, or null if at the end. |
410c8acf | 1700 | * |
c8e02c8a | 1701 | * Use: Returns the next peer. |
410c8acf | 1702 | */ |
1703 | ||
c8e02c8a | 1704 | extern peer *p_next(peer_iter */*i*/); |
410c8acf | 1705 | |
42da2a58 | 1706 | /*----- Tunnel drivers ----------------------------------------------------*/ |
410c8acf | 1707 | |
42da2a58 | 1708 | #ifdef TUN_LINUX |
1709 | extern const tunnel_ops tun_linux; | |
1710 | #endif | |
410c8acf | 1711 | |
42da2a58 | 1712 | #ifdef TUN_UNET |
1713 | extern const tunnel_ops tun_unet; | |
1714 | #endif | |
410c8acf | 1715 | |
42da2a58 | 1716 | #ifdef TUN_BSD |
1717 | extern const tunnel_ops tun_bsd; | |
1718 | #endif | |
410c8acf | 1719 | |
42da2a58 | 1720 | extern const tunnel_ops tun_slip; |
410c8acf | 1721 | |
410c8acf | 1722 | /*----- Other handy utilities ---------------------------------------------*/ |
1723 | ||
832a2ab6 | 1724 | /* --- @timestr@ --- * |
1725 | * | |
1726 | * Arguments: @time_t t@ = a time to convert | |
1727 | * | |
1728 | * Returns: A pointer to a textual representation of the time. | |
1729 | * | |
1730 | * Use: Converts a time to a textual representation. Corrupts | |
a4b808b0 | 1731 | * @buf_u@. |
832a2ab6 | 1732 | */ |
1733 | ||
1734 | extern const char *timestr(time_t /*t*/); | |
1735 | ||
42da2a58 | 1736 | /* --- @mystrieq@ --- * |
1737 | * | |
1738 | * Arguments: @const char *x, *y@ = two strings | |
1739 | * | |
1740 | * Returns: True if @x@ and @y are equal, up to case. | |
1741 | */ | |
1742 | ||
1743 | extern int mystrieq(const char */*x*/, const char */*y*/); | |
1744 | ||
cb2c2bfc MW |
1745 | /* --- @addrsz@ --- * |
1746 | * | |
1747 | * Arguments: @const addr *a@ = a network address | |
1748 | * | |
1749 | * Returns: The size of the address, for passing into the sockets API. | |
1750 | */ | |
1751 | ||
1752 | extern socklen_t addrsz(const addr */*a*/); | |
1753 | ||
37941236 | 1754 | /* --- @seq_reset@ --- * |
1755 | * | |
1756 | * Arguments: @seqwin *s@ = sequence-checking window | |
1757 | * | |
1758 | * Returns: --- | |
1759 | * | |
1760 | * Use: Resets a sequence number window. | |
1761 | */ | |
1762 | ||
1763 | extern void seq_reset(seqwin */*s*/); | |
1764 | ||
1765 | /* --- @seq_check@ --- * | |
1766 | * | |
1767 | * Arguments: @seqwin *s@ = sequence-checking window | |
1768 | * @uint32 q@ = sequence number to check | |
f43df819 | 1769 | * @const char *service@ = service to report message from |
37941236 | 1770 | * |
1771 | * Returns: A @SEQ_@ code. | |
1772 | * | |
1773 | * Use: Checks a sequence number against the window, updating things | |
1774 | * as necessary. | |
1775 | */ | |
1776 | ||
f43df819 | 1777 | extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/); |
37941236 | 1778 | |
410c8acf | 1779 | /*----- That's all, folks -------------------------------------------------*/ |
1780 | ||
1781 | #ifdef __cplusplus | |
1782 | } | |
1783 | #endif | |
1784 | ||
1785 | #endif |