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) */
45 /* Each site can be in one of several possible states. */
48 SITE_STOP - nothing is allowed to happen; tunnel is down;
49 all session keys have been erased
50 -> SITE_RUN upon external instruction
51 SITE_RUN - site up, maybe with valid key
52 -> SITE_RESOLVE upon outgoing packet and no valid key
53 we start name resolution for the other end of the tunnel
54 -> SITE_SENTMSG2 upon valid incoming message 1 and suitable time
55 we send an appropriate message 2
56 SITE_RESOLVE - waiting for name resolution
57 -> SITE_SENTMSG1 upon successful resolution
58 we send an appropriate message 1
59 -> SITE_SENTMSG2 upon valid incoming message 1 (then abort resolution)
60 we abort resolution and
61 -> SITE_WAIT on timeout or resolution failure
63 -> SITE_SENTMSG2 upon valid incoming message 1 from higher priority end
64 -> SITE_SENTMSG3 upon valid incoming message 2
65 -> SITE_WAIT on timeout
67 -> SITE_SENTMSG4 upon valid incoming message 3
68 -> SITE_WAIT on timeout
70 -> SITE_SENTMSG5 upon valid incoming message 4
71 -> SITE_WAIT on timeout
73 -> SITE_RUN upon valid incoming message 5
74 -> SITE_WAIT on timeout
76 -> SITE_RUN upon valid incoming message 6
77 -> SITE_WAIT on timeout
78 SITE_WAIT - failed to establish key; do nothing for a while
79 -> SITE_RUN on timeout
84 #define SITE_RESOLVE 2
85 #define SITE_SENTMSG1 3
86 #define SITE_SENTMSG2 4
87 #define SITE_SENTMSG3 5
88 #define SITE_SENTMSG4 6
89 #define SITE_SENTMSG5 7
92 int32_t site_max_start_pad = 4*4;
94 static cstring_t state_name(uint32_t state)
97 case 0: return "STOP";
99 case 2: return "RESOLVE";
100 case 3: return "SENTMSG1";
101 case 4: return "SENTMSG2";
102 case 5: return "SENTMSG3";
103 case 6: return "SENTMSG4";
104 case 7: return "SENTMSG5";
105 case 8: return "WAIT";
106 default: return "*bad state*";
112 #define LOG_UNEXPECTED 0x00000001
113 #define LOG_SETUP_INIT 0x00000002
114 #define LOG_SETUP_TIMEOUT 0x00000004
115 #define LOG_ACTIVATE_KEY 0x00000008
116 #define LOG_TIMEOUT_KEY 0x00000010
117 #define LOG_SEC 0x00000020
118 #define LOG_STATE 0x00000040
119 #define LOG_DROP 0x00000080
120 #define LOG_DUMP 0x00000100
121 #define LOG_ERROR 0x00000400
122 #define LOG_PEER_ADDRS 0x00000800
124 static struct flagstr log_event_table[]={
125 { "unexpected", LOG_UNEXPECTED },
126 { "setup-init", LOG_SETUP_INIT },
127 { "setup-timeout", LOG_SETUP_TIMEOUT },
128 { "activate-key", LOG_ACTIVATE_KEY },
129 { "timeout-key", LOG_TIMEOUT_KEY },
130 { "security", LOG_SEC },
131 { "state-change", LOG_STATE },
132 { "packet-drop", LOG_DROP },
133 { "dump-packets", LOG_DUMP },
134 { "errors", LOG_ERROR },
135 { "peer-addrs", LOG_PEER_ADDRS },
136 { "default", LOG_SETUP_INIT|LOG_SETUP_TIMEOUT|
137 LOG_ACTIVATE_KEY|LOG_TIMEOUT_KEY|LOG_SEC|LOG_ERROR },
138 { "all", 0xffffffff },
143 /***** TRANSPORT PEERS declarations *****/
145 /* Details of "mobile peer" semantics:
147 | Note: this comment is wishful thinking right now. It will be
148 | implemented in subsequent commits.
150 - We use the same data structure for the different configurations,
151 but manage it with different algorithms.
153 - We record up to mobile_peers_max peer address/port numbers
154 ("peers") for key setup, and separately up to mobile_peers_max
157 - In general, we make a new set of addrs (see below) when we start
158 a new key exchange; the key setup addrs become the data transport
159 addrs when key setup complets.
161 If our peer is mobile:
163 - We send to all recent addresses of incoming packets, plus
164 initially all configured addresses (which we also expire).
166 - So, we record addrs of good incoming packets, as follows:
167 1. expire any peers last seen >120s ("mobile-peer-expiry") ago
168 2. add the peer of the just received packet to the applicable list
169 (possibly evicting the oldest entries to make room)
170 NB that we do not expire peers until an incoming packet arrives.
172 - If the peer has a configured address or name, we record them the
173 same way, but only as a result of our own initiation of key
174 setup. (We might evict some incoming packet addrs to make room.)
176 - The default number of addrs to keep is 3, or 4 if we have a
177 configured name or address. That's space for two configured
178 addresses (one IPv6 and one IPv4), plus two received addresses.
180 - Outgoing packets are sent to every recorded address in the
181 applicable list. Any unsupported[1] addresses are deleted from
182 the list right away. (This should only happen to configured
183 addresses, of course, but there is no need to check that.)
185 - When we successfully complete a key setup, we merge the key setup
186 peers into the data transfer peers.
188 [1] An unsupported address is one for whose AF we don't have a
189 socket (perhaps because we got EAFNOSUPPORT or some such) or for
190 which sendto gives ENETUNREACH.
192 If neither end is mobile:
194 - When peer initiated the key exchange, we use the incoming packet
197 - When we initiate the key exchange, we try configured addresses
198 until we get one which isn't unsupported then fixate on that.
200 - When we complete a key setup, we replace the data transport peers
201 with those from the key setup.
205 - We can't tell when local network setup changes so we can't cache
206 the unsupported addrs and completely remove the spurious calls to
207 sendto, but we can optimise things a bit by deprioritising addrs
208 which seem to be unsupported.
210 - Use only configured addresses. (Except, that if our peer
211 initiated a key exchange we use the incoming packet address until
212 our name resolution completes.)
214 - When we send a packet, try each address in turn; if addr
215 supported, put that address to the end of the list for future
216 packets, and go onto the next address.
218 - When we complete a key setup, we replace the data transport peers
219 with those from the key setup.
223 #define MAX_MOBILE_PEERS_MAX MAX_PEER_ADDRS /* send at most this many copies */
227 struct comm_addr addr;
231 /* configuration information */
232 /* runtime information */
234 transport_peer peers[MAX_MOBILE_PEERS_MAX];
237 /* Basic operations on transport peer address sets */
238 static void transport_peers_clear(struct site *st, transport_peers *peers);
239 static int transport_peers_valid(transport_peers *peers);
240 static void transport_peers_copy(struct site *st, transport_peers *dst,
241 const transport_peers *src);
243 /* Record address of incoming setup packet; resp. data packet. */
244 static void transport_setup_msgok(struct site *st, const struct comm_addr *a);
245 static void transport_data_msgok(struct site *st, const struct comm_addr *a);
247 /* Initialise the setup addresses. Called before we send the first
248 * packet in a key exchange. If we are the initiator, as a result of
249 * resolve completing (or being determined not to be relevant) or an
250 * incoming PROD; if we are the responder, as a result of the MSG1. */
251 static bool_t transport_compute_setupinit_peers(struct site *st,
252 const struct comm_addr *configured_addrs /* 0 if none or not found */,
253 int n_configured_addrs /* 0 if none or not found */,
254 const struct comm_addr *incoming_packet_addr /* 0 if none */);
256 /* Called if we are the responder in a key setup, when the resolve
257 * completes. transport_compute_setupinit_peers will hvae been called
258 * earlier. If _complete is called, we are still doing the key setup
259 * (and we should use the new values for both the rest of the key
260 * setup and the ongoing data exchange); if _tardy is called, the key
261 * setup is done (either completed or not) and only the data peers are
263 static void transport_resolve_complete(struct site *st,
264 const struct comm_addr *addrs, int naddrs);
265 static void transport_resolve_complete_tardy(struct site *st,
266 const struct comm_addr *addrs, int naddrs);
268 static void transport_xmit(struct site *st, transport_peers *peers,
269 struct buffer_if *buf, bool_t candebug);
271 /***** END of transport peers declarations *****/
275 struct transform_inst_if *transform;
276 uint64_t key_timeout; /* End of life of current key */
277 uint32_t remote_session_id;
283 /* configuration information */
286 bool_t local_mobile, peer_mobile; /* Mobile client support */
287 int32_t transport_peers_max;
288 string_t tunname; /* localname<->remotename by default, used in logs */
289 string_t address; /* DNS name for bootstrapping, optional */
290 int remoteport; /* Port for bootstrapping, optional */
292 struct netlink_if *netlink;
293 struct comm_if **comms;
295 struct resolver_if *resolver;
297 struct random_if *random;
298 struct rsaprivkey_if *privkey;
299 struct rsapubkey_if *pubkey;
300 struct transform_if **transforms;
303 struct hash_if *hash;
305 uint32_t index; /* Index of this site */
306 uint32_t local_capabilities;
307 int32_t setup_retries; /* How many times to send setup packets */
308 int32_t setup_retry_interval; /* Initial timeout for setup packets */
309 int32_t wait_timeout; /* How long to wait if setup unsuccessful */
310 int32_t mobile_peer_expiry; /* How long to remember 2ary addresses */
311 int32_t key_lifetime; /* How long a key lasts once set up */
312 int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
313 after this time, initiate a new
316 bool_t setup_priority; /* Do we have precedence if both sites emit
317 message 1 simultaneously? */
320 /* runtime information */
322 uint64_t now; /* Most recently seen time */
323 bool_t allow_send_prod;
326 /* The currently established session */
327 struct data_key current;
328 struct data_key auxiliary_key;
329 bool_t auxiliary_is_new;
330 uint64_t renegotiate_key_time; /* When we can negotiate a new key */
331 uint64_t auxiliary_renegotiate_key_time;
332 transport_peers peers; /* Current address(es) of peer for data traffic */
334 /* The current key setup protocol exchange. We can only be
335 involved in one of these at a time. There's a potential for
336 denial of service here (the attacker keeps sending a setup
337 packet; we keep trying to continue the exchange, and have to
338 timeout before we can listen for another setup packet); perhaps
339 we should keep a list of 'bad' sources for setup packets. */
340 uint32_t remote_capabilities;
341 uint16_t remote_adv_mtu;
342 struct transform_if *chosen_transform;
343 uint32_t setup_session_id;
344 transport_peers setup_peers;
345 uint8_t localN[NONCELEN]; /* Nonces for key exchange */
346 uint8_t remoteN[NONCELEN];
347 struct buffer_if buffer; /* Current outgoing key exchange packet */
348 struct buffer_if scratch;
349 int32_t retries; /* Number of retries remaining */
350 uint64_t timeout; /* Timeout for current state */
352 uint8_t *sharedsecret;
353 uint32_t sharedsecretlen, sharedsecretallocd;
354 struct transform_inst_if *new_transform; /* For key setup/verify */
357 static uint32_t event_log_priority(struct site *st, uint32_t event)
359 if (!(event&st->log_events))
362 case LOG_UNEXPECTED: return M_INFO;
363 case LOG_SETUP_INIT: return M_INFO;
364 case LOG_SETUP_TIMEOUT: return M_NOTICE;
365 case LOG_ACTIVATE_KEY: return M_INFO;
366 case LOG_TIMEOUT_KEY: return M_INFO;
367 case LOG_SEC: return M_SECURITY;
368 case LOG_STATE: return M_DEBUG;
369 case LOG_DROP: return M_DEBUG;
370 case LOG_DUMP: return M_DEBUG;
371 case LOG_ERROR: return M_ERR;
372 case LOG_PEER_ADDRS: return M_DEBUG;
373 default: return M_ERR;
377 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
379 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
383 class=event_log_priority(st, event);
385 slilog_part(st->log,class,"%s: ",st->tunname);
386 vslilog_part(st->log,class,msg,ap);
387 slilog_part(st->log,class,"\n");
391 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
393 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
397 vslog(st,event,msg,ap);
401 static void logtimeout(struct site *st, const char *fmt, ...)
403 static void logtimeout(struct site *st, const char *fmt, ...)
405 uint32_t class=event_log_priority(st,LOG_SETUP_TIMEOUT);
412 slilog_part(st->log,class,"%s: ",st->tunname);
413 vslilog_part(st->log,class,fmt,ap);
417 for (i=0, delim=" (tried ";
418 i<st->setup_peers.npeers;
420 transport_peer *peer=&st->setup_peers.peers[i];
421 const char *s=comm_addr_to_string(&peer->addr);
422 slilog_part(st->log,class,"%s%s",delim,s);
425 slilog_part(st->log,class,")\n");
429 static void set_link_quality(struct site *st);
430 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel);
431 static void delete_one_key(struct site *st, struct data_key *key,
432 const char *reason /* may be 0 meaning don't log*/,
433 const char *which /* ignored if !reasonn */,
434 uint32_t loglevel /* ignored if !reasonn */);
435 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
436 const struct comm_addr *prod_hint);
437 static void enter_state_run(struct site *st);
438 static bool_t enter_state_resolve(struct site *st);
439 static bool_t enter_new_state(struct site *st,uint32_t next);
440 static void enter_state_wait(struct site *st);
441 static void activate_new_key(struct site *st);
443 static bool_t is_transform_valid(struct transform_inst_if *transform)
445 return transform && transform->valid(transform->st);
448 static bool_t current_valid(struct site *st)
450 return is_transform_valid(st->current.transform);
453 #define DEFINE_CALL_TRANSFORM(fwdrev) \
454 static int call_transform_##fwdrev(struct site *st, \
455 struct transform_inst_if *transform, \
456 struct buffer_if *buf, \
457 const char **errmsg) \
459 if (!is_transform_valid(transform)) { \
460 *errmsg="transform not set up"; \
463 return transform->fwdrev(transform->st,buf,errmsg); \
466 DEFINE_CALL_TRANSFORM(forwards)
467 DEFINE_CALL_TRANSFORM(reverse)
469 static void dispose_transform(struct transform_inst_if **transform_var)
471 struct transform_inst_if *transform=*transform_var;
473 transform->delkey(transform->st);
474 transform->destroy(transform->st);
479 #define CHECK_AVAIL(b,l) do { if ((b)->size<(l)) return False; } while(0)
480 #define CHECK_EMPTY(b) do { if ((b)->size!=0) return False; } while(0)
481 #define CHECK_TYPE(b,t) do { uint32_t type; \
482 CHECK_AVAIL((b),4); \
483 type=buf_unprepend_uint32((b)); \
484 if (type!=(t)) return False; } while(0)
486 static _Bool type_is_msg34(uint32_t type)
489 type == LABEL_MSG3 ||
490 type == LABEL_MSG3BIS ||
497 struct buffer_if extrainfo;
504 struct parsedname remote;
505 struct parsedname local;
506 uint32_t remote_capabilities;
508 int capab_transformnum;
518 static void set_new_transform(struct site *st, char *pk)
520 /* Make room for the shared key */
521 st->sharedsecretlen=st->chosen_transform->keylen?:st->dh->ceil_len;
522 assert(st->sharedsecretlen);
523 if (st->sharedsecretlen > st->sharedsecretallocd) {
524 st->sharedsecretallocd=st->sharedsecretlen;
525 st->sharedsecret=realloc(st->sharedsecret,st->sharedsecretallocd);
527 if (!st->sharedsecret) fatal_perror("site:sharedsecret");
529 /* Generate the shared key */
530 st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,pk,
531 st->sharedsecret,st->sharedsecretlen);
533 /* Set up the transform */
534 struct transform_if *generator=st->chosen_transform;
535 struct transform_inst_if *generated=generator->create(generator->st);
536 generated->setkey(generated->st,st->sharedsecret,
537 st->sharedsecretlen,st->setup_priority);
538 dispose_transform(&st->new_transform);
539 st->new_transform=generated;
541 slog(st,LOG_SETUP_INIT,"key exchange negotiated transform"
542 " %d (capabilities ours=%#"PRIx32" theirs=%#"PRIx32")",
543 st->chosen_transform->capab_transformnum,
544 st->local_capabilities, st->remote_capabilities);
548 int32_t lenpos, afternul;
550 static void append_string_xinfo_start(struct buffer_if *buf,
551 struct xinfoadd *xia,
553 /* Helps construct one of the names with additional info as found
554 * in MSG1..4. Call this function first, then append all the
555 * desired extra info (not including the nul byte) to the buffer,
556 * then call append_string_xinfo_done. */
558 xia->lenpos = buf->size;
559 buf_append_string(buf,str);
560 buf_append_uint8(buf,0);
561 xia->afternul = buf->size;
563 static void append_string_xinfo_done(struct buffer_if *buf,
564 struct xinfoadd *xia)
566 /* we just need to adjust the string length */
567 if (buf->size == xia->afternul) {
568 /* no extra info, strip the nul too */
569 buf_unappend_uint8(buf);
571 put_uint16(buf->start+xia->lenpos, buf->size-(xia->lenpos+2));
575 /* Build any of msg1 to msg4. msg5 and msg6 are built from the inside
576 out using a transform of config data supplied by netlink */
577 static bool_t generate_msg(struct site *st, uint32_t type, cstring_t what)
583 st->retries=st->setup_retries;
584 BUF_ALLOC(&st->buffer,what);
585 buffer_init(&st->buffer,0);
586 buf_append_uint32(&st->buffer,
587 (type==LABEL_MSG1?0:st->setup_session_id));
588 buf_append_uint32(&st->buffer,st->index);
589 buf_append_uint32(&st->buffer,type);
592 append_string_xinfo_start(&st->buffer,&xia,st->localname);
593 if ((st->local_capabilities & CAPAB_EARLY) || (type != LABEL_MSG1)) {
594 buf_append_uint32(&st->buffer,st->local_capabilities);
596 if (type_is_msg34(type)) {
597 buf_append_uint16(&st->buffer,st->mtu_target);
599 append_string_xinfo_done(&st->buffer,&xia);
601 buf_append_string(&st->buffer,st->remotename);
602 BUF_ADD_OBJ(append,&st->buffer,st->localN);
603 if (type==LABEL_MSG1) return True;
604 BUF_ADD_OBJ(append,&st->buffer,st->remoteN);
605 if (type==LABEL_MSG2) return True;
607 if (hacky_par_mid_failnow()) return False;
609 if (type==LABEL_MSG3BIS)
610 buf_append_uint8(&st->buffer,st->chosen_transform->capab_transformnum);
612 dhpub=st->dh->makepublic(st->dh->st,st->dhsecret,st->dh->len);
613 buf_append_string(&st->buffer,dhpub);
615 hash=safe_malloc(st->hash->len, "generate_msg");
616 hst=st->hash->init();
617 st->hash->update(hst,st->buffer.start,st->buffer.size);
618 st->hash->final(hst,hash);
619 sig=st->privkey->sign(st->privkey->st,hash,st->hash->len);
620 buf_append_string(&st->buffer,sig);
626 static bool_t unpick_name(struct buffer_if *msg, struct parsedname *nm)
629 nm->len=buf_unprepend_uint16(msg);
630 CHECK_AVAIL(msg,nm->len);
631 nm->name=buf_unprepend(msg,nm->len);
632 uint8_t *nul=memchr(nm->name,0,nm->len);
634 buffer_readonly_view(&nm->extrainfo,0,0);
636 buffer_readonly_view(&nm->extrainfo, nul+1, msg->start-(nul+1));
637 nm->len=nul-nm->name;
642 static bool_t unpick_msg(struct site *st, uint32_t type,
643 struct buffer_if *msg, struct msg *m)
645 m->capab_transformnum=-1;
646 m->hashstart=msg->start;
648 m->dest=buf_unprepend_uint32(msg);
650 m->source=buf_unprepend_uint32(msg);
651 CHECK_TYPE(msg,type);
652 if (!unpick_name(msg,&m->remote)) return False;
653 m->remote_capabilities=0;
655 if (m->remote.extrainfo.size) {
656 CHECK_AVAIL(&m->remote.extrainfo,4);
657 m->remote_capabilities=buf_unprepend_uint32(&m->remote.extrainfo);
659 if (type_is_msg34(type) && m->remote.extrainfo.size) {
660 CHECK_AVAIL(&m->remote.extrainfo,2);
661 m->remote_mtu=buf_unprepend_uint16(&m->remote.extrainfo);
663 if (!unpick_name(msg,&m->local)) return False;
664 if (type==LABEL_PROD) {
668 CHECK_AVAIL(msg,NONCELEN);
669 m->nR=buf_unprepend(msg,NONCELEN);
670 if (type==LABEL_MSG1) {
674 CHECK_AVAIL(msg,NONCELEN);
675 m->nL=buf_unprepend(msg,NONCELEN);
676 if (type==LABEL_MSG2) {
680 if (type==LABEL_MSG3BIS) {
682 m->capab_transformnum = buf_unprepend_uint8(msg);
684 m->capab_transformnum = CAPAB_TRANSFORMNUM_ANCIENT;
687 m->pklen=buf_unprepend_uint16(msg);
688 CHECK_AVAIL(msg,m->pklen);
689 m->pk=buf_unprepend(msg,m->pklen);
690 m->hashlen=msg->start-m->hashstart;
692 m->siglen=buf_unprepend_uint16(msg);
693 CHECK_AVAIL(msg,m->siglen);
694 m->sig=buf_unprepend(msg,m->siglen);
699 static bool_t name_matches(const struct parsedname *nm, const char *expected)
701 int expected_len=strlen(expected);
703 nm->len == expected_len &&
704 !memcmp(nm->name, expected, expected_len);
707 static bool_t check_msg(struct site *st, uint32_t type, struct msg *m,
710 if (type==LABEL_MSG1) return True;
712 /* Check that the site names and our nonce have been sent
713 back correctly, and then store our peer's nonce. */
714 if (!name_matches(&m->remote,st->remotename)) {
715 *error="wrong remote site name";
718 if (!name_matches(&m->local,st->localname)) {
719 *error="wrong local site name";
722 if (memcmp(m->nL,st->localN,NONCELEN)!=0) {
723 *error="wrong locally-generated nonce";
726 if (type==LABEL_MSG2) return True;
727 if (!consttime_memeq(m->nR,st->remoteN,NONCELEN)!=0) {
728 *error="wrong remotely-generated nonce";
731 /* MSG3 has complicated rules about capabilities, which are
732 * handled in process_msg3. */
733 if (type==LABEL_MSG3 || type==LABEL_MSG3BIS) return True;
734 if (m->remote_capabilities!=st->remote_capabilities) {
735 *error="remote capabilities changed";
738 if (type==LABEL_MSG4) return True;
739 *error="unknown message type";
743 static bool_t generate_msg1(struct site *st)
745 st->random->generate(st->random->st,NONCELEN,st->localN);
746 return generate_msg(st,LABEL_MSG1,"site:MSG1");
749 static bool_t process_msg1(struct site *st, struct buffer_if *msg1,
750 const struct comm_addr *src, struct msg *m)
752 /* We've already determined we're in an appropriate state to
753 process an incoming MSG1, and that the MSG1 has correct values
756 st->setup_session_id=m->source;
757 st->remote_capabilities=m->remote_capabilities;
758 memcpy(st->remoteN,m->nR,NONCELEN);
762 static bool_t generate_msg2(struct site *st)
764 st->random->generate(st->random->st,NONCELEN,st->localN);
765 return generate_msg(st,LABEL_MSG2,"site:MSG2");
768 static bool_t process_msg2(struct site *st, struct buffer_if *msg2,
769 const struct comm_addr *src)
774 if (!unpick_msg(st,LABEL_MSG2,msg2,&m)) return False;
775 if (!check_msg(st,LABEL_MSG2,&m,&err)) {
776 slog(st,LOG_SEC,"msg2: %s",err);
779 st->setup_session_id=m.source;
780 st->remote_capabilities=m.remote_capabilities;
782 /* Select the transform to use */
784 uint32_t remote_transforms = st->remote_capabilities & CAPAB_TRANSFORM_MASK;
785 if (!remote_transforms)
786 /* old secnets only had this one transform */
787 remote_transforms = 1UL << CAPAB_TRANSFORMNUM_ANCIENT;
789 struct transform_if *ti;
791 for (i=0; i<st->ntransforms; i++) {
792 ti=st->transforms[i];
793 if ((1UL << ti->capab_transformnum) & remote_transforms)
794 goto transform_found;
796 slog(st,LOG_ERROR,"no transforms in common"
797 " (us %#"PRIx32"; them: %#"PRIx32")",
798 st->local_capabilities & CAPAB_TRANSFORM_MASK,
802 st->chosen_transform=ti;
804 memcpy(st->remoteN,m.nR,NONCELEN);
808 static bool_t generate_msg3(struct site *st)
810 /* Now we have our nonce and their nonce. Think of a secret key,
811 and create message number 3. */
812 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
813 return generate_msg(st,
814 (st->remote_capabilities & CAPAB_TRANSFORM_MASK
815 ? LABEL_MSG3BIS : LABEL_MSG3),
819 static bool_t process_msg3_msg4(struct site *st, struct msg *m)
824 /* Check signature and store g^x mod m */
825 hash=safe_malloc(st->hash->len, "process_msg3_msg4");
826 hst=st->hash->init();
827 st->hash->update(hst,m->hashstart,m->hashlen);
828 st->hash->final(hst,hash);
829 /* Terminate signature with a '0' - cheating, but should be ok */
831 if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m->sig)) {
832 slog(st,LOG_SEC,"msg3/msg4 signature failed check!");
838 st->remote_adv_mtu=m->remote_mtu;
843 static bool_t process_msg3(struct site *st, struct buffer_if *msg3,
844 const struct comm_addr *src, uint32_t msgtype)
849 assert(msgtype==LABEL_MSG3 || msgtype==LABEL_MSG3BIS);
851 if (!unpick_msg(st,msgtype,msg3,&m)) return False;
852 if (!check_msg(st,msgtype,&m,&err)) {
853 slog(st,LOG_SEC,"msg3: %s",err);
856 uint32_t capab_adv_late = m.remote_capabilities
857 & ~st->remote_capabilities & CAPAB_EARLY;
858 if (capab_adv_late) {
859 slog(st,LOG_SEC,"msg3 impermissibly adds early capability flag(s)"
860 " %#"PRIx32" (was %#"PRIx32", now %#"PRIx32")",
861 capab_adv_late, st->remote_capabilities, m.remote_capabilities);
864 st->remote_capabilities|=m.remote_capabilities;
866 struct transform_if *ti;
868 for (i=0; i<st->ntransforms; i++) {
869 ti=st->transforms[i];
870 if (ti->capab_transformnum == m.capab_transformnum)
871 goto transform_found;
873 slog(st,LOG_SEC,"peer chose unknown-to-us transform %d!",
874 m.capab_transformnum);
877 st->chosen_transform=ti;
879 if (!process_msg3_msg4(st,&m))
882 /* Terminate their DH public key with a '0' */
884 /* Invent our DH secret key */
885 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
887 /* Generate the shared key and set up the transform */
888 set_new_transform(st,m.pk);
893 static bool_t generate_msg4(struct site *st)
895 /* We have both nonces, their public key and our private key. Generate
896 our public key, sign it and send it to them. */
897 return generate_msg(st,LABEL_MSG4,"site:MSG4");
900 static bool_t process_msg4(struct site *st, struct buffer_if *msg4,
901 const struct comm_addr *src)
906 if (!unpick_msg(st,LABEL_MSG4,msg4,&m)) return False;
907 if (!check_msg(st,LABEL_MSG4,&m,&err)) {
908 slog(st,LOG_SEC,"msg4: %s",err);
912 if (!process_msg3_msg4(st,&m))
915 /* Terminate their DH public key with a '0' */
918 /* Generate the shared key and set up the transform */
919 set_new_transform(st,m.pk);
930 static bool_t unpick_msg0(struct site *st, struct buffer_if *msg0,
934 m->dest=buf_unprepend_uint32(msg0);
936 m->source=buf_unprepend_uint32(msg0);
938 m->type=buf_unprepend_uint32(msg0);
940 /* Leaves transformed part of buffer untouched */
943 static bool_t generate_msg5(struct site *st)
945 cstring_t transform_err;
947 BUF_ALLOC(&st->buffer,"site:MSG5");
948 /* We are going to add four words to the message */
949 buffer_init(&st->buffer,calculate_max_start_pad());
950 /* Give the netlink code an opportunity to put its own stuff in the
951 message (configuration information, etc.) */
952 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
953 if (call_transform_forwards(st,st->new_transform,
954 &st->buffer,&transform_err))
956 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
957 buf_prepend_uint32(&st->buffer,st->index);
958 buf_prepend_uint32(&st->buffer,st->setup_session_id);
960 st->retries=st->setup_retries;
964 static bool_t process_msg5(struct site *st, struct buffer_if *msg5,
965 const struct comm_addr *src,
966 struct transform_inst_if *transform)
969 cstring_t transform_err;
971 if (!unpick_msg0(st,msg5,&m)) return False;
973 if (call_transform_reverse(st,transform,msg5,&transform_err)) {
974 /* There's a problem */
975 slog(st,LOG_SEC,"process_msg5: transform: %s",transform_err);
978 /* Buffer should now contain untransformed PING packet data */
980 if (buf_unprepend_uint32(msg5)!=LABEL_MSG5) {
981 slog(st,LOG_SEC,"MSG5/PING packet contained wrong label");
984 /* Older versions of secnet used to write some config data here
985 * which we ignore. So we don't CHECK_EMPTY */
989 static void create_msg6(struct site *st, struct transform_inst_if *transform,
992 cstring_t transform_err;
994 BUF_ALLOC(&st->buffer,"site:MSG6");
995 /* We are going to add four words to the message */
996 buffer_init(&st->buffer,calculate_max_start_pad());
997 /* Give the netlink code an opportunity to put its own stuff in the
998 message (configuration information, etc.) */
999 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1000 int problem = call_transform_forwards(st,transform,
1001 &st->buffer,&transform_err);
1003 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1004 buf_prepend_uint32(&st->buffer,st->index);
1005 buf_prepend_uint32(&st->buffer,session_id);
1008 static bool_t generate_msg6(struct site *st)
1010 if (!is_transform_valid(st->new_transform))
1012 create_msg6(st,st->new_transform,st->setup_session_id);
1013 st->retries=1; /* Peer will retransmit MSG5 if this packet gets lost */
1017 static bool_t process_msg6(struct site *st, struct buffer_if *msg6,
1018 const struct comm_addr *src)
1021 cstring_t transform_err;
1023 if (!unpick_msg0(st,msg6,&m)) return False;
1025 if (call_transform_reverse(st,st->new_transform,msg6,&transform_err)) {
1026 /* There's a problem */
1027 slog(st,LOG_SEC,"process_msg6: transform: %s",transform_err);
1030 /* Buffer should now contain untransformed PING packet data */
1031 CHECK_AVAIL(msg6,4);
1032 if (buf_unprepend_uint32(msg6)!=LABEL_MSG6) {
1033 slog(st,LOG_SEC,"MSG6/PONG packet contained invalid data");
1036 /* Older versions of secnet used to write some config data here
1037 * which we ignore. So we don't CHECK_EMPTY */
1041 static bool_t decrypt_msg0(struct site *st, struct buffer_if *msg0,
1042 const struct comm_addr *src)
1044 cstring_t transform_err, auxkey_err, newkey_err="n/a";
1048 if (!unpick_msg0(st,msg0,&m)) return False;
1050 /* Keep a copy so we can try decrypting it with multiple keys */
1051 buffer_copy(&st->scratch, msg0);
1053 problem = call_transform_reverse(st,st->current.transform,
1054 msg0,&transform_err);
1056 if (!st->auxiliary_is_new)
1057 delete_one_key(st,&st->auxiliary_key,
1058 "peer has used new key","auxiliary key",LOG_SEC);
1064 buffer_copy(msg0, &st->scratch);
1065 problem = call_transform_reverse(st,st->auxiliary_key.transform,
1068 slog(st,LOG_DROP,"processing packet which uses auxiliary key");
1069 if (st->auxiliary_is_new) {
1070 /* We previously timed out in state SENTMSG5 but it turns
1071 * out that our peer did in fact get our MSG5 and is
1072 * using the new key. So we should switch to it too. */
1073 /* This is a bit like activate_new_key. */
1076 st->current=st->auxiliary_key;
1077 st->auxiliary_key=t;
1079 delete_one_key(st,&st->auxiliary_key,"peer has used new key",
1080 "previous key",LOG_SEC);
1081 st->auxiliary_is_new=0;
1082 st->renegotiate_key_time=st->auxiliary_renegotiate_key_time;
1089 if (st->state==SITE_SENTMSG5) {
1090 buffer_copy(msg0, &st->scratch);
1091 problem = call_transform_reverse(st,st->new_transform,
1094 /* It looks like we didn't get the peer's MSG6 */
1095 /* This is like a cut-down enter_new_state(SITE_RUN) */
1096 slog(st,LOG_STATE,"will enter state RUN (MSG0 with new key)");
1097 BUF_FREE(&st->buffer);
1099 activate_new_key(st);
1100 return True; /* do process the data in this packet */
1106 slog(st,LOG_SEC,"transform: %s (aux: %s, new: %s)",
1107 transform_err,auxkey_err,newkey_err);
1108 initiate_key_setup(st,"incoming message would not decrypt",0);
1109 send_nak(src,m.dest,m.source,m.type,msg0,"message would not decrypt");
1113 slog(st,LOG_DROP,"transform: %s (merely skew)",transform_err);
1117 static bool_t process_msg0(struct site *st, struct buffer_if *msg0,
1118 const struct comm_addr *src)
1122 if (!decrypt_msg0(st,msg0,src))
1125 CHECK_AVAIL(msg0,4);
1126 type=buf_unprepend_uint32(msg0);
1129 /* We must forget about the current session. */
1130 delete_keys(st,"request from peer",LOG_SEC);
1133 /* Deliver to netlink layer */
1134 st->netlink->deliver(st->netlink->st,msg0);
1135 transport_data_msgok(st,src);
1136 /* See whether we should start negotiating a new key */
1137 if (st->now > st->renegotiate_key_time)
1138 initiate_key_setup(st,"incoming packet in renegotiation window",0);
1141 slog(st,LOG_SEC,"incoming encrypted message of type %08x "
1148 static void dump_packet(struct site *st, struct buffer_if *buf,
1149 const struct comm_addr *addr, bool_t incoming)
1151 uint32_t dest=get_uint32(buf->start);
1152 uint32_t source=get_uint32(buf->start+4);
1153 uint32_t msgtype=get_uint32(buf->start+8);
1155 if (st->log_events & LOG_DUMP)
1156 slilog(st->log,M_DEBUG,"%s: %s: %08x<-%08x: %08x:",
1157 st->tunname,incoming?"incoming":"outgoing",
1158 dest,source,msgtype);
1161 static uint32_t site_status(void *st)
1166 static bool_t send_msg(struct site *st)
1168 if (st->retries>0) {
1169 transport_xmit(st, &st->setup_peers, &st->buffer, True);
1170 st->timeout=st->now+st->setup_retry_interval;
1173 } else if (st->state==SITE_SENTMSG5) {
1174 logtimeout(st,"timed out sending MSG5, stashing new key");
1175 /* We stash the key we have produced, in case it turns out that
1176 * our peer did see our MSG5 after all and starts using it. */
1177 /* This is a bit like some of activate_new_key */
1178 struct transform_inst_if *t;
1179 t=st->auxiliary_key.transform;
1180 st->auxiliary_key.transform=st->new_transform;
1181 st->new_transform=t;
1182 dispose_transform(&st->new_transform);
1184 st->auxiliary_is_new=1;
1185 st->auxiliary_key.key_timeout=st->now+st->key_lifetime;
1186 st->auxiliary_renegotiate_key_time=st->now+st->key_renegotiate_time;
1187 st->auxiliary_key.remote_session_id=st->setup_session_id;
1189 enter_state_wait(st);
1192 logtimeout(st,"timed out sending key setup packet "
1193 "(in state %s)",state_name(st->state));
1194 enter_state_wait(st);
1199 static void site_resolve_callback(void *sst, const struct comm_addr *addrs,
1200 int naddrs, int was_naddrs)
1202 struct site *st=sst;
1204 st->resolving=False;
1207 slog(st,LOG_STATE,"resolution of %s completed, %d addrs, eg: %s",
1208 st->address, was_naddrs, comm_addr_to_string(&addrs[0]));;
1209 if (naddrs != was_naddrs) {
1210 slog(st,LOG_SETUP_INIT,"resolution of supplied addresses/names"
1211 " yielded too many results (%d > %d), some ignored",
1212 was_naddrs, naddrs);
1215 slog(st,LOG_ERROR,"resolution of %s failed",st->address);
1218 switch (st->state) {
1220 if (transport_compute_setupinit_peers(st,addrs,naddrs,0)) {
1221 enter_new_state(st,SITE_SENTMSG1);
1223 /* Can't figure out who to try to to talk to */
1224 slog(st,LOG_SETUP_INIT,
1225 "key exchange failed: cannot find peer address");
1226 enter_state_run(st);
1229 case SITE_SENTMSG1: case SITE_SENTMSG2:
1230 case SITE_SENTMSG3: case SITE_SENTMSG4:
1233 /* We start using the address immediately for data too.
1234 * It's best to store it in st->peers now because we might
1235 * go via SENTMSG5, WAIT, and a MSG0, straight into using
1236 * the new key (without updating the data peer addrs). */
1237 transport_resolve_complete(st,addrs,naddrs);
1238 } else if (st->local_mobile) {
1239 /* We can't let this rest because we may have a peer
1240 * address which will break in the future. */
1241 slog(st,LOG_SETUP_INIT,"resolution of %s failed: "
1242 "abandoning key exchange",st->address);
1243 enter_state_wait(st);
1245 slog(st,LOG_SETUP_INIT,"resolution of %s failed: "
1246 " continuing to use source address of peer's packets"
1247 " for key exchange and ultimately data",
1253 slog(st,LOG_SETUP_INIT,"resolution of %s completed tardily,"
1254 " updating peer address(es)",st->address);
1255 transport_resolve_complete_tardy(st,addrs,naddrs);
1256 } else if (st->local_mobile) {
1257 /* Not very good. We should queue (another) renegotiation
1258 * so that we can update the peer address. */
1259 st->key_renegotiate_time=st->now+st->wait_timeout;
1261 slog(st,LOG_SETUP_INIT,"resolution of %s failed: "
1262 " continuing to use source address of peer's packets",
1273 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
1274 const struct comm_addr *prod_hint)
1276 /* Reentrancy hazard: can call enter_new_state/enter_state_* */
1277 if (st->state!=SITE_RUN) return False;
1278 slog(st,LOG_SETUP_INIT,"initiating key exchange (%s)",reason);
1280 slog(st,LOG_SETUP_INIT,"resolving peer address");
1281 return enter_state_resolve(st);
1282 } else if (transport_compute_setupinit_peers(st,0,0,prod_hint)) {
1283 return enter_new_state(st,SITE_SENTMSG1);
1285 slog(st,LOG_SETUP_INIT,"key exchange failed: no address for peer");
1289 static void activate_new_key(struct site *st)
1291 struct transform_inst_if *t;
1293 /* We have three transform instances, which we swap between old,
1295 t=st->auxiliary_key.transform;
1296 st->auxiliary_key.transform=st->current.transform;
1297 st->current.transform=st->new_transform;
1298 st->new_transform=t;
1299 dispose_transform(&st->new_transform);
1302 st->auxiliary_is_new=0;
1303 st->auxiliary_key.key_timeout=st->current.key_timeout;
1304 st->current.key_timeout=st->now+st->key_lifetime;
1305 st->renegotiate_key_time=st->now+st->key_renegotiate_time;
1306 transport_peers_copy(st,&st->peers,&st->setup_peers);
1307 st->current.remote_session_id=st->setup_session_id;
1309 /* Compute the inter-site MTU. This is min( our_mtu, their_mtu ).
1310 * But their mtu be unspecified, in which case we just use ours. */
1311 uint32_t intersite_mtu=
1312 MIN(st->mtu_target, st->remote_adv_mtu ?: ~(uint32_t)0);
1313 st->netlink->set_mtu(st->netlink->st,intersite_mtu);
1315 slog(st,LOG_ACTIVATE_KEY,"new key activated"
1316 " (mtu ours=%"PRId32" theirs=%"PRId32" intersite=%"PRId32")",
1317 st->mtu_target, st->remote_adv_mtu, intersite_mtu);
1318 enter_state_run(st);
1321 static void delete_one_key(struct site *st, struct data_key *key,
1322 cstring_t reason, cstring_t which, uint32_t loglevel)
1324 if (!is_transform_valid(key->transform)) return;
1325 if (reason) slog(st,loglevel,"%s deleted (%s)",which,reason);
1326 dispose_transform(&key->transform);
1330 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel)
1332 if (current_valid(st)) {
1333 slog(st,loglevel,"session closed (%s)",reason);
1335 delete_one_key(st,&st->current,0,0,0);
1336 set_link_quality(st);
1338 delete_one_key(st,&st->auxiliary_key,0,0,0);
1341 static void state_assert(struct site *st, bool_t ok)
1343 if (!ok) fatal("site:state_assert");
1346 static void enter_state_stop(struct site *st)
1348 st->state=SITE_STOP;
1350 delete_keys(st,"entering state STOP",LOG_TIMEOUT_KEY);
1351 dispose_transform(&st->new_transform);
1354 static void set_link_quality(struct site *st)
1357 if (current_valid(st))
1358 quality=LINK_QUALITY_UP;
1359 else if (st->state==SITE_WAIT || st->state==SITE_STOP)
1360 quality=LINK_QUALITY_DOWN;
1361 else if (st->address)
1362 quality=LINK_QUALITY_DOWN_CURRENT_ADDRESS;
1363 else if (transport_peers_valid(&st->peers))
1364 quality=LINK_QUALITY_DOWN_STALE_ADDRESS;
1366 quality=LINK_QUALITY_DOWN;
1368 st->netlink->set_quality(st->netlink->st,quality);
1371 static void enter_state_run(struct site *st)
1373 slog(st,LOG_STATE,"entering state RUN");
1377 st->setup_session_id=0;
1378 transport_peers_clear(st,&st->setup_peers);
1379 FILLZERO(st->localN);
1380 FILLZERO(st->remoteN);
1381 dispose_transform(&st->new_transform);
1382 memset(st->dhsecret,0,st->dh->len);
1383 memset(st->sharedsecret,0,st->sharedsecretlen);
1384 set_link_quality(st);
1387 static bool_t ensure_resolving(struct site *st)
1389 /* Reentrancy hazard: may call site_resolve_callback and hence
1390 * enter_new_state, enter_state_* and generate_msg*. */
1394 assert(st->address);
1396 /* resolver->request might reentrantly call site_resolve_callback
1397 * which will clear st->resolving, so we need to set it beforehand
1398 * rather than afterwards; also, it might return False, in which
1399 * case we have to clear ->resolving again. */
1401 bool_t ok = st->resolver->request(st->resolver->st,st->address,
1402 st->remoteport,st->comms[0],
1403 site_resolve_callback,st);
1405 st->resolving=False;
1410 static bool_t enter_state_resolve(struct site *st)
1412 /* Reentrancy hazard! See ensure_resolving. */
1413 state_assert(st,st->state==SITE_RUN);
1414 slog(st,LOG_STATE,"entering state RESOLVE");
1415 st->state=SITE_RESOLVE;
1416 return ensure_resolving(st);
1419 static bool_t enter_new_state(struct site *st, uint32_t next)
1421 bool_t (*gen)(struct site *st);
1424 slog(st,LOG_STATE,"entering state %s",state_name(next));
1427 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
1431 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1432 st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
1436 state_assert(st,st->state==SITE_SENTMSG1);
1437 BUF_FREE(&st->buffer);
1441 state_assert(st,st->state==SITE_SENTMSG2);
1442 BUF_FREE(&st->buffer);
1446 state_assert(st,st->state==SITE_SENTMSG3);
1447 BUF_FREE(&st->buffer);
1451 state_assert(st,st->state==SITE_SENTMSG4);
1452 BUF_FREE(&st->buffer);
1457 fatal("enter_new_state(%s): invalid new state",state_name(next));
1461 if (hacky_par_start_failnow()) return False;
1463 r= gen(st) && send_msg(st);
1466 st->setup_retries, st->setup_retry_interval,
1471 if (next==SITE_RUN) {
1472 BUF_FREE(&st->buffer); /* Never reused */
1473 st->timeout=0; /* Never retransmit */
1474 activate_new_key(st);
1478 slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1479 st->buffer.free=False; /* Unconditionally use the buffer; it may be
1480 in either state, and enter_state_wait() will
1482 enter_state_wait(st);
1486 /* msg7 tells our peer that we're about to forget our key */
1487 static bool_t send_msg7(struct site *st, cstring_t reason)
1489 cstring_t transform_err;
1491 if (current_valid(st) && st->buffer.free
1492 && transport_peers_valid(&st->peers)) {
1493 BUF_ALLOC(&st->buffer,"site:MSG7");
1494 buffer_init(&st->buffer,calculate_max_start_pad());
1495 buf_append_uint32(&st->buffer,LABEL_MSG7);
1496 buf_append_string(&st->buffer,reason);
1497 if (call_transform_forwards(st, st->current.transform,
1498 &st->buffer, &transform_err))
1500 buf_prepend_uint32(&st->buffer,LABEL_MSG0);
1501 buf_prepend_uint32(&st->buffer,st->index);
1502 buf_prepend_uint32(&st->buffer,st->current.remote_session_id);
1503 transport_xmit(st,&st->peers,&st->buffer,True);
1504 BUF_FREE(&st->buffer);
1511 /* We go into this state if our peer becomes uncommunicative. Similar to
1512 the "stop" state, we forget all session keys for a while, before
1513 re-entering the "run" state. */
1514 static void enter_state_wait(struct site *st)
1516 slog(st,LOG_STATE,"entering state WAIT");
1517 st->timeout=st->now+st->wait_timeout;
1518 st->state=SITE_WAIT;
1519 set_link_quality(st);
1520 BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1521 /* XXX Erase keys etc. */
1524 static void generate_prod(struct site *st, struct buffer_if *buf)
1527 buf_append_uint32(buf,0);
1528 buf_append_uint32(buf,0);
1529 buf_append_uint32(buf,LABEL_PROD);
1530 buf_append_string(buf,st->localname);
1531 buf_append_string(buf,st->remotename);
1534 static void generate_send_prod(struct site *st,
1535 const struct comm_addr *source)
1537 if (!st->allow_send_prod) return; /* too soon */
1538 if (!(st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1539 st->state==SITE_WAIT)) return; /* we'd ignore peer's MSG1 */
1541 slog(st,LOG_SETUP_INIT,"prodding peer for key exchange");
1542 st->allow_send_prod=0;
1543 generate_prod(st,&st->scratch);
1544 dump_packet(st,&st->scratch,source,False);
1545 source->comm->sendmsg(source->comm->st, &st->scratch, source);
1548 static inline void site_settimeout(uint64_t timeout, int *timeout_io)
1551 int64_t offset=timeout-*now;
1552 if (offset<0) offset=0;
1553 if (offset>INT_MAX) offset=INT_MAX;
1554 if (*timeout_io<0 || offset<*timeout_io)
1559 static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
1562 struct site *st=sst;
1564 *nfds_io=0; /* We don't use any file descriptors */
1567 /* Work out when our next timeout is. The earlier of 'timeout' or
1568 'current.key_timeout'. A stored value of '0' indicates no timeout
1570 site_settimeout(st->timeout, timeout_io);
1571 site_settimeout(st->current.key_timeout, timeout_io);
1572 site_settimeout(st->auxiliary_key.key_timeout, timeout_io);
1574 return 0; /* success */
1577 static void check_expiry(struct site *st, struct data_key *key,
1580 if (key->key_timeout && *now>key->key_timeout) {
1581 delete_one_key(st,key,"maximum life exceeded",which,LOG_TIMEOUT_KEY);
1585 /* NB site_afterpoll will be called before site_beforepoll is ever called */
1586 static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
1588 struct site *st=sst;
1591 if (st->timeout && *now>st->timeout) {
1593 if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
1594 if (!hacky_par_start_failnow())
1596 } else if (st->state==SITE_WAIT) {
1597 enter_state_run(st);
1599 slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
1603 check_expiry(st,&st->current,"current key");
1604 check_expiry(st,&st->auxiliary_key,"auxiliary key");
1607 /* This function is called by the netlink device to deliver packets
1608 intended for the remote network. The packet is in "raw" wire
1609 format, but is guaranteed to be word-aligned. */
1610 static void site_outgoing(void *sst, struct buffer_if *buf)
1612 struct site *st=sst;
1613 cstring_t transform_err;
1615 if (st->state==SITE_STOP) {
1620 st->allow_send_prod=1;
1622 /* In all other states we consider delivering the packet if we have
1623 a valid key and a valid address to send it to. */
1624 if (current_valid(st) && transport_peers_valid(&st->peers)) {
1625 /* Transform it and send it */
1627 buf_prepend_uint32(buf,LABEL_MSG9);
1628 if (call_transform_forwards(st, st->current.transform,
1629 buf, &transform_err))
1631 buf_prepend_uint32(buf,LABEL_MSG0);
1632 buf_prepend_uint32(buf,st->index);
1633 buf_prepend_uint32(buf,st->current.remote_session_id);
1634 transport_xmit(st,&st->peers,buf,False);
1641 slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
1643 initiate_key_setup(st,"outgoing packet",0);
1646 static bool_t named_for_us(struct site *st, const struct buffer_if *buf_in,
1647 uint32_t type, struct msg *m)
1648 /* For packets which are identified by the local and remote names.
1649 * If it has our name and our peer's name in it it's for us. */
1651 struct buffer_if buf[1];
1652 buffer_readonly_clone(buf,buf_in);
1653 return unpick_msg(st,type,buf,m)
1654 && name_matches(&m->remote,st->remotename)
1655 && name_matches(&m->local,st->localname);
1658 /* This function is called by the communication device to deliver
1659 packets from our peers.
1660 It should return True if the packet is recognised as being for
1661 this current site instance (and should therefore not be processed
1662 by other sites), even if the packet was otherwise ignored. */
1663 static bool_t site_incoming(void *sst, struct buffer_if *buf,
1664 const struct comm_addr *source)
1666 struct site *st=sst;
1668 if (buf->size < 12) return False;
1670 uint32_t dest=get_uint32(buf->start);
1671 uint32_t msgtype=get_uint32(buf->start+8);
1672 struct msg named_msg;
1674 if (msgtype==LABEL_MSG1) {
1675 if (!named_for_us(st,buf,msgtype,&named_msg))
1677 /* It's a MSG1 addressed to us. Decide what to do about it. */
1678 dump_packet(st,buf,source,True);
1679 if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1680 st->state==SITE_WAIT) {
1681 /* We should definitely process it */
1682 transport_compute_setupinit_peers(st,0,0,source);
1683 if (process_msg1(st,buf,source,&named_msg)) {
1684 slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
1685 bool_t entered=enter_new_state(st,SITE_SENTMSG2);
1686 if (entered && st->address && st->local_mobile)
1687 /* We must do this as the very last thing, because
1688 the resolver callback might reenter us. */
1689 ensure_resolving(st);
1691 slog(st,LOG_ERROR,"failed to process incoming msg1");
1695 } else if (st->state==SITE_SENTMSG1) {
1696 /* We've just sent a message 1! They may have crossed on
1697 the wire. If we have priority then we ignore the
1698 incoming one, otherwise we process it as usual. */
1699 if (st->setup_priority) {
1701 slog(st,LOG_DUMP,"crossed msg1s; we are higher "
1702 "priority => ignore incoming msg1");
1705 slog(st,LOG_DUMP,"crossed msg1s; we are lower "
1706 "priority => use incoming msg1");
1707 if (process_msg1(st,buf,source,&named_msg)) {
1708 BUF_FREE(&st->buffer); /* Free our old message 1 */
1709 transport_setup_msgok(st,source);
1710 enter_new_state(st,SITE_SENTMSG2);
1712 slog(st,LOG_ERROR,"failed to process an incoming "
1713 "crossed msg1 (we have low priority)");
1719 /* The message 1 was received at an unexpected stage of the
1720 key setup. XXX POLICY - what do we do? */
1721 slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
1725 if (msgtype==LABEL_PROD) {
1726 if (!named_for_us(st,buf,msgtype,&named_msg))
1728 dump_packet(st,buf,source,True);
1729 if (st->state!=SITE_RUN) {
1730 slog(st,LOG_DROP,"ignoring PROD when not in state RUN");
1731 } else if (current_valid(st)) {
1732 slog(st,LOG_DROP,"ignoring PROD when we think we have a key");
1734 initiate_key_setup(st,"peer sent PROD packet",source);
1739 if (dest==st->index) {
1740 /* Explicitly addressed to us */
1741 if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True);
1744 /* If the source is our current peer then initiate a key setup,
1745 because our peer's forgotten the key */
1746 if (get_uint32(buf->start+4)==st->current.remote_session_id) {
1748 initiated = initiate_key_setup(st,"received a NAK",source);
1749 if (!initiated) generate_send_prod(st,source);
1751 slog(st,LOG_SEC,"bad incoming NAK");
1755 process_msg0(st,buf,source);
1758 /* Setup packet: should not have been explicitly addressed
1760 slog(st,LOG_SEC,"incoming explicitly addressed msg1");
1763 /* Setup packet: expected only in state SENTMSG1 */
1764 if (st->state!=SITE_SENTMSG1) {
1765 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
1766 } else if (process_msg2(st,buf,source)) {
1767 transport_setup_msgok(st,source);
1768 enter_new_state(st,SITE_SENTMSG3);
1770 slog(st,LOG_SEC,"invalid MSG2");
1775 /* Setup packet: expected only in state SENTMSG2 */
1776 if (st->state!=SITE_SENTMSG2) {
1777 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
1778 } else if (process_msg3(st,buf,source,msgtype)) {
1779 transport_setup_msgok(st,source);
1780 enter_new_state(st,SITE_SENTMSG4);
1782 slog(st,LOG_SEC,"invalid MSG3");
1786 /* Setup packet: expected only in state SENTMSG3 */
1787 if (st->state!=SITE_SENTMSG3) {
1788 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
1789 } else if (process_msg4(st,buf,source)) {
1790 transport_setup_msgok(st,source);
1791 enter_new_state(st,SITE_SENTMSG5);
1793 slog(st,LOG_SEC,"invalid MSG4");
1797 /* Setup packet: expected only in state SENTMSG4 */
1798 /* (may turn up in state RUN if our return MSG6 was lost
1799 and the new key has already been activated. In that
1800 case we discard it. The peer will realise that we
1801 are using the new key when they see our data packets.
1802 Until then the peer's data packets to us get discarded. */
1803 if (st->state==SITE_SENTMSG4) {
1804 if (process_msg5(st,buf,source,st->new_transform)) {
1805 transport_setup_msgok(st,source);
1806 enter_new_state(st,SITE_RUN);
1808 slog(st,LOG_SEC,"invalid MSG5");
1810 } else if (st->state==SITE_RUN) {
1811 if (process_msg5(st,buf,source,st->current.transform)) {
1812 slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
1813 transport_setup_msgok(st,source);
1814 create_msg6(st,st->current.transform,
1815 st->current.remote_session_id);
1816 transport_xmit(st,&st->peers,&st->buffer,True);
1817 BUF_FREE(&st->buffer);
1819 slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
1822 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
1826 /* Setup packet: expected only in state SENTMSG5 */
1827 if (st->state!=SITE_SENTMSG5) {
1828 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
1829 } else if (process_msg6(st,buf,source)) {
1830 BUF_FREE(&st->buffer); /* Free message 5 */
1831 transport_setup_msgok(st,source);
1832 activate_new_key(st);
1834 slog(st,LOG_SEC,"invalid MSG6");
1838 slog(st,LOG_SEC,"received message of unknown type 0x%08x",
1849 static void site_control(void *vst, bool_t run)
1851 struct site *st=vst;
1852 if (run) enter_state_run(st);
1853 else enter_state_stop(st);
1856 static void site_phase_hook(void *sst, uint32_t newphase)
1858 struct site *st=sst;
1860 /* The program is shutting down; tell our peer */
1861 send_msg7(st,"shutting down");
1864 static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
1867 static uint32_t index_sequence;
1873 st=safe_malloc(sizeof(*st),"site_apply");
1875 st->cl.description="site";
1876 st->cl.type=CL_SITE;
1878 st->cl.interface=&st->ops;
1880 st->ops.control=site_control;
1881 st->ops.status=site_status;
1883 /* First parameter must be a dict */
1884 item=list_elem(args,0);
1885 if (!item || item->type!=t_dict)
1886 cfgfatal(loc,"site","parameter must be a dictionary\n");
1888 dict=item->data.dict;
1889 st->localname=dict_read_string(dict, "local-name", True, "site", loc);
1890 st->remotename=dict_read_string(dict, "name", True, "site", loc);
1892 st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
1894 dict_read_bool(dict,"local-mobile",False,"site",loc,False);
1896 /* Sanity check (which also allows the 'sites' file to include
1897 site() closures for all sites including our own): refuse to
1898 talk to ourselves */
1899 if (strcmp(st->localname,st->remotename)==0) {
1900 Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
1902 if (st->peer_mobile != st->local_mobile)
1903 cfgfatal(loc,"site","site %s's peer-mobile=%d"
1904 " but our local-mobile=%d\n",
1905 st->localname, st->peer_mobile, st->local_mobile);
1909 if (st->peer_mobile && st->local_mobile) {
1910 Message(M_WARNING,"site %s: site is mobile but so are we"
1911 " -> ignoring this site\n", st->remotename);
1916 assert(index_sequence < 0xffffffffUL);
1917 st->index = ++index_sequence;
1918 st->local_capabilities = 0;
1919 st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
1921 #define GET_CLOSURE_LIST(dictkey,things,nthings,CL_TYPE) do{ \
1922 list_t *things##_cfg=dict_lookup(dict,dictkey); \
1923 if (!things##_cfg) \
1924 cfgfatal(loc,"site","closure list \"%s\" not found\n",dictkey); \
1925 st->nthings=list_length(things##_cfg); \
1926 st->things=safe_malloc_ary(sizeof(*st->things),st->nthings,dictkey "s"); \
1927 assert(st->nthings); \
1928 for (i=0; i<st->nthings; i++) { \
1929 item_t *item=list_elem(things##_cfg,i); \
1930 if (item->type!=t_closure) \
1931 cfgfatal(loc,"site","%s is not a closure\n",dictkey); \
1932 closure_t *cl=item->data.closure; \
1933 if (cl->type!=CL_TYPE) \
1934 cfgfatal(loc,"site","%s closure wrong type\n",dictkey); \
1935 st->things[i]=cl->interface; \
1939 GET_CLOSURE_LIST("comm",comms,ncomms,CL_COMM);
1941 st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
1942 st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
1943 st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
1945 st->privkey=find_cl_if(dict,"local-key",CL_RSAPRIVKEY,True,"site",loc);
1946 st->address=dict_read_string(dict, "address", False, "site", loc);
1948 st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
1949 else st->remoteport=0;
1950 st->pubkey=find_cl_if(dict,"key",CL_RSAPUBKEY,True,"site",loc);
1952 GET_CLOSURE_LIST("transform",transforms,ntransforms,CL_TRANSFORM);
1954 st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
1955 st->hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
1957 #define DEFAULT(D) (st->peer_mobile || st->local_mobile \
1958 ? DEFAULT_MOBILE_##D : DEFAULT_##D)
1959 #define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
1961 st->key_lifetime= CFG_NUMBER("key-lifetime", KEY_LIFETIME);
1962 st->setup_retries= CFG_NUMBER("setup-retries", SETUP_RETRIES);
1963 st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
1964 st->wait_timeout= CFG_NUMBER("wait-time", WAIT_TIME);
1965 st->mtu_target= dict_read_number(dict,"mtu-target",False,"site",loc,0);
1967 st->mobile_peer_expiry= dict_read_number(
1968 dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
1970 st->transport_peers_max= !st->peer_mobile ? 1 : dict_read_number(
1971 dict,"mobile-peers-max",False,"site",loc,DEFAULT_MOBILE_PEERS_MAX);
1972 if (st->transport_peers_max<1 ||
1973 st->transport_peers_max>MAX_MOBILE_PEERS_MAX) {
1974 cfgfatal(loc,"site","mobile-peers-max must be in range 1.."
1975 STRING(MAX_MOBILE_PEERS_MAX) "\n");
1978 if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
1979 st->key_renegotiate_time=st->key_lifetime/2;
1981 st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
1982 st->key_renegotiate_time=dict_read_number(
1983 dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
1984 if (st->key_renegotiate_time > st->key_lifetime) {
1985 cfgfatal(loc,"site",
1986 "renegotiate-time must be less than key-lifetime\n");
1989 st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
1990 log_event_table,"site");
1992 st->resolving=False;
1993 st->allow_send_prod=0;
1995 st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
1997 sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
1999 /* The information we expect to see in incoming messages of type 1 */
2000 /* fixme: lots of unchecked overflows here, but the results are only
2001 corrupted packets rather than undefined behaviour */
2002 st->setup_priority=(strcmp(st->localname,st->remotename)>0);
2004 buffer_new(&st->buffer,SETUP_BUFFER_LEN);
2006 buffer_new(&st->scratch,SETUP_BUFFER_LEN);
2007 BUF_ALLOC(&st->scratch,"site:scratch");
2009 /* We are interested in poll(), but only for timeouts. We don't have
2010 any fds of our own. */
2011 register_for_poll(st, site_beforepoll, site_afterpoll, 0, "site");
2014 st->remote_capabilities=0;
2015 st->chosen_transform=0;
2016 st->current.key_timeout=0;
2017 st->auxiliary_key.key_timeout=0;
2018 transport_peers_clear(st,&st->peers);
2019 transport_peers_clear(st,&st->setup_peers);
2020 /* XXX mlock these */
2021 st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
2022 st->sharedsecretlen=st->sharedsecretallocd=0;
2025 for (i=0; i<st->ntransforms; i++) {
2026 struct transform_if *ti=st->transforms[i];
2027 uint32_t capbit = 1UL << ti->capab_transformnum;
2028 if (st->local_capabilities & capbit)
2029 slog(st,LOG_ERROR,"transformnum capability bit"
2030 " %d (%#"PRIx32") reused", ti->capab_transformnum, capbit);
2031 st->local_capabilities |= capbit;
2034 /* We need to register the remote networks with the netlink device */
2035 uint32_t netlink_mtu; /* local virtual interface mtu */
2036 st->netlink->reg(st->netlink->st, site_outgoing, st, &netlink_mtu);
2037 if (!st->mtu_target)
2038 st->mtu_target=netlink_mtu;
2040 for (i=0; i<st->ncomms; i++)
2041 st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
2043 st->current.transform=0;
2044 st->auxiliary_key.transform=0;
2045 st->new_transform=0;
2046 st->auxiliary_is_new=0;
2048 enter_state_stop(st);
2050 add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
2052 return new_closure(&st->cl);
2055 void site_module(dict_t *dict)
2057 add_closure(dict,"site",site_apply);
2061 /***** TRANSPORT PEERS definitions *****/
2063 static void transport_peers_debug(struct site *st, transport_peers *dst,
2064 const char *didwhat,
2065 int nargs, const struct comm_addr *args,
2070 if (!(st->log_events & LOG_PEER_ADDRS))
2071 return; /* an optimisation */
2073 slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
2074 (dst==&st->peers ? "data" :
2075 dst==&st->setup_peers ? "setup" : "UNKNOWN"),
2076 didwhat, nargs, dst->npeers);
2078 for (i=0, argp=(void*)args;
2080 i++, (argp+=stride?stride:sizeof(*args))) {
2081 const struct comm_addr *ca=(void*)argp;
2082 slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
2083 i, comm_addr_to_string(ca));
2085 for (i=0; i<dst->npeers; i++) {
2086 struct timeval diff;
2087 timersub(tv_now,&dst->peers[i].last,&diff);
2088 const struct comm_addr *ca=&dst->peers[i].addr;
2089 slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
2090 i, comm_addr_to_string(ca),
2091 (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
2095 static bool_t transport_addrs_equal(const struct comm_addr *a,
2096 const struct comm_addr *b) {
2097 return !memcmp(a,b,sizeof(*a));
2100 static void transport_peers_expire(struct site *st, transport_peers *peers) {
2101 /* peers must be sorted first */
2102 int previous_peers=peers->npeers;
2103 struct timeval oldest;
2104 oldest.tv_sec = tv_now->tv_sec - st->mobile_peer_expiry;
2105 oldest.tv_usec = tv_now->tv_usec;
2106 while (peers->npeers>1 &&
2107 timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
2109 if (peers->npeers != previous_peers)
2110 transport_peers_debug(st,peers,"expire", 0,0,0);
2113 static bool_t transport_peer_record_one(struct site *st, transport_peers *peers,
2114 const struct comm_addr *ca,
2115 const struct timeval *tv) {
2116 /* returns false if output is full */
2119 if (peers->npeers >= st->transport_peers_max)
2122 for (search=0; search<peers->npeers; search++)
2123 if (transport_addrs_equal(&peers->peers[search].addr, ca))
2126 peers->peers[peers->npeers].addr = *ca;
2127 peers->peers[peers->npeers].last = *tv;
2132 static void transport_record_peers(struct site *st, transport_peers *peers,
2133 const struct comm_addr *addrs, int naddrs,
2135 /* We add addrs into peers. The new entries end up at the front
2136 * and displace entries towards the end (perhaps even off the
2137 * end). Any existing matching entries are moved up to the front.
2139 * Caller must first call transport_peers_expire. */
2141 if (naddrs==1 && peers->npeers>=1 &&
2142 transport_addrs_equal(&addrs[0], &peers->peers[0].addr)) {
2143 /* optimisation, also avoids debug for trivial updates */
2144 peers->peers[0].last = *tv_now;
2148 int old_npeers=peers->npeers;
2149 transport_peer old_peers[old_npeers];
2150 COPY_ARRAY(old_peers,peers->peers,old_npeers);
2154 for (i=0; i<naddrs; i++) {
2155 if (!transport_peer_record_one(st,peers, &addrs[i], tv_now))
2158 for (i=0; i<old_npeers; i++) {
2159 const transport_peer *old=&old_peers[i];
2160 if (!transport_peer_record_one(st,peers, &old->addr, &old->last))
2164 transport_peers_debug(st,peers,m, naddrs,addrs,0);
2167 static void transport_expire_record_peers(struct site *st,
2168 transport_peers *peers,
2169 const struct comm_addr *addrs,
2170 int naddrs, const char *m) {
2171 /* Convenience function */
2172 transport_peers_expire(st,peers);
2173 transport_record_peers(st,peers,addrs,naddrs,m);
2176 static bool_t transport_compute_setupinit_peers(struct site *st,
2177 const struct comm_addr *configured_addrs /* 0 if none or not found */,
2178 int n_configured_addrs /* 0 if none or not found */,
2179 const struct comm_addr *incoming_packet_addr /* 0 if none */) {
2180 if (!n_configured_addrs && !incoming_packet_addr &&
2181 !transport_peers_valid(&st->peers))
2184 slog(st,LOG_SETUP_INIT,
2185 "using: %d configured addr(s);%s %d old peer addrs(es)",
2187 incoming_packet_addr ? " incoming packet address;" : "",
2190 /* Non-mobile peers have st->peers.npeers==0 or ==1, since they
2191 * have transport_peers_max==1. The effect is that this code
2192 * always uses the configured address if supplied, or otherwise
2193 * the address of the incoming PROD, or the existing data peer if
2194 * one exists; this is as desired. */
2196 transport_peers_copy(st,&st->setup_peers,&st->peers);
2197 transport_peers_expire(st,&st->setup_peers);
2199 if (incoming_packet_addr)
2200 transport_record_peers(st,&st->setup_peers,
2201 incoming_packet_addr,1, "incoming");
2203 if (n_configured_addrs)
2204 transport_record_peers(st,&st->setup_peers,
2205 configured_addrs,n_configured_addrs, "setupinit");
2207 assert(transport_peers_valid(&st->setup_peers));
2211 static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
2212 if (st->peer_mobile)
2213 transport_expire_record_peers(st,&st->setup_peers,a,1,"setupmsg");
2215 static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
2216 if (st->peer_mobile)
2217 transport_expire_record_peers(st,&st->peers,a,1,"datamsg");
2220 static int transport_peers_valid(transport_peers *peers) {
2221 return peers->npeers;
2223 static void transport_peers_clear(struct site *st, transport_peers *peers) {
2225 transport_peers_debug(st,peers,"clear",0,0,0);
2227 static void transport_peers_copy(struct site *st, transport_peers *dst,
2228 const transport_peers *src) {
2229 dst->npeers=src->npeers;
2230 COPY_ARRAY(dst->peers, src->peers, dst->npeers);
2231 transport_peers_debug(st,dst,"copy",
2232 src->npeers, &src->peers->addr, sizeof(*src->peers));
2235 static void transport_resolve_complete(struct site *st,
2236 const struct comm_addr *addrs,
2238 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2240 transport_expire_record_peers(st,&st->setup_peers,addrs,naddrs,
2244 static void transport_resolve_complete_tardy(struct site *st,
2245 const struct comm_addr *addrs,
2247 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2248 "resolved tardily");
2251 static void transport_peers__copy_by_mask(transport_peer *out, int *nout_io,
2253 const transport_peers *inp) {
2254 /* out and in->peers may be the same region, or nonoverlapping */
2255 const transport_peer *in=inp->peers;
2257 for (slot=0; slot<inp->npeers; slot++) {
2258 if (!(mask & (1U << slot)))
2260 if (!(out==in && slot==*nout_io))
2261 COPY_OBJ(out[*nout_io], in[slot]);
2266 void transport_xmit(struct site *st, transport_peers *peers,
2267 struct buffer_if *buf, bool_t candebug) {
2269 transport_peers_expire(st, peers);
2270 unsigned failed=0; /* bitmask */
2271 assert(MAX_MOBILE_PEERS_MAX < sizeof(unsigned)*CHAR_BIT);
2274 for (slot=0; slot<peers->npeers; slot++) {
2275 transport_peer *peer=&peers->peers[slot];
2277 dump_packet(st, buf, &peer->addr, False);
2279 peer->addr.comm->sendmsg(peer->addr.comm->st, buf, &peer->addr);
2281 failed |= 1U << slot;
2284 if (ok && !st->peer_mobile)
2287 /* Now we need to demote/delete failing addrs: if we are mobile we
2288 * merely demote them; otherwise we delete them. */
2289 if (st->local_mobile) {
2290 unsigned expected = ((1U << nfailed)-1) << (peers->npeers-nfailed);
2291 /* `expected' has all the failures at the end already */
2292 if (failed != expected) {
2294 transport_peer failedpeers[nfailed];
2295 transport_peers__copy_by_mask(failedpeers, &fslot, failed,peers);
2296 assert(fslot == nfailed);
2298 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2299 assert(wslot+nfailed == peers->npeers);
2300 COPY_ARRAY(peers->peers+wslot, failedpeers, nfailed);
2303 if (failed && peers->npeers > 1) {
2305 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2306 peers->npeers=wslot;
2311 /***** END of transport peers declarations *****/