site logging: Use [v]slilog_part in slog
[secnet] / site.c
CommitLineData
2fe58dfd
SE
1/* site.c - manage communication with a remote network site */
2
469fd1d9
SE
3/* The 'site' code doesn't know anything about the structure of the
4 packets it's transmitting. In fact, under the new netlink
5 configuration scheme it doesn't need to know anything at all about
6 IP addresses, except how to contact its peer. This means it could
7 potentially be used to tunnel other protocols too (IPv6, IPX, plain
8 old Ethernet frames) if appropriate netlink code can be written
9 (and that ought not to be too hard, eg. using the TUN/TAP device to
10 pretend to be an Ethernet interface). */
11
ff05a229
SE
12/* At some point in the future the netlink code will be asked for
13 configuration information to go in the PING/PONG packets at the end
14 of the key exchange. */
15
8689b3a9 16#include "secnet.h"
2fe58dfd 17#include <stdio.h>
469fd1d9 18#include <string.h>
fe5e9cc4 19#include <limits.h>
58650a70 20#include <assert.h>
8689b3a9 21#include <sys/socket.h>
2fe58dfd 22
8689b3a9 23#include <sys/mman.h>
2fe58dfd 24#include "util.h"
59635212 25#include "unaligned.h"
ff05a229 26#include "magic.h"
2fe58dfd
SE
27
28#define SETUP_BUFFER_LEN 2048
29
e7f8ec2a
IJ
30#define DEFAULT_KEY_LIFETIME (3600*1000) /* [ms] */
31#define DEFAULT_KEY_RENEGOTIATE_GAP (5*60*1000) /* [ms] */
2fe58dfd 32#define DEFAULT_SETUP_RETRIES 5
e7f8ec2a
IJ
33#define DEFAULT_SETUP_RETRY_INTERVAL (2*1000) /* [ms] */
34#define DEFAULT_WAIT_TIME (20*1000) /* [ms] */
e57264d6
IJ
35
36#define DEFAULT_MOBILE_KEY_LIFETIME (2*24*3600*1000) /* [ms] */
37#define DEFAULT_MOBILE_KEY_RENEGOTIATE_GAP (12*3600*1000) /* [ms] */
38#define DEFAULT_MOBILE_SETUP_RETRIES 30
39#define DEFAULT_MOBILE_SETUP_RETRY_INTERVAL (1*1000) /* [ms] */
40#define DEFAULT_MOBILE_WAIT_TIME (10*1000) /* [ms] */
41
446353cd
IJ
42#define DEFAULT_MOBILE_PEER_EXPIRY (2*60) /* [s] */
43#define DEFAULT_MOBILE_PEERS_MAX 3 /* send at most this many copies (default) */
2fe58dfd
SE
44
45/* Each site can be in one of several possible states. */
46
47/* States:
48 SITE_STOP - nothing is allowed to happen; tunnel is down;
49 all session keys have been erased
50 -> SITE_RUN upon external instruction
51 SITE_RUN - site up, maybe with valid key
52 -> SITE_RESOLVE upon outgoing packet and no valid key
53 we start name resolution for the other end of the tunnel
54 -> SITE_SENTMSG2 upon valid incoming message 1 and suitable time
55 we send an appropriate message 2
56 SITE_RESOLVE - waiting for name resolution
57 -> SITE_SENTMSG1 upon successful resolution
58 we send an appropriate message 1
59 -> SITE_SENTMSG2 upon valid incoming message 1 (then abort resolution)
60 we abort resolution and
61 -> SITE_WAIT on timeout or resolution failure
62 SITE_SENTMSG1
63 -> SITE_SENTMSG2 upon valid incoming message 1 from higher priority end
64 -> SITE_SENTMSG3 upon valid incoming message 2
65 -> SITE_WAIT on timeout
66 SITE_SENTMSG2
67 -> SITE_SENTMSG4 upon valid incoming message 3
68 -> SITE_WAIT on timeout
69 SITE_SENTMSG3
70 -> SITE_SENTMSG5 upon valid incoming message 4
71 -> SITE_WAIT on timeout
72 SITE_SENTMSG4
73 -> SITE_RUN upon valid incoming message 5
74 -> SITE_WAIT on timeout
75 SITE_SENTMSG5
76 -> SITE_RUN upon valid incoming message 6
77 -> SITE_WAIT on timeout
78 SITE_WAIT - failed to establish key; do nothing for a while
79 -> SITE_RUN on timeout
80 */
81
82#define SITE_STOP 0
83#define SITE_RUN 1
84#define SITE_RESOLVE 2
85#define SITE_SENTMSG1 3
86#define SITE_SENTMSG2 4
87#define SITE_SENTMSG3 5
88#define SITE_SENTMSG4 6
89#define SITE_SENTMSG5 7
90#define SITE_WAIT 8
91
3abd18e8
IJ
92int32_t site_max_start_pad = 4*4;
93
fe5e9cc4 94static cstring_t state_name(uint32_t state)
2fe58dfd
SE
95{
96 switch (state) {
3454dce4
SE
97 case 0: return "STOP";
98 case 1: return "RUN";
99 case 2: return "RESOLVE";
100 case 3: return "SENTMSG1";
101 case 4: return "SENTMSG2";
102 case 5: return "SENTMSG3";
103 case 6: return "SENTMSG4";
104 case 7: return "SENTMSG5";
105 case 8: return "WAIT";
2fe58dfd
SE
106 default: return "*bad state*";
107 }
108}
109
2fe58dfd
SE
110#define NONCELEN 8
111
112#define LOG_UNEXPECTED 0x00000001
113#define LOG_SETUP_INIT 0x00000002
114#define LOG_SETUP_TIMEOUT 0x00000004
115#define LOG_ACTIVATE_KEY 0x00000008
116#define LOG_TIMEOUT_KEY 0x00000010
9d3a4132 117#define LOG_SEC 0x00000020
2fe58dfd
SE
118#define LOG_STATE 0x00000040
119#define LOG_DROP 0x00000080
120#define LOG_DUMP 0x00000100
121#define LOG_ERROR 0x00000400
446353cd 122#define LOG_PEER_ADDRS 0x00000800
2fe58dfd 123
9d3a4132
SE
124static struct flagstr log_event_table[]={
125 { "unexpected", LOG_UNEXPECTED },
126 { "setup-init", LOG_SETUP_INIT },
127 { "setup-timeout", LOG_SETUP_TIMEOUT },
128 { "activate-key", LOG_ACTIVATE_KEY },
129 { "timeout-key", LOG_TIMEOUT_KEY },
130 { "security", LOG_SEC },
131 { "state-change", LOG_STATE },
132 { "packet-drop", LOG_DROP },
133 { "dump-packets", LOG_DUMP },
134 { "errors", LOG_ERROR },
446353cd 135 { "peer-addrs", LOG_PEER_ADDRS },
ff05a229
SE
136 { "default", LOG_SETUP_INIT|LOG_SETUP_TIMEOUT|
137 LOG_ACTIVATE_KEY|LOG_TIMEOUT_KEY|LOG_SEC|LOG_ERROR },
9d3a4132
SE
138 { "all", 0xffffffff },
139 { NULL, 0 }
140};
141
446353cd
IJ
142
143/***** TRANSPORT PEERS declarations *****/
144
145/* Details of "mobile peer" semantics:
146
147 - We record mobile_peers_max peer address/port numbers ("peers")
148 for key setup, and separately mobile_peers_max for data
149 transfer. If these lists fill up, we retain the newest peers.
150 (For non-mobile peers we only record one of each.)
151
152 - Outgoing packets are sent to every recorded peer in the
153 applicable list.
154
155 - Data transfer peers are straightforward: whenever we successfully
156 process a data packet, we record the peer. Also, whenever we
157 successfully complete a key setup, we merge the key setup
158 peers into the data transfer peers.
159
160 (For "non-mobile" peers we simply copy the peer used for
161 successful key setup, and don't change the peer otherwise.)
162
163 - Key setup peers are slightly more complicated.
164
165 Whenever we receive and successfully process a key exchange
166 packet, we record the peer.
167
168 Whenever we try to initiate a key setup, we copy the list of data
169 transfer peers and use it for key setup. But we also look to see
170 if the config supplies an address and port number and if so we
171 add that as a key setup peer (possibly evicting one of the data
172 transfer peers we just copied).
173
174 (For "non-mobile" peers, if we if we have a configured peer
175 address and port, we always use that; otherwise if we have a
176 current data peer address we use that; otherwise we do not
177 attempt to initiate a key setup for lack of a peer address.)
178
179 "Record the peer" means
180 1. expire any peers last seen >120s ("mobile-peer-expiry") ago
181 2. add the peer of the just received packet to the applicable list
182 (possibly evicting older entries)
183 NB that we do not expire peers until an incoming packet arrives.
184
185 */
186
187#define MAX_MOBILE_PEERS_MAX 5 /* send at most this many copies, compiled max */
188
189typedef struct {
190 struct timeval last;
191 struct comm_addr addr;
192} transport_peer;
193
194typedef struct {
195/* configuration information */
196/* runtime information */
197 int npeers;
198 transport_peer peers[MAX_MOBILE_PEERS_MAX];
199} transport_peers;
200
201static void transport_peers_clear(struct site *st, transport_peers *peers);
202static int transport_peers_valid(transport_peers *peers);
203static void transport_peers_copy(struct site *st, transport_peers *dst,
204 const transport_peers *src);
205
206static void transport_setup_msgok(struct site *st, const struct comm_addr *a);
207static void transport_data_msgok(struct site *st, const struct comm_addr *a);
208static bool_t transport_compute_setupinit_peers(struct site *st,
dd9209d1
IJ
209 const struct comm_addr *configured_addr /* 0 if none or not found */,
210 const struct comm_addr *prod_hint_addr /* 0 if none */);
446353cd
IJ
211static void transport_record_peer(struct site *st, transport_peers *peers,
212 const struct comm_addr *addr, const char *m);
213
214static void transport_xmit(struct site *st, transport_peers *peers,
215 struct buffer_if *buf, bool_t candebug);
216
217 /***** END of transport peers declarations *****/
218
219
19e9a588
IJ
220struct data_key {
221 struct transform_inst_if *transform;
222 uint64_t key_timeout; /* End of life of current key */
223 uint32_t remote_session_id;
224};
225
2fe58dfd
SE
226struct site {
227 closure_t cl;
228 struct site_if ops;
229/* configuration information */
230 string_t localname;
231 string_t remotename;
446353cd
IJ
232 bool_t peer_mobile; /* Mobile client support */
233 int32_t transport_peers_max;
ff05a229 234 string_t tunname; /* localname<->remotename by default, used in logs */
2fe58dfd 235 string_t address; /* DNS name for bootstrapping, optional */
ff05a229 236 int remoteport; /* Port for bootstrapping, optional */
3ed1846a 237 uint32_t mtu_target;
2fe58dfd 238 struct netlink_if *netlink;
59533c16
IJ
239 struct comm_if **comms;
240 int ncomms;
2fe58dfd
SE
241 struct resolver_if *resolver;
242 struct log_if *log;
243 struct random_if *random;
244 struct rsaprivkey_if *privkey;
2fe58dfd 245 struct rsapubkey_if *pubkey;
5b5f297f
IJ
246 struct transform_if **transforms;
247 int ntransforms;
2fe58dfd
SE
248 struct dh_if *dh;
249 struct hash_if *hash;
2fe58dfd 250
58650a70 251 uint32_t index; /* Index of this site */
09a385fb 252 uint32_t local_capabilities;
1caa23ff 253 int32_t setup_retries; /* How many times to send setup packets */
e7f8ec2a 254 int32_t setup_retry_interval; /* Initial timeout for setup packets */
4a8aed08 255 int32_t wait_timeout; /* How long to wait if setup unsuccessful */
446353cd 256 int32_t mobile_peer_expiry; /* How long to remember 2ary addresses */
4a8aed08
IJ
257 int32_t key_lifetime; /* How long a key lasts once set up */
258 int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
9d3a4132
SE
259 after this time, initiate a new
260 key exchange */
2fe58dfd 261
2fe58dfd
SE
262 bool_t setup_priority; /* Do we have precedence if both sites emit
263 message 1 simultaneously? */
264 uint32_t log_events;
265
266/* runtime information */
267 uint32_t state;
268 uint64_t now; /* Most recently seen time */
dd9209d1 269 bool_t allow_send_prod;
2fe58dfd 270
ff05a229 271 /* The currently established session */
19e9a588 272 struct data_key current;
02b0959b 273 struct data_key auxiliary_key;
bd98cd6b 274 bool_t auxiliary_is_new;
ff05a229 275 uint64_t renegotiate_key_time; /* When we can negotiate a new key */
bd98cd6b 276 uint64_t auxiliary_renegotiate_key_time;
446353cd 277 transport_peers peers; /* Current address(es) of peer for data traffic */
2fe58dfd 278
ff05a229
SE
279 /* The current key setup protocol exchange. We can only be
280 involved in one of these at a time. There's a potential for
281 denial of service here (the attacker keeps sending a setup
282 packet; we keep trying to continue the exchange, and have to
283 timeout before we can listen for another setup packet); perhaps
284 we should keep a list of 'bad' sources for setup packets. */
09a385fb 285 uint32_t remote_capabilities;
3ed1846a 286 uint16_t remote_adv_mtu;
5b5f297f 287 struct transform_if *chosen_transform;
2fe58dfd 288 uint32_t setup_session_id;
446353cd 289 transport_peers setup_peers;
2fe58dfd
SE
290 uint8_t localN[NONCELEN]; /* Nonces for key exchange */
291 uint8_t remoteN[NONCELEN];
292 struct buffer_if buffer; /* Current outgoing key exchange packet */
05f39b4d 293 struct buffer_if scratch;
4a8aed08 294 int32_t retries; /* Number of retries remaining */
2fe58dfd
SE
295 uint64_t timeout; /* Timeout for current state */
296 uint8_t *dhsecret;
297 uint8_t *sharedsecret;
5b5f297f 298 uint32_t sharedsecretlen, sharedsecretallocd;
2fe58dfd
SE
299 struct transform_inst_if *new_transform; /* For key setup/verify */
300};
301
8368df34
IJ
302static uint32_t event_log_priority(struct site *st, uint32_t event)
303{
304 if (!(event&st->log_events))
305 return 0;
306 switch(event) {
307 case LOG_UNEXPECTED: return M_INFO;
308 case LOG_SETUP_INIT: return M_INFO;
309 case LOG_SETUP_TIMEOUT: return M_NOTICE;
310 case LOG_ACTIVATE_KEY: return M_INFO;
311 case LOG_TIMEOUT_KEY: return M_INFO;
312 case LOG_SEC: return M_SECURITY;
313 case LOG_STATE: return M_DEBUG;
314 case LOG_DROP: return M_DEBUG;
315 case LOG_DUMP: return M_DEBUG;
316 case LOG_ERROR: return M_ERR;
317 case LOG_PEER_ADDRS: return M_DEBUG;
318 default: return M_ERR;
319 }
320}
321
fe5e9cc4 322static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
779837e1
IJ
323FORMAT(printf,3,4);
324static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
2fe58dfd
SE
325{
326 va_list ap;
b2a56f7c 327 uint32_t class;
2fe58dfd 328
8368df34
IJ
329 class=event_log_priority(st, event);
330 if (class) {
331 va_start(ap,msg);
e5d8c16e
IJ
332 slilog_part(st->log,class,"%s: ",st->tunname);
333 vslilog_part(st->log,class,msg,ap);
334 slilog_part(st->log,class,"\n");
8368df34 335 va_end(ap);
2fe58dfd 336 }
2fe58dfd
SE
337}
338
9d3a4132 339static void set_link_quality(struct site *st);
1d388569
IJ
340static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel);
341static void delete_one_key(struct site *st, struct data_key *key,
342 const char *reason /* may be 0 meaning don't log*/,
343 const char *which /* ignored if !reasonn */,
344 uint32_t loglevel /* ignored if !reasonn */);
dd9209d1
IJ
345static bool_t initiate_key_setup(struct site *st, cstring_t reason,
346 const struct comm_addr *prod_hint);
2fe58dfd
SE
347static void enter_state_run(struct site *st);
348static bool_t enter_state_resolve(struct site *st);
ff05a229 349static bool_t enter_new_state(struct site *st,uint32_t next);
2fe58dfd 350static void enter_state_wait(struct site *st);
05f39b4d 351static void activate_new_key(struct site *st);
2fe58dfd 352
0afd257e
IJ
353static bool_t is_transform_valid(struct transform_inst_if *transform)
354{
fcad4b0b 355 return transform && transform->valid(transform->st);
0afd257e
IJ
356}
357
3d8d8f4e
IJ
358static bool_t current_valid(struct site *st)
359{
0afd257e
IJ
360 return is_transform_valid(st->current.transform);
361}
362
363#define DEFINE_CALL_TRANSFORM(fwdrev) \
364static int call_transform_##fwdrev(struct site *st, \
365 struct transform_inst_if *transform, \
366 struct buffer_if *buf, \
367 const char **errmsg) \
368{ \
fcad4b0b
IJ
369 if (!is_transform_valid(transform)) { \
370 *errmsg="transform not set up"; \
371 return 1; \
372 } \
0afd257e 373 return transform->fwdrev(transform->st,buf,errmsg); \
3d8d8f4e
IJ
374}
375
0afd257e
IJ
376DEFINE_CALL_TRANSFORM(forwards)
377DEFINE_CALL_TRANSFORM(reverse)
378
379static void dispose_transform(struct transform_inst_if **transform_var)
380{
0afd257e 381 struct transform_inst_if *transform=*transform_var;
fcad4b0b
IJ
382 if (transform) {
383 transform->delkey(transform->st);
384 transform->destroy(transform->st);
385 }
386 *transform_var = 0;
0afd257e
IJ
387}
388
2fe58dfd
SE
389#define CHECK_AVAIL(b,l) do { if ((b)->size<(l)) return False; } while(0)
390#define CHECK_EMPTY(b) do { if ((b)->size!=0) return False; } while(0)
391#define CHECK_TYPE(b,t) do { uint32_t type; \
392 CHECK_AVAIL((b),4); \
59635212 393 type=buf_unprepend_uint32((b)); \
2fe58dfd
SE
394 if (type!=(t)) return False; } while(0)
395
3ed1846a
IJ
396static _Bool type_is_msg34(uint32_t type)
397{
398 return
399 type == LABEL_MSG3 ||
400 type == LABEL_MSG3BIS ||
401 type == LABEL_MSG4;
402}
403
1737eeef
IJ
404struct parsedname {
405 int32_t len;
406 uint8_t *name;
09a385fb 407 struct buffer_if extrainfo;
1737eeef
IJ
408};
409
2fe58dfd
SE
410struct msg {
411 uint8_t *hashstart;
412 uint32_t dest;
413 uint32_t source;
1737eeef
IJ
414 struct parsedname remote;
415 struct parsedname local;
09a385fb 416 uint32_t remote_capabilities;
3ed1846a 417 uint16_t remote_mtu;
5b5f297f 418 int capab_transformnum;
2fe58dfd
SE
419 uint8_t *nR;
420 uint8_t *nL;
1caa23ff 421 int32_t pklen;
3e8addad 422 char *pk;
1caa23ff
IJ
423 int32_t hashlen;
424 int32_t siglen;
3e8addad 425 char *sig;
2fe58dfd
SE
426};
427
5b5f297f 428static void set_new_transform(struct site *st, char *pk)
0afd257e 429{
5b5f297f
IJ
430 /* Make room for the shared key */
431 st->sharedsecretlen=st->chosen_transform->keylen?:st->dh->ceil_len;
432 assert(st->sharedsecretlen);
433 if (st->sharedsecretlen > st->sharedsecretallocd) {
434 st->sharedsecretallocd=st->sharedsecretlen;
435 st->sharedsecret=realloc(st->sharedsecret,st->sharedsecretallocd);
436 }
437 if (!st->sharedsecret) fatal_perror("site:sharedsecret");
438
439 /* Generate the shared key */
440 st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,pk,
441 st->sharedsecret,st->sharedsecretlen);
442
443 /* Set up the transform */
444 struct transform_if *generator=st->chosen_transform;
fcad4b0b
IJ
445 struct transform_inst_if *generated=generator->create(generator->st);
446 generated->setkey(generated->st,st->sharedsecret,
447 st->sharedsecretlen,st->setup_priority);
448 dispose_transform(&st->new_transform);
449 st->new_transform=generated;
5b5f297f
IJ
450
451 slog(st,LOG_SETUP_INIT,"key exchange negotiated transform"
452 " %d (capabilities ours=%#"PRIx32" theirs=%#"PRIx32")",
453 st->chosen_transform->capab_transformnum,
454 st->local_capabilities, st->remote_capabilities);
0afd257e
IJ
455}
456
09a385fb
IJ
457struct xinfoadd {
458 int32_t lenpos, afternul;
459};
460static void append_string_xinfo_start(struct buffer_if *buf,
461 struct xinfoadd *xia,
462 const char *str)
463 /* Helps construct one of the names with additional info as found
464 * in MSG1..4. Call this function first, then append all the
465 * desired extra info (not including the nul byte) to the buffer,
466 * then call append_string_xinfo_done. */
467{
468 xia->lenpos = buf->size;
469 buf_append_string(buf,str);
470 buf_append_uint8(buf,0);
471 xia->afternul = buf->size;
472}
473static void append_string_xinfo_done(struct buffer_if *buf,
474 struct xinfoadd *xia)
475{
476 /* we just need to adjust the string length */
477 if (buf->size == xia->afternul) {
478 /* no extra info, strip the nul too */
479 buf_unappend_uint8(buf);
480 } else {
481 put_uint16(buf->start+xia->lenpos, buf->size-(xia->lenpos+2));
482 }
483}
484
ff05a229
SE
485/* Build any of msg1 to msg4. msg5 and msg6 are built from the inside
486 out using a transform of config data supplied by netlink */
fe5e9cc4 487static bool_t generate_msg(struct site *st, uint32_t type, cstring_t what)
2fe58dfd
SE
488{
489 void *hst;
3b83c932 490 uint8_t *hash;
2fe58dfd
SE
491 string_t dhpub, sig;
492
493 st->retries=st->setup_retries;
494 BUF_ALLOC(&st->buffer,what);
495 buffer_init(&st->buffer,0);
59635212
SE
496 buf_append_uint32(&st->buffer,
497 (type==LABEL_MSG1?0:st->setup_session_id));
58650a70 498 buf_append_uint32(&st->buffer,st->index);
59635212 499 buf_append_uint32(&st->buffer,type);
09a385fb
IJ
500
501 struct xinfoadd xia;
502 append_string_xinfo_start(&st->buffer,&xia,st->localname);
503 if ((st->local_capabilities & CAPAB_EARLY) || (type != LABEL_MSG1)) {
504 buf_append_uint32(&st->buffer,st->local_capabilities);
505 }
3ed1846a
IJ
506 if (type_is_msg34(type)) {
507 buf_append_uint16(&st->buffer,st->mtu_target);
508 }
09a385fb
IJ
509 append_string_xinfo_done(&st->buffer,&xia);
510
2fe58dfd
SE
511 buf_append_string(&st->buffer,st->remotename);
512 memcpy(buf_append(&st->buffer,NONCELEN),st->localN,NONCELEN);
513 if (type==LABEL_MSG1) return True;
514 memcpy(buf_append(&st->buffer,NONCELEN),st->remoteN,NONCELEN);
515 if (type==LABEL_MSG2) return True;
3b83c932
SE
516
517 if (hacky_par_mid_failnow()) return False;
518
5b5f297f
IJ
519 if (type==LABEL_MSG3BIS)
520 buf_append_uint8(&st->buffer,st->chosen_transform->capab_transformnum);
521
2fe58dfd
SE
522 dhpub=st->dh->makepublic(st->dh->st,st->dhsecret,st->dh->len);
523 buf_append_string(&st->buffer,dhpub);
524 free(dhpub);
3b83c932 525 hash=safe_malloc(st->hash->len, "generate_msg");
2fe58dfd
SE
526 hst=st->hash->init();
527 st->hash->update(hst,st->buffer.start,st->buffer.size);
528 st->hash->final(hst,hash);
529 sig=st->privkey->sign(st->privkey->st,hash,st->hash->len);
530 buf_append_string(&st->buffer,sig);
531 free(sig);
3b83c932 532 free(hash);
2fe58dfd
SE
533 return True;
534}
535
1737eeef
IJ
536static bool_t unpick_name(struct buffer_if *msg, struct parsedname *nm)
537{
538 CHECK_AVAIL(msg,2);
539 nm->len=buf_unprepend_uint16(msg);
540 CHECK_AVAIL(msg,nm->len);
541 nm->name=buf_unprepend(msg,nm->len);
542 uint8_t *nul=memchr(nm->name,0,nm->len);
543 if (!nul) {
09a385fb 544 buffer_readonly_view(&nm->extrainfo,0,0);
1737eeef 545 } else {
09a385fb 546 buffer_readonly_view(&nm->extrainfo, nul+1, msg->start-(nul+1));
1737eeef
IJ
547 nm->len=nul-nm->name;
548 }
549 return True;
550}
551
2fe58dfd
SE
552static bool_t unpick_msg(struct site *st, uint32_t type,
553 struct buffer_if *msg, struct msg *m)
554{
5b5f297f 555 m->capab_transformnum=-1;
2fe58dfd
SE
556 m->hashstart=msg->start;
557 CHECK_AVAIL(msg,4);
59635212 558 m->dest=buf_unprepend_uint32(msg);
2fe58dfd 559 CHECK_AVAIL(msg,4);
59635212 560 m->source=buf_unprepend_uint32(msg);
2fe58dfd 561 CHECK_TYPE(msg,type);
1737eeef 562 if (!unpick_name(msg,&m->remote)) return False;
09a385fb 563 m->remote_capabilities=0;
3ed1846a 564 m->remote_mtu=0;
09a385fb
IJ
565 if (m->remote.extrainfo.size) {
566 CHECK_AVAIL(&m->remote.extrainfo,4);
567 m->remote_capabilities=buf_unprepend_uint32(&m->remote.extrainfo);
568 }
3ed1846a
IJ
569 if (type_is_msg34(type) && m->remote.extrainfo.size) {
570 CHECK_AVAIL(&m->remote.extrainfo,2);
571 m->remote_mtu=buf_unprepend_uint16(&m->remote.extrainfo);
572 }
1737eeef 573 if (!unpick_name(msg,&m->local)) return False;
dd9209d1
IJ
574 if (type==LABEL_PROD) {
575 CHECK_EMPTY(msg);
576 return True;
577 }
2fe58dfd
SE
578 CHECK_AVAIL(msg,NONCELEN);
579 m->nR=buf_unprepend(msg,NONCELEN);
580 if (type==LABEL_MSG1) {
581 CHECK_EMPTY(msg);
582 return True;
583 }
584 CHECK_AVAIL(msg,NONCELEN);
585 m->nL=buf_unprepend(msg,NONCELEN);
586 if (type==LABEL_MSG2) {
587 CHECK_EMPTY(msg);
588 return True;
589 }
5b5f297f
IJ
590 if (type==LABEL_MSG3BIS) {
591 CHECK_AVAIL(msg,1);
592 m->capab_transformnum = buf_unprepend_uint8(msg);
593 } else {
594 m->capab_transformnum = CAPAB_TRANSFORMNUM_ANCIENT;
595 }
2fe58dfd 596 CHECK_AVAIL(msg,2);
59635212 597 m->pklen=buf_unprepend_uint16(msg);
2fe58dfd
SE
598 CHECK_AVAIL(msg,m->pklen);
599 m->pk=buf_unprepend(msg,m->pklen);
600 m->hashlen=msg->start-m->hashstart;
601 CHECK_AVAIL(msg,2);
59635212 602 m->siglen=buf_unprepend_uint16(msg);
2fe58dfd
SE
603 CHECK_AVAIL(msg,m->siglen);
604 m->sig=buf_unprepend(msg,m->siglen);
605 CHECK_EMPTY(msg);
606 return True;
607}
608
1737eeef
IJ
609static bool_t name_matches(const struct parsedname *nm, const char *expected)
610{
611 int expected_len=strlen(expected);
612 return
613 nm->len == expected_len &&
614 !memcmp(nm->name, expected, expected_len);
615}
616
ff05a229 617static bool_t check_msg(struct site *st, uint32_t type, struct msg *m,
fe5e9cc4 618 cstring_t *error)
ff05a229
SE
619{
620 if (type==LABEL_MSG1) return True;
621
622 /* Check that the site names and our nonce have been sent
623 back correctly, and then store our peer's nonce. */
1737eeef 624 if (!name_matches(&m->remote,st->remotename)) {
ff05a229
SE
625 *error="wrong remote site name";
626 return False;
627 }
1737eeef 628 if (!name_matches(&m->local,st->localname)) {
ff05a229
SE
629 *error="wrong local site name";
630 return False;
631 }
632 if (memcmp(m->nL,st->localN,NONCELEN)!=0) {
633 *error="wrong locally-generated nonce";
634 return False;
635 }
636 if (type==LABEL_MSG2) return True;
5ad34db2 637 if (!consttime_memeq(m->nR,st->remoteN,NONCELEN)!=0) {
ff05a229
SE
638 *error="wrong remotely-generated nonce";
639 return False;
640 }
09a385fb
IJ
641 /* MSG3 has complicated rules about capabilities, which are
642 * handled in process_msg3. */
5b5f297f 643 if (type==LABEL_MSG3 || type==LABEL_MSG3BIS) return True;
09a385fb
IJ
644 if (m->remote_capabilities!=st->remote_capabilities) {
645 *error="remote capabilities changed";
646 return False;
647 }
ff05a229
SE
648 if (type==LABEL_MSG4) return True;
649 *error="unknown message type";
650 return False;
651}
652
2fe58dfd
SE
653static bool_t generate_msg1(struct site *st)
654{
655 st->random->generate(st->random->st,NONCELEN,st->localN);
656 return generate_msg(st,LABEL_MSG1,"site:MSG1");
657}
658
659static bool_t process_msg1(struct site *st, struct buffer_if *msg1,
7e29719e 660 const struct comm_addr *src, struct msg *m)
2fe58dfd 661{
2fe58dfd
SE
662 /* We've already determined we're in an appropriate state to
663 process an incoming MSG1, and that the MSG1 has correct values
664 of A and B. */
665
446353cd 666 transport_record_peer(st,&st->setup_peers,src,"msg1");
7e29719e 667 st->setup_session_id=m->source;
09a385fb 668 st->remote_capabilities=m->remote_capabilities;
7e29719e 669 memcpy(st->remoteN,m->nR,NONCELEN);
2fe58dfd
SE
670 return True;
671}
672
673static bool_t generate_msg2(struct site *st)
674{
675 st->random->generate(st->random->st,NONCELEN,st->localN);
676 return generate_msg(st,LABEL_MSG2,"site:MSG2");
677}
678
679static bool_t process_msg2(struct site *st, struct buffer_if *msg2,
a15faeb2 680 const struct comm_addr *src)
2fe58dfd
SE
681{
682 struct msg m;
fe5e9cc4 683 cstring_t err;
2fe58dfd
SE
684
685 if (!unpick_msg(st,LABEL_MSG2,msg2,&m)) return False;
ff05a229
SE
686 if (!check_msg(st,LABEL_MSG2,&m,&err)) {
687 slog(st,LOG_SEC,"msg2: %s",err);
2fe58dfd
SE
688 return False;
689 }
690 st->setup_session_id=m.source;
09a385fb 691 st->remote_capabilities=m.remote_capabilities;
5b5f297f
IJ
692
693 /* Select the transform to use */
694
695 uint32_t remote_transforms = st->remote_capabilities & CAPAB_TRANSFORM_MASK;
696 if (!remote_transforms)
697 /* old secnets only had this one transform */
698 remote_transforms = 1UL << CAPAB_TRANSFORMNUM_ANCIENT;
699
700 struct transform_if *ti;
701 int i;
702 for (i=0; i<st->ntransforms; i++) {
703 ti=st->transforms[i];
704 if ((1UL << ti->capab_transformnum) & remote_transforms)
705 goto transform_found;
706 }
707 slog(st,LOG_ERROR,"no transforms in common"
708 " (us %#"PRIx32"; them: %#"PRIx32")",
709 st->local_capabilities & CAPAB_TRANSFORM_MASK,
710 remote_transforms);
711 return False;
712 transform_found:
713 st->chosen_transform=ti;
714
2fe58dfd
SE
715 memcpy(st->remoteN,m.nR,NONCELEN);
716 return True;
717}
718
719static bool_t generate_msg3(struct site *st)
720{
721 /* Now we have our nonce and their nonce. Think of a secret key,
722 and create message number 3. */
723 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
5b5f297f
IJ
724 return generate_msg(st,
725 (st->remote_capabilities & CAPAB_TRANSFORM_MASK
726 ? LABEL_MSG3BIS : LABEL_MSG3),
727 "site:MSG3");
2fe58dfd
SE
728}
729
e001e8c0
IJ
730static bool_t process_msg3_msg4(struct site *st, struct msg *m)
731{
732 uint8_t *hash;
733 void *hst;
734
735 /* Check signature and store g^x mod m */
736 hash=safe_malloc(st->hash->len, "process_msg3_msg4");
737 hst=st->hash->init();
738 st->hash->update(hst,m->hashstart,m->hashlen);
739 st->hash->final(hst,hash);
740 /* Terminate signature with a '0' - cheating, but should be ok */
741 m->sig[m->siglen]=0;
742 if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m->sig)) {
743 slog(st,LOG_SEC,"msg3/msg4 signature failed check!");
744 free(hash);
745 return False;
746 }
747 free(hash);
748
3ed1846a
IJ
749 st->remote_adv_mtu=m->remote_mtu;
750
e001e8c0
IJ
751 return True;
752}
753
2fe58dfd 754static bool_t process_msg3(struct site *st, struct buffer_if *msg3,
5b5f297f 755 const struct comm_addr *src, uint32_t msgtype)
2fe58dfd
SE
756{
757 struct msg m;
fe5e9cc4 758 cstring_t err;
2fe58dfd 759
5b5f297f
IJ
760 assert(msgtype==LABEL_MSG3 || msgtype==LABEL_MSG3BIS);
761
762 if (!unpick_msg(st,msgtype,msg3,&m)) return False;
763 if (!check_msg(st,msgtype,&m,&err)) {
ff05a229 764 slog(st,LOG_SEC,"msg3: %s",err);
2fe58dfd
SE
765 return False;
766 }
09a385fb
IJ
767 uint32_t capab_adv_late = m.remote_capabilities
768 & ~st->remote_capabilities & CAPAB_EARLY;
769 if (capab_adv_late) {
770 slog(st,LOG_SEC,"msg3 impermissibly adds early capability flag(s)"
771 " %#"PRIx32" (was %#"PRIx32", now %#"PRIx32")",
772 capab_adv_late, st->remote_capabilities, m.remote_capabilities);
773 return False;
774 }
775 st->remote_capabilities|=m.remote_capabilities;
ff05a229 776
5b5f297f
IJ
777 struct transform_if *ti;
778 int i;
779 for (i=0; i<st->ntransforms; i++) {
780 ti=st->transforms[i];
781 if (ti->capab_transformnum == m.capab_transformnum)
782 goto transform_found;
783 }
784 slog(st,LOG_SEC,"peer chose unknown-to-us transform %d!",
785 m.capab_transformnum);
786 return False;
787 transform_found:
788 st->chosen_transform=ti;
789
e001e8c0 790 if (!process_msg3_msg4(st,&m))
2fe58dfd 791 return False;
2fe58dfd
SE
792
793 /* Terminate their DH public key with a '0' */
794 m.pk[m.pklen]=0;
795 /* Invent our DH secret key */
796 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
797
5b5f297f
IJ
798 /* Generate the shared key and set up the transform */
799 set_new_transform(st,m.pk);
2fe58dfd
SE
800
801 return True;
802}
803
804static bool_t generate_msg4(struct site *st)
805{
806 /* We have both nonces, their public key and our private key. Generate
807 our public key, sign it and send it to them. */
808 return generate_msg(st,LABEL_MSG4,"site:MSG4");
809}
810
811static bool_t process_msg4(struct site *st, struct buffer_if *msg4,
a15faeb2 812 const struct comm_addr *src)
2fe58dfd
SE
813{
814 struct msg m;
fe5e9cc4 815 cstring_t err;
2fe58dfd
SE
816
817 if (!unpick_msg(st,LABEL_MSG4,msg4,&m)) return False;
ff05a229
SE
818 if (!check_msg(st,LABEL_MSG4,&m,&err)) {
819 slog(st,LOG_SEC,"msg4: %s",err);
2fe58dfd
SE
820 return False;
821 }
822
e001e8c0 823 if (!process_msg3_msg4(st,&m))
2fe58dfd 824 return False;
2fe58dfd
SE
825
826 /* Terminate their DH public key with a '0' */
827 m.pk[m.pklen]=0;
5b5f297f
IJ
828
829 /* Generate the shared key and set up the transform */
830 set_new_transform(st,m.pk);
2fe58dfd
SE
831
832 return True;
833}
834
2fe58dfd
SE
835struct msg0 {
836 uint32_t dest;
837 uint32_t source;
838 uint32_t type;
839};
840
841static bool_t unpick_msg0(struct site *st, struct buffer_if *msg0,
842 struct msg0 *m)
843{
844 CHECK_AVAIL(msg0,4);
59635212 845 m->dest=buf_unprepend_uint32(msg0);
2fe58dfd 846 CHECK_AVAIL(msg0,4);
59635212 847 m->source=buf_unprepend_uint32(msg0);
2fe58dfd 848 CHECK_AVAIL(msg0,4);
59635212 849 m->type=buf_unprepend_uint32(msg0);
2fe58dfd
SE
850 return True;
851 /* Leaves transformed part of buffer untouched */
852}
853
ff05a229
SE
854static bool_t generate_msg5(struct site *st)
855{
fe5e9cc4 856 cstring_t transform_err;
ff05a229
SE
857
858 BUF_ALLOC(&st->buffer,"site:MSG5");
859 /* We are going to add four words to the message */
3abd18e8 860 buffer_init(&st->buffer,calculate_max_start_pad());
ff05a229
SE
861 /* Give the netlink code an opportunity to put its own stuff in the
862 message (configuration information, etc.) */
ff05a229 863 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
0afd257e
IJ
864 if (call_transform_forwards(st,st->new_transform,
865 &st->buffer,&transform_err))
866 return False;
ff05a229 867 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
58650a70 868 buf_prepend_uint32(&st->buffer,st->index);
ff05a229
SE
869 buf_prepend_uint32(&st->buffer,st->setup_session_id);
870
871 st->retries=st->setup_retries;
872 return True;
873}
874
2fe58dfd 875static bool_t process_msg5(struct site *st, struct buffer_if *msg5,
c90cc2a7
IJ
876 const struct comm_addr *src,
877 struct transform_inst_if *transform)
2fe58dfd
SE
878{
879 struct msg0 m;
fe5e9cc4 880 cstring_t transform_err;
2fe58dfd
SE
881
882 if (!unpick_msg0(st,msg5,&m)) return False;
883
0afd257e 884 if (call_transform_reverse(st,transform,msg5,&transform_err)) {
2fe58dfd 885 /* There's a problem */
59635212 886 slog(st,LOG_SEC,"process_msg5: transform: %s",transform_err);
2fe58dfd
SE
887 return False;
888 }
889 /* Buffer should now contain untransformed PING packet data */
890 CHECK_AVAIL(msg5,4);
59635212 891 if (buf_unprepend_uint32(msg5)!=LABEL_MSG5) {
ff05a229 892 slog(st,LOG_SEC,"MSG5/PING packet contained wrong label");
2fe58dfd
SE
893 return False;
894 }
ff7cdc9e
IJ
895 /* Older versions of secnet used to write some config data here
896 * which we ignore. So we don't CHECK_EMPTY */
2fe58dfd
SE
897 return True;
898}
899
c90cc2a7
IJ
900static void create_msg6(struct site *st, struct transform_inst_if *transform,
901 uint32_t session_id)
2fe58dfd 902{
fe5e9cc4 903 cstring_t transform_err;
2fe58dfd
SE
904
905 BUF_ALLOC(&st->buffer,"site:MSG6");
ff05a229 906 /* We are going to add four words to the message */
3abd18e8 907 buffer_init(&st->buffer,calculate_max_start_pad());
794f2398
SE
908 /* Give the netlink code an opportunity to put its own stuff in the
909 message (configuration information, etc.) */
ff05a229 910 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
0afd257e
IJ
911 int problem = call_transform_forwards(st,transform,
912 &st->buffer,&transform_err);
913 assert(!problem);
59635212 914 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
58650a70 915 buf_prepend_uint32(&st->buffer,st->index);
c90cc2a7
IJ
916 buf_prepend_uint32(&st->buffer,session_id);
917}
2fe58dfd 918
c90cc2a7
IJ
919static bool_t generate_msg6(struct site *st)
920{
0afd257e
IJ
921 if (!is_transform_valid(st->new_transform))
922 return False;
c90cc2a7 923 create_msg6(st,st->new_transform,st->setup_session_id);
ff05a229 924 st->retries=1; /* Peer will retransmit MSG5 if this packet gets lost */
2fe58dfd
SE
925 return True;
926}
927
928static bool_t process_msg6(struct site *st, struct buffer_if *msg6,
a15faeb2 929 const struct comm_addr *src)
2fe58dfd
SE
930{
931 struct msg0 m;
fe5e9cc4 932 cstring_t transform_err;
2fe58dfd
SE
933
934 if (!unpick_msg0(st,msg6,&m)) return False;
935
0afd257e 936 if (call_transform_reverse(st,st->new_transform,msg6,&transform_err)) {
2fe58dfd 937 /* There's a problem */
59635212 938 slog(st,LOG_SEC,"process_msg6: transform: %s",transform_err);
2fe58dfd
SE
939 return False;
940 }
941 /* Buffer should now contain untransformed PING packet data */
942 CHECK_AVAIL(msg6,4);
59635212
SE
943 if (buf_unprepend_uint32(msg6)!=LABEL_MSG6) {
944 slog(st,LOG_SEC,"MSG6/PONG packet contained invalid data");
2fe58dfd
SE
945 return False;
946 }
ff7cdc9e
IJ
947 /* Older versions of secnet used to write some config data here
948 * which we ignore. So we don't CHECK_EMPTY */
2fe58dfd
SE
949 return True;
950}
951
48b97423
IJ
952static bool_t decrypt_msg0(struct site *st, struct buffer_if *msg0,
953 const struct comm_addr *src)
2fe58dfd 954{
02b0959b 955 cstring_t transform_err, auxkey_err, newkey_err="n/a";
065e1922
IJ
956 struct msg0 m;
957 uint32_t problem;
2fe58dfd 958
2fe58dfd
SE
959 if (!unpick_msg0(st,msg0,&m)) return False;
960
05f39b4d
IJ
961 /* Keep a copy so we can try decrypting it with multiple keys */
962 buffer_copy(&st->scratch, msg0);
963
0afd257e
IJ
964 problem = call_transform_reverse(st,st->current.transform,
965 msg0,&transform_err);
02b0959b 966 if (!problem) {
bd98cd6b
IJ
967 if (!st->auxiliary_is_new)
968 delete_one_key(st,&st->auxiliary_key,
969 "peer has used new key","auxiliary key",LOG_SEC);
02b0959b
IJ
970 return True;
971 }
48b97423
IJ
972 if (problem==2)
973 goto skew;
07e4774c 974
02b0959b 975 buffer_copy(msg0, &st->scratch);
fcad4b0b
IJ
976 problem = call_transform_reverse(st,st->auxiliary_key.transform,
977 msg0,&auxkey_err);
02b0959b
IJ
978 if (problem==0) {
979 slog(st,LOG_DROP,"processing packet which uses auxiliary key");
bd98cd6b
IJ
980 if (st->auxiliary_is_new) {
981 /* We previously timed out in state SENTMSG5 but it turns
982 * out that our peer did in fact get our MSG5 and is
983 * using the new key. So we should switch to it too. */
984 /* This is a bit like activate_new_key. */
985 struct data_key t;
986 t=st->current;
987 st->current=st->auxiliary_key;
988 st->auxiliary_key=t;
989
990 delete_one_key(st,&st->auxiliary_key,"peer has used new key",
991 "previous key",LOG_SEC);
992 st->auxiliary_is_new=0;
993 st->renegotiate_key_time=st->auxiliary_renegotiate_key_time;
994 }
02b0959b
IJ
995 return True;
996 }
48b97423
IJ
997 if (problem==2)
998 goto skew;
02b0959b 999
05f39b4d
IJ
1000 if (st->state==SITE_SENTMSG5) {
1001 buffer_copy(msg0, &st->scratch);
0afd257e
IJ
1002 problem = call_transform_reverse(st,st->new_transform,
1003 msg0,&newkey_err);
48b97423 1004 if (!problem) {
05f39b4d
IJ
1005 /* It looks like we didn't get the peer's MSG6 */
1006 /* This is like a cut-down enter_new_state(SITE_RUN) */
1007 slog(st,LOG_STATE,"will enter state RUN (MSG0 with new key)");
1008 BUF_FREE(&st->buffer);
1009 st->timeout=0;
1010 activate_new_key(st);
1011 return True; /* do process the data in this packet */
1012 }
48b97423
IJ
1013 if (problem==2)
1014 goto skew;
05f39b4d
IJ
1015 }
1016
02b0959b
IJ
1017 slog(st,LOG_SEC,"transform: %s (aux: %s, new: %s)",
1018 transform_err,auxkey_err,newkey_err);
dd9209d1 1019 initiate_key_setup(st,"incoming message would not decrypt",0);
48b97423
IJ
1020 send_nak(src,m.dest,m.source,m.type,msg0,"message would not decrypt");
1021 return False;
1022
1023 skew:
1024 slog(st,LOG_DROP,"transform: %s (merely skew)",transform_err);
065e1922
IJ
1025 return False;
1026}
1027
1028static bool_t process_msg0(struct site *st, struct buffer_if *msg0,
1029 const struct comm_addr *src)
1030{
1031 uint32_t type;
1032
48b97423 1033 if (!decrypt_msg0(st,msg0,src))
065e1922
IJ
1034 return False;
1035
2fe58dfd 1036 CHECK_AVAIL(msg0,4);
59635212 1037 type=buf_unprepend_uint32(msg0);
2fe58dfd 1038 switch(type) {
794f2398
SE
1039 case LABEL_MSG7:
1040 /* We must forget about the current session. */
1d388569 1041 delete_keys(st,"request from peer",LOG_SEC);
794f2398 1042 return True;
2fe58dfd
SE
1043 case LABEL_MSG9:
1044 /* Deliver to netlink layer */
469fd1d9 1045 st->netlink->deliver(st->netlink->st,msg0);
446353cd 1046 transport_data_msgok(st,src);
837cf01e
IJ
1047 /* See whether we should start negotiating a new key */
1048 if (st->now > st->renegotiate_key_time)
dd9209d1 1049 initiate_key_setup(st,"incoming packet in renegotiation window",0);
2fe58dfd 1050 return True;
2fe58dfd 1051 default:
ff05a229
SE
1052 slog(st,LOG_SEC,"incoming encrypted message of type %08x "
1053 "(unknown)",type);
2fe58dfd
SE
1054 break;
1055 }
1056 return False;
1057}
1058
1059static void dump_packet(struct site *st, struct buffer_if *buf,
a15faeb2 1060 const struct comm_addr *addr, bool_t incoming)
2fe58dfd 1061{
0a6cbade
IJ
1062 uint32_t dest=get_uint32(buf->start);
1063 uint32_t source=get_uint32(buf->start+4);
1064 uint32_t msgtype=get_uint32(buf->start+8);
2fe58dfd
SE
1065
1066 if (st->log_events & LOG_DUMP)
040ee979
SE
1067 slilog(st->log,M_DEBUG,"%s: %s: %08x<-%08x: %08x:",
1068 st->tunname,incoming?"incoming":"outgoing",
1069 dest,source,msgtype);
2fe58dfd
SE
1070}
1071
1072static uint32_t site_status(void *st)
1073{
1074 return 0;
1075}
1076
1077static bool_t send_msg(struct site *st)
1078{
1079 if (st->retries>0) {
446353cd 1080 transport_xmit(st, &st->setup_peers, &st->buffer, True);
e7f8ec2a 1081 st->timeout=st->now+st->setup_retry_interval;
2fe58dfd
SE
1082 st->retries--;
1083 return True;
bd98cd6b
IJ
1084 } else if (st->state==SITE_SENTMSG5) {
1085 slog(st,LOG_SETUP_TIMEOUT,"timed out sending MSG5, stashing new key");
1086 /* We stash the key we have produced, in case it turns out that
1087 * our peer did see our MSG5 after all and starts using it. */
1088 /* This is a bit like some of activate_new_key */
1089 struct transform_inst_if *t;
1090 t=st->auxiliary_key.transform;
1091 st->auxiliary_key.transform=st->new_transform;
1092 st->new_transform=t;
0afd257e 1093 dispose_transform(&st->new_transform);
bd98cd6b 1094
bd98cd6b
IJ
1095 st->auxiliary_is_new=1;
1096 st->auxiliary_key.key_timeout=st->now+st->key_lifetime;
1097 st->auxiliary_renegotiate_key_time=st->now+st->key_renegotiate_time;
1098 st->auxiliary_key.remote_session_id=st->setup_session_id;
1099
1100 enter_state_wait(st);
1101 return False;
2fe58dfd 1102 } else {
3454dce4
SE
1103 slog(st,LOG_SETUP_TIMEOUT,"timed out sending key setup packet "
1104 "(in state %s)",state_name(st->state));
2fe58dfd
SE
1105 enter_state_wait(st);
1106 return False;
1107 }
1108}
1109
1110static void site_resolve_callback(void *sst, struct in_addr *address)
1111{
1112 struct site *st=sst;
446353cd 1113 struct comm_addr ca_buf, *ca_use;
2fe58dfd
SE
1114
1115 if (st->state!=SITE_RESOLVE) {
1116 slog(st,LOG_UNEXPECTED,"site_resolve_callback called unexpectedly");
1117 return;
1118 }
1119 if (address) {
446353cd 1120 FILLZERO(ca_buf);
59533c16 1121 ca_buf.comm=st->comms[0];
446353cd
IJ
1122 ca_buf.sin.sin_family=AF_INET;
1123 ca_buf.sin.sin_port=htons(st->remoteport);
1124 ca_buf.sin.sin_addr=*address;
1125 ca_use=&ca_buf;
2fe58dfd 1126 } else {
2fe58dfd 1127 slog(st,LOG_ERROR,"resolution of %s failed",st->address);
446353cd
IJ
1128 ca_use=0;
1129 }
dd9209d1 1130 if (transport_compute_setupinit_peers(st,ca_use,0)) {
446353cd
IJ
1131 enter_new_state(st,SITE_SENTMSG1);
1132 } else {
1133 /* Can't figure out who to try to to talk to */
1134 slog(st,LOG_SETUP_INIT,"key exchange failed: cannot find peer address");
2fe58dfd
SE
1135 enter_state_run(st);
1136 }
1137}
1138
dd9209d1
IJ
1139static bool_t initiate_key_setup(struct site *st, cstring_t reason,
1140 const struct comm_addr *prod_hint)
9d3a4132
SE
1141{
1142 if (st->state!=SITE_RUN) return False;
794f2398 1143 slog(st,LOG_SETUP_INIT,"initiating key exchange (%s)",reason);
9d3a4132 1144 if (st->address) {
794f2398 1145 slog(st,LOG_SETUP_INIT,"resolving peer address");
9d3a4132 1146 return enter_state_resolve(st);
dd9209d1 1147 } else if (transport_compute_setupinit_peers(st,0,prod_hint)) {
ff05a229 1148 return enter_new_state(st,SITE_SENTMSG1);
9d3a4132 1149 }
ff05a229 1150 slog(st,LOG_SETUP_INIT,"key exchange failed: no address for peer");
9d3a4132
SE
1151 return False;
1152}
1153
2fe58dfd
SE
1154static void activate_new_key(struct site *st)
1155{
1156 struct transform_inst_if *t;
1157
02b0959b
IJ
1158 /* We have three transform instances, which we swap between old,
1159 active and setup */
1160 t=st->auxiliary_key.transform;
1161 st->auxiliary_key.transform=st->current.transform;
19e9a588 1162 st->current.transform=st->new_transform;
2fe58dfd 1163 st->new_transform=t;
0afd257e 1164 dispose_transform(&st->new_transform);
2fe58dfd 1165
2fe58dfd 1166 st->timeout=0;
bd98cd6b 1167 st->auxiliary_is_new=0;
02b0959b 1168 st->auxiliary_key.key_timeout=st->current.key_timeout;
19e9a588 1169 st->current.key_timeout=st->now+st->key_lifetime;
ff05a229 1170 st->renegotiate_key_time=st->now+st->key_renegotiate_time;
446353cd 1171 transport_peers_copy(st,&st->peers,&st->setup_peers);
19e9a588 1172 st->current.remote_session_id=st->setup_session_id;
2fe58dfd 1173
3ed1846a
IJ
1174 /* Compute the inter-site MTU. This is min( our_mtu, their_mtu ).
1175 * But their mtu be unspecified, in which case we just use ours. */
1176 uint32_t intersite_mtu=
1177 MIN(st->mtu_target, st->remote_adv_mtu ?: ~(uint32_t)0);
1178 st->netlink->set_mtu(st->netlink->st,intersite_mtu);
1179
1180 slog(st,LOG_ACTIVATE_KEY,"new key activated"
1181 " (mtu ours=%"PRId32" theirs=%"PRId32" intersite=%"PRId32")",
1182 st->mtu_target, st->remote_adv_mtu, intersite_mtu);
9d3a4132 1183 enter_state_run(st);
2fe58dfd
SE
1184}
1185
1d388569
IJ
1186static void delete_one_key(struct site *st, struct data_key *key,
1187 cstring_t reason, cstring_t which, uint32_t loglevel)
1188{
0afd257e 1189 if (!is_transform_valid(key->transform)) return;
1d388569 1190 if (reason) slog(st,loglevel,"%s deleted (%s)",which,reason);
0afd257e 1191 dispose_transform(&key->transform);
1d388569
IJ
1192 key->key_timeout=0;
1193}
1194
1195static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel)
794f2398 1196{
3d8d8f4e 1197 if (current_valid(st)) {
794f2398
SE
1198 slog(st,loglevel,"session closed (%s)",reason);
1199
1d388569 1200 delete_one_key(st,&st->current,0,0,0);
794f2398
SE
1201 set_link_quality(st);
1202 }
02b0959b 1203 delete_one_key(st,&st->auxiliary_key,0,0,0);
794f2398
SE
1204}
1205
2fe58dfd
SE
1206static void state_assert(struct site *st, bool_t ok)
1207{
4f5e39ec 1208 if (!ok) fatal("site:state_assert");
2fe58dfd
SE
1209}
1210
1211static void enter_state_stop(struct site *st)
1212{
1213 st->state=SITE_STOP;
1214 st->timeout=0;
1d388569 1215 delete_keys(st,"entering state STOP",LOG_TIMEOUT_KEY);
0afd257e 1216 dispose_transform(&st->new_transform);
2fe58dfd
SE
1217}
1218
9d3a4132
SE
1219static void set_link_quality(struct site *st)
1220{
1221 uint32_t quality;
3d8d8f4e 1222 if (current_valid(st))
9d3a4132
SE
1223 quality=LINK_QUALITY_UP;
1224 else if (st->state==SITE_WAIT || st->state==SITE_STOP)
1225 quality=LINK_QUALITY_DOWN;
1226 else if (st->address)
1227 quality=LINK_QUALITY_DOWN_CURRENT_ADDRESS;
446353cd 1228 else if (transport_peers_valid(&st->peers))
9d3a4132
SE
1229 quality=LINK_QUALITY_DOWN_STALE_ADDRESS;
1230 else
1231 quality=LINK_QUALITY_DOWN;
1232
469fd1d9 1233 st->netlink->set_quality(st->netlink->st,quality);
9d3a4132
SE
1234}
1235
2fe58dfd
SE
1236static void enter_state_run(struct site *st)
1237{
1238 slog(st,LOG_STATE,"entering state RUN");
1239 st->state=SITE_RUN;
1240 st->timeout=0;
9d3a4132 1241
ff05a229 1242 st->setup_session_id=0;
446353cd 1243 transport_peers_clear(st,&st->setup_peers);
ff05a229
SE
1244 memset(st->localN,0,NONCELEN);
1245 memset(st->remoteN,0,NONCELEN);
0afd257e 1246 dispose_transform(&st->new_transform);
ff05a229 1247 memset(st->dhsecret,0,st->dh->len);
7c9ca4bd 1248 memset(st->sharedsecret,0,st->sharedsecretlen);
9d3a4132 1249 set_link_quality(st);
2fe58dfd
SE
1250}
1251
1252static bool_t enter_state_resolve(struct site *st)
1253{
1254 state_assert(st,st->state==SITE_RUN);
1255 slog(st,LOG_STATE,"entering state RESOLVE");
1256 st->state=SITE_RESOLVE;
1257 st->resolver->request(st->resolver->st,st->address,
1258 site_resolve_callback,st);
1259 return True;
1260}
1261
ff05a229 1262static bool_t enter_new_state(struct site *st, uint32_t next)
2fe58dfd 1263{
ff05a229 1264 bool_t (*gen)(struct site *st);
3b83c932
SE
1265 int r;
1266
ff05a229
SE
1267 slog(st,LOG_STATE,"entering state %s",state_name(next));
1268 switch(next) {
1269 case SITE_SENTMSG1:
1270 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
1271 gen=generate_msg1;
1272 break;
1273 case SITE_SENTMSG2:
1274 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1275 st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
1276 gen=generate_msg2;
1277 break;
1278 case SITE_SENTMSG3:
1279 state_assert(st,st->state==SITE_SENTMSG1);
1280 BUF_FREE(&st->buffer);
1281 gen=generate_msg3;
1282 break;
1283 case SITE_SENTMSG4:
1284 state_assert(st,st->state==SITE_SENTMSG2);
1285 BUF_FREE(&st->buffer);
1286 gen=generate_msg4;
1287 break;
1288 case SITE_SENTMSG5:
1289 state_assert(st,st->state==SITE_SENTMSG3);
1290 BUF_FREE(&st->buffer);
1291 gen=generate_msg5;
1292 break;
1293 case SITE_RUN:
1294 state_assert(st,st->state==SITE_SENTMSG4);
1295 BUF_FREE(&st->buffer);
1296 gen=generate_msg6;
1297 break;
1298 default:
1299 gen=NULL;
4f5e39ec 1300 fatal("enter_new_state(%s): invalid new state",state_name(next));
ff05a229 1301 break;
2fe58dfd 1302 }
2fe58dfd 1303
3b83c932
SE
1304 if (hacky_par_start_failnow()) return False;
1305
1306 r= gen(st) && send_msg(st);
1307
1308 hacky_par_end(&r,
e7f8ec2a 1309 st->setup_retries, st->setup_retry_interval,
3b83c932
SE
1310 send_msg, st);
1311
1312 if (r) {
ff05a229
SE
1313 st->state=next;
1314 if (next==SITE_RUN) {
1315 BUF_FREE(&st->buffer); /* Never reused */
1316 st->timeout=0; /* Never retransmit */
1317 activate_new_key(st);
1318 }
2fe58dfd
SE
1319 return True;
1320 }
ff05a229
SE
1321 slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1322 st->buffer.free=False; /* Unconditionally use the buffer; it may be
1323 in either state, and enter_state_wait() will
1324 do a BUF_FREE() */
2fe58dfd
SE
1325 enter_state_wait(st);
1326 return False;
1327}
1328
ff05a229 1329/* msg7 tells our peer that we're about to forget our key */
fe5e9cc4 1330static bool_t send_msg7(struct site *st, cstring_t reason)
794f2398 1331{
fe5e9cc4 1332 cstring_t transform_err;
794f2398 1333
3d8d8f4e 1334 if (current_valid(st) && st->buffer.free
446353cd 1335 && transport_peers_valid(&st->peers)) {
794f2398 1336 BUF_ALLOC(&st->buffer,"site:MSG7");
3abd18e8 1337 buffer_init(&st->buffer,calculate_max_start_pad());
794f2398
SE
1338 buf_append_uint32(&st->buffer,LABEL_MSG7);
1339 buf_append_string(&st->buffer,reason);
0afd257e
IJ
1340 if (call_transform_forwards(st, st->current.transform,
1341 &st->buffer, &transform_err))
1342 goto free_out;
794f2398 1343 buf_prepend_uint32(&st->buffer,LABEL_MSG0);
58650a70 1344 buf_prepend_uint32(&st->buffer,st->index);
19e9a588 1345 buf_prepend_uint32(&st->buffer,st->current.remote_session_id);
446353cd 1346 transport_xmit(st,&st->peers,&st->buffer,True);
794f2398 1347 BUF_FREE(&st->buffer);
0afd257e 1348 free_out:
794f2398
SE
1349 return True;
1350 }
1351 return False;
1352}
1353
2fe58dfd
SE
1354/* We go into this state if our peer becomes uncommunicative. Similar to
1355 the "stop" state, we forget all session keys for a while, before
1356 re-entering the "run" state. */
1357static void enter_state_wait(struct site *st)
1358{
1359 slog(st,LOG_STATE,"entering state WAIT");
1360 st->timeout=st->now+st->wait_timeout;
1361 st->state=SITE_WAIT;
9d3a4132 1362 set_link_quality(st);
2fe58dfd
SE
1363 BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1364 /* XXX Erase keys etc. */
1365}
1366
dd9209d1
IJ
1367static void generate_prod(struct site *st, struct buffer_if *buf)
1368{
1369 buffer_init(buf,0);
1370 buf_append_uint32(buf,0);
1371 buf_append_uint32(buf,0);
1372 buf_append_uint32(buf,LABEL_PROD);
1373 buf_append_string(buf,st->localname);
1374 buf_append_string(buf,st->remotename);
1375}
1376
1377static void generate_send_prod(struct site *st,
1378 const struct comm_addr *source)
1379{
1380 if (!st->allow_send_prod) return; /* too soon */
1381 if (!(st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1382 st->state==SITE_WAIT)) return; /* we'd ignore peer's MSG1 */
1383
1384 slog(st,LOG_SETUP_INIT,"prodding peer for key exchange");
1385 st->allow_send_prod=0;
1386 generate_prod(st,&st->scratch);
1387 dump_packet(st,&st->scratch,source,False);
1388 source->comm->sendmsg(source->comm->st, &st->scratch, source);
1389}
1390
16f73fa6 1391static inline void site_settimeout(uint64_t timeout, int *timeout_io)
fe5e9cc4
SE
1392{
1393 if (timeout) {
0009e60a
IJ
1394 int64_t offset=timeout-*now;
1395 if (offset<0) offset=0;
fe5e9cc4
SE
1396 if (offset>INT_MAX) offset=INT_MAX;
1397 if (*timeout_io<0 || offset<*timeout_io)
1398 *timeout_io=offset;
1399 }
1400}
1401
2fe58dfd 1402static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
90a39563 1403 int *timeout_io)
2fe58dfd
SE
1404{
1405 struct site *st=sst;
1406
1407 *nfds_io=0; /* We don't use any file descriptors */
1408 st->now=*now;
1409
1410 /* Work out when our next timeout is. The earlier of 'timeout' or
19e9a588 1411 'current.key_timeout'. A stored value of '0' indicates no timeout
2fe58dfd 1412 active. */
16f73fa6 1413 site_settimeout(st->timeout, timeout_io);
19e9a588 1414 site_settimeout(st->current.key_timeout, timeout_io);
02b0959b 1415 site_settimeout(st->auxiliary_key.key_timeout, timeout_io);
2fe58dfd
SE
1416
1417 return 0; /* success */
1418}
1419
1d388569
IJ
1420static void check_expiry(struct site *st, struct data_key *key,
1421 const char *which)
1422{
1423 if (key->key_timeout && *now>key->key_timeout) {
1424 delete_one_key(st,key,"maximum life exceeded",which,LOG_TIMEOUT_KEY);
1425 }
1426}
1427
2fe58dfd 1428/* NB site_afterpoll will be called before site_beforepoll is ever called */
90a39563 1429static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
2fe58dfd
SE
1430{
1431 struct site *st=sst;
1432
1433 st->now=*now;
1434 if (st->timeout && *now>st->timeout) {
2fe58dfd 1435 st->timeout=0;
3b83c932
SE
1436 if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
1437 if (!hacky_par_start_failnow())
1438 send_msg(st);
1439 } else if (st->state==SITE_WAIT) {
2fe58dfd
SE
1440 enter_state_run(st);
1441 } else {
1442 slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
1443 st->state);
1444 }
1445 }
1d388569 1446 check_expiry(st,&st->current,"current key");
02b0959b 1447 check_expiry(st,&st->auxiliary_key,"auxiliary key");
2fe58dfd
SE
1448}
1449
1450/* This function is called by the netlink device to deliver packets
1451 intended for the remote network. The packet is in "raw" wire
1452 format, but is guaranteed to be word-aligned. */
469fd1d9 1453static void site_outgoing(void *sst, struct buffer_if *buf)
2fe58dfd
SE
1454{
1455 struct site *st=sst;
fe5e9cc4 1456 cstring_t transform_err;
2fe58dfd
SE
1457
1458 if (st->state==SITE_STOP) {
1459 BUF_FREE(buf);
1460 return;
1461 }
1462
dd9209d1
IJ
1463 st->allow_send_prod=1;
1464
2fe58dfd
SE
1465 /* In all other states we consider delivering the packet if we have
1466 a valid key and a valid address to send it to. */
3d8d8f4e 1467 if (current_valid(st) && transport_peers_valid(&st->peers)) {
2fe58dfd 1468 /* Transform it and send it */
70dc107b
SE
1469 if (buf->size>0) {
1470 buf_prepend_uint32(buf,LABEL_MSG9);
0afd257e
IJ
1471 if (call_transform_forwards(st, st->current.transform,
1472 buf, &transform_err))
1473 goto free_out;
70dc107b 1474 buf_prepend_uint32(buf,LABEL_MSG0);
58650a70 1475 buf_prepend_uint32(buf,st->index);
19e9a588 1476 buf_prepend_uint32(buf,st->current.remote_session_id);
446353cd 1477 transport_xmit(st,&st->peers,buf,False);
70dc107b 1478 }
0afd257e 1479 free_out:
2fe58dfd
SE
1480 BUF_FREE(buf);
1481 return;
1482 }
1483
70dc107b 1484 slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
2fe58dfd 1485 BUF_FREE(buf);
dd9209d1 1486 initiate_key_setup(st,"outgoing packet",0);
2fe58dfd
SE
1487}
1488
7e29719e
IJ
1489static bool_t named_for_us(struct site *st, const struct buffer_if *buf_in,
1490 uint32_t type, struct msg *m)
1491 /* For packets which are identified by the local and remote names.
1492 * If it has our name and our peer's name in it it's for us. */
1493{
1494 struct buffer_if buf[1];
1495 buffer_readonly_clone(buf,buf_in);
1496 return unpick_msg(st,type,buf,m)
1497 && name_matches(&m->remote,st->remotename)
1498 && name_matches(&m->local,st->localname);
1499}
1500
2fe58dfd 1501/* This function is called by the communication device to deliver
dd9209d1
IJ
1502 packets from our peers.
1503 It should return True if the packet is recognised as being for
1504 this current site instance (and should therefore not be processed
1505 by other sites), even if the packet was otherwise ignored. */
2fe58dfd 1506static bool_t site_incoming(void *sst, struct buffer_if *buf,
a15faeb2 1507 const struct comm_addr *source)
2fe58dfd
SE
1508{
1509 struct site *st=sst;
20138876
IJ
1510
1511 if (buf->size < 12) return False;
1512
0a6cbade
IJ
1513 uint32_t dest=get_uint32(buf->start);
1514 uint32_t msgtype=get_uint32(buf->start+8);
7e29719e
IJ
1515 struct msg named_msg;
1516
1517 if (msgtype==LABEL_MSG1) {
1518 if (!named_for_us(st,buf,msgtype,&named_msg))
1519 return False;
1520 /* It's a MSG1 addressed to us. Decide what to do about it. */
1521 dump_packet(st,buf,source,True);
1522 if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1523 st->state==SITE_WAIT) {
1524 /* We should definitely process it */
1525 if (process_msg1(st,buf,source,&named_msg)) {
1526 slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
1527 enter_new_state(st,SITE_SENTMSG2);
1528 } else {
1529 slog(st,LOG_ERROR,"failed to process incoming msg1");
1530 }
1531 BUF_FREE(buf);
1532 return True;
1533 } else if (st->state==SITE_SENTMSG1) {
1534 /* We've just sent a message 1! They may have crossed on
1535 the wire. If we have priority then we ignore the
1536 incoming one, otherwise we process it as usual. */
1537 if (st->setup_priority) {
1538 BUF_FREE(buf);
1539 slog(st,LOG_DUMP,"crossed msg1s; we are higher "
1540 "priority => ignore incoming msg1");
1541 return True;
1542 } else {
1543 slog(st,LOG_DUMP,"crossed msg1s; we are lower "
1544 "priority => use incoming msg1");
1545 if (process_msg1(st,buf,source,&named_msg)) {
1546 BUF_FREE(&st->buffer); /* Free our old message 1 */
ff05a229 1547 enter_new_state(st,SITE_SENTMSG2);
2fe58dfd 1548 } else {
7e29719e
IJ
1549 slog(st,LOG_ERROR,"failed to process an incoming "
1550 "crossed msg1 (we have low priority)");
2fe58dfd
SE
1551 }
1552 BUF_FREE(buf);
1553 return True;
2fe58dfd 1554 }
2fe58dfd 1555 }
7e29719e
IJ
1556 /* The message 1 was received at an unexpected stage of the
1557 key setup. XXX POLICY - what do we do? */
1558 slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
1559 BUF_FREE(buf);
1560 return True;
2fe58dfd 1561 }
dd9209d1
IJ
1562 if (msgtype==LABEL_PROD) {
1563 if (!named_for_us(st,buf,msgtype,&named_msg))
1564 return False;
1565 dump_packet(st,buf,source,True);
1566 if (st->state!=SITE_RUN) {
1567 slog(st,LOG_DROP,"ignoring PROD when not in state RUN");
1568 } else if (current_valid(st)) {
1569 slog(st,LOG_DROP,"ignoring PROD when we think we have a key");
1570 } else {
1571 initiate_key_setup(st,"peer sent PROD packet",source);
1572 }
1573 BUF_FREE(buf);
1574 return True;
1575 }
58650a70 1576 if (dest==st->index) {
2fe58dfd
SE
1577 /* Explicitly addressed to us */
1578 if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True);
1579 switch (msgtype) {
136740e6 1580 case LABEL_NAK:
794f2398
SE
1581 /* If the source is our current peer then initiate a key setup,
1582 because our peer's forgotten the key */
19e9a588 1583 if (get_uint32(buf->start+4)==st->current.remote_session_id) {
dd9209d1
IJ
1584 bool_t initiated;
1585 initiated = initiate_key_setup(st,"received a NAK",0);
1586 if (!initiated) generate_send_prod(st,source);
794f2398
SE
1587 } else {
1588 slog(st,LOG_SEC,"bad incoming NAK");
1589 }
1590 break;
2fe58dfd
SE
1591 case LABEL_MSG0:
1592 process_msg0(st,buf,source);
1593 break;
1594 case LABEL_MSG1:
1595 /* Setup packet: should not have been explicitly addressed
1596 to us */
59635212 1597 slog(st,LOG_SEC,"incoming explicitly addressed msg1");
2fe58dfd
SE
1598 break;
1599 case LABEL_MSG2:
1600 /* Setup packet: expected only in state SENTMSG1 */
1601 if (st->state!=SITE_SENTMSG1) {
1602 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
446353cd
IJ
1603 } else if (process_msg2(st,buf,source)) {
1604 transport_setup_msgok(st,source);
ff05a229 1605 enter_new_state(st,SITE_SENTMSG3);
446353cd 1606 } else {
59635212 1607 slog(st,LOG_SEC,"invalid MSG2");
2fe58dfd
SE
1608 }
1609 break;
1610 case LABEL_MSG3:
5b5f297f 1611 case LABEL_MSG3BIS:
2fe58dfd
SE
1612 /* Setup packet: expected only in state SENTMSG2 */
1613 if (st->state!=SITE_SENTMSG2) {
1614 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
5b5f297f 1615 } else if (process_msg3(st,buf,source,msgtype)) {
446353cd 1616 transport_setup_msgok(st,source);
ff05a229 1617 enter_new_state(st,SITE_SENTMSG4);
446353cd 1618 } else {
59635212 1619 slog(st,LOG_SEC,"invalid MSG3");
2fe58dfd
SE
1620 }
1621 break;
1622 case LABEL_MSG4:
1623 /* Setup packet: expected only in state SENTMSG3 */
1624 if (st->state!=SITE_SENTMSG3) {
1625 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
446353cd
IJ
1626 } else if (process_msg4(st,buf,source)) {
1627 transport_setup_msgok(st,source);
ff05a229 1628 enter_new_state(st,SITE_SENTMSG5);
446353cd 1629 } else {
59635212 1630 slog(st,LOG_SEC,"invalid MSG4");
2fe58dfd
SE
1631 }
1632 break;
1633 case LABEL_MSG5:
4efd681a
SE
1634 /* Setup packet: expected only in state SENTMSG4 */
1635 /* (may turn up in state RUN if our return MSG6 was lost
1636 and the new key has already been activated. In that
05f39b4d
IJ
1637 case we discard it. The peer will realise that we
1638 are using the new key when they see our data packets.
1639 Until then the peer's data packets to us get discarded. */
c90cc2a7
IJ
1640 if (st->state==SITE_SENTMSG4) {
1641 if (process_msg5(st,buf,source,st->new_transform)) {
1642 transport_setup_msgok(st,source);
1643 enter_new_state(st,SITE_RUN);
1644 } else {
1645 slog(st,LOG_SEC,"invalid MSG5");
1646 }
1647 } else if (st->state==SITE_RUN) {
19e9a588 1648 if (process_msg5(st,buf,source,st->current.transform)) {
c90cc2a7
IJ
1649 slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
1650 transport_setup_msgok(st,source);
19e9a588
IJ
1651 create_msg6(st,st->current.transform,
1652 st->current.remote_session_id);
c90cc2a7
IJ
1653 transport_xmit(st,&st->peers,&st->buffer,True);
1654 BUF_FREE(&st->buffer);
1655 } else {
1656 slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
1657 }
2fe58dfd 1658 } else {
c90cc2a7 1659 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
2fe58dfd
SE
1660 }
1661 break;
1662 case LABEL_MSG6:
1663 /* Setup packet: expected only in state SENTMSG5 */
1664 if (st->state!=SITE_SENTMSG5) {
1665 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
1666 } else if (process_msg6(st,buf,source)) {
1667 BUF_FREE(&st->buffer); /* Free message 5 */
446353cd 1668 transport_setup_msgok(st,source);
2fe58dfd
SE
1669 activate_new_key(st);
1670 } else {
59635212 1671 slog(st,LOG_SEC,"invalid MSG6");
2fe58dfd
SE
1672 }
1673 break;
2fe58dfd 1674 default:
59635212 1675 slog(st,LOG_SEC,"received message of unknown type 0x%08x",
2fe58dfd
SE
1676 msgtype);
1677 break;
1678 }
1679 BUF_FREE(buf);
1680 return True;
1681 }
1682
1683 return False;
1684}
1685
1686static void site_control(void *vst, bool_t run)
1687{
1688 struct site *st=vst;
1689 if (run) enter_state_run(st);
1690 else enter_state_stop(st);
1691}
1692
794f2398
SE
1693static void site_phase_hook(void *sst, uint32_t newphase)
1694{
1695 struct site *st=sst;
1696
1697 /* The program is shutting down; tell our peer */
1698 send_msg7(st,"shutting down");
1699}
1700
2fe58dfd
SE
1701static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
1702 list_t *args)
1703{
58650a70 1704 static uint32_t index_sequence;
2fe58dfd
SE
1705 struct site *st;
1706 item_t *item;
1707 dict_t *dict;
59533c16 1708 int i;
2fe58dfd
SE
1709
1710 st=safe_malloc(sizeof(*st),"site_apply");
1711
1712 st->cl.description="site";
1713 st->cl.type=CL_SITE;
1714 st->cl.apply=NULL;
1715 st->cl.interface=&st->ops;
1716 st->ops.st=st;
1717 st->ops.control=site_control;
1718 st->ops.status=site_status;
1719
1720 /* First parameter must be a dict */
1721 item=list_elem(args,0);
1722 if (!item || item->type!=t_dict)
1723 cfgfatal(loc,"site","parameter must be a dictionary\n");
1724
1725 dict=item->data.dict;
558fa3fb
SE
1726 st->localname=dict_read_string(dict, "local-name", True, "site", loc);
1727 st->remotename=dict_read_string(dict, "name", True, "site", loc);
dba19f84
IJ
1728
1729 st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
1730 bool_t local_mobile=
1731 dict_read_bool(dict,"local-mobile",False,"site",loc,False);
1732
558fa3fb
SE
1733 /* Sanity check (which also allows the 'sites' file to include
1734 site() closures for all sites including our own): refuse to
1735 talk to ourselves */
1736 if (strcmp(st->localname,st->remotename)==0) {
b2a56f7c 1737 Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
baa06aeb 1738 st->localname);
dba19f84
IJ
1739 if (st->peer_mobile != local_mobile)
1740 cfgfatal(loc,"site","site %s's peer-mobile=%d"
1741 " but our local-mobile=%d\n",
1742 st->localname, st->peer_mobile, local_mobile);
1743 free(st);
1744 return NULL;
1745 }
1746 if (st->peer_mobile && local_mobile) {
1747 Message(M_WARNING,"site %s: site is mobile but so are we"
1748 " -> ignoring this site\n", st->remotename);
558fa3fb
SE
1749 free(st);
1750 return NULL;
1751 }
dba19f84 1752
58650a70
RK
1753 assert(index_sequence < 0xffffffffUL);
1754 st->index = ++index_sequence;
09a385fb 1755 st->local_capabilities = 0;
469fd1d9 1756 st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
59533c16 1757
5b5f297f
IJ
1758#define GET_CLOSURE_LIST(dictkey,things,nthings,CL_TYPE) do{ \
1759 list_t *things##_cfg=dict_lookup(dict,dictkey); \
1760 if (!things##_cfg) \
1761 cfgfatal(loc,"site","closure list \"%s\" not found\n",dictkey); \
1762 st->nthings=list_length(things##_cfg); \
1763 st->things=safe_malloc_ary(sizeof(*st->things),st->nthings,dictkey "s"); \
1764 assert(st->nthings); \
1765 for (i=0; i<st->nthings; i++) { \
1766 item_t *item=list_elem(things##_cfg,i); \
1767 if (item->type!=t_closure) \
1768 cfgfatal(loc,"site","%s is not a closure\n",dictkey); \
1769 closure_t *cl=item->data.closure; \
1770 if (cl->type!=CL_TYPE) \
1771 cfgfatal(loc,"site","%s closure wrong type\n",dictkey); \
1772 st->things[i]=cl->interface; \
1773 } \
1774}while(0)
1775
1776 GET_CLOSURE_LIST("comm",comms,ncomms,CL_COMM);
59533c16 1777
2fe58dfd
SE
1778 st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
1779 st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
1780 st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
1781
2fe58dfd 1782 st->privkey=find_cl_if(dict,"local-key",CL_RSAPRIVKEY,True,"site",loc);
2fe58dfd 1783 st->address=dict_read_string(dict, "address", False, "site", loc);
3454dce4
SE
1784 if (st->address)
1785 st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
1786 else st->remoteport=0;
2fe58dfd
SE
1787 st->pubkey=find_cl_if(dict,"key",CL_RSAPUBKEY,True,"site",loc);
1788
5b5f297f 1789 GET_CLOSURE_LIST("transform",transforms,ntransforms,CL_TRANSFORM);
2fe58dfd
SE
1790
1791 st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
1792 st->hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
1793
e57264d6
IJ
1794#define DEFAULT(D) (st->peer_mobile || local_mobile \
1795 ? DEFAULT_MOBILE_##D : DEFAULT_##D)
e7f8ec2a 1796#define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
c27ca22f 1797
e7f8ec2a
IJ
1798 st->key_lifetime= CFG_NUMBER("key-lifetime", KEY_LIFETIME);
1799 st->setup_retries= CFG_NUMBER("setup-retries", SETUP_RETRIES);
1800 st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
1801 st->wait_timeout= CFG_NUMBER("wait-time", WAIT_TIME);
3ed1846a 1802 st->mtu_target= dict_read_number(dict,"mtu-target",False,"site",loc,0);
e7f8ec2a 1803
446353cd
IJ
1804 st->mobile_peer_expiry= dict_read_number(
1805 dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
1806
1807 st->transport_peers_max= !st->peer_mobile ? 1 : dict_read_number(
1808 dict,"mobile-peers-max",False,"site",loc,DEFAULT_MOBILE_PEERS_MAX);
1809 if (st->transport_peers_max<1 ||
1810 st->transport_peers_max>=MAX_MOBILE_PEERS_MAX) {
1811 cfgfatal(loc,"site","mobile-peers-max must be in range 1.."
1812 STRING(MAX_MOBILE_PEERS_MAX) "\n");
1813 }
1814
e7f8ec2a 1815 if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
c27ca22f
IJ
1816 st->key_renegotiate_time=st->key_lifetime/2;
1817 else
e7f8ec2a 1818 st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
9d3a4132 1819 st->key_renegotiate_time=dict_read_number(
cce0051f 1820 dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
9d3a4132
SE
1821 if (st->key_renegotiate_time > st->key_lifetime) {
1822 cfgfatal(loc,"site",
1823 "renegotiate-time must be less than key-lifetime\n");
1824 }
9d3a4132
SE
1825
1826 st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
1827 log_event_table,"site");
2fe58dfd 1828
dd9209d1
IJ
1829 st->allow_send_prod=0;
1830
4efd681a
SE
1831 st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
1832 "site_apply");
1833 sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
1834
2fe58dfd 1835 /* The information we expect to see in incoming messages of type 1 */
59230b9b
IJ
1836 /* fixme: lots of unchecked overflows here, but the results are only
1837 corrupted packets rather than undefined behaviour */
2fe58dfd
SE
1838 st->setup_priority=(strcmp(st->localname,st->remotename)>0);
1839
1840 buffer_new(&st->buffer,SETUP_BUFFER_LEN);
1841
8aaaa634 1842 buffer_new(&st->scratch,SETUP_BUFFER_LEN);
05f39b4d
IJ
1843 BUF_ALLOC(&st->scratch,"site:scratch");
1844
2fe58dfd
SE
1845 /* We are interested in poll(), but only for timeouts. We don't have
1846 any fds of our own. */
1847 register_for_poll(st, site_beforepoll, site_afterpoll, 0, "site");
1848 st->timeout=0;
1849
09a385fb 1850 st->remote_capabilities=0;
5b5f297f 1851 st->chosen_transform=0;
19e9a588 1852 st->current.key_timeout=0;
02b0959b 1853 st->auxiliary_key.key_timeout=0;
446353cd
IJ
1854 transport_peers_clear(st,&st->peers);
1855 transport_peers_clear(st,&st->setup_peers);
2fe58dfd
SE
1856 /* XXX mlock these */
1857 st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
5b5f297f
IJ
1858 st->sharedsecretlen=st->sharedsecretallocd=0;
1859 st->sharedsecret=0;
1860
5b5f297f
IJ
1861 for (i=0; i<st->ntransforms; i++) {
1862 struct transform_if *ti=st->transforms[i];
1863 uint32_t capbit = 1UL << ti->capab_transformnum;
1864 if (st->local_capabilities & capbit)
1865 slog(st,LOG_ERROR,"transformnum capability bit"
1866 " %d (%#"PRIx32") reused", ti->capab_transformnum, capbit);
1867 st->local_capabilities |= capbit;
59533c16 1868 }
59533c16 1869
2fe58dfd 1870 /* We need to register the remote networks with the netlink device */
3ed1846a
IJ
1871 uint32_t netlink_mtu; /* local virtual interface mtu */
1872 st->netlink->reg(st->netlink->st, site_outgoing, st, &netlink_mtu);
1873 if (!st->mtu_target)
1874 st->mtu_target=netlink_mtu;
ff05a229 1875
59533c16
IJ
1876 for (i=0; i<st->ncomms; i++)
1877 st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
2fe58dfd 1878
fcad4b0b
IJ
1879 st->current.transform=0;
1880 st->auxiliary_key.transform=0;
1881 st->new_transform=0;
bd98cd6b 1882 st->auxiliary_is_new=0;
2fe58dfd
SE
1883
1884 enter_state_stop(st);
1885
794f2398
SE
1886 add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
1887
2fe58dfd
SE
1888 return new_closure(&st->cl);
1889}
1890
2fe58dfd
SE
1891void site_module(dict_t *dict)
1892{
1893 add_closure(dict,"site",site_apply);
1894}
446353cd
IJ
1895
1896
1897/***** TRANSPORT PEERS definitions *****/
1898
1899static void transport_peers_debug(struct site *st, transport_peers *dst,
1900 const char *didwhat,
1901 int nargs, const struct comm_addr *args,
1902 size_t stride) {
1903 int i;
1904 char *argp;
1905
1906 if (!(st->log_events & LOG_PEER_ADDRS))
1907 return; /* an optimisation */
1908
1909 slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
1910 (dst==&st->peers ? "data" :
1911 dst==&st->setup_peers ? "setup" : "UNKNOWN"),
1912 didwhat, nargs, dst->npeers);
1913
1914 for (i=0, argp=(void*)args;
1915 i<nargs;
1916 i++, (argp+=stride?stride:sizeof(*args))) {
1917 const struct comm_addr *ca=(void*)argp;
1918 slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
1919 i, ca->comm->addr_to_string(ca->comm->st,ca));
1920 }
1921 for (i=0; i<dst->npeers; i++) {
1922 struct timeval diff;
1923 timersub(tv_now,&dst->peers[i].last,&diff);
1924 const struct comm_addr *ca=&dst->peers[i].addr;
1925 slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
1926 i, ca->comm->addr_to_string(ca->comm->st,ca),
1927 (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
1928 }
1929}
1930
1931static int transport_peer_compar(const void *av, const void *bv) {
1932 const transport_peer *a=av;
1933 const transport_peer *b=bv;
1934 /* put most recent first in the array */
1935 if (timercmp(&a->last, &b->last, <)) return +1;
1936 if (timercmp(&a->last, &b->last, >)) return -11;
1937 return 0;
1938}
1939
1940static void transport_peers_expire(struct site *st, transport_peers *peers) {
1941 /* peers must be sorted first */
1942 int previous_peers=peers->npeers;
1943 struct timeval oldest;
1944 oldest.tv_sec = tv_now->tv_sec - st->mobile_peer_expiry;
1945 oldest.tv_usec = tv_now->tv_usec;
1946 while (peers->npeers>1 &&
1947 timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
1948 peers->npeers--;
1949 if (peers->npeers != previous_peers)
1950 transport_peers_debug(st,peers,"expire", 0,0,0);
1951}
1952
1953static void transport_record_peer(struct site *st, transport_peers *peers,
1954 const struct comm_addr *addr, const char *m) {
1955 int slot, changed=0;
1956
1957 for (slot=0; slot<peers->npeers; slot++)
1958 if (!memcmp(&peers->peers[slot].addr, addr, sizeof(*addr)))
1959 goto found;
1960
1961 changed=1;
1962 if (peers->npeers==st->transport_peers_max)
925c5ca8 1963 slot=st->transport_peers_max-1;
446353cd
IJ
1964 else
1965 slot=peers->npeers++;
1966
1967 found:
1968 peers->peers[slot].addr=*addr;
1969 peers->peers[slot].last=*tv_now;
1970
1971 if (peers->npeers>1)
1972 qsort(peers->peers, peers->npeers,
1973 sizeof(*peers->peers), transport_peer_compar);
1974
1975 if (changed || peers->npeers!=1)
1976 transport_peers_debug(st,peers,m, 1,addr,0);
1977 transport_peers_expire(st, peers);
1978}
1979
1980static bool_t transport_compute_setupinit_peers(struct site *st,
dd9209d1
IJ
1981 const struct comm_addr *configured_addr /* 0 if none or not found */,
1982 const struct comm_addr *prod_hint_addr /* 0 if none */) {
446353cd 1983
dd9209d1
IJ
1984 if (!configured_addr && !prod_hint_addr &&
1985 !transport_peers_valid(&st->peers))
446353cd
IJ
1986 return False;
1987
1988 slog(st,LOG_SETUP_INIT,
dd9209d1
IJ
1989 "using:%s%s %d old peer address(es)",
1990 configured_addr ? " configured address;" : "",
1991 prod_hint_addr ? " PROD hint address;" : "",
779837e1 1992 st->peers.npeers);
446353cd
IJ
1993
1994 /* Non-mobile peers havve st->peers.npeers==0 or ==1, since they
1995 * have transport_peers_max==1. The effect is that this code
1996 * always uses the configured address if supplied, or otherwise
dd9209d1
IJ
1997 * the address of the incoming PROD, or the existing data peer if
1998 * one exists; this is as desired. */
446353cd
IJ
1999
2000 transport_peers_copy(st,&st->setup_peers,&st->peers);
2001
dd9209d1
IJ
2002 if (prod_hint_addr)
2003 transport_record_peer(st,&st->setup_peers,prod_hint_addr,"prod");
2004
446353cd
IJ
2005 if (configured_addr)
2006 transport_record_peer(st,&st->setup_peers,configured_addr,"setupinit");
2007
2008 assert(transport_peers_valid(&st->setup_peers));
2009 return True;
2010}
2011
2012static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
2013 if (st->peer_mobile)
2014 transport_record_peer(st,&st->setup_peers,a,"setupmsg");
2015}
2016static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
2017 if (st->peer_mobile)
2018 transport_record_peer(st,&st->peers,a,"datamsg");
2019}
2020
2021static int transport_peers_valid(transport_peers *peers) {
2022 return peers->npeers;
2023}
2024static void transport_peers_clear(struct site *st, transport_peers *peers) {
2025 peers->npeers= 0;
2026 transport_peers_debug(st,peers,"clear",0,0,0);
2027}
2028static void transport_peers_copy(struct site *st, transport_peers *dst,
2029 const transport_peers *src) {
2030 dst->npeers=src->npeers;
2031 memcpy(dst->peers, src->peers, sizeof(*dst->peers) * dst->npeers);
2032 transport_peers_debug(st,dst,"copy",
a620a048 2033 src->npeers, &src->peers->addr, sizeof(*src->peers));
446353cd
IJ
2034}
2035
2036void transport_xmit(struct site *st, transport_peers *peers,
2037 struct buffer_if *buf, bool_t candebug) {
2038 int slot;
2039 transport_peers_expire(st, peers);
2040 for (slot=0; slot<peers->npeers; slot++) {
2041 transport_peer *peer=&peers->peers[slot];
2042 if (candebug)
2043 dump_packet(st, buf, &peer->addr, False);
2044 peer->addr.comm->sendmsg(peer->addr.comm->st, buf, &peer->addr);
2045 }
2046}
2047
2048/***** END of transport peers declarations *****/