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