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] */
44 /* Each site can be in one of several possible states. */
47 SITE_STOP - nothing is allowed to happen; tunnel is down;
48 all session keys have been erased
49 -> SITE_RUN upon external instruction
50 SITE_RUN - site up, maybe with valid key
51 -> SITE_RESOLVE upon outgoing packet and no valid key
52 we start name resolution for the other end of the tunnel
53 -> SITE_SENTMSG2 upon valid incoming message 1 and suitable time
54 we send an appropriate message 2
55 SITE_RESOLVE - waiting for name resolution
56 -> SITE_SENTMSG1 upon successful resolution
57 we send an appropriate message 1
58 -> SITE_SENTMSG2 upon valid incoming message 1 (then abort resolution)
59 we abort resolution and
60 -> SITE_WAIT on timeout or resolution failure
62 -> SITE_SENTMSG2 upon valid incoming message 1 from higher priority end
63 -> SITE_SENTMSG3 upon valid incoming message 2
64 -> SITE_WAIT on timeout
66 -> SITE_SENTMSG4 upon valid incoming message 3
67 -> SITE_WAIT on timeout
69 -> SITE_SENTMSG5 upon valid incoming message 4
70 -> SITE_WAIT on timeout
72 -> SITE_RUN upon valid incoming message 5
73 -> SITE_WAIT on timeout
75 -> SITE_RUN upon valid incoming message 6
76 -> SITE_WAIT on timeout
77 SITE_WAIT - failed to establish key; do nothing for a while
78 -> SITE_RUN on timeout
83 #define SITE_RESOLVE 2
84 #define SITE_SENTMSG1 3
85 #define SITE_SENTMSG2 4
86 #define SITE_SENTMSG3 5
87 #define SITE_SENTMSG4 6
88 #define SITE_SENTMSG5 7
91 int32_t site_max_start_pad = 4*4;
93 static cstring_t state_name(uint32_t state)
96 case 0: return "STOP";
98 case 2: return "RESOLVE";
99 case 3: return "SENTMSG1";
100 case 4: return "SENTMSG2";
101 case 5: return "SENTMSG3";
102 case 6: return "SENTMSG4";
103 case 7: return "SENTMSG5";
104 case 8: return "WAIT";
105 default: return "*bad state*";
111 #define LOG_UNEXPECTED 0x00000001
112 #define LOG_SETUP_INIT 0x00000002
113 #define LOG_SETUP_TIMEOUT 0x00000004
114 #define LOG_ACTIVATE_KEY 0x00000008
115 #define LOG_TIMEOUT_KEY 0x00000010
116 #define LOG_SEC 0x00000020
117 #define LOG_STATE 0x00000040
118 #define LOG_DROP 0x00000080
119 #define LOG_DUMP 0x00000100
120 #define LOG_ERROR 0x00000400
121 #define LOG_PEER_ADDRS 0x00000800
123 static struct flagstr log_event_table[]={
124 { "unexpected", LOG_UNEXPECTED },
125 { "setup-init", LOG_SETUP_INIT },
126 { "setup-timeout", LOG_SETUP_TIMEOUT },
127 { "activate-key", LOG_ACTIVATE_KEY },
128 { "timeout-key", LOG_TIMEOUT_KEY },
129 { "security", LOG_SEC },
130 { "state-change", LOG_STATE },
131 { "packet-drop", LOG_DROP },
132 { "dump-packets", LOG_DUMP },
133 { "errors", LOG_ERROR },
134 { "peer-addrs", LOG_PEER_ADDRS },
135 { "default", LOG_SETUP_INIT|LOG_SETUP_TIMEOUT|
136 LOG_ACTIVATE_KEY|LOG_TIMEOUT_KEY|LOG_SEC|LOG_ERROR },
137 { "all", 0xffffffff },
142 /***** TRANSPORT PEERS declarations *****/
144 /* Details of "mobile peer" semantics:
146 - We use the same data structure for the different configurations,
147 but manage it with different algorithms.
149 - We record up to mobile_peers_max peer address/port numbers
150 ("peers") for key setup, and separately up to mobile_peers_max
153 - In general, we make a new set of addrs (see below) when we start
154 a new key exchange; the key setup addrs become the data transport
155 addrs when key setup complets.
157 If our peer is mobile:
159 - We send to all recent addresses of incoming packets, plus
160 initially all configured addresses (which we also expire).
162 - So, we record addrs of good incoming packets, as follows:
163 1. expire any peers last seen >120s ("mobile-peer-expiry") ago
164 2. add the peer of the just received packet to the applicable list
165 (possibly evicting the oldest entries to make room)
166 NB that we do not expire peers until an incoming packet arrives.
168 - If the peer has a configured address or name, we record them the
169 same way, but only as a result of our own initiation of key
170 setup. (We might evict some incoming packet addrs to make room.)
172 - The default number of addrs to keep is 3, or 4 if we have a
173 configured name or address. That's space for two configured
174 addresses (one IPv6 and one IPv4), plus two received addresses.
176 - Outgoing packets are sent to every recorded address in the
177 applicable list. Any unsupported[1] addresses are deleted from
178 the list right away. (This should only happen to configured
179 addresses, of course, but there is no need to check that.)
181 - When we successfully complete a key setup, we merge the key setup
182 peers into the data transfer peers.
184 [1] An unsupported address is one for whose AF we don't have a
185 socket (perhaps because we got EAFNOSUPPORT or some such) or for
186 which sendto gives ENETUNREACH.
188 If neither end is mobile:
190 - When peer initiated the key exchange, we use the incoming packet
193 - When we initiate the key exchange, we try configured addresses
194 until we get one which isn't unsupported then fixate on that.
196 - When we complete a key setup, we replace the data transport peers
197 with those from the key setup.
201 - We can't tell when local network setup changes so we can't cache
202 the unsupported addrs and completely remove the spurious calls to
203 sendto, but we can optimise things a bit by deprioritising addrs
204 which seem to be unsupported.
206 - Use only configured addresses. (Except, that if our peer
207 initiated a key exchange we use the incoming packet address until
208 our name resolution completes.)
210 - When we send a packet, try each address in turn; if addr
211 supported, put that address to the end of the list for future
212 packets, and go onto the next address.
214 - When we complete a key setup, we replace the data transport peers
215 with those from the key setup.
221 struct comm_addr addr;
225 /* configuration information */
226 /* runtime information */
228 transport_peer peers[MAX_PEER_ADDRS];
231 /* Basic operations on transport peer address sets */
232 static void transport_peers_clear(struct site *st, transport_peers *peers);
233 static int transport_peers_valid(transport_peers *peers);
234 static void transport_peers_copy(struct site *st, transport_peers *dst,
235 const transport_peers *src);
237 /* Record address of incoming setup packet; resp. data packet. */
238 static void transport_setup_msgok(struct site *st, const struct comm_addr *a);
239 static void transport_data_msgok(struct site *st, const struct comm_addr *a);
241 /* Initialise the setup addresses. Called before we send the first
242 * packet in a key exchange. If we are the initiator, as a result of
243 * resolve completing (or being determined not to be relevant) or an
244 * incoming PROD; if we are the responder, as a result of the MSG1. */
245 static bool_t transport_compute_setupinit_peers(struct site *st,
246 const struct comm_addr *configured_addrs /* 0 if none or not found */,
247 int n_configured_addrs /* 0 if none or not found */,
248 const struct comm_addr *incoming_packet_addr /* 0 if none */);
250 /* Called if we are the responder in a key setup, when the resolve
251 * completes. transport_compute_setupinit_peers will hvae been called
252 * earlier. If _complete is called, we are still doing the key setup
253 * (and we should use the new values for both the rest of the key
254 * setup and the ongoing data exchange); if _tardy is called, the key
255 * setup is done (either completed or not) and only the data peers are
257 static void transport_resolve_complete(struct site *st,
258 const struct comm_addr *addrs, int naddrs);
259 static void transport_resolve_complete_tardy(struct site *st,
260 const struct comm_addr *addrs, int naddrs);
262 static void transport_xmit(struct site *st, transport_peers *peers,
263 struct buffer_if *buf, bool_t candebug);
265 /***** END of transport peers declarations *****/
269 struct transform_inst_if *transform;
270 uint64_t key_timeout; /* End of life of current key */
271 uint32_t remote_session_id;
277 /* configuration information */
280 bool_t local_mobile, peer_mobile; /* Mobile client support */
281 int32_t transport_peers_max;
282 string_t tunname; /* localname<->remotename by default, used in logs */
283 cstring_t *addresses; /* DNS name or address(es) for bootstrapping, optional */
284 int remoteport; /* Port for bootstrapping, optional */
286 struct netlink_if *netlink;
287 struct comm_if **comms;
289 struct resolver_if *resolver;
291 struct random_if *random;
292 struct rsaprivkey_if *privkey;
293 struct rsapubkey_if *pubkey;
294 struct transform_if **transforms;
297 struct hash_if *hash;
299 uint32_t index; /* Index of this site */
300 uint32_t local_capabilities;
301 int32_t setup_retries; /* How many times to send setup packets */
302 int32_t setup_retry_interval; /* Initial timeout for setup packets */
303 int32_t wait_timeout; /* How long to wait if setup unsuccessful */
304 int32_t mobile_peer_expiry; /* How long to remember 2ary addresses */
305 int32_t key_lifetime; /* How long a key lasts once set up */
306 int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
307 after this time, initiate a new
310 bool_t setup_priority; /* Do we have precedence if both sites emit
311 message 1 simultaneously? */
314 /* runtime information */
316 uint64_t now; /* Most recently seen time */
317 bool_t allow_send_prod;
319 int resolving_n_results_all;
320 int resolving_n_results_stored;
321 struct comm_addr resolving_results[MAX_PEER_ADDRS];
323 /* The currently established session */
324 struct data_key current;
325 struct data_key auxiliary_key;
326 bool_t auxiliary_is_new;
327 uint64_t renegotiate_key_time; /* When we can negotiate a new key */
328 uint64_t auxiliary_renegotiate_key_time;
329 transport_peers peers; /* Current address(es) of peer for data traffic */
331 /* The current key setup protocol exchange. We can only be
332 involved in one of these at a time. There's a potential for
333 denial of service here (the attacker keeps sending a setup
334 packet; we keep trying to continue the exchange, and have to
335 timeout before we can listen for another setup packet); perhaps
336 we should keep a list of 'bad' sources for setup packets. */
337 uint32_t remote_capabilities;
338 uint16_t remote_adv_mtu;
339 struct transform_if *chosen_transform;
340 uint32_t setup_session_id;
341 transport_peers setup_peers;
342 uint8_t localN[NONCELEN]; /* Nonces for key exchange */
343 uint8_t remoteN[NONCELEN];
344 struct buffer_if buffer; /* Current outgoing key exchange packet */
345 struct buffer_if scratch;
346 int32_t retries; /* Number of retries remaining */
347 uint64_t timeout; /* Timeout for current state */
349 uint8_t *sharedsecret;
350 uint32_t sharedsecretlen, sharedsecretallocd;
351 struct transform_inst_if *new_transform; /* For key setup/verify */
354 static uint32_t event_log_priority(struct site *st, uint32_t event)
356 if (!(event&st->log_events))
359 case LOG_UNEXPECTED: return M_INFO;
360 case LOG_SETUP_INIT: return M_INFO;
361 case LOG_SETUP_TIMEOUT: return M_NOTICE;
362 case LOG_ACTIVATE_KEY: return M_INFO;
363 case LOG_TIMEOUT_KEY: return M_INFO;
364 case LOG_SEC: return M_SECURITY;
365 case LOG_STATE: return M_DEBUG;
366 case LOG_DROP: return M_DEBUG;
367 case LOG_DUMP: return M_DEBUG;
368 case LOG_ERROR: return M_ERR;
369 case LOG_PEER_ADDRS: return M_DEBUG;
370 default: return M_ERR;
374 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
376 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
380 class=event_log_priority(st, event);
382 slilog_part(st->log,class,"%s: ",st->tunname);
383 vslilog_part(st->log,class,msg,ap);
384 slilog_part(st->log,class,"\n");
388 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
390 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
394 vslog(st,event,msg,ap);
398 static void logtimeout(struct site *st, const char *fmt, ...)
400 static void logtimeout(struct site *st, const char *fmt, ...)
402 uint32_t class=event_log_priority(st,LOG_SETUP_TIMEOUT);
409 slilog_part(st->log,class,"%s: ",st->tunname);
410 vslilog_part(st->log,class,fmt,ap);
414 for (i=0, delim=" (tried ";
415 i<st->setup_peers.npeers;
417 transport_peer *peer=&st->setup_peers.peers[i];
418 const char *s=comm_addr_to_string(&peer->addr);
419 slilog_part(st->log,class,"%s%s",delim,s);
422 slilog_part(st->log,class,")\n");
426 static void set_link_quality(struct site *st);
427 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel);
428 static void delete_one_key(struct site *st, struct data_key *key,
429 const char *reason /* may be 0 meaning don't log*/,
430 const char *which /* ignored if !reasonn */,
431 uint32_t loglevel /* ignored if !reasonn */);
432 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
433 const struct comm_addr *prod_hint);
434 static void enter_state_run(struct site *st);
435 static bool_t enter_state_resolve(struct site *st);
436 static void decrement_resolving_count(struct site *st, int by);
437 static bool_t enter_new_state(struct site *st,uint32_t next);
438 static void enter_state_wait(struct site *st);
439 static void activate_new_key(struct site *st);
441 static bool_t is_transform_valid(struct transform_inst_if *transform)
443 return transform && transform->valid(transform->st);
446 static bool_t current_valid(struct site *st)
448 return is_transform_valid(st->current.transform);
451 #define DEFINE_CALL_TRANSFORM(fwdrev) \
452 static int call_transform_##fwdrev(struct site *st, \
453 struct transform_inst_if *transform, \
454 struct buffer_if *buf, \
455 const char **errmsg) \
457 if (!is_transform_valid(transform)) { \
458 *errmsg="transform not set up"; \
461 return transform->fwdrev(transform->st,buf,errmsg); \
464 DEFINE_CALL_TRANSFORM(forwards)
465 DEFINE_CALL_TRANSFORM(reverse)
467 static void dispose_transform(struct transform_inst_if **transform_var)
469 struct transform_inst_if *transform=*transform_var;
471 transform->delkey(transform->st);
472 transform->destroy(transform->st);
477 #define CHECK_AVAIL(b,l) do { if ((b)->size<(l)) return False; } while(0)
478 #define CHECK_EMPTY(b) do { if ((b)->size!=0) return False; } while(0)
479 #define CHECK_TYPE(b,t) do { uint32_t type; \
480 CHECK_AVAIL((b),4); \
481 type=buf_unprepend_uint32((b)); \
482 if (type!=(t)) return False; } while(0)
484 static _Bool type_is_msg34(uint32_t type)
487 type == LABEL_MSG3 ||
488 type == LABEL_MSG3BIS ||
495 struct buffer_if extrainfo;
502 struct parsedname remote;
503 struct parsedname local;
504 uint32_t remote_capabilities;
506 int capab_transformnum;
516 static void set_new_transform(struct site *st, char *pk)
518 /* Make room for the shared key */
519 st->sharedsecretlen=st->chosen_transform->keylen?:st->dh->ceil_len;
520 assert(st->sharedsecretlen);
521 if (st->sharedsecretlen > st->sharedsecretallocd) {
522 st->sharedsecretallocd=st->sharedsecretlen;
523 st->sharedsecret=safe_realloc_ary(st->sharedsecret,1,
524 st->sharedsecretallocd,
525 "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 BUF_ADD_OBJ(append,&st->buffer,st->localN);
602 if (type==LABEL_MSG1) return True;
603 BUF_ADD_OBJ(append,&st->buffer,st->remoteN);
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,
1199 int stored_naddrs, int all_naddrs,
1200 const char *address, const char *failwhy)
1202 struct site *st=sst;
1204 if (!stored_naddrs) {
1205 slog(st,LOG_ERROR,"resolution of %s failed: %s",address,failwhy);
1207 slog(st,LOG_PEER_ADDRS,"resolution of %s completed, %d addrs, eg: %s",
1208 address, all_naddrs, comm_addr_to_string(&addrs[0]));;
1210 int space=st->transport_peers_max-st->resolving_n_results_stored;
1211 int n_tocopy=MIN(stored_naddrs,space);
1212 COPY_ARRAY(st->resolving_results + st->resolving_n_results_stored,
1215 st->resolving_n_results_stored += n_tocopy;
1216 st->resolving_n_results_all += all_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_stored;
1234 assert(naddrs<=st->transport_peers_max);
1237 if (naddrs != st->resolving_n_results_all) {
1238 slog(st,LOG_SETUP_INIT,"resolution of supplied addresses/names"
1239 " yielded too many results (%d > %d), some ignored",
1240 st->resolving_n_results_all, naddrs);
1242 slog(st,LOG_STATE,"resolution completed, %d addrs, eg: %s",
1243 naddrs, comm_addr_to_string(&addrs[0]));;
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_stored=0;
1429 st->resolving_n_results_all=0;
1430 st->resolving_count+=2;
1431 const char **addrp=st->addresses;
1432 const char *address;
1434 for (; (address=*addrp++); ) {
1435 bool_t ok = st->resolver->request(st->resolver->st,address,
1436 st->remoteport,st->comms[0],
1437 site_resolve_callback,st);
1439 st->resolving_count++;
1443 st->resolving_count=0;
1446 decrement_resolving_count(st,2);
1450 static bool_t enter_state_resolve(struct site *st)
1452 /* Reentrancy hazard! See ensure_resolving. */
1453 state_assert(st,st->state==SITE_RUN);
1454 slog(st,LOG_STATE,"entering state RESOLVE");
1455 st->state=SITE_RESOLVE;
1456 return ensure_resolving(st);
1459 static bool_t enter_new_state(struct site *st, uint32_t next)
1461 bool_t (*gen)(struct site *st);
1464 slog(st,LOG_STATE,"entering state %s",state_name(next));
1467 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
1471 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1472 st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
1476 state_assert(st,st->state==SITE_SENTMSG1);
1477 BUF_FREE(&st->buffer);
1481 state_assert(st,st->state==SITE_SENTMSG2);
1482 BUF_FREE(&st->buffer);
1486 state_assert(st,st->state==SITE_SENTMSG3);
1487 BUF_FREE(&st->buffer);
1491 state_assert(st,st->state==SITE_SENTMSG4);
1492 BUF_FREE(&st->buffer);
1497 fatal("enter_new_state(%s): invalid new state",state_name(next));
1501 if (hacky_par_start_failnow()) return False;
1503 r= gen(st) && send_msg(st);
1506 st->setup_retries, st->setup_retry_interval,
1511 if (next==SITE_RUN) {
1512 BUF_FREE(&st->buffer); /* Never reused */
1513 st->timeout=0; /* Never retransmit */
1514 activate_new_key(st);
1518 slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1519 st->buffer.free=False; /* Unconditionally use the buffer; it may be
1520 in either state, and enter_state_wait() will
1522 enter_state_wait(st);
1526 /* msg7 tells our peer that we're about to forget our key */
1527 static bool_t send_msg7(struct site *st, cstring_t reason)
1529 cstring_t transform_err;
1531 if (current_valid(st) && st->buffer.free
1532 && transport_peers_valid(&st->peers)) {
1533 BUF_ALLOC(&st->buffer,"site:MSG7");
1534 buffer_init(&st->buffer,calculate_max_start_pad());
1535 buf_append_uint32(&st->buffer,LABEL_MSG7);
1536 buf_append_string(&st->buffer,reason);
1537 if (call_transform_forwards(st, st->current.transform,
1538 &st->buffer, &transform_err))
1540 buf_prepend_uint32(&st->buffer,LABEL_MSG0);
1541 buf_prepend_uint32(&st->buffer,st->index);
1542 buf_prepend_uint32(&st->buffer,st->current.remote_session_id);
1543 transport_xmit(st,&st->peers,&st->buffer,True);
1544 BUF_FREE(&st->buffer);
1551 /* We go into this state if our peer becomes uncommunicative. Similar to
1552 the "stop" state, we forget all session keys for a while, before
1553 re-entering the "run" state. */
1554 static void enter_state_wait(struct site *st)
1556 slog(st,LOG_STATE,"entering state WAIT");
1557 st->timeout=st->now+st->wait_timeout;
1558 st->state=SITE_WAIT;
1559 set_link_quality(st);
1560 BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1561 /* XXX Erase keys etc. */
1564 static void generate_prod(struct site *st, struct buffer_if *buf)
1567 buf_append_uint32(buf,0);
1568 buf_append_uint32(buf,0);
1569 buf_append_uint32(buf,LABEL_PROD);
1570 buf_append_string(buf,st->localname);
1571 buf_append_string(buf,st->remotename);
1574 static void generate_send_prod(struct site *st,
1575 const struct comm_addr *source)
1577 if (!st->allow_send_prod) return; /* too soon */
1578 if (!(st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1579 st->state==SITE_WAIT)) return; /* we'd ignore peer's MSG1 */
1581 slog(st,LOG_SETUP_INIT,"prodding peer for key exchange");
1582 st->allow_send_prod=0;
1583 generate_prod(st,&st->scratch);
1584 dump_packet(st,&st->scratch,source,False);
1585 source->comm->sendmsg(source->comm->st, &st->scratch, source);
1588 static inline void site_settimeout(uint64_t timeout, int *timeout_io)
1591 int64_t offset=timeout-*now;
1592 if (offset<0) offset=0;
1593 if (offset>INT_MAX) offset=INT_MAX;
1594 if (*timeout_io<0 || offset<*timeout_io)
1599 static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
1602 struct site *st=sst;
1604 BEFOREPOLL_WANT_FDS(0); /* We don't use any file descriptors */
1607 /* Work out when our next timeout is. The earlier of 'timeout' or
1608 'current.key_timeout'. A stored value of '0' indicates no timeout
1610 site_settimeout(st->timeout, timeout_io);
1611 site_settimeout(st->current.key_timeout, timeout_io);
1612 site_settimeout(st->auxiliary_key.key_timeout, timeout_io);
1614 return 0; /* success */
1617 static void check_expiry(struct site *st, struct data_key *key,
1620 if (key->key_timeout && *now>key->key_timeout) {
1621 delete_one_key(st,key,"maximum life exceeded",which,LOG_TIMEOUT_KEY);
1625 /* NB site_afterpoll will be called before site_beforepoll is ever called */
1626 static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
1628 struct site *st=sst;
1631 if (st->timeout && *now>st->timeout) {
1633 if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
1634 if (!hacky_par_start_failnow())
1636 } else if (st->state==SITE_WAIT) {
1637 enter_state_run(st);
1639 slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
1643 check_expiry(st,&st->current,"current key");
1644 check_expiry(st,&st->auxiliary_key,"auxiliary key");
1647 /* This function is called by the netlink device to deliver packets
1648 intended for the remote network. The packet is in "raw" wire
1649 format, but is guaranteed to be word-aligned. */
1650 static void site_outgoing(void *sst, struct buffer_if *buf)
1652 struct site *st=sst;
1653 cstring_t transform_err;
1655 if (st->state==SITE_STOP) {
1660 st->allow_send_prod=1;
1662 /* In all other states we consider delivering the packet if we have
1663 a valid key and a valid address to send it to. */
1664 if (current_valid(st) && transport_peers_valid(&st->peers)) {
1665 /* Transform it and send it */
1667 buf_prepend_uint32(buf,LABEL_MSG9);
1668 if (call_transform_forwards(st, st->current.transform,
1669 buf, &transform_err))
1671 buf_prepend_uint32(buf,LABEL_MSG0);
1672 buf_prepend_uint32(buf,st->index);
1673 buf_prepend_uint32(buf,st->current.remote_session_id);
1674 transport_xmit(st,&st->peers,buf,False);
1681 slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
1683 initiate_key_setup(st,"outgoing packet",0);
1686 static bool_t named_for_us(struct site *st, const struct buffer_if *buf_in,
1687 uint32_t type, struct msg *m)
1688 /* For packets which are identified by the local and remote names.
1689 * If it has our name and our peer's name in it it's for us. */
1691 struct buffer_if buf[1];
1692 buffer_readonly_clone(buf,buf_in);
1693 return unpick_msg(st,type,buf,m)
1694 && name_matches(&m->remote,st->remotename)
1695 && name_matches(&m->local,st->localname);
1698 /* This function is called by the communication device to deliver
1699 packets from our peers.
1700 It should return True if the packet is recognised as being for
1701 this current site instance (and should therefore not be processed
1702 by other sites), even if the packet was otherwise ignored. */
1703 static bool_t site_incoming(void *sst, struct buffer_if *buf,
1704 const struct comm_addr *source)
1706 struct site *st=sst;
1708 if (buf->size < 12) return False;
1710 uint32_t dest=get_uint32(buf->start);
1711 uint32_t msgtype=get_uint32(buf->start+8);
1712 struct msg named_msg;
1714 if (msgtype==LABEL_MSG1) {
1715 if (!named_for_us(st,buf,msgtype,&named_msg))
1717 /* It's a MSG1 addressed to us. Decide what to do about it. */
1718 dump_packet(st,buf,source,True);
1719 if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1720 st->state==SITE_WAIT) {
1721 /* We should definitely process it */
1722 transport_compute_setupinit_peers(st,0,0,source);
1723 if (process_msg1(st,buf,source,&named_msg)) {
1724 slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
1725 bool_t entered=enter_new_state(st,SITE_SENTMSG2);
1726 if (entered && st->addresses && st->local_mobile)
1727 /* We must do this as the very last thing, because
1728 the resolver callback might reenter us. */
1729 ensure_resolving(st);
1731 slog(st,LOG_ERROR,"failed to process incoming msg1");
1735 } else if (st->state==SITE_SENTMSG1) {
1736 /* We've just sent a message 1! They may have crossed on
1737 the wire. If we have priority then we ignore the
1738 incoming one, otherwise we process it as usual. */
1739 if (st->setup_priority) {
1741 slog(st,LOG_DUMP,"crossed msg1s; we are higher "
1742 "priority => ignore incoming msg1");
1745 slog(st,LOG_DUMP,"crossed msg1s; we are lower "
1746 "priority => use incoming msg1");
1747 if (process_msg1(st,buf,source,&named_msg)) {
1748 BUF_FREE(&st->buffer); /* Free our old message 1 */
1749 transport_setup_msgok(st,source);
1750 enter_new_state(st,SITE_SENTMSG2);
1752 slog(st,LOG_ERROR,"failed to process an incoming "
1753 "crossed msg1 (we have low priority)");
1759 /* The message 1 was received at an unexpected stage of the
1760 key setup. XXX POLICY - what do we do? */
1761 slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
1765 if (msgtype==LABEL_PROD) {
1766 if (!named_for_us(st,buf,msgtype,&named_msg))
1768 dump_packet(st,buf,source,True);
1769 if (st->state!=SITE_RUN) {
1770 slog(st,LOG_DROP,"ignoring PROD when not in state RUN");
1771 } else if (current_valid(st)) {
1772 slog(st,LOG_DROP,"ignoring PROD when we think we have a key");
1774 initiate_key_setup(st,"peer sent PROD packet",source);
1779 if (dest==st->index) {
1780 /* Explicitly addressed to us */
1781 if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True);
1784 /* If the source is our current peer then initiate a key setup,
1785 because our peer's forgotten the key */
1786 if (get_uint32(buf->start+4)==st->current.remote_session_id) {
1788 initiated = initiate_key_setup(st,"received a NAK",source);
1789 if (!initiated) generate_send_prod(st,source);
1791 slog(st,LOG_SEC,"bad incoming NAK");
1795 process_msg0(st,buf,source);
1798 /* Setup packet: should not have been explicitly addressed
1800 slog(st,LOG_SEC,"incoming explicitly addressed msg1");
1803 /* Setup packet: expected only in state SENTMSG1 */
1804 if (st->state!=SITE_SENTMSG1) {
1805 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
1806 } else if (process_msg2(st,buf,source)) {
1807 transport_setup_msgok(st,source);
1808 enter_new_state(st,SITE_SENTMSG3);
1810 slog(st,LOG_SEC,"invalid MSG2");
1815 /* Setup packet: expected only in state SENTMSG2 */
1816 if (st->state!=SITE_SENTMSG2) {
1817 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
1818 } else if (process_msg3(st,buf,source,msgtype)) {
1819 transport_setup_msgok(st,source);
1820 enter_new_state(st,SITE_SENTMSG4);
1822 slog(st,LOG_SEC,"invalid MSG3");
1826 /* Setup packet: expected only in state SENTMSG3 */
1827 if (st->state!=SITE_SENTMSG3) {
1828 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
1829 } else if (process_msg4(st,buf,source)) {
1830 transport_setup_msgok(st,source);
1831 enter_new_state(st,SITE_SENTMSG5);
1833 slog(st,LOG_SEC,"invalid MSG4");
1837 /* Setup packet: expected only in state SENTMSG4 */
1838 /* (may turn up in state RUN if our return MSG6 was lost
1839 and the new key has already been activated. In that
1840 case we discard it. The peer will realise that we
1841 are using the new key when they see our data packets.
1842 Until then the peer's data packets to us get discarded. */
1843 if (st->state==SITE_SENTMSG4) {
1844 if (process_msg5(st,buf,source,st->new_transform)) {
1845 transport_setup_msgok(st,source);
1846 enter_new_state(st,SITE_RUN);
1848 slog(st,LOG_SEC,"invalid MSG5");
1850 } else if (st->state==SITE_RUN) {
1851 if (process_msg5(st,buf,source,st->current.transform)) {
1852 slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
1853 transport_setup_msgok(st,source);
1854 create_msg6(st,st->current.transform,
1855 st->current.remote_session_id);
1856 transport_xmit(st,&st->peers,&st->buffer,True);
1857 BUF_FREE(&st->buffer);
1859 slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
1862 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
1866 /* Setup packet: expected only in state SENTMSG5 */
1867 if (st->state!=SITE_SENTMSG5) {
1868 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
1869 } else if (process_msg6(st,buf,source)) {
1870 BUF_FREE(&st->buffer); /* Free message 5 */
1871 transport_setup_msgok(st,source);
1872 activate_new_key(st);
1874 slog(st,LOG_SEC,"invalid MSG6");
1878 slog(st,LOG_SEC,"received message of unknown type 0x%08x",
1889 static void site_control(void *vst, bool_t run)
1891 struct site *st=vst;
1892 if (run) enter_state_run(st);
1893 else enter_state_stop(st);
1896 static void site_phase_hook(void *sst, uint32_t newphase)
1898 struct site *st=sst;
1900 /* The program is shutting down; tell our peer */
1901 send_msg7(st,"shutting down");
1904 static void site_childpersist_clearkeys(void *sst, uint32_t newphase)
1906 struct site *st=sst;
1907 dispose_transform(&st->current.transform);
1908 dispose_transform(&st->auxiliary_key.transform);
1909 dispose_transform(&st->new_transform);
1910 /* Not much point overwiting the signing key, since we loaded it
1911 from disk, and it is only valid prospectively if at all,
1913 /* XXX it would be best to overwrite the DH state, because that
1914 _is_ relevant to forward secrecy. However we have no
1915 convenient interface for doing that and in practice gmp has
1916 probably dribbled droppings all over the malloc arena. A good
1917 way to fix this would be to have a privsep child for asymmetric
1918 crypto operations, but that's a task for another day. */
1921 static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
1924 static uint32_t index_sequence;
1932 st->cl.description="site";
1933 st->cl.type=CL_SITE;
1935 st->cl.interface=&st->ops;
1937 st->ops.control=site_control;
1938 st->ops.status=site_status;
1940 /* First parameter must be a dict */
1941 item=list_elem(args,0);
1942 if (!item || item->type!=t_dict)
1943 cfgfatal(loc,"site","parameter must be a dictionary\n");
1945 dict=item->data.dict;
1946 st->localname=dict_read_string(dict, "local-name", True, "site", loc);
1947 st->remotename=dict_read_string(dict, "name", True, "site", loc);
1949 st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
1951 dict_read_bool(dict,"local-mobile",False,"site",loc,False);
1953 /* Sanity check (which also allows the 'sites' file to include
1954 site() closures for all sites including our own): refuse to
1955 talk to ourselves */
1956 if (strcmp(st->localname,st->remotename)==0) {
1957 Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
1959 if (st->peer_mobile != st->local_mobile)
1960 cfgfatal(loc,"site","site %s's peer-mobile=%d"
1961 " but our local-mobile=%d\n",
1962 st->localname, st->peer_mobile, st->local_mobile);
1966 if (st->peer_mobile && st->local_mobile) {
1967 Message(M_WARNING,"site %s: site is mobile but so are we"
1968 " -> ignoring this site\n", st->remotename);
1973 assert(index_sequence < 0xffffffffUL);
1974 st->index = ++index_sequence;
1975 st->local_capabilities = 0;
1976 st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
1978 #define GET_CLOSURE_LIST(dictkey,things,nthings,CL_TYPE) do{ \
1979 list_t *things##_cfg=dict_lookup(dict,dictkey); \
1980 if (!things##_cfg) \
1981 cfgfatal(loc,"site","closure list \"%s\" not found\n",dictkey); \
1982 st->nthings=list_length(things##_cfg); \
1983 st->things=safe_malloc_ary(sizeof(*st->things),st->nthings,dictkey "s"); \
1984 assert(st->nthings); \
1985 for (i=0; i<st->nthings; i++) { \
1986 item_t *item=list_elem(things##_cfg,i); \
1987 if (item->type!=t_closure) \
1988 cfgfatal(loc,"site","%s is not a closure\n",dictkey); \
1989 closure_t *cl=item->data.closure; \
1990 if (cl->type!=CL_TYPE) \
1991 cfgfatal(loc,"site","%s closure wrong type\n",dictkey); \
1992 st->things[i]=cl->interface; \
1996 GET_CLOSURE_LIST("comm",comms,ncomms,CL_COMM);
1998 st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
1999 st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
2000 st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
2002 st->privkey=find_cl_if(dict,"local-key",CL_RSAPRIVKEY,True,"site",loc);
2003 st->addresses=dict_read_string_array(dict,"address",False,"site",loc,0);
2005 st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
2006 else st->remoteport=0;
2007 st->pubkey=find_cl_if(dict,"key",CL_RSAPUBKEY,True,"site",loc);
2009 GET_CLOSURE_LIST("transform",transforms,ntransforms,CL_TRANSFORM);
2011 st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
2012 st->hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
2014 #define DEFAULT(D) (st->peer_mobile || st->local_mobile \
2015 ? DEFAULT_MOBILE_##D : DEFAULT_##D)
2016 #define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
2018 st->key_lifetime= CFG_NUMBER("key-lifetime", KEY_LIFETIME);
2019 st->setup_retries= CFG_NUMBER("setup-retries", SETUP_RETRIES);
2020 st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
2021 st->wait_timeout= CFG_NUMBER("wait-time", WAIT_TIME);
2022 st->mtu_target= dict_read_number(dict,"mtu-target",False,"site",loc,0);
2024 st->mobile_peer_expiry= dict_read_number(
2025 dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
2027 const char *peerskey= st->peer_mobile
2028 ? "mobile-peers-max" : "static-peers-max";
2029 st->transport_peers_max= dict_read_number(
2030 dict,peerskey,False,"site",loc, st->addresses ? 4 : 3);
2031 if (st->transport_peers_max<1 ||
2032 st->transport_peers_max>MAX_PEER_ADDRS) {
2033 cfgfatal(loc,"site", "%s must be in range 1.."
2034 STRING(MAX_PEER_ADDRS) "\n", peerskey);
2037 if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
2038 st->key_renegotiate_time=st->key_lifetime/2;
2040 st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
2041 st->key_renegotiate_time=dict_read_number(
2042 dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
2043 if (st->key_renegotiate_time > st->key_lifetime) {
2044 cfgfatal(loc,"site",
2045 "renegotiate-time must be less than key-lifetime\n");
2048 st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
2049 log_event_table,"site");
2051 st->resolving_count=0;
2052 st->allow_send_prod=0;
2054 st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
2056 sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
2058 /* The information we expect to see in incoming messages of type 1 */
2059 /* fixme: lots of unchecked overflows here, but the results are only
2060 corrupted packets rather than undefined behaviour */
2061 st->setup_priority=(strcmp(st->localname,st->remotename)>0);
2063 buffer_new(&st->buffer,SETUP_BUFFER_LEN);
2065 buffer_new(&st->scratch,SETUP_BUFFER_LEN);
2066 BUF_ALLOC(&st->scratch,"site:scratch");
2068 /* We are interested in poll(), but only for timeouts. We don't have
2069 any fds of our own. */
2070 register_for_poll(st, site_beforepoll, site_afterpoll, "site");
2073 st->remote_capabilities=0;
2074 st->chosen_transform=0;
2075 st->current.key_timeout=0;
2076 st->auxiliary_key.key_timeout=0;
2077 transport_peers_clear(st,&st->peers);
2078 transport_peers_clear(st,&st->setup_peers);
2079 /* XXX mlock these */
2080 st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
2081 st->sharedsecretlen=st->sharedsecretallocd=0;
2084 for (i=0; i<st->ntransforms; i++) {
2085 struct transform_if *ti=st->transforms[i];
2086 uint32_t capbit = 1UL << ti->capab_transformnum;
2087 if (st->local_capabilities & capbit)
2088 slog(st,LOG_ERROR,"transformnum capability bit"
2089 " %d (%#"PRIx32") reused", ti->capab_transformnum, capbit);
2090 st->local_capabilities |= capbit;
2093 /* We need to register the remote networks with the netlink device */
2094 uint32_t netlink_mtu; /* local virtual interface mtu */
2095 st->netlink->reg(st->netlink->st, site_outgoing, st, &netlink_mtu);
2096 if (!st->mtu_target)
2097 st->mtu_target=netlink_mtu;
2099 for (i=0; i<st->ncomms; i++)
2100 st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
2102 st->current.transform=0;
2103 st->auxiliary_key.transform=0;
2104 st->new_transform=0;
2105 st->auxiliary_is_new=0;
2107 enter_state_stop(st);
2109 add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
2110 add_hook(PHASE_CHILDPERSIST,site_childpersist_clearkeys,st);
2112 return new_closure(&st->cl);
2115 void site_module(dict_t *dict)
2117 add_closure(dict,"site",site_apply);
2121 /***** TRANSPORT PEERS definitions *****/
2123 static void transport_peers_debug(struct site *st, transport_peers *dst,
2124 const char *didwhat,
2125 int nargs, const struct comm_addr *args,
2130 if (!(st->log_events & LOG_PEER_ADDRS))
2131 return; /* an optimisation */
2133 slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
2134 (dst==&st->peers ? "data" :
2135 dst==&st->setup_peers ? "setup" : "UNKNOWN"),
2136 didwhat, nargs, dst->npeers);
2138 for (i=0, argp=(void*)args;
2140 i++, (argp+=stride?stride:sizeof(*args))) {
2141 const struct comm_addr *ca=(void*)argp;
2142 slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
2143 i, comm_addr_to_string(ca));
2145 for (i=0; i<dst->npeers; i++) {
2146 struct timeval diff;
2147 timersub(tv_now,&dst->peers[i].last,&diff);
2148 const struct comm_addr *ca=&dst->peers[i].addr;
2149 slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
2150 i, comm_addr_to_string(ca),
2151 (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
2155 static void transport_peers_expire(struct site *st, transport_peers *peers) {
2156 /* peers must be sorted first */
2157 int previous_peers=peers->npeers;
2158 struct timeval oldest;
2159 oldest.tv_sec = tv_now->tv_sec - st->mobile_peer_expiry;
2160 oldest.tv_usec = tv_now->tv_usec;
2161 while (peers->npeers>1 &&
2162 timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
2164 if (peers->npeers != previous_peers)
2165 transport_peers_debug(st,peers,"expire", 0,0,0);
2168 static bool_t transport_peer_record_one(struct site *st, transport_peers *peers,
2169 const struct comm_addr *ca,
2170 const struct timeval *tv) {
2171 /* returns false if output is full */
2174 if (peers->npeers >= st->transport_peers_max)
2177 for (search=0; search<peers->npeers; search++)
2178 if (comm_addr_equal(&peers->peers[search].addr, ca))
2181 peers->peers[peers->npeers].addr = *ca;
2182 peers->peers[peers->npeers].last = *tv;
2187 static void transport_record_peers(struct site *st, transport_peers *peers,
2188 const struct comm_addr *addrs, int naddrs,
2190 /* We add addrs into peers. The new entries end up at the front
2191 * and displace entries towards the end (perhaps even off the
2192 * end). Any existing matching entries are moved up to the front.
2194 * Caller must first call transport_peers_expire. */
2196 if (naddrs==1 && peers->npeers>=1 &&
2197 comm_addr_equal(&addrs[0], &peers->peers[0].addr)) {
2198 /* optimisation, also avoids debug for trivial updates */
2199 peers->peers[0].last = *tv_now;
2203 int old_npeers=peers->npeers;
2204 transport_peer old_peers[old_npeers];
2205 COPY_ARRAY(old_peers,peers->peers,old_npeers);
2209 for (i=0; i<naddrs; i++) {
2210 if (!transport_peer_record_one(st,peers, &addrs[i], tv_now))
2213 for (i=0; i<old_npeers; i++) {
2214 const transport_peer *old=&old_peers[i];
2215 if (!transport_peer_record_one(st,peers, &old->addr, &old->last))
2219 transport_peers_debug(st,peers,m, naddrs,addrs,0);
2222 static void transport_expire_record_peers(struct site *st,
2223 transport_peers *peers,
2224 const struct comm_addr *addrs,
2225 int naddrs, const char *m) {
2226 /* Convenience function */
2227 transport_peers_expire(st,peers);
2228 transport_record_peers(st,peers,addrs,naddrs,m);
2231 static bool_t transport_compute_setupinit_peers(struct site *st,
2232 const struct comm_addr *configured_addrs /* 0 if none or not found */,
2233 int n_configured_addrs /* 0 if none or not found */,
2234 const struct comm_addr *incoming_packet_addr /* 0 if none */) {
2235 if (!n_configured_addrs && !incoming_packet_addr &&
2236 !transport_peers_valid(&st->peers))
2239 slog(st,LOG_SETUP_INIT,
2240 "using: %d configured addr(s);%s %d old peer addrs(es)",
2242 incoming_packet_addr ? " incoming packet address;" : "",
2245 /* Non-mobile peers try addresses until one is plausible. The
2246 * effect is that this code always tries first the configured
2247 * address if supplied, or otherwise the address of the incoming
2248 * PROD, or finally the existing data peer if one exists; this is
2251 transport_peers_copy(st,&st->setup_peers,&st->peers);
2252 transport_peers_expire(st,&st->setup_peers);
2254 if (incoming_packet_addr)
2255 transport_record_peers(st,&st->setup_peers,
2256 incoming_packet_addr,1, "incoming");
2258 if (n_configured_addrs)
2259 transport_record_peers(st,&st->setup_peers,
2260 configured_addrs,n_configured_addrs, "setupinit");
2262 assert(transport_peers_valid(&st->setup_peers));
2266 static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
2267 if (st->peer_mobile)
2268 transport_expire_record_peers(st,&st->setup_peers,a,1,"setupmsg");
2270 static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
2271 if (st->peer_mobile)
2272 transport_expire_record_peers(st,&st->peers,a,1,"datamsg");
2275 static int transport_peers_valid(transport_peers *peers) {
2276 return peers->npeers;
2278 static void transport_peers_clear(struct site *st, transport_peers *peers) {
2280 transport_peers_debug(st,peers,"clear",0,0,0);
2282 static void transport_peers_copy(struct site *st, transport_peers *dst,
2283 const transport_peers *src) {
2284 dst->npeers=src->npeers;
2285 COPY_ARRAY(dst->peers, src->peers, dst->npeers);
2286 transport_peers_debug(st,dst,"copy",
2287 src->npeers, &src->peers->addr, sizeof(*src->peers));
2290 static void transport_resolve_complete(struct site *st,
2291 const struct comm_addr *addrs,
2293 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2295 transport_expire_record_peers(st,&st->setup_peers,addrs,naddrs,
2299 static void transport_resolve_complete_tardy(struct site *st,
2300 const struct comm_addr *addrs,
2302 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2303 "resolved tardily");
2306 static void transport_peers__copy_by_mask(transport_peer *out, int *nout_io,
2308 const transport_peers *inp) {
2309 /* out and in->peers may be the same region, or nonoverlapping */
2310 const transport_peer *in=inp->peers;
2312 for (slot=0; slot<inp->npeers; slot++) {
2313 if (!(mask & (1U << slot)))
2315 if (!(out==in && slot==*nout_io))
2316 COPY_OBJ(out[*nout_io], in[slot]);
2321 void transport_xmit(struct site *st, transport_peers *peers,
2322 struct buffer_if *buf, bool_t candebug) {
2324 transport_peers_expire(st, peers);
2325 unsigned failed=0; /* bitmask */
2326 assert(MAX_PEER_ADDRS < sizeof(unsigned)*CHAR_BIT);
2329 for (slot=0; slot<peers->npeers; slot++) {
2330 transport_peer *peer=&peers->peers[slot];
2332 dump_packet(st, buf, &peer->addr, False);
2334 peer->addr.comm->sendmsg(peer->addr.comm->st, buf, &peer->addr);
2336 failed |= 1U << slot;
2339 if (ok && !st->peer_mobile)
2342 /* Now we need to demote/delete failing addrs: if we are mobile we
2343 * merely demote them; otherwise we delete them. */
2344 if (st->local_mobile) {
2345 unsigned expected = ((1U << nfailed)-1) << (peers->npeers-nfailed);
2346 /* `expected' has all the failures at the end already */
2347 if (failed != expected) {
2349 transport_peer failedpeers[nfailed];
2350 transport_peers__copy_by_mask(failedpeers, &fslot, failed,peers);
2351 assert(fslot == nfailed);
2353 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2354 assert(wslot+nfailed == peers->npeers);
2355 COPY_ARRAY(peers->peers+wslot, failedpeers, nfailed);
2358 if (failed && peers->npeers > 1) {
2360 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2361 peers->npeers=wslot;
2366 /***** END of transport peers declarations *****/