site.c

   1 /* site.c - manage communication with a remote network site */
   2
   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).  */
  11
  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. */
  15
  16 #include "secnet.h"
  17 #include <stdio.h>
  18 #include <string.h>
  19 #include <limits.h>
  20 #include <assert.h>
  21 #include <sys/socket.h>
  22
  23 #include <sys/mman.h>
  24 #include "util.h"
  25 #include "unaligned.h"
  26 #include "magic.h"
  27
  28 #define SETUP_BUFFER_LEN 2048
  29
  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] */
  35
  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] */
  41
  42 #define DEFAULT_MOBILE_PEER_EXPIRY            (2*60)      /* [s] */
  43 #define DEFAULT_MOBILE_PEERS_MAX 3 /* send at most this many copies (default) */
  44
  45 /* Each site can be in one of several possible states. */
  46
  47 /* 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
  62    SITE_SENTMSG1
  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
  66    SITE_SENTMSG2
  67      -> SITE_SENTMSG4 upon valid incoming message 3
  68      -> SITE_WAIT on timeout
  69    SITE_SENTMSG3
  70      -> SITE_SENTMSG5 upon valid incoming message 4
  71      -> SITE_WAIT on timeout
  72    SITE_SENTMSG4
  73      -> SITE_RUN upon valid incoming message 5
  74      -> SITE_WAIT on timeout
  75    SITE_SENTMSG5
  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
  80    */
  81
  82 #define SITE_STOP     0
  83 #define SITE_RUN      1
  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
  90 #define SITE_WAIT     8
  91
  92 static cstring_t state_name(uint32_t state)
  93 {
  94     switch (state) {
  95     case 0: return "STOP";
  96     case 1: return "RUN";
  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*";
 105     }
 106 }
 107
 108 #define NONCELEN 8
 109
 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
 121
 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 },
 137     { NULL, 0 }
 138 };
 139
 140
 141 /***** TRANSPORT PEERS declarations *****/
 142
 143 /* Details of "mobile peer" semantics:
 144
 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.)
 149
 150    - Outgoing packets are sent to every recorded peer in the
 151      applicable list.
 152
 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.
 157
 158      (For "non-mobile" peers we simply copy the peer used for
 159      successful key setup, and don't change the peer otherwise.)
 160
 161    - Key setup peers are slightly more complicated.
 162
 163      Whenever we receive and successfully process a key exchange
 164      packet, we record the peer.
 165
 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).
 171
 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.)
 176
 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.
 182
 183    */
 184
 185 #define MAX_MOBILE_PEERS_MAX 5 /* send at most this many copies, compiled max */
 186
 187 typedef struct {
 188     struct timeval last;
 189     struct comm_addr addr;
 190 } transport_peer;
 191
 192 typedef struct {
 193 /* configuration information */
 194 /* runtime information */
 195     int npeers;
 196     transport_peer peers[MAX_MOBILE_PEERS_MAX];
 197 } transport_peers;
 198
 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);
 203
 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);
 210
 211 static void transport_xmit(struct site *st, transport_peers *peers,
 212                            struct buffer_if *buf, bool_t candebug);
 213
 214  /***** END of transport peers declarations *****/
 215
 216
 217 struct site {
 218     closure_t cl;
 219     struct site_if ops;
 220 /* configuration information */
 221     string_t localname;
 222     string_t remotename;
 223     bool_t peer_mobile; /* Mobile client support */
 224     int32_t transport_peers_max;
 225     string_t tunname; /* localname<->remotename by default, used in logs */
 226     string_t address; /* DNS name for bootstrapping, optional */
 227     int remoteport; /* Port for bootstrapping, optional */
 228     struct netlink_if *netlink;
 229     struct comm_if **comms;
 230     int ncomms;
 231     struct resolver_if *resolver;
 232     struct log_if *log;
 233     struct random_if *random;
 234     struct rsaprivkey_if *privkey;
 235     struct rsapubkey_if *pubkey;
 236     struct transform_if *transform;
 237     struct dh_if *dh;
 238     struct hash_if *hash;
 239
 240     uint32_t index; /* Index of this site */
 241     int32_t setup_retries; /* How many times to send setup packets */
 242     int32_t setup_retry_interval; /* Initial timeout for setup packets */
 243     int32_t wait_timeout; /* How long to wait if setup unsuccessful */
 244     int32_t mobile_peer_expiry; /* How long to remember 2ary addresses */
 245     int32_t key_lifetime; /* How long a key lasts once set up */
 246     int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
 247                                       after this time, initiate a new
 248                                       key exchange */
 249
 250     uint8_t *setupsig; /* Expected signature of incoming MSG1 packets */
 251     int32_t setupsiglen; /* Allows us to discard packets quickly if
 252                             they are not for us */
 253     bool_t setup_priority; /* Do we have precedence if both sites emit
 254                               message 1 simultaneously? */
 255     uint32_t log_events;
 256
 257 /* runtime information */
 258     uint32_t state;
 259     uint64_t now; /* Most recently seen time */
 260
 261     /* The currently established session */
 262     uint32_t remote_session_id;
 263     struct transform_inst_if *current_transform;
 264     bool_t current_valid;
 265     uint64_t current_key_timeout; /* End of life of current key */
 266     uint64_t renegotiate_key_time; /* When we can negotiate a new key */
 267     transport_peers peers; /* Current address(es) of peer for data traffic */
 268
 269     /* The current key setup protocol exchange.  We can only be
 270        involved in one of these at a time.  There's a potential for
 271        denial of service here (the attacker keeps sending a setup
 272        packet; we keep trying to continue the exchange, and have to
 273        timeout before we can listen for another setup packet); perhaps
 274        we should keep a list of 'bad' sources for setup packets. */
 275     uint32_t setup_session_id;
 276     transport_peers setup_peers;
 277     uint8_t localN[NONCELEN]; /* Nonces for key exchange */
 278     uint8_t remoteN[NONCELEN];
 279     struct buffer_if buffer; /* Current outgoing key exchange packet */
 280     struct buffer_if scratch;
 281     int32_t retries; /* Number of retries remaining */
 282     uint64_t timeout; /* Timeout for current state */
 283     uint8_t *dhsecret;
 284     uint8_t *sharedsecret;
 285     struct transform_inst_if *new_transform; /* For key setup/verify */
 286 };
 287
 288 static void slog(struct site *st, uint32_t event, cstring_t msg, ...)
 289 {
 290     va_list ap;
 291     char buf[240];
 292     uint32_t class;
 293
 294     va_start(ap,msg);
 295
 296     if (event&st->log_events) {
 297         switch(event) {
 298         case LOG_UNEXPECTED: class=M_INFO; break;
 299         case LOG_SETUP_INIT: class=M_INFO; break;
 300         case LOG_SETUP_TIMEOUT: class=M_NOTICE; break;
 301         case LOG_ACTIVATE_KEY: class=M_INFO; break;
 302         case LOG_TIMEOUT_KEY: class=M_INFO; break;
 303         case LOG_SEC: class=M_SECURITY; break;
 304         case LOG_STATE: class=M_DEBUG; break;
 305         case LOG_DROP: class=M_DEBUG; break;
 306         case LOG_DUMP: class=M_DEBUG; break;
 307         case LOG_ERROR: class=M_ERR; break;
 308         case LOG_PEER_ADDRS: class=M_DEBUG; break;
 309         default: class=M_ERR; break;
 310         }
 311
 312         vsnprintf(buf,sizeof(buf),msg,ap);
 313         st->log->log(st->log->st,class,"%s: %s",st->tunname,buf);
 314     }
 315     va_end(ap);
 316 }
 317
 318 static void set_link_quality(struct site *st);
 319 static void delete_key(struct site *st, cstring_t reason, uint32_t loglevel);
 320 static bool_t initiate_key_setup(struct site *st, cstring_t reason);
 321 static void enter_state_run(struct site *st);
 322 static bool_t enter_state_resolve(struct site *st);
 323 static bool_t enter_new_state(struct site *st,uint32_t next);
 324 static void enter_state_wait(struct site *st);
 325 static void activate_new_key(struct site *st);
 326
 327 #define CHECK_AVAIL(b,l) do { if ((b)->size<(l)) return False; } while(0)
 328 #define CHECK_EMPTY(b) do { if ((b)->size!=0) return False; } while(0)
 329 #define CHECK_TYPE(b,t) do { uint32_t type; \
 330     CHECK_AVAIL((b),4); \
 331     type=buf_unprepend_uint32((b)); \
 332     if (type!=(t)) return False; } while(0)
 333
 334 struct msg {
 335     uint8_t *hashstart;
 336     uint32_t dest;
 337     uint32_t source;
 338     int32_t remlen;
 339     uint8_t *remote;
 340     int32_t loclen;
 341     uint8_t *local;
 342     uint8_t *nR;
 343     uint8_t *nL;
 344     int32_t pklen;
 345     char *pk;
 346     int32_t hashlen;
 347     int32_t siglen;
 348     char *sig;
 349 };
 350
 351 /* Build any of msg1 to msg4. msg5 and msg6 are built from the inside
 352    out using a transform of config data supplied by netlink */
 353 static bool_t generate_msg(struct site *st, uint32_t type, cstring_t what)
 354 {
 355     void *hst;
 356     uint8_t *hash;
 357     string_t dhpub, sig;
 358
 359     st->retries=st->setup_retries;
 360     BUF_ALLOC(&st->buffer,what);
 361     buffer_init(&st->buffer,0);
 362     buf_append_uint32(&st->buffer,
 363         (type==LABEL_MSG1?0:st->setup_session_id));
 364     buf_append_uint32(&st->buffer,st->index);
 365     buf_append_uint32(&st->buffer,type);
 366     buf_append_string(&st->buffer,st->localname);
 367     buf_append_string(&st->buffer,st->remotename);
 368     memcpy(buf_append(&st->buffer,NONCELEN),st->localN,NONCELEN);
 369     if (type==LABEL_MSG1) return True;
 370     memcpy(buf_append(&st->buffer,NONCELEN),st->remoteN,NONCELEN);
 371     if (type==LABEL_MSG2) return True;
 372
 373     if (hacky_par_mid_failnow()) return False;
 374
 375     dhpub=st->dh->makepublic(st->dh->st,st->dhsecret,st->dh->len);
 376     buf_append_string(&st->buffer,dhpub);
 377     free(dhpub);
 378     hash=safe_malloc(st->hash->len, "generate_msg");
 379     hst=st->hash->init();
 380     st->hash->update(hst,st->buffer.start,st->buffer.size);
 381     st->hash->final(hst,hash);
 382     sig=st->privkey->sign(st->privkey->st,hash,st->hash->len);
 383     buf_append_string(&st->buffer,sig);
 384     free(sig);
 385     free(hash);
 386     return True;
 387 }
 388
 389 static bool_t unpick_msg(struct site *st, uint32_t type,
 390                          struct buffer_if *msg, struct msg *m)
 391 {
 392     m->hashstart=msg->start;
 393     CHECK_AVAIL(msg,4);
 394     m->dest=buf_unprepend_uint32(msg);
 395     CHECK_AVAIL(msg,4);
 396     m->source=buf_unprepend_uint32(msg);
 397     CHECK_TYPE(msg,type);
 398     CHECK_AVAIL(msg,2);
 399     m->remlen=buf_unprepend_uint16(msg);
 400     CHECK_AVAIL(msg,m->remlen);
 401     m->remote=buf_unprepend(msg,m->remlen);
 402     CHECK_AVAIL(msg,2);
 403     m->loclen=buf_unprepend_uint16(msg);
 404     CHECK_AVAIL(msg,m->loclen);
 405     m->local=buf_unprepend(msg,m->loclen);
 406     CHECK_AVAIL(msg,NONCELEN);
 407     m->nR=buf_unprepend(msg,NONCELEN);
 408     if (type==LABEL_MSG1) {
 409         CHECK_EMPTY(msg);
 410         return True;
 411     }
 412     CHECK_AVAIL(msg,NONCELEN);
 413     m->nL=buf_unprepend(msg,NONCELEN);
 414     if (type==LABEL_MSG2) {
 415         CHECK_EMPTY(msg);
 416         return True;
 417     }
 418     CHECK_AVAIL(msg,2);
 419     m->pklen=buf_unprepend_uint16(msg);
 420     CHECK_AVAIL(msg,m->pklen);
 421     m->pk=buf_unprepend(msg,m->pklen);
 422     m->hashlen=msg->start-m->hashstart;
 423     CHECK_AVAIL(msg,2);
 424     m->siglen=buf_unprepend_uint16(msg);
 425     CHECK_AVAIL(msg,m->siglen);
 426     m->sig=buf_unprepend(msg,m->siglen);
 427     CHECK_EMPTY(msg);
 428     return True;
 429 }
 430
 431 static bool_t check_msg(struct site *st, uint32_t type, struct msg *m,
 432                         cstring_t *error)
 433 {
 434     if (type==LABEL_MSG1) return True;
 435
 436     /* Check that the site names and our nonce have been sent
 437        back correctly, and then store our peer's nonce. */
 438     if (memcmp(m->remote,st->remotename,strlen(st->remotename)!=0)) {
 439         *error="wrong remote site name";
 440         return False;
 441     }
 442     if (memcmp(m->local,st->localname,strlen(st->localname)!=0)) {
 443         *error="wrong local site name";
 444         return False;
 445     }
 446     if (memcmp(m->nL,st->localN,NONCELEN)!=0) {
 447         *error="wrong locally-generated nonce";
 448         return False;
 449     }
 450     if (type==LABEL_MSG2) return True;
 451     if (memcmp(m->nR,st->remoteN,NONCELEN)!=0) {
 452         *error="wrong remotely-generated nonce";
 453         return False;
 454     }
 455     if (type==LABEL_MSG3) return True;
 456     if (type==LABEL_MSG4) return True;
 457     *error="unknown message type";
 458     return False;
 459 }
 460
 461 static bool_t generate_msg1(struct site *st)
 462 {
 463     st->random->generate(st->random->st,NONCELEN,st->localN);
 464     return generate_msg(st,LABEL_MSG1,"site:MSG1");
 465 }
 466
 467 static bool_t process_msg1(struct site *st, struct buffer_if *msg1,
 468                            const struct comm_addr *src)
 469 {
 470     struct msg m;
 471
 472     /* We've already determined we're in an appropriate state to
 473        process an incoming MSG1, and that the MSG1 has correct values
 474        of A and B. */
 475
 476     if (!unpick_msg(st,LABEL_MSG1,msg1,&m)) return False;
 477
 478     transport_record_peer(st,&st->setup_peers,src,"msg1");
 479     st->setup_session_id=m.source;
 480     memcpy(st->remoteN,m.nR,NONCELEN);
 481     return True;
 482 }
 483
 484 static bool_t generate_msg2(struct site *st)
 485 {
 486     st->random->generate(st->random->st,NONCELEN,st->localN);
 487     return generate_msg(st,LABEL_MSG2,"site:MSG2");
 488 }
 489
 490 static bool_t process_msg2(struct site *st, struct buffer_if *msg2,
 491                            const struct comm_addr *src)
 492 {
 493     struct msg m;
 494     cstring_t err;
 495
 496     if (!unpick_msg(st,LABEL_MSG2,msg2,&m)) return False;
 497     if (!check_msg(st,LABEL_MSG2,&m,&err)) {
 498         slog(st,LOG_SEC,"msg2: %s",err);
 499         return False;
 500     }
 501     st->setup_session_id=m.source;
 502     memcpy(st->remoteN,m.nR,NONCELEN);
 503     return True;
 504 }
 505
 506 static bool_t generate_msg3(struct site *st)
 507 {
 508     /* Now we have our nonce and their nonce. Think of a secret key,
 509        and create message number 3. */
 510     st->random->generate(st->random->st,st->dh->len,st->dhsecret);
 511     return generate_msg(st,LABEL_MSG3,"site:MSG3");
 512 }
 513
 514 static bool_t process_msg3(struct site *st, struct buffer_if *msg3,
 515                            const struct comm_addr *src)
 516 {
 517     struct msg m;
 518     uint8_t *hash;
 519     void *hst;
 520     cstring_t err;
 521
 522     if (!unpick_msg(st,LABEL_MSG3,msg3,&m)) return False;
 523     if (!check_msg(st,LABEL_MSG3,&m,&err)) {
 524         slog(st,LOG_SEC,"msg3: %s",err);
 525         return False;
 526     }
 527
 528     /* Check signature and store g^x mod m */
 529     hash=safe_malloc(st->hash->len, "process_msg3");
 530     hst=st->hash->init();
 531     st->hash->update(hst,m.hashstart,m.hashlen);
 532     st->hash->final(hst,hash);
 533     /* Terminate signature with a '0' - cheating, but should be ok */
 534     m.sig[m.siglen]=0;
 535     if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m.sig)) {
 536         slog(st,LOG_SEC,"msg3 signature failed check!");
 537         free(hash);
 538         return False;
 539     }
 540     free(hash);
 541
 542     /* Terminate their DH public key with a '0' */
 543     m.pk[m.pklen]=0;
 544     /* Invent our DH secret key */
 545     st->random->generate(st->random->st,st->dh->len,st->dhsecret);
 546
 547     /* Generate the shared key */
 548     st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,m.pk,
 549                        st->sharedsecret,st->transform->keylen);
 550
 551     /* Set up the transform */
 552     st->new_transform->setkey(st->new_transform->st,st->sharedsecret,
 553                               st->transform->keylen);
 554
 555     return True;
 556 }
 557
 558 static bool_t generate_msg4(struct site *st)
 559 {
 560     /* We have both nonces, their public key and our private key. Generate
 561        our public key, sign it and send it to them. */
 562     return generate_msg(st,LABEL_MSG4,"site:MSG4");
 563 }
 564
 565 static bool_t process_msg4(struct site *st, struct buffer_if *msg4,
 566                            const struct comm_addr *src)
 567 {
 568     struct msg m;
 569     uint8_t *hash;
 570     void *hst;
 571     cstring_t err;
 572
 573     if (!unpick_msg(st,LABEL_MSG4,msg4,&m)) return False;
 574     if (!check_msg(st,LABEL_MSG4,&m,&err)) {
 575         slog(st,LOG_SEC,"msg4: %s",err);
 576         return False;
 577     }
 578
 579     /* Check signature and store g^x mod m */
 580     hash=safe_malloc(st->hash->len, "process_msg4");
 581     hst=st->hash->init();
 582     st->hash->update(hst,m.hashstart,m.hashlen);
 583     st->hash->final(hst,hash);
 584     /* Terminate signature with a '0' - cheating, but should be ok */
 585     m.sig[m.siglen]=0;
 586     if (!st->pubkey->check(st->pubkey->st,hash,st->hash->len,m.sig)) {
 587         slog(st,LOG_SEC,"msg4 signature failed check!");
 588         free(hash);
 589         return False;
 590     }
 591     free(hash);
 592
 593     /* Terminate their DH public key with a '0' */
 594     m.pk[m.pklen]=0;
 595     /* Generate the shared key */
 596     st->dh->makeshared(st->dh->st,st->dhsecret,st->dh->len,m.pk,
 597                        st->sharedsecret,st->transform->keylen);
 598     /* Set up the transform */
 599     st->new_transform->setkey(st->new_transform->st,st->sharedsecret,
 600                               st->transform->keylen);
 601
 602     return True;
 603 }
 604
 605 struct msg0 {
 606     uint32_t dest;
 607     uint32_t source;
 608     uint32_t type;
 609 };
 610
 611 static bool_t unpick_msg0(struct site *st, struct buffer_if *msg0,
 612                           struct msg0 *m)
 613 {
 614     CHECK_AVAIL(msg0,4);
 615     m->dest=buf_unprepend_uint32(msg0);
 616     CHECK_AVAIL(msg0,4);
 617     m->source=buf_unprepend_uint32(msg0);
 618     CHECK_AVAIL(msg0,4);
 619     m->type=buf_unprepend_uint32(msg0);
 620     return True;
 621     /* Leaves transformed part of buffer untouched */
 622 }
 623
 624 static bool_t generate_msg5(struct site *st)
 625 {
 626     cstring_t transform_err;
 627
 628     BUF_ALLOC(&st->buffer,"site:MSG5");
 629     /* We are going to add four words to the message */
 630     buffer_init(&st->buffer,st->transform->max_start_pad+(4*4));
 631     /* Give the netlink code an opportunity to put its own stuff in the
 632        message (configuration information, etc.) */
 633     buf_prepend_uint32(&st->buffer,LABEL_MSG5);
 634     st->new_transform->forwards(st->new_transform->st,&st->buffer,
 635                                 &transform_err);
 636     buf_prepend_uint32(&st->buffer,LABEL_MSG5);
 637     buf_prepend_uint32(&st->buffer,st->index);
 638     buf_prepend_uint32(&st->buffer,st->setup_session_id);
 639
 640     st->retries=st->setup_retries;
 641     return True;
 642 }
 643
 644 static bool_t process_msg5(struct site *st, struct buffer_if *msg5,
 645                            const struct comm_addr *src,
 646                            struct transform_inst_if *transform)
 647 {
 648     struct msg0 m;
 649     cstring_t transform_err;
 650
 651     if (!unpick_msg0(st,msg5,&m)) return False;
 652
 653     if (transform->reverse(transform->st,msg5,&transform_err)) {
 654         /* There's a problem */
 655         slog(st,LOG_SEC,"process_msg5: transform: %s",transform_err);
 656         return False;
 657     }
 658     /* Buffer should now contain untransformed PING packet data */
 659     CHECK_AVAIL(msg5,4);
 660     if (buf_unprepend_uint32(msg5)!=LABEL_MSG5) {
 661         slog(st,LOG_SEC,"MSG5/PING packet contained wrong label");
 662         return False;
 663     }
 664     /* Older versions of secnet used to write some config data here
 665      * which we ignore.  So we don't CHECK_EMPTY */
 666     return True;
 667 }
 668
 669 static void create_msg6(struct site *st, struct transform_inst_if *transform,
 670                         uint32_t session_id)
 671 {
 672     cstring_t transform_err;
 673
 674     BUF_ALLOC(&st->buffer,"site:MSG6");
 675     /* We are going to add four words to the message */
 676     buffer_init(&st->buffer,st->transform->max_start_pad+(4*4));
 677     /* Give the netlink code an opportunity to put its own stuff in the
 678        message (configuration information, etc.) */
 679     buf_prepend_uint32(&st->buffer,LABEL_MSG6);
 680     transform->forwards(transform->st,&st->buffer,&transform_err);
 681     buf_prepend_uint32(&st->buffer,LABEL_MSG6);
 682     buf_prepend_uint32(&st->buffer,st->index);
 683     buf_prepend_uint32(&st->buffer,session_id);
 684 }
 685
 686 static bool_t generate_msg6(struct site *st)
 687 {
 688     create_msg6(st,st->new_transform,st->setup_session_id);
 689     st->retries=1; /* Peer will retransmit MSG5 if this packet gets lost */
 690     return True;
 691 }
 692
 693 static bool_t process_msg6(struct site *st, struct buffer_if *msg6,
 694                            const struct comm_addr *src)
 695 {
 696     struct msg0 m;
 697     cstring_t transform_err;
 698
 699     if (!unpick_msg0(st,msg6,&m)) return False;
 700
 701     if (st->new_transform->reverse(st->new_transform->st,
 702                                    msg6,&transform_err)) {
 703         /* There's a problem */
 704         slog(st,LOG_SEC,"process_msg6: transform: %s",transform_err);
 705         return False;
 706     }
 707     /* Buffer should now contain untransformed PING packet data */
 708     CHECK_AVAIL(msg6,4);
 709     if (buf_unprepend_uint32(msg6)!=LABEL_MSG6) {
 710         slog(st,LOG_SEC,"MSG6/PONG packet contained invalid data");
 711         return False;
 712     }
 713     /* Older versions of secnet used to write some config data here
 714      * which we ignore.  So we don't CHECK_EMPTY */
 715     return True;
 716 }
 717
 718 static bool_t decrypt_msg0(struct site *st, struct buffer_if *msg0)
 719 {
 720     cstring_t transform_err, newkey_err="n/a";
 721     struct msg0 m;
 722     uint32_t problem;
 723
 724     if (!unpick_msg0(st,msg0,&m)) return False;
 725
 726     /* Keep a copy so we can try decrypting it with multiple keys */
 727     buffer_copy(&st->scratch, msg0);
 728
 729     problem = st->current_transform->reverse(st->current_transform->st,
 730                                              msg0,&transform_err);
 731     if (!problem) return True;
 732
 733     if (problem==2) {
 734         slog(st,LOG_DROP,"transform: %s (merely skew)",transform_err);
 735         return False;
 736     }
 737
 738     if (st->state==SITE_SENTMSG5) {
 739         buffer_copy(msg0, &st->scratch);
 740         if (!st->new_transform->reverse(st->new_transform->st,
 741                                         msg0,&newkey_err)) {
 742             /* It looks like we didn't get the peer's MSG6 */
 743             /* This is like a cut-down enter_new_state(SITE_RUN) */
 744             slog(st,LOG_STATE,"will enter state RUN (MSG0 with new key)");
 745             BUF_FREE(&st->buffer);
 746             st->timeout=0;
 747             activate_new_key(st);
 748             return True; /* do process the data in this packet */
 749         }
 750     }
 751
 752     slog(st,LOG_SEC,"transform: %s (new: %s)",transform_err,newkey_err);
 753     initiate_key_setup(st,"incoming message would not decrypt");
 754     return False;
 755 }
 756
 757 static bool_t process_msg0(struct site *st, struct buffer_if *msg0,
 758                            const struct comm_addr *src)
 759 {
 760     uint32_t type;
 761
 762     if (!decrypt_msg0(st,msg0))
 763         return False;
 764
 765     CHECK_AVAIL(msg0,4);
 766     type=buf_unprepend_uint32(msg0);
 767     switch(type) {
 768     case LABEL_MSG7:
 769         /* We must forget about the current session. */
 770         delete_key(st,"request from peer",LOG_SEC);
 771         return True;
 772     case LABEL_MSG9:
 773         /* Deliver to netlink layer */
 774         st->netlink->deliver(st->netlink->st,msg0);
 775         transport_data_msgok(st,src);
 776         /* See whether we should start negotiating a new key */
 777         if (st->now > st->renegotiate_key_time)
 778             initiate_key_setup(st,"incoming packet in renegotiation window");
 779         return True;
 780     default:
 781         slog(st,LOG_SEC,"incoming encrypted message of type %08x "
 782              "(unknown)",type);
 783         break;
 784     }
 785     return False;
 786 }
 787
 788 static void dump_packet(struct site *st, struct buffer_if *buf,
 789                         const struct comm_addr *addr, bool_t incoming)
 790 {
 791     uint32_t dest=ntohl(*(uint32_t *)buf->start);
 792     uint32_t source=ntohl(*(uint32_t *)(buf->start+4));
 793     uint32_t msgtype=ntohl(*(uint32_t *)(buf->start+8));
 794
 795     if (st->log_events & LOG_DUMP)
 796         slilog(st->log,M_DEBUG,"%s: %s: %08x<-%08x: %08x:",
 797                st->tunname,incoming?"incoming":"outgoing",
 798                dest,source,msgtype);
 799 }
 800
 801 static uint32_t site_status(void *st)
 802 {
 803     return 0;
 804 }
 805
 806 static bool_t send_msg(struct site *st)
 807 {
 808     if (st->retries>0) {
 809         transport_xmit(st, &st->setup_peers, &st->buffer, True);
 810         st->timeout=st->now+st->setup_retry_interval;
 811         st->retries--;
 812         return True;
 813     } else {
 814         slog(st,LOG_SETUP_TIMEOUT,"timed out sending key setup packet "
 815             "(in state %s)",state_name(st->state));
 816         enter_state_wait(st);
 817         return False;
 818     }
 819 }
 820
 821 static void site_resolve_callback(void *sst, struct in_addr *address)
 822 {
 823     struct site *st=sst;
 824     struct comm_addr ca_buf, *ca_use;
 825
 826     if (st->state!=SITE_RESOLVE) {
 827         slog(st,LOG_UNEXPECTED,"site_resolve_callback called unexpectedly");
 828         return;
 829     }
 830     if (address) {
 831         FILLZERO(ca_buf);
 832         ca_buf.comm=st->comms[0];
 833         ca_buf.sin.sin_family=AF_INET;
 834         ca_buf.sin.sin_port=htons(st->remoteport);
 835         ca_buf.sin.sin_addr=*address;
 836         ca_use=&ca_buf;
 837     } else {
 838         slog(st,LOG_ERROR,"resolution of %s failed",st->address);
 839         ca_use=0;
 840     }
 841     if (transport_compute_setupinit_peers(st,ca_use)) {
 842         enter_new_state(st,SITE_SENTMSG1);
 843     } else {
 844         /* Can't figure out who to try to to talk to */
 845         slog(st,LOG_SETUP_INIT,"key exchange failed: cannot find peer address");
 846         enter_state_run(st);
 847     }
 848 }
 849
 850 static bool_t initiate_key_setup(struct site *st, cstring_t reason)
 851 {
 852     if (st->state!=SITE_RUN) return False;
 853     slog(st,LOG_SETUP_INIT,"initiating key exchange (%s)",reason);
 854     if (st->address) {
 855         slog(st,LOG_SETUP_INIT,"resolving peer address");
 856         return enter_state_resolve(st);
 857     } else if (transport_compute_setupinit_peers(st,0)) {
 858         return enter_new_state(st,SITE_SENTMSG1);
 859     }
 860     slog(st,LOG_SETUP_INIT,"key exchange failed: no address for peer");
 861     return False;
 862 }
 863
 864 static void activate_new_key(struct site *st)
 865 {
 866     struct transform_inst_if *t;
 867
 868     /* We have two transform instances, which we swap between active
 869        and setup */
 870     t=st->current_transform;
 871     st->current_transform=st->new_transform;
 872     st->new_transform=t;
 873
 874     t->delkey(t->st);
 875     st->timeout=0;
 876     st->current_valid=True;
 877     st->current_key_timeout=st->now+st->key_lifetime;
 878     st->renegotiate_key_time=st->now+st->key_renegotiate_time;
 879     transport_peers_copy(st,&st->peers,&st->setup_peers);
 880     st->remote_session_id=st->setup_session_id;
 881
 882     slog(st,LOG_ACTIVATE_KEY,"new key activated");
 883     enter_state_run(st);
 884 }
 885
 886 static void delete_key(struct site *st, cstring_t reason, uint32_t loglevel)
 887 {
 888     if (st->current_valid) {
 889         slog(st,loglevel,"session closed (%s)",reason);
 890
 891         st->current_valid=False;
 892         st->current_transform->delkey(st->current_transform->st);
 893         st->current_key_timeout=0;
 894         set_link_quality(st);
 895     }
 896 }
 897
 898 static void state_assert(struct site *st, bool_t ok)
 899 {
 900     if (!ok) fatal("site:state_assert");
 901 }
 902
 903 static void enter_state_stop(struct site *st)
 904 {
 905     st->state=SITE_STOP;
 906     st->timeout=0;
 907     delete_key(st,"entering state STOP",LOG_TIMEOUT_KEY);
 908     st->new_transform->delkey(st->new_transform->st);
 909 }
 910
 911 static void set_link_quality(struct site *st)
 912 {
 913     uint32_t quality;
 914     if (st->current_valid)
 915         quality=LINK_QUALITY_UP;
 916     else if (st->state==SITE_WAIT || st->state==SITE_STOP)
 917         quality=LINK_QUALITY_DOWN;
 918     else if (st->address)
 919         quality=LINK_QUALITY_DOWN_CURRENT_ADDRESS;
 920     else if (transport_peers_valid(&st->peers))
 921         quality=LINK_QUALITY_DOWN_STALE_ADDRESS;
 922     else
 923         quality=LINK_QUALITY_DOWN;
 924
 925     st->netlink->set_quality(st->netlink->st,quality);
 926 }
 927
 928 static void enter_state_run(struct site *st)
 929 {
 930     slog(st,LOG_STATE,"entering state RUN");
 931     st->state=SITE_RUN;
 932     st->timeout=0;
 933
 934     st->setup_session_id=0;
 935     transport_peers_clear(st,&st->setup_peers);
 936     memset(st->localN,0,NONCELEN);
 937     memset(st->remoteN,0,NONCELEN);
 938     st->new_transform->delkey(st->new_transform->st);
 939     memset(st->dhsecret,0,st->dh->len);
 940     memset(st->sharedsecret,0,st->transform->keylen);
 941     set_link_quality(st);
 942 }
 943
 944 static bool_t enter_state_resolve(struct site *st)
 945 {
 946     state_assert(st,st->state==SITE_RUN);
 947     slog(st,LOG_STATE,"entering state RESOLVE");
 948     st->state=SITE_RESOLVE;
 949     st->resolver->request(st->resolver->st,st->address,
 950                           site_resolve_callback,st);
 951     return True;
 952 }
 953
 954 static bool_t enter_new_state(struct site *st, uint32_t next)
 955 {
 956     bool_t (*gen)(struct site *st);
 957     int r;
 958
 959     slog(st,LOG_STATE,"entering state %s",state_name(next));
 960     switch(next) {
 961     case SITE_SENTMSG1:
 962         state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE);
 963         gen=generate_msg1;
 964         break;
 965     case SITE_SENTMSG2:
 966         state_assert(st,st->state==SITE_RUN || st->state==SITE_RESOLVE ||
 967                      st->state==SITE_SENTMSG1 || st->state==SITE_WAIT);
 968         gen=generate_msg2;
 969         break;
 970     case SITE_SENTMSG3:
 971         state_assert(st,st->state==SITE_SENTMSG1);
 972         BUF_FREE(&st->buffer);
 973         gen=generate_msg3;
 974         break;
 975     case SITE_SENTMSG4:
 976         state_assert(st,st->state==SITE_SENTMSG2);
 977         BUF_FREE(&st->buffer);
 978         gen=generate_msg4;
 979         break;
 980     case SITE_SENTMSG5:
 981         state_assert(st,st->state==SITE_SENTMSG3);
 982         BUF_FREE(&st->buffer);
 983         gen=generate_msg5;
 984         break;
 985     case SITE_RUN:
 986         state_assert(st,st->state==SITE_SENTMSG4);
 987         BUF_FREE(&st->buffer);
 988         gen=generate_msg6;
 989         break;
 990     default:
 991         gen=NULL;
 992         fatal("enter_new_state(%s): invalid new state",state_name(next));
 993         break;
 994     }
 995
 996     if (hacky_par_start_failnow()) return False;
 997
 998     r= gen(st) && send_msg(st);
 999
1000     hacky_par_end(&r,
1001                   st->setup_retries, st->setup_retry_interval,
1002                   send_msg, st);
1003
1004     if (r) {
1005         st->state=next;
1006         if (next==SITE_RUN) {
1007             BUF_FREE(&st->buffer); /* Never reused */
1008             st->timeout=0; /* Never retransmit */
1009             activate_new_key(st);
1010         }
1011         return True;
1012     }
1013     slog(st,LOG_ERROR,"error entering state %s",state_name(next));
1014     st->buffer.free=False; /* Unconditionally use the buffer; it may be
1015                               in either state, and enter_state_wait() will
1016                               do a BUF_FREE() */
1017     enter_state_wait(st);
1018     return False;
1019 }
1020
1021 /* msg7 tells our peer that we're about to forget our key */
1022 static bool_t send_msg7(struct site *st, cstring_t reason)
1023 {
1024     cstring_t transform_err;
1025
1026     if (st->current_valid && st->buffer.free
1027         && transport_peers_valid(&st->peers)) {
1028         BUF_ALLOC(&st->buffer,"site:MSG7");
1029         buffer_init(&st->buffer,st->transform->max_start_pad+(4*3));
1030         buf_append_uint32(&st->buffer,LABEL_MSG7);
1031         buf_append_string(&st->buffer,reason);
1032         st->current_transform->forwards(st->current_transform->st,
1033                                         &st->buffer, &transform_err);
1034         buf_prepend_uint32(&st->buffer,LABEL_MSG0);
1035         buf_prepend_uint32(&st->buffer,st->index);
1036         buf_prepend_uint32(&st->buffer,st->remote_session_id);
1037         transport_xmit(st,&st->peers,&st->buffer,True);
1038         BUF_FREE(&st->buffer);
1039         return True;
1040     }
1041     return False;
1042 }
1043
1044 /* We go into this state if our peer becomes uncommunicative. Similar to
1045    the "stop" state, we forget all session keys for a while, before
1046    re-entering the "run" state. */
1047 static void enter_state_wait(struct site *st)
1048 {
1049     slog(st,LOG_STATE,"entering state WAIT");
1050     st->timeout=st->now+st->wait_timeout;
1051     st->state=SITE_WAIT;
1052     set_link_quality(st);
1053     BUF_FREE(&st->buffer); /* will have had an outgoing packet in it */
1054     /* XXX Erase keys etc. */
1055 }
1056
1057 static inline void site_settimeout(uint64_t timeout, int *timeout_io)
1058 {
1059     if (timeout) {
1060         int64_t offset=timeout-*now;
1061         if (offset<0) offset=0;
1062         if (offset>INT_MAX) offset=INT_MAX;
1063         if (*timeout_io<0 || offset<*timeout_io)
1064             *timeout_io=offset;
1065     }
1066 }
1067
1068 static int site_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
1069                            int *timeout_io)
1070 {
1071     struct site *st=sst;
1072
1073     *nfds_io=0; /* We don't use any file descriptors */
1074     st->now=*now;
1075
1076     /* Work out when our next timeout is. The earlier of 'timeout' or
1077        'current_key_timeout'. A stored value of '0' indicates no timeout
1078        active. */
1079     site_settimeout(st->timeout, timeout_io);
1080     site_settimeout(st->current_key_timeout, timeout_io);
1081
1082     return 0; /* success */
1083 }
1084
1085 /* NB site_afterpoll will be called before site_beforepoll is ever called */
1086 static void site_afterpoll(void *sst, struct pollfd *fds, int nfds)
1087 {
1088     struct site *st=sst;
1089
1090     st->now=*now;
1091     if (st->timeout && *now>st->timeout) {
1092         st->timeout=0;
1093         if (st->state>=SITE_SENTMSG1 && st->state<=SITE_SENTMSG5) {
1094             if (!hacky_par_start_failnow())
1095                 send_msg(st);
1096         } else if (st->state==SITE_WAIT) {
1097             enter_state_run(st);
1098         } else {
1099             slog(st,LOG_ERROR,"site_afterpoll: unexpected timeout, state=%d",
1100                  st->state);
1101         }
1102     }
1103     if (st->current_key_timeout && *now>st->current_key_timeout) {
1104         delete_key(st,"maximum key life exceeded",LOG_TIMEOUT_KEY);
1105     }
1106 }
1107
1108 /* This function is called by the netlink device to deliver packets
1109    intended for the remote network. The packet is in "raw" wire
1110    format, but is guaranteed to be word-aligned. */
1111 static void site_outgoing(void *sst, struct buffer_if *buf)
1112 {
1113     struct site *st=sst;
1114     cstring_t transform_err;
1115
1116     if (st->state==SITE_STOP) {
1117         BUF_FREE(buf);
1118         return;
1119     }
1120
1121     /* In all other states we consider delivering the packet if we have
1122        a valid key and a valid address to send it to. */
1123     if (st->current_valid && transport_peers_valid(&st->peers)) {
1124         /* Transform it and send it */
1125         if (buf->size>0) {
1126             buf_prepend_uint32(buf,LABEL_MSG9);
1127             st->current_transform->forwards(st->current_transform->st,
1128                                             buf, &transform_err);
1129             buf_prepend_uint32(buf,LABEL_MSG0);
1130             buf_prepend_uint32(buf,st->index);
1131             buf_prepend_uint32(buf,st->remote_session_id);
1132             transport_xmit(st,&st->peers,buf,False);
1133         }
1134         BUF_FREE(buf);
1135         return;
1136     }
1137
1138     slog(st,LOG_DROP,"discarding outgoing packet of size %d",buf->size);
1139     BUF_FREE(buf);
1140     initiate_key_setup(st,"outgoing packet");
1141 }
1142
1143 /* This function is called by the communication device to deliver
1144    packets from our peers. */
1145 static bool_t site_incoming(void *sst, struct buffer_if *buf,
1146                             const struct comm_addr *source)
1147 {
1148     struct site *st=sst;
1149
1150     if (buf->size < 12) return False;
1151
1152     uint32_t dest=ntohl(*(uint32_t *)buf->start);
1153
1154     if (dest==0) {
1155         /* It could be for any site - it should have LABEL_MSG1 and
1156            might have our name and our peer's name in it */
1157         if (buf->size<(st->setupsiglen+8+NONCELEN)) return False;
1158         if (memcmp(buf->start+8,st->setupsig,st->setupsiglen)==0) {
1159             /* It's addressed to us. Decide what to do about it. */
1160             dump_packet(st,buf,source,True);
1161             if (st->state==SITE_RUN || st->state==SITE_RESOLVE ||
1162                 st->state==SITE_WAIT) {
1163                 /* We should definitely process it */
1164                 if (process_msg1(st,buf,source)) {
1165                     slog(st,LOG_SETUP_INIT,"key setup initiated by peer");
1166                     enter_new_state(st,SITE_SENTMSG2);
1167                 } else {
1168                     slog(st,LOG_ERROR,"failed to process incoming msg1");
1169                 }
1170                 BUF_FREE(buf);
1171                 return True;
1172             } else if (st->state==SITE_SENTMSG1) {
1173                 /* We've just sent a message 1! They may have crossed on
1174                    the wire. If we have priority then we ignore the
1175                    incoming one, otherwise we process it as usual. */
1176                 if (st->setup_priority) {
1177                     BUF_FREE(buf);
1178                     slog(st,LOG_DUMP,"crossed msg1s; we are higher "
1179                          "priority => ignore incoming msg1");
1180                     return True;
1181                 } else {
1182                     slog(st,LOG_DUMP,"crossed msg1s; we are lower "
1183                          "priority => use incoming msg1");
1184                     if (process_msg1(st,buf,source)) {
1185                         BUF_FREE(&st->buffer); /* Free our old message 1 */
1186                         enter_new_state(st,SITE_SENTMSG2);
1187                     } else {
1188                         slog(st,LOG_ERROR,"failed to process an incoming "
1189                              "crossed msg1 (we have low priority)");
1190                     }
1191                     BUF_FREE(buf);
1192                     return True;
1193                 }
1194             }
1195             /* The message 1 was received at an unexpected stage of the
1196                key setup. XXX POLICY - what do we do? */
1197             slog(st,LOG_UNEXPECTED,"unexpected incoming message 1");
1198             BUF_FREE(buf);
1199             return True;
1200         }
1201         return False; /* Not for us. */
1202     }
1203     if (dest==st->index) {
1204         /* Explicitly addressed to us */
1205         uint32_t msgtype=ntohl(get_uint32(buf->start+8));
1206         if (msgtype!=LABEL_MSG0) dump_packet(st,buf,source,True);
1207         switch (msgtype) {
1208         case 0: /* NAK */
1209             /* If the source is our current peer then initiate a key setup,
1210                because our peer's forgotten the key */
1211             if (get_uint32(buf->start+4)==st->remote_session_id) {
1212                 initiate_key_setup(st,"received a NAK");
1213             } else {
1214                 slog(st,LOG_SEC,"bad incoming NAK");
1215             }
1216             break;
1217         case LABEL_MSG0:
1218             process_msg0(st,buf,source);
1219             break;
1220         case LABEL_MSG1:
1221             /* Setup packet: should not have been explicitly addressed
1222                to us */
1223             slog(st,LOG_SEC,"incoming explicitly addressed msg1");
1224             break;
1225         case LABEL_MSG2:
1226             /* Setup packet: expected only in state SENTMSG1 */
1227             if (st->state!=SITE_SENTMSG1) {
1228                 slog(st,LOG_UNEXPECTED,"unexpected MSG2");
1229             } else if (process_msg2(st,buf,source)) {
1230                 transport_setup_msgok(st,source);
1231                 enter_new_state(st,SITE_SENTMSG3);
1232             } else {
1233                 slog(st,LOG_SEC,"invalid MSG2");
1234             }
1235             break;
1236         case LABEL_MSG3:
1237             /* Setup packet: expected only in state SENTMSG2 */
1238             if (st->state!=SITE_SENTMSG2) {
1239                 slog(st,LOG_UNEXPECTED,"unexpected MSG3");
1240             } else if (process_msg3(st,buf,source)) {
1241                 transport_setup_msgok(st,source);
1242                 enter_new_state(st,SITE_SENTMSG4);
1243             } else {
1244                 slog(st,LOG_SEC,"invalid MSG3");
1245             }
1246             break;
1247         case LABEL_MSG4:
1248             /* Setup packet: expected only in state SENTMSG3 */
1249             if (st->state!=SITE_SENTMSG3) {
1250                 slog(st,LOG_UNEXPECTED,"unexpected MSG4");
1251             } else if (process_msg4(st,buf,source)) {
1252                 transport_setup_msgok(st,source);
1253                 enter_new_state(st,SITE_SENTMSG5);
1254             } else {
1255                 slog(st,LOG_SEC,"invalid MSG4");
1256             }
1257             break;
1258         case LABEL_MSG5:
1259             /* Setup packet: expected only in state SENTMSG4 */
1260             /* (may turn up in state RUN if our return MSG6 was lost
1261                and the new key has already been activated. In that
1262                case we discard it. The peer will realise that we
1263                are using the new key when they see our data packets.
1264                Until then the peer's data packets to us get discarded. */
1265             if (st->state==SITE_SENTMSG4) {
1266                 if (process_msg5(st,buf,source,st->new_transform)) {
1267                     transport_setup_msgok(st,source);
1268                     enter_new_state(st,SITE_RUN);
1269                 } else {
1270                     slog(st,LOG_SEC,"invalid MSG5");
1271                 }
1272             } else if (st->state==SITE_RUN) {
1273                 if (process_msg5(st,buf,source,st->current_transform)) {
1274                     slog(st,LOG_DROP,"got MSG5, retransmitting MSG6");
1275                     transport_setup_msgok(st,source);
1276                     create_msg6(st,st->current_transform,st->remote_session_id);
1277                     transport_xmit(st,&st->peers,&st->buffer,True);
1278                     BUF_FREE(&st->buffer);
1279                 } else {
1280                     slog(st,LOG_SEC,"invalid MSG5 (in state RUN)");
1281                 }
1282             } else {
1283                 slog(st,LOG_UNEXPECTED,"unexpected MSG5");
1284             }
1285             break;
1286         case LABEL_MSG6:
1287             /* Setup packet: expected only in state SENTMSG5 */
1288             if (st->state!=SITE_SENTMSG5) {
1289                 slog(st,LOG_UNEXPECTED,"unexpected MSG6");
1290             } else if (process_msg6(st,buf,source)) {
1291                 BUF_FREE(&st->buffer); /* Free message 5 */
1292                 transport_setup_msgok(st,source);
1293                 activate_new_key(st);
1294             } else {
1295                 slog(st,LOG_SEC,"invalid MSG6");
1296             }
1297             break;
1298         default:
1299             slog(st,LOG_SEC,"received message of unknown type 0x%08x",
1300                  msgtype);
1301             break;
1302         }
1303         BUF_FREE(buf);
1304         return True;
1305     }
1306
1307     return False;
1308 }
1309
1310 static void site_control(void *vst, bool_t run)
1311 {
1312     struct site *st=vst;
1313     if (run) enter_state_run(st);
1314     else enter_state_stop(st);
1315 }
1316
1317 static void site_phase_hook(void *sst, uint32_t newphase)
1318 {
1319     struct site *st=sst;
1320
1321     /* The program is shutting down; tell our peer */
1322     send_msg7(st,"shutting down");
1323 }
1324
1325 static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
1326                           list_t *args)
1327 {
1328     static uint32_t index_sequence;
1329     struct site *st;
1330     item_t *item;
1331     dict_t *dict;
1332     int i;
1333
1334     st=safe_malloc(sizeof(*st),"site_apply");
1335
1336     st->cl.description="site";
1337     st->cl.type=CL_SITE;
1338     st->cl.apply=NULL;
1339     st->cl.interface=&st->ops;
1340     st->ops.st=st;
1341     st->ops.control=site_control;
1342     st->ops.status=site_status;
1343
1344     /* First parameter must be a dict */
1345     item=list_elem(args,0);
1346     if (!item || item->type!=t_dict)
1347         cfgfatal(loc,"site","parameter must be a dictionary\n");
1348
1349     dict=item->data.dict;
1350     st->localname=dict_read_string(dict, "local-name", True, "site", loc);
1351     st->remotename=dict_read_string(dict, "name", True, "site", loc);
1352
1353     st->peer_mobile=dict_read_bool(dict,"mobile",False,"site",loc,False);
1354     bool_t local_mobile=
1355         dict_read_bool(dict,"local-mobile",False,"site",loc,False);
1356
1357     /* Sanity check (which also allows the 'sites' file to include
1358        site() closures for all sites including our own): refuse to
1359        talk to ourselves */
1360     if (strcmp(st->localname,st->remotename)==0) {
1361         Message(M_DEBUG,"site %s: local-name==name -> ignoring this site\n",
1362                 st->localname);
1363         if (st->peer_mobile != local_mobile)
1364             cfgfatal(loc,"site","site %s's peer-mobile=%d"
1365                     " but our local-mobile=%d\n",
1366                     st->localname, st->peer_mobile, local_mobile);
1367         free(st);
1368         return NULL;
1369     }
1370     if (st->peer_mobile && local_mobile) {
1371         Message(M_WARNING,"site %s: site is mobile but so are we"
1372                 " -> ignoring this site\n", st->remotename);
1373         free(st);
1374         return NULL;
1375     }
1376
1377     assert(index_sequence < 0xffffffffUL);
1378     st->index = ++index_sequence;
1379     st->netlink=find_cl_if(dict,"link",CL_NETLINK,True,"site",loc);
1380
1381     list_t *comms_cfg=dict_lookup(dict,"comm");
1382     if (!comms_cfg) cfgfatal(loc,"site","closure list \"comm\" not found\n");
1383     st->ncomms=list_length(comms_cfg);
1384     st->comms=safe_malloc_ary(sizeof(*st->comms),st->ncomms,"comms");
1385     assert(st->ncomms);
1386     for (i=0; i<st->ncomms; i++) {
1387         item_t *item=list_elem(comms_cfg,i);
1388         if (item->type!=t_closure)
1389             cfgfatal(loc,"site","comm is not a closure\n");
1390         closure_t *cl=item->data.closure;
1391         if (cl->type!=CL_COMM) cfgfatal(loc,"site","comm closure wrong type\n");
1392         st->comms[i]=cl->interface;
1393     }
1394
1395     st->resolver=find_cl_if(dict,"resolver",CL_RESOLVER,True,"site",loc);
1396     st->log=find_cl_if(dict,"log",CL_LOG,True,"site",loc);
1397     st->random=find_cl_if(dict,"random",CL_RANDOMSRC,True,"site",loc);
1398
1399     st->privkey=find_cl_if(dict,"local-key",CL_RSAPRIVKEY,True,"site",loc);
1400     st->address=dict_read_string(dict, "address", False, "site", loc);
1401     if (st->address)
1402         st->remoteport=dict_read_number(dict,"port",True,"site",loc,0);
1403     else st->remoteport=0;
1404     st->pubkey=find_cl_if(dict,"key",CL_RSAPUBKEY,True,"site",loc);
1405
1406     st->transform=
1407         find_cl_if(dict,"transform",CL_TRANSFORM,True,"site",loc);
1408
1409     st->dh=find_cl_if(dict,"dh",CL_DH,True,"site",loc);
1410     st->hash=find_cl_if(dict,"hash",CL_HASH,True,"site",loc);
1411
1412 #define DEFAULT(D) (st->peer_mobile || local_mobile     \
1413                     ? DEFAULT_MOBILE_##D : DEFAULT_##D)
1414 #define CFG_NUMBER(k,D) dict_read_number(dict,(k),False,"site",loc,DEFAULT(D));
1415
1416     st->key_lifetime=         CFG_NUMBER("key-lifetime",  KEY_LIFETIME);
1417     st->setup_retries=        CFG_NUMBER("setup-retries", SETUP_RETRIES);
1418     st->setup_retry_interval= CFG_NUMBER("setup-timeout", SETUP_RETRY_INTERVAL);
1419     st->wait_timeout=         CFG_NUMBER("wait-time",     WAIT_TIME);
1420
1421     st->mobile_peer_expiry= dict_read_number(
1422        dict,"mobile-peer-expiry",False,"site",loc,DEFAULT_MOBILE_PEER_EXPIRY);
1423
1424     st->transport_peers_max= !st->peer_mobile ? 1 : dict_read_number(
1425         dict,"mobile-peers-max",False,"site",loc,DEFAULT_MOBILE_PEERS_MAX);
1426     if (st->transport_peers_max<1 ||
1427         st->transport_peers_max>=MAX_MOBILE_PEERS_MAX) {
1428         cfgfatal(loc,"site","mobile-peers-max must be in range 1.."
1429                  STRING(MAX_MOBILE_PEERS_MAX) "\n");
1430     }
1431
1432     if (st->key_lifetime < DEFAULT(KEY_RENEGOTIATE_GAP)*2)
1433         st->key_renegotiate_time=st->key_lifetime/2;
1434     else
1435         st->key_renegotiate_time=st->key_lifetime-DEFAULT(KEY_RENEGOTIATE_GAP);
1436     st->key_renegotiate_time=dict_read_number(
1437         dict,"renegotiate-time",False,"site",loc,st->key_renegotiate_time);
1438     if (st->key_renegotiate_time > st->key_lifetime) {
1439         cfgfatal(loc,"site",
1440                  "renegotiate-time must be less than key-lifetime\n");
1441     }
1442
1443     st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
1444                                        log_event_table,"site");
1445
1446     st->tunname=safe_malloc(strlen(st->localname)+strlen(st->remotename)+5,
1447                             "site_apply");
1448     sprintf(st->tunname,"%s<->%s",st->localname,st->remotename);
1449
1450     /* The information we expect to see in incoming messages of type 1 */
1451     /* fixme: lots of unchecked overflows here, but the results are only
1452        corrupted packets rather than undefined behaviour */
1453     st->setupsiglen=strlen(st->remotename)+strlen(st->localname)+8;
1454     st->setupsig=safe_malloc(st->setupsiglen,"site_apply");
1455     put_uint32(st->setupsig+0,LABEL_MSG1);
1456     put_uint16(st->setupsig+4,strlen(st->remotename));
1457     memcpy(&st->setupsig[6],st->remotename,strlen(st->remotename));
1458     put_uint16(st->setupsig+(6+strlen(st->remotename)),strlen(st->localname));
1459     memcpy(&st->setupsig[8+strlen(st->remotename)],st->localname,
1460            strlen(st->localname));
1461     st->setup_priority=(strcmp(st->localname,st->remotename)>0);
1462
1463     buffer_new(&st->buffer,SETUP_BUFFER_LEN);
1464
1465     buffer_new(&st->scratch,0);
1466     BUF_ALLOC(&st->scratch,"site:scratch");
1467
1468     /* We are interested in poll(), but only for timeouts. We don't have
1469        any fds of our own. */
1470     register_for_poll(st, site_beforepoll, site_afterpoll, 0, "site");
1471     st->timeout=0;
1472
1473     st->current_valid=False;
1474     st->current_key_timeout=0;
1475     transport_peers_clear(st,&st->peers);
1476     transport_peers_clear(st,&st->setup_peers);
1477     /* XXX mlock these */
1478     st->dhsecret=safe_malloc(st->dh->len,"site:dhsecret");
1479     st->sharedsecret=safe_malloc(st->transform->keylen,"site:sharedsecret");
1480
1481     /* We need to compute some properties of our comms */
1482 #define COMPUTE_WORST(pad)                      \
1483     int worst_##pad=0;                          \
1484     for (i=0; i<st->ncomms; i++) {              \
1485         int thispad=st->comms[i]->pad;          \
1486         if (thispad > worst_##pad)              \
1487             worst_##pad=thispad;                \
1488     }
1489     COMPUTE_WORST(min_start_pad)
1490     COMPUTE_WORST(min_end_pad)
1491
1492     /* We need to register the remote networks with the netlink device */
1493     st->netlink->reg(st->netlink->st, site_outgoing, st,
1494                      st->transform->max_start_pad+(4*4)+
1495                      worst_min_start_pad,
1496                      st->transform->max_end_pad+worst_min_end_pad);
1497
1498     for (i=0; i<st->ncomms; i++)
1499         st->comms[i]->request_notify(st->comms[i]->st, st, site_incoming);
1500
1501     st->current_transform=st->transform->create(st->transform->st);
1502     st->new_transform=st->transform->create(st->transform->st);
1503
1504     enter_state_stop(st);
1505
1506     add_hook(PHASE_SHUTDOWN,site_phase_hook,st);
1507
1508     return new_closure(&st->cl);
1509 }
1510
1511 void site_module(dict_t *dict)
1512 {
1513     add_closure(dict,"site",site_apply);
1514 }
1515
1516
1517 /***** TRANSPORT PEERS definitions *****/
1518
1519 static void transport_peers_debug(struct site *st, transport_peers *dst,
1520                                   const char *didwhat,
1521                                   int nargs, const struct comm_addr *args,
1522                                   size_t stride) {
1523     int i;
1524     char *argp;
1525
1526     if (!(st->log_events & LOG_PEER_ADDRS))
1527         return; /* an optimisation */
1528
1529     slog(st, LOG_PEER_ADDRS, "peers (%s) %s nargs=%d => npeers=%d",
1530          (dst==&st->peers ? "data" :
1531           dst==&st->setup_peers ? "setup" : "UNKNOWN"),
1532          didwhat, nargs, dst->npeers);
1533
1534     for (i=0, argp=(void*)args;
1535          i<nargs;
1536          i++, (argp+=stride?stride:sizeof(*args))) {
1537         const struct comm_addr *ca=(void*)argp;
1538         slog(st, LOG_PEER_ADDRS, " args: addrs[%d]=%s",
1539              i, ca->comm->addr_to_string(ca->comm->st,ca));
1540     }
1541     for (i=0; i<dst->npeers; i++) {
1542         struct timeval diff;
1543         timersub(tv_now,&dst->peers[i].last,&diff);
1544         const struct comm_addr *ca=&dst->peers[i].addr;
1545         slog(st, LOG_PEER_ADDRS, " peers: addrs[%d]=%s T-%ld.%06ld",
1546              i, ca->comm->addr_to_string(ca->comm->st,ca),
1547              (unsigned long)diff.tv_sec, (unsigned long)diff.tv_usec);
1548     }
1549 }
1550
1551 static int transport_peer_compar(const void *av, const void *bv) {
1552     const transport_peer *a=av;
1553     const transport_peer *b=bv;
1554     /* put most recent first in the array */
1555     if (timercmp(&a->last, &b->last, <)) return +1;
1556     if (timercmp(&a->last, &b->last, >)) return -11;
1557     return 0;
1558 }
1559
1560 static void transport_peers_expire(struct site *st, transport_peers *peers) {
1561     /* peers must be sorted first */
1562     int previous_peers=peers->npeers;
1563     struct timeval oldest;
1564     oldest.tv_sec  = tv_now->tv_sec - st->mobile_peer_expiry;
1565     oldest.tv_usec = tv_now->tv_usec;
1566     while (peers->npeers>1 &&
1567            timercmp(&peers->peers[peers->npeers-1].last, &oldest, <))
1568         peers->npeers--;
1569     if (peers->npeers != previous_peers)
1570         transport_peers_debug(st,peers,"expire", 0,0,0);
1571 }
1572
1573 static void transport_record_peer(struct site *st, transport_peers *peers,
1574                                   const struct comm_addr *addr, const char *m) {
1575     int slot, changed=0;
1576
1577     for (slot=0; slot<peers->npeers; slot++)
1578         if (!memcmp(&peers->peers[slot].addr, addr, sizeof(*addr)))
1579             goto found;
1580
1581     changed=1;
1582     if (peers->npeers==st->transport_peers_max)
1583         slot=st->transport_peers_max;
1584     else
1585         slot=peers->npeers++;
1586
1587  found:
1588     peers->peers[slot].addr=*addr;
1589     peers->peers[slot].last=*tv_now;
1590
1591     if (peers->npeers>1)
1592         qsort(peers->peers, peers->npeers,
1593               sizeof(*peers->peers), transport_peer_compar);
1594
1595     if (changed || peers->npeers!=1)
1596         transport_peers_debug(st,peers,m, 1,addr,0);
1597     transport_peers_expire(st, peers);
1598 }
1599
1600 static bool_t transport_compute_setupinit_peers(struct site *st,
1601         const struct comm_addr *configured_addr /* 0 if none or not found */) {
1602
1603     if (!configured_addr && !transport_peers_valid(&st->peers))
1604         return False;
1605
1606     slog(st,LOG_SETUP_INIT,
1607          (!configured_addr ? "using only %d old peer address(es)"
1608           : "using configured address, and/or perhaps %d old peer address(es)"),
1609          st->peers);
1610
1611     /* Non-mobile peers havve st->peers.npeers==0 or ==1, since they
1612      * have transport_peers_max==1.  The effect is that this code
1613      * always uses the configured address if supplied, or otherwise
1614      * the existing data peer if one exists; this is as desired. */
1615
1616     transport_peers_copy(st,&st->setup_peers,&st->peers);
1617
1618     if (configured_addr)
1619         transport_record_peer(st,&st->setup_peers,configured_addr,"setupinit");
1620
1621     assert(transport_peers_valid(&st->setup_peers));
1622     return True;
1623 }
1624
1625 static void transport_setup_msgok(struct site *st, const struct comm_addr *a) {
1626     if (st->peer_mobile)
1627         transport_record_peer(st,&st->setup_peers,a,"setupmsg");
1628 }
1629 static void transport_data_msgok(struct site *st, const struct comm_addr *a) {
1630     if (st->peer_mobile)
1631         transport_record_peer(st,&st->peers,a,"datamsg");
1632 }
1633
1634 static int transport_peers_valid(transport_peers *peers) {
1635     return peers->npeers;
1636 }
1637 static void transport_peers_clear(struct site *st, transport_peers *peers) {
1638     peers->npeers= 0;
1639     transport_peers_debug(st,peers,"clear",0,0,0);
1640 }
1641 static void transport_peers_copy(struct site *st, transport_peers *dst,
1642                                  const transport_peers *src) {
1643     dst->npeers=src->npeers;
1644     memcpy(dst->peers, src->peers, sizeof(*dst->peers) * dst->npeers);
1645     transport_peers_debug(st,dst,"copy",
1646                           src->npeers, &src->peers->addr, sizeof(*src->peers));
1647 }
1648
1649 void transport_xmit(struct site *st, transport_peers *peers,
1650                     struct buffer_if *buf, bool_t candebug) {
1651     int slot;
1652     transport_peers_expire(st, peers);
1653     for (slot=0; slot<peers->npeers; slot++) {
1654         transport_peer *peer=&peers->peers[slot];
1655         if (candebug)
1656             dump_packet(st, buf, &peer->addr, False);
1657         peer->addr.comm->sendmsg(peer->addr.comm->st, buf, &peer->addr);
1658     }
1659 }
1660
1661 /***** END of transport peers declarations *****/