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 | Note: this comment is wishful thinking right now. It will be
149 | implemented in subsequent commits.
151 - We use the same data structure for the different configurations,
152 but manage it with different algorithms.
154 - We record up to mobile_peers_max peer address/port numbers
155 ("peers") for key setup, and separately up to mobile_peers_max
158 - In general, we make a new set of addrs (see below) when we start
159 a new key exchange; the key setup addrs become the data transport
160 addrs when key setup complets.
162 If our peer is mobile:
164 - We send to all recent addresses of incoming packets, plus
165 initially all configured addresses (which we also expire).
167 - So, we record addrs of good incoming packets, as follows:
168 1. expire any peers last seen >120s ("mobile-peer-expiry") ago
169 2. add the peer of the just received packet to the applicable list
170 (possibly evicting the oldest entries to make room)
171 NB that we do not expire peers until an incoming packet arrives.
173 - If the peer has a configured address or name, we record them the
174 same way, but only as a result of our own initiation of key
175 setup. (We might evict some incoming packet addrs to make room.)
177 - The default number of addrs to keep is 3, or 4 if we have a
178 configured name or address. That's space for two configured
179 addresses (one IPv6 and one IPv4), plus two received addresses.
181 - Outgoing packets are sent to every recorded address in the
182 applicable list. Any unsupported[1] addresses are deleted from
183 the list right away. (This should only happen to configured
184 addresses, of course, but there is no need to check that.)
186 - When we successfully complete a key setup, we merge the key setup
187 peers into the data transfer peers.
189 [1] An unsupported address is one for whose AF we don't have a
190 socket (perhaps because we got EAFNOSUPPORT or some such) or for
191 which sendto gives ENETUNREACH.
193 If neither end is mobile:
195 - When peer initiated the key exchange, we use the incoming packet
198 - When we initiate the key exchange, we try configured addresses
199 until we get one which isn't unsupported then fixate on that.
201 - When we complete a key setup, we replace the data transport peers
202 with those from the key setup.
206 - We can't tell when local network setup changes so we can't cache
207 the unsupported addrs and completely remove the spurious calls to
208 sendto, but we can optimise things a bit by deprioritising addrs
209 which seem to be unsupported.
211 - Use only configured addresses. (Except, that if our peer
212 initiated a key exchange we use the incoming packet address until
213 our name resolution completes.)
215 - When we send a packet, try each address in turn; if addr
216 supported, put that address to the end of the list for future
217 packets, and go onto the next address.
219 - When we complete a key setup, we replace the data transport peers
220 with those from the key setup.
226 struct comm_addr addr;
230 /* configuration information */
231 /* runtime information */
233 transport_peer peers[MAX_PEER_ADDRS];
236 /* Basic operations on transport peer address sets */
237 static void transport_peers_clear(struct site *st, transport_peers *peers);
238 static int transport_peers_valid(transport_peers *peers);
239 static void transport_peers_copy(struct site *st, transport_peers *dst,
240 const transport_peers *src);
242 /* Record address of incoming setup packet; resp. data packet. */
243 static void transport_setup_msgok(struct site *st, const struct comm_addr *a);
244 static void transport_data_msgok(struct site *st, const struct comm_addr *a);
246 /* Initialise the setup addresses. Called before we send the first
247 * packet in a key exchange. If we are the initiator, as a result of
248 * resolve completing (or being determined not to be relevant) or an
249 * incoming PROD; if we are the responder, as a result of the MSG1. */
250 static bool_t transport_compute_setupinit_peers(struct site *st,
251 const struct comm_addr *configured_addrs /* 0 if none or not found */,
252 int n_configured_addrs /* 0 if none or not found */,
253 const struct comm_addr *incoming_packet_addr /* 0 if none */);
255 /* Called if we are the responder in a key setup, when the resolve
256 * completes. transport_compute_setupinit_peers will hvae been called
257 * earlier. If _complete is called, we are still doing the key setup
258 * (and we should use the new values for both the rest of the key
259 * setup and the ongoing data exchange); if _tardy is called, the key
260 * setup is done (either completed or not) and only the data peers are
262 static void transport_resolve_complete(struct site *st,
263 const struct comm_addr *addrs, int naddrs);
264 static void transport_resolve_complete_tardy(struct site *st,
265 const struct comm_addr *addrs, int naddrs);
267 static void transport_xmit(struct site *st, transport_peers *peers,
268 struct buffer_if *buf, bool_t candebug);
270 /***** END of transport peers declarations *****/
274 struct transform_inst_if *transform;
275 uint64_t key_timeout; /* End of life of current key */
276 uint32_t remote_session_id;
282 /* configuration information */
285 bool_t local_mobile, peer_mobile; /* Mobile client support */
286 int32_t transport_peers_max;
287 string_t tunname; /* localname<->remotename by default, used in logs */
288 string_t address; /* DNS name for bootstrapping, optional */
289 int remoteport; /* Port for bootstrapping, optional */
291 struct netlink_if *netlink;
292 struct comm_if **comms;
294 struct resolver_if *resolver;
296 struct random_if *random;
297 struct rsaprivkey_if *privkey;
298 struct rsapubkey_if *pubkey;
299 struct transform_if **transforms;
302 struct hash_if *hash;
304 uint32_t index; /* Index of this site */
305 uint32_t local_capabilities;
306 int32_t setup_retries; /* How many times to send setup packets */
307 int32_t setup_retry_interval; /* Initial timeout for setup packets */
308 int32_t wait_timeout; /* How long to wait if setup unsuccessful */
309 int32_t mobile_peer_expiry; /* How long to remember 2ary addresses */
310 int32_t key_lifetime; /* How long a key lasts once set up */
311 int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
312 after this time, initiate a new
315 bool_t setup_priority; /* Do we have precedence if both sites emit
316 message 1 simultaneously? */
319 /* runtime information */
321 uint64_t now; /* Most recently seen time */
322 bool_t allow_send_prod;
325 /* The currently established session */
326 struct data_key current;
327 struct data_key auxiliary_key;
328 bool_t auxiliary_is_new;
329 uint64_t renegotiate_key_time; /* When we can negotiate a new key */
330 uint64_t auxiliary_renegotiate_key_time;
331 transport_peers peers; /* Current address(es) of peer for data traffic */
333 /* The current key setup protocol exchange. We can only be
334 involved in one of these at a time. There's a potential for
335 denial of service here (the attacker keeps sending a setup
336 packet; we keep trying to continue the exchange, and have to
337 timeout before we can listen for another setup packet); perhaps
338 we should keep a list of 'bad' sources for setup packets. */
339 uint32_t remote_capabilities;
340 uint16_t remote_adv_mtu;
341 struct transform_if *chosen_transform;
342 uint32_t setup_session_id;
343 transport_peers setup_peers;
344 uint8_t localN[NONCELEN]; /* Nonces for key exchange */
345 uint8_t remoteN[NONCELEN];
346 struct buffer_if buffer; /* Current outgoing key exchange packet */
347 struct buffer_if scratch;
348 int32_t retries; /* Number of retries remaining */
349 uint64_t timeout; /* Timeout for current state */
351 uint8_t *sharedsecret;
352 uint32_t sharedsecretlen, sharedsecretallocd;
353 struct transform_inst_if *new_transform; /* For key setup/verify */
356 static uint32_t event_log_priority(struct site *st, uint32_t event)
358 if (!(event&st->log_events))
361 case LOG_UNEXPECTED: return M_INFO;
362 case LOG_SETUP_INIT: return M_INFO;
363 case LOG_SETUP_TIMEOUT: return M_NOTICE;
364 case LOG_ACTIVATE_KEY: return M_INFO;
365 case LOG_TIMEOUT_KEY: return M_INFO;
366 case LOG_SEC: return M_SECURITY;
367 case LOG_STATE: return M_DEBUG;
368 case LOG_DROP: return M_DEBUG;
369 case LOG_DUMP: return M_DEBUG;
370 case LOG_ERROR: return M_ERR;
371 case LOG_PEER_ADDRS: return M_DEBUG;
372 default: return M_ERR;
376 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
378 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
382 class=event_log_priority(st, event);
384 slilog_part(st->log,class,"%s: ",st->tunname);
385 vslilog_part(st->log,class,msg,ap);
386 slilog_part(st->log,class,"\n");
390 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
392 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
396 vslog(st,event,msg,ap);
400 static void logtimeout(struct site *st, const char *fmt, ...)
402 static void logtimeout(struct site *st, const char *fmt, ...)
404 uint32_t class=event_log_priority(st,LOG_SETUP_TIMEOUT);
411 slilog_part(st->log,class,"%s: ",st->tunname);
412 vslilog_part(st->log,class,fmt,ap);
416 for (i=0, delim=" (tried ";
417 i<st->setup_peers.npeers;
419 transport_peer *peer=&st->setup_peers.peers[i];
420 const char *s=comm_addr_to_string(&peer->addr);
421 slilog_part(st->log,class,"%s%s",delim,s);
424 slilog_part(st->log,class,")\n");
428 static void set_link_quality(struct site *st);
429 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel);
430 static void delete_one_key(struct site *st, struct data_key *key,
431 const char *reason /* may be 0 meaning don't log*/,
432 const char *which /* ignored if !reasonn */,
433 uint32_t loglevel /* ignored if !reasonn */);
434 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
435 const struct comm_addr *prod_hint);
436 static void enter_state_run(struct site *st);
437 static bool_t enter_state_resolve(struct site *st);
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=realloc(st->sharedsecret,st->sharedsecretallocd);
526 if (!st->sharedsecret) fatal_perror("site:sharedsecret");
528 /* Generate the shared key */
529 st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,pk,
530 st->sharedsecret,st->sharedsecretlen);
532 /* Set up the transform */
533 struct transform_if *generator=st->chosen_transform;
534 struct transform_inst_if *generated=generator->create(generator->st);
535 generated->setkey(generated->st,st->sharedsecret,
536 st->sharedsecretlen,st->setup_priority);
537 dispose_transform(&st->new_transform);
538 st->new_transform=generated;
540 slog(st,LOG_SETUP_INIT,"key exchange negotiated transform"
541 " %d (capabilities ours=%#"PRIx32" theirs=%#"PRIx32")",
542 st->chosen_transform->capab_transformnum,
543 st->local_capabilities, st->remote_capabilities);
547 int32_t lenpos, afternul;
549 static void append_string_xinfo_start(struct buffer_if *buf,
550 struct xinfoadd *xia,
552 /* Helps construct one of the names with additional info as found
553 * in MSG1..4. Call this function first, then append all the
554 * desired extra info (not including the nul byte) to the buffer,
555 * then call append_string_xinfo_done. */
557 xia->lenpos = buf->size;
558 buf_append_string(buf,str);
559 buf_append_uint8(buf,0);
560 xia->afternul = buf->size;
562 static void append_string_xinfo_done(struct buffer_if *buf,
563 struct xinfoadd *xia)
565 /* we just need to adjust the string length */
566 if (buf->size == xia->afternul) {
567 /* no extra info, strip the nul too */
568 buf_unappend_uint8(buf);
570 put_uint16(buf->start+xia->lenpos, buf->size-(xia->lenpos+2));
574 /* Build any of msg1 to msg4. msg5 and msg6 are built from the inside
575 out using a transform of config data supplied by netlink */
576 static bool_t generate_msg(struct site *st, uint32_t type, cstring_t what)
582 st->retries=st->setup_retries;
583 BUF_ALLOC(&st->buffer,what);
584 buffer_init(&st->buffer,0);
585 buf_append_uint32(&st->buffer,
586 (type==LABEL_MSG1?0:st->setup_session_id));
587 buf_append_uint32(&st->buffer,st->index);
588 buf_append_uint32(&st->buffer,type);
591 append_string_xinfo_start(&st->buffer,&xia,st->localname);
592 if ((st->local_capabilities & CAPAB_EARLY) || (type != LABEL_MSG1)) {
593 buf_append_uint32(&st->buffer,st->local_capabilities);
595 if (type_is_msg34(type)) {
596 buf_append_uint16(&st->buffer,st->mtu_target);
598 append_string_xinfo_done(&st->buffer,&xia);
600 buf_append_string(&st->buffer,st->remotename);
601 memcpy(buf_append(&st->buffer,NONCELEN),st->localN,NONCELEN);
602 if (type==LABEL_MSG1) return True;
603 memcpy(buf_append(&st->buffer,NONCELEN),st->remoteN,NONCELEN);
604 if (type==LABEL_MSG2) return True;
606 if (hacky_par_mid_failnow()) return False;
608 if (type==LABEL_MSG3BIS)
609 buf_append_uint8(&st->buffer,st->chosen_transform->capab_transformnum);
611 dhpub=st->dh->makepublic(st->dh->st,st->dhsecret,st->dh->len);
612 buf_append_string(&st->buffer,dhpub);
614 hash=safe_malloc(st->hash->len, "generate_msg");
615 hst=st->hash->init();
616 st->hash->update(hst,st->buffer.start,st->buffer.size);
617 st->hash->final(hst,hash);
618 sig=st->privkey->sign(st->privkey->st,hash,st->hash->len);
619 buf_append_string(&st->buffer,sig);
625 static bool_t unpick_name(struct buffer_if *msg, struct parsedname *nm)
628 nm->len=buf_unprepend_uint16(msg);
629 CHECK_AVAIL(msg,nm->len);
630 nm->name=buf_unprepend(msg,nm->len);
631 uint8_t *nul=memchr(nm->name,0,nm->len);
633 buffer_readonly_view(&nm->extrainfo,0,0);
635 buffer_readonly_view(&nm->extrainfo, nul+1, msg->start-(nul+1));
636 nm->len=nul-nm->name;
641 static bool_t unpick_msg(struct site *st, uint32_t type,
642 struct buffer_if *msg, struct msg *m)
644 m->capab_transformnum=-1;
645 m->hashstart=msg->start;
647 m->dest=buf_unprepend_uint32(msg);
649 m->source=buf_unprepend_uint32(msg);
650 CHECK_TYPE(msg,type);
651 if (!unpick_name(msg,&m->remote)) return False;
652 m->remote_capabilities=0;
654 if (m->remote.extrainfo.size) {
655 CHECK_AVAIL(&m->remote.extrainfo,4);
656 m->remote_capabilities=buf_unprepend_uint32(&m->remote.extrainfo);
658 if (type_is_msg34(type) && m->remote.extrainfo.size) {
659 CHECK_AVAIL(&m->remote.extrainfo,2);
660 m->remote_mtu=buf_unprepend_uint16(&m->remote.extrainfo);
662 if (!unpick_name(msg,&m->local)) return False;
663 if (type==LABEL_PROD) {
667 CHECK_AVAIL(msg,NONCELEN);
668 m->nR=buf_unprepend(msg,NONCELEN);
669 if (type==LABEL_MSG1) {
673 CHECK_AVAIL(msg,NONCELEN);
674 m->nL=buf_unprepend(msg,NONCELEN);
675 if (type==LABEL_MSG2) {
679 if (type==LABEL_MSG3BIS) {
681 m->capab_transformnum = buf_unprepend_uint8(msg);
683 m->capab_transformnum = CAPAB_TRANSFORMNUM_ANCIENT;
686 m->pklen=buf_unprepend_uint16(msg);
687 CHECK_AVAIL(msg,m->pklen);
688 m->pk=buf_unprepend(msg,m->pklen);
689 m->hashlen=msg->start-m->hashstart;
691 m->siglen=buf_unprepend_uint16(msg);
692 CHECK_AVAIL(msg,m->siglen);
693 m->sig=buf_unprepend(msg,m->siglen);
698 static bool_t name_matches(const struct parsedname *nm, const char *expected)
700 int expected_len=strlen(expected);
702 nm->len == expected_len &&
703 !memcmp(nm->name, expected, expected_len);
706 static bool_t check_msg(struct site *st, uint32_t type, struct msg *m,
709 if (type==LABEL_MSG1) return True;
711 /* Check that the site names and our nonce have been sent
712 back correctly, and then store our peer's nonce. */
713 if (!name_matches(&m->remote,st->remotename)) {
714 *error="wrong remote site name";
717 if (!name_matches(&m->local,st->localname)) {
718 *error="wrong local site name";
721 if (memcmp(m->nL,st->localN,NONCELEN)!=0) {
722 *error="wrong locally-generated nonce";
725 if (type==LABEL_MSG2) return True;
726 if (!consttime_memeq(m->nR,st->remoteN,NONCELEN)!=0) {
727 *error="wrong remotely-generated nonce";
730 /* MSG3 has complicated rules about capabilities, which are
731 * handled in process_msg3. */
732 if (type==LABEL_MSG3 || type==LABEL_MSG3BIS) return True;
733 if (m->remote_capabilities!=st->remote_capabilities) {
734 *error="remote capabilities changed";
737 if (type==LABEL_MSG4) return True;
738 *error="unknown message type";
742 static bool_t generate_msg1(struct site *st)
744 st->random->generate(st->random->st,NONCELEN,st->localN);
745 return generate_msg(st,LABEL_MSG1,"site:MSG1");
748 static bool_t process_msg1(struct site *st, struct buffer_if *msg1,
749 const struct comm_addr *src, struct msg *m)
751 /* We've already determined we're in an appropriate state to
752 process an incoming MSG1, and that the MSG1 has correct values
755 st->setup_session_id=m->source;
756 st->remote_capabilities=m->remote_capabilities;
757 memcpy(st->remoteN,m->nR,NONCELEN);
761 static bool_t generate_msg2(struct site *st)
763 st->random->generate(st->random->st,NONCELEN,st->localN);
764 return generate_msg(st,LABEL_MSG2,"site:MSG2");
767 static bool_t process_msg2(struct site *st, struct buffer_if *msg2,
768 const struct comm_addr *src)
773 if (!unpick_msg(st,LABEL_MSG2,msg2,&m)) return False;
774 if (!check_msg(st,LABEL_MSG2,&m,&err)) {
775 slog(st,LOG_SEC,"msg2: %s",err);
778 st->setup_session_id=m.source;
779 st->remote_capabilities=m.remote_capabilities;
781 /* Select the transform to use */
783 uint32_t remote_transforms = st->remote_capabilities & CAPAB_TRANSFORM_MASK;
784 if (!remote_transforms)
785 /* old secnets only had this one transform */
786 remote_transforms = 1UL << CAPAB_TRANSFORMNUM_ANCIENT;
788 struct transform_if *ti;
790 for (i=0; i<st->ntransforms; i++) {
791 ti=st->transforms[i];
792 if ((1UL << ti->capab_transformnum) & remote_transforms)
793 goto transform_found;
795 slog(st,LOG_ERROR,"no transforms in common"
796 " (us %#"PRIx32"; them: %#"PRIx32")",
797 st->local_capabilities & CAPAB_TRANSFORM_MASK,
801 st->chosen_transform=ti;
803 memcpy(st->remoteN,m.nR,NONCELEN);
807 static bool_t generate_msg3(struct site *st)
809 /* Now we have our nonce and their nonce. Think of a secret key,
810 and create message number 3. */
811 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
812 return generate_msg(st,
813 (st->remote_capabilities & CAPAB_TRANSFORM_MASK
814 ? LABEL_MSG3BIS : LABEL_MSG3),
818 static bool_t process_msg3_msg4(struct site *st, struct msg *m)
823 /* Check signature and store g^x mod m */
824 hash=safe_malloc(st->hash->len, "process_msg3_msg4");
825 hst=st->hash->init();
826 st->hash->update(hst,m->hashstart,m->hashlen);
827 st->hash->final(hst,hash);
828 /* Terminate signature with a '0' - cheating, but should be ok */
830 if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m->sig)) {
831 slog(st,LOG_SEC,"msg3/msg4 signature failed check!");
837 st->remote_adv_mtu=m->remote_mtu;
842 static bool_t process_msg3(struct site *st, struct buffer_if *msg3,
843 const struct comm_addr *src, uint32_t msgtype)
848 assert(msgtype==LABEL_MSG3 || msgtype==LABEL_MSG3BIS);
850 if (!unpick_msg(st,msgtype,msg3,&m)) return False;
851 if (!check_msg(st,msgtype,&m,&err)) {
852 slog(st,LOG_SEC,"msg3: %s",err);
855 uint32_t capab_adv_late = m.remote_capabilities
856 & ~st->remote_capabilities & CAPAB_EARLY;
857 if (capab_adv_late) {
858 slog(st,LOG_SEC,"msg3 impermissibly adds early capability flag(s)"
859 " %#"PRIx32" (was %#"PRIx32", now %#"PRIx32")",
860 capab_adv_late, st->remote_capabilities, m.remote_capabilities);
863 st->remote_capabilities|=m.remote_capabilities;
865 struct transform_if *ti;
867 for (i=0; i<st->ntransforms; i++) {
868 ti=st->transforms[i];
869 if (ti->capab_transformnum == m.capab_transformnum)
870 goto transform_found;
872 slog(st,LOG_SEC,"peer chose unknown-to-us transform %d!",
873 m.capab_transformnum);
876 st->chosen_transform=ti;
878 if (!process_msg3_msg4(st,&m))
881 /* Terminate their DH public key with a '0' */
883 /* Invent our DH secret key */
884 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
886 /* Generate the shared key and set up the transform */
887 set_new_transform(st,m.pk);
892 static bool_t generate_msg4(struct site *st)
894 /* We have both nonces, their public key and our private key. Generate
895 our public key, sign it and send it to them. */
896 return generate_msg(st,LABEL_MSG4,"site:MSG4");
899 static bool_t process_msg4(struct site *st, struct buffer_if *msg4,
900 const struct comm_addr *src)
905 if (!unpick_msg(st,LABEL_MSG4,msg4,&m)) return False;
906 if (!check_msg(st,LABEL_MSG4,&m,&err)) {
907 slog(st,LOG_SEC,"msg4: %s",err);
911 if (!process_msg3_msg4(st,&m))
914 /* Terminate their DH public key with a '0' */
917 /* Generate the shared key and set up the transform */
918 set_new_transform(st,m.pk);
929 static bool_t unpick_msg0(struct site *st, struct buffer_if *msg0,
933 m->dest=buf_unprepend_uint32(msg0);
935 m->source=buf_unprepend_uint32(msg0);
937 m->type=buf_unprepend_uint32(msg0);
939 /* Leaves transformed part of buffer untouched */
942 static bool_t generate_msg5(struct site *st)
944 cstring_t transform_err;
946 BUF_ALLOC(&st->buffer,"site:MSG5");
947 /* We are going to add four words to the message */
948 buffer_init(&st->buffer,calculate_max_start_pad());
949 /* Give the netlink code an opportunity to put its own stuff in the
950 message (configuration information, etc.) */
951 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
952 if (call_transform_forwards(st,st->new_transform,
953 &st->buffer,&transform_err))
955 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
956 buf_prepend_uint32(&st->buffer,st->index);
957 buf_prepend_uint32(&st->buffer,st->setup_session_id);
959 st->retries=st->setup_retries;
963 static bool_t process_msg5(struct site *st, struct buffer_if *msg5,
964 const struct comm_addr *src,
965 struct transform_inst_if *transform)
968 cstring_t transform_err;
970 if (!unpick_msg0(st,msg5,&m)) return False;
972 if (call_transform_reverse(st,transform,msg5,&transform_err)) {
973 /* There's a problem */
974 slog(st,LOG_SEC,"process_msg5: transform: %s",transform_err);
977 /* Buffer should now contain untransformed PING packet data */
979 if (buf_unprepend_uint32(msg5)!=LABEL_MSG5) {
980 slog(st,LOG_SEC,"MSG5/PING packet contained wrong label");
983 /* Older versions of secnet used to write some config data here
984 * which we ignore. So we don't CHECK_EMPTY */
988 static void create_msg6(struct site *st, struct transform_inst_if *transform,
991 cstring_t transform_err;
993 BUF_ALLOC(&st->buffer,"site:MSG6");
994 /* We are going to add four words to the message */
995 buffer_init(&st->buffer,calculate_max_start_pad());
996 /* Give the netlink code an opportunity to put its own stuff in the
997 message (configuration information, etc.) */
998 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
999 int problem = call_transform_forwards(st,transform,
1000 &st->buffer,&transform_err);
1002 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1003 buf_prepend_uint32(&st->buffer,st->index);
1004 buf_prepend_uint32(&st->buffer,session_id);
1007 static bool_t generate_msg6(struct site *st)
1009 if (!is_transform_valid(st->new_transform))
1011 create_msg6(st,st->new_transform,st->setup_session_id);
1012 st->retries=1; /* Peer will retransmit MSG5 if this packet gets lost */
1016 static bool_t process_msg6(struct site *st, struct buffer_if *msg6,
1017 const struct comm_addr *src)
1020 cstring_t transform_err;
1022 if (!unpick_msg0(st,msg6,&m)) return False;
1024 if (call_transform_reverse(st,st->new_transform,msg6,&transform_err)) {
1025 /* There's a problem */
1026 slog(st,LOG_SEC,"process_msg6: transform: %s",transform_err);
1029 /* Buffer should now contain untransformed PING packet data */
1030 CHECK_AVAIL(msg6,4);
1031 if (buf_unprepend_uint32(msg6)!=LABEL_MSG6) {
1032 slog(st,LOG_SEC,"MSG6/PONG packet contained invalid data");
1035 /* Older versions of secnet used to write some config data here
1036 * which we ignore. So we don't CHECK_EMPTY */
1040 static bool_t decrypt_msg0(struct site *st, struct buffer_if *msg0,
1041 const struct comm_addr *src)
1043 cstring_t transform_err, auxkey_err, newkey_err="n/a";
1047 if (!unpick_msg0(st,msg0,&m)) return False;
1049 /* Keep a copy so we can try decrypting it with multiple keys */
1050 buffer_copy(&st->scratch, msg0);
1052 problem = call_transform_reverse(st,st->current.transform,
1053 msg0,&transform_err);
1055 if (!st->auxiliary_is_new)
1056 delete_one_key(st,&st->auxiliary_key,
1057 "peer has used new key","auxiliary key",LOG_SEC);
1063 buffer_copy(msg0, &st->scratch);
1064 problem = call_transform_reverse(st,st->auxiliary_key.transform,
1067 slog(st,LOG_DROP,"processing packet which uses auxiliary key");
1068 if (st->auxiliary_is_new) {
1069 /* We previously timed out in state SENTMSG5 but it turns
1070 * out that our peer did in fact get our MSG5 and is
1071 * using the new key. So we should switch to it too. */
1072 /* This is a bit like activate_new_key. */
1075 st->current=st->auxiliary_key;
1076 st->auxiliary_key=t;
1078 delete_one_key(st,&st->auxiliary_key,"peer has used new key",
1079 "previous key",LOG_SEC);
1080 st->auxiliary_is_new=0;
1081 st->renegotiate_key_time=st->auxiliary_renegotiate_key_time;
1088 if (st->state==SITE_SENTMSG5) {
1089 buffer_copy(msg0, &st->scratch);
1090 problem = call_transform_reverse(st,st->new_transform,
1093 /* It looks like we didn't get the peer's MSG6 */
1094 /* This is like a cut-down enter_new_state(SITE_RUN) */
1095 slog(st,LOG_STATE,"will enter state RUN (MSG0 with new key)");
1096 BUF_FREE(&st->buffer);
1098 activate_new_key(st);
1099 return True; /* do process the data in this packet */
1105 slog(st,LOG_SEC,"transform: %s (aux: %s, new: %s)",
1106 transform_err,auxkey_err,newkey_err);
1107 initiate_key_setup(st,"incoming message would not decrypt",0);
1108 send_nak(src,m.dest,m.source,m.type,msg0,"message would not decrypt");
1112 slog(st,LOG_DROP,"transform: %s (merely skew)",transform_err);
1116 static bool_t process_msg0(struct site *st, struct buffer_if *msg0,
1117 const struct comm_addr *src)
1121 if (!decrypt_msg0(st,msg0,src))
1124 CHECK_AVAIL(msg0,4);
1125 type=buf_unprepend_uint32(msg0);
1128 /* We must forget about the current session. */
1129 delete_keys(st,"request from peer",LOG_SEC);
1132 /* Deliver to netlink layer */
1133 st->netlink->deliver(st->netlink->st,msg0);
1134 transport_data_msgok(st,src);
1135 /* See whether we should start negotiating a new key */
1136 if (st->now > st->renegotiate_key_time)
1137 initiate_key_setup(st,"incoming packet in renegotiation window",0);
1140 slog(st,LOG_SEC,"incoming encrypted message of type %08x "
1147 static void dump_packet(struct site *st, struct buffer_if *buf,
1148 const struct comm_addr *addr, bool_t incoming)
1150 uint32_t dest=get_uint32(buf->start);
1151 uint32_t source=get_uint32(buf->start+4);
1152 uint32_t msgtype=get_uint32(buf->start+8);
1154 if (st->log_events & LOG_DUMP)
1155 slilog(st->log,M_DEBUG,"%s: %s: %08x<-%08x: %08x:",
1156 st->tunname,incoming?"incoming":"outgoing",
1157 dest,source,msgtype);
1160 static uint32_t site_status(void *st)
1165 static bool_t send_msg(struct site *st)
1167 if (st->retries>0) {
1168 transport_xmit(st, &st->setup_peers, &st->buffer, True);
1169 st->timeout=st->now+st->setup_retry_interval;
1172 } else if (st->state==SITE_SENTMSG5) {
1173 logtimeout(st,"timed out sending MSG5, stashing new key");
1174 /* We stash the key we have produced, in case it turns out that
1175 * our peer did see our MSG5 after all and starts using it. */
1176 /* This is a bit like some of activate_new_key */
1177 struct transform_inst_if *t;
1178 t=st->auxiliary_key.transform;
1179 st->auxiliary_key.transform=st->new_transform;
1180 st->new_transform=t;
1181 dispose_transform(&st->new_transform);
1183 st->auxiliary_is_new=1;
1184 st->auxiliary_key.key_timeout=st->now+st->key_lifetime;
1185 st->auxiliary_renegotiate_key_time=st->now+st->key_renegotiate_time;
1186 st->auxiliary_key.remote_session_id=st->setup_session_id;
1188 enter_state_wait(st);
1191 logtimeout(st,"timed out sending key setup packet "
1192 "(in state %s)",state_name(st->state));
1193 enter_state_wait(st);
1198 static void site_resolve_callback(void *sst, const struct comm_addr *addrs,
1201 struct site *st=sst;
1203 st->resolving=False;
1206 slog(st,LOG_STATE,"resolution of %s completed, %d addrs, eg: %s",
1207 st->address, naddrs, comm_addr_to_string(&addrs[0]));;
1209 slog(st,LOG_ERROR,"resolution of %s failed",st->address);
1212 switch (st->state) {
1214 if (transport_compute_setupinit_peers(st,addrs,naddrs,0)) {
1215 enter_new_state(st,SITE_SENTMSG1);
1217 /* Can't figure out who to try to to talk to */
1218 slog(st,LOG_SETUP_INIT,
1219 "key exchange failed: cannot find peer address");
1220 enter_state_run(st);
1223 case SITE_SENTMSG1: case SITE_SENTMSG2:
1224 case SITE_SENTMSG3: case SITE_SENTMSG4:
1227 /* We start using the address immediately for data too.
1228 * It's best to store it in st->peers now because we might
1229 * go via SENTMSG5, WAIT, and a MSG0, straight into using
1230 * the new key (without updating the data peer addrs). */
1231 transport_resolve_complete(st,addrs,naddrs);
1232 } else if (st->local_mobile) {
1233 /* We can't let this rest because we may have a peer
1234 * address which will break in the future. */
1235 slog(st,LOG_SETUP_INIT,"resolution of %s failed: "
1236 "abandoning key exchange",st->address);
1237 enter_state_wait(st);
1239 slog(st,LOG_SETUP_INIT,"resolution of %s failed: "
1240 " continuing to use source address of peer's packets"
1241 " for key exchange and ultimately data",
1247 slog(st,LOG_SETUP_INIT,"resolution of %s completed tardily,"
1248 " updating peer address(es)",st->address);
1249 transport_resolve_complete_tardy(st,addrs,naddrs);
1250 } else if (st->local_mobile) {
1251 /* Not very good. We should queue (another) renegotiation
1252 * so that we can update the peer address. */
1253 st->key_renegotiate_time=st->now+st->wait_timeout;
1255 slog(st,LOG_SETUP_INIT,"resolution of %s failed: "
1256 " continuing to use source address of peer's packets",
1267 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
1268 const struct comm_addr *prod_hint)
1270 /* Reentrancy hazard: can call enter_new_state/enter_state_* */
1271 if (st->state!=SITE_RUN) return False;
1272 slog(st,LOG_SETUP_INIT,"initiating key exchange (%s)",reason);
1274 slog(st,LOG_SETUP_INIT,"resolving peer address");
1275 return enter_state_resolve(st);
1276 } else if (transport_compute_setupinit_peers(st,0,0,prod_hint)) {
1277 return enter_new_state(st,SITE_SENTMSG1);
1279 slog(st,LOG_SETUP_INIT,"key exchange failed: no address for peer");
1283 static void activate_new_key(struct site *st)
1285 struct transform_inst_if *t;
1287 /* We have three transform instances, which we swap between old,
1289 t=st->auxiliary_key.transform;
1290 st->auxiliary_key.transform=st->current.transform;
1291 st->current.transform=st->new_transform;
1292 st->new_transform=t;
1293 dispose_transform(&st->new_transform);
1296 st->auxiliary_is_new=0;
1297 st->auxiliary_key.key_timeout=st->current.key_timeout;
1298 st->current.key_timeout=st->now+st->key_lifetime;
1299 st->renegotiate_key_time=st->now+st->key_renegotiate_time;
1300 transport_peers_copy(st,&st->peers,&st->setup_peers);
1301 st->current.remote_session_id=st->setup_session_id;
1303 /* Compute the inter-site MTU. This is min( our_mtu, their_mtu ).
1304 * But their mtu be unspecified, in which case we just use ours. */
1305 uint32_t intersite_mtu=
1306 MIN(st->mtu_target, st->remote_adv_mtu ?: ~(uint32_t)0);
1307 st->netlink->set_mtu(st->netlink->st,intersite_mtu);
1309 slog(st,LOG_ACTIVATE_KEY,"new key activated"
1310 " (mtu ours=%"PRId32" theirs=%"PRId32" intersite=%"PRId32")",
1311 st->mtu_target, st->remote_adv_mtu, intersite_mtu);
1312 enter_state_run(st);
1315 static void delete_one_key(struct site *st, struct data_key *key,
1316 cstring_t reason, cstring_t which, uint32_t loglevel)
1318 if (!is_transform_valid(key->transform)) return;
1319 if (reason) slog(st,loglevel,"%s deleted (%s)",which,reason);
1320 dispose_transform(&key->transform);
1324 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel)
1326 if (current_valid(st)) {
1327 slog(st,loglevel,"session closed (%s)",reason);
1329 delete_one_key(st,&st->current,0,0,0);
1330 set_link_quality(st);
1332 delete_one_key(st,&st->auxiliary_key,0,0,0);
1335 static void state_assert(struct site *st, bool_t ok)
1337 if (!ok) fatal("site:state_assert");
1340 static void enter_state_stop(struct site *st)
1342 st->state=SITE_STOP;
1344 delete_keys(st,"entering state STOP",LOG_TIMEOUT_KEY);
1345 dispose_transform(&st->new_transform);
1348 static void set_link_quality(struct site *st)
1351 if (current_valid(st))
1352 quality=LINK_QUALITY_UP;
1353 else if (st->state==SITE_WAIT || st->state==SITE_STOP)
1354 quality=LINK_QUALITY_DOWN;
1355 else if (st->address)
1356 quality=LINK_QUALITY_DOWN_CURRENT_ADDRESS;
1357 else if (transport_peers_valid(&st->peers))
1358 quality=LINK_QUALITY_DOWN_STALE_ADDRESS;
1360 quality=LINK_QUALITY_DOWN;
1362 st->netlink->set_quality(st->netlink->st,quality);
1365 static void enter_state_run(struct site *st)
1367 slog(st,LOG_STATE,"entering state RUN");
1371 st->setup_session_id=0;
1372 transport_peers_clear(st,&st->setup_peers);
1373 memset(st->localN,0,NONCELEN);
1374 memset(st->remoteN,0,NONCELEN);
1375 dispose_transform(&st->new_transform);
1376 memset(st->dhsecret,0,st->dh->len);
1377 memset(st->sharedsecret,0,st->sharedsecretlen);
1378 set_link_quality(st);
1381 static bool_t ensure_resolving(struct site *st)
1383 /* Reentrancy hazard: may call site_resolve_callback and hence
1384 * enter_new_state, enter_state_* and generate_msg*. */
1388 assert(st->address);
1390 /* resolver->request might reentrantly call site_resolve_callback
1391 * which will clear st->resolving, so we need to set it beforehand
1392 * rather than afterwards; also, it might return False, in which
1393 * case we have to clear ->resolving again. */
1395 bool_t ok = st->resolver->request(st->resolver->st,st->address,
1396 st->remoteport,st->comms[0],
1397 site_resolve_callback,st);
1399 st->resolving=False;
1404 static bool_t enter_state_resolve(struct site *st)
1406 /* Reentrancy hazard! See ensure_resolving. */
1407 state_assert(st,st->state==SITE_RUN);
1408 slog(st,LOG_STATE,"entering state RESOLVE");
1409 st->state=SITE_RESOLVE;
1410 return ensure_resolving(st);
1413 static bool_t enter_new_state(struct site *st, uint32_t next)
1415 bool_t (*gen)(struct site *st);
1418 slog(st,LOG_STATE,"entering state %s",state_name(next));
1421 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
1425 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1426 st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
1430 state_assert(st,st->state==SITE_SENTMSG1);
1431 BUF_FREE(&st->buffer);
1435 state_assert(st,st->state==SITE_SENTMSG2);
1436 BUF_FREE(&st->buffer);
1440 state_assert(st,st->state==SITE_SENTMSG3);
1441 BUF_FREE(&st->buffer);
1445 state_assert(st,st->state==SITE_SENTMSG4);
1446 BUF_FREE(&st->buffer);
1451 fatal("enter_new_state(%s): invalid new state",state_name(next));
1455 if (hacky_par_start_failnow()) return False;
1457 r= gen(st) && send_msg(st);
1460 st->setup_retries, st->setup_retry_interval,
1465 if (next==SITE_RUN) {
1466 BUF_FREE(&st->buffer); /* Never reused */
1467 st->timeout=0; /* Never retransmit */
1468 activate_new_key(st);
1472 slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1473 st->buffer.free=False; /* Unconditionally use the buffer; it may be
1474 in either state, and enter_state_wait() will
1476 enter_state_wait(st);
1480 /* msg7 tells our peer that we're about to forget our key */
1481 static bool_t send_msg7(struct site *st, cstring_t reason)
1483 cstring_t transform_err;
1485 if (current_valid(st) && st->buffer.free
1486 && transport_peers_valid(&st->peers)) {
1487 BUF_ALLOC(&st->buffer,"site:MSG7");
1488 buffer_init(&st->buffer,calculate_max_start_pad());
1489 buf_append_uint32(&st->buffer,LABEL_MSG7);
1490 buf_append_string(&st->buffer,reason);
1491 if (call_transform_forwards(st, st->current.transform,
1492 &st->buffer, &transform_err))
1494 buf_prepend_uint32(&st->buffer,LABEL_MSG0);
1495 buf_prepend_uint32(&st->buffer,st->index);
1496 buf_prepend_uint32(&st->buffer,st->current.remote_session_id);
1497 transport_xmit(st,&st->peers,&st->buffer,True);
1498 BUF_FREE(&st->buffer);
1505 /* We go into this state if our peer becomes uncommunicative. Similar to
1506 the "stop" state, we forget all session keys for a while, before
1507 re-entering the "run" state. */
1508 static void enter_state_wait(struct site *st)
1510 slog(st,LOG_STATE,"entering state WAIT");
1511 st->timeout=st->now+st->wait_timeout;
1512 st->state=SITE_WAIT;
1513 set_link_quality(st);
1514 BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1515 /* XXX Erase keys etc. */
1518 static void generate_prod(struct site *st, struct buffer_if *buf)
1521 buf_append_uint32(buf,0);
1522 buf_append_uint32(buf,0);
1523 buf_append_uint32(buf,LABEL_PROD);
1524 buf_append_string(buf,st->localname);
1525 buf_append_string(buf,st->remotename);
1528 static void generate_send_prod(struct site *st,
1529 const struct comm_addr *source)
1531 if (!st->allow_send_prod) return; /* too soon */
1532 if (!(st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1533 st->state==SITE_WAIT)) return; /* we'd ignore peer's MSG1 */
1535 slog(st,LOG_SETUP_INIT,"prodding peer for key exchange");
1536 st->allow_send_prod=0;
1537 generate_prod(st,&st->scratch);
1538 dump_packet(st,&st->scratch,source,False);
1539 source->comm->sendmsg(source->comm->st, &st->scratch, source);
1542 static inline void site_settimeout(uint64_t timeout, int *timeout_io)
1545 int64_t offset=timeout-*now;
1546 if (offset<0) offset=0;
1547 if (offset>INT_MAX) offset=INT_MAX;
1548 if (*timeout_io<0 || offset<*timeout_io)
1553 static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
1556 struct site *st=sst;
1558 *nfds_io=0; /* We don't use any file descriptors */
1561 /* Work out when our next timeout is. The earlier of 'timeout' or
1562 'current.key_timeout'. A stored value of '0' indicates no timeout
1564 site_settimeout(st->timeout, timeout_io);
1565 site_settimeout(st->current.key_timeout, timeout_io);
1566 site_settimeout(st->auxiliary_key.key_timeout, timeout_io);
1568 return 0; /* success */
1571 static void check_expiry(struct site *st, struct data_key *key,
1574 if (key->key_timeout && *now>key->key_timeout) {
1575 delete_one_key(st,key,"maximum life exceeded",which,LOG_TIMEOUT_KEY);
1579 /* NB site_afterpoll will be called before site_beforepoll is ever called */
1580 static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
1582 struct site *st=sst;
1585 if (st->timeout && *now>st->timeout) {
1587 if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
1588 if (!hacky_par_start_failnow())
1590 } else if (st->state==SITE_WAIT) {
1591 enter_state_run(st);
1593 slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
1597 check_expiry(st,&st->current,"current key");
1598 check_expiry(st,&st->auxiliary_key,"auxiliary key");
1601 /* This function is called by the netlink device to deliver packets
1602 intended for the remote network. The packet is in "raw" wire
1603 format, but is guaranteed to be word-aligned. */
1604 static void site_outgoing(void *sst, struct buffer_if *buf)
1606 struct site *st=sst;
1607 cstring_t transform_err;
1609 if (st->state==SITE_STOP) {
1614 st->allow_send_prod=1;
1616 /* In all other states we consider delivering the packet if we have
1617 a valid key and a valid address to send it to. */
1618 if (current_valid(st) && transport_peers_valid(&st->peers)) {
1619 /* Transform it and send it */
1621 buf_prepend_uint32(buf,LABEL_MSG9);
1622 if (call_transform_forwards(st, st->current.transform,
1623 buf, &transform_err))
1625 buf_prepend_uint32(buf,LABEL_MSG0);
1626 buf_prepend_uint32(buf,st->index);
1627 buf_prepend_uint32(buf,st->current.remote_session_id);
1628 transport_xmit(st,&st->peers,buf,False);
1635 slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
1637 initiate_key_setup(st,"outgoing packet",0);
1640 static bool_t named_for_us(struct site *st, const struct buffer_if *buf_in,
1641 uint32_t type, struct msg *m)
1642 /* For packets which are identified by the local and remote names.
1643 * If it has our name and our peer's name in it it's for us. */
1645 struct buffer_if buf[1];
1646 buffer_readonly_clone(buf,buf_in);
1647 return unpick_msg(st,type,buf,m)
1648 && name_matches(&m->remote,st->remotename)
1649 && name_matches(&m->local,st->localname);
1652 /* This function is called by the communication device to deliver
1653 packets from our peers.
1654 It should return True if the packet is recognised as being for
1655 this current site instance (and should therefore not be processed
1656 by other sites), even if the packet was otherwise ignored. */
1657 static bool_t site_incoming(void *sst, struct buffer_if *buf,
1658 const struct comm_addr *source)
1660 struct site *st=sst;
1662 if (buf->size < 12) return False;
1664 uint32_t dest=get_uint32(buf->start);
1665 uint32_t msgtype=get_uint32(buf->start+8);
1666 struct msg named_msg;
1668 if (msgtype==LABEL_MSG1) {
1669 if (!named_for_us(st,buf,msgtype,&named_msg))
1671 /* It's a MSG1 addressed to us. Decide what to do about it. */
1672 dump_packet(st,buf,source,True);
1673 if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1674 st->state==SITE_WAIT) {
1675 /* We should definitely process it */
1676 transport_compute_setupinit_peers(st,0,0,source);
1677 if (process_msg1(st,buf,source,&named_msg)) {
1678 slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
1679 bool_t entered=enter_new_state(st,SITE_SENTMSG2);
1680 if (entered && st->address && st->local_mobile)
1681 /* We must do this as the very last thing, because
1682 the resolver callback might reenter us. */
1683 ensure_resolving(st);
1685 slog(st,LOG_ERROR,"failed to process incoming msg1");
1689 } else if (st->state==SITE_SENTMSG1) {
1690 /* We've just sent a message 1! They may have crossed on
1691 the wire. If we have priority then we ignore the
1692 incoming one, otherwise we process it as usual. */
1693 if (st->setup_priority) {
1695 slog(st,LOG_DUMP,"crossed msg1s; we are higher "
1696 "priority => ignore incoming msg1");
1699 slog(st,LOG_DUMP,"crossed msg1s; we are lower "
1700 "priority => use incoming msg1");
1701 if (process_msg1(st,buf,source,&named_msg)) {
1702 BUF_FREE(&st->buffer); /* Free our old message 1 */
1703 transport_setup_msgok(st,source);
1704 enter_new_state(st,SITE_SENTMSG2);
1706 slog(st,LOG_ERROR,"failed to process an incoming "
1707 "crossed msg1 (we have low priority)");
1713 /* The message 1 was received at an unexpected stage of the
1714 key setup. XXX POLICY - what do we do? */
1715 slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
1719 if (msgtype==LABEL_PROD) {
1720 if (!named_for_us(st,buf,msgtype,&named_msg))
1722 dump_packet(st,buf,source,True);
1723 if (st->state!=SITE_RUN) {
1724 slog(st,LOG_DROP,"ignoring PROD when not in state RUN");
1725 } else if (current_valid(st)) {
1726 slog(st,LOG_DROP,"ignoring PROD when we think we have a key");
1728 initiate_key_setup(st,"peer sent PROD packet",source);
1733 if (dest==st->index) {
1734 /* Explicitly addressed to us */
1735 if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True);
1738 /* If the source is our current peer then initiate a key setup,
1739 because our peer's forgotten the key */
1740 if (get_uint32(buf->start+4)==st->current.remote_session_id) {
1742 initiated = initiate_key_setup(st,"received a NAK",source);
1743 if (!initiated) generate_send_prod(st,source);
1745 slog(st,LOG_SEC,"bad incoming NAK");
1749 process_msg0(st,buf,source);
1752 /* Setup packet: should not have been explicitly addressed
1754 slog(st,LOG_SEC,"incoming explicitly addressed msg1");
1757 /* Setup packet: expected only in state SENTMSG1 */
1758 if (st->state!=SITE_SENTMSG1) {
1759 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
1760 } else if (process_msg2(st,buf,source)) {
1761 transport_setup_msgok(st,source);
1762 enter_new_state(st,SITE_SENTMSG3);
1764 slog(st,LOG_SEC,"invalid MSG2");
1769 /* Setup packet: expected only in state SENTMSG2 */
1770 if (st->state!=SITE_SENTMSG2) {
1771 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
1772 } else if (process_msg3(st,buf,source,msgtype)) {
1773 transport_setup_msgok(st,source);
1774 enter_new_state(st,SITE_SENTMSG4);
1776 slog(st,LOG_SEC,"invalid MSG3");
1780 /* Setup packet: expected only in state SENTMSG3 */
1781 if (st->state!=SITE_SENTMSG3) {
1782 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
1783 } else if (process_msg4(st,buf,source)) {
1784 transport_setup_msgok(st,source);
1785 enter_new_state(st,SITE_SENTMSG5);
1787 slog(st,LOG_SEC,"invalid MSG4");
1791 /* Setup packet: expected only in state SENTMSG4 */
1792 /* (may turn up in state RUN if our return MSG6 was lost
1793 and the new key has already been activated. In that
1794 case we discard it. The peer will realise that we
1795 are using the new key when they see our data packets.
1796 Until then the peer's data packets to us get discarded. */
1797 if (st->state==SITE_SENTMSG4) {
1798 if (process_msg5(st,buf,source,st->new_transform)) {
1799 transport_setup_msgok(st,source);
1800 enter_new_state(st,SITE_RUN);
1802 slog(st,LOG_SEC,"invalid MSG5");
1804 } else if (st->state==SITE_RUN) {
1805 if (process_msg5(st,buf,source,st->current.transform)) {
1806 slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
1807 transport_setup_msgok(st,source);
1808 create_msg6(st,st->current.transform,
1809 st->current.remote_session_id);
1810 transport_xmit(st,&st->peers,&st->buffer,True);
1811 BUF_FREE(&st->buffer);
1813 slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
1816 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
1820 /* Setup packet: expected only in state SENTMSG5 */
1821 if (st->state!=SITE_SENTMSG5) {
1822 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
1823 } else if (process_msg6(st,buf,source)) {
1824 BUF_FREE(&st->buffer); /* Free message 5 */
1825 transport_setup_msgok(st,source);
1826 activate_new_key(st);
1828 slog(st,LOG_SEC,"invalid MSG6");
1832 slog(st,LOG_SEC,"received message of unknown type 0x%08x",
1843 static void site_control(void *vst, bool_t run)
1845 struct site *st=vst;
1846 if (run) enter_state_run(st);
1847 else enter_state_stop(st);
1850 static void site_phase_hook(void *sst, uint32_t newphase)
1852 struct site *st=sst;
1854 /* The program is shutting down; tell our peer */
1855 send_msg7(st,"shutting down");
1858 static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
1861 static uint32_t index_sequence;
1867 st=safe_malloc(sizeof(*st),"site_apply");
1869 st->cl.description="site";
1870 st->cl.type=CL_SITE;
1872 st->cl.interface=&st->ops;
1874 st->ops.control=site_control;
1875 st->ops.status=site_status;
1877 /* First parameter must be a dict */
1878 item=list_elem(args,0);
1879 if (!item || item->type!=t_dict)
1880 cfgfatal(loc,"site","parameter must be a dictionary\n");
1882 dict=item->data.dict;
1883 st->localname=dict_read_string(dict, "local-name", True, "site", loc);
1884 st->remotename=dict_read_string(dict, "name", True, "site", loc);
1886 st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
1888 dict_read_bool(dict,"local-mobile",False,"site",loc,False);
1890 /* Sanity check (which also allows the 'sites' file to include
1891 site() closures for all sites including our own): refuse to
1892 talk to ourselves */
1893 if (strcmp(st->localname,st->remotename)==0) {
1894 Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
1896 if (st->peer_mobile != st->local_mobile)
1897 cfgfatal(loc,"site","site %s's peer-mobile=%d"
1898 " but our local-mobile=%d\n",
1899 st->localname, st->peer_mobile, st->local_mobile);
1903 if (st->peer_mobile && st->local_mobile) {
1904 Message(M_WARNING,"site %s: site is mobile but so are we"
1905 " -> ignoring this site\n", st->remotename);
1910 assert(index_sequence < 0xffffffffUL);
1911 st->index = ++index_sequence;
1912 st->local_capabilities = 0;
1913 st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
1915 #define GET_CLOSURE_LIST(dictkey,things,nthings,CL_TYPE) do{ \
1916 list_t *things##_cfg=dict_lookup(dict,dictkey); \
1917 if (!things##_cfg) \
1918 cfgfatal(loc,"site","closure list \"%s\" not found\n",dictkey); \
1919 st->nthings=list_length(things##_cfg); \
1920 st->things=safe_malloc_ary(sizeof(*st->things),st->nthings,dictkey "s"); \
1921 assert(st->nthings); \
1922 for (i=0; i<st->nthings; i++) { \
1923 item_t *item=list_elem(things##_cfg,i); \
1924 if (item->type!=t_closure) \
1925 cfgfatal(loc,"site","%s is not a closure\n",dictkey); \
1926 closure_t *cl=item->data.closure; \
1927 if (cl->type!=CL_TYPE) \
1928 cfgfatal(loc,"site","%s closure wrong type\n",dictkey); \
1929 st->things[i]=cl->interface; \
1933 GET_CLOSURE_LIST("comm",comms,ncomms,CL_COMM);
1935 st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
1936 st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
1937 st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
1939 st->privkey=find_cl_if(dict,"local-key",CL_RSAPRIVKEY,True,"site",loc);
1940 st->address=dict_read_string(dict, "address", False, "site", loc);
1942 st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
1943 else st->remoteport=0;
1944 st->pubkey=find_cl_if(dict,"key",CL_RSAPUBKEY,True,"site",loc);
1946 GET_CLOSURE_LIST("transform",transforms,ntransforms,CL_TRANSFORM);
1948 st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
1949 st->hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
1951 #define DEFAULT(D) (st->peer_mobile || st->local_mobile \
1952 ? DEFAULT_MOBILE_##D : DEFAULT_##D)
1953 #define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
1955 st->key_lifetime= CFG_NUMBER("key-lifetime", KEY_LIFETIME);
1956 st->setup_retries= CFG_NUMBER("setup-retries", SETUP_RETRIES);
1957 st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
1958 st->wait_timeout= CFG_NUMBER("wait-time", WAIT_TIME);
1959 st->mtu_target= dict_read_number(dict,"mtu-target",False,"site",loc,0);
1961 st->mobile_peer_expiry= dict_read_number(
1962 dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
1964 const char *peerskey= st->peer_mobile
1965 ? "mobile-peers-max" : "static-peers-max";
1966 st->transport_peers_max= dict_read_number(
1967 dict,peerskey,False,"site",loc,DEFAULT_MOBILE_PEERS_MAX);
1968 if (st->transport_peers_max<1 ||
1969 st->transport_peers_max>=MAX_PEER_ADDRS) {
1970 cfgfatal(loc,"site", "%s must be in range 1.."
1971 STRING(MAX_PEER_ADDRS) "\n", peerskey);
1974 if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
1975 st->key_renegotiate_time=st->key_lifetime/2;
1977 st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
1978 st->key_renegotiate_time=dict_read_number(
1979 dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
1980 if (st->key_renegotiate_time > st->key_lifetime) {
1981 cfgfatal(loc,"site",
1982 "renegotiate-time must be less than key-lifetime\n");
1985 st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
1986 log_event_table,"site");
1988 st->resolving=False;
1989 st->allow_send_prod=0;
1991 st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
1993 sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
1995 /* The information we expect to see in incoming messages of type 1 */
1996 /* fixme: lots of unchecked overflows here, but the results are only
1997 corrupted packets rather than undefined behaviour */
1998 st->setup_priority=(strcmp(st->localname,st->remotename)>0);
2000 buffer_new(&st->buffer,SETUP_BUFFER_LEN);
2002 buffer_new(&st->scratch,SETUP_BUFFER_LEN);
2003 BUF_ALLOC(&st->scratch,"site:scratch");
2005 /* We are interested in poll(), but only for timeouts. We don't have
2006 any fds of our own. */
2007 register_for_poll(st, site_beforepoll, site_afterpoll, 0, "site");
2010 st->remote_capabilities=0;
2011 st->chosen_transform=0;
2012 st->current.key_timeout=0;
2013 st->auxiliary_key.key_timeout=0;
2014 transport_peers_clear(st,&st->peers);
2015 transport_peers_clear(st,&st->setup_peers);
2016 /* XXX mlock these */
2017 st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
2018 st->sharedsecretlen=st->sharedsecretallocd=0;
2021 for (i=0; i<st->ntransforms; i++) {
2022 struct transform_if *ti=st->transforms[i];
2023 uint32_t capbit = 1UL << ti->capab_transformnum;
2024 if (st->local_capabilities & capbit)
2025 slog(st,LOG_ERROR,"transformnum capability bit"
2026 " %d (%#"PRIx32") reused", ti->capab_transformnum, capbit);
2027 st->local_capabilities |= capbit;
2030 /* We need to register the remote networks with the netlink device */
2031 uint32_t netlink_mtu; /* local virtual interface mtu */
2032 st->netlink->reg(st->netlink->st, site_outgoing, st, &netlink_mtu);
2033 if (!st->mtu_target)
2034 st->mtu_target=netlink_mtu;
2036 for (i=0; i<st->ncomms; i++)
2037 st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
2039 st->current.transform=0;
2040 st->auxiliary_key.transform=0;
2041 st->new_transform=0;
2042 st->auxiliary_is_new=0;
2044 enter_state_stop(st);
2046 add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
2048 return new_closure(&st->cl);
2051 void site_module(dict_t *dict)
2053 add_closure(dict,"site",site_apply);
2057 /***** TRANSPORT PEERS definitions *****/
2059 static void transport_peers_debug(struct site *st, transport_peers *dst,
2060 const char *didwhat,
2061 int nargs, const struct comm_addr *args,
2066 if (!(st->log_events & LOG_PEER_ADDRS))
2067 return; /* an optimisation */
2069 slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
2070 (dst==&st->peers ? "data" :
2071 dst==&st->setup_peers ? "setup" : "UNKNOWN"),
2072 didwhat, nargs, dst->npeers);
2074 for (i=0, argp=(void*)args;
2076 i++, (argp+=stride?stride:sizeof(*args))) {
2077 const struct comm_addr *ca=(void*)argp;
2078 slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
2079 i, comm_addr_to_string(ca));
2081 for (i=0; i<dst->npeers; i++) {
2082 struct timeval diff;
2083 timersub(tv_now,&dst->peers[i].last,&diff);
2084 const struct comm_addr *ca=&dst->peers[i].addr;
2085 slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
2086 i, comm_addr_to_string(ca),
2087 (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
2091 static bool_t transport_addrs_equal(const struct comm_addr *a,
2092 const struct comm_addr *b) {
2093 return !memcmp(a,b,sizeof(*a));
2096 static void transport_peers_expire(struct site *st, transport_peers *peers) {
2097 /* peers must be sorted first */
2098 int previous_peers=peers->npeers;
2099 struct timeval oldest;
2100 oldest.tv_sec = tv_now->tv_sec - st->mobile_peer_expiry;
2101 oldest.tv_usec = tv_now->tv_usec;
2102 while (peers->npeers>1 &&
2103 timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
2105 if (peers->npeers != previous_peers)
2106 transport_peers_debug(st,peers,"expire", 0,0,0);
2109 static bool_t transport_peer_record_one(struct site *st, transport_peers *peers,
2110 const struct comm_addr *ca,
2111 const struct timeval *tv) {
2112 /* returns false if output is full */
2115 if (peers->npeers > st->transport_peers_max)
2118 for (search=0; search<peers->npeers; search++)
2119 if (transport_addrs_equal(&peers->peers[search].addr, ca))
2122 peers->peers[peers->npeers].addr = *ca;
2123 peers->peers[peers->npeers].last = *tv;
2128 static void transport_record_peers(struct site *st, transport_peers *peers,
2129 const struct comm_addr *addrs, int naddrs,
2131 /* We add addrs into peers. The new entries end up at the front
2132 * and displace entries towards the end (perhaps even off the end).
2133 * Any existing matching entries are moved up to the front.
2134 * Caller must first call transport_peers_expire. */
2136 if (naddrs==1 && peers->npeers>=1 &&
2137 transport_addrs_equal(&addrs[0], &peers->peers[0].addr)) {
2138 /* optimisation, also avoids debug for trivial updates */
2139 peers->peers[0].last = *tv_now;
2143 int old_npeers=peers->npeers;
2144 transport_peers old_peers[old_npeers];
2145 memcpy(old_peers,peers->peers,sizeof(old_npeers));
2149 for (i=0; i<naddrs; i++) {
2150 if (!transport_peer_record_one(st,peers, &addrs[i], tv_now))
2153 for (i=0; i<old_npeers; i++) {
2154 const transport_peer *old=&old_peers->peers[i];
2155 if (!transport_peer_record_one(st,peers, &old->addr, &old->last))
2159 transport_peers_debug(st,peers,m, naddrs,addrs,0);
2162 static bool_t transport_compute_setupinit_peers(struct site *st,
2163 const struct comm_addr *configured_addrs /* 0 if none or not found */,
2164 int n_configured_addrs /* 0 if none or not found */,
2165 const struct comm_addr *incoming_packet_addr /* 0 if none */) {
2166 if (!n_configured_addrs && !incoming_packet_addr &&
2167 !transport_peers_valid(&st->peers))
2170 slog(st,LOG_SETUP_INIT,
2171 "using:%d configured addr(s);%s %d old peer addrs(es)",
2173 incoming_packet_addr ? " incoming packet address;" : "",
2176 /* Non-mobile peers try addresses until one is plausible. The
2177 * effect is that this code always tries first the configured
2178 * address if supplied, or otherwise the address of the incoming
2179 * PROD, or finally the existing data peer if one exists; this is
2182 transport_peers_copy(st,&st->setup_peers,&st->peers);
2183 transport_peers_expire(st,&st->setup_peers);
2185 if (incoming_packet_addr)
2186 transport_record_peers(st,&st->setup_peers,
2187 incoming_packet_addr,1, "incoming");
2189 if (n_configured_addrs)
2190 transport_record_peers(st,&st->setup_peers,
2191 configured_addrs,n_configured_addrs, "setupinit");
2193 assert(transport_peers_valid(&st->setup_peers));
2197 static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
2198 if (st->peer_mobile) {
2199 transport_peers_expire(st,&st->setup_peers);
2200 transport_record_peers(st,&st->setup_peers,a,1,"setupmsg");
2203 static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
2204 if (st->peer_mobile) {
2205 transport_peers_expire(st,&st->setup_peers);
2206 transport_record_peers(st,&st->peers,a,1,"datamsg");
2210 static int transport_peers_valid(transport_peers *peers) {
2211 return peers->npeers;
2213 static void transport_peers_clear(struct site *st, transport_peers *peers) {
2215 transport_peers_debug(st,peers,"clear",0,0,0);
2217 static void transport_peers_copy(struct site *st, transport_peers *dst,
2218 const transport_peers *src) {
2219 dst->npeers=src->npeers;
2220 memcpy(dst->peers, src->peers, sizeof(*dst->peers) * dst->npeers);
2221 transport_peers_debug(st,dst,"copy",
2222 src->npeers, &src->peers->addr, sizeof(*src->peers));
2225 static void transport_resolve_complete(struct site *st,
2226 const struct comm_addr *addrs,
2228 transport_peers_expire(st,&st->peers);
2229 transport_record_peers(st,&st->peers,addrs,naddrs,"resolved data");
2230 transport_peers_expire(st,&st->setup_peers);
2231 transport_record_peers(st,&st->setup_peers,addrs,naddrs,"resolved setup");
2234 static void transport_resolve_complete_tardy(struct site *st,
2235 const struct comm_addr *addrs,
2237 transport_peers_expire(st,&st->peers);
2238 transport_record_peers(st,&st->peers,addrs,naddrs,"resolved tardily");
2241 static void transport_peers__copy_by_mask(transport_peer *out, int *nout_io,
2243 const transport_peers *inp) {
2244 /* out and in->peers may be the same region, or nonoverlapping */
2245 const transport_peer *in=inp->peers;
2247 for (slot=0; slot<inp->npeers; slot++) {
2248 if (!(mask & (1U << slot)))
2250 if (!(out==in && slot==*nout_io))
2251 memcpy(&out[*nout_io], &in[slot], sizeof(out[0]));
2256 void transport_xmit(struct site *st, transport_peers *peers,
2257 struct buffer_if *buf, bool_t candebug) {
2259 transport_peers_expire(st, peers);
2260 unsigned failed=0; /* bitmask */
2261 assert(MAX_PEER_ADDRS < sizeof(unsigned)*CHAR_BIT);
2264 for (slot=0; slot<peers->npeers; slot++) {
2265 transport_peer *peer=&peers->peers[slot];
2267 dump_packet(st, buf, &peer->addr, False);
2269 peer->addr.comm->sendmsg(peer->addr.comm->st, buf, &peer->addr);
2271 failed |= 1U << slot;
2274 if (ok && !st->peer_mobile)
2277 /* Now we need to demote/delete failing addrs: if we are mobile we
2278 * merely demote them; otherwise we delete them. */
2279 if (st->local_mobile) {
2280 unsigned expected = ((1U << nfailed)-1) << (peers->npeers-nfailed);
2281 /* `expected' has all the failures at the end already */
2282 if (failed != expected) {
2284 transport_peer failedpeers[nfailed];
2285 transport_peers__copy_by_mask(failedpeers, &fslot, failed,peers);
2286 assert(fslot == nfailed);
2288 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2289 assert(wslot+nfailed == peers->npeers);
2290 memcpy(peers->peers+wslot,failedpeers,sizeof(failedpeers));
2293 if (failed && peers->npeers > 1) {
2295 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2296 peers->npeers=wslot;
2301 /***** END of transport peers declarations *****/