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"
48 #define SETUP_BUFFER_LEN 2048
50 #define DEFAULT_KEY_LIFETIME (3600*1000) /* [ms] */
51 #define DEFAULT_KEY_RENEGOTIATE_GAP (5*60*1000) /* [ms] */
52 #define DEFAULT_SETUP_RETRIES 5
53 #define DEFAULT_SETUP_RETRY_INTERVAL (2*1000) /* [ms] */
54 #define DEFAULT_WAIT_TIME (20*1000) /* [ms] */
56 #define DEFAULT_MOBILE_KEY_LIFETIME (2*24*3600*1000) /* [ms] */
57 #define DEFAULT_MOBILE_KEY_RENEGOTIATE_GAP (12*3600*1000) /* [ms] */
58 #define DEFAULT_MOBILE_SETUP_RETRIES 30
59 #define DEFAULT_MOBILE_SETUP_RETRY_INTERVAL (1*1000) /* [ms] */
60 #define DEFAULT_MOBILE_WAIT_TIME (10*1000) /* [ms] */
62 #define DEFAULT_MOBILE_PEER_EXPIRY (2*60) /* [s] */
64 #define PEERKEYS_SUFFIX_MAXLEN (sizeof("~incoming")-1)
66 /* Each site can be in one of several possible states. */
69 SITE_STOP - nothing is allowed to happen; tunnel is down;
70 all session keys have been erased
71 -> SITE_RUN upon external instruction
72 SITE_RUN - site up, maybe with valid key
73 -> SITE_RESOLVE upon outgoing packet and no valid key
74 we start name resolution for the other end of the tunnel
75 -> SITE_SENTMSG2 upon valid incoming message 1 and suitable time
76 we send an appropriate message 2
77 SITE_RESOLVE - waiting for name resolution
78 -> SITE_SENTMSG1 upon successful resolution
79 we send an appropriate message 1
80 -> SITE_SENTMSG2 upon valid incoming message 1 (then abort resolution)
81 we abort resolution and
82 -> SITE_WAIT on timeout or resolution failure
84 -> SITE_SENTMSG2 upon valid incoming message 1 from higher priority end
85 -> SITE_SENTMSG3 upon valid incoming message 2
86 -> SITE_WAIT on timeout
88 -> SITE_SENTMSG4 upon valid incoming message 3
89 -> SITE_WAIT on timeout
91 -> SITE_SENTMSG5 upon valid incoming message 4
92 -> SITE_WAIT on timeout
94 -> SITE_RUN upon valid incoming message 5
95 -> SITE_WAIT on timeout
97 -> SITE_RUN upon valid incoming message 6
98 -> SITE_WAIT on timeout
99 SITE_WAIT - failed to establish key; do nothing for a while
100 -> SITE_RUN on timeout
105 #define SITE_RESOLVE 2
106 #define SITE_SENTMSG1 3
107 #define SITE_SENTMSG2 4
108 #define SITE_SENTMSG3 5
109 #define SITE_SENTMSG4 6
110 #define SITE_SENTMSG5 7
113 #define CASES_MSG3_KNOWN LABEL_MSG3: case LABEL_MSG3BIS
117 int32_t site_max_start_pad = 4*4;
119 static cstring_t state_name(uint32_t state)
122 case 0: return "STOP";
123 case 1: return "RUN";
124 case 2: return "RESOLVE";
125 case 3: return "SENTMSG1";
126 case 4: return "SENTMSG2";
127 case 5: return "SENTMSG3";
128 case 6: return "SENTMSG4";
129 case 7: return "SENTMSG5";
130 case 8: return "WAIT";
131 default: return "*bad state*";
137 #define LOG_UNEXPECTED 0x00000001
138 #define LOG_SETUP_INIT 0x00000002
139 #define LOG_SETUP_TIMEOUT 0x00000004
140 #define LOG_ACTIVATE_KEY 0x00000008
141 #define LOG_TIMEOUT_KEY 0x00000010
142 #define LOG_SEC 0x00000020
143 #define LOG_STATE 0x00000040
144 #define LOG_DROP 0x00000080
145 #define LOG_DUMP 0x00000100
146 #define LOG_ERROR 0x00000400
147 #define LOG_PEER_ADDRS 0x00000800
148 #define LOG_SIGKEYS 0x00001000
150 static struct flagstr log_event_table[]={
151 { "unexpected", LOG_UNEXPECTED },
152 { "setup-init", LOG_SETUP_INIT },
153 { "setup-timeout", LOG_SETUP_TIMEOUT },
154 { "activate-key", LOG_ACTIVATE_KEY },
155 { "timeout-key", LOG_TIMEOUT_KEY },
156 { "security", LOG_SEC },
157 { "state-change", LOG_STATE },
158 { "packet-drop", LOG_DROP },
159 { "dump-packets", LOG_DUMP },
160 { "errors", LOG_ERROR },
161 { "peer-addrs", LOG_PEER_ADDRS },
162 { "sigkeys", LOG_SIGKEYS },
163 { "default", LOG_SETUP_INIT|LOG_SETUP_TIMEOUT|
164 LOG_ACTIVATE_KEY|LOG_TIMEOUT_KEY|LOG_SEC|LOG_ERROR|LOG_SIGKEYS },
165 { "all", 0xffffffff },
170 /***** TRANSPORT PEERS declarations *****/
172 /* Details of "mobile peer" semantics:
174 - We use the same data structure for the different configurations,
175 but manage it with different algorithms.
177 - We record up to mobile_peers_max peer address/port numbers
178 ("peers") for key setup, and separately up to mobile_peers_max
181 - In general, we make a new set of addrs (see below) when we start
182 a new key exchange; the key setup addrs become the data transport
183 addrs when key setup complets.
185 If our peer is mobile:
187 - We send to all recent addresses of incoming packets, plus
188 initially all configured addresses (which we also expire).
190 - So, we record addrs of good incoming packets, as follows:
191 1. expire any peers last seen >120s ("mobile-peer-expiry") ago
192 2. add the peer of the just received packet to the applicable list
193 (possibly evicting the oldest entries to make room)
194 NB that we do not expire peers until an incoming packet arrives.
196 - If the peer has a configured address or name, we record them the
197 same way, but only as a result of our own initiation of key
198 setup. (We might evict some incoming packet addrs to make room.)
200 - The default number of addrs to keep is 3, or 4 if we have a
201 configured name or address. That's space for two configured
202 addresses (one IPv6 and one IPv4), plus two received addresses.
204 - Outgoing packets are sent to every recorded address in the
205 applicable list. Any unsupported[1] addresses are deleted from
206 the list right away. (This should only happen to configured
207 addresses, of course, but there is no need to check that.)
209 - When we successfully complete a key setup, we merge the key setup
210 peers into the data transfer peers.
212 [1] An unsupported address is one for whose AF we don't have a
213 socket (perhaps because we got EAFNOSUPPORT or some such) or for
214 which sendto gives ENETUNREACH.
216 If neither end is mobile:
218 - When peer initiated the key exchange, we use the incoming packet
221 - When we initiate the key exchange, we try configured addresses
222 until we get one which isn't unsupported then fixate on that.
224 - When we complete a key setup, we replace the data transport peers
225 with those from the key setup.
229 - We can't tell when local network setup changes so we can't cache
230 the unsupported addrs and completely remove the spurious calls to
231 sendto, but we can optimise things a bit by deprioritising addrs
232 which seem to be unsupported.
234 - Use only configured addresses. (Except, that if our peer
235 initiated a key exchange we use the incoming packet address until
236 our name resolution completes.)
238 - When we send a packet, try each address in turn; if addr
239 supported, put that address to the end of the list for future
240 packets, and go onto the next address.
242 - When we complete a key setup, we replace the data transport peers
243 with those from the key setup.
249 struct comm_addr addr;
253 /* configuration information */
254 /* runtime information */
256 transport_peer peers[MAX_PEER_ADDRS];
259 /* Basic operations on transport peer address sets */
260 static void transport_peers_clear(struct site *st, transport_peers *peers);
261 static int transport_peers_valid(transport_peers *peers);
262 static void transport_peers_copy(struct site *st, transport_peers *dst,
263 const transport_peers *src);
265 /* Record address of incoming setup packet; resp. data packet. */
266 static void transport_setup_msgok(struct site *st, const struct comm_addr *a);
267 static void transport_data_msgok(struct site *st, const struct comm_addr *a);
269 /* Initialise the setup addresses. Called before we send the first
270 * packet in a key exchange. If we are the initiator, as a result of
271 * resolve completing (or being determined not to be relevant) or an
272 * incoming PROD; if we are the responder, as a result of the MSG1. */
273 static bool_t transport_compute_setupinit_peers(struct site *st,
274 const struct comm_addr *configured_addrs /* 0 if none or not found */,
275 int n_configured_addrs /* 0 if none or not found */,
276 const struct comm_addr *incoming_packet_addr /* 0 if none */);
278 /* Called if we are the responder in a key setup, when the resolve
279 * completes. transport_compute_setupinit_peers will hvae been called
280 * earlier. If _complete is called, we are still doing the key setup
281 * (and we should use the new values for both the rest of the key
282 * setup and the ongoing data exchange); if _tardy is called, the key
283 * setup is done (either completed or not) and only the data peers are
285 static void transport_resolve_complete(struct site *st,
286 const struct comm_addr *addrs, int naddrs);
287 static void transport_resolve_complete_tardy(struct site *st,
288 const struct comm_addr *addrs, int naddrs);
290 static void transport_xmit(struct site *st, transport_peers *peers,
291 struct buffer_if *buf, bool_t candebug);
293 /***** END of transport peers declarations *****/
297 struct transform_inst_if *transform;
298 uint64_t key_timeout; /* End of life of current key */
299 uint32_t remote_session_id;
305 /* configuration information */
309 bool_t local_mobile, peer_mobile; /* Mobile client support */
310 int32_t transport_peers_max;
311 string_t tunname; /* localname<->remotename by default, used in logs */
312 cstring_t *addresses; /* DNS name or address(es) for bootstrapping, optional */
313 int remoteport; /* Port for bootstrapping, optional */
315 struct netlink_if *netlink;
316 struct comm_if **comms;
317 struct comm_clientinfo **commclientinfos;
319 struct resolver_if *resolver;
321 struct random_if *random;
322 struct privcache_if *privkeys;
323 struct sigprivkey_if *privkey_fixed;
324 struct transform_if **transforms;
328 uint32_t index; /* Index of this site */
329 uint32_t early_capabilities;
330 uint32_t local_capabilities;
331 int32_t setup_retries; /* How many times to send setup packets */
332 int32_t setup_retry_interval; /* Initial timeout for setup packets */
333 int32_t wait_timeout_mean; /* How long to wait if setup unsuccessful */
334 int32_t mobile_peer_expiry; /* How long to remember 2ary addresses */
335 int32_t key_lifetime; /* How long a key lasts once set up */
336 int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
337 after this time, initiate a new
340 bool_t our_name_later; /* our name > peer name */
343 /* runtime information */
345 uint64_t now; /* Most recently seen time */
346 bool_t allow_send_prod;
347 bool_t msg1_crossed_logged;
349 int resolving_n_results_all;
350 int resolving_n_results_stored;
351 struct comm_addr resolving_results[MAX_PEER_ADDRS];
352 const char *peerkeys_path;
353 struct pathprefix_template peerkeys_tmpl;
354 struct peer_keyset *peerkeys_current, *peerkeys_kex;
356 /* The currently established session */
357 struct data_key current;
358 struct data_key auxiliary_key;
359 bool_t auxiliary_is_new;
360 uint64_t renegotiate_key_time; /* When we can negotiate a new key */
361 uint64_t auxiliary_renegotiate_key_time;
362 transport_peers peers; /* Current address(es) of peer for data traffic */
364 /* The current key setup protocol exchange. We can only be
365 involved in one of these at a time. There's a potential for
366 denial of service here (the attacker keeps sending a setup
367 packet; we keep trying to continue the exchange, and have to
368 timeout before we can listen for another setup packet); perhaps
369 we should keep a list of 'bad' sources for setup packets. */
370 uint32_t remote_capabilities;
371 uint16_t remote_adv_mtu;
372 struct transform_if *chosen_transform;
373 uint32_t setup_session_id;
374 transport_peers setup_peers;
375 uint8_t localN[NONCELEN]; /* Nonces for key exchange */
376 uint8_t remoteN[NONCELEN];
377 struct buffer_if buffer; /* Current outgoing key exchange packet */
378 struct buffer_if scratch;
379 int32_t retries; /* Number of retries remaining */
380 uint64_t timeout; /* Timeout for current state */
382 uint8_t *sharedsecret;
383 uint32_t sharedsecretlen, sharedsecretallocd;
384 struct transform_inst_if *new_transform; /* For key setup/verify */
387 static uint32_t event_log_priority(struct site *st, uint32_t event)
389 if (!(event&st->log_events))
392 case LOG_UNEXPECTED: return M_INFO;
393 case LOG_SETUP_INIT: return M_INFO;
394 case LOG_SETUP_TIMEOUT: return M_NOTICE;
395 case LOG_ACTIVATE_KEY: return M_INFO;
396 case LOG_TIMEOUT_KEY: return M_INFO;
397 case LOG_SEC: return M_SECURITY;
398 case LOG_STATE: return M_DEBUG;
399 case LOG_DROP: return M_DEBUG;
400 case LOG_DUMP: return M_DEBUG;
401 case LOG_ERROR: return M_ERR;
402 case LOG_PEER_ADDRS: return M_DEBUG;
403 case LOG_SIGKEYS: return M_INFO;
404 default: return M_ERR;
408 static uint32_t slog_start(struct site *st, uint32_t event)
410 uint32_t class=event_log_priority(st, event);
412 slilog_part(st->log,class,"%s: ",st->tunname);
417 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
419 static void vslog(struct site *st, uint32_t event, cstring_t msg, va_list ap)
423 class=slog_start(st,event);
425 vslilog_part(st->log,class,msg,ap);
426 slilog_part(st->log,class,"\n");
430 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
432 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
436 vslog(st,event,msg,ap);
440 static void logtimeout(struct site *st, const char *fmt, ...)
442 static void logtimeout(struct site *st, const char *fmt, ...)
444 uint32_t class=event_log_priority(st,LOG_SETUP_TIMEOUT);
451 slilog_part(st->log,class,"%s: ",st->tunname);
452 vslilog_part(st->log,class,fmt,ap);
456 for (i=0, delim=" (tried ";
457 i<st->setup_peers.npeers;
459 transport_peer *peer=&st->setup_peers.peers[i];
460 const char *s=comm_addr_to_string(&peer->addr);
461 slilog_part(st->log,class,"%s%s",delim,s);
464 slilog_part(st->log,class,")\n");
468 static void set_link_quality(struct site *st);
469 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel);
470 static void delete_one_key(struct site *st, struct data_key *key,
471 const char *reason /* may be 0 meaning don't log*/,
472 const char *which /* ignored if !reasonn */,
473 uint32_t loglevel /* ignored if !reasonn */);
474 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
475 const struct comm_addr *prod_hint);
476 static void enter_state_run(struct site *st);
477 static bool_t enter_state_resolve(struct site *st);
478 static void decrement_resolving_count(struct site *st, int by);
479 static bool_t enter_new_state(struct site *st,uint32_t next,
480 const struct msg *prompt
481 /* may be 0 for SENTMSG1 */);
482 static void enter_state_wait(struct site *st);
483 static void activate_new_key(struct site *st);
485 static bool_t is_transform_valid(struct transform_inst_if *transform)
487 return transform && transform->valid(transform->st);
490 static bool_t current_valid(struct site *st)
492 return is_transform_valid(st->current.transform);
495 #define DEFINE_CALL_TRANSFORM(fwdrev) \
496 static transform_apply_return \
497 call_transform_##fwdrev(struct site *st, \
498 struct transform_inst_if *transform, \
499 struct buffer_if *buf, \
500 const char **errmsg) \
502 if (!is_transform_valid(transform)) { \
503 *errmsg="transform not set up"; \
504 return transform_apply_err; \
506 return transform->fwdrev(transform->st,buf,errmsg); \
509 DEFINE_CALL_TRANSFORM(forwards)
510 DEFINE_CALL_TRANSFORM(reverse)
512 static void dispose_transform(struct transform_inst_if **transform_var)
514 struct transform_inst_if *transform=*transform_var;
516 transform->delkey(transform->st);
517 transform->destroy(transform->st);
522 #define CHECK_AVAIL(b,l) do { if ((b)->size<(l)) return False; } while(0)
523 #define CHECK_EMPTY(b) do { if ((b)->size!=0) return False; } while(0)
524 #define CHECK_TYPE(b,t) do { uint32_t type; \
525 CHECK_AVAIL((b),4); \
526 type=buf_unprepend_uint32((b)); \
527 if (type!=(t)) return False; } while(0)
529 static _Bool type_is_msg23(uint32_t type)
532 case LABEL_MSG2: case CASES_MSG3_KNOWN: return True;
533 default: return False;
536 static _Bool type_is_msg34(uint32_t type)
539 case CASES_MSG3_KNOWN: case LABEL_MSG4: return True;
540 default: return False;
547 struct buffer_if extrainfo;
554 struct parsedname remote;
555 struct parsedname local;
556 uint32_t remote_capabilities;
558 int capab_transformnum;
564 struct alg_msg_data sig;
565 int n_pubkeys_accepted_nom; /* may be > MAX_SIG_KEYS ! */
566 const struct sigkeyid *pubkeys_accepted[MAX_SIG_KEYS];
567 int signing_key_index;
570 static const struct sigkeyid keyid_zero;
572 static int32_t wait_timeout(struct site *st) {
573 int32_t t = st->wait_timeout_mean;
576 st->random->generate(st->random->st,sizeof(factor),&factor);
577 t += (t / 256) * factor;
582 static _Bool set_new_transform(struct site *st, char *pk)
586 /* Make room for the shared key */
587 st->sharedsecretlen=st->chosen_transform->keylen?:st->dh->ceil_len;
588 assert(st->sharedsecretlen);
589 if (st->sharedsecretlen > st->sharedsecretallocd) {
590 st->sharedsecretallocd=st->sharedsecretlen;
591 st->sharedsecret=safe_realloc_ary(st->sharedsecret,1,
592 st->sharedsecretallocd,
593 "site:sharedsecret");
596 /* Generate the shared key */
597 st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,pk,
598 st->sharedsecret,st->sharedsecretlen);
600 /* Set up the transform */
601 struct transform_if *generator=st->chosen_transform;
602 struct transform_inst_if *generated=generator->create(generator->st);
603 ok = generated->setkey(generated->st,st->sharedsecret,
604 st->sharedsecretlen,st->our_name_later);
606 dispose_transform(&st->new_transform);
607 if (!ok) return False;
608 st->new_transform=generated;
610 slog(st,LOG_SETUP_INIT,"key exchange negotiated transform"
611 " %d (capabilities ours=%#"PRIx32" theirs=%#"PRIx32")",
612 st->chosen_transform->capab_bit,
613 st->local_capabilities, st->remote_capabilities);
618 int32_t lenpos, afternul;
620 static void append_string_xinfo_start(struct buffer_if *buf,
621 struct xinfoadd *xia,
623 /* Helps construct one of the names with additional info as found
624 * in MSG1..4. Call this function first, then append all the
625 * desired extra info (not including the nul byte) to the buffer,
626 * then call append_string_xinfo_done. */
628 xia->lenpos = buf->size;
629 buf_append_string(buf,str);
630 buf_append_uint8(buf,0);
631 xia->afternul = buf->size;
633 static void append_string_xinfo_done(struct buffer_if *buf,
634 struct xinfoadd *xia)
636 /* we just need to adjust the string length */
637 if (buf->size == xia->afternul) {
638 /* no extra info, strip the nul too */
639 buf_unappend_uint8(buf);
641 put_uint16(buf->start+xia->lenpos, buf->size-(xia->lenpos+2));
645 /* Build any of msg1 to msg4. msg5 and msg6 are built from the inside
646 out using a transform of config data supplied by netlink */
647 static bool_t generate_msg(struct site *st, uint32_t type, cstring_t what,
648 const struct msg *prompt
649 /* may be 0 for MSG1 */)
655 st->retries=st->setup_retries;
656 BUF_ALLOC(&st->buffer,what);
657 buffer_init(&st->buffer,0);
658 buf_append_uint32(&st->buffer,
659 (type==LABEL_MSG1?0:st->setup_session_id));
660 buf_append_uint32(&st->buffer,st->index);
661 buf_append_uint32(&st->buffer,type);
664 append_string_xinfo_start(&st->buffer,&xia,st->localname);
665 if ((st->local_capabilities & st->early_capabilities) ||
666 (type != LABEL_MSG1)) {
667 buf_append_uint32(&st->buffer,st->local_capabilities);
669 if (type_is_msg34(type)) {
670 buf_append_uint16(&st->buffer,st->mtu_target);
672 if (type_is_msg23(type)) {
673 buf_append_uint8(&st->buffer,st->peerkeys_kex->nkeys);
674 for (ki=0; ki<st->peerkeys_kex->nkeys; ki++) {
675 struct peer_pubkey *pk = &st->peerkeys_kex->keys[ki];
676 BUF_ADD_OBJ(append,&st->buffer,pk->id);
679 struct sigprivkey_if *privkey=0;
680 if (type_is_msg34(type)) {
681 assert(prompt->n_pubkeys_accepted_nom>0);
683 ki<prompt->n_pubkeys_accepted_nom && ki<MAX_SIG_KEYS;
685 const struct sigkeyid *kid=prompt->pubkeys_accepted[ki];
687 privkey=st->privkeys->lookup(st->privkeys->st,kid,st->log);
688 if (privkey) goto privkey_found;
690 if (sigkeyid_equal(&keyid_zero,kid)) {
691 privkey=st->privkey_fixed;
696 uint32_t class = slog_start(st,LOG_ERROR);
698 slilog_part(st->log,class,"no suitable private key, peer wanted");
700 ki<prompt->n_pubkeys_accepted_nom && ki<MAX_SIG_KEYS;
702 slilog_part(st->log,class, " " SIGKEYID_PR_FMT,
703 SIGKEYID_PR_VAL(prompt->pubkeys_accepted[ki]));
705 if (prompt->n_pubkeys_accepted_nom > MAX_SIG_KEYS)
706 slilog_part(st->log,class," +%d",
707 prompt->n_pubkeys_accepted_nom - MAX_SIG_KEYS);
708 slilog_part(st->log,class,"\n");
713 buf_append_uint8(&st->buffer,ki);
716 append_string_xinfo_done(&st->buffer,&xia);
718 buf_append_string(&st->buffer,st->remotename);
719 BUF_ADD_OBJ(append,&st->buffer,st->localN);
720 if (type==LABEL_MSG1) return True;
721 BUF_ADD_OBJ(append,&st->buffer,st->remoteN);
722 if (type==LABEL_MSG2) return True;
724 if (hacky_par_mid_failnow()) return False;
726 if (MSGMAJOR(type) == 3) do {
727 minor = MSGMINOR(type);
728 if (minor < 1) break;
729 buf_append_uint8(&st->buffer,st->chosen_transform->capab_bit);
732 dhpub=st->dh->makepublic(st->dh->st,st->dhsecret,st->dh->len);
733 buf_append_string(&st->buffer,dhpub);
736 bool_t ok=privkey->sign(privkey->st,
747 static bool_t unpick_name(struct buffer_if *msg, struct parsedname *nm)
750 nm->len=buf_unprepend_uint16(msg);
751 CHECK_AVAIL(msg,nm->len);
752 nm->name=buf_unprepend(msg,nm->len);
753 uint8_t *nul=memchr(nm->name,0,nm->len);
755 buffer_readonly_view(&nm->extrainfo,0,0);
757 buffer_readonly_view(&nm->extrainfo, nul+1, msg->start-(nul+1));
758 nm->len=nul-nm->name;
763 static bool_t unpick_msg(struct site *st, uint32_t type,
764 struct buffer_if *msg, struct msg *m)
768 m->n_pubkeys_accepted_nom=-1;
769 m->capab_transformnum=-1;
770 m->signing_key_index=-1;
771 m->hashstart=msg->start;
773 m->dest=buf_unprepend_uint32(msg);
775 m->source=buf_unprepend_uint32(msg);
776 CHECK_TYPE(msg,type);
777 if (!unpick_name(msg,&m->remote)) return False;
778 m->remote_capabilities=0;
780 if (m->remote.extrainfo.size) {
781 CHECK_AVAIL(&m->remote.extrainfo,4);
782 m->remote_capabilities=buf_unprepend_uint32(&m->remote.extrainfo);
784 if (type_is_msg34(type) && m->remote.extrainfo.size) {
785 CHECK_AVAIL(&m->remote.extrainfo,2);
786 m->remote_mtu=buf_unprepend_uint16(&m->remote.extrainfo);
788 if (type_is_msg23(type) && m->remote.extrainfo.size) {
789 m->n_pubkeys_accepted_nom = buf_unprepend_uint8(&m->remote.extrainfo);
790 if (!m->n_pubkeys_accepted_nom) return False;
791 for (int ki_nom=0; ki_nom<m->n_pubkeys_accepted_nom; ki_nom++) {
792 CHECK_AVAIL(&m->remote.extrainfo,KEYIDSZ);
793 struct sigkeyid *kid = buf_unprepend(&m->remote.extrainfo,KEYIDSZ);
794 if (ki_nom<MAX_SIG_KEYS) m->pubkeys_accepted[ki_nom] = kid;
797 m->n_pubkeys_accepted_nom = 1;
798 m->pubkeys_accepted[0] = &keyid_zero;
800 if (type_is_msg34(type) && m->remote.extrainfo.size) {
801 m->signing_key_index=buf_unprepend_uint8(&m->remote.extrainfo);
803 m->signing_key_index=0;
805 if (!unpick_name(msg,&m->local)) return False;
806 if (type==LABEL_PROD) {
810 CHECK_AVAIL(msg,NONCELEN);
811 m->nR=buf_unprepend(msg,NONCELEN);
812 if (type==LABEL_MSG1) {
816 CHECK_AVAIL(msg,NONCELEN);
817 m->nL=buf_unprepend(msg,NONCELEN);
818 if (type==LABEL_MSG2) {
822 if (MSGMAJOR(type) == 3) do {
823 minor = MSGMINOR(type);
824 #define MAYBE_READ_CAP(minminor, kind, dflt) do { \
825 if (minor < (minminor)) \
826 m->capab_##kind##num = (dflt); \
828 CHECK_AVAIL(msg, 1); \
829 m->capab_##kind##num = buf_unprepend_uint8(msg); \
832 MAYBE_READ_CAP(1, transform, CAPAB_BIT_ANCIENTTRANSFORM);
833 #undef MAYBE_READ_CAP
836 m->pklen=buf_unprepend_uint16(msg);
837 CHECK_AVAIL(msg,m->pklen);
838 m->pk=buf_unprepend(msg,m->pklen);
839 m->hashlen=msg->start-m->hashstart;
841 if (m->signing_key_index < 0 ||
842 m->signing_key_index >= st->peerkeys_kex->nkeys) {
845 struct sigpubkey_if *pubkey=
846 st->peerkeys_kex->keys[m->signing_key_index].pubkey;
847 if (!pubkey->unpick(pubkey->st,msg,&m->sig)) {
856 static bool_t name_matches(const struct parsedname *nm, const char *expected)
858 int expected_len=strlen(expected);
860 nm->len == expected_len &&
861 !memcmp(nm->name, expected, expected_len);
864 static bool_t check_msg(struct site *st, uint32_t type, struct msg *m,
867 if (type==LABEL_MSG1) return True;
869 /* Check that the site names and our nonce have been sent
870 back correctly, and then store our peer's nonce. */
871 if (!name_matches(&m->remote,st->remotename)) {
872 *error="wrong remote site name";
875 if (!name_matches(&m->local,st->localname)) {
876 *error="wrong local site name";
879 if (memcmp(m->nL,st->localN,NONCELEN)!=0) {
880 *error="wrong locally-generated nonce";
883 if (type==LABEL_MSG2) return True;
884 if (!consttime_memeq(m->nR,st->remoteN,NONCELEN)) {
885 *error="wrong remotely-generated nonce";
888 /* MSG3 has complicated rules about capabilities, which are
889 * handled in process_msg3. */
890 if (MSGMAJOR(type) == 3) return True;
891 if (m->remote_capabilities!=st->remote_capabilities) {
892 *error="remote capabilities changed";
895 if (type==LABEL_MSG4) return True;
896 *error="unknown message type";
900 static void peerkeys_maybe_incorporate(struct site *st, const char *file,
901 const char *whatmore,
904 struct peer_keyset *atsuffix=
905 keyset_load(file,&st->scratch,st->log,logcl_enoent);
906 if (!atsuffix) return;
908 if (st->peerkeys_current &&
909 serial_cmp(atsuffix->serial,st->peerkeys_current->serial) <= 0) {
910 slog(st,LOG_SIGKEYS,"keys from %s%s are older, discarding",
912 keyset_dispose(&atsuffix);
914 if (r) slog(st,LOG_ERROR,"failed to remove old key update %s: %s\n",
915 st->peerkeys_tmpl.buffer,strerror(errno));
918 slog(st,LOG_SIGKEYS,"keys from %s%s are newer, installing",
920 keyset_dispose(&st->peerkeys_current);
921 st->peerkeys_current=atsuffix;
922 int r=rename(file,st->peerkeys_path);
923 if (r) slog(st,LOG_ERROR,"failed to install key update %s as %s: %s\n",
924 st->peerkeys_tmpl.buffer,st->peerkeys_path,
929 static void peerkeys_check_for_update(struct site *st)
933 * <F> live file, loaded on startup, updated by secnet
934 * (only). * in-memory peerkeys_current is kept
935 * synced with this file
937 * <F>~update update file from config manager, checked before
938 * every key exchange. config manager must rename
939 * this file into place; it will be renamed and
940 * then removed by secnet.
942 * <F>~proc update file being processed by secnet.
943 * only secnet may write or remove.
945 * <F>~incoming update file from peer, being received by secnet
946 * may be incomplete, unverified, or even malicious
947 * only secnet may write or remove.
949 * <F>~tmp update file from config manager, only mss may
952 * secnet discards updates that are not more recent than (by
953 * serial) the live file. But it may not process updates
956 * The implied keyset to be used is MAX(live, proc, update).
959 * check live vs proc, either mv proc live or rm proc
960 * if proc doesn't exist, mv update proc
962 * make-secnet-sites does:
963 * write: rename something onto update
964 * read: read update,proc,live in that order and take max
966 * We support only one concurrent secnet, one concurrent
967 * writing make-secnet-sites, and any number of readers.
968 * We want to maintain a live file at all times as that
969 * is what secnet actually reads at startup and uses.
971 * Proof that this is sound:
972 * Let us regard update,proc,live as i=0,1,2
973 * Files contain public key sets and are manipulated as
974 * a whole, and we may regard key sets with the same
975 * serial as equivalent.
976 * We talk below about reading as if it were atomic.
977 * Actually the atomic operation is open(2); the
978 * reading gets whatever that name refers to. So
979 * we can model this as an atomic read.
980 * secnet eventually moves all data into the live file
981 * or deletes it, so there should be no indefinitely
982 * stale data; informally this means we can disregard
983 * the possibility of very old serials and regard
984 * serials as fully ordered. (We don't bother with
985 * a formal proof of this property.)
986 * Consequently we will only think about the serial
987 * and not the contents. We treat absent files as
988 * minimal (we will write -1 for convenience although
989 * we don't mean a numerical value). We write S(i).
991 * Invariant 1 for secnet's transformations is as follows:
992 * Each file S(i) is only reduced (to S'(i)) if for some j S'(j)
993 * >= S(i), with S'(j) either being >= S(i) beforehand, or
994 * updated atomically together with S(i).
996 * Proof of invariant 1 for the secnet operations:
997 * (a) check live vs proc, proc>live, mv:
998 * j=2, i=1; S'(i)=-1, so S(i) is being reduced. S'(j) is
999 * equal to S(i), and the rename is atomic [1], so S'(j) and
1000 * S'(i) are updated simultaneously. S(j) is being
1001 * increased. (There are no hazards from concurrent writers;
1002 * only we ourselves (secnet) write to live or proc.)
1003 * (b) check live vs proc, proc<=live, rm:
1004 * j=2, i=1; S'(i)=-1, so S(i) is being reduced. But
1005 * S(j) is >= $(i) throughout. (Again, no concurrent
1007 * (c) mv update proc (when proc does not exist):
1008 * j=1, i=0; S(i) is being reduced to -1. But simultaneously
1009 * S(j) is being increased to the old S(i). Our precondition
1010 * (proc not existing) is not subject to a concurrent writer
1011 * hazards because only we write to proc; our action is
1012 * atomic and takes whatever update is available (if any).
1014 * Proof of soundness for the mss reading operation:
1015 * Let M be MAX(\forall S) at the point where mss reads update.
1016 * Invariant 2: when mss reads S(k), MAX(K, S(k)..S(2)) >= M,
1017 * where K is the max S it has seen so far. Clearly this is
1018 * true for k=0 (with K==-1). secnet's operations never break
1019 * this invariant because if any S() is reduced, another one
1020 * counted must be increased. mss's step operation
1021 * updates K with S(k), so MAX(K', S(k+1)..)=MAX(K, S(k)..),
1022 * and updates k to k+1, preserving the invariant.
1023 * At the end we have k=3 and K=>M. Since secnet never
1024 * invents serials, K=M in the absence of an mss update
1027 * Consideration of the mss update operation:
1028 * Successive serials from sites file updates etc. are supposed
1029 * to be increasing. When this is true, M is increased. A
1030 * concurrent reading mss which makes its first read after the
1031 * update will get the new data (by the proofs above). This
1032 * seems to be the required property.
1036 * [1] From "Base Specifications issue 7",
1037 * 2.9.7 Thread Interactions with Regular File Operations
1038 * All of the following functions shall be atomic with respect to
1039 * each other in the effects specified in POSIX.1-2017 when they
1040 * operate on regular files or symbolic links:
1041 * ... rename ... open ...
1043 if (!st->peerkeys_path) return;
1045 pathprefix_template_setsuffix(&st->peerkeys_tmpl,"~proc");
1046 peerkeys_maybe_incorporate(st,st->peerkeys_tmpl.buffer,
1047 " (found old update)",
1050 pathprefix_template_setsuffix(&st->peerkeys_tmpl,"~update");
1051 const char *inputp=st->peerkeys_tmpl.buffer;
1052 if (access(inputp,R_OK)) {
1054 slog(st,LOG_ERROR,"cannot access peer key update file %s\n",
1059 buffer_init(&st->scratch,0);
1060 BUF_ADD_BYTES(append,&st->scratch,
1061 st->peerkeys_tmpl.buffer,
1062 strlen(st->peerkeys_tmpl.buffer)+1);
1063 inputp=st->scratch.start;
1065 pathprefix_template_setsuffix(&st->peerkeys_tmpl,"~proc");
1066 const char *oursp=st->peerkeys_tmpl.buffer;
1068 int r=rename(inputp,oursp);
1070 slog(st,LOG_ERROR,"failed to claim key update file %s as %s: %s\n",
1071 inputp,oursp,strerror(errno));
1075 peerkeys_maybe_incorporate(st,oursp," (update)",M_ERR);
1079 static bool_t kex_init(struct site *st)
1081 keyset_dispose(&st->peerkeys_kex);
1082 peerkeys_check_for_update(st);
1083 if (!st->peerkeys_current) {
1084 slog(st,LOG_SETUP_INIT,"no peer public keys, abandoning key setup");
1087 st->peerkeys_kex = keyset_dup(st->peerkeys_current);
1088 st->random->generate(st->random->st,NONCELEN,st->localN);
1092 static bool_t generate_msg1(struct site *st, const struct msg *prompt_maybe_0)
1095 generate_msg(st,LABEL_MSG1,"site:MSG1",prompt_maybe_0);
1098 static bool_t process_msg1(struct site *st, struct buffer_if *msg1,
1099 const struct comm_addr *src,
1100 const struct msg *m)
1102 /* We've already determined we're in an appropriate state to
1103 process an incoming MSG1, and that the MSG1 has correct values
1106 st->setup_session_id=m->source;
1107 st->remote_capabilities=m->remote_capabilities;
1108 memcpy(st->remoteN,m->nR,NONCELEN);
1112 static bool_t generate_msg2(struct site *st,
1113 const struct msg *prompt_may_be_null)
1116 generate_msg(st,LABEL_MSG2,"site:MSG2",prompt_may_be_null);
1119 static bool_t process_msg2(struct site *st, struct buffer_if *msg2,
1120 const struct comm_addr *src,
1121 struct msg *m /* returned */)
1125 if (!unpick_msg(st,LABEL_MSG2,msg2,m)) return False;
1126 if (!check_msg(st,LABEL_MSG2,m,&err)) {
1127 slog(st,LOG_SEC,"msg2: %s",err);
1130 st->setup_session_id=m->source;
1131 st->remote_capabilities=m->remote_capabilities;
1133 /* Select the transform to use */
1135 uint32_t remote_crypto_caps = st->remote_capabilities & CAPAB_TRANSFORM_MASK;
1136 if (!remote_crypto_caps)
1137 /* old secnets only had this one transform */
1138 remote_crypto_caps = 1UL << CAPAB_BIT_ANCIENTTRANSFORM;
1140 #define CHOOSE_CRYPTO(kind, whats) do { \
1141 struct kind##_if *iface; \
1142 uint32_t bit, ours = 0; \
1144 for (i= 0; i < st->n##kind##s; i++) { \
1145 iface=st->kind##s[i]; \
1146 bit = 1UL << iface->capab_bit; \
1147 if (bit & remote_crypto_caps) goto kind##_found; \
1150 slog(st,LOG_ERROR,"no " whats " in common" \
1151 " (us %#"PRIx32"; them: %#"PRIx32")", \
1152 st->local_capabilities & ours, remote_crypto_caps); \
1155 st->chosen_##kind = iface; \
1158 CHOOSE_CRYPTO(transform, "transforms");
1160 #undef CHOOSE_CRYPTO
1162 memcpy(st->remoteN,m->nR,NONCELEN);
1166 static bool_t generate_msg3(struct site *st, const struct msg *prompt)
1168 /* Now we have our nonce and their nonce. Think of a secret key,
1169 and create message number 3. */
1170 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
1171 return generate_msg(st,
1172 (st->remote_capabilities & CAPAB_TRANSFORM_MASK)
1175 "site:MSG3",prompt);
1178 static bool_t process_msg3_msg4(struct site *st, struct msg *m)
1180 /* Check signature and store g^x mod m */
1183 if (m->signing_key_index >= 0) {
1184 if (m->signing_key_index >= st->peerkeys_kex->nkeys)
1186 ki=m->signing_key_index;
1188 for (ki=0; ki<st->peerkeys_kex->nkeys; ki++)
1189 if (sigkeyid_equal(&keyid_zero,&st->peerkeys_kex->keys[ki].id))
1193 "peer signed with keyid zero, which we do not accept");
1197 struct sigpubkey_if *pubkey=st->peerkeys_kex->keys[ki].pubkey;
1199 if (!pubkey->check(pubkey->st,
1200 m->hashstart,m->hashlen,
1202 slog(st,LOG_SEC,"msg3/msg4 signature failed check!");
1206 st->remote_adv_mtu=m->remote_mtu;
1211 static bool_t process_msg3(struct site *st, struct buffer_if *msg3,
1212 const struct comm_addr *src, uint32_t msgtype,
1213 struct msg *m /* returned */)
1218 case CASES_MSG3_KNOWN: break;
1222 if (!unpick_msg(st,msgtype,msg3,m)) return False;
1223 if (!check_msg(st,msgtype,m,&err)) {
1224 slog(st,LOG_SEC,"msg3: %s",err);
1227 uint32_t capab_adv_late = m->remote_capabilities
1228 & ~st->remote_capabilities & st->early_capabilities;
1229 if (capab_adv_late) {
1230 slog(st,LOG_SEC,"msg3 impermissibly adds early capability flag(s)"
1231 " %#"PRIx32" (was %#"PRIx32", now %#"PRIx32")",
1232 capab_adv_late, st->remote_capabilities, m->remote_capabilities);
1236 #define CHOSE_CRYPTO(kind, what) do { \
1237 struct kind##_if *iface; \
1239 for (i=0; i<st->n##kind##s; i++) { \
1240 iface=st->kind##s[i]; \
1241 if (iface->capab_bit == m->capab_##kind##num) \
1242 goto kind##_found; \
1244 slog(st,LOG_SEC,"peer chose unknown-to-us " what " %d!", \
1245 m->capab_##kind##num); \
1248 st->chosen_##kind=iface; \
1251 CHOSE_CRYPTO(transform, "transform");
1255 if (!process_msg3_msg4(st,m))
1258 /* Update our idea of the remote site's capabilities, now that we've
1259 * verified that its message was authentic.
1261 * Our previous idea of the remote site's capabilities came from the
1262 * unauthenticated MSG1. We've already checked that this new message
1263 * doesn't change any of the bits we relied upon in the past, but it may
1264 * also have set additional capability bits. We simply throw those away
1265 * now, and use the authentic capabilities from this MSG3. */
1266 st->remote_capabilities=m->remote_capabilities;
1268 /* Terminate their DH public key with a '0' */
1270 /* Invent our DH secret key */
1271 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
1273 /* Generate the shared key and set up the transform */
1274 if (!set_new_transform(st,m->pk)) return False;
1279 static bool_t generate_msg4(struct site *st, const struct msg *prompt)
1281 /* We have both nonces, their public key and our private key. Generate
1282 our public key, sign it and send it to them. */
1283 return generate_msg(st,LABEL_MSG4,"site:MSG4",prompt);
1286 static bool_t process_msg4(struct site *st, struct buffer_if *msg4,
1287 const struct comm_addr *src,
1288 struct msg *m /* returned */)
1292 if (!unpick_msg(st,LABEL_MSG4,msg4,m)) return False;
1293 if (!check_msg(st,LABEL_MSG4,m,&err)) {
1294 slog(st,LOG_SEC,"msg4: %s",err);
1298 if (!process_msg3_msg4(st,m))
1301 /* Terminate their DH public key with a '0' */
1304 /* Generate the shared key and set up the transform */
1305 if (!set_new_transform(st,m->pk)) return False;
1316 static bool_t unpick_msg0(struct site *st, struct buffer_if *msg0,
1319 CHECK_AVAIL(msg0,4);
1320 m->dest=buf_unprepend_uint32(msg0);
1321 CHECK_AVAIL(msg0,4);
1322 m->source=buf_unprepend_uint32(msg0);
1323 CHECK_AVAIL(msg0,4);
1324 m->type=buf_unprepend_uint32(msg0);
1326 /* Leaves transformed part of buffer untouched */
1329 static bool_t generate_msg5(struct site *st, const struct msg *prompt)
1331 cstring_t transform_err;
1333 BUF_ALLOC(&st->buffer,"site:MSG5");
1334 /* We are going to add four words to the message */
1335 buffer_init(&st->buffer,calculate_max_start_pad());
1336 /* Give the netlink code an opportunity to put its own stuff in the
1337 message (configuration information, etc.) */
1338 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
1339 if (call_transform_forwards(st,st->new_transform,
1340 &st->buffer,&transform_err))
1342 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
1343 buf_prepend_uint32(&st->buffer,st->index);
1344 buf_prepend_uint32(&st->buffer,st->setup_session_id);
1346 st->retries=st->setup_retries;
1350 static bool_t process_msg5(struct site *st, struct buffer_if *msg5,
1351 const struct comm_addr *src,
1352 struct transform_inst_if *transform)
1355 cstring_t transform_err;
1357 if (!unpick_msg0(st,msg5,&m)) return False;
1359 if (call_transform_reverse(st,transform,msg5,&transform_err)) {
1360 /* There's a problem */
1361 slog(st,LOG_SEC,"process_msg5: transform: %s",transform_err);
1364 /* Buffer should now contain untransformed PING packet data */
1365 CHECK_AVAIL(msg5,4);
1366 if (buf_unprepend_uint32(msg5)!=LABEL_MSG5) {
1367 slog(st,LOG_SEC,"MSG5/PING packet contained wrong label");
1370 /* Older versions of secnet used to write some config data here
1371 * which we ignore. So we don't CHECK_EMPTY */
1375 static void create_msg6(struct site *st, struct transform_inst_if *transform,
1376 uint32_t session_id)
1378 cstring_t transform_err;
1380 BUF_ALLOC(&st->buffer,"site:MSG6");
1381 /* We are going to add four words to the message */
1382 buffer_init(&st->buffer,calculate_max_start_pad());
1383 /* Give the netlink code an opportunity to put its own stuff in the
1384 message (configuration information, etc.) */
1385 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1386 transform_apply_return problem =
1387 call_transform_forwards(st,transform,
1388 &st->buffer,&transform_err);
1390 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1391 buf_prepend_uint32(&st->buffer,st->index);
1392 buf_prepend_uint32(&st->buffer,session_id);
1395 static bool_t generate_msg6(struct site *st, const struct msg *prompt)
1397 if (!is_transform_valid(st->new_transform))
1399 create_msg6(st,st->new_transform,st->setup_session_id);
1400 st->retries=1; /* Peer will retransmit MSG5 if this packet gets lost */
1404 static bool_t process_msg6(struct site *st, struct buffer_if *msg6,
1405 const struct comm_addr *src)
1408 cstring_t transform_err;
1410 if (!unpick_msg0(st,msg6,&m)) return False;
1412 if (call_transform_reverse(st,st->new_transform,msg6,&transform_err)) {
1413 /* There's a problem */
1414 slog(st,LOG_SEC,"process_msg6: transform: %s",transform_err);
1417 /* Buffer should now contain untransformed PING packet data */
1418 CHECK_AVAIL(msg6,4);
1419 if (buf_unprepend_uint32(msg6)!=LABEL_MSG6) {
1420 slog(st,LOG_SEC,"MSG6/PONG packet contained invalid data");
1423 /* Older versions of secnet used to write some config data here
1424 * which we ignore. So we don't CHECK_EMPTY */
1428 static transform_apply_return
1429 decrypt_msg0(struct site *st, struct buffer_if *msg0,
1430 const struct comm_addr *src)
1432 cstring_t transform_err, auxkey_err, newkey_err="n/a";
1434 transform_apply_return problem;
1436 if (!unpick_msg0(st,msg0,&m)) return False;
1438 /* Keep a copy so we can try decrypting it with multiple keys */
1439 buffer_copy(&st->scratch, msg0);
1441 problem = call_transform_reverse(st,st->current.transform,
1442 msg0,&transform_err);
1444 if (!st->auxiliary_is_new)
1445 delete_one_key(st,&st->auxiliary_key,
1446 "peer has used new key","auxiliary key",LOG_SEC);
1449 if (transform_apply_return_badseq(problem))
1452 buffer_copy(msg0, &st->scratch);
1453 problem = call_transform_reverse(st,st->auxiliary_key.transform,
1456 slog(st,LOG_DROP,"processing packet which uses auxiliary key");
1457 if (st->auxiliary_is_new) {
1458 /* We previously timed out in state SENTMSG5 but it turns
1459 * out that our peer did in fact get our MSG5 and is
1460 * using the new key. So we should switch to it too. */
1461 /* This is a bit like activate_new_key. */
1464 st->current=st->auxiliary_key;
1465 st->auxiliary_key=t;
1467 delete_one_key(st,&st->auxiliary_key,"peer has used new key",
1468 "previous key",LOG_SEC);
1469 st->auxiliary_is_new=0;
1470 st->renegotiate_key_time=st->auxiliary_renegotiate_key_time;
1474 if (transform_apply_return_badseq(problem))
1477 if (st->state==SITE_SENTMSG5) {
1478 buffer_copy(msg0, &st->scratch);
1479 problem = call_transform_reverse(st,st->new_transform,
1482 /* It looks like we didn't get the peer's MSG6 */
1483 /* This is like a cut-down enter_new_state(SITE_RUN) */
1484 slog(st,LOG_STATE,"will enter state RUN (MSG0 with new key)");
1485 BUF_FREE(&st->buffer);
1487 activate_new_key(st);
1488 return 0; /* do process the data in this packet */
1490 if (transform_apply_return_badseq(problem))
1494 slog(st,LOG_SEC,"transform: %s (aux: %s, new: %s)",
1495 transform_err,auxkey_err,newkey_err);
1496 initiate_key_setup(st,"incoming message would not decrypt",0);
1497 send_nak(src,m.dest,m.source,m.type,msg0,"message would not decrypt");
1502 slog(st,LOG_DROP,"transform: %s (bad seq.)",transform_err);
1507 static bool_t process_msg0(struct site *st, struct buffer_if *msg0,
1508 const struct comm_addr *src)
1511 transform_apply_return problem;
1513 problem = decrypt_msg0(st,msg0,src);
1514 if (problem==transform_apply_seqdupe) {
1515 /* We recently received another copy of this packet, maybe due
1516 * to polypath. That's not a problem; indeed, for the
1517 * purposes of transport address management it is a success.
1518 * But we don't want to process the packet. */
1519 transport_data_msgok(st,src);
1525 CHECK_AVAIL(msg0,4);
1526 type=buf_unprepend_uint32(msg0);
1529 /* We must forget about the current session. */
1530 delete_keys(st,"request from peer",LOG_SEC);
1531 /* probably, the peer is shutting down, and this is going to fail,
1532 * but we need to be trying to bring the link up again */
1534 initiate_key_setup(st,"peer requested key teardown",0);
1537 /* Deliver to netlink layer */
1538 st->netlink->deliver(st->netlink->st,msg0);
1539 transport_data_msgok(st,src);
1540 /* See whether we should start negotiating a new key */
1541 if (st->now > st->renegotiate_key_time)
1542 initiate_key_setup(st,"incoming packet in renegotiation window",0);
1545 slog(st,LOG_SEC,"incoming encrypted message of type %08x "
1552 static void dump_packet(struct site *st, struct buffer_if *buf,
1553 const struct comm_addr *addr, bool_t incoming,
1556 uint32_t dest=get_uint32(buf->start);
1557 uint32_t source=get_uint32(buf->start+4);
1558 uint32_t msgtype=get_uint32(buf->start+8);
1560 if (st->log_events & LOG_DUMP)
1561 slilog(st->log,M_DEBUG,"%s: %s: %08x<-%08x: %08x: %s%s",
1562 st->tunname,incoming?"incoming":"outgoing",
1563 dest,source,msgtype,comm_addr_to_string(addr),
1567 static bool_t comm_addr_sendmsg(struct site *st,
1568 const struct comm_addr *dest,
1569 struct buffer_if *buf)
1572 struct comm_clientinfo *commclientinfo = 0;
1574 for (i=0; i < st->ncomms; i++) {
1575 if (st->comms[i] == dest->comm) {
1576 commclientinfo = st->commclientinfos[i];
1580 return dest->comm->sendmsg(dest->comm->st, buf, dest, commclientinfo);
1583 static uint32_t site_status(void *st)
1588 static bool_t send_msg(struct site *st)
1590 if (st->retries>0) {
1591 transport_xmit(st, &st->setup_peers, &st->buffer, True);
1592 st->timeout=st->now+st->setup_retry_interval;
1595 } else if (st->state==SITE_SENTMSG5) {
1596 logtimeout(st,"timed out sending MSG5, stashing new key");
1597 /* We stash the key we have produced, in case it turns out that
1598 * our peer did see our MSG5 after all and starts using it. */
1599 /* This is a bit like some of activate_new_key */
1600 struct transform_inst_if *t;
1601 t=st->auxiliary_key.transform;
1602 st->auxiliary_key.transform=st->new_transform;
1603 st->new_transform=t;
1604 dispose_transform(&st->new_transform);
1606 st->auxiliary_is_new=1;
1607 st->auxiliary_key.key_timeout=st->now+st->key_lifetime;
1608 st->auxiliary_renegotiate_key_time=st->now+st->key_renegotiate_time;
1609 st->auxiliary_key.remote_session_id=st->setup_session_id;
1611 enter_state_wait(st);
1614 logtimeout(st,"timed out sending key setup packet "
1615 "(in state %s)",state_name(st->state));
1616 enter_state_wait(st);
1621 static void site_resolve_callback(void *sst, const struct comm_addr *addrs,
1622 int stored_naddrs, int all_naddrs,
1623 const char *address, const char *failwhy)
1625 struct site *st=sst;
1627 if (!stored_naddrs) {
1628 slog(st,LOG_ERROR,"resolution of %s failed: %s",address,failwhy);
1630 slog(st,LOG_PEER_ADDRS,"resolution of %s completed, %d addrs, eg: %s",
1631 address, all_naddrs, comm_addr_to_string(&addrs[0]));;
1633 int space=st->transport_peers_max-st->resolving_n_results_stored;
1634 int n_tocopy=MIN(stored_naddrs,space);
1635 COPY_ARRAY(st->resolving_results + st->resolving_n_results_stored,
1638 st->resolving_n_results_stored += n_tocopy;
1639 st->resolving_n_results_all += all_naddrs;
1642 decrement_resolving_count(st,1);
1645 static void decrement_resolving_count(struct site *st, int by)
1647 assert(st->resolving_count>0);
1648 st->resolving_count-=by;
1650 if (st->resolving_count)
1653 /* OK, we are done with them all. Handle combined results. */
1655 const struct comm_addr *addrs=st->resolving_results;
1656 int naddrs=st->resolving_n_results_stored;
1657 assert(naddrs<=st->transport_peers_max);
1660 if (naddrs != st->resolving_n_results_all) {
1661 slog(st,LOG_SETUP_INIT,"resolution of supplied addresses/names"
1662 " yielded too many results (%d > %d), some ignored",
1663 st->resolving_n_results_all, naddrs);
1665 slog(st,LOG_STATE,"resolution completed, %d addrs, eg: %s",
1666 naddrs, iaddr_to_string(&addrs[0].ia));;
1669 switch (st->state) {
1671 if (transport_compute_setupinit_peers(st,addrs,naddrs,0)) {
1672 enter_new_state(st,SITE_SENTMSG1,0);
1674 /* Can't figure out who to try to to talk to */
1675 slog(st,LOG_SETUP_INIT,
1676 "key exchange failed: cannot find peer address");
1677 enter_state_run(st);
1680 case SITE_SENTMSG1: case SITE_SENTMSG2:
1681 case SITE_SENTMSG3: case SITE_SENTMSG4:
1684 /* We start using the address immediately for data too.
1685 * It's best to store it in st->peers now because we might
1686 * go via SENTMSG5, WAIT, and a MSG0, straight into using
1687 * the new key (without updating the data peer addrs). */
1688 transport_resolve_complete(st,addrs,naddrs);
1689 } else if (st->local_mobile) {
1690 /* We can't let this rest because we may have a peer
1691 * address which will break in the future. */
1692 slog(st,LOG_SETUP_INIT,"resolution failed: "
1693 "abandoning key exchange");
1694 enter_state_wait(st);
1696 slog(st,LOG_SETUP_INIT,"resolution failed: "
1697 " continuing to use source address of peer's packets"
1698 " for key exchange and ultimately data");
1703 slog(st,LOG_SETUP_INIT,"resolution completed tardily,"
1704 " updating peer address(es)");
1705 transport_resolve_complete_tardy(st,addrs,naddrs);
1706 } else if (st->local_mobile) {
1707 /* Not very good. We should queue (another) renegotiation
1708 * so that we can update the peer address. */
1709 st->key_renegotiate_time=st->now+wait_timeout(st);
1711 slog(st,LOG_SETUP_INIT,"resolution failed: "
1712 " continuing to use source address of peer's packets");
1722 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
1723 const struct comm_addr *prod_hint)
1725 /* Reentrancy hazard: can call enter_new_state/enter_state_* */
1726 if (st->state!=SITE_RUN) return False;
1727 slog(st,LOG_SETUP_INIT,"initiating key exchange (%s)",reason);
1728 if (st->addresses) {
1729 slog(st,LOG_SETUP_INIT,"resolving peer address(es)");
1730 return enter_state_resolve(st);
1731 } else if (transport_compute_setupinit_peers(st,0,0,prod_hint)) {
1732 return enter_new_state(st,SITE_SENTMSG1,0);
1734 slog(st,LOG_SETUP_INIT,"key exchange failed: no address for peer");
1738 static void activate_new_key(struct site *st)
1740 struct transform_inst_if *t;
1742 /* We have three transform instances, which we swap between old,
1744 t=st->auxiliary_key.transform;
1745 st->auxiliary_key.transform=st->current.transform;
1746 st->current.transform=st->new_transform;
1747 st->new_transform=t;
1748 dispose_transform(&st->new_transform);
1751 st->auxiliary_is_new=0;
1752 st->auxiliary_key.key_timeout=st->current.key_timeout;
1753 st->current.key_timeout=st->now+st->key_lifetime;
1754 st->renegotiate_key_time=st->now+st->key_renegotiate_time;
1755 transport_peers_copy(st,&st->peers,&st->setup_peers);
1756 st->current.remote_session_id=st->setup_session_id;
1758 /* Compute the inter-site MTU. This is min( our_mtu, their_mtu ).
1759 * But their mtu be unspecified, in which case we just use ours. */
1760 uint32_t intersite_mtu=
1761 MIN(st->mtu_target, st->remote_adv_mtu ?: ~(uint32_t)0);
1762 st->netlink->set_mtu(st->netlink->st,intersite_mtu);
1764 slog(st,LOG_ACTIVATE_KEY,"new key activated"
1765 " (mtu ours=%"PRId32" theirs=%"PRId32" intersite=%"PRId32")",
1766 st->mtu_target, st->remote_adv_mtu, intersite_mtu);
1767 enter_state_run(st);
1770 static void delete_one_key(struct site *st, struct data_key *key,
1771 cstring_t reason, cstring_t which, uint32_t loglevel)
1773 if (!is_transform_valid(key->transform)) return;
1774 if (reason) slog(st,loglevel,"%s deleted (%s)",which,reason);
1775 dispose_transform(&key->transform);
1779 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel)
1781 if (current_valid(st)) {
1782 slog(st,loglevel,"session closed (%s)",reason);
1784 delete_one_key(st,&st->current,0,0,0);
1785 set_link_quality(st);
1787 delete_one_key(st,&st->auxiliary_key,0,0,0);
1790 static void state_assert(struct site *st, bool_t ok)
1792 if (!ok) fatal("site:state_assert");
1795 static void enter_state_stop(struct site *st)
1797 st->state=SITE_STOP;
1799 delete_keys(st,"entering state STOP",LOG_TIMEOUT_KEY);
1800 dispose_transform(&st->new_transform);
1803 static void set_link_quality(struct site *st)
1806 if (current_valid(st))
1807 quality=LINK_QUALITY_UP;
1808 else if (st->state==SITE_WAIT || st->state==SITE_STOP)
1809 quality=LINK_QUALITY_DOWN;
1810 else if (st->addresses)
1811 quality=LINK_QUALITY_DOWN_CURRENT_ADDRESS;
1812 else if (transport_peers_valid(&st->peers))
1813 quality=LINK_QUALITY_DOWN_STALE_ADDRESS;
1815 quality=LINK_QUALITY_DOWN;
1817 st->netlink->set_quality(st->netlink->st,quality);
1820 static void enter_state_run(struct site *st)
1822 slog(st,LOG_STATE,"entering state RUN%s",
1823 current_valid(st) ? " (keyed)" : " (unkeyed)");
1827 st->setup_session_id=0;
1828 transport_peers_clear(st,&st->setup_peers);
1829 keyset_dispose(&st->peerkeys_kex);
1830 FILLZERO(st->localN);
1831 FILLZERO(st->remoteN);
1832 dispose_transform(&st->new_transform);
1833 memset(st->dhsecret,0,st->dh->len);
1834 if (st->sharedsecret) memset(st->sharedsecret,0,st->sharedsecretlen);
1835 set_link_quality(st);
1837 if (st->keepalive && !current_valid(st))
1838 initiate_key_setup(st, "keepalive", 0);
1841 static bool_t ensure_resolving(struct site *st)
1843 /* Reentrancy hazard: may call site_resolve_callback and hence
1844 * enter_new_state, enter_state_* and generate_msg*. */
1845 if (st->resolving_count)
1848 assert(st->addresses);
1850 /* resolver->request might reentrantly call site_resolve_callback
1851 * which will decrement st->resolving, so we need to increment it
1852 * twice beforehand to prevent decrement from thinking we're
1853 * finished, and decrement it ourselves. Alternatively if
1854 * everything fails then there are no callbacks due and we simply
1855 * set it to 0 and return false.. */
1856 st->resolving_n_results_stored=0;
1857 st->resolving_n_results_all=0;
1858 st->resolving_count+=2;
1859 const char **addrp=st->addresses;
1860 const char *address;
1862 for (; (address=*addrp++); ) {
1863 bool_t ok = st->resolver->request(st->resolver->st,address,
1864 st->remoteport,st->comms[0],
1865 site_resolve_callback,st);
1867 st->resolving_count++;
1871 st->resolving_count=0;
1874 decrement_resolving_count(st,2);
1878 static bool_t enter_state_resolve(struct site *st)
1880 /* Reentrancy hazard! See ensure_resolving. */
1881 state_assert(st,st->state==SITE_RUN);
1882 slog(st,LOG_STATE,"entering state RESOLVE");
1883 st->state=SITE_RESOLVE;
1884 return ensure_resolving(st);
1887 static bool_t enter_new_state(struct site *st, uint32_t next,
1888 const struct msg *prompt
1889 /* may be 0 for SENTMSG1 */)
1891 bool_t (*gen)(struct site *st, const struct msg *prompt);
1894 slog(st,LOG_STATE,"entering state %s",state_name(next));
1897 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
1898 if (!kex_init(st)) return False;
1900 st->msg1_crossed_logged = False;
1903 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1904 st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
1905 if (!kex_init(st)) return False;
1909 state_assert(st,st->state==SITE_SENTMSG1);
1910 BUF_FREE(&st->buffer);
1914 state_assert(st,st->state==SITE_SENTMSG2);
1915 BUF_FREE(&st->buffer);
1919 state_assert(st,st->state==SITE_SENTMSG3);
1920 BUF_FREE(&st->buffer);
1924 state_assert(st,st->state==SITE_SENTMSG4);
1925 BUF_FREE(&st->buffer);
1930 fatal("enter_new_state(%s): invalid new state",state_name(next));
1934 if (hacky_par_start_failnow()) return False;
1936 r= gen(st,prompt) && send_msg(st);
1939 st->setup_retries, st->setup_retry_interval,
1944 if (next==SITE_RUN) {
1945 BUF_FREE(&st->buffer); /* Never reused */
1946 st->timeout=0; /* Never retransmit */
1947 activate_new_key(st);
1951 slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1952 st->buffer.free=False; /* Unconditionally use the buffer; it may be
1953 in either state, and enter_state_wait() will
1955 enter_state_wait(st);
1959 /* msg7 tells our peer that we're about to forget our key */
1960 static bool_t send_msg7(struct site *st, cstring_t reason)
1962 cstring_t transform_err;
1964 if (current_valid(st) && st->buffer.free
1965 && transport_peers_valid(&st->peers)) {
1966 BUF_ALLOC(&st->buffer,"site:MSG7");
1967 buffer_init(&st->buffer,calculate_max_start_pad());
1968 buf_append_uint32(&st->buffer,LABEL_MSG7);
1969 buf_append_string(&st->buffer,reason);
1970 if (call_transform_forwards(st, st->current.transform,
1971 &st->buffer, &transform_err))
1973 buf_prepend_uint32(&st->buffer,LABEL_MSG0);
1974 buf_prepend_uint32(&st->buffer,st->index);
1975 buf_prepend_uint32(&st->buffer,st->current.remote_session_id);
1976 transport_xmit(st,&st->peers,&st->buffer,True);
1977 BUF_FREE(&st->buffer);
1984 /* We go into this state if our peer becomes uncommunicative. Similar to
1985 the "stop" state, we forget all session keys for a while, before
1986 re-entering the "run" state. */
1987 static void enter_state_wait(struct site *st)
1989 slog(st,LOG_STATE,"entering state WAIT");
1990 st->timeout=st->now+wait_timeout(st);
1991 st->state=SITE_WAIT;
1992 set_link_quality(st);
1993 BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1994 /* XXX Erase keys etc. */
1997 static void generate_prod(struct site *st, struct buffer_if *buf)
2000 buf_append_uint32(buf,0);
2001 buf_append_uint32(buf,0);
2002 buf_append_uint32(buf,LABEL_PROD);
2003 buf_append_string(buf,st->localname);
2004 buf_append_string(buf,st->remotename);
2007 static void generate_send_prod(struct site *st,
2008 const struct comm_addr *source)
2010 if (!st->allow_send_prod) return; /* too soon */
2011 if (!(st->state==SITE_RUN || st->state==SITE_RESOLVE ||
2012 st->state==SITE_WAIT)) return; /* we'd ignore peer's MSG1 */
2014 slog(st,LOG_SETUP_INIT,"prodding peer for key exchange");
2015 st->allow_send_prod=0;
2016 generate_prod(st,&st->scratch);
2017 bool_t ok = comm_addr_sendmsg(st, source, &st->scratch);
2018 dump_packet(st,&st->scratch,source,False,ok);
2021 static inline void site_settimeout(uint64_t timeout, int *timeout_io)
2024 int64_t offset=timeout-*now;
2025 if (offset<0) offset=0;
2026 if (offset>INT_MAX) offset=INT_MAX;
2027 if (*timeout_io<0 || offset<*timeout_io)
2032 static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
2035 struct site *st=sst;
2037 BEFOREPOLL_WANT_FDS(0); /* We don't use any file descriptors */
2040 /* Work out when our next timeout is. The earlier of 'timeout' or
2041 'current.key_timeout'. A stored value of '0' indicates no timeout
2043 site_settimeout(st->timeout, timeout_io);
2044 site_settimeout(st->current.key_timeout, timeout_io);
2045 site_settimeout(st->auxiliary_key.key_timeout, timeout_io);
2047 return 0; /* success */
2050 static void check_expiry(struct site *st, struct data_key *key,
2053 if (key->key_timeout && *now>key->key_timeout) {
2054 delete_one_key(st,key,"maximum life exceeded",which,LOG_TIMEOUT_KEY);
2058 /* NB site_afterpoll will be called before site_beforepoll is ever called */
2059 static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
2061 struct site *st=sst;
2064 if (st->timeout && *now>st->timeout) {
2066 if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
2067 if (!hacky_par_start_failnow())
2069 } else if (st->state==SITE_WAIT) {
2070 enter_state_run(st);
2072 slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
2076 check_expiry(st,&st->current,"current key");
2077 check_expiry(st,&st->auxiliary_key,"auxiliary key");
2080 /* This function is called by the netlink device to deliver packets
2081 intended for the remote network. The packet is in "raw" wire
2082 format, but is guaranteed to be word-aligned. */
2083 static void site_outgoing(void *sst, struct buffer_if *buf)
2085 struct site *st=sst;
2086 cstring_t transform_err;
2088 if (st->state==SITE_STOP) {
2093 st->allow_send_prod=1;
2095 /* In all other states we consider delivering the packet if we have
2096 a valid key and a valid address to send it to. */
2097 if (current_valid(st) && transport_peers_valid(&st->peers)) {
2098 /* Transform it and send it */
2100 buf_prepend_uint32(buf,LABEL_MSG9);
2101 if (call_transform_forwards(st, st->current.transform,
2102 buf, &transform_err))
2104 buf_prepend_uint32(buf,LABEL_MSG0);
2105 buf_prepend_uint32(buf,st->index);
2106 buf_prepend_uint32(buf,st->current.remote_session_id);
2107 transport_xmit(st,&st->peers,buf,False);
2114 slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
2116 initiate_key_setup(st,"outgoing packet",0);
2119 static bool_t named_for_us(struct site *st, const struct buffer_if *buf_in,
2120 uint32_t type, struct msg *m,
2121 struct priomsg *whynot)
2122 /* For packets which are identified by the local and remote names.
2123 * If it has our name and our peer's name in it it's for us. */
2125 struct buffer_if buf[1];
2126 buffer_readonly_clone(buf,buf_in);
2128 if (!unpick_msg(st,type,buf,m)) {
2129 priomsg_update_fixed(whynot, comm_notify_whynot_unpick, "malformed");
2132 #define NAME_MATCHES(lr) \
2133 if (!name_matches(&m->lr, st->lr##name)) { \
2134 if (priomsg_update_fixed(whynot, comm_notify_whynot_name_##lr, \
2135 "unknown " #lr " name: ")) { \
2136 truncmsg_add_packet_string(&whynot->m, m->lr.len, m->lr.name); \
2140 NAME_MATCHES(remote);
2141 NAME_MATCHES(local );
2147 static bool_t we_have_priority(struct site *st, const struct msg *m) {
2148 if (st->local_capabilities & m->remote_capabilities &
2149 CAPAB_PRIORITY_MOBILE) {
2150 if (st->local_mobile) return True;
2151 if (st-> peer_mobile) return False;
2153 return st->our_name_later;
2156 static bool_t setup_late_msg_ok(struct site *st,
2157 const struct buffer_if *buf_in,
2159 const struct comm_addr *source,
2160 struct msg *m /* returned */) {
2161 /* For setup packets which seem from their type like they are
2162 * late. Maybe they came via a different path. All we do is make
2163 * a note of the sending address, iff they look like they are part
2164 * of the current key setup attempt. */
2165 if (!named_for_us(st,buf_in,msgtype,m,0))
2166 /* named_for_us calls unpick_msg which gets the nonces */
2168 if (!consttime_memeq(m->nR,st->remoteN,NONCELEN) ||
2169 !consttime_memeq(m->nL,st->localN, NONCELEN))
2170 /* spoof ? from stale run ? who knows */
2172 transport_setup_msgok(st,source);
2176 /* This function is called by the communication device to deliver
2177 packets from our peers.
2178 It should return True if the packet is recognised as being for
2179 this current site instance (and should therefore not be processed
2180 by other sites), even if the packet was otherwise ignored. */
2181 static bool_t site_incoming(void *sst, struct buffer_if *buf,
2182 const struct comm_addr *source,
2183 struct priomsg *whynot)
2185 struct site *st=sst;
2187 if (buf->size < 12) return False;
2189 uint32_t dest=get_uint32(buf->start);
2190 uint32_t msgtype=get_uint32(buf->start+8);
2192 /* initialised by named_for_us, or process_msgN for N!=1 */
2194 if (msgtype==LABEL_MSG1) {
2195 if (!named_for_us(st,buf,msgtype,&msg,whynot))
2197 /* It's a MSG1 addressed to us. Decide what to do about it. */
2198 dump_packet(st,buf,source,True,True);
2199 if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
2200 st->state==SITE_WAIT) {
2201 /* We should definitely process it */
2202 transport_compute_setupinit_peers(st,0,0,source);
2203 if (process_msg1(st,buf,source,&msg)) {
2204 slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
2205 bool_t entered=enter_new_state(st,SITE_SENTMSG2,&msg);
2206 if (entered && st->addresses && st->local_mobile)
2207 /* We must do this as the very last thing, because
2208 the resolver callback might reenter us. */
2209 ensure_resolving(st);
2211 slog(st,LOG_ERROR,"failed to process incoming msg1");
2215 } else if (st->state==SITE_SENTMSG1) {
2216 /* We've just sent a message 1! They may have crossed on
2217 the wire. If we have priority then we ignore the
2218 incoming one, otherwise we process it as usual. */
2219 if (we_have_priority(st,&msg)) {
2221 if (!st->msg1_crossed_logged++)
2222 slog(st,LOG_SETUP_INIT,"crossed msg1s; we are higher "
2223 "priority => ignore incoming msg1");
2226 slog(st,LOG_SETUP_INIT,"crossed msg1s; we are lower "
2227 "priority => use incoming msg1");
2228 if (process_msg1(st,buf,source,&msg)) {
2229 BUF_FREE(&st->buffer); /* Free our old message 1 */
2230 transport_setup_msgok(st,source);
2231 enter_new_state(st,SITE_SENTMSG2,&msg);
2233 slog(st,LOG_ERROR,"failed to process an incoming "
2234 "crossed msg1 (we have low priority)");
2239 } else if (st->state==SITE_SENTMSG2 ||
2240 st->state==SITE_SENTMSG4) {
2241 if (consttime_memeq(msg.nR,st->remoteN,NONCELEN)) {
2242 /* We are ahead in the protocol, but that msg1 had the
2243 * peer's nonce so presumably it is from this key
2244 * exchange run, via a slower route */
2245 transport_setup_msgok(st,source);
2247 slog(st,LOG_UNEXPECTED,"competing incoming message 1");
2252 /* The message 1 was received at an unexpected stage of the
2253 key setup. Well, they lost the race. */
2254 slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
2258 if (msgtype==LABEL_PROD) {
2259 if (!named_for_us(st,buf,msgtype,&msg,whynot))
2261 dump_packet(st,buf,source,True,True);
2262 if (st->state!=SITE_RUN) {
2263 slog(st,LOG_DROP,"ignoring PROD when not in state RUN");
2264 } else if (current_valid(st)) {
2265 slog(st,LOG_DROP,"ignoring PROD when we think we have a key");
2267 initiate_key_setup(st,"peer sent PROD packet",source);
2272 if (dest==st->index) {
2273 /* Explicitly addressed to us */
2274 if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True,True);
2277 /* If the source is our current peer then initiate a key setup,
2278 because our peer's forgotten the key */
2279 if (get_uint32(buf->start+4)==st->current.remote_session_id) {
2281 initiated = initiate_key_setup(st,"received a NAK",source);
2282 if (!initiated) generate_send_prod(st,source);
2284 slog(st,LOG_SEC,"bad incoming NAK");
2288 process_msg0(st,buf,source);
2291 /* Setup packet: should not have been explicitly addressed
2293 slog(st,LOG_SEC,"incoming explicitly addressed msg1");
2296 /* Setup packet: expected only in state SENTMSG1 */
2297 if (st->state!=SITE_SENTMSG1) {
2298 if ((st->state==SITE_SENTMSG3 ||
2299 st->state==SITE_SENTMSG5) &&
2300 setup_late_msg_ok(st,buf,msgtype,source,&msg))
2302 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
2303 } else if (process_msg2(st,buf,source,&msg)) {
2304 transport_setup_msgok(st,source);
2305 enter_new_state(st,SITE_SENTMSG3,&msg);
2307 slog(st,LOG_SEC,"invalid MSG2");
2310 case CASES_MSG3_KNOWN:
2311 /* Setup packet: expected only in state SENTMSG2 */
2312 if (st->state!=SITE_SENTMSG2) {
2313 if ((st->state==SITE_SENTMSG4) &&
2314 setup_late_msg_ok(st,buf,msgtype,source,&msg))
2316 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
2317 } else if (process_msg3(st,buf,source,msgtype,&msg)) {
2318 transport_setup_msgok(st,source);
2319 enter_new_state(st,SITE_SENTMSG4,&msg);
2321 slog(st,LOG_SEC,"invalid MSG3");
2325 /* Setup packet: expected only in state SENTMSG3 */
2326 if (st->state!=SITE_SENTMSG3) {
2327 if ((st->state==SITE_SENTMSG5) &&
2328 setup_late_msg_ok(st,buf,msgtype,source,&msg))
2330 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
2331 } else if (process_msg4(st,buf,source,&msg)) {
2332 transport_setup_msgok(st,source);
2333 enter_new_state(st,SITE_SENTMSG5,&msg);
2335 slog(st,LOG_SEC,"invalid MSG4");
2339 /* Setup packet: expected only in state SENTMSG4 */
2340 /* (may turn up in state RUN if our return MSG6 was lost
2341 and the new key has already been activated. In that
2342 case we discard it. The peer will realise that we
2343 are using the new key when they see our data packets.
2344 Until then the peer's data packets to us get discarded. */
2345 if (st->state==SITE_SENTMSG4) {
2346 if (process_msg5(st,buf,source,st->new_transform)) {
2347 transport_setup_msgok(st,source);
2348 enter_new_state(st,SITE_RUN,&msg);
2350 slog(st,LOG_SEC,"invalid MSG5");
2352 } else if (st->state==SITE_RUN) {
2353 if (process_msg5(st,buf,source,st->current.transform)) {
2354 slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
2355 transport_setup_msgok(st,source);
2356 create_msg6(st,st->current.transform,
2357 st->current.remote_session_id);
2358 transport_xmit(st,&st->peers,&st->buffer,True);
2359 BUF_FREE(&st->buffer);
2361 slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
2364 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
2368 /* Setup packet: expected only in state SENTMSG5 */
2369 if (st->state!=SITE_SENTMSG5) {
2370 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
2371 } else if (process_msg6(st,buf,source)) {
2372 BUF_FREE(&st->buffer); /* Free message 5 */
2373 transport_setup_msgok(st,source);
2374 activate_new_key(st);
2376 slog(st,LOG_SEC,"invalid MSG6");
2380 slog(st,LOG_SEC,"received message of unknown type 0x%08x",
2388 priomsg_update_fixed(whynot, comm_notify_whynot_general,
2389 "not MSG1 or PROD; unknown dest index");
2393 static void site_control(void *vst, bool_t run)
2395 struct site *st=vst;
2396 if (run) enter_state_run(st);
2397 else enter_state_stop(st);
2400 static void site_phase_hook(void *sst, uint32_t newphase)
2402 struct site *st=sst;
2404 /* The program is shutting down; tell our peer */
2405 send_msg7(st,"shutting down");
2408 static void site_childpersist_clearkeys(void *sst, uint32_t newphase)
2410 struct site *st=sst;
2411 dispose_transform(&st->current.transform);
2412 dispose_transform(&st->auxiliary_key.transform);
2413 dispose_transform(&st->new_transform);
2414 /* Not much point overwiting the signing key, since we loaded it
2415 from disk, and it is only valid prospectively if at all,
2417 /* XXX it would be best to overwrite the DH state, because that
2418 _is_ relevant to forward secrecy. However we have no
2419 convenient interface for doing that and in practice gmp has
2420 probably dribbled droppings all over the malloc arena. A good
2421 way to fix this would be to have a privsep child for asymmetric
2422 crypto operations, but that's a task for another day. */
2425 static void setup_sethash(struct site *st, dict_t *dict,
2426 struct hash_if **hash, struct cloc loc,
2427 sig_sethash_fn *sethash, void *sigkey_st) {
2428 if (!*hash) *hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
2429 sethash(sigkey_st,*hash);
2431 #define SETUP_SETHASH(k) do{ \
2433 setup_sethash(st,dict, &hash,loc, (k)->sethash,(k)->st); \
2436 static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
2439 static uint32_t index_sequence;
2447 st->cl.description="site";
2448 st->cl.type=CL_SITE;
2450 st->cl.interface=&st->ops;
2452 st->ops.control=site_control;
2453 st->ops.status=site_status;
2454 st->peerkeys_path=0;
2455 st->peerkeys_tmpl.buffer=0;
2456 st->peerkeys_current=st->peerkeys_kex=0;
2458 /* First parameter must be a dict */
2459 item=list_elem(args,0);
2460 if (!item || item->type!=t_dict)
2461 cfgfatal(loc,"site","parameter must be a dictionary\n");
2463 dict=item->data.dict;
2464 st->localname=dict_read_string(dict, "local-name", True, "site", loc);
2465 st->remotename=dict_read_string(dict, "name", True, "site", loc);
2467 st->keepalive=dict_read_bool(dict,"keepalive",False,"site",loc,False);
2469 st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
2471 dict_read_bool(dict,"local-mobile",False,"site",loc,False);
2473 /* Sanity check (which also allows the 'sites' file to include
2474 site() closures for all sites including our own): refuse to
2475 talk to ourselves */
2476 if (strcmp(st->localname,st->remotename)==0) {
2477 Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
2479 if (st->peer_mobile != st->local_mobile)
2480 cfgfatal(loc,"site","site %s's peer-mobile=%d"
2481 " but our local-mobile=%d\n",
2482 st->localname, st->peer_mobile, st->local_mobile);
2486 if (st->peer_mobile && st->local_mobile) {
2487 Message(M_WARNING,"site %s: site is mobile but so are we"
2488 " -> ignoring this site\n", st->remotename);
2493 assert(index_sequence < 0xffffffffUL);
2494 st->index = ++index_sequence;
2495 st->local_capabilities = 0;
2496 st->early_capabilities = CAPAB_PRIORITY_MOBILE;
2497 st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
2499 #define GET_CLOSURE_LIST(dictkey,things,nthings,CL_TYPE) do{ \
2500 list_t *things##_cfg=dict_lookup(dict,dictkey); \
2501 if (!things##_cfg) \
2502 cfgfatal(loc,"site","closure list \"%s\" not found\n",dictkey); \
2503 st->nthings=list_length(things##_cfg); \
2504 NEW_ARY(st->things,st->nthings); \
2505 assert(st->nthings); \
2506 for (i=0; i<st->nthings; i++) { \
2507 item_t *item=list_elem(things##_cfg,i); \
2508 if (item->type!=t_closure) \
2509 cfgfatal(loc,"site","%s is not a closure\n",dictkey); \
2510 closure_t *cl=item->data.closure; \
2511 if (cl->type!=CL_TYPE) \
2512 cfgfatal(loc,"site","%s closure wrong type\n",dictkey); \
2513 st->things[i]=cl->interface; \
2517 GET_CLOSURE_LIST("comm",comms,ncomms,CL_COMM);
2519 NEW_ARY(st->commclientinfos, st->ncomms);
2520 dict_t *comminfo = dict_read_dict(dict,"comm-info",False,"site",loc);
2521 for (i=0; i<st->ncomms; i++) {
2522 st->commclientinfos[i] =
2524 st->comms[i]->clientinfo(st->comms[i],comminfo,loc);
2527 st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
2528 st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
2529 st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
2531 struct hash_if *hash=0;
2533 st->privkeys=find_cl_if(dict,"key-cache",CL_PRIVCACHE,False,"site",loc);
2534 if (!st->privkeys) {
2536 find_cl_if(dict,"local-key",CL_SIGPRIVKEY,True,"site",loc);
2537 SETUP_SETHASH(st->privkey_fixed);
2540 struct sigpubkey_if *fixed_pubkey
2541 =find_cl_if(dict,"key",CL_SIGPUBKEY,False,"site",loc);
2542 st->peerkeys_path=dict_read_string(dict,"peer-keys",fixed_pubkey==0,
2544 if (st->peerkeys_path) {
2545 pathprefix_template_init(&st->peerkeys_tmpl,st->peerkeys_path,
2546 PEERKEYS_SUFFIX_MAXLEN + 1 /* nul */);
2547 st->peerkeys_current=keyset_load(st->peerkeys_path,
2548 &st->scratch,st->log,M_ERR);
2550 fixed_pubkey->dispose(fixed_pubkey->st);
2553 assert(fixed_pubkey);
2554 SETUP_SETHASH(fixed_pubkey);
2555 NEW(st->peerkeys_current);
2556 st->peerkeys_current->refcount=1;
2557 st->peerkeys_current->nkeys=1;
2558 st->peerkeys_current->keys[0].id=keyid_zero;
2559 st->peerkeys_current->keys[0].pubkey=fixed_pubkey;
2560 slog(st,LOG_SIGKEYS,
2561 "using old-style fixed peer public key (no `peer-keys')");
2564 st->addresses=dict_read_string_array(dict,"address",False,"site",loc,0);
2566 st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
2567 else st->remoteport=0;
2569 GET_CLOSURE_LIST("transform",transforms,ntransforms,CL_TRANSFORM);
2571 st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
2573 #define DEFAULT(D) (st->peer_mobile || st->local_mobile \
2574 ? DEFAULT_MOBILE_##D : DEFAULT_##D)
2575 #define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
2577 st->key_lifetime= CFG_NUMBER("key-lifetime", KEY_LIFETIME);
2578 st->setup_retries= CFG_NUMBER("setup-retries", SETUP_RETRIES);
2579 st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
2580 st->wait_timeout_mean= CFG_NUMBER("wait-time", WAIT_TIME);
2581 st->mtu_target= dict_read_number(dict,"mtu-target",False,"site",loc,0);
2583 st->mobile_peer_expiry= dict_read_number(
2584 dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
2586 const char *peerskey= st->peer_mobile
2587 ? "mobile-peers-max" : "static-peers-max";
2588 st->transport_peers_max= dict_read_number(
2589 dict,peerskey,False,"site",loc, st->addresses ? 4 : 3);
2590 if (st->transport_peers_max<1 ||
2591 st->transport_peers_max>MAX_PEER_ADDRS) {
2592 cfgfatal(loc,"site", "%s must be in range 1.."
2593 STRING(MAX_PEER_ADDRS) "\n", peerskey);
2596 if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
2597 st->key_renegotiate_time=st->key_lifetime/2;
2599 st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
2600 st->key_renegotiate_time=dict_read_number(
2601 dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
2602 if (st->key_renegotiate_time > st->key_lifetime) {
2603 cfgfatal(loc,"site",
2604 "renegotiate-time must be less than key-lifetime\n");
2607 st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
2608 log_event_table,"site");
2610 st->resolving_count=0;
2611 st->allow_send_prod=0;
2613 st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
2615 sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
2617 /* The information we expect to see in incoming messages of type 1 */
2618 /* fixme: lots of unchecked overflows here, but the results are only
2619 corrupted packets rather than undefined behaviour */
2620 st->our_name_later=(strcmp(st->localname,st->remotename)>0);
2622 buffer_new(&st->buffer,SETUP_BUFFER_LEN);
2624 buffer_new(&st->scratch,SETUP_BUFFER_LEN);
2625 BUF_ALLOC(&st->scratch,"site:scratch");
2627 /* We are interested in poll(), but only for timeouts. We don't have
2628 any fds of our own. */
2629 register_for_poll(st, site_beforepoll, site_afterpoll, "site");
2632 st->remote_capabilities=0;
2633 st->chosen_transform=0;
2634 st->current.key_timeout=0;
2635 st->auxiliary_key.key_timeout=0;
2636 transport_peers_clear(st,&st->peers);
2637 transport_peers_clear(st,&st->setup_peers);
2638 /* XXX mlock these */
2639 st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
2640 st->sharedsecretlen=st->sharedsecretallocd=0;
2643 #define SET_CAPBIT(bit) do { \
2644 uint32_t capflag = 1UL << (bit); \
2645 if (st->local_capabilities & capflag) \
2646 slog(st,LOG_ERROR,"capability bit" \
2647 " %d (%#"PRIx32") reused", (bit), capflag); \
2648 st->local_capabilities |= capflag; \
2651 for (i=0; i<st->ntransforms; i++)
2652 SET_CAPBIT(st->transforms[i]->capab_bit);
2656 if (st->local_mobile || st->peer_mobile)
2657 st->local_capabilities |= CAPAB_PRIORITY_MOBILE;
2659 /* We need to register the remote networks with the netlink device */
2660 uint32_t netlink_mtu; /* local virtual interface mtu */
2661 st->netlink->reg(st->netlink->st, site_outgoing, st, &netlink_mtu);
2662 if (!st->mtu_target)
2663 st->mtu_target=netlink_mtu;
2665 for (i=0; i<st->ncomms; i++)
2666 st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
2668 st->current.transform=0;
2669 st->auxiliary_key.transform=0;
2670 st->new_transform=0;
2671 st->auxiliary_is_new=0;
2673 enter_state_stop(st);
2675 add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
2676 add_hook(PHASE_CHILDPERSIST,site_childpersist_clearkeys,st);
2678 return new_closure(&st->cl);
2681 void site_module(dict_t *dict)
2683 add_closure(dict,"site",site_apply);
2687 /***** TRANSPORT PEERS definitions *****/
2689 static void transport_peers_debug(struct site *st, transport_peers *dst,
2690 const char *didwhat,
2691 int nargs, const struct comm_addr *args,
2696 if (!(st->log_events & LOG_PEER_ADDRS))
2697 return; /* an optimisation */
2699 slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
2700 (dst==&st->peers ? "data" :
2701 dst==&st->setup_peers ? "setup" : "UNKNOWN"),
2702 didwhat, nargs, dst->npeers);
2704 for (i=0, argp=(void*)args;
2706 i++, (argp+=stride?stride:sizeof(*args))) {
2707 const struct comm_addr *ca=(void*)argp;
2708 slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
2709 i, comm_addr_to_string(ca));
2711 for (i=0; i<dst->npeers; i++) {
2712 struct timeval diff;
2713 timersub(tv_now,&dst->peers[i].last,&diff);
2714 const struct comm_addr *ca=&dst->peers[i].addr;
2715 slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
2716 i, comm_addr_to_string(ca),
2717 (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
2721 static void transport_peers_expire(struct site *st, transport_peers *peers) {
2722 /* peers must be sorted first */
2723 int previous_peers=peers->npeers;
2724 struct timeval oldest;
2725 oldest.tv_sec = tv_now->tv_sec - st->mobile_peer_expiry;
2726 oldest.tv_usec = tv_now->tv_usec;
2727 while (peers->npeers>1 &&
2728 timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
2730 if (peers->npeers != previous_peers)
2731 transport_peers_debug(st,peers,"expire", 0,0,0);
2734 static bool_t transport_peer_record_one(struct site *st, transport_peers *peers,
2735 const struct comm_addr *ca,
2736 const struct timeval *tv) {
2737 /* returns false if output is full */
2740 if (peers->npeers >= st->transport_peers_max)
2743 for (search=0; search<peers->npeers; search++)
2744 if (comm_addr_equal(&peers->peers[search].addr, ca))
2747 peers->peers[peers->npeers].addr = *ca;
2748 peers->peers[peers->npeers].last = *tv;
2753 static void transport_record_peers(struct site *st, transport_peers *peers,
2754 const struct comm_addr *addrs, int naddrs,
2756 /* We add addrs into peers. The new entries end up at the front
2757 * and displace entries towards the end (perhaps even off the
2758 * end). Any existing matching entries are moved up to the front.
2760 * Caller must first call transport_peers_expire. */
2763 /* avoids debug for uninteresting updates */
2765 for (i=0; i<peers->npeers; i++) {
2766 if (comm_addr_equal(&addrs[0], &peers->peers[i].addr)) {
2767 memmove(peers->peers+1, peers->peers,
2768 sizeof(peers->peers[0]) * i);
2769 peers->peers[0].addr = addrs[0];
2770 peers->peers[0].last = *tv_now;
2776 int old_npeers=peers->npeers;
2777 transport_peer old_peers[old_npeers];
2778 COPY_ARRAY(old_peers,peers->peers,old_npeers);
2782 for (i=0; i<naddrs; i++) {
2783 if (!transport_peer_record_one(st,peers, &addrs[i], tv_now))
2786 for (i=0; i<old_npeers; i++) {
2787 const transport_peer *old=&old_peers[i];
2788 if (!transport_peer_record_one(st,peers, &old->addr, &old->last))
2792 transport_peers_debug(st,peers,m, naddrs,addrs,0);
2795 static void transport_expire_record_peers(struct site *st,
2796 transport_peers *peers,
2797 const struct comm_addr *addrs,
2798 int naddrs, const char *m) {
2799 /* Convenience function */
2800 transport_peers_expire(st,peers);
2801 transport_record_peers(st,peers,addrs,naddrs,m);
2804 static bool_t transport_compute_setupinit_peers(struct site *st,
2805 const struct comm_addr *configured_addrs /* 0 if none or not found */,
2806 int n_configured_addrs /* 0 if none or not found */,
2807 const struct comm_addr *incoming_packet_addr /* 0 if none */) {
2808 if (!n_configured_addrs && !incoming_packet_addr &&
2809 !transport_peers_valid(&st->peers))
2812 slog(st,LOG_SETUP_INIT,
2813 "using: %d configured addr(s);%s %d old peer addrs(es)",
2815 incoming_packet_addr ? " incoming packet address;" : "",
2818 /* Non-mobile peers try addresses until one is plausible. The
2819 * effect is that this code always tries first the configured
2820 * address if supplied, or otherwise the address of the incoming
2821 * PROD, or finally the existing data peer if one exists; this is
2824 transport_peers_copy(st,&st->setup_peers,&st->peers);
2825 transport_peers_expire(st,&st->setup_peers);
2827 if (incoming_packet_addr)
2828 transport_record_peers(st,&st->setup_peers,
2829 incoming_packet_addr,1, "incoming");
2831 if (n_configured_addrs)
2832 transport_record_peers(st,&st->setup_peers,
2833 configured_addrs,n_configured_addrs, "setupinit");
2835 assert(transport_peers_valid(&st->setup_peers));
2839 static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
2840 if (st->peer_mobile)
2841 transport_expire_record_peers(st,&st->setup_peers,a,1,"setupmsg");
2843 static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
2844 if (st->peer_mobile)
2845 transport_expire_record_peers(st,&st->peers,a,1,"datamsg");
2848 static int transport_peers_valid(transport_peers *peers) {
2849 return peers->npeers;
2851 static void transport_peers_clear(struct site *st, transport_peers *peers) {
2853 transport_peers_debug(st,peers,"clear",0,0,0);
2855 static void transport_peers_copy(struct site *st, transport_peers *dst,
2856 const transport_peers *src) {
2857 dst->npeers=src->npeers;
2858 COPY_ARRAY(dst->peers, src->peers, dst->npeers);
2859 transport_peers_debug(st,dst,"copy",
2860 src->npeers, &src->peers->addr, sizeof(*src->peers));
2863 static void transport_resolve_complete(struct site *st,
2864 const struct comm_addr *addrs,
2866 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2868 transport_expire_record_peers(st,&st->setup_peers,addrs,naddrs,
2872 static void transport_resolve_complete_tardy(struct site *st,
2873 const struct comm_addr *addrs,
2875 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2876 "resolved tardily");
2879 static void transport_peers__copy_by_mask(transport_peer *out, int *nout_io,
2881 const transport_peers *inp) {
2882 /* out and in->peers may be the same region, or nonoverlapping */
2883 const transport_peer *in=inp->peers;
2885 for (slot=0; slot<inp->npeers; slot++) {
2886 if (!(mask & (1U << slot)))
2888 if (!(out==in && slot==*nout_io))
2889 COPY_OBJ(out[*nout_io], in[slot]);
2894 void transport_xmit(struct site *st, transport_peers *peers,
2895 struct buffer_if *buf, bool_t candebug) {
2897 transport_peers_expire(st, peers);
2898 unsigned failed=0; /* bitmask */
2899 assert(MAX_PEER_ADDRS < sizeof(unsigned)*CHAR_BIT);
2902 for (slot=0; slot<peers->npeers; slot++) {
2903 transport_peer *peer=&peers->peers[slot];
2904 bool_t ok = comm_addr_sendmsg(st, &peer->addr, buf);
2906 dump_packet(st, buf, &peer->addr, False, ok);
2908 failed |= 1U << slot;
2911 if (ok && !st->peer_mobile)
2914 /* Now we need to demote/delete failing addrs: if we are mobile we
2915 * merely demote them; otherwise we delete them. */
2916 if (st->local_mobile) {
2917 unsigned expected = ((1U << nfailed)-1) << (peers->npeers-nfailed);
2918 /* `expected' has all the failures at the end already */
2919 if (failed != expected) {
2921 transport_peer failedpeers[nfailed];
2922 transport_peers__copy_by_mask(failedpeers, &fslot, failed,peers);
2923 assert(fslot == nfailed);
2925 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2926 assert(wslot+nfailed == peers->npeers);
2927 COPY_ARRAY(peers->peers+wslot, failedpeers, nfailed);
2928 transport_peers_debug(st,peers,"mobile failure reorder",0,0,0);
2931 if (failed && peers->npeers > 1) {
2933 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2934 peers->npeers=wslot;
2935 transport_peers_debug(st,peers,"non-mobile failure cleanup",0,0,0);
2940 /***** END of transport peers declarations *****/