1 /* site.c - manage communication with a remote network site */
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). */
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. */
21 #include <sys/socket.h>
25 #include "unaligned.h"
28 #define SETUP_BUFFER_LEN 2048
30 #define DEFAULT_KEY_LIFETIME (3600*1000) /* [ms] */
31 #define DEFAULT_KEY_RENEGOTIATE_GAP (5*60*1000) /* [ms] */
32 #define DEFAULT_SETUP_RETRIES 5
33 #define DEFAULT_SETUP_RETRY_INTERVAL (2*1000) /* [ms] */
34 #define DEFAULT_WAIT_TIME (20*1000) /* [ms] */
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] */
42 #define DEFAULT_MOBILE_PEER_EXPIRY (2*60) /* [s] */
43 #define DEFAULT_MOBILE_PEERS_MAX 3 /* send at most this many copies (default) */
44 #define DEFAULT_STATIC_PEERS_MAX 3 /* retain at most this many peer addresses */
46 /* Each site can be in one of several possible states. */
49 SITE_STOP - nothing is allowed to happen; tunnel is down;
50 all session keys have been erased
51 -> SITE_RUN upon external instruction
52 SITE_RUN - site up, maybe with valid key
53 -> SITE_RESOLVE upon outgoing packet and no valid key
54 we start name resolution for the other end of the tunnel
55 -> SITE_SENTMSG2 upon valid incoming message 1 and suitable time
56 we send an appropriate message 2
57 SITE_RESOLVE - waiting for name resolution
58 -> SITE_SENTMSG1 upon successful resolution
59 we send an appropriate message 1
60 -> SITE_SENTMSG2 upon valid incoming message 1 (then abort resolution)
61 we abort resolution and
62 -> SITE_WAIT on timeout or resolution failure
64 -> SITE_SENTMSG2 upon valid incoming message 1 from higher priority end
65 -> SITE_SENTMSG3 upon valid incoming message 2
66 -> SITE_WAIT on timeout
68 -> SITE_SENTMSG4 upon valid incoming message 3
69 -> SITE_WAIT on timeout
71 -> SITE_SENTMSG5 upon valid incoming message 4
72 -> SITE_WAIT on timeout
74 -> SITE_RUN upon valid incoming message 5
75 -> SITE_WAIT on timeout
77 -> SITE_RUN upon valid incoming message 6
78 -> SITE_WAIT on timeout
79 SITE_WAIT - failed to establish key; do nothing for a while
80 -> SITE_RUN on timeout
85 #define SITE_RESOLVE 2
86 #define SITE_SENTMSG1 3
87 #define SITE_SENTMSG2 4
88 #define SITE_SENTMSG3 5
89 #define SITE_SENTMSG4 6
90 #define SITE_SENTMSG5 7
93 int32_t site_max_start_pad = 4*4;
95 static cstring_t state_name(uint32_t state)
98 case 0: return "STOP";
100 case 2: return "RESOLVE";
101 case 3: return "SENTMSG1";
102 case 4: return "SENTMSG2";
103 case 5: return "SENTMSG3";
104 case 6: return "SENTMSG4";
105 case 7: return "SENTMSG5";
106 case 8: return "WAIT";
107 default: return "*bad state*";
113 #define LOG_UNEXPECTED 0x00000001
114 #define LOG_SETUP_INIT 0x00000002
115 #define LOG_SETUP_TIMEOUT 0x00000004
116 #define LOG_ACTIVATE_KEY 0x00000008
117 #define LOG_TIMEOUT_KEY 0x00000010
118 #define LOG_SEC 0x00000020
119 #define LOG_STATE 0x00000040
120 #define LOG_DROP 0x00000080
121 #define LOG_DUMP 0x00000100
122 #define LOG_ERROR 0x00000400
123 #define LOG_PEER_ADDRS 0x00000800
125 static struct flagstr log_event_table[]={
126 { "unexpected", LOG_UNEXPECTED },
127 { "setup-init", LOG_SETUP_INIT },
128 { "setup-timeout", LOG_SETUP_TIMEOUT },
129 { "activate-key", LOG_ACTIVATE_KEY },
130 { "timeout-key", LOG_TIMEOUT_KEY },
131 { "security", LOG_SEC },
132 { "state-change", LOG_STATE },
133 { "packet-drop", LOG_DROP },
134 { "dump-packets", LOG_DUMP },
135 { "errors", LOG_ERROR },
136 { "peer-addrs", LOG_PEER_ADDRS },
137 { "default", LOG_SETUP_INIT|LOG_SETUP_TIMEOUT|
138 LOG_ACTIVATE_KEY|LOG_TIMEOUT_KEY|LOG_SEC|LOG_ERROR },
139 { "all", 0xffffffff },
144 /***** TRANSPORT PEERS declarations *****/
146 /* Details of "mobile peer" semantics:
148 - We use the same data structure for the different configurations,
149 but manage it with different algorithms.
151 - We record up to mobile_peers_max peer address/port numbers
152 ("peers") for key setup, and separately up to mobile_peers_max
155 - In general, we make a new set of addrs (see below) when we start
156 a new key exchange; the key setup addrs become the data transport
157 addrs when key setup complets.
159 If our peer is mobile:
161 - We send to all recent addresses of incoming packets, plus
162 initially all configured addresses (which we also expire).
164 - So, we record addrs of good incoming packets, as follows:
165 1. expire any peers last seen >120s ("mobile-peer-expiry") ago
166 2. add the peer of the just received packet to the applicable list
167 (possibly evicting the oldest entries to make room)
168 NB that we do not expire peers until an incoming packet arrives.
170 - If the peer has a configured address or name, we record them the
171 same way, but only as a result of our own initiation of key
172 setup. (We might evict some incoming packet addrs to make room.)
174 - The default number of addrs to keep is 3, or 4 if we have a
175 configured name or address. That's space for two configured
176 addresses (one IPv6 and one IPv4), plus two received addresses.
178 - Outgoing packets are sent to every recorded address in the
179 applicable list. Any unsupported[1] addresses are deleted from
180 the list right away. (This should only happen to configured
181 addresses, of course, but there is no need to check that.)
183 - When we successfully complete a key setup, we merge the key setup
184 peers into the data transfer peers.
186 [1] An unsupported address is one for whose AF we don't have a
187 socket (perhaps because we got EAFNOSUPPORT or some such) or for
188 which sendto gives ENETUNREACH.
190 If neither end is mobile:
192 - When peer initiated the key exchange, we use the incoming packet
195 - When we initiate the key exchange, we try configured addresses
196 until we get one which isn't unsupported then fixate on that.
198 - When we complete a key setup, we replace the data transport peers
199 with those from the key setup.
203 - We can't tell when local network setup changes so we can't cache
204 the unsupported addrs and completely remove the spurious calls to
205 sendto, but we can optimise things a bit by deprioritising addrs
206 which seem to be unsupported.
208 - Use only configured addresses. (Except, that if our peer
209 initiated a key exchange we use the incoming packet address until
210 our name resolution completes.)
212 - When we send a packet, try each address in turn; if addr
213 supported, put that address to the end of the list for future
214 packets, and go onto the next address.
216 - When we complete a key setup, we replace the data transport peers
217 with those from the key setup.
223 struct comm_addr addr;
227 /* configuration information */
228 /* runtime information */
230 transport_peer peers[MAX_PEER_ADDRS];
233 /* Basic operations on transport peer address sets */
234 static void transport_peers_clear(struct site *st, transport_peers *peers);
235 static int transport_peers_valid(transport_peers *peers);
236 static void transport_peers_copy(struct site *st, transport_peers *dst,
237 const transport_peers *src);
239 /* Record address of incoming setup packet; resp. data packet. */
240 static void transport_setup_msgok(struct site *st, const struct comm_addr *a);
241 static void transport_data_msgok(struct site *st, const struct comm_addr *a);
243 /* Initialise the setup addresses. Called before we send the first
244 * packet in a key exchange. If we are the initiator, as a result of
245 * resolve completing (or being determined not to be relevant) or an
246 * incoming PROD; if we are the responder, as a result of the MSG1. */
247 static bool_t transport_compute_setupinit_peers(struct site *st,
248 const struct comm_addr *configured_addrs /* 0 if none or not found */,
249 int n_configured_addrs /* 0 if none or not found */,
250 const struct comm_addr *incoming_packet_addr /* 0 if none */);
252 /* Called if we are the responder in a key setup, when the resolve
253 * completes. transport_compute_setupinit_peers will hvae been called
254 * earlier. If _complete is called, we are still doing the key setup
255 * (and we should use the new values for both the rest of the key
256 * setup and the ongoing data exchange); if _tardy is called, the key
257 * setup is done (either completed or not) and only the data peers are
259 static void transport_resolve_complete(struct site *st,
260 const struct comm_addr *addrs, int naddrs);
261 static void transport_resolve_complete_tardy(struct site *st,
262 const struct comm_addr *addrs, int naddrs);
264 static void transport_xmit(struct site *st, transport_peers *peers,
265 struct buffer_if *buf, bool_t candebug);
267 /***** END of transport peers declarations *****/
271 struct transform_inst_if *transform;
272 uint64_t key_timeout; /* End of life of current key */
273 uint32_t remote_session_id;
279 /* configuration information */
282 bool_t local_mobile, peer_mobile; /* Mobile client support */
283 int32_t transport_peers_max;
284 string_t tunname; /* localname<->remotename by default, used in logs */
285 cstring_t *addresses; /* DNS name or address(es) for bootstrapping, optional */
286 int remoteport; /* Port for bootstrapping, optional */
288 struct netlink_if *netlink;
289 struct comm_if **comms;
291 struct resolver_if *resolver;
293 struct random_if *random;
294 struct rsaprivkey_if *privkey;
295 struct rsapubkey_if *pubkey;
296 struct transform_if **transforms;
299 struct hash_if *hash;
301 uint32_t index; /* Index of this site */
302 uint32_t local_capabilities;
303 int32_t setup_retries; /* How many times to send setup packets */
304 int32_t setup_retry_interval; /* Initial timeout for setup packets */
305 int32_t wait_timeout; /* How long to wait if setup unsuccessful */
306 int32_t mobile_peer_expiry; /* How long to remember 2ary addresses */
307 int32_t key_lifetime; /* How long a key lasts once set up */
308 int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
309 after this time, initiate a new
312 bool_t setup_priority; /* Do we have precedence if both sites emit
313 message 1 simultaneously? */
316 /* runtime information */
318 uint64_t now; /* Most recently seen time */
319 bool_t allow_send_prod;
321 int resolving_n_results;
322 struct comm_addr resolving_results[MAX_PEER_ADDRS];
324 /* The currently established session */
325 struct data_key current;
326 struct data_key auxiliary_key;
327 bool_t auxiliary_is_new;
328 uint64_t renegotiate_key_time; /* When we can negotiate a new key */
329 uint64_t auxiliary_renegotiate_key_time;
330 transport_peers peers; /* Current address(es) of peer for data traffic */
332 /* The current key setup protocol exchange. We can only be
333 involved in one of these at a time. There's a potential for
334 denial of service here (the attacker keeps sending a setup
335 packet; we keep trying to continue the exchange, and have to
336 timeout before we can listen for another setup packet); perhaps
337 we should keep a list of 'bad' sources for setup packets. */
338 uint32_t remote_capabilities;
339 uint16_t remote_adv_mtu;
340 struct transform_if *chosen_transform;
341 uint32_t setup_session_id;
342 transport_peers setup_peers;
343 uint8_t localN[NONCELEN]; /* Nonces for key exchange */
344 uint8_t remoteN[NONCELEN];
345 struct buffer_if buffer; /* Current outgoing key exchange packet */
346 struct buffer_if scratch;
347 int32_t retries; /* Number of retries remaining */
348 uint64_t timeout; /* Timeout for current state */
350 uint8_t *sharedsecret;
351 uint32_t sharedsecretlen, sharedsecretallocd;
352 struct transform_inst_if *new_transform; /* For key setup/verify */
355 static uint32_t event_log_priority(struct site *st, uint32_t event)
357 if (!(event&st->log_events))
360 case LOG_UNEXPECTED: return M_INFO;
361 case LOG_SETUP_INIT: return M_INFO;
362 case LOG_SETUP_TIMEOUT: return M_NOTICE;
363 case LOG_ACTIVATE_KEY: return M_INFO;
364 case LOG_TIMEOUT_KEY: return M_INFO;
365 case LOG_SEC: return M_SECURITY;
366 case LOG_STATE: return M_DEBUG;
367 case LOG_DROP: return M_DEBUG;
368 case LOG_DUMP: return M_DEBUG;
369 case LOG_ERROR: return M_ERR;
370 case LOG_PEER_ADDRS: return M_DEBUG;
371 default: return M_ERR;
375 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
377 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
381 class=event_log_priority(st, event);
383 slilog_part(st->log,class,"%s: ",st->tunname);
384 vslilog_part(st->log,class,msg,ap);
385 slilog_part(st->log,class,"\n");
389 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
391 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
395 vslog(st,event,msg,ap);
399 static void logtimeout(struct site *st, const char *fmt, ...)
401 static void logtimeout(struct site *st, const char *fmt, ...)
403 uint32_t class=event_log_priority(st,LOG_SETUP_TIMEOUT);
410 slilog_part(st->log,class,"%s: ",st->tunname);
411 vslilog_part(st->log,class,fmt,ap);
415 for (i=0, delim=" (tried ";
416 i<st->setup_peers.npeers;
418 transport_peer *peer=&st->setup_peers.peers[i];
419 const char *s=comm_addr_to_string(&peer->addr);
420 slilog_part(st->log,class,"%s%s",delim,s);
423 slilog_part(st->log,class,")\n");
427 static void set_link_quality(struct site *st);
428 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel);
429 static void delete_one_key(struct site *st, struct data_key *key,
430 const char *reason /* may be 0 meaning don't log*/,
431 const char *which /* ignored if !reasonn */,
432 uint32_t loglevel /* ignored if !reasonn */);
433 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
434 const struct comm_addr *prod_hint);
435 static void enter_state_run(struct site *st);
436 static bool_t enter_state_resolve(struct site *st);
437 static void decrement_resolving_count(struct site *st, int by);
438 static bool_t enter_new_state(struct site *st,uint32_t next);
439 static void enter_state_wait(struct site *st);
440 static void activate_new_key(struct site *st);
442 static bool_t is_transform_valid(struct transform_inst_if *transform)
444 return transform && transform->valid(transform->st);
447 static bool_t current_valid(struct site *st)
449 return is_transform_valid(st->current.transform);
452 #define DEFINE_CALL_TRANSFORM(fwdrev) \
453 static int call_transform_##fwdrev(struct site *st, \
454 struct transform_inst_if *transform, \
455 struct buffer_if *buf, \
456 const char **errmsg) \
458 if (!is_transform_valid(transform)) { \
459 *errmsg="transform not set up"; \
462 return transform->fwdrev(transform->st,buf,errmsg); \
465 DEFINE_CALL_TRANSFORM(forwards)
466 DEFINE_CALL_TRANSFORM(reverse)
468 static void dispose_transform(struct transform_inst_if **transform_var)
470 struct transform_inst_if *transform=*transform_var;
472 transform->delkey(transform->st);
473 transform->destroy(transform->st);
478 #define CHECK_AVAIL(b,l) do { if ((b)->size<(l)) return False; } while(0)
479 #define CHECK_EMPTY(b) do { if ((b)->size!=0) return False; } while(0)
480 #define CHECK_TYPE(b,t) do { uint32_t type; \
481 CHECK_AVAIL((b),4); \
482 type=buf_unprepend_uint32((b)); \
483 if (type!=(t)) return False; } while(0)
485 static _Bool type_is_msg34(uint32_t type)
488 type == LABEL_MSG3 ||
489 type == LABEL_MSG3BIS ||
496 struct buffer_if extrainfo;
503 struct parsedname remote;
504 struct parsedname local;
505 uint32_t remote_capabilities;
507 int capab_transformnum;
517 static void set_new_transform(struct site *st, char *pk)
519 /* Make room for the shared key */
520 st->sharedsecretlen=st->chosen_transform->keylen?:st->dh->ceil_len;
521 assert(st->sharedsecretlen);
522 if (st->sharedsecretlen > st->sharedsecretallocd) {
523 st->sharedsecretallocd=st->sharedsecretlen;
524 st->sharedsecret=safe_realloc_ary(st->sharedsecret,1,
525 st->sharedsecretallocd,
526 "site:sharedsecret");
529 /* Generate the shared key */
530 st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,pk,
531 st->sharedsecret,st->sharedsecretlen);
533 /* Set up the transform */
534 struct transform_if *generator=st->chosen_transform;
535 struct transform_inst_if *generated=generator->create(generator->st);
536 generated->setkey(generated->st,st->sharedsecret,
537 st->sharedsecretlen,st->setup_priority);
538 dispose_transform(&st->new_transform);
539 st->new_transform=generated;
541 slog(st,LOG_SETUP_INIT,"key exchange negotiated transform"
542 " %d (capabilities ours=%#"PRIx32" theirs=%#"PRIx32")",
543 st->chosen_transform->capab_transformnum,
544 st->local_capabilities, st->remote_capabilities);
548 int32_t lenpos, afternul;
550 static void append_string_xinfo_start(struct buffer_if *buf,
551 struct xinfoadd *xia,
553 /* Helps construct one of the names with additional info as found
554 * in MSG1..4. Call this function first, then append all the
555 * desired extra info (not including the nul byte) to the buffer,
556 * then call append_string_xinfo_done. */
558 xia->lenpos = buf->size;
559 buf_append_string(buf,str);
560 buf_append_uint8(buf,0);
561 xia->afternul = buf->size;
563 static void append_string_xinfo_done(struct buffer_if *buf,
564 struct xinfoadd *xia)
566 /* we just need to adjust the string length */
567 if (buf->size == xia->afternul) {
568 /* no extra info, strip the nul too */
569 buf_unappend_uint8(buf);
571 put_uint16(buf->start+xia->lenpos, buf->size-(xia->lenpos+2));
575 /* Build any of msg1 to msg4. msg5 and msg6 are built from the inside
576 out using a transform of config data supplied by netlink */
577 static bool_t generate_msg(struct site *st, uint32_t type, cstring_t what)
583 st->retries=st->setup_retries;
584 BUF_ALLOC(&st->buffer,what);
585 buffer_init(&st->buffer,0);
586 buf_append_uint32(&st->buffer,
587 (type==LABEL_MSG1?0:st->setup_session_id));
588 buf_append_uint32(&st->buffer,st->index);
589 buf_append_uint32(&st->buffer,type);
592 append_string_xinfo_start(&st->buffer,&xia,st->localname);
593 if ((st->local_capabilities & CAPAB_EARLY) || (type != LABEL_MSG1)) {
594 buf_append_uint32(&st->buffer,st->local_capabilities);
596 if (type_is_msg34(type)) {
597 buf_append_uint16(&st->buffer,st->mtu_target);
599 append_string_xinfo_done(&st->buffer,&xia);
601 buf_append_string(&st->buffer,st->remotename);
602 BUF_ADD_OBJ(append,&st->buffer,st->localN);
603 if (type==LABEL_MSG1) return True;
604 BUF_ADD_OBJ(append,&st->buffer,st->remoteN);
605 if (type==LABEL_MSG2) return True;
607 if (hacky_par_mid_failnow()) return False;
609 if (type==LABEL_MSG3BIS)
610 buf_append_uint8(&st->buffer,st->chosen_transform->capab_transformnum);
612 dhpub=st->dh->makepublic(st->dh->st,st->dhsecret,st->dh->len);
613 buf_append_string(&st->buffer,dhpub);
615 hash=safe_malloc(st->hash->len, "generate_msg");
616 hst=st->hash->init();
617 st->hash->update(hst,st->buffer.start,st->buffer.size);
618 st->hash->final(hst,hash);
619 sig=st->privkey->sign(st->privkey->st,hash,st->hash->len);
620 buf_append_string(&st->buffer,sig);
626 static bool_t unpick_name(struct buffer_if *msg, struct parsedname *nm)
629 nm->len=buf_unprepend_uint16(msg);
630 CHECK_AVAIL(msg,nm->len);
631 nm->name=buf_unprepend(msg,nm->len);
632 uint8_t *nul=memchr(nm->name,0,nm->len);
634 buffer_readonly_view(&nm->extrainfo,0,0);
636 buffer_readonly_view(&nm->extrainfo, nul+1, msg->start-(nul+1));
637 nm->len=nul-nm->name;
642 static bool_t unpick_msg(struct site *st, uint32_t type,
643 struct buffer_if *msg, struct msg *m)
645 m->capab_transformnum=-1;
646 m->hashstart=msg->start;
648 m->dest=buf_unprepend_uint32(msg);
650 m->source=buf_unprepend_uint32(msg);
651 CHECK_TYPE(msg,type);
652 if (!unpick_name(msg,&m->remote)) return False;
653 m->remote_capabilities=0;
655 if (m->remote.extrainfo.size) {
656 CHECK_AVAIL(&m->remote.extrainfo,4);
657 m->remote_capabilities=buf_unprepend_uint32(&m->remote.extrainfo);
659 if (type_is_msg34(type) && m->remote.extrainfo.size) {
660 CHECK_AVAIL(&m->remote.extrainfo,2);
661 m->remote_mtu=buf_unprepend_uint16(&m->remote.extrainfo);
663 if (!unpick_name(msg,&m->local)) return False;
664 if (type==LABEL_PROD) {
668 CHECK_AVAIL(msg,NONCELEN);
669 m->nR=buf_unprepend(msg,NONCELEN);
670 if (type==LABEL_MSG1) {
674 CHECK_AVAIL(msg,NONCELEN);
675 m->nL=buf_unprepend(msg,NONCELEN);
676 if (type==LABEL_MSG2) {
680 if (type==LABEL_MSG3BIS) {
682 m->capab_transformnum = buf_unprepend_uint8(msg);
684 m->capab_transformnum = CAPAB_TRANSFORMNUM_ANCIENT;
687 m->pklen=buf_unprepend_uint16(msg);
688 CHECK_AVAIL(msg,m->pklen);
689 m->pk=buf_unprepend(msg,m->pklen);
690 m->hashlen=msg->start-m->hashstart;
692 m->siglen=buf_unprepend_uint16(msg);
693 CHECK_AVAIL(msg,m->siglen);
694 m->sig=buf_unprepend(msg,m->siglen);
699 static bool_t name_matches(const struct parsedname *nm, const char *expected)
701 int expected_len=strlen(expected);
703 nm->len == expected_len &&
704 !memcmp(nm->name, expected, expected_len);
707 static bool_t check_msg(struct site *st, uint32_t type, struct msg *m,
710 if (type==LABEL_MSG1) return True;
712 /* Check that the site names and our nonce have been sent
713 back correctly, and then store our peer's nonce. */
714 if (!name_matches(&m->remote,st->remotename)) {
715 *error="wrong remote site name";
718 if (!name_matches(&m->local,st->localname)) {
719 *error="wrong local site name";
722 if (memcmp(m->nL,st->localN,NONCELEN)!=0) {
723 *error="wrong locally-generated nonce";
726 if (type==LABEL_MSG2) return True;
727 if (!consttime_memeq(m->nR,st->remoteN,NONCELEN)!=0) {
728 *error="wrong remotely-generated nonce";
731 /* MSG3 has complicated rules about capabilities, which are
732 * handled in process_msg3. */
733 if (type==LABEL_MSG3 || type==LABEL_MSG3BIS) return True;
734 if (m->remote_capabilities!=st->remote_capabilities) {
735 *error="remote capabilities changed";
738 if (type==LABEL_MSG4) return True;
739 *error="unknown message type";
743 static bool_t generate_msg1(struct site *st)
745 st->random->generate(st->random->st,NONCELEN,st->localN);
746 return generate_msg(st,LABEL_MSG1,"site:MSG1");
749 static bool_t process_msg1(struct site *st, struct buffer_if *msg1,
750 const struct comm_addr *src, struct msg *m)
752 /* We've already determined we're in an appropriate state to
753 process an incoming MSG1, and that the MSG1 has correct values
756 st->setup_session_id=m->source;
757 st->remote_capabilities=m->remote_capabilities;
758 memcpy(st->remoteN,m->nR,NONCELEN);
762 static bool_t generate_msg2(struct site *st)
764 st->random->generate(st->random->st,NONCELEN,st->localN);
765 return generate_msg(st,LABEL_MSG2,"site:MSG2");
768 static bool_t process_msg2(struct site *st, struct buffer_if *msg2,
769 const struct comm_addr *src)
774 if (!unpick_msg(st,LABEL_MSG2,msg2,&m)) return False;
775 if (!check_msg(st,LABEL_MSG2,&m,&err)) {
776 slog(st,LOG_SEC,"msg2: %s",err);
779 st->setup_session_id=m.source;
780 st->remote_capabilities=m.remote_capabilities;
782 /* Select the transform to use */
784 uint32_t remote_transforms = st->remote_capabilities & CAPAB_TRANSFORM_MASK;
785 if (!remote_transforms)
786 /* old secnets only had this one transform */
787 remote_transforms = 1UL << CAPAB_TRANSFORMNUM_ANCIENT;
789 struct transform_if *ti;
791 for (i=0; i<st->ntransforms; i++) {
792 ti=st->transforms[i];
793 if ((1UL << ti->capab_transformnum) & remote_transforms)
794 goto transform_found;
796 slog(st,LOG_ERROR,"no transforms in common"
797 " (us %#"PRIx32"; them: %#"PRIx32")",
798 st->local_capabilities & CAPAB_TRANSFORM_MASK,
802 st->chosen_transform=ti;
804 memcpy(st->remoteN,m.nR,NONCELEN);
808 static bool_t generate_msg3(struct site *st)
810 /* Now we have our nonce and their nonce. Think of a secret key,
811 and create message number 3. */
812 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
813 return generate_msg(st,
814 (st->remote_capabilities & CAPAB_TRANSFORM_MASK
815 ? LABEL_MSG3BIS : LABEL_MSG3),
819 static bool_t process_msg3_msg4(struct site *st, struct msg *m)
824 /* Check signature and store g^x mod m */
825 hash=safe_malloc(st->hash->len, "process_msg3_msg4");
826 hst=st->hash->init();
827 st->hash->update(hst,m->hashstart,m->hashlen);
828 st->hash->final(hst,hash);
829 /* Terminate signature with a '0' - cheating, but should be ok */
831 if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m->sig)) {
832 slog(st,LOG_SEC,"msg3/msg4 signature failed check!");
838 st->remote_adv_mtu=m->remote_mtu;
843 static bool_t process_msg3(struct site *st, struct buffer_if *msg3,
844 const struct comm_addr *src, uint32_t msgtype)
849 assert(msgtype==LABEL_MSG3 || msgtype==LABEL_MSG3BIS);
851 if (!unpick_msg(st,msgtype,msg3,&m)) return False;
852 if (!check_msg(st,msgtype,&m,&err)) {
853 slog(st,LOG_SEC,"msg3: %s",err);
856 uint32_t capab_adv_late = m.remote_capabilities
857 & ~st->remote_capabilities & CAPAB_EARLY;
858 if (capab_adv_late) {
859 slog(st,LOG_SEC,"msg3 impermissibly adds early capability flag(s)"
860 " %#"PRIx32" (was %#"PRIx32", now %#"PRIx32")",
861 capab_adv_late, st->remote_capabilities, m.remote_capabilities);
864 st->remote_capabilities|=m.remote_capabilities;
866 struct transform_if *ti;
868 for (i=0; i<st->ntransforms; i++) {
869 ti=st->transforms[i];
870 if (ti->capab_transformnum == m.capab_transformnum)
871 goto transform_found;
873 slog(st,LOG_SEC,"peer chose unknown-to-us transform %d!",
874 m.capab_transformnum);
877 st->chosen_transform=ti;
879 if (!process_msg3_msg4(st,&m))
882 /* Terminate their DH public key with a '0' */
884 /* Invent our DH secret key */
885 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
887 /* Generate the shared key and set up the transform */
888 set_new_transform(st,m.pk);
893 static bool_t generate_msg4(struct site *st)
895 /* We have both nonces, their public key and our private key. Generate
896 our public key, sign it and send it to them. */
897 return generate_msg(st,LABEL_MSG4,"site:MSG4");
900 static bool_t process_msg4(struct site *st, struct buffer_if *msg4,
901 const struct comm_addr *src)
906 if (!unpick_msg(st,LABEL_MSG4,msg4,&m)) return False;
907 if (!check_msg(st,LABEL_MSG4,&m,&err)) {
908 slog(st,LOG_SEC,"msg4: %s",err);
912 if (!process_msg3_msg4(st,&m))
915 /* Terminate their DH public key with a '0' */
918 /* Generate the shared key and set up the transform */
919 set_new_transform(st,m.pk);
930 static bool_t unpick_msg0(struct site *st, struct buffer_if *msg0,
934 m->dest=buf_unprepend_uint32(msg0);
936 m->source=buf_unprepend_uint32(msg0);
938 m->type=buf_unprepend_uint32(msg0);
940 /* Leaves transformed part of buffer untouched */
943 static bool_t generate_msg5(struct site *st)
945 cstring_t transform_err;
947 BUF_ALLOC(&st->buffer,"site:MSG5");
948 /* We are going to add four words to the message */
949 buffer_init(&st->buffer,calculate_max_start_pad());
950 /* Give the netlink code an opportunity to put its own stuff in the
951 message (configuration information, etc.) */
952 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
953 if (call_transform_forwards(st,st->new_transform,
954 &st->buffer,&transform_err))
956 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
957 buf_prepend_uint32(&st->buffer,st->index);
958 buf_prepend_uint32(&st->buffer,st->setup_session_id);
960 st->retries=st->setup_retries;
964 static bool_t process_msg5(struct site *st, struct buffer_if *msg5,
965 const struct comm_addr *src,
966 struct transform_inst_if *transform)
969 cstring_t transform_err;
971 if (!unpick_msg0(st,msg5,&m)) return False;
973 if (call_transform_reverse(st,transform,msg5,&transform_err)) {
974 /* There's a problem */
975 slog(st,LOG_SEC,"process_msg5: transform: %s",transform_err);
978 /* Buffer should now contain untransformed PING packet data */
980 if (buf_unprepend_uint32(msg5)!=LABEL_MSG5) {
981 slog(st,LOG_SEC,"MSG5/PING packet contained wrong label");
984 /* Older versions of secnet used to write some config data here
985 * which we ignore. So we don't CHECK_EMPTY */
989 static void create_msg6(struct site *st, struct transform_inst_if *transform,
992 cstring_t transform_err;
994 BUF_ALLOC(&st->buffer,"site:MSG6");
995 /* We are going to add four words to the message */
996 buffer_init(&st->buffer,calculate_max_start_pad());
997 /* Give the netlink code an opportunity to put its own stuff in the
998 message (configuration information, etc.) */
999 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1000 int problem = call_transform_forwards(st,transform,
1001 &st->buffer,&transform_err);
1003 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1004 buf_prepend_uint32(&st->buffer,st->index);
1005 buf_prepend_uint32(&st->buffer,session_id);
1008 static bool_t generate_msg6(struct site *st)
1010 if (!is_transform_valid(st->new_transform))
1012 create_msg6(st,st->new_transform,st->setup_session_id);
1013 st->retries=1; /* Peer will retransmit MSG5 if this packet gets lost */
1017 static bool_t process_msg6(struct site *st, struct buffer_if *msg6,
1018 const struct comm_addr *src)
1021 cstring_t transform_err;
1023 if (!unpick_msg0(st,msg6,&m)) return False;
1025 if (call_transform_reverse(st,st->new_transform,msg6,&transform_err)) {
1026 /* There's a problem */
1027 slog(st,LOG_SEC,"process_msg6: transform: %s",transform_err);
1030 /* Buffer should now contain untransformed PING packet data */
1031 CHECK_AVAIL(msg6,4);
1032 if (buf_unprepend_uint32(msg6)!=LABEL_MSG6) {
1033 slog(st,LOG_SEC,"MSG6/PONG packet contained invalid data");
1036 /* Older versions of secnet used to write some config data here
1037 * which we ignore. So we don't CHECK_EMPTY */
1041 static bool_t decrypt_msg0(struct site *st, struct buffer_if *msg0,
1042 const struct comm_addr *src)
1044 cstring_t transform_err, auxkey_err, newkey_err="n/a";
1048 if (!unpick_msg0(st,msg0,&m)) return False;
1050 /* Keep a copy so we can try decrypting it with multiple keys */
1051 buffer_copy(&st->scratch, msg0);
1053 problem = call_transform_reverse(st,st->current.transform,
1054 msg0,&transform_err);
1056 if (!st->auxiliary_is_new)
1057 delete_one_key(st,&st->auxiliary_key,
1058 "peer has used new key","auxiliary key",LOG_SEC);
1064 buffer_copy(msg0, &st->scratch);
1065 problem = call_transform_reverse(st,st->auxiliary_key.transform,
1068 slog(st,LOG_DROP,"processing packet which uses auxiliary key");
1069 if (st->auxiliary_is_new) {
1070 /* We previously timed out in state SENTMSG5 but it turns
1071 * out that our peer did in fact get our MSG5 and is
1072 * using the new key. So we should switch to it too. */
1073 /* This is a bit like activate_new_key. */
1076 st->current=st->auxiliary_key;
1077 st->auxiliary_key=t;
1079 delete_one_key(st,&st->auxiliary_key,"peer has used new key",
1080 "previous key",LOG_SEC);
1081 st->auxiliary_is_new=0;
1082 st->renegotiate_key_time=st->auxiliary_renegotiate_key_time;
1089 if (st->state==SITE_SENTMSG5) {
1090 buffer_copy(msg0, &st->scratch);
1091 problem = call_transform_reverse(st,st->new_transform,
1094 /* It looks like we didn't get the peer's MSG6 */
1095 /* This is like a cut-down enter_new_state(SITE_RUN) */
1096 slog(st,LOG_STATE,"will enter state RUN (MSG0 with new key)");
1097 BUF_FREE(&st->buffer);
1099 activate_new_key(st);
1100 return True; /* do process the data in this packet */
1106 slog(st,LOG_SEC,"transform: %s (aux: %s, new: %s)",
1107 transform_err,auxkey_err,newkey_err);
1108 initiate_key_setup(st,"incoming message would not decrypt",0);
1109 send_nak(src,m.dest,m.source,m.type,msg0,"message would not decrypt");
1113 slog(st,LOG_DROP,"transform: %s (merely skew)",transform_err);
1117 static bool_t process_msg0(struct site *st, struct buffer_if *msg0,
1118 const struct comm_addr *src)
1122 if (!decrypt_msg0(st,msg0,src))
1125 CHECK_AVAIL(msg0,4);
1126 type=buf_unprepend_uint32(msg0);
1129 /* We must forget about the current session. */
1130 delete_keys(st,"request from peer",LOG_SEC);
1133 /* Deliver to netlink layer */
1134 st->netlink->deliver(st->netlink->st,msg0);
1135 transport_data_msgok(st,src);
1136 /* See whether we should start negotiating a new key */
1137 if (st->now > st->renegotiate_key_time)
1138 initiate_key_setup(st,"incoming packet in renegotiation window",0);
1141 slog(st,LOG_SEC,"incoming encrypted message of type %08x "
1148 static void dump_packet(struct site *st, struct buffer_if *buf,
1149 const struct comm_addr *addr, bool_t incoming)
1151 uint32_t dest=get_uint32(buf->start);
1152 uint32_t source=get_uint32(buf->start+4);
1153 uint32_t msgtype=get_uint32(buf->start+8);
1155 if (st->log_events & LOG_DUMP)
1156 slilog(st->log,M_DEBUG,"%s: %s: %08x<-%08x: %08x:",
1157 st->tunname,incoming?"incoming":"outgoing",
1158 dest,source,msgtype);
1161 static uint32_t site_status(void *st)
1166 static bool_t send_msg(struct site *st)
1168 if (st->retries>0) {
1169 transport_xmit(st, &st->setup_peers, &st->buffer, True);
1170 st->timeout=st->now+st->setup_retry_interval;
1173 } else if (st->state==SITE_SENTMSG5) {
1174 logtimeout(st,"timed out sending MSG5, stashing new key");
1175 /* We stash the key we have produced, in case it turns out that
1176 * our peer did see our MSG5 after all and starts using it. */
1177 /* This is a bit like some of activate_new_key */
1178 struct transform_inst_if *t;
1179 t=st->auxiliary_key.transform;
1180 st->auxiliary_key.transform=st->new_transform;
1181 st->new_transform=t;
1182 dispose_transform(&st->new_transform);
1184 st->auxiliary_is_new=1;
1185 st->auxiliary_key.key_timeout=st->now+st->key_lifetime;
1186 st->auxiliary_renegotiate_key_time=st->now+st->key_renegotiate_time;
1187 st->auxiliary_key.remote_session_id=st->setup_session_id;
1189 enter_state_wait(st);
1192 logtimeout(st,"timed out sending key setup packet "
1193 "(in state %s)",state_name(st->state));
1194 enter_state_wait(st);
1199 static void site_resolve_callback(void *sst, const struct comm_addr *addrs,
1200 int naddrs, const char *address,
1201 const char *failwhy)
1203 struct site *st=sst;
1206 slog(st,LOG_ERROR,"resolution of %s failed: %s",address,failwhy);
1208 slog(st,LOG_PEER_ADDRS,"resolution of %s completed, %d addrs, eg: %s",
1209 address, naddrs, comm_addr_to_string(&addrs[0]));;
1211 int n_tocopy = MIN(st->transport_peers_max - st->resolving_n_results,
1213 COPY_ARRAY(st->resolving_results + st->resolving_n_results,
1216 st->resolving_n_results += naddrs;
1219 decrement_resolving_count(st,1);
1222 static void decrement_resolving_count(struct site *st, int by)
1224 assert(st->resolving_count>0);
1225 st->resolving_count-=by;
1227 if (st->resolving_count)
1230 /* OK, we are done with them all. Handle combined results. */
1232 const struct comm_addr *addrs=st->resolving_results;
1233 int naddrs=st->resolving_n_results;
1236 slog(st,LOG_STATE,"resolution completed, %d addrs, eg: %s",
1237 naddrs, comm_addr_to_string(&addrs[0]));;
1238 if (st->resolving_n_results > st->transport_peers_max) {
1239 slog(st,LOG_STATE,"resolution of supplied addresses/names"
1240 " yielded too many results (%d > %d), some ignored",
1241 st->resolving_n_results, st->transport_peers_max);
1242 st->resolving_n_results=st->transport_peers_max;
1246 switch (st->state) {
1248 if (transport_compute_setupinit_peers(st,addrs,naddrs,0)) {
1249 enter_new_state(st,SITE_SENTMSG1);
1251 /* Can't figure out who to try to to talk to */
1252 slog(st,LOG_SETUP_INIT,
1253 "key exchange failed: cannot find peer address");
1254 enter_state_run(st);
1257 case SITE_SENTMSG1: case SITE_SENTMSG2:
1258 case SITE_SENTMSG3: case SITE_SENTMSG4:
1261 /* We start using the address immediately for data too.
1262 * It's best to store it in st->peers now because we might
1263 * go via SENTMSG5, WAIT, and a MSG0, straight into using
1264 * the new key (without updating the data peer addrs). */
1265 transport_resolve_complete(st,addrs,naddrs);
1266 } else if (st->local_mobile) {
1267 /* We can't let this rest because we may have a peer
1268 * address which will break in the future. */
1269 slog(st,LOG_SETUP_INIT,"resolution failed: "
1270 "abandoning key exchange");
1271 enter_state_wait(st);
1273 slog(st,LOG_SETUP_INIT,"resolution failed: "
1274 " continuing to use source address of peer's packets"
1275 " for key exchange and ultimately data");
1280 slog(st,LOG_SETUP_INIT,"resolution completed tardily,"
1281 " updating peer address(es)");
1282 transport_resolve_complete_tardy(st,addrs,naddrs);
1283 } else if (st->local_mobile) {
1284 /* Not very good. We should queue (another) renegotiation
1285 * so that we can update the peer address. */
1286 st->key_renegotiate_time=st->now+st->wait_timeout;
1288 slog(st,LOG_SETUP_INIT,"resolution failed: "
1289 " continuing to use source address of peer's packets");
1299 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
1300 const struct comm_addr *prod_hint)
1302 /* Reentrancy hazard: can call enter_new_state/enter_state_* */
1303 if (st->state!=SITE_RUN) return False;
1304 slog(st,LOG_SETUP_INIT,"initiating key exchange (%s)",reason);
1305 if (st->addresses) {
1306 slog(st,LOG_SETUP_INIT,"resolving peer address(es)");
1307 return enter_state_resolve(st);
1308 } else if (transport_compute_setupinit_peers(st,0,0,prod_hint)) {
1309 return enter_new_state(st,SITE_SENTMSG1);
1311 slog(st,LOG_SETUP_INIT,"key exchange failed: no address for peer");
1315 static void activate_new_key(struct site *st)
1317 struct transform_inst_if *t;
1319 /* We have three transform instances, which we swap between old,
1321 t=st->auxiliary_key.transform;
1322 st->auxiliary_key.transform=st->current.transform;
1323 st->current.transform=st->new_transform;
1324 st->new_transform=t;
1325 dispose_transform(&st->new_transform);
1328 st->auxiliary_is_new=0;
1329 st->auxiliary_key.key_timeout=st->current.key_timeout;
1330 st->current.key_timeout=st->now+st->key_lifetime;
1331 st->renegotiate_key_time=st->now+st->key_renegotiate_time;
1332 transport_peers_copy(st,&st->peers,&st->setup_peers);
1333 st->current.remote_session_id=st->setup_session_id;
1335 /* Compute the inter-site MTU. This is min( our_mtu, their_mtu ).
1336 * But their mtu be unspecified, in which case we just use ours. */
1337 uint32_t intersite_mtu=
1338 MIN(st->mtu_target, st->remote_adv_mtu ?: ~(uint32_t)0);
1339 st->netlink->set_mtu(st->netlink->st,intersite_mtu);
1341 slog(st,LOG_ACTIVATE_KEY,"new key activated"
1342 " (mtu ours=%"PRId32" theirs=%"PRId32" intersite=%"PRId32")",
1343 st->mtu_target, st->remote_adv_mtu, intersite_mtu);
1344 enter_state_run(st);
1347 static void delete_one_key(struct site *st, struct data_key *key,
1348 cstring_t reason, cstring_t which, uint32_t loglevel)
1350 if (!is_transform_valid(key->transform)) return;
1351 if (reason) slog(st,loglevel,"%s deleted (%s)",which,reason);
1352 dispose_transform(&key->transform);
1356 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel)
1358 if (current_valid(st)) {
1359 slog(st,loglevel,"session closed (%s)",reason);
1361 delete_one_key(st,&st->current,0,0,0);
1362 set_link_quality(st);
1364 delete_one_key(st,&st->auxiliary_key,0,0,0);
1367 static void state_assert(struct site *st, bool_t ok)
1369 if (!ok) fatal("site:state_assert");
1372 static void enter_state_stop(struct site *st)
1374 st->state=SITE_STOP;
1376 delete_keys(st,"entering state STOP",LOG_TIMEOUT_KEY);
1377 dispose_transform(&st->new_transform);
1380 static void set_link_quality(struct site *st)
1383 if (current_valid(st))
1384 quality=LINK_QUALITY_UP;
1385 else if (st->state==SITE_WAIT || st->state==SITE_STOP)
1386 quality=LINK_QUALITY_DOWN;
1387 else if (st->addresses)
1388 quality=LINK_QUALITY_DOWN_CURRENT_ADDRESS;
1389 else if (transport_peers_valid(&st->peers))
1390 quality=LINK_QUALITY_DOWN_STALE_ADDRESS;
1392 quality=LINK_QUALITY_DOWN;
1394 st->netlink->set_quality(st->netlink->st,quality);
1397 static void enter_state_run(struct site *st)
1399 slog(st,LOG_STATE,"entering state RUN");
1403 st->setup_session_id=0;
1404 transport_peers_clear(st,&st->setup_peers);
1405 FILLZERO(st->localN);
1406 FILLZERO(st->remoteN);
1407 dispose_transform(&st->new_transform);
1408 memset(st->dhsecret,0,st->dh->len);
1409 memset(st->sharedsecret,0,st->sharedsecretlen);
1410 set_link_quality(st);
1413 static bool_t ensure_resolving(struct site *st)
1415 /* Reentrancy hazard: may call site_resolve_callback and hence
1416 * enter_new_state, enter_state_* and generate_msg*. */
1417 if (st->resolving_count)
1420 assert(st->addresses);
1422 /* resolver->request might reentrantly call site_resolve_callback
1423 * which will decrement st->resolving, so we need to increment it
1424 * twice beforehand to prevent decrement from thinking we're
1425 * finished, and decrement it ourselves. Alternatively if
1426 * everything fails then there are no callbacks due and we simply
1427 * set it to 0 and return false.. */
1428 st->resolving_n_results=0;
1429 st->resolving_count+=2;
1430 const char **addrp=st->addresses;
1431 const char *address;
1433 for (; (address=*addrp++); ) {
1434 bool_t ok = st->resolver->request(st->resolver->st,address,
1435 st->remoteport,st->comms[0],
1436 site_resolve_callback,st);
1438 st->resolving_count++;
1442 st->resolving_count=0;
1445 decrement_resolving_count(st,2);
1449 static bool_t enter_state_resolve(struct site *st)
1451 /* Reentrancy hazard! See ensure_resolving. */
1452 state_assert(st,st->state==SITE_RUN);
1453 slog(st,LOG_STATE,"entering state RESOLVE");
1454 st->state=SITE_RESOLVE;
1455 return ensure_resolving(st);
1458 static bool_t enter_new_state(struct site *st, uint32_t next)
1460 bool_t (*gen)(struct site *st);
1463 slog(st,LOG_STATE,"entering state %s",state_name(next));
1466 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
1470 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1471 st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
1475 state_assert(st,st->state==SITE_SENTMSG1);
1476 BUF_FREE(&st->buffer);
1480 state_assert(st,st->state==SITE_SENTMSG2);
1481 BUF_FREE(&st->buffer);
1485 state_assert(st,st->state==SITE_SENTMSG3);
1486 BUF_FREE(&st->buffer);
1490 state_assert(st,st->state==SITE_SENTMSG4);
1491 BUF_FREE(&st->buffer);
1496 fatal("enter_new_state(%s): invalid new state",state_name(next));
1500 if (hacky_par_start_failnow()) return False;
1502 r= gen(st) && send_msg(st);
1505 st->setup_retries, st->setup_retry_interval,
1510 if (next==SITE_RUN) {
1511 BUF_FREE(&st->buffer); /* Never reused */
1512 st->timeout=0; /* Never retransmit */
1513 activate_new_key(st);
1517 slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1518 st->buffer.free=False; /* Unconditionally use the buffer; it may be
1519 in either state, and enter_state_wait() will
1521 enter_state_wait(st);
1525 /* msg7 tells our peer that we're about to forget our key */
1526 static bool_t send_msg7(struct site *st, cstring_t reason)
1528 cstring_t transform_err;
1530 if (current_valid(st) && st->buffer.free
1531 && transport_peers_valid(&st->peers)) {
1532 BUF_ALLOC(&st->buffer,"site:MSG7");
1533 buffer_init(&st->buffer,calculate_max_start_pad());
1534 buf_append_uint32(&st->buffer,LABEL_MSG7);
1535 buf_append_string(&st->buffer,reason);
1536 if (call_transform_forwards(st, st->current.transform,
1537 &st->buffer, &transform_err))
1539 buf_prepend_uint32(&st->buffer,LABEL_MSG0);
1540 buf_prepend_uint32(&st->buffer,st->index);
1541 buf_prepend_uint32(&st->buffer,st->current.remote_session_id);
1542 transport_xmit(st,&st->peers,&st->buffer,True);
1543 BUF_FREE(&st->buffer);
1550 /* We go into this state if our peer becomes uncommunicative. Similar to
1551 the "stop" state, we forget all session keys for a while, before
1552 re-entering the "run" state. */
1553 static void enter_state_wait(struct site *st)
1555 slog(st,LOG_STATE,"entering state WAIT");
1556 st->timeout=st->now+st->wait_timeout;
1557 st->state=SITE_WAIT;
1558 set_link_quality(st);
1559 BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1560 /* XXX Erase keys etc. */
1563 static void generate_prod(struct site *st, struct buffer_if *buf)
1566 buf_append_uint32(buf,0);
1567 buf_append_uint32(buf,0);
1568 buf_append_uint32(buf,LABEL_PROD);
1569 buf_append_string(buf,st->localname);
1570 buf_append_string(buf,st->remotename);
1573 static void generate_send_prod(struct site *st,
1574 const struct comm_addr *source)
1576 if (!st->allow_send_prod) return; /* too soon */
1577 if (!(st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1578 st->state==SITE_WAIT)) return; /* we'd ignore peer's MSG1 */
1580 slog(st,LOG_SETUP_INIT,"prodding peer for key exchange");
1581 st->allow_send_prod=0;
1582 generate_prod(st,&st->scratch);
1583 dump_packet(st,&st->scratch,source,False);
1584 source->comm->sendmsg(source->comm->st, &st->scratch, source);
1587 static inline void site_settimeout(uint64_t timeout, int *timeout_io)
1590 int64_t offset=timeout-*now;
1591 if (offset<0) offset=0;
1592 if (offset>INT_MAX) offset=INT_MAX;
1593 if (*timeout_io<0 || offset<*timeout_io)
1598 static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
1601 struct site *st=sst;
1603 BEFOREPOLL_WANT_FDS(0); /* We don't use any file descriptors */
1606 /* Work out when our next timeout is. The earlier of 'timeout' or
1607 'current.key_timeout'. A stored value of '0' indicates no timeout
1609 site_settimeout(st->timeout, timeout_io);
1610 site_settimeout(st->current.key_timeout, timeout_io);
1611 site_settimeout(st->auxiliary_key.key_timeout, timeout_io);
1613 return 0; /* success */
1616 static void check_expiry(struct site *st, struct data_key *key,
1619 if (key->key_timeout && *now>key->key_timeout) {
1620 delete_one_key(st,key,"maximum life exceeded",which,LOG_TIMEOUT_KEY);
1624 /* NB site_afterpoll will be called before site_beforepoll is ever called */
1625 static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
1627 struct site *st=sst;
1630 if (st->timeout && *now>st->timeout) {
1632 if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
1633 if (!hacky_par_start_failnow())
1635 } else if (st->state==SITE_WAIT) {
1636 enter_state_run(st);
1638 slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
1642 check_expiry(st,&st->current,"current key");
1643 check_expiry(st,&st->auxiliary_key,"auxiliary key");
1646 /* This function is called by the netlink device to deliver packets
1647 intended for the remote network. The packet is in "raw" wire
1648 format, but is guaranteed to be word-aligned. */
1649 static void site_outgoing(void *sst, struct buffer_if *buf)
1651 struct site *st=sst;
1652 cstring_t transform_err;
1654 if (st->state==SITE_STOP) {
1659 st->allow_send_prod=1;
1661 /* In all other states we consider delivering the packet if we have
1662 a valid key and a valid address to send it to. */
1663 if (current_valid(st) && transport_peers_valid(&st->peers)) {
1664 /* Transform it and send it */
1666 buf_prepend_uint32(buf,LABEL_MSG9);
1667 if (call_transform_forwards(st, st->current.transform,
1668 buf, &transform_err))
1670 buf_prepend_uint32(buf,LABEL_MSG0);
1671 buf_prepend_uint32(buf,st->index);
1672 buf_prepend_uint32(buf,st->current.remote_session_id);
1673 transport_xmit(st,&st->peers,buf,False);
1680 slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
1682 initiate_key_setup(st,"outgoing packet",0);
1685 static bool_t named_for_us(struct site *st, const struct buffer_if *buf_in,
1686 uint32_t type, struct msg *m)
1687 /* For packets which are identified by the local and remote names.
1688 * If it has our name and our peer's name in it it's for us. */
1690 struct buffer_if buf[1];
1691 buffer_readonly_clone(buf,buf_in);
1692 return unpick_msg(st,type,buf,m)
1693 && name_matches(&m->remote,st->remotename)
1694 && name_matches(&m->local,st->localname);
1697 /* This function is called by the communication device to deliver
1698 packets from our peers.
1699 It should return True if the packet is recognised as being for
1700 this current site instance (and should therefore not be processed
1701 by other sites), even if the packet was otherwise ignored. */
1702 static bool_t site_incoming(void *sst, struct buffer_if *buf,
1703 const struct comm_addr *source)
1705 struct site *st=sst;
1707 if (buf->size < 12) return False;
1709 uint32_t dest=get_uint32(buf->start);
1710 uint32_t msgtype=get_uint32(buf->start+8);
1711 struct msg named_msg;
1713 if (msgtype==LABEL_MSG1) {
1714 if (!named_for_us(st,buf,msgtype,&named_msg))
1716 /* It's a MSG1 addressed to us. Decide what to do about it. */
1717 dump_packet(st,buf,source,True);
1718 if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1719 st->state==SITE_WAIT) {
1720 /* We should definitely process it */
1721 transport_compute_setupinit_peers(st,0,0,source);
1722 if (process_msg1(st,buf,source,&named_msg)) {
1723 slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
1724 bool_t entered=enter_new_state(st,SITE_SENTMSG2);
1725 if (entered && st->addresses && st->local_mobile)
1726 /* We must do this as the very last thing, because
1727 the resolver callback might reenter us. */
1728 ensure_resolving(st);
1730 slog(st,LOG_ERROR,"failed to process incoming msg1");
1734 } else if (st->state==SITE_SENTMSG1) {
1735 /* We've just sent a message 1! They may have crossed on
1736 the wire. If we have priority then we ignore the
1737 incoming one, otherwise we process it as usual. */
1738 if (st->setup_priority) {
1740 slog(st,LOG_DUMP,"crossed msg1s; we are higher "
1741 "priority => ignore incoming msg1");
1744 slog(st,LOG_DUMP,"crossed msg1s; we are lower "
1745 "priority => use incoming msg1");
1746 if (process_msg1(st,buf,source,&named_msg)) {
1747 BUF_FREE(&st->buffer); /* Free our old message 1 */
1748 transport_setup_msgok(st,source);
1749 enter_new_state(st,SITE_SENTMSG2);
1751 slog(st,LOG_ERROR,"failed to process an incoming "
1752 "crossed msg1 (we have low priority)");
1758 /* The message 1 was received at an unexpected stage of the
1759 key setup. XXX POLICY - what do we do? */
1760 slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
1764 if (msgtype==LABEL_PROD) {
1765 if (!named_for_us(st,buf,msgtype,&named_msg))
1767 dump_packet(st,buf,source,True);
1768 if (st->state!=SITE_RUN) {
1769 slog(st,LOG_DROP,"ignoring PROD when not in state RUN");
1770 } else if (current_valid(st)) {
1771 slog(st,LOG_DROP,"ignoring PROD when we think we have a key");
1773 initiate_key_setup(st,"peer sent PROD packet",source);
1778 if (dest==st->index) {
1779 /* Explicitly addressed to us */
1780 if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True);
1783 /* If the source is our current peer then initiate a key setup,
1784 because our peer's forgotten the key */
1785 if (get_uint32(buf->start+4)==st->current.remote_session_id) {
1787 initiated = initiate_key_setup(st,"received a NAK",source);
1788 if (!initiated) generate_send_prod(st,source);
1790 slog(st,LOG_SEC,"bad incoming NAK");
1794 process_msg0(st,buf,source);
1797 /* Setup packet: should not have been explicitly addressed
1799 slog(st,LOG_SEC,"incoming explicitly addressed msg1");
1802 /* Setup packet: expected only in state SENTMSG1 */
1803 if (st->state!=SITE_SENTMSG1) {
1804 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
1805 } else if (process_msg2(st,buf,source)) {
1806 transport_setup_msgok(st,source);
1807 enter_new_state(st,SITE_SENTMSG3);
1809 slog(st,LOG_SEC,"invalid MSG2");
1814 /* Setup packet: expected only in state SENTMSG2 */
1815 if (st->state!=SITE_SENTMSG2) {
1816 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
1817 } else if (process_msg3(st,buf,source,msgtype)) {
1818 transport_setup_msgok(st,source);
1819 enter_new_state(st,SITE_SENTMSG4);
1821 slog(st,LOG_SEC,"invalid MSG3");
1825 /* Setup packet: expected only in state SENTMSG3 */
1826 if (st->state!=SITE_SENTMSG3) {
1827 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
1828 } else if (process_msg4(st,buf,source)) {
1829 transport_setup_msgok(st,source);
1830 enter_new_state(st,SITE_SENTMSG5);
1832 slog(st,LOG_SEC,"invalid MSG4");
1836 /* Setup packet: expected only in state SENTMSG4 */
1837 /* (may turn up in state RUN if our return MSG6 was lost
1838 and the new key has already been activated. In that
1839 case we discard it. The peer will realise that we
1840 are using the new key when they see our data packets.
1841 Until then the peer's data packets to us get discarded. */
1842 if (st->state==SITE_SENTMSG4) {
1843 if (process_msg5(st,buf,source,st->new_transform)) {
1844 transport_setup_msgok(st,source);
1845 enter_new_state(st,SITE_RUN);
1847 slog(st,LOG_SEC,"invalid MSG5");
1849 } else if (st->state==SITE_RUN) {
1850 if (process_msg5(st,buf,source,st->current.transform)) {
1851 slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
1852 transport_setup_msgok(st,source);
1853 create_msg6(st,st->current.transform,
1854 st->current.remote_session_id);
1855 transport_xmit(st,&st->peers,&st->buffer,True);
1856 BUF_FREE(&st->buffer);
1858 slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
1861 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
1865 /* Setup packet: expected only in state SENTMSG5 */
1866 if (st->state!=SITE_SENTMSG5) {
1867 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
1868 } else if (process_msg6(st,buf,source)) {
1869 BUF_FREE(&st->buffer); /* Free message 5 */
1870 transport_setup_msgok(st,source);
1871 activate_new_key(st);
1873 slog(st,LOG_SEC,"invalid MSG6");
1877 slog(st,LOG_SEC,"received message of unknown type 0x%08x",
1888 static void site_control(void *vst, bool_t run)
1890 struct site *st=vst;
1891 if (run) enter_state_run(st);
1892 else enter_state_stop(st);
1895 static void site_phase_hook(void *sst, uint32_t newphase)
1897 struct site *st=sst;
1899 /* The program is shutting down; tell our peer */
1900 send_msg7(st,"shutting down");
1903 static void site_childpersist_clearkeys(void *sst, uint32_t newphase)
1905 struct site *st=sst;
1906 dispose_transform(&st->current.transform);
1907 dispose_transform(&st->auxiliary_key.transform);
1908 dispose_transform(&st->new_transform);
1909 /* Not much point overwiting the signing key, since we loaded it
1910 from disk, and it is only valid prospectively if at all,
1912 /* XXX it would be best to overwrite the DH state, because that
1913 _is_ relevant to forward secrecy. However we have no
1914 convenient interface for doing that and in practice gmp has
1915 probably dribbled droppings all over the malloc arena. A good
1916 way to fix this would be to have a privsep child for asymmetric
1917 crypto operations, but that's a task for another day. */
1920 static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
1923 static uint32_t index_sequence;
1929 st=safe_malloc(sizeof(*st),"site_apply");
1931 st->cl.description="site";
1932 st->cl.type=CL_SITE;
1934 st->cl.interface=&st->ops;
1936 st->ops.control=site_control;
1937 st->ops.status=site_status;
1939 /* First parameter must be a dict */
1940 item=list_elem(args,0);
1941 if (!item || item->type!=t_dict)
1942 cfgfatal(loc,"site","parameter must be a dictionary\n");
1944 dict=item->data.dict;
1945 st->localname=dict_read_string(dict, "local-name", True, "site", loc);
1946 st->remotename=dict_read_string(dict, "name", True, "site", loc);
1948 st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
1950 dict_read_bool(dict,"local-mobile",False,"site",loc,False);
1952 /* Sanity check (which also allows the 'sites' file to include
1953 site() closures for all sites including our own): refuse to
1954 talk to ourselves */
1955 if (strcmp(st->localname,st->remotename)==0) {
1956 Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
1958 if (st->peer_mobile != st->local_mobile)
1959 cfgfatal(loc,"site","site %s's peer-mobile=%d"
1960 " but our local-mobile=%d\n",
1961 st->localname, st->peer_mobile, st->local_mobile);
1965 if (st->peer_mobile && st->local_mobile) {
1966 Message(M_WARNING,"site %s: site is mobile but so are we"
1967 " -> ignoring this site\n", st->remotename);
1972 assert(index_sequence < 0xffffffffUL);
1973 st->index = ++index_sequence;
1974 st->local_capabilities = 0;
1975 st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
1977 #define GET_CLOSURE_LIST(dictkey,things,nthings,CL_TYPE) do{ \
1978 list_t *things##_cfg=dict_lookup(dict,dictkey); \
1979 if (!things##_cfg) \
1980 cfgfatal(loc,"site","closure list \"%s\" not found\n",dictkey); \
1981 st->nthings=list_length(things##_cfg); \
1982 st->things=safe_malloc_ary(sizeof(*st->things),st->nthings,dictkey "s"); \
1983 assert(st->nthings); \
1984 for (i=0; i<st->nthings; i++) { \
1985 item_t *item=list_elem(things##_cfg,i); \
1986 if (item->type!=t_closure) \
1987 cfgfatal(loc,"site","%s is not a closure\n",dictkey); \
1988 closure_t *cl=item->data.closure; \
1989 if (cl->type!=CL_TYPE) \
1990 cfgfatal(loc,"site","%s closure wrong type\n",dictkey); \
1991 st->things[i]=cl->interface; \
1995 GET_CLOSURE_LIST("comm",comms,ncomms,CL_COMM);
1997 st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
1998 st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
1999 st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
2001 st->privkey=find_cl_if(dict,"local-key",CL_RSAPRIVKEY,True,"site",loc);
2002 st->addresses=dict_read_string_array(dict,"address",False,"site",loc,0);
2004 st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
2005 else st->remoteport=0;
2006 st->pubkey=find_cl_if(dict,"key",CL_RSAPUBKEY,True,"site",loc);
2008 GET_CLOSURE_LIST("transform",transforms,ntransforms,CL_TRANSFORM);
2010 st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
2011 st->hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
2013 #define DEFAULT(D) (st->peer_mobile || st->local_mobile \
2014 ? DEFAULT_MOBILE_##D : DEFAULT_##D)
2015 #define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
2017 st->key_lifetime= CFG_NUMBER("key-lifetime", KEY_LIFETIME);
2018 st->setup_retries= CFG_NUMBER("setup-retries", SETUP_RETRIES);
2019 st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
2020 st->wait_timeout= CFG_NUMBER("wait-time", WAIT_TIME);
2021 st->mtu_target= dict_read_number(dict,"mtu-target",False,"site",loc,0);
2023 st->mobile_peer_expiry= dict_read_number(
2024 dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
2026 const char *peerskey= st->peer_mobile
2027 ? "mobile-peers-max" : "static-peers-max";
2028 st->transport_peers_max= dict_read_number(
2029 dict,peerskey,False,"site",loc,DEFAULT_MOBILE_PEERS_MAX);
2030 if (st->transport_peers_max<1 ||
2031 st->transport_peers_max>=MAX_PEER_ADDRS) {
2032 cfgfatal(loc,"site", "%s must be in range 1.."
2033 STRING(MAX_PEER_ADDRS) "\n", peerskey);
2036 if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
2037 st->key_renegotiate_time=st->key_lifetime/2;
2039 st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
2040 st->key_renegotiate_time=dict_read_number(
2041 dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
2042 if (st->key_renegotiate_time > st->key_lifetime) {
2043 cfgfatal(loc,"site",
2044 "renegotiate-time must be less than key-lifetime\n");
2047 st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
2048 log_event_table,"site");
2050 st->resolving_count=0;
2051 st->allow_send_prod=0;
2053 st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
2055 sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
2057 /* The information we expect to see in incoming messages of type 1 */
2058 /* fixme: lots of unchecked overflows here, but the results are only
2059 corrupted packets rather than undefined behaviour */
2060 st->setup_priority=(strcmp(st->localname,st->remotename)>0);
2062 buffer_new(&st->buffer,SETUP_BUFFER_LEN);
2064 buffer_new(&st->scratch,SETUP_BUFFER_LEN);
2065 BUF_ALLOC(&st->scratch,"site:scratch");
2067 /* We are interested in poll(), but only for timeouts. We don't have
2068 any fds of our own. */
2069 register_for_poll(st, site_beforepoll, site_afterpoll, "site");
2072 st->remote_capabilities=0;
2073 st->chosen_transform=0;
2074 st->current.key_timeout=0;
2075 st->auxiliary_key.key_timeout=0;
2076 transport_peers_clear(st,&st->peers);
2077 transport_peers_clear(st,&st->setup_peers);
2078 /* XXX mlock these */
2079 st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
2080 st->sharedsecretlen=st->sharedsecretallocd=0;
2083 for (i=0; i<st->ntransforms; i++) {
2084 struct transform_if *ti=st->transforms[i];
2085 uint32_t capbit = 1UL << ti->capab_transformnum;
2086 if (st->local_capabilities & capbit)
2087 slog(st,LOG_ERROR,"transformnum capability bit"
2088 " %d (%#"PRIx32") reused", ti->capab_transformnum, capbit);
2089 st->local_capabilities |= capbit;
2092 /* We need to register the remote networks with the netlink device */
2093 uint32_t netlink_mtu; /* local virtual interface mtu */
2094 st->netlink->reg(st->netlink->st, site_outgoing, st, &netlink_mtu);
2095 if (!st->mtu_target)
2096 st->mtu_target=netlink_mtu;
2098 for (i=0; i<st->ncomms; i++)
2099 st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
2101 st->current.transform=0;
2102 st->auxiliary_key.transform=0;
2103 st->new_transform=0;
2104 st->auxiliary_is_new=0;
2106 enter_state_stop(st);
2108 add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
2109 add_hook(PHASE_CHILDPERSIST,site_childpersist_clearkeys,st);
2111 return new_closure(&st->cl);
2114 void site_module(dict_t *dict)
2116 add_closure(dict,"site",site_apply);
2120 /***** TRANSPORT PEERS definitions *****/
2122 static void transport_peers_debug(struct site *st, transport_peers *dst,
2123 const char *didwhat,
2124 int nargs, const struct comm_addr *args,
2129 if (!(st->log_events & LOG_PEER_ADDRS))
2130 return; /* an optimisation */
2132 slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
2133 (dst==&st->peers ? "data" :
2134 dst==&st->setup_peers ? "setup" : "UNKNOWN"),
2135 didwhat, nargs, dst->npeers);
2137 for (i=0, argp=(void*)args;
2139 i++, (argp+=stride?stride:sizeof(*args))) {
2140 const struct comm_addr *ca=(void*)argp;
2141 slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
2142 i, comm_addr_to_string(ca));
2144 for (i=0; i<dst->npeers; i++) {
2145 struct timeval diff;
2146 timersub(tv_now,&dst->peers[i].last,&diff);
2147 const struct comm_addr *ca=&dst->peers[i].addr;
2148 slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
2149 i, comm_addr_to_string(ca),
2150 (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
2154 static bool_t transport_addrs_equal(const struct comm_addr *a,
2155 const struct comm_addr *b) {
2156 return !memcmp(a,b,sizeof(*a));
2159 static void transport_peers_expire(struct site *st, transport_peers *peers) {
2160 /* peers must be sorted first */
2161 int previous_peers=peers->npeers;
2162 struct timeval oldest;
2163 oldest.tv_sec = tv_now->tv_sec - st->mobile_peer_expiry;
2164 oldest.tv_usec = tv_now->tv_usec;
2165 while (peers->npeers>1 &&
2166 timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
2168 if (peers->npeers != previous_peers)
2169 transport_peers_debug(st,peers,"expire", 0,0,0);
2172 static bool_t transport_peer_record_one(struct site *st, transport_peers *peers,
2173 const struct comm_addr *ca,
2174 const struct timeval *tv) {
2175 /* returns false if output is full */
2178 if (peers->npeers > st->transport_peers_max)
2181 for (search=0; search<peers->npeers; search++)
2182 if (transport_addrs_equal(&peers->peers[search].addr, ca))
2185 peers->peers[peers->npeers].addr = *ca;
2186 peers->peers[peers->npeers].last = *tv;
2191 static void transport_record_peers(struct site *st, transport_peers *peers,
2192 const struct comm_addr *addrs, int naddrs,
2194 /* We add addrs into peers. The new entries end up at the front
2195 * and displace entries towards the end (perhaps even off the end).
2196 * Any existing matching entries are moved up to the front.
2197 * Caller must first call transport_peers_expire. */
2199 if (naddrs==1 && peers->npeers>=1 &&
2200 transport_addrs_equal(&addrs[0], &peers->peers[0].addr)) {
2201 /* optimisation, also avoids debug for trivial updates */
2202 peers->peers[0].last = *tv_now;
2206 int old_npeers=peers->npeers;
2207 transport_peer old_peers[old_npeers];
2208 COPY_ARRAY(old_peers,peers->peers,old_npeers);
2212 for (i=0; i<naddrs; i++) {
2213 if (!transport_peer_record_one(st,peers, &addrs[i], tv_now))
2216 for (i=0; i<old_npeers; i++) {
2217 const transport_peer *old=&old_peers[i];
2218 if (!transport_peer_record_one(st,peers, &old->addr, &old->last))
2222 transport_peers_debug(st,peers,m, naddrs,addrs,0);
2225 static bool_t transport_compute_setupinit_peers(struct site *st,
2226 const struct comm_addr *configured_addrs /* 0 if none or not found */,
2227 int n_configured_addrs /* 0 if none or not found */,
2228 const struct comm_addr *incoming_packet_addr /* 0 if none */) {
2229 if (!n_configured_addrs && !incoming_packet_addr &&
2230 !transport_peers_valid(&st->peers))
2233 slog(st,LOG_SETUP_INIT,
2234 "using: %d configured addr(s);%s %d old peer addrs(es)",
2236 incoming_packet_addr ? " incoming packet address;" : "",
2239 /* Non-mobile peers try addresses until one is plausible. The
2240 * effect is that this code always tries first the configured
2241 * address if supplied, or otherwise the address of the incoming
2242 * PROD, or finally the existing data peer if one exists; this is
2245 transport_peers_copy(st,&st->setup_peers,&st->peers);
2246 transport_peers_expire(st,&st->setup_peers);
2248 if (incoming_packet_addr)
2249 transport_record_peers(st,&st->setup_peers,
2250 incoming_packet_addr,1, "incoming");
2252 if (n_configured_addrs)
2253 transport_record_peers(st,&st->setup_peers,
2254 configured_addrs,n_configured_addrs, "setupinit");
2256 assert(transport_peers_valid(&st->setup_peers));
2260 static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
2261 if (st->peer_mobile) {
2262 transport_peers_expire(st,&st->setup_peers);
2263 transport_record_peers(st,&st->setup_peers,a,1,"setupmsg");
2266 static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
2267 if (st->peer_mobile) {
2268 transport_peers_expire(st,&st->setup_peers);
2269 transport_record_peers(st,&st->peers,a,1,"datamsg");
2273 static int transport_peers_valid(transport_peers *peers) {
2274 return peers->npeers;
2276 static void transport_peers_clear(struct site *st, transport_peers *peers) {
2278 transport_peers_debug(st,peers,"clear",0,0,0);
2280 static void transport_peers_copy(struct site *st, transport_peers *dst,
2281 const transport_peers *src) {
2282 dst->npeers=src->npeers;
2283 COPY_ARRAY(dst->peers, src->peers, dst->npeers);
2284 transport_peers_debug(st,dst,"copy",
2285 src->npeers, &src->peers->addr, sizeof(*src->peers));
2288 static void transport_resolve_complete(struct site *st,
2289 const struct comm_addr *addrs,
2291 transport_peers_expire(st,&st->peers);
2292 transport_record_peers(st,&st->peers,addrs,naddrs,"resolved data");
2293 transport_peers_expire(st,&st->setup_peers);
2294 transport_record_peers(st,&st->setup_peers,addrs,naddrs,"resolved setup");
2297 static void transport_resolve_complete_tardy(struct site *st,
2298 const struct comm_addr *addrs,
2300 transport_peers_expire(st,&st->peers);
2301 transport_record_peers(st,&st->peers,addrs,naddrs,"resolved tardily");
2304 static void transport_peers__copy_by_mask(transport_peer *out, int *nout_io,
2306 const transport_peers *inp) {
2307 /* out and in->peers may be the same region, or nonoverlapping */
2308 const transport_peer *in=inp->peers;
2310 for (slot=0; slot<inp->npeers; slot++) {
2311 if (!(mask & (1U << slot)))
2313 if (!(out==in && slot==*nout_io))
2314 COPY_OBJ(out[*nout_io], in[slot]);
2319 void transport_xmit(struct site *st, transport_peers *peers,
2320 struct buffer_if *buf, bool_t candebug) {
2322 transport_peers_expire(st, peers);
2323 unsigned failed=0; /* bitmask */
2324 assert(MAX_PEER_ADDRS < sizeof(unsigned)*CHAR_BIT);
2327 for (slot=0; slot<peers->npeers; slot++) {
2328 transport_peer *peer=&peers->peers[slot];
2330 dump_packet(st, buf, &peer->addr, False);
2332 peer->addr.comm->sendmsg(peer->addr.comm->st, buf, &peer->addr);
2334 failed |= 1U << slot;
2337 if (ok && !st->peer_mobile)
2340 /* Now we need to demote/delete failing addrs: if we are mobile we
2341 * merely demote them; otherwise we delete them. */
2342 if (st->local_mobile) {
2343 unsigned expected = ((1U << nfailed)-1) << (peers->npeers-nfailed);
2344 /* `expected' has all the failures at the end already */
2345 if (failed != expected) {
2347 transport_peer failedpeers[nfailed];
2348 transport_peers__copy_by_mask(failedpeers, &fslot, failed,peers);
2349 assert(fslot == nfailed);
2351 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2352 assert(wslot+nfailed == peers->npeers);
2353 COPY_ARRAY(peers->peers+wslot, failedpeers, nfailed);
2356 if (failed && peers->npeers > 1) {
2358 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2359 peers->npeers=wslot;
2364 /***** END of transport peers declarations *****/