1 /* site.c - manage communication with a remote network site */
3 /* The 'site' code doesn't know anything about the structure of the
4 packets it's transmitting. In fact, under the new netlink
5 configuration scheme it doesn't need to know anything at all about
6 IP addresses, except how to contact its peer. This means it could
7 potentially be used to tunnel other protocols too (IPv6, IPX, plain
8 old Ethernet frames) if appropriate netlink code can be written
9 (and that ought not to be too hard, eg. using the TUN/TAP device to
10 pretend to be an Ethernet interface). */
12 /* At some point in the future the netlink code will be asked for
13 configuration information to go in the PING/PONG packets at the end
14 of the key exchange. */
21 #include <sys/socket.h>
25 #include "unaligned.h"
28 #define SETUP_BUFFER_LEN 2048
30 #define DEFAULT_KEY_LIFETIME (3600*1000) /* [ms] */
31 #define DEFAULT_KEY_RENEGOTIATE_GAP (5*60*1000) /* [ms] */
32 #define DEFAULT_SETUP_RETRIES 5
33 #define DEFAULT_SETUP_RETRY_INTERVAL (2*1000) /* [ms] */
34 #define DEFAULT_WAIT_TIME (20*1000) /* [ms] */
36 #define DEFAULT_MOBILE_KEY_LIFETIME (2*24*3600*1000) /* [ms] */
37 #define DEFAULT_MOBILE_KEY_RENEGOTIATE_GAP (12*3600*1000) /* [ms] */
38 #define DEFAULT_MOBILE_SETUP_RETRIES 30
39 #define DEFAULT_MOBILE_SETUP_RETRY_INTERVAL (1*1000) /* [ms] */
40 #define DEFAULT_MOBILE_WAIT_TIME (10*1000) /* [ms] */
42 #define DEFAULT_MOBILE_PEER_EXPIRY (2*60) /* [s] */
43 #define DEFAULT_MOBILE_PEERS_MAX 3 /* send at most this many copies (default) */
45 /* Each site can be in one of several possible states. */
48 SITE_STOP - nothing is allowed to happen; tunnel is down;
49 all session keys have been erased
50 -> SITE_RUN upon external instruction
51 SITE_RUN - site up, maybe with valid key
52 -> SITE_RESOLVE upon outgoing packet and no valid key
53 we start name resolution for the other end of the tunnel
54 -> SITE_SENTMSG2 upon valid incoming message 1 and suitable time
55 we send an appropriate message 2
56 SITE_RESOLVE - waiting for name resolution
57 -> SITE_SENTMSG1 upon successful resolution
58 we send an appropriate message 1
59 -> SITE_SENTMSG2 upon valid incoming message 1 (then abort resolution)
60 we abort resolution and
61 -> SITE_WAIT on timeout or resolution failure
63 -> SITE_SENTMSG2 upon valid incoming message 1 from higher priority end
64 -> SITE_SENTMSG3 upon valid incoming message 2
65 -> SITE_WAIT on timeout
67 -> SITE_SENTMSG4 upon valid incoming message 3
68 -> SITE_WAIT on timeout
70 -> SITE_SENTMSG5 upon valid incoming message 4
71 -> SITE_WAIT on timeout
73 -> SITE_RUN upon valid incoming message 5
74 -> SITE_WAIT on timeout
76 -> SITE_RUN upon valid incoming message 6
77 -> SITE_WAIT on timeout
78 SITE_WAIT - failed to establish key; do nothing for a while
79 -> SITE_RUN on timeout
84 #define SITE_RESOLVE 2
85 #define SITE_SENTMSG1 3
86 #define SITE_SENTMSG2 4
87 #define SITE_SENTMSG3 5
88 #define SITE_SENTMSG4 6
89 #define SITE_SENTMSG5 7
92 static cstring_t state_name(uint32_t state)
95 case 0: return "STOP";
97 case 2: return "RESOLVE";
98 case 3: return "SENTMSG1";
99 case 4: return "SENTMSG2";
100 case 5: return "SENTMSG3";
101 case 6: return "SENTMSG4";
102 case 7: return "SENTMSG5";
103 case 8: return "WAIT";
104 default: return "*bad state*";
110 #define LOG_UNEXPECTED 0x00000001
111 #define LOG_SETUP_INIT 0x00000002
112 #define LOG_SETUP_TIMEOUT 0x00000004
113 #define LOG_ACTIVATE_KEY 0x00000008
114 #define LOG_TIMEOUT_KEY 0x00000010
115 #define LOG_SEC 0x00000020
116 #define LOG_STATE 0x00000040
117 #define LOG_DROP 0x00000080
118 #define LOG_DUMP 0x00000100
119 #define LOG_ERROR 0x00000400
120 #define LOG_PEER_ADDRS 0x00000800
122 static struct flagstr log_event_table[]={
123 { "unexpected", LOG_UNEXPECTED },
124 { "setup-init", LOG_SETUP_INIT },
125 { "setup-timeout", LOG_SETUP_TIMEOUT },
126 { "activate-key", LOG_ACTIVATE_KEY },
127 { "timeout-key", LOG_TIMEOUT_KEY },
128 { "security", LOG_SEC },
129 { "state-change", LOG_STATE },
130 { "packet-drop", LOG_DROP },
131 { "dump-packets", LOG_DUMP },
132 { "errors", LOG_ERROR },
133 { "peer-addrs", LOG_PEER_ADDRS },
134 { "default", LOG_SETUP_INIT|LOG_SETUP_TIMEOUT|
135 LOG_ACTIVATE_KEY|LOG_TIMEOUT_KEY|LOG_SEC|LOG_ERROR },
136 { "all", 0xffffffff },
141 /***** TRANSPORT PEERS declarations *****/
143 /* Details of "mobile peer" semantics:
145 - We record mobile_peers_max peer address/port numbers ("peers")
146 for key setup, and separately mobile_peers_max for data
147 transfer. If these lists fill up, we retain the newest peers.
148 (For non-mobile peers we only record one of each.)
150 - Outgoing packets are sent to every recorded peer in the
153 - Data transfer peers are straightforward: whenever we successfully
154 process a data packet, we record the peer. Also, whenever we
155 successfully complete a key setup, we merge the key setup
156 peers into the data transfer peers.
158 (For "non-mobile" peers we simply copy the peer used for
159 successful key setup, and don't change the peer otherwise.)
161 - Key setup peers are slightly more complicated.
163 Whenever we receive and successfully process a key exchange
164 packet, we record the peer.
166 Whenever we try to initiate a key setup, we copy the list of data
167 transfer peers and use it for key setup. But we also look to see
168 if the config supplies an address and port number and if so we
169 add that as a key setup peer (possibly evicting one of the data
170 transfer peers we just copied).
172 (For "non-mobile" peers, if we if we have a configured peer
173 address and port, we always use that; otherwise if we have a
174 current data peer address we use that; otherwise we do not
175 attempt to initiate a key setup for lack of a peer address.)
177 "Record the peer" means
178 1. expire any peers last seen >120s ("mobile-peer-expiry") ago
179 2. add the peer of the just received packet to the applicable list
180 (possibly evicting older entries)
181 NB that we do not expire peers until an incoming packet arrives.
185 #define MAX_MOBILE_PEERS_MAX 5 /* send at most this many copies, compiled max */
189 struct comm_addr addr;
193 /* configuration information */
194 /* runtime information */
196 transport_peer peers[MAX_MOBILE_PEERS_MAX];
199 static void transport_peers_clear(struct site *st, transport_peers *peers);
200 static int transport_peers_valid(transport_peers *peers);
201 static void transport_peers_copy(struct site *st, transport_peers *dst,
202 const transport_peers *src);
204 static void transport_setup_msgok(struct site *st, const struct comm_addr *a);
205 static void transport_data_msgok(struct site *st, const struct comm_addr *a);
206 static bool_t transport_compute_setupinit_peers(struct site *st,
207 const struct comm_addr *configured_addr /* 0 if none or not found */);
208 static void transport_record_peer(struct site *st, transport_peers *peers,
209 const struct comm_addr *addr, const char *m);
211 static void transport_xmit(struct site *st, transport_peers *peers,
212 struct buffer_if *buf, bool_t candebug);
214 /***** END of transport peers declarations *****/
218 struct transform_inst_if *transform;
219 uint64_t key_timeout; /* End of life of current key */
220 uint32_t remote_session_id;
226 /* configuration information */
229 bool_t peer_mobile; /* Mobile client support */
230 int32_t transport_peers_max;
231 string_t tunname; /* localname<->remotename by default, used in logs */
232 string_t address; /* DNS name for bootstrapping, optional */
233 int remoteport; /* Port for bootstrapping, optional */
234 struct netlink_if *netlink;
235 struct comm_if **comms;
237 struct resolver_if *resolver;
239 struct random_if *random;
240 struct rsaprivkey_if *privkey;
241 struct rsapubkey_if *pubkey;
242 struct transform_if *transform;
244 struct hash_if *hash;
246 uint32_t index; /* Index of this site */
247 int32_t setup_retries; /* How many times to send setup packets */
248 int32_t setup_retry_interval; /* Initial timeout for setup packets */
249 int32_t wait_timeout; /* How long to wait if setup unsuccessful */
250 int32_t mobile_peer_expiry; /* How long to remember 2ary addresses */
251 int32_t key_lifetime; /* How long a key lasts once set up */
252 int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
253 after this time, initiate a new
256 uint8_t *setupsig; /* Expected signature of incoming MSG1 packets */
257 int32_t setupsiglen; /* Allows us to discard packets quickly if
258 they are not for us */
259 bool_t setup_priority; /* Do we have precedence if both sites emit
260 message 1 simultaneously? */
263 /* runtime information */
265 uint64_t now; /* Most recently seen time */
267 /* The currently established session */
268 struct data_key current;
269 struct data_key auxiliary_key;
270 bool_t auxiliary_is_new;
271 uint64_t renegotiate_key_time; /* When we can negotiate a new key */
272 uint64_t auxiliary_renegotiate_key_time;
273 transport_peers peers; /* Current address(es) of peer for data traffic */
275 /* The current key setup protocol exchange. We can only be
276 involved in one of these at a time. There's a potential for
277 denial of service here (the attacker keeps sending a setup
278 packet; we keep trying to continue the exchange, and have to
279 timeout before we can listen for another setup packet); perhaps
280 we should keep a list of 'bad' sources for setup packets. */
281 uint32_t setup_session_id;
282 transport_peers setup_peers;
283 uint8_t localN[NONCELEN]; /* Nonces for key exchange */
284 uint8_t remoteN[NONCELEN];
285 struct buffer_if buffer; /* Current outgoing key exchange packet */
286 struct buffer_if scratch;
287 int32_t retries; /* Number of retries remaining */
288 uint64_t timeout; /* Timeout for current state */
290 uint8_t *sharedsecret;
291 uint32_t sharedsecretlen;
292 struct transform_inst_if *new_transform; /* For key setup/verify */
295 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
303 if (event&st->log_events) {
305 case LOG_UNEXPECTED: class=M_INFO; break;
306 case LOG_SETUP_INIT: class=M_INFO; break;
307 case LOG_SETUP_TIMEOUT: class=M_NOTICE; break;
308 case LOG_ACTIVATE_KEY: class=M_INFO; break;
309 case LOG_TIMEOUT_KEY: class=M_INFO; break;
310 case LOG_SEC: class=M_SECURITY; break;
311 case LOG_STATE: class=M_DEBUG; break;
312 case LOG_DROP: class=M_DEBUG; break;
313 case LOG_DUMP: class=M_DEBUG; break;
314 case LOG_ERROR: class=M_ERR; break;
315 case LOG_PEER_ADDRS: class=M_DEBUG; break;
316 default: class=M_ERR; break;
319 vsnprintf(buf,sizeof(buf),msg,ap);
320 st->log->log(st->log->st,class,"%s: %s",st->tunname,buf);
325 static void set_link_quality(struct site *st);
326 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel);
327 static void delete_one_key(struct site *st, struct data_key *key,
328 const char *reason /* may be 0 meaning don't log*/,
329 const char *which /* ignored if !reasonn */,
330 uint32_t loglevel /* ignored if !reasonn */);
331 static bool_t initiate_key_setup(struct site *st, cstring_t reason);
332 static void enter_state_run(struct site *st);
333 static bool_t enter_state_resolve(struct site *st);
334 static bool_t enter_new_state(struct site *st,uint32_t next);
335 static void enter_state_wait(struct site *st);
336 static void activate_new_key(struct site *st);
338 static bool_t current_valid(struct site *st)
340 return st->current.transform->valid(st->current.transform->st);
343 #define CHECK_AVAIL(b,l) do { if ((b)->size<(l)) return False; } while(0)
344 #define CHECK_EMPTY(b) do { if ((b)->size!=0) return False; } while(0)
345 #define CHECK_TYPE(b,t) do { uint32_t type; \
346 CHECK_AVAIL((b),4); \
347 type=buf_unprepend_uint32((b)); \
348 if (type!=(t)) return False; } while(0)
353 int32_t extrainfo_len;
361 struct parsedname remote;
362 struct parsedname local;
372 /* Build any of msg1 to msg4. msg5 and msg6 are built from the inside
373 out using a transform of config data supplied by netlink */
374 static bool_t generate_msg(struct site *st, uint32_t type, cstring_t what)
380 st->retries=st->setup_retries;
381 BUF_ALLOC(&st->buffer,what);
382 buffer_init(&st->buffer,0);
383 buf_append_uint32(&st->buffer,
384 (type==LABEL_MSG1?0:st->setup_session_id));
385 buf_append_uint32(&st->buffer,st->index);
386 buf_append_uint32(&st->buffer,type);
387 buf_append_string(&st->buffer,st->localname);
388 buf_append_string(&st->buffer,st->remotename);
389 memcpy(buf_append(&st->buffer,NONCELEN),st->localN,NONCELEN);
390 if (type==LABEL_MSG1) return True;
391 memcpy(buf_append(&st->buffer,NONCELEN),st->remoteN,NONCELEN);
392 if (type==LABEL_MSG2) return True;
394 if (hacky_par_mid_failnow()) return False;
396 dhpub=st->dh->makepublic(st->dh->st,st->dhsecret,st->dh->len);
397 buf_append_string(&st->buffer,dhpub);
399 hash=safe_malloc(st->hash->len, "generate_msg");
400 hst=st->hash->init();
401 st->hash->update(hst,st->buffer.start,st->buffer.size);
402 st->hash->final(hst,hash);
403 sig=st->privkey->sign(st->privkey->st,hash,st->hash->len);
404 buf_append_string(&st->buffer,sig);
410 static bool_t unpick_name(struct buffer_if *msg, struct parsedname *nm)
413 nm->len=buf_unprepend_uint16(msg);
414 CHECK_AVAIL(msg,nm->len);
415 nm->name=buf_unprepend(msg,nm->len);
416 uint8_t *nul=memchr(nm->name,0,nm->len);
422 nm->extrainfo_len=msg->start-nm->extrainfo;
423 nm->len=nul-nm->name;
428 static bool_t unpick_msg(struct site *st, uint32_t type,
429 struct buffer_if *msg, struct msg *m)
431 m->hashstart=msg->start;
433 m->dest=buf_unprepend_uint32(msg);
435 m->source=buf_unprepend_uint32(msg);
436 CHECK_TYPE(msg,type);
437 if (!unpick_name(msg,&m->remote)) return False;
438 if (!unpick_name(msg,&m->local)) return False;
439 CHECK_AVAIL(msg,NONCELEN);
440 m->nR=buf_unprepend(msg,NONCELEN);
441 if (type==LABEL_MSG1) {
445 CHECK_AVAIL(msg,NONCELEN);
446 m->nL=buf_unprepend(msg,NONCELEN);
447 if (type==LABEL_MSG2) {
452 m->pklen=buf_unprepend_uint16(msg);
453 CHECK_AVAIL(msg,m->pklen);
454 m->pk=buf_unprepend(msg,m->pklen);
455 m->hashlen=msg->start-m->hashstart;
457 m->siglen=buf_unprepend_uint16(msg);
458 CHECK_AVAIL(msg,m->siglen);
459 m->sig=buf_unprepend(msg,m->siglen);
464 static bool_t name_matches(const struct parsedname *nm, const char *expected)
466 int expected_len=strlen(expected);
468 nm->len == expected_len &&
469 !memcmp(nm->name, expected, expected_len);
472 static bool_t check_msg(struct site *st, uint32_t type, struct msg *m,
475 if (type==LABEL_MSG1) return True;
477 /* Check that the site names and our nonce have been sent
478 back correctly, and then store our peer's nonce. */
479 if (!name_matches(&m->remote,st->remotename)) {
480 *error="wrong remote site name";
483 if (!name_matches(&m->local,st->localname)) {
484 *error="wrong local site name";
487 if (memcmp(m->nL,st->localN,NONCELEN)!=0) {
488 *error="wrong locally-generated nonce";
491 if (type==LABEL_MSG2) return True;
492 if (!consttime_memeq(m->nR,st->remoteN,NONCELEN)!=0) {
493 *error="wrong remotely-generated nonce";
496 if (type==LABEL_MSG3) return True;
497 if (type==LABEL_MSG4) return True;
498 *error="unknown message type";
502 static bool_t generate_msg1(struct site *st)
504 st->random->generate(st->random->st,NONCELEN,st->localN);
505 return generate_msg(st,LABEL_MSG1,"site:MSG1");
508 static bool_t process_msg1(struct site *st, struct buffer_if *msg1,
509 const struct comm_addr *src)
513 /* We've already determined we're in an appropriate state to
514 process an incoming MSG1, and that the MSG1 has correct values
517 if (!unpick_msg(st,LABEL_MSG1,msg1,&m)) return False;
519 transport_record_peer(st,&st->setup_peers,src,"msg1");
520 st->setup_session_id=m.source;
521 memcpy(st->remoteN,m.nR,NONCELEN);
525 static bool_t generate_msg2(struct site *st)
527 st->random->generate(st->random->st,NONCELEN,st->localN);
528 return generate_msg(st,LABEL_MSG2,"site:MSG2");
531 static bool_t process_msg2(struct site *st, struct buffer_if *msg2,
532 const struct comm_addr *src)
537 if (!unpick_msg(st,LABEL_MSG2,msg2,&m)) return False;
538 if (!check_msg(st,LABEL_MSG2,&m,&err)) {
539 slog(st,LOG_SEC,"msg2: %s",err);
542 st->setup_session_id=m.source;
543 memcpy(st->remoteN,m.nR,NONCELEN);
547 static bool_t generate_msg3(struct site *st)
549 /* Now we have our nonce and their nonce. Think of a secret key,
550 and create message number 3. */
551 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
552 return generate_msg(st,LABEL_MSG3,"site:MSG3");
555 static bool_t process_msg3(struct site *st, struct buffer_if *msg3,
556 const struct comm_addr *src)
563 if (!unpick_msg(st,LABEL_MSG3,msg3,&m)) return False;
564 if (!check_msg(st,LABEL_MSG3,&m,&err)) {
565 slog(st,LOG_SEC,"msg3: %s",err);
569 /* Check signature and store g^x mod m */
570 hash=safe_malloc(st->hash->len, "process_msg3");
571 hst=st->hash->init();
572 st->hash->update(hst,m.hashstart,m.hashlen);
573 st->hash->final(hst,hash);
574 /* Terminate signature with a '0' - cheating, but should be ok */
576 if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m.sig)) {
577 slog(st,LOG_SEC,"msg3 signature failed check!");
583 /* Terminate their DH public key with a '0' */
585 /* Invent our DH secret key */
586 st->random->generate(st->random->st,st->dh->len,st->dhsecret);
588 /* Generate the shared key */
589 st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,m.pk,
590 st->sharedsecret,st->sharedsecretlen);
592 /* Set up the transform */
593 st->new_transform->setkey(st->new_transform->st,st->sharedsecret,
594 st->sharedsecretlen,st->setup_priority);
599 static bool_t generate_msg4(struct site *st)
601 /* We have both nonces, their public key and our private key. Generate
602 our public key, sign it and send it to them. */
603 return generate_msg(st,LABEL_MSG4,"site:MSG4");
606 static bool_t process_msg4(struct site *st, struct buffer_if *msg4,
607 const struct comm_addr *src)
614 if (!unpick_msg(st,LABEL_MSG4,msg4,&m)) return False;
615 if (!check_msg(st,LABEL_MSG4,&m,&err)) {
616 slog(st,LOG_SEC,"msg4: %s",err);
620 /* Check signature and store g^x mod m */
621 hash=safe_malloc(st->hash->len, "process_msg4");
622 hst=st->hash->init();
623 st->hash->update(hst,m.hashstart,m.hashlen);
624 st->hash->final(hst,hash);
625 /* Terminate signature with a '0' - cheating, but should be ok */
627 if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m.sig)) {
628 slog(st,LOG_SEC,"msg4 signature failed check!");
634 /* Terminate their DH public key with a '0' */
636 /* Generate the shared key */
637 st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,m.pk,
638 st->sharedsecret,st->sharedsecretlen);
639 /* Set up the transform */
640 st->new_transform->setkey(st->new_transform->st,st->sharedsecret,
641 st->sharedsecretlen,st->setup_priority);
652 static bool_t unpick_msg0(struct site *st, struct buffer_if *msg0,
656 m->dest=buf_unprepend_uint32(msg0);
658 m->source=buf_unprepend_uint32(msg0);
660 m->type=buf_unprepend_uint32(msg0);
662 /* Leaves transformed part of buffer untouched */
665 static bool_t generate_msg5(struct site *st)
667 cstring_t transform_err;
669 BUF_ALLOC(&st->buffer,"site:MSG5");
670 /* We are going to add four words to the message */
671 buffer_init(&st->buffer,st->transform->max_start_pad+(4*4));
672 /* Give the netlink code an opportunity to put its own stuff in the
673 message (configuration information, etc.) */
674 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
675 st->new_transform->forwards(st->new_transform->st,&st->buffer,
677 buf_prepend_uint32(&st->buffer,LABEL_MSG5);
678 buf_prepend_uint32(&st->buffer,st->index);
679 buf_prepend_uint32(&st->buffer,st->setup_session_id);
681 st->retries=st->setup_retries;
685 static bool_t process_msg5(struct site *st, struct buffer_if *msg5,
686 const struct comm_addr *src,
687 struct transform_inst_if *transform)
690 cstring_t transform_err;
692 if (!unpick_msg0(st,msg5,&m)) return False;
694 if (transform->reverse(transform->st,msg5,&transform_err)) {
695 /* There's a problem */
696 slog(st,LOG_SEC,"process_msg5: transform: %s",transform_err);
699 /* Buffer should now contain untransformed PING packet data */
701 if (buf_unprepend_uint32(msg5)!=LABEL_MSG5) {
702 slog(st,LOG_SEC,"MSG5/PING packet contained wrong label");
705 /* Older versions of secnet used to write some config data here
706 * which we ignore. So we don't CHECK_EMPTY */
710 static void create_msg6(struct site *st, struct transform_inst_if *transform,
713 cstring_t transform_err;
715 BUF_ALLOC(&st->buffer,"site:MSG6");
716 /* We are going to add four words to the message */
717 buffer_init(&st->buffer,st->transform->max_start_pad+(4*4));
718 /* Give the netlink code an opportunity to put its own stuff in the
719 message (configuration information, etc.) */
720 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
721 transform->forwards(transform->st,&st->buffer,&transform_err);
722 buf_prepend_uint32(&st->buffer,LABEL_MSG6);
723 buf_prepend_uint32(&st->buffer,st->index);
724 buf_prepend_uint32(&st->buffer,session_id);
727 static bool_t generate_msg6(struct site *st)
729 create_msg6(st,st->new_transform,st->setup_session_id);
730 st->retries=1; /* Peer will retransmit MSG5 if this packet gets lost */
734 static bool_t process_msg6(struct site *st, struct buffer_if *msg6,
735 const struct comm_addr *src)
738 cstring_t transform_err;
740 if (!unpick_msg0(st,msg6,&m)) return False;
742 if (st->new_transform->reverse(st->new_transform->st,
743 msg6,&transform_err)) {
744 /* There's a problem */
745 slog(st,LOG_SEC,"process_msg6: transform: %s",transform_err);
748 /* Buffer should now contain untransformed PING packet data */
750 if (buf_unprepend_uint32(msg6)!=LABEL_MSG6) {
751 slog(st,LOG_SEC,"MSG6/PONG packet contained invalid data");
754 /* Older versions of secnet used to write some config data here
755 * which we ignore. So we don't CHECK_EMPTY */
759 static bool_t decrypt_msg0(struct site *st, struct buffer_if *msg0,
760 const struct comm_addr *src)
762 cstring_t transform_err, auxkey_err, newkey_err="n/a";
766 if (!unpick_msg0(st,msg0,&m)) return False;
768 /* Keep a copy so we can try decrypting it with multiple keys */
769 buffer_copy(&st->scratch, msg0);
771 problem = st->current.transform->reverse(st->current.transform->st,
772 msg0,&transform_err);
774 if (!st->auxiliary_is_new)
775 delete_one_key(st,&st->auxiliary_key,
776 "peer has used new key","auxiliary key",LOG_SEC);
782 buffer_copy(msg0, &st->scratch);
783 problem = st->auxiliary_key.transform->reverse
784 (st->auxiliary_key.transform->st,msg0,&auxkey_err);
786 slog(st,LOG_DROP,"processing packet which uses auxiliary key");
787 if (st->auxiliary_is_new) {
788 /* We previously timed out in state SENTMSG5 but it turns
789 * out that our peer did in fact get our MSG5 and is
790 * using the new key. So we should switch to it too. */
791 /* This is a bit like activate_new_key. */
794 st->current=st->auxiliary_key;
797 delete_one_key(st,&st->auxiliary_key,"peer has used new key",
798 "previous key",LOG_SEC);
799 st->auxiliary_is_new=0;
800 st->renegotiate_key_time=st->auxiliary_renegotiate_key_time;
807 if (st->state==SITE_SENTMSG5) {
808 buffer_copy(msg0, &st->scratch);
809 problem = st->new_transform->reverse(st->new_transform->st,
812 /* It looks like we didn't get the peer's MSG6 */
813 /* This is like a cut-down enter_new_state(SITE_RUN) */
814 slog(st,LOG_STATE,"will enter state RUN (MSG0 with new key)");
815 BUF_FREE(&st->buffer);
817 activate_new_key(st);
818 return True; /* do process the data in this packet */
824 slog(st,LOG_SEC,"transform: %s (aux: %s, new: %s)",
825 transform_err,auxkey_err,newkey_err);
826 initiate_key_setup(st,"incoming message would not decrypt");
827 send_nak(src,m.dest,m.source,m.type,msg0,"message would not decrypt");
831 slog(st,LOG_DROP,"transform: %s (merely skew)",transform_err);
835 static bool_t process_msg0(struct site *st, struct buffer_if *msg0,
836 const struct comm_addr *src)
840 if (!decrypt_msg0(st,msg0,src))
844 type=buf_unprepend_uint32(msg0);
847 /* We must forget about the current session. */
848 delete_keys(st,"request from peer",LOG_SEC);
851 /* Deliver to netlink layer */
852 st->netlink->deliver(st->netlink->st,msg0);
853 transport_data_msgok(st,src);
854 /* See whether we should start negotiating a new key */
855 if (st->now > st->renegotiate_key_time)
856 initiate_key_setup(st,"incoming packet in renegotiation window");
859 slog(st,LOG_SEC,"incoming encrypted message of type %08x "
866 static void dump_packet(struct site *st, struct buffer_if *buf,
867 const struct comm_addr *addr, bool_t incoming)
869 uint32_t dest=ntohl(*(uint32_t *)buf->start);
870 uint32_t source=ntohl(*(uint32_t *)(buf->start+4));
871 uint32_t msgtype=ntohl(*(uint32_t *)(buf->start+8));
873 if (st->log_events & LOG_DUMP)
874 slilog(st->log,M_DEBUG,"%s: %s: %08x<-%08x: %08x:",
875 st->tunname,incoming?"incoming":"outgoing",
876 dest,source,msgtype);
879 static uint32_t site_status(void *st)
884 static bool_t send_msg(struct site *st)
887 transport_xmit(st, &st->setup_peers, &st->buffer, True);
888 st->timeout=st->now+st->setup_retry_interval;
891 } else if (st->state==SITE_SENTMSG5) {
892 slog(st,LOG_SETUP_TIMEOUT,"timed out sending MSG5, stashing new key");
893 /* We stash the key we have produced, in case it turns out that
894 * our peer did see our MSG5 after all and starts using it. */
895 /* This is a bit like some of activate_new_key */
896 struct transform_inst_if *t;
897 t=st->auxiliary_key.transform;
898 st->auxiliary_key.transform=st->new_transform;
902 st->auxiliary_is_new=1;
903 st->auxiliary_key.key_timeout=st->now+st->key_lifetime;
904 st->auxiliary_renegotiate_key_time=st->now+st->key_renegotiate_time;
905 st->auxiliary_key.remote_session_id=st->setup_session_id;
907 enter_state_wait(st);
910 slog(st,LOG_SETUP_TIMEOUT,"timed out sending key setup packet "
911 "(in state %s)",state_name(st->state));
912 enter_state_wait(st);
917 static void site_resolve_callback(void *sst, struct in_addr *address)
920 struct comm_addr ca_buf, *ca_use;
922 if (st->state!=SITE_RESOLVE) {
923 slog(st,LOG_UNEXPECTED,"site_resolve_callback called unexpectedly");
928 ca_buf.comm=st->comms[0];
929 ca_buf.sin.sin_family=AF_INET;
930 ca_buf.sin.sin_port=htons(st->remoteport);
931 ca_buf.sin.sin_addr=*address;
934 slog(st,LOG_ERROR,"resolution of %s failed",st->address);
937 if (transport_compute_setupinit_peers(st,ca_use)) {
938 enter_new_state(st,SITE_SENTMSG1);
940 /* Can't figure out who to try to to talk to */
941 slog(st,LOG_SETUP_INIT,"key exchange failed: cannot find peer address");
946 static bool_t initiate_key_setup(struct site *st, cstring_t reason)
948 if (st->state!=SITE_RUN) return False;
949 slog(st,LOG_SETUP_INIT,"initiating key exchange (%s)",reason);
951 slog(st,LOG_SETUP_INIT,"resolving peer address");
952 return enter_state_resolve(st);
953 } else if (transport_compute_setupinit_peers(st,0)) {
954 return enter_new_state(st,SITE_SENTMSG1);
956 slog(st,LOG_SETUP_INIT,"key exchange failed: no address for peer");
960 static void activate_new_key(struct site *st)
962 struct transform_inst_if *t;
964 /* We have three transform instances, which we swap between old,
966 t=st->auxiliary_key.transform;
967 st->auxiliary_key.transform=st->current.transform;
968 st->current.transform=st->new_transform;
973 st->auxiliary_is_new=0;
974 st->auxiliary_key.key_timeout=st->current.key_timeout;
975 st->current.key_timeout=st->now+st->key_lifetime;
976 st->renegotiate_key_time=st->now+st->key_renegotiate_time;
977 transport_peers_copy(st,&st->peers,&st->setup_peers);
978 st->current.remote_session_id=st->setup_session_id;
980 slog(st,LOG_ACTIVATE_KEY,"new key activated");
984 static void delete_one_key(struct site *st, struct data_key *key,
985 cstring_t reason, cstring_t which, uint32_t loglevel)
987 if (!key->transform->valid(key->transform->st)) return;
988 if (reason) slog(st,loglevel,"%s deleted (%s)",which,reason);
989 key->transform->delkey(key->transform->st);
993 static void delete_keys(struct site *st, cstring_t reason, uint32_t loglevel)
995 if (current_valid(st)) {
996 slog(st,loglevel,"session closed (%s)",reason);
998 delete_one_key(st,&st->current,0,0,0);
999 set_link_quality(st);
1001 delete_one_key(st,&st->auxiliary_key,0,0,0);
1004 static void state_assert(struct site *st, bool_t ok)
1006 if (!ok) fatal("site:state_assert");
1009 static void enter_state_stop(struct site *st)
1011 st->state=SITE_STOP;
1013 delete_keys(st,"entering state STOP",LOG_TIMEOUT_KEY);
1014 st->new_transform->delkey(st->new_transform->st);
1017 static void set_link_quality(struct site *st)
1020 if (current_valid(st))
1021 quality=LINK_QUALITY_UP;
1022 else if (st->state==SITE_WAIT || st->state==SITE_STOP)
1023 quality=LINK_QUALITY_DOWN;
1024 else if (st->address)
1025 quality=LINK_QUALITY_DOWN_CURRENT_ADDRESS;
1026 else if (transport_peers_valid(&st->peers))
1027 quality=LINK_QUALITY_DOWN_STALE_ADDRESS;
1029 quality=LINK_QUALITY_DOWN;
1031 st->netlink->set_quality(st->netlink->st,quality);
1034 static void enter_state_run(struct site *st)
1036 slog(st,LOG_STATE,"entering state RUN");
1040 st->setup_session_id=0;
1041 transport_peers_clear(st,&st->setup_peers);
1042 memset(st->localN,0,NONCELEN);
1043 memset(st->remoteN,0,NONCELEN);
1044 st->new_transform->delkey(st->new_transform->st);
1045 memset(st->dhsecret,0,st->dh->len);
1046 memset(st->sharedsecret,0,st->sharedsecretlen);
1047 set_link_quality(st);
1050 static bool_t enter_state_resolve(struct site *st)
1052 state_assert(st,st->state==SITE_RUN);
1053 slog(st,LOG_STATE,"entering state RESOLVE");
1054 st->state=SITE_RESOLVE;
1055 st->resolver->request(st->resolver->st,st->address,
1056 site_resolve_callback,st);
1060 static bool_t enter_new_state(struct site *st, uint32_t next)
1062 bool_t (*gen)(struct site *st);
1065 slog(st,LOG_STATE,"entering state %s",state_name(next));
1068 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
1072 state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1073 st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
1077 state_assert(st,st->state==SITE_SENTMSG1);
1078 BUF_FREE(&st->buffer);
1082 state_assert(st,st->state==SITE_SENTMSG2);
1083 BUF_FREE(&st->buffer);
1087 state_assert(st,st->state==SITE_SENTMSG3);
1088 BUF_FREE(&st->buffer);
1092 state_assert(st,st->state==SITE_SENTMSG4);
1093 BUF_FREE(&st->buffer);
1098 fatal("enter_new_state(%s): invalid new state",state_name(next));
1102 if (hacky_par_start_failnow()) return False;
1104 r= gen(st) && send_msg(st);
1107 st->setup_retries, st->setup_retry_interval,
1112 if (next==SITE_RUN) {
1113 BUF_FREE(&st->buffer); /* Never reused */
1114 st->timeout=0; /* Never retransmit */
1115 activate_new_key(st);
1119 slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1120 st->buffer.free=False; /* Unconditionally use the buffer; it may be
1121 in either state, and enter_state_wait() will
1123 enter_state_wait(st);
1127 /* msg7 tells our peer that we're about to forget our key */
1128 static bool_t send_msg7(struct site *st, cstring_t reason)
1130 cstring_t transform_err;
1132 if (current_valid(st) && st->buffer.free
1133 && transport_peers_valid(&st->peers)) {
1134 BUF_ALLOC(&st->buffer,"site:MSG7");
1135 buffer_init(&st->buffer,st->transform->max_start_pad+(4*3));
1136 buf_append_uint32(&st->buffer,LABEL_MSG7);
1137 buf_append_string(&st->buffer,reason);
1138 st->current.transform->forwards(st->current.transform->st,
1139 &st->buffer, &transform_err);
1140 buf_prepend_uint32(&st->buffer,LABEL_MSG0);
1141 buf_prepend_uint32(&st->buffer,st->index);
1142 buf_prepend_uint32(&st->buffer,st->current.remote_session_id);
1143 transport_xmit(st,&st->peers,&st->buffer,True);
1144 BUF_FREE(&st->buffer);
1150 /* We go into this state if our peer becomes uncommunicative. Similar to
1151 the "stop" state, we forget all session keys for a while, before
1152 re-entering the "run" state. */
1153 static void enter_state_wait(struct site *st)
1155 slog(st,LOG_STATE,"entering state WAIT");
1156 st->timeout=st->now+st->wait_timeout;
1157 st->state=SITE_WAIT;
1158 set_link_quality(st);
1159 BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1160 /* XXX Erase keys etc. */
1163 static inline void site_settimeout(uint64_t timeout, int *timeout_io)
1166 int64_t offset=timeout-*now;
1167 if (offset<0) offset=0;
1168 if (offset>INT_MAX) offset=INT_MAX;
1169 if (*timeout_io<0 || offset<*timeout_io)
1174 static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
1177 struct site *st=sst;
1179 *nfds_io=0; /* We don't use any file descriptors */
1182 /* Work out when our next timeout is. The earlier of 'timeout' or
1183 'current.key_timeout'. A stored value of '0' indicates no timeout
1185 site_settimeout(st->timeout, timeout_io);
1186 site_settimeout(st->current.key_timeout, timeout_io);
1187 site_settimeout(st->auxiliary_key.key_timeout, timeout_io);
1189 return 0; /* success */
1192 static void check_expiry(struct site *st, struct data_key *key,
1195 if (key->key_timeout && *now>key->key_timeout) {
1196 delete_one_key(st,key,"maximum life exceeded",which,LOG_TIMEOUT_KEY);
1200 /* NB site_afterpoll will be called before site_beforepoll is ever called */
1201 static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
1203 struct site *st=sst;
1206 if (st->timeout && *now>st->timeout) {
1208 if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
1209 if (!hacky_par_start_failnow())
1211 } else if (st->state==SITE_WAIT) {
1212 enter_state_run(st);
1214 slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
1218 check_expiry(st,&st->current,"current key");
1219 check_expiry(st,&st->auxiliary_key,"auxiliary key");
1222 /* This function is called by the netlink device to deliver packets
1223 intended for the remote network. The packet is in "raw" wire
1224 format, but is guaranteed to be word-aligned. */
1225 static void site_outgoing(void *sst, struct buffer_if *buf)
1227 struct site *st=sst;
1228 cstring_t transform_err;
1230 if (st->state==SITE_STOP) {
1235 /* In all other states we consider delivering the packet if we have
1236 a valid key and a valid address to send it to. */
1237 if (current_valid(st) && transport_peers_valid(&st->peers)) {
1238 /* Transform it and send it */
1240 buf_prepend_uint32(buf,LABEL_MSG9);
1241 st->current.transform->forwards(st->current.transform->st,
1242 buf, &transform_err);
1243 buf_prepend_uint32(buf,LABEL_MSG0);
1244 buf_prepend_uint32(buf,st->index);
1245 buf_prepend_uint32(buf,st->current.remote_session_id);
1246 transport_xmit(st,&st->peers,buf,False);
1252 slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
1254 initiate_key_setup(st,"outgoing packet");
1257 /* This function is called by the communication device to deliver
1258 packets from our peers. */
1259 static bool_t site_incoming(void *sst, struct buffer_if *buf,
1260 const struct comm_addr *source)
1262 struct site *st=sst;
1264 if (buf->size < 12) return False;
1266 uint32_t dest=ntohl(*(uint32_t *)buf->start);
1269 /* It could be for any site - it should have LABEL_MSG1 and
1270 might have our name and our peer's name in it */
1271 if (buf->size<(st->setupsiglen+8+NONCELEN)) return False;
1272 if (memcmp(buf->start+8,st->setupsig,st->setupsiglen)==0) {
1273 /* It's addressed to us. Decide what to do about it. */
1274 dump_packet(st,buf,source,True);
1275 if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1276 st->state==SITE_WAIT) {
1277 /* We should definitely process it */
1278 if (process_msg1(st,buf,source)) {
1279 slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
1280 enter_new_state(st,SITE_SENTMSG2);
1282 slog(st,LOG_ERROR,"failed to process incoming msg1");
1286 } else if (st->state==SITE_SENTMSG1) {
1287 /* We've just sent a message 1! They may have crossed on
1288 the wire. If we have priority then we ignore the
1289 incoming one, otherwise we process it as usual. */
1290 if (st->setup_priority) {
1292 slog(st,LOG_DUMP,"crossed msg1s; we are higher "
1293 "priority => ignore incoming msg1");
1296 slog(st,LOG_DUMP,"crossed msg1s; we are lower "
1297 "priority => use incoming msg1");
1298 if (process_msg1(st,buf,source)) {
1299 BUF_FREE(&st->buffer); /* Free our old message 1 */
1300 enter_new_state(st,SITE_SENTMSG2);
1302 slog(st,LOG_ERROR,"failed to process an incoming "
1303 "crossed msg1 (we have low priority)");
1309 /* The message 1 was received at an unexpected stage of the
1310 key setup. XXX POLICY - what do we do? */
1311 slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
1315 return False; /* Not for us. */
1317 if (dest==st->index) {
1318 /* Explicitly addressed to us */
1319 uint32_t msgtype=ntohl(get_uint32(buf->start+8));
1320 if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True);
1323 /* If the source is our current peer then initiate a key setup,
1324 because our peer's forgotten the key */
1325 if (get_uint32(buf->start+4)==st->current.remote_session_id) {
1326 initiate_key_setup(st,"received a NAK");
1328 slog(st,LOG_SEC,"bad incoming NAK");
1332 process_msg0(st,buf,source);
1335 /* Setup packet: should not have been explicitly addressed
1337 slog(st,LOG_SEC,"incoming explicitly addressed msg1");
1340 /* Setup packet: expected only in state SENTMSG1 */
1341 if (st->state!=SITE_SENTMSG1) {
1342 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
1343 } else if (process_msg2(st,buf,source)) {
1344 transport_setup_msgok(st,source);
1345 enter_new_state(st,SITE_SENTMSG3);
1347 slog(st,LOG_SEC,"invalid MSG2");
1351 /* Setup packet: expected only in state SENTMSG2 */
1352 if (st->state!=SITE_SENTMSG2) {
1353 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
1354 } else if (process_msg3(st,buf,source)) {
1355 transport_setup_msgok(st,source);
1356 enter_new_state(st,SITE_SENTMSG4);
1358 slog(st,LOG_SEC,"invalid MSG3");
1362 /* Setup packet: expected only in state SENTMSG3 */
1363 if (st->state!=SITE_SENTMSG3) {
1364 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
1365 } else if (process_msg4(st,buf,source)) {
1366 transport_setup_msgok(st,source);
1367 enter_new_state(st,SITE_SENTMSG5);
1369 slog(st,LOG_SEC,"invalid MSG4");
1373 /* Setup packet: expected only in state SENTMSG4 */
1374 /* (may turn up in state RUN if our return MSG6 was lost
1375 and the new key has already been activated. In that
1376 case we discard it. The peer will realise that we
1377 are using the new key when they see our data packets.
1378 Until then the peer's data packets to us get discarded. */
1379 if (st->state==SITE_SENTMSG4) {
1380 if (process_msg5(st,buf,source,st->new_transform)) {
1381 transport_setup_msgok(st,source);
1382 enter_new_state(st,SITE_RUN);
1384 slog(st,LOG_SEC,"invalid MSG5");
1386 } else if (st->state==SITE_RUN) {
1387 if (process_msg5(st,buf,source,st->current.transform)) {
1388 slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
1389 transport_setup_msgok(st,source);
1390 create_msg6(st,st->current.transform,
1391 st->current.remote_session_id);
1392 transport_xmit(st,&st->peers,&st->buffer,True);
1393 BUF_FREE(&st->buffer);
1395 slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
1398 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
1402 /* Setup packet: expected only in state SENTMSG5 */
1403 if (st->state!=SITE_SENTMSG5) {
1404 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
1405 } else if (process_msg6(st,buf,source)) {
1406 BUF_FREE(&st->buffer); /* Free message 5 */
1407 transport_setup_msgok(st,source);
1408 activate_new_key(st);
1410 slog(st,LOG_SEC,"invalid MSG6");
1414 slog(st,LOG_SEC,"received message of unknown type 0x%08x",
1425 static void site_control(void *vst, bool_t run)
1427 struct site *st=vst;
1428 if (run) enter_state_run(st);
1429 else enter_state_stop(st);
1432 static void site_phase_hook(void *sst, uint32_t newphase)
1434 struct site *st=sst;
1436 /* The program is shutting down; tell our peer */
1437 send_msg7(st,"shutting down");
1440 static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
1443 static uint32_t index_sequence;
1449 st=safe_malloc(sizeof(*st),"site_apply");
1451 st->cl.description="site";
1452 st->cl.type=CL_SITE;
1454 st->cl.interface=&st->ops;
1456 st->ops.control=site_control;
1457 st->ops.status=site_status;
1459 /* First parameter must be a dict */
1460 item=list_elem(args,0);
1461 if (!item || item->type!=t_dict)
1462 cfgfatal(loc,"site","parameter must be a dictionary\n");
1464 dict=item->data.dict;
1465 st->localname=dict_read_string(dict, "local-name", True, "site", loc);
1466 st->remotename=dict_read_string(dict, "name", True, "site", loc);
1468 st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
1469 bool_t local_mobile=
1470 dict_read_bool(dict,"local-mobile",False,"site",loc,False);
1472 /* Sanity check (which also allows the 'sites' file to include
1473 site() closures for all sites including our own): refuse to
1474 talk to ourselves */
1475 if (strcmp(st->localname,st->remotename)==0) {
1476 Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
1478 if (st->peer_mobile != local_mobile)
1479 cfgfatal(loc,"site","site %s's peer-mobile=%d"
1480 " but our local-mobile=%d\n",
1481 st->localname, st->peer_mobile, local_mobile);
1485 if (st->peer_mobile && local_mobile) {
1486 Message(M_WARNING,"site %s: site is mobile but so are we"
1487 " -> ignoring this site\n", st->remotename);
1492 assert(index_sequence < 0xffffffffUL);
1493 st->index = ++index_sequence;
1494 st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
1496 list_t *comms_cfg=dict_lookup(dict,"comm");
1497 if (!comms_cfg) cfgfatal(loc,"site","closure list \"comm\" not found\n");
1498 st->ncomms=list_length(comms_cfg);
1499 st->comms=safe_malloc_ary(sizeof(*st->comms),st->ncomms,"comms");
1501 for (i=0; i<st->ncomms; i++) {
1502 item_t *item=list_elem(comms_cfg,i);
1503 if (item->type!=t_closure)
1504 cfgfatal(loc,"site","comm is not a closure\n");
1505 closure_t *cl=item->data.closure;
1506 if (cl->type!=CL_COMM) cfgfatal(loc,"site","comm closure wrong type\n");
1507 st->comms[i]=cl->interface;
1510 st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
1511 st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
1512 st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
1514 st->privkey=find_cl_if(dict,"local-key",CL_RSAPRIVKEY,True,"site",loc);
1515 st->address=dict_read_string(dict, "address", False, "site", loc);
1517 st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
1518 else st->remoteport=0;
1519 st->pubkey=find_cl_if(dict,"key",CL_RSAPUBKEY,True,"site",loc);
1522 find_cl_if(dict,"transform",CL_TRANSFORM,True,"site",loc);
1524 st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
1525 st->hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
1527 #define DEFAULT(D) (st->peer_mobile || local_mobile \
1528 ? DEFAULT_MOBILE_##D : DEFAULT_##D)
1529 #define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
1531 st->key_lifetime= CFG_NUMBER("key-lifetime", KEY_LIFETIME);
1532 st->setup_retries= CFG_NUMBER("setup-retries", SETUP_RETRIES);
1533 st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
1534 st->wait_timeout= CFG_NUMBER("wait-time", WAIT_TIME);
1536 st->mobile_peer_expiry= dict_read_number(
1537 dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
1539 st->transport_peers_max= !st->peer_mobile ? 1 : dict_read_number(
1540 dict,"mobile-peers-max",False,"site",loc,DEFAULT_MOBILE_PEERS_MAX);
1541 if (st->transport_peers_max<1 ||
1542 st->transport_peers_max>=MAX_MOBILE_PEERS_MAX) {
1543 cfgfatal(loc,"site","mobile-peers-max must be in range 1.."
1544 STRING(MAX_MOBILE_PEERS_MAX) "\n");
1547 if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
1548 st->key_renegotiate_time=st->key_lifetime/2;
1550 st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
1551 st->key_renegotiate_time=dict_read_number(
1552 dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
1553 if (st->key_renegotiate_time > st->key_lifetime) {
1554 cfgfatal(loc,"site",
1555 "renegotiate-time must be less than key-lifetime\n");
1558 st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
1559 log_event_table,"site");
1561 st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
1563 sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
1565 /* The information we expect to see in incoming messages of type 1 */
1566 /* fixme: lots of unchecked overflows here, but the results are only
1567 corrupted packets rather than undefined behaviour */
1568 st->setupsiglen=strlen(st->remotename)+strlen(st->localname)+8;
1569 st->setupsig=safe_malloc(st->setupsiglen,"site_apply");
1570 put_uint32(st->setupsig+0,LABEL_MSG1);
1571 put_uint16(st->setupsig+4,strlen(st->remotename));
1572 memcpy(&st->setupsig[6],st->remotename,strlen(st->remotename));
1573 put_uint16(st->setupsig+(6+strlen(st->remotename)),strlen(st->localname));
1574 memcpy(&st->setupsig[8+strlen(st->remotename)],st->localname,
1575 strlen(st->localname));
1576 st->setup_priority=(strcmp(st->localname,st->remotename)>0);
1578 buffer_new(&st->buffer,SETUP_BUFFER_LEN);
1580 buffer_new(&st->scratch,0);
1581 BUF_ALLOC(&st->scratch,"site:scratch");
1583 /* We are interested in poll(), but only for timeouts. We don't have
1584 any fds of our own. */
1585 register_for_poll(st, site_beforepoll, site_afterpoll, 0, "site");
1588 st->current.key_timeout=0;
1589 st->auxiliary_key.key_timeout=0;
1590 transport_peers_clear(st,&st->peers);
1591 transport_peers_clear(st,&st->setup_peers);
1592 /* XXX mlock these */
1593 st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
1594 st->sharedsecretlen=st->transform->keylen?:st->dh->ceil_len;
1595 st->sharedsecret=safe_malloc(st->sharedsecretlen,"site:sharedsecret");
1597 /* We need to compute some properties of our comms */
1598 #define COMPUTE_WORST(pad) \
1599 int worst_##pad=0; \
1600 for (i=0; i<st->ncomms; i++) { \
1601 int thispad=st->comms[i]->pad; \
1602 if (thispad > worst_##pad) \
1603 worst_##pad=thispad; \
1605 COMPUTE_WORST(min_start_pad)
1606 COMPUTE_WORST(min_end_pad)
1608 /* We need to register the remote networks with the netlink device */
1609 st->netlink->reg(st->netlink->st, site_outgoing, st,
1610 st->transform->max_start_pad+(4*4)+
1611 worst_min_start_pad,
1612 st->transform->max_end_pad+worst_min_end_pad);
1614 for (i=0; i<st->ncomms; i++)
1615 st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
1617 st->current.transform=st->transform->create(st->transform->st);
1618 st->auxiliary_key.transform=st->transform->create(st->transform->st);
1619 st->new_transform=st->transform->create(st->transform->st);
1620 st->auxiliary_is_new=0;
1622 enter_state_stop(st);
1624 add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
1626 return new_closure(&st->cl);
1629 void site_module(dict_t *dict)
1631 add_closure(dict,"site",site_apply);
1635 /***** TRANSPORT PEERS definitions *****/
1637 static void transport_peers_debug(struct site *st, transport_peers *dst,
1638 const char *didwhat,
1639 int nargs, const struct comm_addr *args,
1644 if (!(st->log_events & LOG_PEER_ADDRS))
1645 return; /* an optimisation */
1647 slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
1648 (dst==&st->peers ? "data" :
1649 dst==&st->setup_peers ? "setup" : "UNKNOWN"),
1650 didwhat, nargs, dst->npeers);
1652 for (i=0, argp=(void*)args;
1654 i++, (argp+=stride?stride:sizeof(*args))) {
1655 const struct comm_addr *ca=(void*)argp;
1656 slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
1657 i, ca->comm->addr_to_string(ca->comm->st,ca));
1659 for (i=0; i<dst->npeers; i++) {
1660 struct timeval diff;
1661 timersub(tv_now,&dst->peers[i].last,&diff);
1662 const struct comm_addr *ca=&dst->peers[i].addr;
1663 slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
1664 i, ca->comm->addr_to_string(ca->comm->st,ca),
1665 (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
1669 static int transport_peer_compar(const void *av, const void *bv) {
1670 const transport_peer *a=av;
1671 const transport_peer *b=bv;
1672 /* put most recent first in the array */
1673 if (timercmp(&a->last, &b->last, <)) return +1;
1674 if (timercmp(&a->last, &b->last, >)) return -11;
1678 static void transport_peers_expire(struct site *st, transport_peers *peers) {
1679 /* peers must be sorted first */
1680 int previous_peers=peers->npeers;
1681 struct timeval oldest;
1682 oldest.tv_sec = tv_now->tv_sec - st->mobile_peer_expiry;
1683 oldest.tv_usec = tv_now->tv_usec;
1684 while (peers->npeers>1 &&
1685 timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
1687 if (peers->npeers != previous_peers)
1688 transport_peers_debug(st,peers,"expire", 0,0,0);
1691 static void transport_record_peer(struct site *st, transport_peers *peers,
1692 const struct comm_addr *addr, const char *m) {
1693 int slot, changed=0;
1695 for (slot=0; slot<peers->npeers; slot++)
1696 if (!memcmp(&peers->peers[slot].addr, addr, sizeof(*addr)))
1700 if (peers->npeers==st->transport_peers_max)
1701 slot=st->transport_peers_max;
1703 slot=peers->npeers++;
1706 peers->peers[slot].addr=*addr;
1707 peers->peers[slot].last=*tv_now;
1709 if (peers->npeers>1)
1710 qsort(peers->peers, peers->npeers,
1711 sizeof(*peers->peers), transport_peer_compar);
1713 if (changed || peers->npeers!=1)
1714 transport_peers_debug(st,peers,m, 1,addr,0);
1715 transport_peers_expire(st, peers);
1718 static bool_t transport_compute_setupinit_peers(struct site *st,
1719 const struct comm_addr *configured_addr /* 0 if none or not found */) {
1721 if (!configured_addr && !transport_peers_valid(&st->peers))
1724 slog(st,LOG_SETUP_INIT,
1725 (!configured_addr ? "using only %d old peer address(es)"
1726 : "using configured address, and/or perhaps %d old peer address(es)"),
1729 /* Non-mobile peers havve st->peers.npeers==0 or ==1, since they
1730 * have transport_peers_max==1. The effect is that this code
1731 * always uses the configured address if supplied, or otherwise
1732 * the existing data peer if one exists; this is as desired. */
1734 transport_peers_copy(st,&st->setup_peers,&st->peers);
1736 if (configured_addr)
1737 transport_record_peer(st,&st->setup_peers,configured_addr,"setupinit");
1739 assert(transport_peers_valid(&st->setup_peers));
1743 static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
1744 if (st->peer_mobile)
1745 transport_record_peer(st,&st->setup_peers,a,"setupmsg");
1747 static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
1748 if (st->peer_mobile)
1749 transport_record_peer(st,&st->peers,a,"datamsg");
1752 static int transport_peers_valid(transport_peers *peers) {
1753 return peers->npeers;
1755 static void transport_peers_clear(struct site *st, transport_peers *peers) {
1757 transport_peers_debug(st,peers,"clear",0,0,0);
1759 static void transport_peers_copy(struct site *st, transport_peers *dst,
1760 const transport_peers *src) {
1761 dst->npeers=src->npeers;
1762 memcpy(dst->peers, src->peers, sizeof(*dst->peers) * dst->npeers);
1763 transport_peers_debug(st,dst,"copy",
1764 src->npeers, &src->peers->addr, sizeof(*src->peers));
1767 void transport_xmit(struct site *st, transport_peers *peers,
1768 struct buffer_if *buf, bool_t candebug) {
1770 transport_peers_expire(st, peers);
1771 for (slot=0; slot<peers->npeers; slot++) {
1772 transport_peer *peer=&peers->peers[slot];
1774 dump_packet(st, buf, &peer->addr, False);
1775 peer->addr.comm->sendmsg(peer->addr.comm->st, buf, &peer->addr);
1779 /***** END of transport peers declarations *****/