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 3 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 */
300 bool_t local_mobile, peer_mobile; /* Mobile client support */
301 int32_t transport_peers_max;
302 string_t tunname; /* localname<->remotename by default, used in logs */
303 cstring_t *addresses; /* DNS name or address(es) for bootstrapping, optional */
304 int remoteport; /* Port for bootstrapping, optional */
306 struct netlink_if *netlink;
307 struct comm_if **comms;
308 struct comm_clientinfo **commclientinfos;
310 struct resolver_if *resolver;
312 struct random_if *random;
313 struct rsaprivkey_if *privkey;
314 struct rsapubkey_if *pubkey;
315 struct transform_if **transforms;
318 struct hash_if *hash;
320 uint32_t index; /* Index of this site */
321 uint32_t local_capabilities;
322 int32_t setup_retries; /* How many times to send setup packets */
323 int32_t setup_retry_interval; /* Initial timeout for setup packets */
324 int32_t wait_timeout; /* How long to wait if setup unsuccessful */
325 int32_t mobile_peer_expiry; /* How long to remember 2ary addresses */
326 int32_t key_lifetime; /* How long a key lasts once set up */
327 int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
328 after this time, initiate a new
331 bool_t setup_priority; /* Do we have precedence if both sites emit
332 message 1 simultaneously? */
335 /* runtime information */
337 uint64_t now; /* Most recently seen time */
338 bool_t allow_send_prod;
340 int resolving_n_results_all;
341 int resolving_n_results_stored;
342 struct comm_addr resolving_results[MAX_PEER_ADDRS];
344 /* The currently established session */
345 struct data_key current;
346 struct data_key auxiliary_key;
347 bool_t auxiliary_is_new;
348 uint64_t renegotiate_key_time; /* When we can negotiate a new key */
349 uint64_t auxiliary_renegotiate_key_time;
350 transport_peers peers; /* Current address(es) of peer for data traffic */
352 /* The current key setup protocol exchange. We can only be
353 involved in one of these at a time. There's a potential for
354 denial of service here (the attacker keeps sending a setup
355 packet; we keep trying to continue the exchange, and have to
356 timeout before we can listen for another setup packet); perhaps
357 we should keep a list of 'bad' sources for setup packets. */
358 uint32_t remote_capabilities;
359 uint16_t remote_adv_mtu;
360 struct transform_if *chosen_transform;
361 uint32_t setup_session_id;
362 transport_peers setup_peers;
363 uint8_t localN[NONCELEN]; /* Nonces for key exchange */
364 uint8_t remoteN[NONCELEN];
365 struct buffer_if buffer; /* Current outgoing key exchange packet */
366 struct buffer_if scratch;
367 int32_t retries; /* Number of retries remaining */
368 uint64_t timeout; /* Timeout for current state */
370 uint8_t *sharedsecret;
371 uint32_t sharedsecretlen, sharedsecretallocd;
372 struct transform_inst_if *new_transform; /* For key setup/verify */
375 static uint32_t event_log_priority(struct site *st, uint32_t event)
377 if (!(event&st->log_events))
380 case LOG_UNEXPECTED: return M_INFO;
381 case LOG_SETUP_INIT: return M_INFO;
382 case LOG_SETUP_TIMEOUT: return M_NOTICE;
383 case LOG_ACTIVATE_KEY: return M_INFO;
384 case LOG_TIMEOUT_KEY: return M_INFO;
385 case LOG_SEC: return M_SECURITY;
386 case LOG_STATE: return M_DEBUG;
387 case LOG_DROP: return M_DEBUG;
388 case LOG_DUMP: return M_DEBUG;
389 case LOG_ERROR: return M_ERR;
390 case LOG_PEER_ADDRS: return M_DEBUG;
391 default: return M_ERR;
395 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
397 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
401 class=event_log_priority(st, event);
403 slilog_part(st->log,class,"%s: ",st->tunname);
404 vslilog_part(st->log,class,msg,ap);
405 slilog_part(st->log,class,"\n");
409 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
411 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
415 vslog(st,event,msg,ap);
419 static void logtimeout(struct site *st, const char *fmt, ...)
421 static void logtimeout(struct site *st, const char *fmt, ...)
423 uint32_t class=event_log_priority(st,LOG_SETUP_TIMEOUT);
430 slilog_part(st->log,class,"%s: ",st->tunname);
431 vslilog_part(st->log,class,fmt,ap);
435 for (i=0, delim=" (tried ";
436 i<st->setup_peers.npeers;
438 transport_peer *peer=&st->setup_peers.peers[i];
439 const char *s=comm_addr_to_string(&peer->addr);
440 slilog_part(st->log,class,"%s%s",delim,s);
443 slilog_part(st->log,class,")\n");
447 static void set_link_quality(struct site *st);
448 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel);
449 static void delete_one_key(struct site *st, struct data_key *key,
450 const char *reason /* may be 0 meaning don't log*/,
451 const char *which /* ignored if !reasonn */,
452 uint32_t loglevel /* ignored if !reasonn */);
453 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
454 const struct comm_addr *prod_hint);
455 static void enter_state_run(struct site *st);
456 static bool_t enter_state_resolve(struct site *st);
457 static void decrement_resolving_count(struct site *st, int by);
458 static bool_t enter_new_state(struct site *st,uint32_t next);
459 static void enter_state_wait(struct site *st);
460 static void activate_new_key(struct site *st);
462 static bool_t is_transform_valid(struct transform_inst_if *transform)
464 return transform && transform->valid(transform->st);
467 static bool_t current_valid(struct site *st)
469 return is_transform_valid(st->current.transform);
472 #define DEFINE_CALL_TRANSFORM(fwdrev) \
473 static int call_transform_##fwdrev(struct site *st, \
474 struct transform_inst_if *transform, \
475 struct buffer_if *buf, \
476 const char **errmsg) \
478 if (!is_transform_valid(transform)) { \
479 *errmsg="transform not set up"; \
482 return transform->fwdrev(transform->st,buf,errmsg); \
485 DEFINE_CALL_TRANSFORM(forwards)
486 DEFINE_CALL_TRANSFORM(reverse)
488 static void dispose_transform(struct transform_inst_if **transform_var)
490 struct transform_inst_if *transform=*transform_var;
492 transform->delkey(transform->st);
493 transform->destroy(transform->st);
498 #define CHECK_AVAIL(b,l) do { if ((b)->size<(l)) return False; } while(0)
499 #define CHECK_EMPTY(b) do { if ((b)->size!=0) return False; } while(0)
500 #define CHECK_TYPE(b,t) do { uint32_t type; \
501 CHECK_AVAIL((b),4); \
502 type=buf_unprepend_uint32((b)); \
503 if (type!=(t)) return False; } while(0)
505 static _Bool type_is_msg34(uint32_t type)
508 type == LABEL_MSG3 ||
509 type == LABEL_MSG3BIS ||
516 struct buffer_if extrainfo;
523 struct parsedname remote;
524 struct parsedname local;
525 uint32_t remote_capabilities;
527 int capab_transformnum;
537 static _Bool set_new_transform(struct site *st, char *pk)
541 /* Make room for the shared key */
542 st->sharedsecretlen=st->chosen_transform->keylen?:st->dh->ceil_len;
543 assert(st->sharedsecretlen);
544 if (st->sharedsecretlen > st->sharedsecretallocd) {
545 st->sharedsecretallocd=st->sharedsecretlen;
546 st->sharedsecret=safe_realloc_ary(st->sharedsecret,1,
547 st->sharedsecretallocd,
548 "site:sharedsecret");
551 /* Generate the shared key */
552 st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,pk,
553 st->sharedsecret,st->sharedsecretlen);
555 /* Set up the transform */
556 struct transform_if *generator=st->chosen_transform;
557 struct transform_inst_if *generated=generator->create(generator->st);
558 ok = generated->setkey(generated->st,st->sharedsecret,
559 st->sharedsecretlen,st->setup_priority);
561 dispose_transform(&st->new_transform);
562 if (!ok) return False;
563 st->new_transform=generated;
565 slog(st,LOG_SETUP_INIT,"key exchange negotiated transform"
566 " %d (capabilities ours=%#"PRIx32" theirs=%#"PRIx32")",
567 st->chosen_transform->capab_transformnum,
568 st->local_capabilities, st->remote_capabilities);
573 int32_t lenpos, afternul;
575 static void append_string_xinfo_start(struct buffer_if *buf,
576 struct xinfoadd *xia,
578 /* Helps construct one of the names with additional info as found
579 * in MSG1..4. Call this function first, then append all the
580 * desired extra info (not including the nul byte) to the buffer,
581 * then call append_string_xinfo_done. */
583 xia->lenpos = buf->size;
584 buf_append_string(buf,str);
585 buf_append_uint8(buf,0);
586 xia->afternul = buf->size;
588 static void append_string_xinfo_done(struct buffer_if *buf,
589 struct xinfoadd *xia)
591 /* we just need to adjust the string length */
592 if (buf->size == xia->afternul) {
593 /* no extra info, strip the nul too */
594 buf_unappend_uint8(buf);
596 put_uint16(buf->start+xia->lenpos, buf->size-(xia->lenpos+2));
600 /* Build any of msg1 to msg4. msg5 and msg6 are built from the inside
601 out using a transform of config data supplied by netlink */
602 static bool_t generate_msg(struct site *st, uint32_t type, cstring_t what)
608 st->retries=st->setup_retries;
609 BUF_ALLOC(&st->buffer,what);
610 buffer_init(&st->buffer,0);
611 buf_append_uint32(&st->buffer,
612 (type==LABEL_MSG1?0:st->setup_session_id));
613 buf_append_uint32(&st->buffer,st->index);
614 buf_append_uint32(&st->buffer,type);
617 append_string_xinfo_start(&st->buffer,&xia,st->localname);
618 if ((st->local_capabilities & CAPAB_EARLY) || (type != LABEL_MSG1)) {
619 buf_append_uint32(&st->buffer,st->local_capabilities);
621 if (type_is_msg34(type)) {
622 buf_append_uint16(&st->buffer,st->mtu_target);
624 append_string_xinfo_done(&st->buffer,&xia);
626 buf_append_string(&st->buffer,st->remotename);
627 BUF_ADD_OBJ(append,&st->buffer,st->localN);
628 if (type==LABEL_MSG1) return True;
629 BUF_ADD_OBJ(append,&st->buffer,st->remoteN);
630 if (type==LABEL_MSG2) return True;
632 if (hacky_par_mid_failnow()) return False;
634 if (type==LABEL_MSG3BIS)
635 buf_append_uint8(&st->buffer,st->chosen_transform->capab_transformnum);
637 dhpub=st->dh->makepublic(st->dh->st,st->dhsecret,st->dh->len);
638 buf_append_string(&st->buffer,dhpub);
640 hash=safe_malloc(st->hash->len, "generate_msg");
641 hst=st->hash->init();
642 st->hash->update(hst,st->buffer.start,st->buffer.size);
643 st->hash->final(hst,hash);
644 sig=st->privkey->sign(st->privkey->st,hash,st->hash->len);
645 buf_append_string(&st->buffer,sig);
651 static bool_t unpick_name(struct buffer_if *msg, struct parsedname *nm)
654 nm->len=buf_unprepend_uint16(msg);
655 CHECK_AVAIL(msg,nm->len);
656 nm->name=buf_unprepend(msg,nm->len);
657 uint8_t *nul=memchr(nm->name,0,nm->len);
659 buffer_readonly_view(&nm->extrainfo,0,0);
661 buffer_readonly_view(&nm->extrainfo, nul+1, msg->start-(nul+1));
662 nm->len=nul-nm->name;
667 static bool_t unpick_msg(struct site *st, uint32_t type,
668 struct buffer_if *msg, struct msg *m)
670 m->capab_transformnum=-1;
671 m->hashstart=msg->start;
673 m->dest=buf_unprepend_uint32(msg);
675 m->source=buf_unprepend_uint32(msg);
676 CHECK_TYPE(msg,type);
677 if (!unpick_name(msg,&m->remote)) return False;
678 m->remote_capabilities=0;
680 if (m->remote.extrainfo.size) {
681 CHECK_AVAIL(&m->remote.extrainfo,4);
682 m->remote_capabilities=buf_unprepend_uint32(&m->remote.extrainfo);
684 if (type_is_msg34(type) && m->remote.extrainfo.size) {
685 CHECK_AVAIL(&m->remote.extrainfo,2);
686 m->remote_mtu=buf_unprepend_uint16(&m->remote.extrainfo);
688 if (!unpick_name(msg,&m->local)) return False;
689 if (type==LABEL_PROD) {
693 CHECK_AVAIL(msg,NONCELEN);
694 m->nR=buf_unprepend(msg,NONCELEN);
695 if (type==LABEL_MSG1) {
699 CHECK_AVAIL(msg,NONCELEN);
700 m->nL=buf_unprepend(msg,NONCELEN);
701 if (type==LABEL_MSG2) {
705 if (type==LABEL_MSG3BIS) {
707 m->capab_transformnum = buf_unprepend_uint8(msg);
709 m->capab_transformnum = CAPAB_TRANSFORMNUM_ANCIENT;
712 m->pklen=buf_unprepend_uint16(msg);
713 CHECK_AVAIL(msg,m->pklen);
714 m->pk=buf_unprepend(msg,m->pklen);
715 m->hashlen=msg->start-m->hashstart;
717 m->siglen=buf_unprepend_uint16(msg);
718 CHECK_AVAIL(msg,m->siglen);
719 m->sig=buf_unprepend(msg,m->siglen);
722 /* In `process_msg3_msg4' below, we assume that we can write a nul
723 * terminator following the signature. Make sure there's enough space.
725 if (msg->start >= msg->base + msg->alloclen)
731 static bool_t name_matches(const struct parsedname *nm, const char *expected)
733 int expected_len=strlen(expected);
735 nm->len == expected_len &&
736 !memcmp(nm->name, expected, expected_len);
739 static bool_t check_msg(struct site *st, uint32_t type, struct msg *m,
742 if (type==LABEL_MSG1) return True;
744 /* Check that the site names and our nonce have been sent
745 back correctly, and then store our peer's nonce. */
746 if (!name_matches(&m->remote,st->remotename)) {
747 *error="wrong remote site name";
750 if (!name_matches(&m->local,st->localname)) {
751 *error="wrong local site name";
754 if (memcmp(m->nL,st->localN,NONCELEN)!=0) {
755 *error="wrong locally-generated nonce";
758 if (type==LABEL_MSG2) return True;
759 if (!consttime_memeq(m->nR,st->remoteN,NONCELEN)!=0) {
760 *error="wrong remotely-generated nonce";
763 /* MSG3 has complicated rules about capabilities, which are
764 * handled in process_msg3. */
765 if (type==LABEL_MSG3 || type==LABEL_MSG3BIS) return True;
766 if (m->remote_capabilities!=st->remote_capabilities) {
767 *error="remote capabilities changed";
770 if (type==LABEL_MSG4) return True;
771 *error="unknown message type";
775 static bool_t generate_msg1(struct site *st)
777 st->random->generate(st->random->st,NONCELEN,st->localN);
778 return generate_msg(st,LABEL_MSG1,"site:MSG1");
781 static bool_t process_msg1(struct site *st, struct buffer_if *msg1,
782 const struct comm_addr *src, struct msg *m)
784 /* We've already determined we're in an appropriate state to
785 process an incoming MSG1, and that the MSG1 has correct values
788 st->setup_session_id=m->source;
789 st->remote_capabilities=m->remote_capabilities;
790 memcpy(st->remoteN,m->nR,NONCELEN);
794 static bool_t generate_msg2(struct site *st)
796 st->random->generate(st->random->st,NONCELEN,st->localN);
797 return generate_msg(st,LABEL_MSG2,"site:MSG2");
800 static bool_t process_msg2(struct site *st, struct buffer_if *msg2,
801 const struct comm_addr *src)
806 if (!unpick_msg(st,LABEL_MSG2,msg2,&m)) return False;
807 if (!check_msg(st,LABEL_MSG2,&m,&err)) {
808 slog(st,LOG_SEC,"msg2: %s",err);
811 st->setup_session_id=m.source;
812 st->remote_capabilities=m.remote_capabilities;
814 /* Select the transform to use */
816 uint32_t remote_transforms = st->remote_capabilities & CAPAB_TRANSFORM_MASK;
817 if (!remote_transforms)
818 /* old secnets only had this one transform */
819 remote_transforms = 1UL << CAPAB_TRANSFORMNUM_ANCIENT;
821 struct transform_if *ti;
823 for (i=0; i<st->ntransforms; i++) {
824 ti=st->transforms[i];
825 if ((1UL << ti->capab_transformnum) & remote_transforms)
826 goto transform_found;
828 slog(st,LOG_ERROR,"no transforms in common"
829 " (us %#"PRIx32"; them: %#"PRIx32")",
830 st->local_capabilities & CAPAB_TRANSFORM_MASK,
834 st->chosen_transform=ti;
836 memcpy(st->remoteN,m.nR,NONCELEN);
840 static bool_t generate_msg3(struct site *st)
842 /* Now we have our nonce and their nonce. Think of a secret key,
843 and create message number 3. */
844 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
845 return generate_msg(st,
846 (st->remote_capabilities & CAPAB_TRANSFORM_MASK
847 ? LABEL_MSG3BIS : LABEL_MSG3),
851 static bool_t process_msg3_msg4(struct site *st, struct msg *m)
856 /* Check signature and store g^x mod m */
857 hash=safe_malloc(st->hash->len, "process_msg3_msg4");
858 hst=st->hash->init();
859 st->hash->update(hst,m->hashstart,m->hashlen);
860 st->hash->final(hst,hash);
861 /* Terminate signature with a '0' - already checked that this will fit */
863 if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m->sig)) {
864 slog(st,LOG_SEC,"msg3/msg4 signature failed check!");
870 st->remote_adv_mtu=m->remote_mtu;
875 static bool_t process_msg3(struct site *st, struct buffer_if *msg3,
876 const struct comm_addr *src, uint32_t msgtype)
881 assert(msgtype==LABEL_MSG3 || msgtype==LABEL_MSG3BIS);
883 if (!unpick_msg(st,msgtype,msg3,&m)) return False;
884 if (!check_msg(st,msgtype,&m,&err)) {
885 slog(st,LOG_SEC,"msg3: %s",err);
888 uint32_t capab_adv_late = m.remote_capabilities
889 & ~st->remote_capabilities & CAPAB_EARLY;
890 if (capab_adv_late) {
891 slog(st,LOG_SEC,"msg3 impermissibly adds early capability flag(s)"
892 " %#"PRIx32" (was %#"PRIx32", now %#"PRIx32")",
893 capab_adv_late, st->remote_capabilities, m.remote_capabilities);
896 st->remote_capabilities|=m.remote_capabilities;
898 struct transform_if *ti;
900 for (i=0; i<st->ntransforms; i++) {
901 ti=st->transforms[i];
902 if (ti->capab_transformnum == m.capab_transformnum)
903 goto transform_found;
905 slog(st,LOG_SEC,"peer chose unknown-to-us transform %d!",
906 m.capab_transformnum);
909 st->chosen_transform=ti;
911 if (!process_msg3_msg4(st,&m))
914 /* Terminate their DH public key with a '0' */
916 /* Invent our DH secret key */
917 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
919 /* Generate the shared key and set up the transform */
920 if (!set_new_transform(st,m.pk)) return False;
925 static bool_t generate_msg4(struct site *st)
927 /* We have both nonces, their public key and our private key. Generate
928 our public key, sign it and send it to them. */
929 return generate_msg(st,LABEL_MSG4,"site:MSG4");
932 static bool_t process_msg4(struct site *st, struct buffer_if *msg4,
933 const struct comm_addr *src)
938 if (!unpick_msg(st,LABEL_MSG4,msg4,&m)) return False;
939 if (!check_msg(st,LABEL_MSG4,&m,&err)) {
940 slog(st,LOG_SEC,"msg4: %s",err);
944 if (!process_msg3_msg4(st,&m))
947 /* Terminate their DH public key with a '0' */
950 /* Generate the shared key and set up the transform */
951 if (!set_new_transform(st,m.pk)) return False;
962 static bool_t unpick_msg0(struct site *st, struct buffer_if *msg0,
966 m->dest=buf_unprepend_uint32(msg0);
968 m->source=buf_unprepend_uint32(msg0);
970 m->type=buf_unprepend_uint32(msg0);
972 /* Leaves transformed part of buffer untouched */
975 static bool_t generate_msg5(struct site *st)
977 cstring_t transform_err;
979 BUF_ALLOC(&st->buffer,"site:MSG5");
980 /* We are going to add four words to the message */
981 buffer_init(&st->buffer,calculate_max_start_pad());
982 /* Give the netlink code an opportunity to put its own stuff in the
983 message (configuration information, etc.) */
984 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
985 if (call_transform_forwards(st,st->new_transform,
986 &st->buffer,&transform_err))
988 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
989 buf_prepend_uint32(&st->buffer,st->index);
990 buf_prepend_uint32(&st->buffer,st->setup_session_id);
992 st->retries=st->setup_retries;
996 static bool_t process_msg5(struct site *st, struct buffer_if *msg5,
997 const struct comm_addr *src,
998 struct transform_inst_if *transform)
1001 cstring_t transform_err;
1003 if (!unpick_msg0(st,msg5,&m)) return False;
1005 if (call_transform_reverse(st,transform,msg5,&transform_err)) {
1006 /* There's a problem */
1007 slog(st,LOG_SEC,"process_msg5: transform: %s",transform_err);
1010 /* Buffer should now contain untransformed PING packet data */
1011 CHECK_AVAIL(msg5,4);
1012 if (buf_unprepend_uint32(msg5)!=LABEL_MSG5) {
1013 slog(st,LOG_SEC,"MSG5/PING packet contained wrong label");
1016 /* Older versions of secnet used to write some config data here
1017 * which we ignore. So we don't CHECK_EMPTY */
1021 static void create_msg6(struct site *st, struct transform_inst_if *transform,
1022 uint32_t session_id)
1024 cstring_t transform_err;
1026 BUF_ALLOC(&st->buffer,"site:MSG6");
1027 /* We are going to add four words to the message */
1028 buffer_init(&st->buffer,calculate_max_start_pad());
1029 /* Give the netlink code an opportunity to put its own stuff in the
1030 message (configuration information, etc.) */
1031 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1032 int problem = call_transform_forwards(st,transform,
1033 &st->buffer,&transform_err);
1035 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1036 buf_prepend_uint32(&st->buffer,st->index);
1037 buf_prepend_uint32(&st->buffer,session_id);
1040 static bool_t generate_msg6(struct site *st)
1042 if (!is_transform_valid(st->new_transform))
1044 create_msg6(st,st->new_transform,st->setup_session_id);
1045 st->retries=1; /* Peer will retransmit MSG5 if this packet gets lost */
1049 static bool_t process_msg6(struct site *st, struct buffer_if *msg6,
1050 const struct comm_addr *src)
1053 cstring_t transform_err;
1055 if (!unpick_msg0(st,msg6,&m)) return False;
1057 if (call_transform_reverse(st,st->new_transform,msg6,&transform_err)) {
1058 /* There's a problem */
1059 slog(st,LOG_SEC,"process_msg6: transform: %s",transform_err);
1062 /* Buffer should now contain untransformed PING packet data */
1063 CHECK_AVAIL(msg6,4);
1064 if (buf_unprepend_uint32(msg6)!=LABEL_MSG6) {
1065 slog(st,LOG_SEC,"MSG6/PONG packet contained invalid data");
1068 /* Older versions of secnet used to write some config data here
1069 * which we ignore. So we don't CHECK_EMPTY */
1073 static bool_t decrypt_msg0(struct site *st, struct buffer_if *msg0,
1074 const struct comm_addr *src)
1076 cstring_t transform_err, auxkey_err, newkey_err="n/a";
1080 if (!unpick_msg0(st,msg0,&m)) return False;
1082 /* Keep a copy so we can try decrypting it with multiple keys */
1083 buffer_copy(&st->scratch, msg0);
1085 problem = call_transform_reverse(st,st->current.transform,
1086 msg0,&transform_err);
1088 if (!st->auxiliary_is_new)
1089 delete_one_key(st,&st->auxiliary_key,
1090 "peer has used new key","auxiliary key",LOG_SEC);
1096 buffer_copy(msg0, &st->scratch);
1097 problem = call_transform_reverse(st,st->auxiliary_key.transform,
1100 slog(st,LOG_DROP,"processing packet which uses auxiliary key");
1101 if (st->auxiliary_is_new) {
1102 /* We previously timed out in state SENTMSG5 but it turns
1103 * out that our peer did in fact get our MSG5 and is
1104 * using the new key. So we should switch to it too. */
1105 /* This is a bit like activate_new_key. */
1108 st->current=st->auxiliary_key;
1109 st->auxiliary_key=t;
1111 delete_one_key(st,&st->auxiliary_key,"peer has used new key",
1112 "previous key",LOG_SEC);
1113 st->auxiliary_is_new=0;
1114 st->renegotiate_key_time=st->auxiliary_renegotiate_key_time;
1121 if (st->state==SITE_SENTMSG5) {
1122 buffer_copy(msg0, &st->scratch);
1123 problem = call_transform_reverse(st,st->new_transform,
1126 /* It looks like we didn't get the peer's MSG6 */
1127 /* This is like a cut-down enter_new_state(SITE_RUN) */
1128 slog(st,LOG_STATE,"will enter state RUN (MSG0 with new key)");
1129 BUF_FREE(&st->buffer);
1131 activate_new_key(st);
1132 return True; /* do process the data in this packet */
1138 slog(st,LOG_SEC,"transform: %s (aux: %s, new: %s)",
1139 transform_err,auxkey_err,newkey_err);
1140 initiate_key_setup(st,"incoming message would not decrypt",0);
1141 send_nak(src,m.dest,m.source,m.type,msg0,"message would not decrypt");
1145 slog(st,LOG_DROP,"transform: %s (merely skew)",transform_err);
1149 static bool_t process_msg0(struct site *st, struct buffer_if *msg0,
1150 const struct comm_addr *src)
1154 if (!decrypt_msg0(st,msg0,src))
1157 CHECK_AVAIL(msg0,4);
1158 type=buf_unprepend_uint32(msg0);
1161 /* We must forget about the current session. */
1162 delete_keys(st,"request from peer",LOG_SEC);
1163 /* probably, the peer is shutting down, and this is going to fail,
1164 * but we need to be trying to bring the link up again */
1166 initiate_key_setup(st,"peer requested key teardown",0);
1169 /* Deliver to netlink layer */
1170 st->netlink->deliver(st->netlink->st,msg0);
1171 transport_data_msgok(st,src);
1172 /* See whether we should start negotiating a new key */
1173 if (st->now > st->renegotiate_key_time)
1174 initiate_key_setup(st,"incoming packet in renegotiation window",0);
1177 slog(st,LOG_SEC,"incoming encrypted message of type %08x "
1184 static void dump_packet(struct site *st, struct buffer_if *buf,
1185 const struct comm_addr *addr, bool_t incoming,
1188 uint32_t dest=get_uint32(buf->start);
1189 uint32_t source=get_uint32(buf->start+4);
1190 uint32_t msgtype=get_uint32(buf->start+8);
1192 if (st->log_events & LOG_DUMP)
1193 slilog(st->log,M_DEBUG,"%s: %s: %08x<-%08x: %08x: %s%s",
1194 st->tunname,incoming?"incoming":"outgoing",
1195 dest,source,msgtype,comm_addr_to_string(addr),
1199 static bool_t comm_addr_sendmsg(struct site *st,
1200 const struct comm_addr *dest,
1201 struct buffer_if *buf)
1204 struct comm_clientinfo *commclientinfo = 0;
1206 for (i=0; i < st->ncomms; i++) {
1207 if (st->comms[i] == dest->comm) {
1208 commclientinfo = st->commclientinfos[i];
1212 return dest->comm->sendmsg(dest->comm->st, buf, dest, commclientinfo);
1215 static uint32_t site_status(void *st)
1220 static bool_t send_msg(struct site *st)
1222 if (st->retries>0) {
1223 transport_xmit(st, &st->setup_peers, &st->buffer, True);
1224 st->timeout=st->now+st->setup_retry_interval;
1227 } else if (st->state==SITE_SENTMSG5) {
1228 logtimeout(st,"timed out sending MSG5, stashing new key");
1229 /* We stash the key we have produced, in case it turns out that
1230 * our peer did see our MSG5 after all and starts using it. */
1231 /* This is a bit like some of activate_new_key */
1232 struct transform_inst_if *t;
1233 t=st->auxiliary_key.transform;
1234 st->auxiliary_key.transform=st->new_transform;
1235 st->new_transform=t;
1236 dispose_transform(&st->new_transform);
1238 st->auxiliary_is_new=1;
1239 st->auxiliary_key.key_timeout=st->now+st->key_lifetime;
1240 st->auxiliary_renegotiate_key_time=st->now+st->key_renegotiate_time;
1241 st->auxiliary_key.remote_session_id=st->setup_session_id;
1243 enter_state_wait(st);
1246 logtimeout(st,"timed out sending key setup packet "
1247 "(in state %s)",state_name(st->state));
1248 enter_state_wait(st);
1253 static void site_resolve_callback(void *sst, const struct comm_addr *addrs,
1254 int stored_naddrs, int all_naddrs,
1255 const char *address, const char *failwhy)
1257 struct site *st=sst;
1259 if (!stored_naddrs) {
1260 slog(st,LOG_ERROR,"resolution of %s failed: %s",address,failwhy);
1262 slog(st,LOG_PEER_ADDRS,"resolution of %s completed, %d addrs, eg: %s",
1263 address, all_naddrs, comm_addr_to_string(&addrs[0]));;
1265 int space=st->transport_peers_max-st->resolving_n_results_stored;
1266 int n_tocopy=MIN(stored_naddrs,space);
1267 COPY_ARRAY(st->resolving_results + st->resolving_n_results_stored,
1270 st->resolving_n_results_stored += n_tocopy;
1271 st->resolving_n_results_all += all_naddrs;
1274 decrement_resolving_count(st,1);
1277 static void decrement_resolving_count(struct site *st, int by)
1279 assert(st->resolving_count>0);
1280 st->resolving_count-=by;
1282 if (st->resolving_count)
1285 /* OK, we are done with them all. Handle combined results. */
1287 const struct comm_addr *addrs=st->resolving_results;
1288 int naddrs=st->resolving_n_results_stored;
1289 assert(naddrs<=st->transport_peers_max);
1292 if (naddrs != st->resolving_n_results_all) {
1293 slog(st,LOG_SETUP_INIT,"resolution of supplied addresses/names"
1294 " yielded too many results (%d > %d), some ignored",
1295 st->resolving_n_results_all, naddrs);
1297 slog(st,LOG_STATE,"resolution completed, %d addrs, eg: %s",
1298 naddrs, iaddr_to_string(&addrs[0].ia));;
1301 switch (st->state) {
1303 if (transport_compute_setupinit_peers(st,addrs,naddrs,0)) {
1304 enter_new_state(st,SITE_SENTMSG1);
1306 /* Can't figure out who to try to to talk to */
1307 slog(st,LOG_SETUP_INIT,
1308 "key exchange failed: cannot find peer address");
1309 enter_state_run(st);
1312 case SITE_SENTMSG1: case SITE_SENTMSG2:
1313 case SITE_SENTMSG3: case SITE_SENTMSG4:
1316 /* We start using the address immediately for data too.
1317 * It's best to store it in st->peers now because we might
1318 * go via SENTMSG5, WAIT, and a MSG0, straight into using
1319 * the new key (without updating the data peer addrs). */
1320 transport_resolve_complete(st,addrs,naddrs);
1321 } else if (st->local_mobile) {
1322 /* We can't let this rest because we may have a peer
1323 * address which will break in the future. */
1324 slog(st,LOG_SETUP_INIT,"resolution failed: "
1325 "abandoning key exchange");
1326 enter_state_wait(st);
1328 slog(st,LOG_SETUP_INIT,"resolution failed: "
1329 " continuing to use source address of peer's packets"
1330 " for key exchange and ultimately data");
1335 slog(st,LOG_SETUP_INIT,"resolution completed tardily,"
1336 " updating peer address(es)");
1337 transport_resolve_complete_tardy(st,addrs,naddrs);
1338 } else if (st->local_mobile) {
1339 /* Not very good. We should queue (another) renegotiation
1340 * so that we can update the peer address. */
1341 st->key_renegotiate_time=st->now+st->wait_timeout;
1343 slog(st,LOG_SETUP_INIT,"resolution failed: "
1344 " continuing to use source address of peer's packets");
1354 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
1355 const struct comm_addr *prod_hint)
1357 /* Reentrancy hazard: can call enter_new_state/enter_state_* */
1358 if (st->state!=SITE_RUN) return False;
1359 slog(st,LOG_SETUP_INIT,"initiating key exchange (%s)",reason);
1360 if (st->addresses) {
1361 slog(st,LOG_SETUP_INIT,"resolving peer address(es)");
1362 return enter_state_resolve(st);
1363 } else if (transport_compute_setupinit_peers(st,0,0,prod_hint)) {
1364 return enter_new_state(st,SITE_SENTMSG1);
1366 slog(st,LOG_SETUP_INIT,"key exchange failed: no address for peer");
1370 static void activate_new_key(struct site *st)
1372 struct transform_inst_if *t;
1374 /* We have three transform instances, which we swap between old,
1376 t=st->auxiliary_key.transform;
1377 st->auxiliary_key.transform=st->current.transform;
1378 st->current.transform=st->new_transform;
1379 st->new_transform=t;
1380 dispose_transform(&st->new_transform);
1383 st->auxiliary_is_new=0;
1384 st->auxiliary_key.key_timeout=st->current.key_timeout;
1385 st->current.key_timeout=st->now+st->key_lifetime;
1386 st->renegotiate_key_time=st->now+st->key_renegotiate_time;
1387 transport_peers_copy(st,&st->peers,&st->setup_peers);
1388 st->current.remote_session_id=st->setup_session_id;
1390 /* Compute the inter-site MTU. This is min( our_mtu, their_mtu ).
1391 * But their mtu be unspecified, in which case we just use ours. */
1392 uint32_t intersite_mtu=
1393 MIN(st->mtu_target, st->remote_adv_mtu ?: ~(uint32_t)0);
1394 st->netlink->set_mtu(st->netlink->st,intersite_mtu);
1396 slog(st,LOG_ACTIVATE_KEY,"new key activated"
1397 " (mtu ours=%"PRId32" theirs=%"PRId32" intersite=%"PRId32")",
1398 st->mtu_target, st->remote_adv_mtu, intersite_mtu);
1399 enter_state_run(st);
1402 static void delete_one_key(struct site *st, struct data_key *key,
1403 cstring_t reason, cstring_t which, uint32_t loglevel)
1405 if (!is_transform_valid(key->transform)) return;
1406 if (reason) slog(st,loglevel,"%s deleted (%s)",which,reason);
1407 dispose_transform(&key->transform);
1411 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel)
1413 if (current_valid(st)) {
1414 slog(st,loglevel,"session closed (%s)",reason);
1416 delete_one_key(st,&st->current,0,0,0);
1417 set_link_quality(st);
1419 delete_one_key(st,&st->auxiliary_key,0,0,0);
1422 static void state_assert(struct site *st, bool_t ok)
1424 if (!ok) fatal("site:state_assert");
1427 static void enter_state_stop(struct site *st)
1429 st->state=SITE_STOP;
1431 delete_keys(st,"entering state STOP",LOG_TIMEOUT_KEY);
1432 dispose_transform(&st->new_transform);
1435 static void set_link_quality(struct site *st)
1438 if (current_valid(st))
1439 quality=LINK_QUALITY_UP;
1440 else if (st->state==SITE_WAIT || st->state==SITE_STOP)
1441 quality=LINK_QUALITY_DOWN;
1442 else if (st->addresses)
1443 quality=LINK_QUALITY_DOWN_CURRENT_ADDRESS;
1444 else if (transport_peers_valid(&st->peers))
1445 quality=LINK_QUALITY_DOWN_STALE_ADDRESS;
1447 quality=LINK_QUALITY_DOWN;
1449 st->netlink->set_quality(st->netlink->st,quality);
1452 static void enter_state_run(struct site *st)
1454 slog(st,LOG_STATE,"entering state RUN");
1458 st->setup_session_id=0;
1459 transport_peers_clear(st,&st->setup_peers);
1460 FILLZERO(st->localN);
1461 FILLZERO(st->remoteN);
1462 dispose_transform(&st->new_transform);
1463 memset(st->dhsecret,0,st->dh->len);
1464 if (st->sharedsecret) memset(st->sharedsecret,0,st->sharedsecretlen);
1465 set_link_quality(st);
1467 if (st->keepalive && !current_valid(st))
1468 initiate_key_setup(st, "keepalive", 0);
1471 static bool_t ensure_resolving(struct site *st)
1473 /* Reentrancy hazard: may call site_resolve_callback and hence
1474 * enter_new_state, enter_state_* and generate_msg*. */
1475 if (st->resolving_count)
1478 assert(st->addresses);
1480 /* resolver->request might reentrantly call site_resolve_callback
1481 * which will decrement st->resolving, so we need to increment it
1482 * twice beforehand to prevent decrement from thinking we're
1483 * finished, and decrement it ourselves. Alternatively if
1484 * everything fails then there are no callbacks due and we simply
1485 * set it to 0 and return false.. */
1486 st->resolving_n_results_stored=0;
1487 st->resolving_n_results_all=0;
1488 st->resolving_count+=2;
1489 const char **addrp=st->addresses;
1490 const char *address;
1492 for (; (address=*addrp++); ) {
1493 bool_t ok = st->resolver->request(st->resolver->st,address,
1494 st->remoteport,st->comms[0],
1495 site_resolve_callback,st);
1497 st->resolving_count++;
1501 st->resolving_count=0;
1504 decrement_resolving_count(st,2);
1508 static bool_t enter_state_resolve(struct site *st)
1510 /* Reentrancy hazard! See ensure_resolving. */
1511 state_assert(st,st->state==SITE_RUN);
1512 slog(st,LOG_STATE,"entering state RESOLVE");
1513 st->state=SITE_RESOLVE;
1514 return ensure_resolving(st);
1517 static bool_t enter_new_state(struct site *st, uint32_t next)
1519 bool_t (*gen)(struct site *st);
1522 slog(st,LOG_STATE,"entering state %s",state_name(next));
1525 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
1529 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1530 st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
1534 state_assert(st,st->state==SITE_SENTMSG1);
1535 BUF_FREE(&st->buffer);
1539 state_assert(st,st->state==SITE_SENTMSG2);
1540 BUF_FREE(&st->buffer);
1544 state_assert(st,st->state==SITE_SENTMSG3);
1545 BUF_FREE(&st->buffer);
1549 state_assert(st,st->state==SITE_SENTMSG4);
1550 BUF_FREE(&st->buffer);
1555 fatal("enter_new_state(%s): invalid new state",state_name(next));
1559 if (hacky_par_start_failnow()) return False;
1561 r= gen(st) && send_msg(st);
1564 st->setup_retries, st->setup_retry_interval,
1569 if (next==SITE_RUN) {
1570 BUF_FREE(&st->buffer); /* Never reused */
1571 st->timeout=0; /* Never retransmit */
1572 activate_new_key(st);
1576 slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1577 st->buffer.free=False; /* Unconditionally use the buffer; it may be
1578 in either state, and enter_state_wait() will
1580 enter_state_wait(st);
1584 /* msg7 tells our peer that we're about to forget our key */
1585 static bool_t send_msg7(struct site *st, cstring_t reason)
1587 cstring_t transform_err;
1589 if (current_valid(st) && st->buffer.free
1590 && transport_peers_valid(&st->peers)) {
1591 BUF_ALLOC(&st->buffer,"site:MSG7");
1592 buffer_init(&st->buffer,calculate_max_start_pad());
1593 buf_append_uint32(&st->buffer,LABEL_MSG7);
1594 buf_append_string(&st->buffer,reason);
1595 if (call_transform_forwards(st, st->current.transform,
1596 &st->buffer, &transform_err))
1598 buf_prepend_uint32(&st->buffer,LABEL_MSG0);
1599 buf_prepend_uint32(&st->buffer,st->index);
1600 buf_prepend_uint32(&st->buffer,st->current.remote_session_id);
1601 transport_xmit(st,&st->peers,&st->buffer,True);
1602 BUF_FREE(&st->buffer);
1609 /* We go into this state if our peer becomes uncommunicative. Similar to
1610 the "stop" state, we forget all session keys for a while, before
1611 re-entering the "run" state. */
1612 static void enter_state_wait(struct site *st)
1614 slog(st,LOG_STATE,"entering state WAIT");
1615 st->timeout=st->now+st->wait_timeout;
1616 st->state=SITE_WAIT;
1617 set_link_quality(st);
1618 BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1619 /* XXX Erase keys etc. */
1622 static void generate_prod(struct site *st, struct buffer_if *buf)
1625 buf_append_uint32(buf,0);
1626 buf_append_uint32(buf,0);
1627 buf_append_uint32(buf,LABEL_PROD);
1628 buf_append_string(buf,st->localname);
1629 buf_append_string(buf,st->remotename);
1632 static void generate_send_prod(struct site *st,
1633 const struct comm_addr *source)
1635 if (!st->allow_send_prod) return; /* too soon */
1636 if (!(st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1637 st->state==SITE_WAIT)) return; /* we'd ignore peer's MSG1 */
1639 slog(st,LOG_SETUP_INIT,"prodding peer for key exchange");
1640 st->allow_send_prod=0;
1641 generate_prod(st,&st->scratch);
1642 bool_t ok = comm_addr_sendmsg(st, source, &st->scratch);
1643 dump_packet(st,&st->scratch,source,False,ok);
1646 static inline void site_settimeout(uint64_t timeout, int *timeout_io)
1649 int64_t offset=timeout-*now;
1650 if (offset<0) offset=0;
1651 if (offset>INT_MAX) offset=INT_MAX;
1652 if (*timeout_io<0 || offset<*timeout_io)
1657 static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
1660 struct site *st=sst;
1662 BEFOREPOLL_WANT_FDS(0); /* We don't use any file descriptors */
1665 /* Work out when our next timeout is. The earlier of 'timeout' or
1666 'current.key_timeout'. A stored value of '0' indicates no timeout
1668 site_settimeout(st->timeout, timeout_io);
1669 site_settimeout(st->current.key_timeout, timeout_io);
1670 site_settimeout(st->auxiliary_key.key_timeout, timeout_io);
1672 return 0; /* success */
1675 static void check_expiry(struct site *st, struct data_key *key,
1678 if (key->key_timeout && *now>key->key_timeout) {
1679 delete_one_key(st,key,"maximum life exceeded",which,LOG_TIMEOUT_KEY);
1683 /* NB site_afterpoll will be called before site_beforepoll is ever called */
1684 static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
1686 struct site *st=sst;
1689 if (st->timeout && *now>st->timeout) {
1691 if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
1692 if (!hacky_par_start_failnow())
1694 } else if (st->state==SITE_WAIT) {
1695 enter_state_run(st);
1697 slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
1701 check_expiry(st,&st->current,"current key");
1702 check_expiry(st,&st->auxiliary_key,"auxiliary key");
1705 /* This function is called by the netlink device to deliver packets
1706 intended for the remote network. The packet is in "raw" wire
1707 format, but is guaranteed to be word-aligned. */
1708 static void site_outgoing(void *sst, struct buffer_if *buf)
1710 struct site *st=sst;
1711 cstring_t transform_err;
1713 if (st->state==SITE_STOP) {
1718 st->allow_send_prod=1;
1720 /* In all other states we consider delivering the packet if we have
1721 a valid key and a valid address to send it to. */
1722 if (current_valid(st) && transport_peers_valid(&st->peers)) {
1723 /* Transform it and send it */
1725 buf_prepend_uint32(buf,LABEL_MSG9);
1726 if (call_transform_forwards(st, st->current.transform,
1727 buf, &transform_err))
1729 buf_prepend_uint32(buf,LABEL_MSG0);
1730 buf_prepend_uint32(buf,st->index);
1731 buf_prepend_uint32(buf,st->current.remote_session_id);
1732 transport_xmit(st,&st->peers,buf,False);
1739 slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
1741 initiate_key_setup(st,"outgoing packet",0);
1744 static bool_t named_for_us(struct site *st, const struct buffer_if *buf_in,
1745 uint32_t type, struct msg *m)
1746 /* For packets which are identified by the local and remote names.
1747 * If it has our name and our peer's name in it it's for us. */
1749 struct buffer_if buf[1];
1750 buffer_readonly_clone(buf,buf_in);
1751 return unpick_msg(st,type,buf,m)
1752 && name_matches(&m->remote,st->remotename)
1753 && name_matches(&m->local,st->localname);
1756 /* This function is called by the communication device to deliver
1757 packets from our peers.
1758 It should return True if the packet is recognised as being for
1759 this current site instance (and should therefore not be processed
1760 by other sites), even if the packet was otherwise ignored. */
1761 static bool_t site_incoming(void *sst, struct buffer_if *buf,
1762 const struct comm_addr *source)
1764 struct site *st=sst;
1766 if (buf->size < 12) return False;
1768 uint32_t dest=get_uint32(buf->start);
1769 uint32_t msgtype=get_uint32(buf->start+8);
1770 struct msg named_msg;
1772 if (msgtype==LABEL_MSG1) {
1773 if (!named_for_us(st,buf,msgtype,&named_msg))
1775 /* It's a MSG1 addressed to us. Decide what to do about it. */
1776 dump_packet(st,buf,source,True,True);
1777 if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1778 st->state==SITE_WAIT) {
1779 /* We should definitely process it */
1780 transport_compute_setupinit_peers(st,0,0,source);
1781 if (process_msg1(st,buf,source,&named_msg)) {
1782 slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
1783 bool_t entered=enter_new_state(st,SITE_SENTMSG2);
1784 if (entered && st->addresses && st->local_mobile)
1785 /* We must do this as the very last thing, because
1786 the resolver callback might reenter us. */
1787 ensure_resolving(st);
1789 slog(st,LOG_ERROR,"failed to process incoming msg1");
1793 } else if (st->state==SITE_SENTMSG1) {
1794 /* We've just sent a message 1! They may have crossed on
1795 the wire. If we have priority then we ignore the
1796 incoming one, otherwise we process it as usual. */
1797 if (st->setup_priority) {
1799 slog(st,LOG_DUMP,"crossed msg1s; we are higher "
1800 "priority => ignore incoming msg1");
1803 slog(st,LOG_DUMP,"crossed msg1s; we are lower "
1804 "priority => use incoming msg1");
1805 if (process_msg1(st,buf,source,&named_msg)) {
1806 BUF_FREE(&st->buffer); /* Free our old message 1 */
1807 transport_setup_msgok(st,source);
1808 enter_new_state(st,SITE_SENTMSG2);
1810 slog(st,LOG_ERROR,"failed to process an incoming "
1811 "crossed msg1 (we have low priority)");
1817 /* The message 1 was received at an unexpected stage of the
1818 key setup. XXX POLICY - what do we do? */
1819 slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
1823 if (msgtype==LABEL_PROD) {
1824 if (!named_for_us(st,buf,msgtype,&named_msg))
1826 dump_packet(st,buf,source,True,True);
1827 if (st->state!=SITE_RUN) {
1828 slog(st,LOG_DROP,"ignoring PROD when not in state RUN");
1829 } else if (current_valid(st)) {
1830 slog(st,LOG_DROP,"ignoring PROD when we think we have a key");
1832 initiate_key_setup(st,"peer sent PROD packet",source);
1837 if (dest==st->index) {
1838 /* Explicitly addressed to us */
1839 if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True,True);
1842 /* If the source is our current peer then initiate a key setup,
1843 because our peer's forgotten the key */
1844 if (get_uint32(buf->start+4)==st->current.remote_session_id) {
1846 initiated = initiate_key_setup(st,"received a NAK",source);
1847 if (!initiated) generate_send_prod(st,source);
1849 slog(st,LOG_SEC,"bad incoming NAK");
1853 process_msg0(st,buf,source);
1856 /* Setup packet: should not have been explicitly addressed
1858 slog(st,LOG_SEC,"incoming explicitly addressed msg1");
1861 /* Setup packet: expected only in state SENTMSG1 */
1862 if (st->state!=SITE_SENTMSG1) {
1863 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
1864 } else if (process_msg2(st,buf,source)) {
1865 transport_setup_msgok(st,source);
1866 enter_new_state(st,SITE_SENTMSG3);
1868 slog(st,LOG_SEC,"invalid MSG2");
1873 /* Setup packet: expected only in state SENTMSG2 */
1874 if (st->state!=SITE_SENTMSG2) {
1875 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
1876 } else if (process_msg3(st,buf,source,msgtype)) {
1877 transport_setup_msgok(st,source);
1878 enter_new_state(st,SITE_SENTMSG4);
1880 slog(st,LOG_SEC,"invalid MSG3");
1884 /* Setup packet: expected only in state SENTMSG3 */
1885 if (st->state!=SITE_SENTMSG3) {
1886 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
1887 } else if (process_msg4(st,buf,source)) {
1888 transport_setup_msgok(st,source);
1889 enter_new_state(st,SITE_SENTMSG5);
1891 slog(st,LOG_SEC,"invalid MSG4");
1895 /* Setup packet: expected only in state SENTMSG4 */
1896 /* (may turn up in state RUN if our return MSG6 was lost
1897 and the new key has already been activated. In that
1898 case we discard it. The peer will realise that we
1899 are using the new key when they see our data packets.
1900 Until then the peer's data packets to us get discarded. */
1901 if (st->state==SITE_SENTMSG4) {
1902 if (process_msg5(st,buf,source,st->new_transform)) {
1903 transport_setup_msgok(st,source);
1904 enter_new_state(st,SITE_RUN);
1906 slog(st,LOG_SEC,"invalid MSG5");
1908 } else if (st->state==SITE_RUN) {
1909 if (process_msg5(st,buf,source,st->current.transform)) {
1910 slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
1911 transport_setup_msgok(st,source);
1912 create_msg6(st,st->current.transform,
1913 st->current.remote_session_id);
1914 transport_xmit(st,&st->peers,&st->buffer,True);
1915 BUF_FREE(&st->buffer);
1917 slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
1920 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
1924 /* Setup packet: expected only in state SENTMSG5 */
1925 if (st->state!=SITE_SENTMSG5) {
1926 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
1927 } else if (process_msg6(st,buf,source)) {
1928 BUF_FREE(&st->buffer); /* Free message 5 */
1929 transport_setup_msgok(st,source);
1930 activate_new_key(st);
1932 slog(st,LOG_SEC,"invalid MSG6");
1936 slog(st,LOG_SEC,"received message of unknown type 0x%08x",
1947 static void site_control(void *vst, bool_t run)
1949 struct site *st=vst;
1950 if (run) enter_state_run(st);
1951 else enter_state_stop(st);
1954 static void site_phase_hook(void *sst, uint32_t newphase)
1956 struct site *st=sst;
1958 /* The program is shutting down; tell our peer */
1959 send_msg7(st,"shutting down");
1962 static void site_childpersist_clearkeys(void *sst, uint32_t newphase)
1964 struct site *st=sst;
1965 dispose_transform(&st->current.transform);
1966 dispose_transform(&st->auxiliary_key.transform);
1967 dispose_transform(&st->new_transform);
1968 /* Not much point overwiting the signing key, since we loaded it
1969 from disk, and it is only valid prospectively if at all,
1971 /* XXX it would be best to overwrite the DH state, because that
1972 _is_ relevant to forward secrecy. However we have no
1973 convenient interface for doing that and in practice gmp has
1974 probably dribbled droppings all over the malloc arena. A good
1975 way to fix this would be to have a privsep child for asymmetric
1976 crypto operations, but that's a task for another day. */
1979 static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
1982 static uint32_t index_sequence;
1990 st->cl.description="site";
1991 st->cl.type=CL_SITE;
1993 st->cl.interface=&st->ops;
1995 st->ops.control=site_control;
1996 st->ops.status=site_status;
1998 /* First parameter must be a dict */
1999 item=list_elem(args,0);
2000 if (!item || item->type!=t_dict)
2001 cfgfatal(loc,"site","parameter must be a dictionary\n");
2003 dict=item->data.dict;
2004 st->localname=dict_read_string(dict, "local-name", True, "site", loc);
2005 st->remotename=dict_read_string(dict, "name", True, "site", loc);
2007 st->keepalive=dict_read_bool(dict,"keepalive",False,"site",loc,False);
2009 st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
2011 dict_read_bool(dict,"local-mobile",False,"site",loc,False);
2013 /* Sanity check (which also allows the 'sites' file to include
2014 site() closures for all sites including our own): refuse to
2015 talk to ourselves */
2016 if (strcmp(st->localname,st->remotename)==0) {
2017 Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
2019 if (st->peer_mobile != st->local_mobile)
2020 cfgfatal(loc,"site","site %s's peer-mobile=%d"
2021 " but our local-mobile=%d\n",
2022 st->localname, st->peer_mobile, st->local_mobile);
2026 if (st->peer_mobile && st->local_mobile) {
2027 Message(M_WARNING,"site %s: site is mobile but so are we"
2028 " -> ignoring this site\n", st->remotename);
2033 assert(index_sequence < 0xffffffffUL);
2034 st->index = ++index_sequence;
2035 st->local_capabilities = 0;
2036 st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
2038 #define GET_CLOSURE_LIST(dictkey,things,nthings,CL_TYPE) do{ \
2039 list_t *things##_cfg=dict_lookup(dict,dictkey); \
2040 if (!things##_cfg) \
2041 cfgfatal(loc,"site","closure list \"%s\" not found\n",dictkey); \
2042 st->nthings=list_length(things##_cfg); \
2043 NEW_ARY(st->things,st->nthings); \
2044 assert(st->nthings); \
2045 for (i=0; i<st->nthings; i++) { \
2046 item_t *item=list_elem(things##_cfg,i); \
2047 if (item->type!=t_closure) \
2048 cfgfatal(loc,"site","%s is not a closure\n",dictkey); \
2049 closure_t *cl=item->data.closure; \
2050 if (cl->type!=CL_TYPE) \
2051 cfgfatal(loc,"site","%s closure wrong type\n",dictkey); \
2052 st->things[i]=cl->interface; \
2056 GET_CLOSURE_LIST("comm",comms,ncomms,CL_COMM);
2058 NEW_ARY(st->commclientinfos, st->ncomms);
2059 dict_t *comminfo = dict_read_dict(dict,"comm-info",False,"site",loc);
2060 for (i=0; i<st->ncomms; i++) {
2061 st->commclientinfos[i] =
2063 st->comms[i]->clientinfo(st->comms[i],comminfo,loc);
2066 st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
2067 st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
2068 st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
2070 st->privkey=find_cl_if(dict,"local-key",CL_RSAPRIVKEY,True,"site",loc);
2071 st->addresses=dict_read_string_array(dict,"address",False,"site",loc,0);
2073 st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
2074 else st->remoteport=0;
2075 st->pubkey=find_cl_if(dict,"key",CL_RSAPUBKEY,True,"site",loc);
2077 GET_CLOSURE_LIST("transform",transforms,ntransforms,CL_TRANSFORM);
2079 st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
2080 st->hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
2082 #define DEFAULT(D) (st->peer_mobile || st->local_mobile \
2083 ? DEFAULT_MOBILE_##D : DEFAULT_##D)
2084 #define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
2086 st->key_lifetime= CFG_NUMBER("key-lifetime", KEY_LIFETIME);
2087 st->setup_retries= CFG_NUMBER("setup-retries", SETUP_RETRIES);
2088 st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
2089 st->wait_timeout= CFG_NUMBER("wait-time", WAIT_TIME);
2090 st->mtu_target= dict_read_number(dict,"mtu-target",False,"site",loc,0);
2092 st->mobile_peer_expiry= dict_read_number(
2093 dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
2095 const char *peerskey= st->peer_mobile
2096 ? "mobile-peers-max" : "static-peers-max";
2097 st->transport_peers_max= dict_read_number(
2098 dict,peerskey,False,"site",loc, st->addresses ? 4 : 3);
2099 if (st->transport_peers_max<1 ||
2100 st->transport_peers_max>MAX_PEER_ADDRS) {
2101 cfgfatal(loc,"site", "%s must be in range 1.."
2102 STRING(MAX_PEER_ADDRS) "\n", peerskey);
2105 if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
2106 st->key_renegotiate_time=st->key_lifetime/2;
2108 st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
2109 st->key_renegotiate_time=dict_read_number(
2110 dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
2111 if (st->key_renegotiate_time > st->key_lifetime) {
2112 cfgfatal(loc,"site",
2113 "renegotiate-time must be less than key-lifetime\n");
2116 st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
2117 log_event_table,"site");
2119 st->resolving_count=0;
2120 st->allow_send_prod=0;
2122 st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
2124 sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
2126 /* The information we expect to see in incoming messages of type 1 */
2127 /* fixme: lots of unchecked overflows here, but the results are only
2128 corrupted packets rather than undefined behaviour */
2129 st->setup_priority=(strcmp(st->localname,st->remotename)>0);
2131 buffer_new(&st->buffer,SETUP_BUFFER_LEN);
2133 buffer_new(&st->scratch,SETUP_BUFFER_LEN);
2134 BUF_ALLOC(&st->scratch,"site:scratch");
2136 /* We are interested in poll(), but only for timeouts. We don't have
2137 any fds of our own. */
2138 register_for_poll(st, site_beforepoll, site_afterpoll, "site");
2141 st->remote_capabilities=0;
2142 st->chosen_transform=0;
2143 st->current.key_timeout=0;
2144 st->auxiliary_key.key_timeout=0;
2145 transport_peers_clear(st,&st->peers);
2146 transport_peers_clear(st,&st->setup_peers);
2147 /* XXX mlock these */
2148 st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
2149 st->sharedsecretlen=st->sharedsecretallocd=0;
2152 for (i=0; i<st->ntransforms; i++) {
2153 struct transform_if *ti=st->transforms[i];
2154 uint32_t capbit = 1UL << ti->capab_transformnum;
2155 if (st->local_capabilities & capbit)
2156 slog(st,LOG_ERROR,"transformnum capability bit"
2157 " %d (%#"PRIx32") reused", ti->capab_transformnum, capbit);
2158 st->local_capabilities |= capbit;
2161 /* We need to register the remote networks with the netlink device */
2162 uint32_t netlink_mtu; /* local virtual interface mtu */
2163 st->netlink->reg(st->netlink->st, site_outgoing, st, &netlink_mtu);
2164 if (!st->mtu_target)
2165 st->mtu_target=netlink_mtu;
2167 for (i=0; i<st->ncomms; i++)
2168 st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
2170 st->current.transform=0;
2171 st->auxiliary_key.transform=0;
2172 st->new_transform=0;
2173 st->auxiliary_is_new=0;
2175 enter_state_stop(st);
2177 add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
2178 add_hook(PHASE_CHILDPERSIST,site_childpersist_clearkeys,st);
2180 return new_closure(&st->cl);
2183 void site_module(dict_t *dict)
2185 add_closure(dict,"site",site_apply);
2189 /***** TRANSPORT PEERS definitions *****/
2191 static void transport_peers_debug(struct site *st, transport_peers *dst,
2192 const char *didwhat,
2193 int nargs, const struct comm_addr *args,
2198 if (!(st->log_events & LOG_PEER_ADDRS))
2199 return; /* an optimisation */
2201 slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
2202 (dst==&st->peers ? "data" :
2203 dst==&st->setup_peers ? "setup" : "UNKNOWN"),
2204 didwhat, nargs, dst->npeers);
2206 for (i=0, argp=(void*)args;
2208 i++, (argp+=stride?stride:sizeof(*args))) {
2209 const struct comm_addr *ca=(void*)argp;
2210 slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
2211 i, comm_addr_to_string(ca));
2213 for (i=0; i<dst->npeers; i++) {
2214 struct timeval diff;
2215 timersub(tv_now,&dst->peers[i].last,&diff);
2216 const struct comm_addr *ca=&dst->peers[i].addr;
2217 slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
2218 i, comm_addr_to_string(ca),
2219 (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
2223 static void transport_peers_expire(struct site *st, transport_peers *peers) {
2224 /* peers must be sorted first */
2225 int previous_peers=peers->npeers;
2226 struct timeval oldest;
2227 oldest.tv_sec = tv_now->tv_sec - st->mobile_peer_expiry;
2228 oldest.tv_usec = tv_now->tv_usec;
2229 while (peers->npeers>1 &&
2230 timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
2232 if (peers->npeers != previous_peers)
2233 transport_peers_debug(st,peers,"expire", 0,0,0);
2236 static bool_t transport_peer_record_one(struct site *st, transport_peers *peers,
2237 const struct comm_addr *ca,
2238 const struct timeval *tv) {
2239 /* returns false if output is full */
2242 if (peers->npeers >= st->transport_peers_max)
2245 for (search=0; search<peers->npeers; search++)
2246 if (comm_addr_equal(&peers->peers[search].addr, ca))
2249 peers->peers[peers->npeers].addr = *ca;
2250 peers->peers[peers->npeers].last = *tv;
2255 static void transport_record_peers(struct site *st, transport_peers *peers,
2256 const struct comm_addr *addrs, int naddrs,
2258 /* We add addrs into peers. The new entries end up at the front
2259 * and displace entries towards the end (perhaps even off the
2260 * end). Any existing matching entries are moved up to the front.
2262 * Caller must first call transport_peers_expire. */
2264 if (naddrs==1 && peers->npeers>=1 &&
2265 comm_addr_equal(&addrs[0], &peers->peers[0].addr)) {
2266 /* optimisation, also avoids debug for trivial updates */
2267 peers->peers[0].last = *tv_now;
2271 int old_npeers=peers->npeers;
2272 transport_peer old_peers[old_npeers];
2273 COPY_ARRAY(old_peers,peers->peers,old_npeers);
2277 for (i=0; i<naddrs; i++) {
2278 if (!transport_peer_record_one(st,peers, &addrs[i], tv_now))
2281 for (i=0; i<old_npeers; i++) {
2282 const transport_peer *old=&old_peers[i];
2283 if (!transport_peer_record_one(st,peers, &old->addr, &old->last))
2287 transport_peers_debug(st,peers,m, naddrs,addrs,0);
2290 static void transport_expire_record_peers(struct site *st,
2291 transport_peers *peers,
2292 const struct comm_addr *addrs,
2293 int naddrs, const char *m) {
2294 /* Convenience function */
2295 transport_peers_expire(st,peers);
2296 transport_record_peers(st,peers,addrs,naddrs,m);
2299 static bool_t transport_compute_setupinit_peers(struct site *st,
2300 const struct comm_addr *configured_addrs /* 0 if none or not found */,
2301 int n_configured_addrs /* 0 if none or not found */,
2302 const struct comm_addr *incoming_packet_addr /* 0 if none */) {
2303 if (!n_configured_addrs && !incoming_packet_addr &&
2304 !transport_peers_valid(&st->peers))
2307 slog(st,LOG_SETUP_INIT,
2308 "using: %d configured addr(s);%s %d old peer addrs(es)",
2310 incoming_packet_addr ? " incoming packet address;" : "",
2313 /* Non-mobile peers try addresses until one is plausible. The
2314 * effect is that this code always tries first the configured
2315 * address if supplied, or otherwise the address of the incoming
2316 * PROD, or finally the existing data peer if one exists; this is
2319 transport_peers_copy(st,&st->setup_peers,&st->peers);
2320 transport_peers_expire(st,&st->setup_peers);
2322 if (incoming_packet_addr)
2323 transport_record_peers(st,&st->setup_peers,
2324 incoming_packet_addr,1, "incoming");
2326 if (n_configured_addrs)
2327 transport_record_peers(st,&st->setup_peers,
2328 configured_addrs,n_configured_addrs, "setupinit");
2330 assert(transport_peers_valid(&st->setup_peers));
2334 static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
2335 if (st->peer_mobile)
2336 transport_expire_record_peers(st,&st->setup_peers,a,1,"setupmsg");
2338 static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
2339 if (st->peer_mobile)
2340 transport_expire_record_peers(st,&st->peers,a,1,"datamsg");
2343 static int transport_peers_valid(transport_peers *peers) {
2344 return peers->npeers;
2346 static void transport_peers_clear(struct site *st, transport_peers *peers) {
2348 transport_peers_debug(st,peers,"clear",0,0,0);
2350 static void transport_peers_copy(struct site *st, transport_peers *dst,
2351 const transport_peers *src) {
2352 dst->npeers=src->npeers;
2353 COPY_ARRAY(dst->peers, src->peers, dst->npeers);
2354 transport_peers_debug(st,dst,"copy",
2355 src->npeers, &src->peers->addr, sizeof(*src->peers));
2358 static void transport_resolve_complete(struct site *st,
2359 const struct comm_addr *addrs,
2361 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2363 transport_expire_record_peers(st,&st->setup_peers,addrs,naddrs,
2367 static void transport_resolve_complete_tardy(struct site *st,
2368 const struct comm_addr *addrs,
2370 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2371 "resolved tardily");
2374 static void transport_peers__copy_by_mask(transport_peer *out, int *nout_io,
2376 const transport_peers *inp) {
2377 /* out and in->peers may be the same region, or nonoverlapping */
2378 const transport_peer *in=inp->peers;
2380 for (slot=0; slot<inp->npeers; slot++) {
2381 if (!(mask & (1U << slot)))
2383 if (!(out==in && slot==*nout_io))
2384 COPY_OBJ(out[*nout_io], in[slot]);
2389 void transport_xmit(struct site *st, transport_peers *peers,
2390 struct buffer_if *buf, bool_t candebug) {
2392 transport_peers_expire(st, peers);
2393 unsigned failed=0; /* bitmask */
2394 assert(MAX_PEER_ADDRS < sizeof(unsigned)*CHAR_BIT);
2397 for (slot=0; slot<peers->npeers; slot++) {
2398 transport_peer *peer=&peers->peers[slot];
2399 bool_t ok = comm_addr_sendmsg(st, &peer->addr, buf);
2401 dump_packet(st, buf, &peer->addr, False, ok);
2403 failed |= 1U << slot;
2406 if (ok && !st->peer_mobile)
2409 /* Now we need to demote/delete failing addrs: if we are mobile we
2410 * merely demote them; otherwise we delete them. */
2411 if (st->local_mobile) {
2412 unsigned expected = ((1U << nfailed)-1) << (peers->npeers-nfailed);
2413 /* `expected' has all the failures at the end already */
2414 if (failed != expected) {
2416 transport_peer failedpeers[nfailed];
2417 transport_peers__copy_by_mask(failedpeers, &fslot, failed,peers);
2418 assert(fslot == nfailed);
2420 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2421 assert(wslot+nfailed == peers->npeers);
2422 COPY_ARRAY(peers->peers+wslot, failedpeers, nfailed);
2423 transport_peers_debug(st,peers,"mobile failure reorder",0,0,0);
2426 if (failed && peers->npeers > 1) {
2428 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2429 peers->npeers=wslot;
2430 transport_peers_debug(st,peers,"non-mobile failure cleanup",0,0,0);
2435 /***** END of transport peers declarations *****/