1 /* site.c - manage communication with a remote network site */
4 * This file is part of secnet.
5 * See README for full list of copyright holders.
7 * secnet is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version d of the License, or
10 * (at your option) any later version.
12 * secnet is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * version 3 along with secnet; if not, see
19 * https://www.gnu.org/licenses/gpl.html.
22 /* The 'site' code doesn't know anything about the structure of the
23 packets it's transmitting. In fact, under the new netlink
24 configuration scheme it doesn't need to know anything at all about
25 IP addresses, except how to contact its peer. This means it could
26 potentially be used to tunnel other protocols too (IPv6, IPX, plain
27 old Ethernet frames) if appropriate netlink code can be written
28 (and that ought not to be too hard, eg. using the TUN/TAP device to
29 pretend to be an Ethernet interface). */
31 /* At some point in the future the netlink code will be asked for
32 configuration information to go in the PING/PONG packets at the end
33 of the key exchange. */
40 #include <sys/socket.h>
44 #include "unaligned.h"
47 #define SETUP_BUFFER_LEN 2048
49 #define DEFAULT_KEY_LIFETIME (3600*1000) /* [ms] */
50 #define DEFAULT_KEY_RENEGOTIATE_GAP (5*60*1000) /* [ms] */
51 #define DEFAULT_SETUP_RETRIES 5
52 #define DEFAULT_SETUP_RETRY_INTERVAL (2*1000) /* [ms] */
53 #define DEFAULT_WAIT_TIME (20*1000) /* [ms] */
55 #define DEFAULT_MOBILE_KEY_LIFETIME (2*24*3600*1000) /* [ms] */
56 #define DEFAULT_MOBILE_KEY_RENEGOTIATE_GAP (12*3600*1000) /* [ms] */
57 #define DEFAULT_MOBILE_SETUP_RETRIES 30
58 #define DEFAULT_MOBILE_SETUP_RETRY_INTERVAL (1*1000) /* [ms] */
59 #define DEFAULT_MOBILE_WAIT_TIME (10*1000) /* [ms] */
61 #define DEFAULT_MOBILE_PEER_EXPIRY (2*60) /* [s] */
63 /* Each site can be in one of several possible states. */
66 SITE_STOP - nothing is allowed to happen; tunnel is down;
67 all session keys have been erased
68 -> SITE_RUN upon external instruction
69 SITE_RUN - site up, maybe with valid key
70 -> SITE_RESOLVE upon outgoing packet and no valid key
71 we start name resolution for the other end of the tunnel
72 -> SITE_SENTMSG2 upon valid incoming message 1 and suitable time
73 we send an appropriate message 2
74 SITE_RESOLVE - waiting for name resolution
75 -> SITE_SENTMSG1 upon successful resolution
76 we send an appropriate message 1
77 -> SITE_SENTMSG2 upon valid incoming message 1 (then abort resolution)
78 we abort resolution and
79 -> SITE_WAIT on timeout or resolution failure
81 -> SITE_SENTMSG2 upon valid incoming message 1 from higher priority end
82 -> SITE_SENTMSG3 upon valid incoming message 2
83 -> SITE_WAIT on timeout
85 -> SITE_SENTMSG4 upon valid incoming message 3
86 -> SITE_WAIT on timeout
88 -> SITE_SENTMSG5 upon valid incoming message 4
89 -> SITE_WAIT on timeout
91 -> SITE_RUN upon valid incoming message 5
92 -> SITE_WAIT on timeout
94 -> SITE_RUN upon valid incoming message 6
95 -> SITE_WAIT on timeout
96 SITE_WAIT - failed to establish key; do nothing for a while
97 -> SITE_RUN on timeout
102 #define SITE_RESOLVE 2
103 #define SITE_SENTMSG1 3
104 #define SITE_SENTMSG2 4
105 #define SITE_SENTMSG3 5
106 #define SITE_SENTMSG4 6
107 #define SITE_SENTMSG5 7
110 int32_t site_max_start_pad = 4*4;
112 static cstring_t state_name(uint32_t state)
115 case 0: return "STOP";
116 case 1: return "RUN";
117 case 2: return "RESOLVE";
118 case 3: return "SENTMSG1";
119 case 4: return "SENTMSG2";
120 case 5: return "SENTMSG3";
121 case 6: return "SENTMSG4";
122 case 7: return "SENTMSG5";
123 case 8: return "WAIT";
124 default: return "*bad state*";
130 #define LOG_UNEXPECTED 0x00000001
131 #define LOG_SETUP_INIT 0x00000002
132 #define LOG_SETUP_TIMEOUT 0x00000004
133 #define LOG_ACTIVATE_KEY 0x00000008
134 #define LOG_TIMEOUT_KEY 0x00000010
135 #define LOG_SEC 0x00000020
136 #define LOG_STATE 0x00000040
137 #define LOG_DROP 0x00000080
138 #define LOG_DUMP 0x00000100
139 #define LOG_ERROR 0x00000400
140 #define LOG_PEER_ADDRS 0x00000800
142 static struct flagstr log_event_table[]={
143 { "unexpected", LOG_UNEXPECTED },
144 { "setup-init", LOG_SETUP_INIT },
145 { "setup-timeout", LOG_SETUP_TIMEOUT },
146 { "activate-key", LOG_ACTIVATE_KEY },
147 { "timeout-key", LOG_TIMEOUT_KEY },
148 { "security", LOG_SEC },
149 { "state-change", LOG_STATE },
150 { "packet-drop", LOG_DROP },
151 { "dump-packets", LOG_DUMP },
152 { "errors", LOG_ERROR },
153 { "peer-addrs", LOG_PEER_ADDRS },
154 { "default", LOG_SETUP_INIT|LOG_SETUP_TIMEOUT|
155 LOG_ACTIVATE_KEY|LOG_TIMEOUT_KEY|LOG_SEC|LOG_ERROR },
156 { "all", 0xffffffff },
161 /***** TRANSPORT PEERS declarations *****/
163 /* Details of "mobile peer" semantics:
165 - We use the same data structure for the different configurations,
166 but manage it with different algorithms.
168 - We record up to mobile_peers_max peer address/port numbers
169 ("peers") for key setup, and separately up to mobile_peers_max
172 - In general, we make a new set of addrs (see below) when we start
173 a new key exchange; the key setup addrs become the data transport
174 addrs when key setup complets.
176 If our peer is mobile:
178 - We send to all recent addresses of incoming packets, plus
179 initially all configured addresses (which we also expire).
181 - So, we record addrs of good incoming packets, as follows:
182 1. expire any peers last seen >120s ("mobile-peer-expiry") ago
183 2. add the peer of the just received packet to the applicable list
184 (possibly evicting the oldest entries to make room)
185 NB that we do not expire peers until an incoming packet arrives.
187 - If the peer has a configured address or name, we record them the
188 same way, but only as a result of our own initiation of key
189 setup. (We might evict some incoming packet addrs to make room.)
191 - The default number of addrs to keep is 3, or 4 if we have a
192 configured name or address. That's space for two configured
193 addresses (one IPv6 and one IPv4), plus two received addresses.
195 - Outgoing packets are sent to every recorded address in the
196 applicable list. Any unsupported[1] addresses are deleted from
197 the list right away. (This should only happen to configured
198 addresses, of course, but there is no need to check that.)
200 - When we successfully complete a key setup, we merge the key setup
201 peers into the data transfer peers.
203 [1] An unsupported address is one for whose AF we don't have a
204 socket (perhaps because we got EAFNOSUPPORT or some such) or for
205 which sendto gives ENETUNREACH.
207 If neither end is mobile:
209 - When peer initiated the key exchange, we use the incoming packet
212 - When we initiate the key exchange, we try configured addresses
213 until we get one which isn't unsupported then fixate on that.
215 - When we complete a key setup, we replace the data transport peers
216 with those from the key setup.
220 - We can't tell when local network setup changes so we can't cache
221 the unsupported addrs and completely remove the spurious calls to
222 sendto, but we can optimise things a bit by deprioritising addrs
223 which seem to be unsupported.
225 - Use only configured addresses. (Except, that if our peer
226 initiated a key exchange we use the incoming packet address until
227 our name resolution completes.)
229 - When we send a packet, try each address in turn; if addr
230 supported, put that address to the end of the list for future
231 packets, and go onto the next address.
233 - When we complete a key setup, we replace the data transport peers
234 with those from the key setup.
240 struct comm_addr addr;
244 /* configuration information */
245 /* runtime information */
247 transport_peer peers[MAX_PEER_ADDRS];
250 /* Basic operations on transport peer address sets */
251 static void transport_peers_clear(struct site *st, transport_peers *peers);
252 static int transport_peers_valid(transport_peers *peers);
253 static void transport_peers_copy(struct site *st, transport_peers *dst,
254 const transport_peers *src);
256 /* Record address of incoming setup packet; resp. data packet. */
257 static void transport_setup_msgok(struct site *st, const struct comm_addr *a);
258 static void transport_data_msgok(struct site *st, const struct comm_addr *a);
260 /* Initialise the setup addresses. Called before we send the first
261 * packet in a key exchange. If we are the initiator, as a result of
262 * resolve completing (or being determined not to be relevant) or an
263 * incoming PROD; if we are the responder, as a result of the MSG1. */
264 static bool_t transport_compute_setupinit_peers(struct site *st,
265 const struct comm_addr *configured_addrs /* 0 if none or not found */,
266 int n_configured_addrs /* 0 if none or not found */,
267 const struct comm_addr *incoming_packet_addr /* 0 if none */);
269 /* Called if we are the responder in a key setup, when the resolve
270 * completes. transport_compute_setupinit_peers will hvae been called
271 * earlier. If _complete is called, we are still doing the key setup
272 * (and we should use the new values for both the rest of the key
273 * setup and the ongoing data exchange); if _tardy is called, the key
274 * setup is done (either completed or not) and only the data peers are
276 static void transport_resolve_complete(struct site *st,
277 const struct comm_addr *addrs, int naddrs);
278 static void transport_resolve_complete_tardy(struct site *st,
279 const struct comm_addr *addrs, int naddrs);
281 static void transport_xmit(struct site *st, transport_peers *peers,
282 struct buffer_if *buf, bool_t candebug);
284 /***** END of transport peers declarations *****/
288 struct transform_inst_if *transform;
289 uint64_t key_timeout; /* End of life of current key */
290 uint32_t remote_session_id;
296 /* configuration information */
299 bool_t local_mobile, peer_mobile; /* Mobile client support */
300 int32_t transport_peers_max;
301 string_t tunname; /* localname<->remotename by default, used in logs */
302 cstring_t *addresses; /* DNS name or address(es) for bootstrapping, optional */
303 int remoteport; /* Port for bootstrapping, optional */
305 struct netlink_if *netlink;
306 struct comm_if **comms;
308 struct resolver_if *resolver;
310 struct random_if *random;
311 struct rsaprivkey_if *privkey;
312 struct rsapubkey_if *pubkey;
313 struct transform_if **transforms;
316 struct hash_if *hash;
318 uint32_t index; /* Index of this site */
319 uint32_t local_capabilities;
320 int32_t setup_retries; /* How many times to send setup packets */
321 int32_t setup_retry_interval; /* Initial timeout for setup packets */
322 int32_t wait_timeout; /* How long to wait if setup unsuccessful */
323 int32_t mobile_peer_expiry; /* How long to remember 2ary addresses */
324 int32_t key_lifetime; /* How long a key lasts once set up */
325 int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
326 after this time, initiate a new
329 bool_t setup_priority; /* Do we have precedence if both sites emit
330 message 1 simultaneously? */
333 /* runtime information */
335 uint64_t now; /* Most recently seen time */
336 bool_t allow_send_prod;
338 int resolving_n_results_all;
339 int resolving_n_results_stored;
340 struct comm_addr resolving_results[MAX_PEER_ADDRS];
342 /* The currently established session */
343 struct data_key current;
344 struct data_key auxiliary_key;
345 bool_t auxiliary_is_new;
346 uint64_t renegotiate_key_time; /* When we can negotiate a new key */
347 uint64_t auxiliary_renegotiate_key_time;
348 transport_peers peers; /* Current address(es) of peer for data traffic */
350 /* The current key setup protocol exchange. We can only be
351 involved in one of these at a time. There's a potential for
352 denial of service here (the attacker keeps sending a setup
353 packet; we keep trying to continue the exchange, and have to
354 timeout before we can listen for another setup packet); perhaps
355 we should keep a list of 'bad' sources for setup packets. */
356 uint32_t remote_capabilities;
357 uint16_t remote_adv_mtu;
358 struct transform_if *chosen_transform;
359 uint32_t setup_session_id;
360 transport_peers setup_peers;
361 uint8_t localN[NONCELEN]; /* Nonces for key exchange */
362 uint8_t remoteN[NONCELEN];
363 struct buffer_if buffer; /* Current outgoing key exchange packet */
364 struct buffer_if scratch;
365 int32_t retries; /* Number of retries remaining */
366 uint64_t timeout; /* Timeout for current state */
368 uint8_t *sharedsecret;
369 uint32_t sharedsecretlen, sharedsecretallocd;
370 struct transform_inst_if *new_transform; /* For key setup/verify */
373 static uint32_t event_log_priority(struct site *st, uint32_t event)
375 if (!(event&st->log_events))
378 case LOG_UNEXPECTED: return M_INFO;
379 case LOG_SETUP_INIT: return M_INFO;
380 case LOG_SETUP_TIMEOUT: return M_NOTICE;
381 case LOG_ACTIVATE_KEY: return M_INFO;
382 case LOG_TIMEOUT_KEY: return M_INFO;
383 case LOG_SEC: return M_SECURITY;
384 case LOG_STATE: return M_DEBUG;
385 case LOG_DROP: return M_DEBUG;
386 case LOG_DUMP: return M_DEBUG;
387 case LOG_ERROR: return M_ERR;
388 case LOG_PEER_ADDRS: return M_DEBUG;
389 default: return M_ERR;
393 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
395 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
399 class=event_log_priority(st, event);
401 slilog_part(st->log,class,"%s: ",st->tunname);
402 vslilog_part(st->log,class,msg,ap);
403 slilog_part(st->log,class,"\n");
407 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
409 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
413 vslog(st,event,msg,ap);
417 static void logtimeout(struct site *st, const char *fmt, ...)
419 static void logtimeout(struct site *st, const char *fmt, ...)
421 uint32_t class=event_log_priority(st,LOG_SETUP_TIMEOUT);
428 slilog_part(st->log,class,"%s: ",st->tunname);
429 vslilog_part(st->log,class,fmt,ap);
433 for (i=0, delim=" (tried ";
434 i<st->setup_peers.npeers;
436 transport_peer *peer=&st->setup_peers.peers[i];
437 const char *s=comm_addr_to_string(&peer->addr);
438 slilog_part(st->log,class,"%s%s",delim,s);
441 slilog_part(st->log,class,")\n");
445 static void set_link_quality(struct site *st);
446 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel);
447 static void delete_one_key(struct site *st, struct data_key *key,
448 const char *reason /* may be 0 meaning don't log*/,
449 const char *which /* ignored if !reasonn */,
450 uint32_t loglevel /* ignored if !reasonn */);
451 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
452 const struct comm_addr *prod_hint);
453 static void enter_state_run(struct site *st);
454 static bool_t enter_state_resolve(struct site *st);
455 static void decrement_resolving_count(struct site *st, int by);
456 static bool_t enter_new_state(struct site *st,uint32_t next);
457 static void enter_state_wait(struct site *st);
458 static void activate_new_key(struct site *st);
460 static bool_t is_transform_valid(struct transform_inst_if *transform)
462 return transform && transform->valid(transform->st);
465 static bool_t current_valid(struct site *st)
467 return is_transform_valid(st->current.transform);
470 #define DEFINE_CALL_TRANSFORM(fwdrev) \
471 static int call_transform_##fwdrev(struct site *st, \
472 struct transform_inst_if *transform, \
473 struct buffer_if *buf, \
474 const char **errmsg) \
476 if (!is_transform_valid(transform)) { \
477 *errmsg="transform not set up"; \
480 return transform->fwdrev(transform->st,buf,errmsg); \
483 DEFINE_CALL_TRANSFORM(forwards)
484 DEFINE_CALL_TRANSFORM(reverse)
486 static void dispose_transform(struct transform_inst_if **transform_var)
488 struct transform_inst_if *transform=*transform_var;
490 transform->delkey(transform->st);
491 transform->destroy(transform->st);
496 #define CHECK_AVAIL(b,l) do { if ((b)->size<(l)) return False; } while(0)
497 #define CHECK_EMPTY(b) do { if ((b)->size!=0) return False; } while(0)
498 #define CHECK_TYPE(b,t) do { uint32_t type; \
499 CHECK_AVAIL((b),4); \
500 type=buf_unprepend_uint32((b)); \
501 if (type!=(t)) return False; } while(0)
503 static _Bool type_is_msg34(uint32_t type)
506 type == LABEL_MSG3 ||
507 type == LABEL_MSG3BIS ||
514 struct buffer_if extrainfo;
521 struct parsedname remote;
522 struct parsedname local;
523 uint32_t remote_capabilities;
525 int capab_transformnum;
535 static void set_new_transform(struct site *st, char *pk)
537 /* Make room for the shared key */
538 st->sharedsecretlen=st->chosen_transform->keylen?:st->dh->ceil_len;
539 assert(st->sharedsecretlen);
540 if (st->sharedsecretlen > st->sharedsecretallocd) {
541 st->sharedsecretallocd=st->sharedsecretlen;
542 st->sharedsecret=safe_realloc_ary(st->sharedsecret,1,
543 st->sharedsecretallocd,
544 "site:sharedsecret");
547 /* Generate the shared key */
548 st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,pk,
549 st->sharedsecret,st->sharedsecretlen);
551 /* Set up the transform */
552 struct transform_if *generator=st->chosen_transform;
553 struct transform_inst_if *generated=generator->create(generator->st);
554 generated->setkey(generated->st,st->sharedsecret,
555 st->sharedsecretlen,st->setup_priority);
556 dispose_transform(&st->new_transform);
557 st->new_transform=generated;
559 slog(st,LOG_SETUP_INIT,"key exchange negotiated transform"
560 " %d (capabilities ours=%#"PRIx32" theirs=%#"PRIx32")",
561 st->chosen_transform->capab_transformnum,
562 st->local_capabilities, st->remote_capabilities);
566 int32_t lenpos, afternul;
568 static void append_string_xinfo_start(struct buffer_if *buf,
569 struct xinfoadd *xia,
571 /* Helps construct one of the names with additional info as found
572 * in MSG1..4. Call this function first, then append all the
573 * desired extra info (not including the nul byte) to the buffer,
574 * then call append_string_xinfo_done. */
576 xia->lenpos = buf->size;
577 buf_append_string(buf,str);
578 buf_append_uint8(buf,0);
579 xia->afternul = buf->size;
581 static void append_string_xinfo_done(struct buffer_if *buf,
582 struct xinfoadd *xia)
584 /* we just need to adjust the string length */
585 if (buf->size == xia->afternul) {
586 /* no extra info, strip the nul too */
587 buf_unappend_uint8(buf);
589 put_uint16(buf->start+xia->lenpos, buf->size-(xia->lenpos+2));
593 /* Build any of msg1 to msg4. msg5 and msg6 are built from the inside
594 out using a transform of config data supplied by netlink */
595 static bool_t generate_msg(struct site *st, uint32_t type, cstring_t what)
601 st->retries=st->setup_retries;
602 BUF_ALLOC(&st->buffer,what);
603 buffer_init(&st->buffer,0);
604 buf_append_uint32(&st->buffer,
605 (type==LABEL_MSG1?0:st->setup_session_id));
606 buf_append_uint32(&st->buffer,st->index);
607 buf_append_uint32(&st->buffer,type);
610 append_string_xinfo_start(&st->buffer,&xia,st->localname);
611 if ((st->local_capabilities & CAPAB_EARLY) || (type != LABEL_MSG1)) {
612 buf_append_uint32(&st->buffer,st->local_capabilities);
614 if (type_is_msg34(type)) {
615 buf_append_uint16(&st->buffer,st->mtu_target);
617 append_string_xinfo_done(&st->buffer,&xia);
619 buf_append_string(&st->buffer,st->remotename);
620 BUF_ADD_OBJ(append,&st->buffer,st->localN);
621 if (type==LABEL_MSG1) return True;
622 BUF_ADD_OBJ(append,&st->buffer,st->remoteN);
623 if (type==LABEL_MSG2) return True;
625 if (hacky_par_mid_failnow()) return False;
627 if (type==LABEL_MSG3BIS)
628 buf_append_uint8(&st->buffer,st->chosen_transform->capab_transformnum);
630 dhpub=st->dh->makepublic(st->dh->st,st->dhsecret,st->dh->len);
631 buf_append_string(&st->buffer,dhpub);
633 hash=safe_malloc(st->hash->len, "generate_msg");
634 hst=st->hash->init();
635 st->hash->update(hst,st->buffer.start,st->buffer.size);
636 st->hash->final(hst,hash);
637 sig=st->privkey->sign(st->privkey->st,hash,st->hash->len);
638 buf_append_string(&st->buffer,sig);
644 static bool_t unpick_name(struct buffer_if *msg, struct parsedname *nm)
647 nm->len=buf_unprepend_uint16(msg);
648 CHECK_AVAIL(msg,nm->len);
649 nm->name=buf_unprepend(msg,nm->len);
650 uint8_t *nul=memchr(nm->name,0,nm->len);
652 buffer_readonly_view(&nm->extrainfo,0,0);
654 buffer_readonly_view(&nm->extrainfo, nul+1, msg->start-(nul+1));
655 nm->len=nul-nm->name;
660 static bool_t unpick_msg(struct site *st, uint32_t type,
661 struct buffer_if *msg, struct msg *m)
663 m->capab_transformnum=-1;
664 m->hashstart=msg->start;
666 m->dest=buf_unprepend_uint32(msg);
668 m->source=buf_unprepend_uint32(msg);
669 CHECK_TYPE(msg,type);
670 if (!unpick_name(msg,&m->remote)) return False;
671 m->remote_capabilities=0;
673 if (m->remote.extrainfo.size) {
674 CHECK_AVAIL(&m->remote.extrainfo,4);
675 m->remote_capabilities=buf_unprepend_uint32(&m->remote.extrainfo);
677 if (type_is_msg34(type) && m->remote.extrainfo.size) {
678 CHECK_AVAIL(&m->remote.extrainfo,2);
679 m->remote_mtu=buf_unprepend_uint16(&m->remote.extrainfo);
681 if (!unpick_name(msg,&m->local)) return False;
682 if (type==LABEL_PROD) {
686 CHECK_AVAIL(msg,NONCELEN);
687 m->nR=buf_unprepend(msg,NONCELEN);
688 if (type==LABEL_MSG1) {
692 CHECK_AVAIL(msg,NONCELEN);
693 m->nL=buf_unprepend(msg,NONCELEN);
694 if (type==LABEL_MSG2) {
698 if (type==LABEL_MSG3BIS) {
700 m->capab_transformnum = buf_unprepend_uint8(msg);
702 m->capab_transformnum = CAPAB_TRANSFORMNUM_ANCIENT;
705 m->pklen=buf_unprepend_uint16(msg);
706 CHECK_AVAIL(msg,m->pklen);
707 m->pk=buf_unprepend(msg,m->pklen);
708 m->hashlen=msg->start-m->hashstart;
710 m->siglen=buf_unprepend_uint16(msg);
711 CHECK_AVAIL(msg,m->siglen);
712 m->sig=buf_unprepend(msg,m->siglen);
717 static bool_t name_matches(const struct parsedname *nm, const char *expected)
719 int expected_len=strlen(expected);
721 nm->len == expected_len &&
722 !memcmp(nm->name, expected, expected_len);
725 static bool_t check_msg(struct site *st, uint32_t type, struct msg *m,
728 if (type==LABEL_MSG1) return True;
730 /* Check that the site names and our nonce have been sent
731 back correctly, and then store our peer's nonce. */
732 if (!name_matches(&m->remote,st->remotename)) {
733 *error="wrong remote site name";
736 if (!name_matches(&m->local,st->localname)) {
737 *error="wrong local site name";
740 if (memcmp(m->nL,st->localN,NONCELEN)!=0) {
741 *error="wrong locally-generated nonce";
744 if (type==LABEL_MSG2) return True;
745 if (!consttime_memeq(m->nR,st->remoteN,NONCELEN)!=0) {
746 *error="wrong remotely-generated nonce";
749 /* MSG3 has complicated rules about capabilities, which are
750 * handled in process_msg3. */
751 if (type==LABEL_MSG3 || type==LABEL_MSG3BIS) return True;
752 if (m->remote_capabilities!=st->remote_capabilities) {
753 *error="remote capabilities changed";
756 if (type==LABEL_MSG4) return True;
757 *error="unknown message type";
761 static bool_t generate_msg1(struct site *st)
763 st->random->generate(st->random->st,NONCELEN,st->localN);
764 return generate_msg(st,LABEL_MSG1,"site:MSG1");
767 static bool_t process_msg1(struct site *st, struct buffer_if *msg1,
768 const struct comm_addr *src, struct msg *m)
770 /* We've already determined we're in an appropriate state to
771 process an incoming MSG1, and that the MSG1 has correct values
774 st->setup_session_id=m->source;
775 st->remote_capabilities=m->remote_capabilities;
776 memcpy(st->remoteN,m->nR,NONCELEN);
780 static bool_t generate_msg2(struct site *st)
782 st->random->generate(st->random->st,NONCELEN,st->localN);
783 return generate_msg(st,LABEL_MSG2,"site:MSG2");
786 static bool_t process_msg2(struct site *st, struct buffer_if *msg2,
787 const struct comm_addr *src)
792 if (!unpick_msg(st,LABEL_MSG2,msg2,&m)) return False;
793 if (!check_msg(st,LABEL_MSG2,&m,&err)) {
794 slog(st,LOG_SEC,"msg2: %s",err);
797 st->setup_session_id=m.source;
798 st->remote_capabilities=m.remote_capabilities;
800 /* Select the transform to use */
802 uint32_t remote_transforms = st->remote_capabilities & CAPAB_TRANSFORM_MASK;
803 if (!remote_transforms)
804 /* old secnets only had this one transform */
805 remote_transforms = 1UL << CAPAB_TRANSFORMNUM_ANCIENT;
807 struct transform_if *ti;
809 for (i=0; i<st->ntransforms; i++) {
810 ti=st->transforms[i];
811 if ((1UL << ti->capab_transformnum) & remote_transforms)
812 goto transform_found;
814 slog(st,LOG_ERROR,"no transforms in common"
815 " (us %#"PRIx32"; them: %#"PRIx32")",
816 st->local_capabilities & CAPAB_TRANSFORM_MASK,
820 st->chosen_transform=ti;
822 memcpy(st->remoteN,m.nR,NONCELEN);
826 static bool_t generate_msg3(struct site *st)
828 /* Now we have our nonce and their nonce. Think of a secret key,
829 and create message number 3. */
830 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
831 return generate_msg(st,
832 (st->remote_capabilities & CAPAB_TRANSFORM_MASK
833 ? LABEL_MSG3BIS : LABEL_MSG3),
837 static bool_t process_msg3_msg4(struct site *st, struct msg *m)
842 /* Check signature and store g^x mod m */
843 hash=safe_malloc(st->hash->len, "process_msg3_msg4");
844 hst=st->hash->init();
845 st->hash->update(hst,m->hashstart,m->hashlen);
846 st->hash->final(hst,hash);
847 /* Terminate signature with a '0' - cheating, but should be ok */
849 if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m->sig)) {
850 slog(st,LOG_SEC,"msg3/msg4 signature failed check!");
856 st->remote_adv_mtu=m->remote_mtu;
861 static bool_t process_msg3(struct site *st, struct buffer_if *msg3,
862 const struct comm_addr *src, uint32_t msgtype)
867 assert(msgtype==LABEL_MSG3 || msgtype==LABEL_MSG3BIS);
869 if (!unpick_msg(st,msgtype,msg3,&m)) return False;
870 if (!check_msg(st,msgtype,&m,&err)) {
871 slog(st,LOG_SEC,"msg3: %s",err);
874 uint32_t capab_adv_late = m.remote_capabilities
875 & ~st->remote_capabilities & CAPAB_EARLY;
876 if (capab_adv_late) {
877 slog(st,LOG_SEC,"msg3 impermissibly adds early capability flag(s)"
878 " %#"PRIx32" (was %#"PRIx32", now %#"PRIx32")",
879 capab_adv_late, st->remote_capabilities, m.remote_capabilities);
882 st->remote_capabilities|=m.remote_capabilities;
884 struct transform_if *ti;
886 for (i=0; i<st->ntransforms; i++) {
887 ti=st->transforms[i];
888 if (ti->capab_transformnum == m.capab_transformnum)
889 goto transform_found;
891 slog(st,LOG_SEC,"peer chose unknown-to-us transform %d!",
892 m.capab_transformnum);
895 st->chosen_transform=ti;
897 if (!process_msg3_msg4(st,&m))
900 /* Terminate their DH public key with a '0' */
902 /* Invent our DH secret key */
903 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
905 /* Generate the shared key and set up the transform */
906 set_new_transform(st,m.pk);
911 static bool_t generate_msg4(struct site *st)
913 /* We have both nonces, their public key and our private key. Generate
914 our public key, sign it and send it to them. */
915 return generate_msg(st,LABEL_MSG4,"site:MSG4");
918 static bool_t process_msg4(struct site *st, struct buffer_if *msg4,
919 const struct comm_addr *src)
924 if (!unpick_msg(st,LABEL_MSG4,msg4,&m)) return False;
925 if (!check_msg(st,LABEL_MSG4,&m,&err)) {
926 slog(st,LOG_SEC,"msg4: %s",err);
930 if (!process_msg3_msg4(st,&m))
933 /* Terminate their DH public key with a '0' */
936 /* Generate the shared key and set up the transform */
937 set_new_transform(st,m.pk);
948 static bool_t unpick_msg0(struct site *st, struct buffer_if *msg0,
952 m->dest=buf_unprepend_uint32(msg0);
954 m->source=buf_unprepend_uint32(msg0);
956 m->type=buf_unprepend_uint32(msg0);
958 /* Leaves transformed part of buffer untouched */
961 static bool_t generate_msg5(struct site *st)
963 cstring_t transform_err;
965 BUF_ALLOC(&st->buffer,"site:MSG5");
966 /* We are going to add four words to the message */
967 buffer_init(&st->buffer,calculate_max_start_pad());
968 /* Give the netlink code an opportunity to put its own stuff in the
969 message (configuration information, etc.) */
970 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
971 if (call_transform_forwards(st,st->new_transform,
972 &st->buffer,&transform_err))
974 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
975 buf_prepend_uint32(&st->buffer,st->index);
976 buf_prepend_uint32(&st->buffer,st->setup_session_id);
978 st->retries=st->setup_retries;
982 static bool_t process_msg5(struct site *st, struct buffer_if *msg5,
983 const struct comm_addr *src,
984 struct transform_inst_if *transform)
987 cstring_t transform_err;
989 if (!unpick_msg0(st,msg5,&m)) return False;
991 if (call_transform_reverse(st,transform,msg5,&transform_err)) {
992 /* There's a problem */
993 slog(st,LOG_SEC,"process_msg5: transform: %s",transform_err);
996 /* Buffer should now contain untransformed PING packet data */
998 if (buf_unprepend_uint32(msg5)!=LABEL_MSG5) {
999 slog(st,LOG_SEC,"MSG5/PING packet contained wrong label");
1002 /* Older versions of secnet used to write some config data here
1003 * which we ignore. So we don't CHECK_EMPTY */
1007 static void create_msg6(struct site *st, struct transform_inst_if *transform,
1008 uint32_t session_id)
1010 cstring_t transform_err;
1012 BUF_ALLOC(&st->buffer,"site:MSG6");
1013 /* We are going to add four words to the message */
1014 buffer_init(&st->buffer,calculate_max_start_pad());
1015 /* Give the netlink code an opportunity to put its own stuff in the
1016 message (configuration information, etc.) */
1017 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1018 int problem = call_transform_forwards(st,transform,
1019 &st->buffer,&transform_err);
1021 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1022 buf_prepend_uint32(&st->buffer,st->index);
1023 buf_prepend_uint32(&st->buffer,session_id);
1026 static bool_t generate_msg6(struct site *st)
1028 if (!is_transform_valid(st->new_transform))
1030 create_msg6(st,st->new_transform,st->setup_session_id);
1031 st->retries=1; /* Peer will retransmit MSG5 if this packet gets lost */
1035 static bool_t process_msg6(struct site *st, struct buffer_if *msg6,
1036 const struct comm_addr *src)
1039 cstring_t transform_err;
1041 if (!unpick_msg0(st,msg6,&m)) return False;
1043 if (call_transform_reverse(st,st->new_transform,msg6,&transform_err)) {
1044 /* There's a problem */
1045 slog(st,LOG_SEC,"process_msg6: transform: %s",transform_err);
1048 /* Buffer should now contain untransformed PING packet data */
1049 CHECK_AVAIL(msg6,4);
1050 if (buf_unprepend_uint32(msg6)!=LABEL_MSG6) {
1051 slog(st,LOG_SEC,"MSG6/PONG packet contained invalid data");
1054 /* Older versions of secnet used to write some config data here
1055 * which we ignore. So we don't CHECK_EMPTY */
1059 static bool_t decrypt_msg0(struct site *st, struct buffer_if *msg0,
1060 const struct comm_addr *src)
1062 cstring_t transform_err, auxkey_err, newkey_err="n/a";
1066 if (!unpick_msg0(st,msg0,&m)) return False;
1068 /* Keep a copy so we can try decrypting it with multiple keys */
1069 buffer_copy(&st->scratch, msg0);
1071 problem = call_transform_reverse(st,st->current.transform,
1072 msg0,&transform_err);
1074 if (!st->auxiliary_is_new)
1075 delete_one_key(st,&st->auxiliary_key,
1076 "peer has used new key","auxiliary key",LOG_SEC);
1082 buffer_copy(msg0, &st->scratch);
1083 problem = call_transform_reverse(st,st->auxiliary_key.transform,
1086 slog(st,LOG_DROP,"processing packet which uses auxiliary key");
1087 if (st->auxiliary_is_new) {
1088 /* We previously timed out in state SENTMSG5 but it turns
1089 * out that our peer did in fact get our MSG5 and is
1090 * using the new key. So we should switch to it too. */
1091 /* This is a bit like activate_new_key. */
1094 st->current=st->auxiliary_key;
1095 st->auxiliary_key=t;
1097 delete_one_key(st,&st->auxiliary_key,"peer has used new key",
1098 "previous key",LOG_SEC);
1099 st->auxiliary_is_new=0;
1100 st->renegotiate_key_time=st->auxiliary_renegotiate_key_time;
1107 if (st->state==SITE_SENTMSG5) {
1108 buffer_copy(msg0, &st->scratch);
1109 problem = call_transform_reverse(st,st->new_transform,
1112 /* It looks like we didn't get the peer's MSG6 */
1113 /* This is like a cut-down enter_new_state(SITE_RUN) */
1114 slog(st,LOG_STATE,"will enter state RUN (MSG0 with new key)");
1115 BUF_FREE(&st->buffer);
1117 activate_new_key(st);
1118 return True; /* do process the data in this packet */
1124 slog(st,LOG_SEC,"transform: %s (aux: %s, new: %s)",
1125 transform_err,auxkey_err,newkey_err);
1126 initiate_key_setup(st,"incoming message would not decrypt",0);
1127 send_nak(src,m.dest,m.source,m.type,msg0,"message would not decrypt");
1131 slog(st,LOG_DROP,"transform: %s (merely skew)",transform_err);
1135 static bool_t process_msg0(struct site *st, struct buffer_if *msg0,
1136 const struct comm_addr *src)
1140 if (!decrypt_msg0(st,msg0,src))
1143 CHECK_AVAIL(msg0,4);
1144 type=buf_unprepend_uint32(msg0);
1147 /* We must forget about the current session. */
1148 delete_keys(st,"request from peer",LOG_SEC);
1151 /* Deliver to netlink layer */
1152 st->netlink->deliver(st->netlink->st,msg0);
1153 transport_data_msgok(st,src);
1154 /* See whether we should start negotiating a new key */
1155 if (st->now > st->renegotiate_key_time)
1156 initiate_key_setup(st,"incoming packet in renegotiation window",0);
1159 slog(st,LOG_SEC,"incoming encrypted message of type %08x "
1166 static void dump_packet(struct site *st, struct buffer_if *buf,
1167 const struct comm_addr *addr, bool_t incoming)
1169 uint32_t dest=get_uint32(buf->start);
1170 uint32_t source=get_uint32(buf->start+4);
1171 uint32_t msgtype=get_uint32(buf->start+8);
1173 if (st->log_events & LOG_DUMP)
1174 slilog(st->log,M_DEBUG,"%s: %s: %08x<-%08x: %08x:",
1175 st->tunname,incoming?"incoming":"outgoing",
1176 dest,source,msgtype);
1179 static uint32_t site_status(void *st)
1184 static bool_t send_msg(struct site *st)
1186 if (st->retries>0) {
1187 transport_xmit(st, &st->setup_peers, &st->buffer, True);
1188 st->timeout=st->now+st->setup_retry_interval;
1191 } else if (st->state==SITE_SENTMSG5) {
1192 logtimeout(st,"timed out sending MSG5, stashing new key");
1193 /* We stash the key we have produced, in case it turns out that
1194 * our peer did see our MSG5 after all and starts using it. */
1195 /* This is a bit like some of activate_new_key */
1196 struct transform_inst_if *t;
1197 t=st->auxiliary_key.transform;
1198 st->auxiliary_key.transform=st->new_transform;
1199 st->new_transform=t;
1200 dispose_transform(&st->new_transform);
1202 st->auxiliary_is_new=1;
1203 st->auxiliary_key.key_timeout=st->now+st->key_lifetime;
1204 st->auxiliary_renegotiate_key_time=st->now+st->key_renegotiate_time;
1205 st->auxiliary_key.remote_session_id=st->setup_session_id;
1207 enter_state_wait(st);
1210 logtimeout(st,"timed out sending key setup packet "
1211 "(in state %s)",state_name(st->state));
1212 enter_state_wait(st);
1217 static void site_resolve_callback(void *sst, const struct comm_addr *addrs,
1218 int stored_naddrs, int all_naddrs,
1219 const char *address, const char *failwhy)
1221 struct site *st=sst;
1223 if (!stored_naddrs) {
1224 slog(st,LOG_ERROR,"resolution of %s failed: %s",address,failwhy);
1226 slog(st,LOG_PEER_ADDRS,"resolution of %s completed, %d addrs, eg: %s",
1227 address, all_naddrs, comm_addr_to_string(&addrs[0]));;
1229 int space=st->transport_peers_max-st->resolving_n_results_stored;
1230 int n_tocopy=MIN(stored_naddrs,space);
1231 COPY_ARRAY(st->resolving_results + st->resolving_n_results_stored,
1234 st->resolving_n_results_stored += n_tocopy;
1235 st->resolving_n_results_all += all_naddrs;
1238 decrement_resolving_count(st,1);
1241 static void decrement_resolving_count(struct site *st, int by)
1243 assert(st->resolving_count>0);
1244 st->resolving_count-=by;
1246 if (st->resolving_count)
1249 /* OK, we are done with them all. Handle combined results. */
1251 const struct comm_addr *addrs=st->resolving_results;
1252 int naddrs=st->resolving_n_results_stored;
1253 assert(naddrs<=st->transport_peers_max);
1256 if (naddrs != st->resolving_n_results_all) {
1257 slog(st,LOG_SETUP_INIT,"resolution of supplied addresses/names"
1258 " yielded too many results (%d > %d), some ignored",
1259 st->resolving_n_results_all, naddrs);
1261 slog(st,LOG_STATE,"resolution completed, %d addrs, eg: %s",
1262 naddrs, iaddr_to_string(&addrs[0].ia));;
1265 switch (st->state) {
1267 if (transport_compute_setupinit_peers(st,addrs,naddrs,0)) {
1268 enter_new_state(st,SITE_SENTMSG1);
1270 /* Can't figure out who to try to to talk to */
1271 slog(st,LOG_SETUP_INIT,
1272 "key exchange failed: cannot find peer address");
1273 enter_state_run(st);
1276 case SITE_SENTMSG1: case SITE_SENTMSG2:
1277 case SITE_SENTMSG3: case SITE_SENTMSG4:
1280 /* We start using the address immediately for data too.
1281 * It's best to store it in st->peers now because we might
1282 * go via SENTMSG5, WAIT, and a MSG0, straight into using
1283 * the new key (without updating the data peer addrs). */
1284 transport_resolve_complete(st,addrs,naddrs);
1285 } else if (st->local_mobile) {
1286 /* We can't let this rest because we may have a peer
1287 * address which will break in the future. */
1288 slog(st,LOG_SETUP_INIT,"resolution failed: "
1289 "abandoning key exchange");
1290 enter_state_wait(st);
1292 slog(st,LOG_SETUP_INIT,"resolution failed: "
1293 " continuing to use source address of peer's packets"
1294 " for key exchange and ultimately data");
1299 slog(st,LOG_SETUP_INIT,"resolution completed tardily,"
1300 " updating peer address(es)");
1301 transport_resolve_complete_tardy(st,addrs,naddrs);
1302 } else if (st->local_mobile) {
1303 /* Not very good. We should queue (another) renegotiation
1304 * so that we can update the peer address. */
1305 st->key_renegotiate_time=st->now+st->wait_timeout;
1307 slog(st,LOG_SETUP_INIT,"resolution failed: "
1308 " continuing to use source address of peer's packets");
1318 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
1319 const struct comm_addr *prod_hint)
1321 /* Reentrancy hazard: can call enter_new_state/enter_state_* */
1322 if (st->state!=SITE_RUN) return False;
1323 slog(st,LOG_SETUP_INIT,"initiating key exchange (%s)",reason);
1324 if (st->addresses) {
1325 slog(st,LOG_SETUP_INIT,"resolving peer address(es)");
1326 return enter_state_resolve(st);
1327 } else if (transport_compute_setupinit_peers(st,0,0,prod_hint)) {
1328 return enter_new_state(st,SITE_SENTMSG1);
1330 slog(st,LOG_SETUP_INIT,"key exchange failed: no address for peer");
1334 static void activate_new_key(struct site *st)
1336 struct transform_inst_if *t;
1338 /* We have three transform instances, which we swap between old,
1340 t=st->auxiliary_key.transform;
1341 st->auxiliary_key.transform=st->current.transform;
1342 st->current.transform=st->new_transform;
1343 st->new_transform=t;
1344 dispose_transform(&st->new_transform);
1347 st->auxiliary_is_new=0;
1348 st->auxiliary_key.key_timeout=st->current.key_timeout;
1349 st->current.key_timeout=st->now+st->key_lifetime;
1350 st->renegotiate_key_time=st->now+st->key_renegotiate_time;
1351 transport_peers_copy(st,&st->peers,&st->setup_peers);
1352 st->current.remote_session_id=st->setup_session_id;
1354 /* Compute the inter-site MTU. This is min( our_mtu, their_mtu ).
1355 * But their mtu be unspecified, in which case we just use ours. */
1356 uint32_t intersite_mtu=
1357 MIN(st->mtu_target, st->remote_adv_mtu ?: ~(uint32_t)0);
1358 st->netlink->set_mtu(st->netlink->st,intersite_mtu);
1360 slog(st,LOG_ACTIVATE_KEY,"new key activated"
1361 " (mtu ours=%"PRId32" theirs=%"PRId32" intersite=%"PRId32")",
1362 st->mtu_target, st->remote_adv_mtu, intersite_mtu);
1363 enter_state_run(st);
1366 static void delete_one_key(struct site *st, struct data_key *key,
1367 cstring_t reason, cstring_t which, uint32_t loglevel)
1369 if (!is_transform_valid(key->transform)) return;
1370 if (reason) slog(st,loglevel,"%s deleted (%s)",which,reason);
1371 dispose_transform(&key->transform);
1375 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel)
1377 if (current_valid(st)) {
1378 slog(st,loglevel,"session closed (%s)",reason);
1380 delete_one_key(st,&st->current,0,0,0);
1381 set_link_quality(st);
1383 delete_one_key(st,&st->auxiliary_key,0,0,0);
1386 static void state_assert(struct site *st, bool_t ok)
1388 if (!ok) fatal("site:state_assert");
1391 static void enter_state_stop(struct site *st)
1393 st->state=SITE_STOP;
1395 delete_keys(st,"entering state STOP",LOG_TIMEOUT_KEY);
1396 dispose_transform(&st->new_transform);
1399 static void set_link_quality(struct site *st)
1402 if (current_valid(st))
1403 quality=LINK_QUALITY_UP;
1404 else if (st->state==SITE_WAIT || st->state==SITE_STOP)
1405 quality=LINK_QUALITY_DOWN;
1406 else if (st->addresses)
1407 quality=LINK_QUALITY_DOWN_CURRENT_ADDRESS;
1408 else if (transport_peers_valid(&st->peers))
1409 quality=LINK_QUALITY_DOWN_STALE_ADDRESS;
1411 quality=LINK_QUALITY_DOWN;
1413 st->netlink->set_quality(st->netlink->st,quality);
1416 static void enter_state_run(struct site *st)
1418 slog(st,LOG_STATE,"entering state RUN");
1422 st->setup_session_id=0;
1423 transport_peers_clear(st,&st->setup_peers);
1424 FILLZERO(st->localN);
1425 FILLZERO(st->remoteN);
1426 dispose_transform(&st->new_transform);
1427 memset(st->dhsecret,0,st->dh->len);
1428 memset(st->sharedsecret,0,st->sharedsecretlen);
1429 set_link_quality(st);
1432 static bool_t ensure_resolving(struct site *st)
1434 /* Reentrancy hazard: may call site_resolve_callback and hence
1435 * enter_new_state, enter_state_* and generate_msg*. */
1436 if (st->resolving_count)
1439 assert(st->addresses);
1441 /* resolver->request might reentrantly call site_resolve_callback
1442 * which will decrement st->resolving, so we need to increment it
1443 * twice beforehand to prevent decrement from thinking we're
1444 * finished, and decrement it ourselves. Alternatively if
1445 * everything fails then there are no callbacks due and we simply
1446 * set it to 0 and return false.. */
1447 st->resolving_n_results_stored=0;
1448 st->resolving_n_results_all=0;
1449 st->resolving_count+=2;
1450 const char **addrp=st->addresses;
1451 const char *address;
1453 for (; (address=*addrp++); ) {
1454 bool_t ok = st->resolver->request(st->resolver->st,address,
1455 st->remoteport,st->comms[0],
1456 site_resolve_callback,st);
1458 st->resolving_count++;
1462 st->resolving_count=0;
1465 decrement_resolving_count(st,2);
1469 static bool_t enter_state_resolve(struct site *st)
1471 /* Reentrancy hazard! See ensure_resolving. */
1472 state_assert(st,st->state==SITE_RUN);
1473 slog(st,LOG_STATE,"entering state RESOLVE");
1474 st->state=SITE_RESOLVE;
1475 return ensure_resolving(st);
1478 static bool_t enter_new_state(struct site *st, uint32_t next)
1480 bool_t (*gen)(struct site *st);
1483 slog(st,LOG_STATE,"entering state %s",state_name(next));
1486 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
1490 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1491 st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
1495 state_assert(st,st->state==SITE_SENTMSG1);
1496 BUF_FREE(&st->buffer);
1500 state_assert(st,st->state==SITE_SENTMSG2);
1501 BUF_FREE(&st->buffer);
1505 state_assert(st,st->state==SITE_SENTMSG3);
1506 BUF_FREE(&st->buffer);
1510 state_assert(st,st->state==SITE_SENTMSG4);
1511 BUF_FREE(&st->buffer);
1516 fatal("enter_new_state(%s): invalid new state",state_name(next));
1520 if (hacky_par_start_failnow()) return False;
1522 r= gen(st) && send_msg(st);
1525 st->setup_retries, st->setup_retry_interval,
1530 if (next==SITE_RUN) {
1531 BUF_FREE(&st->buffer); /* Never reused */
1532 st->timeout=0; /* Never retransmit */
1533 activate_new_key(st);
1537 slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1538 st->buffer.free=False; /* Unconditionally use the buffer; it may be
1539 in either state, and enter_state_wait() will
1541 enter_state_wait(st);
1545 /* msg7 tells our peer that we're about to forget our key */
1546 static bool_t send_msg7(struct site *st, cstring_t reason)
1548 cstring_t transform_err;
1550 if (current_valid(st) && st->buffer.free
1551 && transport_peers_valid(&st->peers)) {
1552 BUF_ALLOC(&st->buffer,"site:MSG7");
1553 buffer_init(&st->buffer,calculate_max_start_pad());
1554 buf_append_uint32(&st->buffer,LABEL_MSG7);
1555 buf_append_string(&st->buffer,reason);
1556 if (call_transform_forwards(st, st->current.transform,
1557 &st->buffer, &transform_err))
1559 buf_prepend_uint32(&st->buffer,LABEL_MSG0);
1560 buf_prepend_uint32(&st->buffer,st->index);
1561 buf_prepend_uint32(&st->buffer,st->current.remote_session_id);
1562 transport_xmit(st,&st->peers,&st->buffer,True);
1563 BUF_FREE(&st->buffer);
1570 /* We go into this state if our peer becomes uncommunicative. Similar to
1571 the "stop" state, we forget all session keys for a while, before
1572 re-entering the "run" state. */
1573 static void enter_state_wait(struct site *st)
1575 slog(st,LOG_STATE,"entering state WAIT");
1576 st->timeout=st->now+st->wait_timeout;
1577 st->state=SITE_WAIT;
1578 set_link_quality(st);
1579 BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1580 /* XXX Erase keys etc. */
1583 static void generate_prod(struct site *st, struct buffer_if *buf)
1586 buf_append_uint32(buf,0);
1587 buf_append_uint32(buf,0);
1588 buf_append_uint32(buf,LABEL_PROD);
1589 buf_append_string(buf,st->localname);
1590 buf_append_string(buf,st->remotename);
1593 static void generate_send_prod(struct site *st,
1594 const struct comm_addr *source)
1596 if (!st->allow_send_prod) return; /* too soon */
1597 if (!(st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1598 st->state==SITE_WAIT)) return; /* we'd ignore peer's MSG1 */
1600 slog(st,LOG_SETUP_INIT,"prodding peer for key exchange");
1601 st->allow_send_prod=0;
1602 generate_prod(st,&st->scratch);
1603 dump_packet(st,&st->scratch,source,False);
1604 source->comm->sendmsg(source->comm->st, &st->scratch, source);
1607 static inline void site_settimeout(uint64_t timeout, int *timeout_io)
1610 int64_t offset=timeout-*now;
1611 if (offset<0) offset=0;
1612 if (offset>INT_MAX) offset=INT_MAX;
1613 if (*timeout_io<0 || offset<*timeout_io)
1618 static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
1621 struct site *st=sst;
1623 BEFOREPOLL_WANT_FDS(0); /* We don't use any file descriptors */
1626 /* Work out when our next timeout is. The earlier of 'timeout' or
1627 'current.key_timeout'. A stored value of '0' indicates no timeout
1629 site_settimeout(st->timeout, timeout_io);
1630 site_settimeout(st->current.key_timeout, timeout_io);
1631 site_settimeout(st->auxiliary_key.key_timeout, timeout_io);
1633 return 0; /* success */
1636 static void check_expiry(struct site *st, struct data_key *key,
1639 if (key->key_timeout && *now>key->key_timeout) {
1640 delete_one_key(st,key,"maximum life exceeded",which,LOG_TIMEOUT_KEY);
1644 /* NB site_afterpoll will be called before site_beforepoll is ever called */
1645 static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
1647 struct site *st=sst;
1650 if (st->timeout && *now>st->timeout) {
1652 if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
1653 if (!hacky_par_start_failnow())
1655 } else if (st->state==SITE_WAIT) {
1656 enter_state_run(st);
1658 slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
1662 check_expiry(st,&st->current,"current key");
1663 check_expiry(st,&st->auxiliary_key,"auxiliary key");
1666 /* This function is called by the netlink device to deliver packets
1667 intended for the remote network. The packet is in "raw" wire
1668 format, but is guaranteed to be word-aligned. */
1669 static void site_outgoing(void *sst, struct buffer_if *buf)
1671 struct site *st=sst;
1672 cstring_t transform_err;
1674 if (st->state==SITE_STOP) {
1679 st->allow_send_prod=1;
1681 /* In all other states we consider delivering the packet if we have
1682 a valid key and a valid address to send it to. */
1683 if (current_valid(st) && transport_peers_valid(&st->peers)) {
1684 /* Transform it and send it */
1686 buf_prepend_uint32(buf,LABEL_MSG9);
1687 if (call_transform_forwards(st, st->current.transform,
1688 buf, &transform_err))
1690 buf_prepend_uint32(buf,LABEL_MSG0);
1691 buf_prepend_uint32(buf,st->index);
1692 buf_prepend_uint32(buf,st->current.remote_session_id);
1693 transport_xmit(st,&st->peers,buf,False);
1700 slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
1702 initiate_key_setup(st,"outgoing packet",0);
1705 static bool_t named_for_us(struct site *st, const struct buffer_if *buf_in,
1706 uint32_t type, struct msg *m)
1707 /* For packets which are identified by the local and remote names.
1708 * If it has our name and our peer's name in it it's for us. */
1710 struct buffer_if buf[1];
1711 buffer_readonly_clone(buf,buf_in);
1712 return unpick_msg(st,type,buf,m)
1713 && name_matches(&m->remote,st->remotename)
1714 && name_matches(&m->local,st->localname);
1717 /* This function is called by the communication device to deliver
1718 packets from our peers.
1719 It should return True if the packet is recognised as being for
1720 this current site instance (and should therefore not be processed
1721 by other sites), even if the packet was otherwise ignored. */
1722 static bool_t site_incoming(void *sst, struct buffer_if *buf,
1723 const struct comm_addr *source)
1725 struct site *st=sst;
1727 if (buf->size < 12) return False;
1729 uint32_t dest=get_uint32(buf->start);
1730 uint32_t msgtype=get_uint32(buf->start+8);
1731 struct msg named_msg;
1733 if (msgtype==LABEL_MSG1) {
1734 if (!named_for_us(st,buf,msgtype,&named_msg))
1736 /* It's a MSG1 addressed to us. Decide what to do about it. */
1737 dump_packet(st,buf,source,True);
1738 if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1739 st->state==SITE_WAIT) {
1740 /* We should definitely process it */
1741 transport_compute_setupinit_peers(st,0,0,source);
1742 if (process_msg1(st,buf,source,&named_msg)) {
1743 slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
1744 bool_t entered=enter_new_state(st,SITE_SENTMSG2);
1745 if (entered && st->addresses && st->local_mobile)
1746 /* We must do this as the very last thing, because
1747 the resolver callback might reenter us. */
1748 ensure_resolving(st);
1750 slog(st,LOG_ERROR,"failed to process incoming msg1");
1754 } else if (st->state==SITE_SENTMSG1) {
1755 /* We've just sent a message 1! They may have crossed on
1756 the wire. If we have priority then we ignore the
1757 incoming one, otherwise we process it as usual. */
1758 if (st->setup_priority) {
1760 slog(st,LOG_DUMP,"crossed msg1s; we are higher "
1761 "priority => ignore incoming msg1");
1764 slog(st,LOG_DUMP,"crossed msg1s; we are lower "
1765 "priority => use incoming msg1");
1766 if (process_msg1(st,buf,source,&named_msg)) {
1767 BUF_FREE(&st->buffer); /* Free our old message 1 */
1768 transport_setup_msgok(st,source);
1769 enter_new_state(st,SITE_SENTMSG2);
1771 slog(st,LOG_ERROR,"failed to process an incoming "
1772 "crossed msg1 (we have low priority)");
1778 /* The message 1 was received at an unexpected stage of the
1779 key setup. XXX POLICY - what do we do? */
1780 slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
1784 if (msgtype==LABEL_PROD) {
1785 if (!named_for_us(st,buf,msgtype,&named_msg))
1787 dump_packet(st,buf,source,True);
1788 if (st->state!=SITE_RUN) {
1789 slog(st,LOG_DROP,"ignoring PROD when not in state RUN");
1790 } else if (current_valid(st)) {
1791 slog(st,LOG_DROP,"ignoring PROD when we think we have a key");
1793 initiate_key_setup(st,"peer sent PROD packet",source);
1798 if (dest==st->index) {
1799 /* Explicitly addressed to us */
1800 if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True);
1803 /* If the source is our current peer then initiate a key setup,
1804 because our peer's forgotten the key */
1805 if (get_uint32(buf->start+4)==st->current.remote_session_id) {
1807 initiated = initiate_key_setup(st,"received a NAK",source);
1808 if (!initiated) generate_send_prod(st,source);
1810 slog(st,LOG_SEC,"bad incoming NAK");
1814 process_msg0(st,buf,source);
1817 /* Setup packet: should not have been explicitly addressed
1819 slog(st,LOG_SEC,"incoming explicitly addressed msg1");
1822 /* Setup packet: expected only in state SENTMSG1 */
1823 if (st->state!=SITE_SENTMSG1) {
1824 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
1825 } else if (process_msg2(st,buf,source)) {
1826 transport_setup_msgok(st,source);
1827 enter_new_state(st,SITE_SENTMSG3);
1829 slog(st,LOG_SEC,"invalid MSG2");
1834 /* Setup packet: expected only in state SENTMSG2 */
1835 if (st->state!=SITE_SENTMSG2) {
1836 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
1837 } else if (process_msg3(st,buf,source,msgtype)) {
1838 transport_setup_msgok(st,source);
1839 enter_new_state(st,SITE_SENTMSG4);
1841 slog(st,LOG_SEC,"invalid MSG3");
1845 /* Setup packet: expected only in state SENTMSG3 */
1846 if (st->state!=SITE_SENTMSG3) {
1847 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
1848 } else if (process_msg4(st,buf,source)) {
1849 transport_setup_msgok(st,source);
1850 enter_new_state(st,SITE_SENTMSG5);
1852 slog(st,LOG_SEC,"invalid MSG4");
1856 /* Setup packet: expected only in state SENTMSG4 */
1857 /* (may turn up in state RUN if our return MSG6 was lost
1858 and the new key has already been activated. In that
1859 case we discard it. The peer will realise that we
1860 are using the new key when they see our data packets.
1861 Until then the peer's data packets to us get discarded. */
1862 if (st->state==SITE_SENTMSG4) {
1863 if (process_msg5(st,buf,source,st->new_transform)) {
1864 transport_setup_msgok(st,source);
1865 enter_new_state(st,SITE_RUN);
1867 slog(st,LOG_SEC,"invalid MSG5");
1869 } else if (st->state==SITE_RUN) {
1870 if (process_msg5(st,buf,source,st->current.transform)) {
1871 slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
1872 transport_setup_msgok(st,source);
1873 create_msg6(st,st->current.transform,
1874 st->current.remote_session_id);
1875 transport_xmit(st,&st->peers,&st->buffer,True);
1876 BUF_FREE(&st->buffer);
1878 slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
1881 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
1885 /* Setup packet: expected only in state SENTMSG5 */
1886 if (st->state!=SITE_SENTMSG5) {
1887 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
1888 } else if (process_msg6(st,buf,source)) {
1889 BUF_FREE(&st->buffer); /* Free message 5 */
1890 transport_setup_msgok(st,source);
1891 activate_new_key(st);
1893 slog(st,LOG_SEC,"invalid MSG6");
1897 slog(st,LOG_SEC,"received message of unknown type 0x%08x",
1908 static void site_control(void *vst, bool_t run)
1910 struct site *st=vst;
1911 if (run) enter_state_run(st);
1912 else enter_state_stop(st);
1915 static void site_phase_hook(void *sst, uint32_t newphase)
1917 struct site *st=sst;
1919 /* The program is shutting down; tell our peer */
1920 send_msg7(st,"shutting down");
1923 static void site_childpersist_clearkeys(void *sst, uint32_t newphase)
1925 struct site *st=sst;
1926 dispose_transform(&st->current.transform);
1927 dispose_transform(&st->auxiliary_key.transform);
1928 dispose_transform(&st->new_transform);
1929 /* Not much point overwiting the signing key, since we loaded it
1930 from disk, and it is only valid prospectively if at all,
1932 /* XXX it would be best to overwrite the DH state, because that
1933 _is_ relevant to forward secrecy. However we have no
1934 convenient interface for doing that and in practice gmp has
1935 probably dribbled droppings all over the malloc arena. A good
1936 way to fix this would be to have a privsep child for asymmetric
1937 crypto operations, but that's a task for another day. */
1940 static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
1943 static uint32_t index_sequence;
1951 st->cl.description="site";
1952 st->cl.type=CL_SITE;
1954 st->cl.interface=&st->ops;
1956 st->ops.control=site_control;
1957 st->ops.status=site_status;
1959 /* First parameter must be a dict */
1960 item=list_elem(args,0);
1961 if (!item || item->type!=t_dict)
1962 cfgfatal(loc,"site","parameter must be a dictionary\n");
1964 dict=item->data.dict;
1965 st->localname=dict_read_string(dict, "local-name", True, "site", loc);
1966 st->remotename=dict_read_string(dict, "name", True, "site", loc);
1968 st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
1970 dict_read_bool(dict,"local-mobile",False,"site",loc,False);
1972 /* Sanity check (which also allows the 'sites' file to include
1973 site() closures for all sites including our own): refuse to
1974 talk to ourselves */
1975 if (strcmp(st->localname,st->remotename)==0) {
1976 Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
1978 if (st->peer_mobile != st->local_mobile)
1979 cfgfatal(loc,"site","site %s's peer-mobile=%d"
1980 " but our local-mobile=%d\n",
1981 st->localname, st->peer_mobile, st->local_mobile);
1985 if (st->peer_mobile && st->local_mobile) {
1986 Message(M_WARNING,"site %s: site is mobile but so are we"
1987 " -> ignoring this site\n", st->remotename);
1992 assert(index_sequence < 0xffffffffUL);
1993 st->index = ++index_sequence;
1994 st->local_capabilities = 0;
1995 st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
1997 #define GET_CLOSURE_LIST(dictkey,things,nthings,CL_TYPE) do{ \
1998 list_t *things##_cfg=dict_lookup(dict,dictkey); \
1999 if (!things##_cfg) \
2000 cfgfatal(loc,"site","closure list \"%s\" not found\n",dictkey); \
2001 st->nthings=list_length(things##_cfg); \
2002 NEW_ARY(st->things,st->nthings); \
2003 assert(st->nthings); \
2004 for (i=0; i<st->nthings; i++) { \
2005 item_t *item=list_elem(things##_cfg,i); \
2006 if (item->type!=t_closure) \
2007 cfgfatal(loc,"site","%s is not a closure\n",dictkey); \
2008 closure_t *cl=item->data.closure; \
2009 if (cl->type!=CL_TYPE) \
2010 cfgfatal(loc,"site","%s closure wrong type\n",dictkey); \
2011 st->things[i]=cl->interface; \
2015 GET_CLOSURE_LIST("comm",comms,ncomms,CL_COMM);
2017 st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
2018 st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
2019 st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
2021 st->privkey=find_cl_if(dict,"local-key",CL_RSAPRIVKEY,True,"site",loc);
2022 st->addresses=dict_read_string_array(dict,"address",False,"site",loc,0);
2024 st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
2025 else st->remoteport=0;
2026 st->pubkey=find_cl_if(dict,"key",CL_RSAPUBKEY,True,"site",loc);
2028 GET_CLOSURE_LIST("transform",transforms,ntransforms,CL_TRANSFORM);
2030 st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
2031 st->hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
2033 #define DEFAULT(D) (st->peer_mobile || st->local_mobile \
2034 ? DEFAULT_MOBILE_##D : DEFAULT_##D)
2035 #define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
2037 st->key_lifetime= CFG_NUMBER("key-lifetime", KEY_LIFETIME);
2038 st->setup_retries= CFG_NUMBER("setup-retries", SETUP_RETRIES);
2039 st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
2040 st->wait_timeout= CFG_NUMBER("wait-time", WAIT_TIME);
2041 st->mtu_target= dict_read_number(dict,"mtu-target",False,"site",loc,0);
2043 st->mobile_peer_expiry= dict_read_number(
2044 dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
2046 const char *peerskey= st->peer_mobile
2047 ? "mobile-peers-max" : "static-peers-max";
2048 st->transport_peers_max= dict_read_number(
2049 dict,peerskey,False,"site",loc, st->addresses ? 4 : 3);
2050 if (st->transport_peers_max<1 ||
2051 st->transport_peers_max>MAX_PEER_ADDRS) {
2052 cfgfatal(loc,"site", "%s must be in range 1.."
2053 STRING(MAX_PEER_ADDRS) "\n", peerskey);
2056 if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
2057 st->key_renegotiate_time=st->key_lifetime/2;
2059 st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
2060 st->key_renegotiate_time=dict_read_number(
2061 dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
2062 if (st->key_renegotiate_time > st->key_lifetime) {
2063 cfgfatal(loc,"site",
2064 "renegotiate-time must be less than key-lifetime\n");
2067 st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
2068 log_event_table,"site");
2070 st->resolving_count=0;
2071 st->allow_send_prod=0;
2073 st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
2075 sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
2077 /* The information we expect to see in incoming messages of type 1 */
2078 /* fixme: lots of unchecked overflows here, but the results are only
2079 corrupted packets rather than undefined behaviour */
2080 st->setup_priority=(strcmp(st->localname,st->remotename)>0);
2082 buffer_new(&st->buffer,SETUP_BUFFER_LEN);
2084 buffer_new(&st->scratch,SETUP_BUFFER_LEN);
2085 BUF_ALLOC(&st->scratch,"site:scratch");
2087 /* We are interested in poll(), but only for timeouts. We don't have
2088 any fds of our own. */
2089 register_for_poll(st, site_beforepoll, site_afterpoll, "site");
2092 st->remote_capabilities=0;
2093 st->chosen_transform=0;
2094 st->current.key_timeout=0;
2095 st->auxiliary_key.key_timeout=0;
2096 transport_peers_clear(st,&st->peers);
2097 transport_peers_clear(st,&st->setup_peers);
2098 /* XXX mlock these */
2099 st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
2100 st->sharedsecretlen=st->sharedsecretallocd=0;
2103 for (i=0; i<st->ntransforms; i++) {
2104 struct transform_if *ti=st->transforms[i];
2105 uint32_t capbit = 1UL << ti->capab_transformnum;
2106 if (st->local_capabilities & capbit)
2107 slog(st,LOG_ERROR,"transformnum capability bit"
2108 " %d (%#"PRIx32") reused", ti->capab_transformnum, capbit);
2109 st->local_capabilities |= capbit;
2112 /* We need to register the remote networks with the netlink device */
2113 uint32_t netlink_mtu; /* local virtual interface mtu */
2114 st->netlink->reg(st->netlink->st, site_outgoing, st, &netlink_mtu);
2115 if (!st->mtu_target)
2116 st->mtu_target=netlink_mtu;
2118 for (i=0; i<st->ncomms; i++)
2119 st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
2121 st->current.transform=0;
2122 st->auxiliary_key.transform=0;
2123 st->new_transform=0;
2124 st->auxiliary_is_new=0;
2126 enter_state_stop(st);
2128 add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
2129 add_hook(PHASE_CHILDPERSIST,site_childpersist_clearkeys,st);
2131 return new_closure(&st->cl);
2134 void site_module(dict_t *dict)
2136 add_closure(dict,"site",site_apply);
2140 /***** TRANSPORT PEERS definitions *****/
2142 static void transport_peers_debug(struct site *st, transport_peers *dst,
2143 const char *didwhat,
2144 int nargs, const struct comm_addr *args,
2149 if (!(st->log_events & LOG_PEER_ADDRS))
2150 return; /* an optimisation */
2152 slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
2153 (dst==&st->peers ? "data" :
2154 dst==&st->setup_peers ? "setup" : "UNKNOWN"),
2155 didwhat, nargs, dst->npeers);
2157 for (i=0, argp=(void*)args;
2159 i++, (argp+=stride?stride:sizeof(*args))) {
2160 const struct comm_addr *ca=(void*)argp;
2161 slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
2162 i, comm_addr_to_string(ca));
2164 for (i=0; i<dst->npeers; i++) {
2165 struct timeval diff;
2166 timersub(tv_now,&dst->peers[i].last,&diff);
2167 const struct comm_addr *ca=&dst->peers[i].addr;
2168 slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
2169 i, comm_addr_to_string(ca),
2170 (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
2174 static void transport_peers_expire(struct site *st, transport_peers *peers) {
2175 /* peers must be sorted first */
2176 int previous_peers=peers->npeers;
2177 struct timeval oldest;
2178 oldest.tv_sec = tv_now->tv_sec - st->mobile_peer_expiry;
2179 oldest.tv_usec = tv_now->tv_usec;
2180 while (peers->npeers>1 &&
2181 timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
2183 if (peers->npeers != previous_peers)
2184 transport_peers_debug(st,peers,"expire", 0,0,0);
2187 static bool_t transport_peer_record_one(struct site *st, transport_peers *peers,
2188 const struct comm_addr *ca,
2189 const struct timeval *tv) {
2190 /* returns false if output is full */
2193 if (peers->npeers >= st->transport_peers_max)
2196 for (search=0; search<peers->npeers; search++)
2197 if (comm_addr_equal(&peers->peers[search].addr, ca))
2200 peers->peers[peers->npeers].addr = *ca;
2201 peers->peers[peers->npeers].last = *tv;
2206 static void transport_record_peers(struct site *st, transport_peers *peers,
2207 const struct comm_addr *addrs, int naddrs,
2209 /* We add addrs into peers. The new entries end up at the front
2210 * and displace entries towards the end (perhaps even off the
2211 * end). Any existing matching entries are moved up to the front.
2213 * Caller must first call transport_peers_expire. */
2215 if (naddrs==1 && peers->npeers>=1 &&
2216 comm_addr_equal(&addrs[0], &peers->peers[0].addr)) {
2217 /* optimisation, also avoids debug for trivial updates */
2218 peers->peers[0].last = *tv_now;
2222 int old_npeers=peers->npeers;
2223 transport_peer old_peers[old_npeers];
2224 COPY_ARRAY(old_peers,peers->peers,old_npeers);
2228 for (i=0; i<naddrs; i++) {
2229 if (!transport_peer_record_one(st,peers, &addrs[i], tv_now))
2232 for (i=0; i<old_npeers; i++) {
2233 const transport_peer *old=&old_peers[i];
2234 if (!transport_peer_record_one(st,peers, &old->addr, &old->last))
2238 transport_peers_debug(st,peers,m, naddrs,addrs,0);
2241 static void transport_expire_record_peers(struct site *st,
2242 transport_peers *peers,
2243 const struct comm_addr *addrs,
2244 int naddrs, const char *m) {
2245 /* Convenience function */
2246 transport_peers_expire(st,peers);
2247 transport_record_peers(st,peers,addrs,naddrs,m);
2250 static bool_t transport_compute_setupinit_peers(struct site *st,
2251 const struct comm_addr *configured_addrs /* 0 if none or not found */,
2252 int n_configured_addrs /* 0 if none or not found */,
2253 const struct comm_addr *incoming_packet_addr /* 0 if none */) {
2254 if (!n_configured_addrs && !incoming_packet_addr &&
2255 !transport_peers_valid(&st->peers))
2258 slog(st,LOG_SETUP_INIT,
2259 "using: %d configured addr(s);%s %d old peer addrs(es)",
2261 incoming_packet_addr ? " incoming packet address;" : "",
2264 /* Non-mobile peers try addresses until one is plausible. The
2265 * effect is that this code always tries first the configured
2266 * address if supplied, or otherwise the address of the incoming
2267 * PROD, or finally the existing data peer if one exists; this is
2270 transport_peers_copy(st,&st->setup_peers,&st->peers);
2271 transport_peers_expire(st,&st->setup_peers);
2273 if (incoming_packet_addr)
2274 transport_record_peers(st,&st->setup_peers,
2275 incoming_packet_addr,1, "incoming");
2277 if (n_configured_addrs)
2278 transport_record_peers(st,&st->setup_peers,
2279 configured_addrs,n_configured_addrs, "setupinit");
2281 assert(transport_peers_valid(&st->setup_peers));
2285 static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
2286 if (st->peer_mobile)
2287 transport_expire_record_peers(st,&st->setup_peers,a,1,"setupmsg");
2289 static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
2290 if (st->peer_mobile)
2291 transport_expire_record_peers(st,&st->peers,a,1,"datamsg");
2294 static int transport_peers_valid(transport_peers *peers) {
2295 return peers->npeers;
2297 static void transport_peers_clear(struct site *st, transport_peers *peers) {
2299 transport_peers_debug(st,peers,"clear",0,0,0);
2301 static void transport_peers_copy(struct site *st, transport_peers *dst,
2302 const transport_peers *src) {
2303 dst->npeers=src->npeers;
2304 COPY_ARRAY(dst->peers, src->peers, dst->npeers);
2305 transport_peers_debug(st,dst,"copy",
2306 src->npeers, &src->peers->addr, sizeof(*src->peers));
2309 static void transport_resolve_complete(struct site *st,
2310 const struct comm_addr *addrs,
2312 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2314 transport_expire_record_peers(st,&st->setup_peers,addrs,naddrs,
2318 static void transport_resolve_complete_tardy(struct site *st,
2319 const struct comm_addr *addrs,
2321 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2322 "resolved tardily");
2325 static void transport_peers__copy_by_mask(transport_peer *out, int *nout_io,
2327 const transport_peers *inp) {
2328 /* out and in->peers may be the same region, or nonoverlapping */
2329 const transport_peer *in=inp->peers;
2331 for (slot=0; slot<inp->npeers; slot++) {
2332 if (!(mask & (1U << slot)))
2334 if (!(out==in && slot==*nout_io))
2335 COPY_OBJ(out[*nout_io], in[slot]);
2340 void transport_xmit(struct site *st, transport_peers *peers,
2341 struct buffer_if *buf, bool_t candebug) {
2343 transport_peers_expire(st, peers);
2344 unsigned failed=0; /* bitmask */
2345 assert(MAX_PEER_ADDRS < sizeof(unsigned)*CHAR_BIT);
2348 for (slot=0; slot<peers->npeers; slot++) {
2349 transport_peer *peer=&peers->peers[slot];
2351 dump_packet(st, buf, &peer->addr, False);
2353 peer->addr.comm->sendmsg(peer->addr.comm->st, buf, &peer->addr);
2355 failed |= 1U << slot;
2358 if (ok && !st->peer_mobile)
2361 /* Now we need to demote/delete failing addrs: if we are mobile we
2362 * merely demote them; otherwise we delete them. */
2363 if (st->local_mobile) {
2364 unsigned expected = ((1U << nfailed)-1) << (peers->npeers-nfailed);
2365 /* `expected' has all the failures at the end already */
2366 if (failed != expected) {
2368 transport_peer failedpeers[nfailed];
2369 transport_peers__copy_by_mask(failedpeers, &fslot, failed,peers);
2370 assert(fslot == nfailed);
2372 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2373 assert(wslot+nfailed == peers->npeers);
2374 COPY_ARRAY(peers->peers+wslot, failedpeers, nfailed);
2377 if (failed && peers->npeers > 1) {
2379 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2380 peers->npeers=wslot;
2385 /***** END of transport peers declarations *****/