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 our_name_later; /* our name > peer name */
334 /* runtime information */
336 uint64_t now; /* Most recently seen time */
337 bool_t allow_send_prod;
338 bool_t msg1_crossed_logged;
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 transform_apply_return \
474 call_transform_##fwdrev(struct site *st, \
475 struct transform_inst_if *transform, \
476 struct buffer_if *buf, \
477 const char **errmsg) \
479 if (!is_transform_valid(transform)) { \
480 *errmsg="transform not set up"; \
481 return transform_apply_err; \
483 return transform->fwdrev(transform->st,buf,errmsg); \
486 DEFINE_CALL_TRANSFORM(forwards)
487 DEFINE_CALL_TRANSFORM(reverse)
489 static void dispose_transform(struct transform_inst_if **transform_var)
491 struct transform_inst_if *transform=*transform_var;
493 transform->delkey(transform->st);
494 transform->destroy(transform->st);
499 #define CHECK_AVAIL(b,l) do { if ((b)->size<(l)) return False; } while(0)
500 #define CHECK_EMPTY(b) do { if ((b)->size!=0) return False; } while(0)
501 #define CHECK_TYPE(b,t) do { uint32_t type; \
502 CHECK_AVAIL((b),4); \
503 type=buf_unprepend_uint32((b)); \
504 if (type!=(t)) return False; } while(0)
506 static _Bool type_is_msg34(uint32_t type)
509 type == LABEL_MSG3 ||
510 type == LABEL_MSG3BIS ||
517 struct buffer_if extrainfo;
524 struct parsedname remote;
525 struct parsedname local;
526 uint32_t remote_capabilities;
528 int capab_transformnum;
538 static _Bool set_new_transform(struct site *st, char *pk)
542 /* Make room for the shared key */
543 st->sharedsecretlen=st->chosen_transform->keylen?:st->dh->ceil_len;
544 assert(st->sharedsecretlen);
545 if (st->sharedsecretlen > st->sharedsecretallocd) {
546 st->sharedsecretallocd=st->sharedsecretlen;
547 st->sharedsecret=safe_realloc_ary(st->sharedsecret,1,
548 st->sharedsecretallocd,
549 "site:sharedsecret");
552 /* Generate the shared key */
553 st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,pk,
554 st->sharedsecret,st->sharedsecretlen);
556 /* Set up the transform */
557 struct transform_if *generator=st->chosen_transform;
558 struct transform_inst_if *generated=generator->create(generator->st);
559 ok = generated->setkey(generated->st,st->sharedsecret,
560 st->sharedsecretlen,st->our_name_later);
562 dispose_transform(&st->new_transform);
563 if (!ok) return False;
564 st->new_transform=generated;
566 slog(st,LOG_SETUP_INIT,"key exchange negotiated transform"
567 " %d (capabilities ours=%#"PRIx32" theirs=%#"PRIx32")",
568 st->chosen_transform->capab_transformnum,
569 st->local_capabilities, st->remote_capabilities);
574 int32_t lenpos, afternul;
576 static void append_string_xinfo_start(struct buffer_if *buf,
577 struct xinfoadd *xia,
579 /* Helps construct one of the names with additional info as found
580 * in MSG1..4. Call this function first, then append all the
581 * desired extra info (not including the nul byte) to the buffer,
582 * then call append_string_xinfo_done. */
584 xia->lenpos = buf->size;
585 buf_append_string(buf,str);
586 buf_append_uint8(buf,0);
587 xia->afternul = buf->size;
589 static void append_string_xinfo_done(struct buffer_if *buf,
590 struct xinfoadd *xia)
592 /* we just need to adjust the string length */
593 if (buf->size == xia->afternul) {
594 /* no extra info, strip the nul too */
595 buf_unappend_uint8(buf);
597 put_uint16(buf->start+xia->lenpos, buf->size-(xia->lenpos+2));
601 /* Build any of msg1 to msg4. msg5 and msg6 are built from the inside
602 out using a transform of config data supplied by netlink */
603 static bool_t generate_msg(struct site *st, uint32_t type, cstring_t what)
609 st->retries=st->setup_retries;
610 BUF_ALLOC(&st->buffer,what);
611 buffer_init(&st->buffer,0);
612 buf_append_uint32(&st->buffer,
613 (type==LABEL_MSG1?0:st->setup_session_id));
614 buf_append_uint32(&st->buffer,st->index);
615 buf_append_uint32(&st->buffer,type);
618 append_string_xinfo_start(&st->buffer,&xia,st->localname);
619 if ((st->local_capabilities & CAPAB_EARLY) || (type != LABEL_MSG1)) {
620 buf_append_uint32(&st->buffer,st->local_capabilities);
622 if (type_is_msg34(type)) {
623 buf_append_uint16(&st->buffer,st->mtu_target);
625 append_string_xinfo_done(&st->buffer,&xia);
627 buf_append_string(&st->buffer,st->remotename);
628 BUF_ADD_OBJ(append,&st->buffer,st->localN);
629 if (type==LABEL_MSG1) return True;
630 BUF_ADD_OBJ(append,&st->buffer,st->remoteN);
631 if (type==LABEL_MSG2) return True;
633 if (hacky_par_mid_failnow()) return False;
635 if (type==LABEL_MSG3BIS)
636 buf_append_uint8(&st->buffer,st->chosen_transform->capab_transformnum);
638 dhpub=st->dh->makepublic(st->dh->st,st->dhsecret,st->dh->len);
639 buf_append_string(&st->buffer,dhpub);
641 hash=safe_malloc(st->hash->len, "generate_msg");
642 hst=st->hash->init();
643 st->hash->update(hst,st->buffer.start,st->buffer.size);
644 st->hash->final(hst,hash);
645 sig=st->privkey->sign(st->privkey->st,hash,st->hash->len);
646 buf_append_string(&st->buffer,sig);
652 static bool_t unpick_name(struct buffer_if *msg, struct parsedname *nm)
655 nm->len=buf_unprepend_uint16(msg);
656 CHECK_AVAIL(msg,nm->len);
657 nm->name=buf_unprepend(msg,nm->len);
658 uint8_t *nul=memchr(nm->name,0,nm->len);
660 buffer_readonly_view(&nm->extrainfo,0,0);
662 buffer_readonly_view(&nm->extrainfo, nul+1, msg->start-(nul+1));
663 nm->len=nul-nm->name;
668 static bool_t unpick_msg(struct site *st, uint32_t type,
669 struct buffer_if *msg, struct msg *m)
671 m->capab_transformnum=-1;
672 m->hashstart=msg->start;
674 m->dest=buf_unprepend_uint32(msg);
676 m->source=buf_unprepend_uint32(msg);
677 CHECK_TYPE(msg,type);
678 if (!unpick_name(msg,&m->remote)) return False;
679 m->remote_capabilities=0;
681 if (m->remote.extrainfo.size) {
682 CHECK_AVAIL(&m->remote.extrainfo,4);
683 m->remote_capabilities=buf_unprepend_uint32(&m->remote.extrainfo);
685 if (type_is_msg34(type) && m->remote.extrainfo.size) {
686 CHECK_AVAIL(&m->remote.extrainfo,2);
687 m->remote_mtu=buf_unprepend_uint16(&m->remote.extrainfo);
689 if (!unpick_name(msg,&m->local)) return False;
690 if (type==LABEL_PROD) {
694 CHECK_AVAIL(msg,NONCELEN);
695 m->nR=buf_unprepend(msg,NONCELEN);
696 if (type==LABEL_MSG1) {
700 CHECK_AVAIL(msg,NONCELEN);
701 m->nL=buf_unprepend(msg,NONCELEN);
702 if (type==LABEL_MSG2) {
706 if (type==LABEL_MSG3BIS) {
708 m->capab_transformnum = buf_unprepend_uint8(msg);
710 m->capab_transformnum = CAPAB_TRANSFORMNUM_ANCIENT;
713 m->pklen=buf_unprepend_uint16(msg);
714 CHECK_AVAIL(msg,m->pklen);
715 m->pk=buf_unprepend(msg,m->pklen);
716 m->hashlen=msg->start-m->hashstart;
718 m->siglen=buf_unprepend_uint16(msg);
719 CHECK_AVAIL(msg,m->siglen);
720 m->sig=buf_unprepend(msg,m->siglen);
723 /* In `process_msg3_msg4' below, we assume that we can write a nul
724 * terminator following the signature. Make sure there's enough space.
726 if (msg->start >= msg->base + msg->alloclen)
732 static bool_t name_matches(const struct parsedname *nm, const char *expected)
734 int expected_len=strlen(expected);
736 nm->len == expected_len &&
737 !memcmp(nm->name, expected, expected_len);
740 static bool_t check_msg(struct site *st, uint32_t type, struct msg *m,
743 if (type==LABEL_MSG1) return True;
745 /* Check that the site names and our nonce have been sent
746 back correctly, and then store our peer's nonce. */
747 if (!name_matches(&m->remote,st->remotename)) {
748 *error="wrong remote site name";
751 if (!name_matches(&m->local,st->localname)) {
752 *error="wrong local site name";
755 if (memcmp(m->nL,st->localN,NONCELEN)!=0) {
756 *error="wrong locally-generated nonce";
759 if (type==LABEL_MSG2) return True;
760 if (!consttime_memeq(m->nR,st->remoteN,NONCELEN)!=0) {
761 *error="wrong remotely-generated nonce";
764 /* MSG3 has complicated rules about capabilities, which are
765 * handled in process_msg3. */
766 if (type==LABEL_MSG3 || type==LABEL_MSG3BIS) return True;
767 if (m->remote_capabilities!=st->remote_capabilities) {
768 *error="remote capabilities changed";
771 if (type==LABEL_MSG4) return True;
772 *error="unknown message type";
776 static bool_t generate_msg1(struct site *st)
778 st->random->generate(st->random->st,NONCELEN,st->localN);
779 return generate_msg(st,LABEL_MSG1,"site:MSG1");
782 static bool_t process_msg1(struct site *st, struct buffer_if *msg1,
783 const struct comm_addr *src, struct msg *m)
785 /* We've already determined we're in an appropriate state to
786 process an incoming MSG1, and that the MSG1 has correct values
789 st->setup_session_id=m->source;
790 st->remote_capabilities=m->remote_capabilities;
791 memcpy(st->remoteN,m->nR,NONCELEN);
795 static bool_t generate_msg2(struct site *st)
797 st->random->generate(st->random->st,NONCELEN,st->localN);
798 return generate_msg(st,LABEL_MSG2,"site:MSG2");
801 static bool_t process_msg2(struct site *st, struct buffer_if *msg2,
802 const struct comm_addr *src)
807 if (!unpick_msg(st,LABEL_MSG2,msg2,&m)) return False;
808 if (!check_msg(st,LABEL_MSG2,&m,&err)) {
809 slog(st,LOG_SEC,"msg2: %s",err);
812 st->setup_session_id=m.source;
813 st->remote_capabilities=m.remote_capabilities;
815 /* Select the transform to use */
817 uint32_t remote_transforms = st->remote_capabilities & CAPAB_TRANSFORM_MASK;
818 if (!remote_transforms)
819 /* old secnets only had this one transform */
820 remote_transforms = 1UL << CAPAB_TRANSFORMNUM_ANCIENT;
822 struct transform_if *ti;
824 for (i=0; i<st->ntransforms; i++) {
825 ti=st->transforms[i];
826 if ((1UL << ti->capab_transformnum) & remote_transforms)
827 goto transform_found;
829 slog(st,LOG_ERROR,"no transforms in common"
830 " (us %#"PRIx32"; them: %#"PRIx32")",
831 st->local_capabilities & CAPAB_TRANSFORM_MASK,
835 st->chosen_transform=ti;
837 memcpy(st->remoteN,m.nR,NONCELEN);
841 static bool_t generate_msg3(struct site *st)
843 /* Now we have our nonce and their nonce. Think of a secret key,
844 and create message number 3. */
845 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
846 return generate_msg(st,
847 (st->remote_capabilities & CAPAB_TRANSFORM_MASK
848 ? LABEL_MSG3BIS : LABEL_MSG3),
852 static bool_t process_msg3_msg4(struct site *st, struct msg *m)
857 /* Check signature and store g^x mod m */
858 hash=safe_malloc(st->hash->len, "process_msg3_msg4");
859 hst=st->hash->init();
860 st->hash->update(hst,m->hashstart,m->hashlen);
861 st->hash->final(hst,hash);
862 /* Terminate signature with a '0' - already checked that this will fit */
864 if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m->sig)) {
865 slog(st,LOG_SEC,"msg3/msg4 signature failed check!");
871 st->remote_adv_mtu=m->remote_mtu;
876 static bool_t process_msg3(struct site *st, struct buffer_if *msg3,
877 const struct comm_addr *src, uint32_t msgtype)
882 assert(msgtype==LABEL_MSG3 || msgtype==LABEL_MSG3BIS);
884 if (!unpick_msg(st,msgtype,msg3,&m)) return False;
885 if (!check_msg(st,msgtype,&m,&err)) {
886 slog(st,LOG_SEC,"msg3: %s",err);
889 uint32_t capab_adv_late = m.remote_capabilities
890 & ~st->remote_capabilities & CAPAB_EARLY;
891 if (capab_adv_late) {
892 slog(st,LOG_SEC,"msg3 impermissibly adds early capability flag(s)"
893 " %#"PRIx32" (was %#"PRIx32", now %#"PRIx32")",
894 capab_adv_late, st->remote_capabilities, m.remote_capabilities);
897 st->remote_capabilities|=m.remote_capabilities;
899 struct transform_if *ti;
901 for (i=0; i<st->ntransforms; i++) {
902 ti=st->transforms[i];
903 if (ti->capab_transformnum == m.capab_transformnum)
904 goto transform_found;
906 slog(st,LOG_SEC,"peer chose unknown-to-us transform %d!",
907 m.capab_transformnum);
910 st->chosen_transform=ti;
912 if (!process_msg3_msg4(st,&m))
915 /* Terminate their DH public key with a '0' */
917 /* Invent our DH secret key */
918 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
920 /* Generate the shared key and set up the transform */
921 if (!set_new_transform(st,m.pk)) return False;
926 static bool_t generate_msg4(struct site *st)
928 /* We have both nonces, their public key and our private key. Generate
929 our public key, sign it and send it to them. */
930 return generate_msg(st,LABEL_MSG4,"site:MSG4");
933 static bool_t process_msg4(struct site *st, struct buffer_if *msg4,
934 const struct comm_addr *src)
939 if (!unpick_msg(st,LABEL_MSG4,msg4,&m)) return False;
940 if (!check_msg(st,LABEL_MSG4,&m,&err)) {
941 slog(st,LOG_SEC,"msg4: %s",err);
945 if (!process_msg3_msg4(st,&m))
948 /* Terminate their DH public key with a '0' */
951 /* Generate the shared key and set up the transform */
952 if (!set_new_transform(st,m.pk)) return False;
963 static bool_t unpick_msg0(struct site *st, struct buffer_if *msg0,
967 m->dest=buf_unprepend_uint32(msg0);
969 m->source=buf_unprepend_uint32(msg0);
971 m->type=buf_unprepend_uint32(msg0);
973 /* Leaves transformed part of buffer untouched */
976 static bool_t generate_msg5(struct site *st)
978 cstring_t transform_err;
980 BUF_ALLOC(&st->buffer,"site:MSG5");
981 /* We are going to add four words to the message */
982 buffer_init(&st->buffer,calculate_max_start_pad());
983 /* Give the netlink code an opportunity to put its own stuff in the
984 message (configuration information, etc.) */
985 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
986 if (call_transform_forwards(st,st->new_transform,
987 &st->buffer,&transform_err))
989 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
990 buf_prepend_uint32(&st->buffer,st->index);
991 buf_prepend_uint32(&st->buffer,st->setup_session_id);
993 st->retries=st->setup_retries;
997 static bool_t process_msg5(struct site *st, struct buffer_if *msg5,
998 const struct comm_addr *src,
999 struct transform_inst_if *transform)
1002 cstring_t transform_err;
1004 if (!unpick_msg0(st,msg5,&m)) return False;
1006 if (call_transform_reverse(st,transform,msg5,&transform_err)) {
1007 /* There's a problem */
1008 slog(st,LOG_SEC,"process_msg5: transform: %s",transform_err);
1011 /* Buffer should now contain untransformed PING packet data */
1012 CHECK_AVAIL(msg5,4);
1013 if (buf_unprepend_uint32(msg5)!=LABEL_MSG5) {
1014 slog(st,LOG_SEC,"MSG5/PING packet contained wrong label");
1017 /* Older versions of secnet used to write some config data here
1018 * which we ignore. So we don't CHECK_EMPTY */
1022 static void create_msg6(struct site *st, struct transform_inst_if *transform,
1023 uint32_t session_id)
1025 cstring_t transform_err;
1027 BUF_ALLOC(&st->buffer,"site:MSG6");
1028 /* We are going to add four words to the message */
1029 buffer_init(&st->buffer,calculate_max_start_pad());
1030 /* Give the netlink code an opportunity to put its own stuff in the
1031 message (configuration information, etc.) */
1032 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1033 transform_apply_return problem =
1034 call_transform_forwards(st,transform,
1035 &st->buffer,&transform_err);
1037 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
1038 buf_prepend_uint32(&st->buffer,st->index);
1039 buf_prepend_uint32(&st->buffer,session_id);
1042 static bool_t generate_msg6(struct site *st)
1044 if (!is_transform_valid(st->new_transform))
1046 create_msg6(st,st->new_transform,st->setup_session_id);
1047 st->retries=1; /* Peer will retransmit MSG5 if this packet gets lost */
1051 static bool_t process_msg6(struct site *st, struct buffer_if *msg6,
1052 const struct comm_addr *src)
1055 cstring_t transform_err;
1057 if (!unpick_msg0(st,msg6,&m)) return False;
1059 if (call_transform_reverse(st,st->new_transform,msg6,&transform_err)) {
1060 /* There's a problem */
1061 slog(st,LOG_SEC,"process_msg6: transform: %s",transform_err);
1064 /* Buffer should now contain untransformed PING packet data */
1065 CHECK_AVAIL(msg6,4);
1066 if (buf_unprepend_uint32(msg6)!=LABEL_MSG6) {
1067 slog(st,LOG_SEC,"MSG6/PONG packet contained invalid data");
1070 /* Older versions of secnet used to write some config data here
1071 * which we ignore. So we don't CHECK_EMPTY */
1075 static transform_apply_return
1076 decrypt_msg0(struct site *st, struct buffer_if *msg0,
1077 const struct comm_addr *src)
1079 cstring_t transform_err, auxkey_err, newkey_err="n/a";
1081 transform_apply_return problem;
1083 if (!unpick_msg0(st,msg0,&m)) return False;
1085 /* Keep a copy so we can try decrypting it with multiple keys */
1086 buffer_copy(&st->scratch, msg0);
1088 problem = call_transform_reverse(st,st->current.transform,
1089 msg0,&transform_err);
1091 if (!st->auxiliary_is_new)
1092 delete_one_key(st,&st->auxiliary_key,
1093 "peer has used new key","auxiliary key",LOG_SEC);
1096 if (transform_apply_return_badseq(problem))
1099 buffer_copy(msg0, &st->scratch);
1100 problem = call_transform_reverse(st,st->auxiliary_key.transform,
1103 slog(st,LOG_DROP,"processing packet which uses auxiliary key");
1104 if (st->auxiliary_is_new) {
1105 /* We previously timed out in state SENTMSG5 but it turns
1106 * out that our peer did in fact get our MSG5 and is
1107 * using the new key. So we should switch to it too. */
1108 /* This is a bit like activate_new_key. */
1111 st->current=st->auxiliary_key;
1112 st->auxiliary_key=t;
1114 delete_one_key(st,&st->auxiliary_key,"peer has used new key",
1115 "previous key",LOG_SEC);
1116 st->auxiliary_is_new=0;
1117 st->renegotiate_key_time=st->auxiliary_renegotiate_key_time;
1121 if (transform_apply_return_badseq(problem))
1124 if (st->state==SITE_SENTMSG5) {
1125 buffer_copy(msg0, &st->scratch);
1126 problem = call_transform_reverse(st,st->new_transform,
1129 /* It looks like we didn't get the peer's MSG6 */
1130 /* This is like a cut-down enter_new_state(SITE_RUN) */
1131 slog(st,LOG_STATE,"will enter state RUN (MSG0 with new key)");
1132 BUF_FREE(&st->buffer);
1134 activate_new_key(st);
1135 return 0; /* do process the data in this packet */
1137 if (transform_apply_return_badseq(problem))
1141 slog(st,LOG_SEC,"transform: %s (aux: %s, new: %s)",
1142 transform_err,auxkey_err,newkey_err);
1143 initiate_key_setup(st,"incoming message would not decrypt",0);
1144 send_nak(src,m.dest,m.source,m.type,msg0,"message would not decrypt");
1149 slog(st,LOG_DROP,"transform: %s (bad seq.)",transform_err);
1154 static bool_t process_msg0(struct site *st, struct buffer_if *msg0,
1155 const struct comm_addr *src)
1158 transform_apply_return problem;
1160 problem = decrypt_msg0(st,msg0,src);
1161 if (problem==transform_apply_seqdupe) {
1162 /* We recently received another copy of this packet, maybe due
1163 * to polypath. That's not a problem; indeed, for the
1164 * purposes of transport address management it is a success.
1165 * But we don't want to process the packet. */
1166 transport_data_msgok(st,src);
1172 CHECK_AVAIL(msg0,4);
1173 type=buf_unprepend_uint32(msg0);
1176 /* We must forget about the current session. */
1177 delete_keys(st,"request from peer",LOG_SEC);
1178 /* probably, the peer is shutting down, and this is going to fail,
1179 * but we need to be trying to bring the link up again */
1181 initiate_key_setup(st,"peer requested key teardown",0);
1184 /* Deliver to netlink layer */
1185 st->netlink->deliver(st->netlink->st,msg0);
1186 transport_data_msgok(st,src);
1187 /* See whether we should start negotiating a new key */
1188 if (st->now > st->renegotiate_key_time)
1189 initiate_key_setup(st,"incoming packet in renegotiation window",0);
1192 slog(st,LOG_SEC,"incoming encrypted message of type %08x "
1199 static void dump_packet(struct site *st, struct buffer_if *buf,
1200 const struct comm_addr *addr, bool_t incoming,
1203 uint32_t dest=get_uint32(buf->start);
1204 uint32_t source=get_uint32(buf->start+4);
1205 uint32_t msgtype=get_uint32(buf->start+8);
1207 if (st->log_events & LOG_DUMP)
1208 slilog(st->log,M_DEBUG,"%s: %s: %08x<-%08x: %08x: %s%s",
1209 st->tunname,incoming?"incoming":"outgoing",
1210 dest,source,msgtype,comm_addr_to_string(addr),
1214 static bool_t comm_addr_sendmsg(struct site *st,
1215 const struct comm_addr *dest,
1216 struct buffer_if *buf)
1219 struct comm_clientinfo *commclientinfo = 0;
1221 for (i=0; i < st->ncomms; i++) {
1222 if (st->comms[i] == dest->comm) {
1223 commclientinfo = st->commclientinfos[i];
1227 return dest->comm->sendmsg(dest->comm->st, buf, dest, commclientinfo);
1230 static uint32_t site_status(void *st)
1235 static bool_t send_msg(struct site *st)
1237 if (st->retries>0) {
1238 transport_xmit(st, &st->setup_peers, &st->buffer, True);
1239 st->timeout=st->now+st->setup_retry_interval;
1242 } else if (st->state==SITE_SENTMSG5) {
1243 logtimeout(st,"timed out sending MSG5, stashing new key");
1244 /* We stash the key we have produced, in case it turns out that
1245 * our peer did see our MSG5 after all and starts using it. */
1246 /* This is a bit like some of activate_new_key */
1247 struct transform_inst_if *t;
1248 t=st->auxiliary_key.transform;
1249 st->auxiliary_key.transform=st->new_transform;
1250 st->new_transform=t;
1251 dispose_transform(&st->new_transform);
1253 st->auxiliary_is_new=1;
1254 st->auxiliary_key.key_timeout=st->now+st->key_lifetime;
1255 st->auxiliary_renegotiate_key_time=st->now+st->key_renegotiate_time;
1256 st->auxiliary_key.remote_session_id=st->setup_session_id;
1258 enter_state_wait(st);
1261 logtimeout(st,"timed out sending key setup packet "
1262 "(in state %s)",state_name(st->state));
1263 enter_state_wait(st);
1268 static void site_resolve_callback(void *sst, const struct comm_addr *addrs,
1269 int stored_naddrs, int all_naddrs,
1270 const char *address, const char *failwhy)
1272 struct site *st=sst;
1274 if (!stored_naddrs) {
1275 slog(st,LOG_ERROR,"resolution of %s failed: %s",address,failwhy);
1277 slog(st,LOG_PEER_ADDRS,"resolution of %s completed, %d addrs, eg: %s",
1278 address, all_naddrs, comm_addr_to_string(&addrs[0]));;
1280 int space=st->transport_peers_max-st->resolving_n_results_stored;
1281 int n_tocopy=MIN(stored_naddrs,space);
1282 COPY_ARRAY(st->resolving_results + st->resolving_n_results_stored,
1285 st->resolving_n_results_stored += n_tocopy;
1286 st->resolving_n_results_all += all_naddrs;
1289 decrement_resolving_count(st,1);
1292 static void decrement_resolving_count(struct site *st, int by)
1294 assert(st->resolving_count>0);
1295 st->resolving_count-=by;
1297 if (st->resolving_count)
1300 /* OK, we are done with them all. Handle combined results. */
1302 const struct comm_addr *addrs=st->resolving_results;
1303 int naddrs=st->resolving_n_results_stored;
1304 assert(naddrs<=st->transport_peers_max);
1307 if (naddrs != st->resolving_n_results_all) {
1308 slog(st,LOG_SETUP_INIT,"resolution of supplied addresses/names"
1309 " yielded too many results (%d > %d), some ignored",
1310 st->resolving_n_results_all, naddrs);
1312 slog(st,LOG_STATE,"resolution completed, %d addrs, eg: %s",
1313 naddrs, iaddr_to_string(&addrs[0].ia));;
1316 switch (st->state) {
1318 if (transport_compute_setupinit_peers(st,addrs,naddrs,0)) {
1319 enter_new_state(st,SITE_SENTMSG1);
1321 /* Can't figure out who to try to to talk to */
1322 slog(st,LOG_SETUP_INIT,
1323 "key exchange failed: cannot find peer address");
1324 enter_state_run(st);
1327 case SITE_SENTMSG1: case SITE_SENTMSG2:
1328 case SITE_SENTMSG3: case SITE_SENTMSG4:
1331 /* We start using the address immediately for data too.
1332 * It's best to store it in st->peers now because we might
1333 * go via SENTMSG5, WAIT, and a MSG0, straight into using
1334 * the new key (without updating the data peer addrs). */
1335 transport_resolve_complete(st,addrs,naddrs);
1336 } else if (st->local_mobile) {
1337 /* We can't let this rest because we may have a peer
1338 * address which will break in the future. */
1339 slog(st,LOG_SETUP_INIT,"resolution failed: "
1340 "abandoning key exchange");
1341 enter_state_wait(st);
1343 slog(st,LOG_SETUP_INIT,"resolution failed: "
1344 " continuing to use source address of peer's packets"
1345 " for key exchange and ultimately data");
1350 slog(st,LOG_SETUP_INIT,"resolution completed tardily,"
1351 " updating peer address(es)");
1352 transport_resolve_complete_tardy(st,addrs,naddrs);
1353 } else if (st->local_mobile) {
1354 /* Not very good. We should queue (another) renegotiation
1355 * so that we can update the peer address. */
1356 st->key_renegotiate_time=st->now+st->wait_timeout;
1358 slog(st,LOG_SETUP_INIT,"resolution failed: "
1359 " continuing to use source address of peer's packets");
1369 static bool_t initiate_key_setup(struct site *st, cstring_t reason,
1370 const struct comm_addr *prod_hint)
1372 /* Reentrancy hazard: can call enter_new_state/enter_state_* */
1373 if (st->state!=SITE_RUN) return False;
1374 slog(st,LOG_SETUP_INIT,"initiating key exchange (%s)",reason);
1375 if (st->addresses) {
1376 slog(st,LOG_SETUP_INIT,"resolving peer address(es)");
1377 return enter_state_resolve(st);
1378 } else if (transport_compute_setupinit_peers(st,0,0,prod_hint)) {
1379 return enter_new_state(st,SITE_SENTMSG1);
1381 slog(st,LOG_SETUP_INIT,"key exchange failed: no address for peer");
1385 static void activate_new_key(struct site *st)
1387 struct transform_inst_if *t;
1389 /* We have three transform instances, which we swap between old,
1391 t=st->auxiliary_key.transform;
1392 st->auxiliary_key.transform=st->current.transform;
1393 st->current.transform=st->new_transform;
1394 st->new_transform=t;
1395 dispose_transform(&st->new_transform);
1398 st->auxiliary_is_new=0;
1399 st->auxiliary_key.key_timeout=st->current.key_timeout;
1400 st->current.key_timeout=st->now+st->key_lifetime;
1401 st->renegotiate_key_time=st->now+st->key_renegotiate_time;
1402 transport_peers_copy(st,&st->peers,&st->setup_peers);
1403 st->current.remote_session_id=st->setup_session_id;
1405 /* Compute the inter-site MTU. This is min( our_mtu, their_mtu ).
1406 * But their mtu be unspecified, in which case we just use ours. */
1407 uint32_t intersite_mtu=
1408 MIN(st->mtu_target, st->remote_adv_mtu ?: ~(uint32_t)0);
1409 st->netlink->set_mtu(st->netlink->st,intersite_mtu);
1411 slog(st,LOG_ACTIVATE_KEY,"new key activated"
1412 " (mtu ours=%"PRId32" theirs=%"PRId32" intersite=%"PRId32")",
1413 st->mtu_target, st->remote_adv_mtu, intersite_mtu);
1414 enter_state_run(st);
1417 static void delete_one_key(struct site *st, struct data_key *key,
1418 cstring_t reason, cstring_t which, uint32_t loglevel)
1420 if (!is_transform_valid(key->transform)) return;
1421 if (reason) slog(st,loglevel,"%s deleted (%s)",which,reason);
1422 dispose_transform(&key->transform);
1426 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel)
1428 if (current_valid(st)) {
1429 slog(st,loglevel,"session closed (%s)",reason);
1431 delete_one_key(st,&st->current,0,0,0);
1432 set_link_quality(st);
1434 delete_one_key(st,&st->auxiliary_key,0,0,0);
1437 static void state_assert(struct site *st, bool_t ok)
1439 if (!ok) fatal("site:state_assert");
1442 static void enter_state_stop(struct site *st)
1444 st->state=SITE_STOP;
1446 delete_keys(st,"entering state STOP",LOG_TIMEOUT_KEY);
1447 dispose_transform(&st->new_transform);
1450 static void set_link_quality(struct site *st)
1453 if (current_valid(st))
1454 quality=LINK_QUALITY_UP;
1455 else if (st->state==SITE_WAIT || st->state==SITE_STOP)
1456 quality=LINK_QUALITY_DOWN;
1457 else if (st->addresses)
1458 quality=LINK_QUALITY_DOWN_CURRENT_ADDRESS;
1459 else if (transport_peers_valid(&st->peers))
1460 quality=LINK_QUALITY_DOWN_STALE_ADDRESS;
1462 quality=LINK_QUALITY_DOWN;
1464 st->netlink->set_quality(st->netlink->st,quality);
1467 static void enter_state_run(struct site *st)
1469 slog(st,LOG_STATE,"entering state RUN");
1473 st->setup_session_id=0;
1474 transport_peers_clear(st,&st->setup_peers);
1475 FILLZERO(st->localN);
1476 FILLZERO(st->remoteN);
1477 dispose_transform(&st->new_transform);
1478 memset(st->dhsecret,0,st->dh->len);
1479 if (st->sharedsecret) memset(st->sharedsecret,0,st->sharedsecretlen);
1480 set_link_quality(st);
1482 if (st->keepalive && !current_valid(st))
1483 initiate_key_setup(st, "keepalive", 0);
1486 static bool_t ensure_resolving(struct site *st)
1488 /* Reentrancy hazard: may call site_resolve_callback and hence
1489 * enter_new_state, enter_state_* and generate_msg*. */
1490 if (st->resolving_count)
1493 assert(st->addresses);
1495 /* resolver->request might reentrantly call site_resolve_callback
1496 * which will decrement st->resolving, so we need to increment it
1497 * twice beforehand to prevent decrement from thinking we're
1498 * finished, and decrement it ourselves. Alternatively if
1499 * everything fails then there are no callbacks due and we simply
1500 * set it to 0 and return false.. */
1501 st->resolving_n_results_stored=0;
1502 st->resolving_n_results_all=0;
1503 st->resolving_count+=2;
1504 const char **addrp=st->addresses;
1505 const char *address;
1507 for (; (address=*addrp++); ) {
1508 bool_t ok = st->resolver->request(st->resolver->st,address,
1509 st->remoteport,st->comms[0],
1510 site_resolve_callback,st);
1512 st->resolving_count++;
1516 st->resolving_count=0;
1519 decrement_resolving_count(st,2);
1523 static bool_t enter_state_resolve(struct site *st)
1525 /* Reentrancy hazard! See ensure_resolving. */
1526 state_assert(st,st->state==SITE_RUN);
1527 slog(st,LOG_STATE,"entering state RESOLVE");
1528 st->state=SITE_RESOLVE;
1529 return ensure_resolving(st);
1532 static bool_t enter_new_state(struct site *st, uint32_t next)
1534 bool_t (*gen)(struct site *st);
1537 slog(st,LOG_STATE,"entering state %s",state_name(next));
1540 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
1542 st->msg1_crossed_logged = False;
1545 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1546 st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
1550 state_assert(st,st->state==SITE_SENTMSG1);
1551 BUF_FREE(&st->buffer);
1555 state_assert(st,st->state==SITE_SENTMSG2);
1556 BUF_FREE(&st->buffer);
1560 state_assert(st,st->state==SITE_SENTMSG3);
1561 BUF_FREE(&st->buffer);
1565 state_assert(st,st->state==SITE_SENTMSG4);
1566 BUF_FREE(&st->buffer);
1571 fatal("enter_new_state(%s): invalid new state",state_name(next));
1575 if (hacky_par_start_failnow()) return False;
1577 r= gen(st) && send_msg(st);
1580 st->setup_retries, st->setup_retry_interval,
1585 if (next==SITE_RUN) {
1586 BUF_FREE(&st->buffer); /* Never reused */
1587 st->timeout=0; /* Never retransmit */
1588 activate_new_key(st);
1592 slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1593 st->buffer.free=False; /* Unconditionally use the buffer; it may be
1594 in either state, and enter_state_wait() will
1596 enter_state_wait(st);
1600 /* msg7 tells our peer that we're about to forget our key */
1601 static bool_t send_msg7(struct site *st, cstring_t reason)
1603 cstring_t transform_err;
1605 if (current_valid(st) && st->buffer.free
1606 && transport_peers_valid(&st->peers)) {
1607 BUF_ALLOC(&st->buffer,"site:MSG7");
1608 buffer_init(&st->buffer,calculate_max_start_pad());
1609 buf_append_uint32(&st->buffer,LABEL_MSG7);
1610 buf_append_string(&st->buffer,reason);
1611 if (call_transform_forwards(st, st->current.transform,
1612 &st->buffer, &transform_err))
1614 buf_prepend_uint32(&st->buffer,LABEL_MSG0);
1615 buf_prepend_uint32(&st->buffer,st->index);
1616 buf_prepend_uint32(&st->buffer,st->current.remote_session_id);
1617 transport_xmit(st,&st->peers,&st->buffer,True);
1618 BUF_FREE(&st->buffer);
1625 /* We go into this state if our peer becomes uncommunicative. Similar to
1626 the "stop" state, we forget all session keys for a while, before
1627 re-entering the "run" state. */
1628 static void enter_state_wait(struct site *st)
1630 slog(st,LOG_STATE,"entering state WAIT");
1631 st->timeout=st->now+st->wait_timeout;
1632 st->state=SITE_WAIT;
1633 set_link_quality(st);
1634 BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1635 /* XXX Erase keys etc. */
1638 static void generate_prod(struct site *st, struct buffer_if *buf)
1641 buf_append_uint32(buf,0);
1642 buf_append_uint32(buf,0);
1643 buf_append_uint32(buf,LABEL_PROD);
1644 buf_append_string(buf,st->localname);
1645 buf_append_string(buf,st->remotename);
1648 static void generate_send_prod(struct site *st,
1649 const struct comm_addr *source)
1651 if (!st->allow_send_prod) return; /* too soon */
1652 if (!(st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1653 st->state==SITE_WAIT)) return; /* we'd ignore peer's MSG1 */
1655 slog(st,LOG_SETUP_INIT,"prodding peer for key exchange");
1656 st->allow_send_prod=0;
1657 generate_prod(st,&st->scratch);
1658 bool_t ok = comm_addr_sendmsg(st, source, &st->scratch);
1659 dump_packet(st,&st->scratch,source,False,ok);
1662 static inline void site_settimeout(uint64_t timeout, int *timeout_io)
1665 int64_t offset=timeout-*now;
1666 if (offset<0) offset=0;
1667 if (offset>INT_MAX) offset=INT_MAX;
1668 if (*timeout_io<0 || offset<*timeout_io)
1673 static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
1676 struct site *st=sst;
1678 BEFOREPOLL_WANT_FDS(0); /* We don't use any file descriptors */
1681 /* Work out when our next timeout is. The earlier of 'timeout' or
1682 'current.key_timeout'. A stored value of '0' indicates no timeout
1684 site_settimeout(st->timeout, timeout_io);
1685 site_settimeout(st->current.key_timeout, timeout_io);
1686 site_settimeout(st->auxiliary_key.key_timeout, timeout_io);
1688 return 0; /* success */
1691 static void check_expiry(struct site *st, struct data_key *key,
1694 if (key->key_timeout && *now>key->key_timeout) {
1695 delete_one_key(st,key,"maximum life exceeded",which,LOG_TIMEOUT_KEY);
1699 /* NB site_afterpoll will be called before site_beforepoll is ever called */
1700 static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
1702 struct site *st=sst;
1705 if (st->timeout && *now>st->timeout) {
1707 if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
1708 if (!hacky_par_start_failnow())
1710 } else if (st->state==SITE_WAIT) {
1711 enter_state_run(st);
1713 slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
1717 check_expiry(st,&st->current,"current key");
1718 check_expiry(st,&st->auxiliary_key,"auxiliary key");
1721 /* This function is called by the netlink device to deliver packets
1722 intended for the remote network. The packet is in "raw" wire
1723 format, but is guaranteed to be word-aligned. */
1724 static void site_outgoing(void *sst, struct buffer_if *buf)
1726 struct site *st=sst;
1727 cstring_t transform_err;
1729 if (st->state==SITE_STOP) {
1734 st->allow_send_prod=1;
1736 /* In all other states we consider delivering the packet if we have
1737 a valid key and a valid address to send it to. */
1738 if (current_valid(st) && transport_peers_valid(&st->peers)) {
1739 /* Transform it and send it */
1741 buf_prepend_uint32(buf,LABEL_MSG9);
1742 if (call_transform_forwards(st, st->current.transform,
1743 buf, &transform_err))
1745 buf_prepend_uint32(buf,LABEL_MSG0);
1746 buf_prepend_uint32(buf,st->index);
1747 buf_prepend_uint32(buf,st->current.remote_session_id);
1748 transport_xmit(st,&st->peers,buf,False);
1755 slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
1757 initiate_key_setup(st,"outgoing packet",0);
1760 static bool_t named_for_us(struct site *st, const struct buffer_if *buf_in,
1761 uint32_t type, struct msg *m)
1762 /* For packets which are identified by the local and remote names.
1763 * If it has our name and our peer's name in it it's for us. */
1765 struct buffer_if buf[1];
1766 buffer_readonly_clone(buf,buf_in);
1767 return unpick_msg(st,type,buf,m)
1768 && name_matches(&m->remote,st->remotename)
1769 && name_matches(&m->local,st->localname);
1772 static bool_t we_have_priority(struct site *st, const struct msg *m) {
1773 if ((st->local_capabilities & m->remote_capabilities)
1774 && CAPAB_PRIORITY_MOBILE) {
1775 if (st->local_mobile) return True;
1776 if (st-> peer_mobile) return False;
1778 return st->our_name_later;
1781 /* This function is called by the communication device to deliver
1782 packets from our peers.
1783 It should return True if the packet is recognised as being for
1784 this current site instance (and should therefore not be processed
1785 by other sites), even if the packet was otherwise ignored. */
1786 static bool_t site_incoming(void *sst, struct buffer_if *buf,
1787 const struct comm_addr *source)
1789 struct site *st=sst;
1791 if (buf->size < 12) return False;
1793 uint32_t dest=get_uint32(buf->start);
1794 uint32_t msgtype=get_uint32(buf->start+8);
1795 struct msg named_msg;
1797 if (msgtype==LABEL_MSG1) {
1798 if (!named_for_us(st,buf,msgtype,&named_msg))
1800 /* It's a MSG1 addressed to us. Decide what to do about it. */
1801 dump_packet(st,buf,source,True,True);
1802 if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1803 st->state==SITE_WAIT) {
1804 /* We should definitely process it */
1805 transport_compute_setupinit_peers(st,0,0,source);
1806 if (process_msg1(st,buf,source,&named_msg)) {
1807 slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
1808 bool_t entered=enter_new_state(st,SITE_SENTMSG2);
1809 if (entered && st->addresses && st->local_mobile)
1810 /* We must do this as the very last thing, because
1811 the resolver callback might reenter us. */
1812 ensure_resolving(st);
1814 slog(st,LOG_ERROR,"failed to process incoming msg1");
1818 } else if (st->state==SITE_SENTMSG1) {
1819 /* We've just sent a message 1! They may have crossed on
1820 the wire. If we have priority then we ignore the
1821 incoming one, otherwise we process it as usual. */
1822 if (we_have_priority(st,&named_msg)) {
1824 if (!st->msg1_crossed_logged++)
1825 slog(st,LOG_SETUP_INIT,"crossed msg1s; we are higher "
1826 "priority => ignore incoming msg1");
1829 slog(st,LOG_SETUP_INIT,"crossed msg1s; we are lower "
1830 "priority => use incoming msg1");
1831 if (process_msg1(st,buf,source,&named_msg)) {
1832 BUF_FREE(&st->buffer); /* Free our old message 1 */
1833 transport_setup_msgok(st,source);
1834 enter_new_state(st,SITE_SENTMSG2);
1836 slog(st,LOG_ERROR,"failed to process an incoming "
1837 "crossed msg1 (we have low priority)");
1842 } else if (st->state==SITE_SENTMSG2 ||
1843 st->state==SITE_SENTMSG4) {
1844 if (consttime_memeq(named_msg.nR,st->remoteN,NONCELEN)) {
1845 /* We are ahead in the protocol, but that msg1 had the
1846 * peer's nonce so presumably it is from this key
1847 * exchange run, via a slower route */
1848 transport_setup_msgok(st,source);
1850 slog(st,LOG_UNEXPECTED,"competing incoming message 1");
1855 /* The message 1 was received at an unexpected stage of the
1856 key setup. Well, they lost the race. */
1857 slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
1861 if (msgtype==LABEL_PROD) {
1862 if (!named_for_us(st,buf,msgtype,&named_msg))
1864 dump_packet(st,buf,source,True,True);
1865 if (st->state!=SITE_RUN) {
1866 slog(st,LOG_DROP,"ignoring PROD when not in state RUN");
1867 } else if (current_valid(st)) {
1868 slog(st,LOG_DROP,"ignoring PROD when we think we have a key");
1870 initiate_key_setup(st,"peer sent PROD packet",source);
1875 if (dest==st->index) {
1876 /* Explicitly addressed to us */
1877 if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True,True);
1880 /* If the source is our current peer then initiate a key setup,
1881 because our peer's forgotten the key */
1882 if (get_uint32(buf->start+4)==st->current.remote_session_id) {
1884 initiated = initiate_key_setup(st,"received a NAK",source);
1885 if (!initiated) generate_send_prod(st,source);
1887 slog(st,LOG_SEC,"bad incoming NAK");
1891 process_msg0(st,buf,source);
1894 /* Setup packet: should not have been explicitly addressed
1896 slog(st,LOG_SEC,"incoming explicitly addressed msg1");
1899 /* Setup packet: expected only in state SENTMSG1 */
1900 if (st->state!=SITE_SENTMSG1) {
1901 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
1902 } else if (process_msg2(st,buf,source)) {
1903 transport_setup_msgok(st,source);
1904 enter_new_state(st,SITE_SENTMSG3);
1906 slog(st,LOG_SEC,"invalid MSG2");
1911 /* Setup packet: expected only in state SENTMSG2 */
1912 if (st->state!=SITE_SENTMSG2) {
1913 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
1914 } else if (process_msg3(st,buf,source,msgtype)) {
1915 transport_setup_msgok(st,source);
1916 enter_new_state(st,SITE_SENTMSG4);
1918 slog(st,LOG_SEC,"invalid MSG3");
1922 /* Setup packet: expected only in state SENTMSG3 */
1923 if (st->state!=SITE_SENTMSG3) {
1924 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
1925 } else if (process_msg4(st,buf,source)) {
1926 transport_setup_msgok(st,source);
1927 enter_new_state(st,SITE_SENTMSG5);
1929 slog(st,LOG_SEC,"invalid MSG4");
1933 /* Setup packet: expected only in state SENTMSG4 */
1934 /* (may turn up in state RUN if our return MSG6 was lost
1935 and the new key has already been activated. In that
1936 case we discard it. The peer will realise that we
1937 are using the new key when they see our data packets.
1938 Until then the peer's data packets to us get discarded. */
1939 if (st->state==SITE_SENTMSG4) {
1940 if (process_msg5(st,buf,source,st->new_transform)) {
1941 transport_setup_msgok(st,source);
1942 enter_new_state(st,SITE_RUN);
1944 slog(st,LOG_SEC,"invalid MSG5");
1946 } else if (st->state==SITE_RUN) {
1947 if (process_msg5(st,buf,source,st->current.transform)) {
1948 slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
1949 transport_setup_msgok(st,source);
1950 create_msg6(st,st->current.transform,
1951 st->current.remote_session_id);
1952 transport_xmit(st,&st->peers,&st->buffer,True);
1953 BUF_FREE(&st->buffer);
1955 slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
1958 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
1962 /* Setup packet: expected only in state SENTMSG5 */
1963 if (st->state!=SITE_SENTMSG5) {
1964 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
1965 } else if (process_msg6(st,buf,source)) {
1966 BUF_FREE(&st->buffer); /* Free message 5 */
1967 transport_setup_msgok(st,source);
1968 activate_new_key(st);
1970 slog(st,LOG_SEC,"invalid MSG6");
1974 slog(st,LOG_SEC,"received message of unknown type 0x%08x",
1985 static void site_control(void *vst, bool_t run)
1987 struct site *st=vst;
1988 if (run) enter_state_run(st);
1989 else enter_state_stop(st);
1992 static void site_phase_hook(void *sst, uint32_t newphase)
1994 struct site *st=sst;
1996 /* The program is shutting down; tell our peer */
1997 send_msg7(st,"shutting down");
2000 static void site_childpersist_clearkeys(void *sst, uint32_t newphase)
2002 struct site *st=sst;
2003 dispose_transform(&st->current.transform);
2004 dispose_transform(&st->auxiliary_key.transform);
2005 dispose_transform(&st->new_transform);
2006 /* Not much point overwiting the signing key, since we loaded it
2007 from disk, and it is only valid prospectively if at all,
2009 /* XXX it would be best to overwrite the DH state, because that
2010 _is_ relevant to forward secrecy. However we have no
2011 convenient interface for doing that and in practice gmp has
2012 probably dribbled droppings all over the malloc arena. A good
2013 way to fix this would be to have a privsep child for asymmetric
2014 crypto operations, but that's a task for another day. */
2017 static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
2020 static uint32_t index_sequence;
2028 st->cl.description="site";
2029 st->cl.type=CL_SITE;
2031 st->cl.interface=&st->ops;
2033 st->ops.control=site_control;
2034 st->ops.status=site_status;
2036 /* First parameter must be a dict */
2037 item=list_elem(args,0);
2038 if (!item || item->type!=t_dict)
2039 cfgfatal(loc,"site","parameter must be a dictionary\n");
2041 dict=item->data.dict;
2042 st->localname=dict_read_string(dict, "local-name", True, "site", loc);
2043 st->remotename=dict_read_string(dict, "name", True, "site", loc);
2045 st->keepalive=dict_read_bool(dict,"keepalive",False,"site",loc,False);
2047 st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
2049 dict_read_bool(dict,"local-mobile",False,"site",loc,False);
2051 /* Sanity check (which also allows the 'sites' file to include
2052 site() closures for all sites including our own): refuse to
2053 talk to ourselves */
2054 if (strcmp(st->localname,st->remotename)==0) {
2055 Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
2057 if (st->peer_mobile != st->local_mobile)
2058 cfgfatal(loc,"site","site %s's peer-mobile=%d"
2059 " but our local-mobile=%d\n",
2060 st->localname, st->peer_mobile, st->local_mobile);
2064 if (st->peer_mobile && st->local_mobile) {
2065 Message(M_WARNING,"site %s: site is mobile but so are we"
2066 " -> ignoring this site\n", st->remotename);
2071 assert(index_sequence < 0xffffffffUL);
2072 st->index = ++index_sequence;
2073 st->local_capabilities = 0;
2074 st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
2076 #define GET_CLOSURE_LIST(dictkey,things,nthings,CL_TYPE) do{ \
2077 list_t *things##_cfg=dict_lookup(dict,dictkey); \
2078 if (!things##_cfg) \
2079 cfgfatal(loc,"site","closure list \"%s\" not found\n",dictkey); \
2080 st->nthings=list_length(things##_cfg); \
2081 NEW_ARY(st->things,st->nthings); \
2082 assert(st->nthings); \
2083 for (i=0; i<st->nthings; i++) { \
2084 item_t *item=list_elem(things##_cfg,i); \
2085 if (item->type!=t_closure) \
2086 cfgfatal(loc,"site","%s is not a closure\n",dictkey); \
2087 closure_t *cl=item->data.closure; \
2088 if (cl->type!=CL_TYPE) \
2089 cfgfatal(loc,"site","%s closure wrong type\n",dictkey); \
2090 st->things[i]=cl->interface; \
2094 GET_CLOSURE_LIST("comm",comms,ncomms,CL_COMM);
2096 NEW_ARY(st->commclientinfos, st->ncomms);
2097 dict_t *comminfo = dict_read_dict(dict,"comm-info",False,"site",loc);
2098 for (i=0; i<st->ncomms; i++) {
2099 st->commclientinfos[i] =
2101 st->comms[i]->clientinfo(st->comms[i],comminfo,loc);
2104 st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
2105 st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
2106 st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
2108 st->privkey=find_cl_if(dict,"local-key",CL_RSAPRIVKEY,True,"site",loc);
2109 st->addresses=dict_read_string_array(dict,"address",False,"site",loc,0);
2111 st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
2112 else st->remoteport=0;
2113 st->pubkey=find_cl_if(dict,"key",CL_RSAPUBKEY,True,"site",loc);
2115 GET_CLOSURE_LIST("transform",transforms,ntransforms,CL_TRANSFORM);
2117 st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
2118 st->hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
2120 #define DEFAULT(D) (st->peer_mobile || st->local_mobile \
2121 ? DEFAULT_MOBILE_##D : DEFAULT_##D)
2122 #define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
2124 st->key_lifetime= CFG_NUMBER("key-lifetime", KEY_LIFETIME);
2125 st->setup_retries= CFG_NUMBER("setup-retries", SETUP_RETRIES);
2126 st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
2127 st->wait_timeout= CFG_NUMBER("wait-time", WAIT_TIME);
2128 st->mtu_target= dict_read_number(dict,"mtu-target",False,"site",loc,0);
2130 st->mobile_peer_expiry= dict_read_number(
2131 dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
2133 const char *peerskey= st->peer_mobile
2134 ? "mobile-peers-max" : "static-peers-max";
2135 st->transport_peers_max= dict_read_number(
2136 dict,peerskey,False,"site",loc, st->addresses ? 4 : 3);
2137 if (st->transport_peers_max<1 ||
2138 st->transport_peers_max>MAX_PEER_ADDRS) {
2139 cfgfatal(loc,"site", "%s must be in range 1.."
2140 STRING(MAX_PEER_ADDRS) "\n", peerskey);
2143 if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
2144 st->key_renegotiate_time=st->key_lifetime/2;
2146 st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
2147 st->key_renegotiate_time=dict_read_number(
2148 dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
2149 if (st->key_renegotiate_time > st->key_lifetime) {
2150 cfgfatal(loc,"site",
2151 "renegotiate-time must be less than key-lifetime\n");
2154 st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
2155 log_event_table,"site");
2157 st->resolving_count=0;
2158 st->allow_send_prod=0;
2160 st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
2162 sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
2164 /* The information we expect to see in incoming messages of type 1 */
2165 /* fixme: lots of unchecked overflows here, but the results are only
2166 corrupted packets rather than undefined behaviour */
2167 st->our_name_later=(strcmp(st->localname,st->remotename)>0);
2169 buffer_new(&st->buffer,SETUP_BUFFER_LEN);
2171 buffer_new(&st->scratch,SETUP_BUFFER_LEN);
2172 BUF_ALLOC(&st->scratch,"site:scratch");
2174 /* We are interested in poll(), but only for timeouts. We don't have
2175 any fds of our own. */
2176 register_for_poll(st, site_beforepoll, site_afterpoll, "site");
2179 st->remote_capabilities=0;
2180 st->chosen_transform=0;
2181 st->current.key_timeout=0;
2182 st->auxiliary_key.key_timeout=0;
2183 transport_peers_clear(st,&st->peers);
2184 transport_peers_clear(st,&st->setup_peers);
2185 /* XXX mlock these */
2186 st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
2187 st->sharedsecretlen=st->sharedsecretallocd=0;
2190 for (i=0; i<st->ntransforms; i++) {
2191 struct transform_if *ti=st->transforms[i];
2192 uint32_t capbit = 1UL << ti->capab_transformnum;
2193 if (st->local_capabilities & capbit)
2194 slog(st,LOG_ERROR,"transformnum capability bit"
2195 " %d (%#"PRIx32") reused", ti->capab_transformnum, capbit);
2196 st->local_capabilities |= capbit;
2199 if (st->local_mobile || st->peer_mobile)
2200 st->local_capabilities |= CAPAB_PRIORITY_MOBILE;
2202 /* We need to register the remote networks with the netlink device */
2203 uint32_t netlink_mtu; /* local virtual interface mtu */
2204 st->netlink->reg(st->netlink->st, site_outgoing, st, &netlink_mtu);
2205 if (!st->mtu_target)
2206 st->mtu_target=netlink_mtu;
2208 for (i=0; i<st->ncomms; i++)
2209 st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
2211 st->current.transform=0;
2212 st->auxiliary_key.transform=0;
2213 st->new_transform=0;
2214 st->auxiliary_is_new=0;
2216 enter_state_stop(st);
2218 add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
2219 add_hook(PHASE_CHILDPERSIST,site_childpersist_clearkeys,st);
2221 return new_closure(&st->cl);
2224 void site_module(dict_t *dict)
2226 add_closure(dict,"site",site_apply);
2230 /***** TRANSPORT PEERS definitions *****/
2232 static void transport_peers_debug(struct site *st, transport_peers *dst,
2233 const char *didwhat,
2234 int nargs, const struct comm_addr *args,
2239 if (!(st->log_events & LOG_PEER_ADDRS))
2240 return; /* an optimisation */
2242 slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
2243 (dst==&st->peers ? "data" :
2244 dst==&st->setup_peers ? "setup" : "UNKNOWN"),
2245 didwhat, nargs, dst->npeers);
2247 for (i=0, argp=(void*)args;
2249 i++, (argp+=stride?stride:sizeof(*args))) {
2250 const struct comm_addr *ca=(void*)argp;
2251 slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
2252 i, comm_addr_to_string(ca));
2254 for (i=0; i<dst->npeers; i++) {
2255 struct timeval diff;
2256 timersub(tv_now,&dst->peers[i].last,&diff);
2257 const struct comm_addr *ca=&dst->peers[i].addr;
2258 slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
2259 i, comm_addr_to_string(ca),
2260 (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
2264 static void transport_peers_expire(struct site *st, transport_peers *peers) {
2265 /* peers must be sorted first */
2266 int previous_peers=peers->npeers;
2267 struct timeval oldest;
2268 oldest.tv_sec = tv_now->tv_sec - st->mobile_peer_expiry;
2269 oldest.tv_usec = tv_now->tv_usec;
2270 while (peers->npeers>1 &&
2271 timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
2273 if (peers->npeers != previous_peers)
2274 transport_peers_debug(st,peers,"expire", 0,0,0);
2277 static bool_t transport_peer_record_one(struct site *st, transport_peers *peers,
2278 const struct comm_addr *ca,
2279 const struct timeval *tv) {
2280 /* returns false if output is full */
2283 if (peers->npeers >= st->transport_peers_max)
2286 for (search=0; search<peers->npeers; search++)
2287 if (comm_addr_equal(&peers->peers[search].addr, ca))
2290 peers->peers[peers->npeers].addr = *ca;
2291 peers->peers[peers->npeers].last = *tv;
2296 static void transport_record_peers(struct site *st, transport_peers *peers,
2297 const struct comm_addr *addrs, int naddrs,
2299 /* We add addrs into peers. The new entries end up at the front
2300 * and displace entries towards the end (perhaps even off the
2301 * end). Any existing matching entries are moved up to the front.
2303 * Caller must first call transport_peers_expire. */
2306 /* avoids debug for uninteresting updates */
2308 for (i=0; i<peers->npeers; i++) {
2309 if (comm_addr_equal(&addrs[0], &peers->peers[i].addr)) {
2310 memmove(peers->peers+1, peers->peers,
2311 sizeof(peers->peers[0]) * i);
2312 peers->peers[0].addr = addrs[0];
2313 peers->peers[0].last = *tv_now;
2319 int old_npeers=peers->npeers;
2320 transport_peer old_peers[old_npeers];
2321 COPY_ARRAY(old_peers,peers->peers,old_npeers);
2325 for (i=0; i<naddrs; i++) {
2326 if (!transport_peer_record_one(st,peers, &addrs[i], tv_now))
2329 for (i=0; i<old_npeers; i++) {
2330 const transport_peer *old=&old_peers[i];
2331 if (!transport_peer_record_one(st,peers, &old->addr, &old->last))
2335 transport_peers_debug(st,peers,m, naddrs,addrs,0);
2338 static void transport_expire_record_peers(struct site *st,
2339 transport_peers *peers,
2340 const struct comm_addr *addrs,
2341 int naddrs, const char *m) {
2342 /* Convenience function */
2343 transport_peers_expire(st,peers);
2344 transport_record_peers(st,peers,addrs,naddrs,m);
2347 static bool_t transport_compute_setupinit_peers(struct site *st,
2348 const struct comm_addr *configured_addrs /* 0 if none or not found */,
2349 int n_configured_addrs /* 0 if none or not found */,
2350 const struct comm_addr *incoming_packet_addr /* 0 if none */) {
2351 if (!n_configured_addrs && !incoming_packet_addr &&
2352 !transport_peers_valid(&st->peers))
2355 slog(st,LOG_SETUP_INIT,
2356 "using: %d configured addr(s);%s %d old peer addrs(es)",
2358 incoming_packet_addr ? " incoming packet address;" : "",
2361 /* Non-mobile peers try addresses until one is plausible. The
2362 * effect is that this code always tries first the configured
2363 * address if supplied, or otherwise the address of the incoming
2364 * PROD, or finally the existing data peer if one exists; this is
2367 transport_peers_copy(st,&st->setup_peers,&st->peers);
2368 transport_peers_expire(st,&st->setup_peers);
2370 if (incoming_packet_addr)
2371 transport_record_peers(st,&st->setup_peers,
2372 incoming_packet_addr,1, "incoming");
2374 if (n_configured_addrs)
2375 transport_record_peers(st,&st->setup_peers,
2376 configured_addrs,n_configured_addrs, "setupinit");
2378 assert(transport_peers_valid(&st->setup_peers));
2382 static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
2383 if (st->peer_mobile)
2384 transport_expire_record_peers(st,&st->setup_peers,a,1,"setupmsg");
2386 static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
2387 if (st->peer_mobile)
2388 transport_expire_record_peers(st,&st->peers,a,1,"datamsg");
2391 static int transport_peers_valid(transport_peers *peers) {
2392 return peers->npeers;
2394 static void transport_peers_clear(struct site *st, transport_peers *peers) {
2396 transport_peers_debug(st,peers,"clear",0,0,0);
2398 static void transport_peers_copy(struct site *st, transport_peers *dst,
2399 const transport_peers *src) {
2400 dst->npeers=src->npeers;
2401 COPY_ARRAY(dst->peers, src->peers, dst->npeers);
2402 transport_peers_debug(st,dst,"copy",
2403 src->npeers, &src->peers->addr, sizeof(*src->peers));
2406 static void transport_resolve_complete(struct site *st,
2407 const struct comm_addr *addrs,
2409 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2411 transport_expire_record_peers(st,&st->setup_peers,addrs,naddrs,
2415 static void transport_resolve_complete_tardy(struct site *st,
2416 const struct comm_addr *addrs,
2418 transport_expire_record_peers(st,&st->peers,addrs,naddrs,
2419 "resolved tardily");
2422 static void transport_peers__copy_by_mask(transport_peer *out, int *nout_io,
2424 const transport_peers *inp) {
2425 /* out and in->peers may be the same region, or nonoverlapping */
2426 const transport_peer *in=inp->peers;
2428 for (slot=0; slot<inp->npeers; slot++) {
2429 if (!(mask & (1U << slot)))
2431 if (!(out==in && slot==*nout_io))
2432 COPY_OBJ(out[*nout_io], in[slot]);
2437 void transport_xmit(struct site *st, transport_peers *peers,
2438 struct buffer_if *buf, bool_t candebug) {
2440 transport_peers_expire(st, peers);
2441 unsigned failed=0; /* bitmask */
2442 assert(MAX_PEER_ADDRS < sizeof(unsigned)*CHAR_BIT);
2445 for (slot=0; slot<peers->npeers; slot++) {
2446 transport_peer *peer=&peers->peers[slot];
2447 bool_t ok = comm_addr_sendmsg(st, &peer->addr, buf);
2449 dump_packet(st, buf, &peer->addr, False, ok);
2451 failed |= 1U << slot;
2454 if (ok && !st->peer_mobile)
2457 /* Now we need to demote/delete failing addrs: if we are mobile we
2458 * merely demote them; otherwise we delete them. */
2459 if (st->local_mobile) {
2460 unsigned expected = ((1U << nfailed)-1) << (peers->npeers-nfailed);
2461 /* `expected' has all the failures at the end already */
2462 if (failed != expected) {
2464 transport_peer failedpeers[nfailed];
2465 transport_peers__copy_by_mask(failedpeers, &fslot, failed,peers);
2466 assert(fslot == nfailed);
2468 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2469 assert(wslot+nfailed == peers->npeers);
2470 COPY_ARRAY(peers->peers+wslot, failedpeers, nfailed);
2471 transport_peers_debug(st,peers,"mobile failure reorder",0,0,0);
2474 if (failed && peers->npeers > 1) {
2476 transport_peers__copy_by_mask(peers->peers,&wslot,~failed,peers);
2477 peers->npeers=wslot;
2478 transport_peers_debug(st,peers,"non-mobile failure cleanup",0,0,0);
2483 /***** END of transport peers declarations *****/