serval-dna/overlay_mdp.c

/*
Serval DNA MDP overlay network
Copyright (C) 2012-2013 Serval Project Inc.
Copyright (C) 2010-2012 Paul Gardner-Stephen
 
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/

/*
  Portions Copyright (C) 2013 Petter Reinholdtsen
  Some rights reserved

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in
     the documentation and/or other materials provided with the
     distribution.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.
*/

#include <dirent.h>
#include <sys/types.h>
#include <sys/stat.h>
#include "serval.h"
#include "conf.h"
#include "str.h"
#include "strbuf.h"
#include "strbuf_helpers.h"
#include "overlay_buffer.h"
#include "overlay_address.h"
#include "overlay_interface.h"
#include "overlay_packet.h"
#include "mdp_client.h"
#include "crypto.h"
#include "keyring.h"
#include "socket.h"
#include "server.h"
#include "route_link.h"

uint16_t mdp_loopback_port;

static void overlay_mdp_poll(struct sched_ent *alarm);
static void mdp_poll2(struct sched_ent *alarm);

static struct profile_total mdp_stats = { .name="overlay_mdp_poll" };
static struct sched_ent mdp_sock = {
  .function = overlay_mdp_poll,
  .stats = &mdp_stats,
  .poll={.fd = -1},
};

static struct profile_total mdp_stats2 = { .name="mdp_poll2" };
static struct sched_ent mdp_sock2 = {
  .function = mdp_poll2,
  .stats = &mdp_stats2,
  .poll={.fd = -1},
};
static struct sched_ent mdp_sock2_inet = {
  .function = mdp_poll2,
  .stats = &mdp_stats2,
  .poll={.fd = -1},
};

struct mdp_binding{
  struct mdp_binding *_next;
  struct subscriber *subscriber;
  mdp_port_t port;
  uint8_t version;
  uint8_t flags;
  struct socket_address client;
  time_ms_t binding_time;
};

static struct mdp_binding *mdp_bindings=NULL;
static mdp_port_t next_port_binding=256;
static struct subscriber internal[0];

static int overlay_saw_mdp_frame(
  struct internal_mdp_header *header, 
  struct overlay_buffer *payload);

static int mdp_send2(struct __sourceloc, const struct socket_address *client, const struct mdp_header *header, 
  const uint8_t *payload, size_t payload_len);

static uint8_t has_dead_clients=0;
static int mark_dead_client(const struct socket_address *client)
{
  struct mdp_binding *binding = mdp_bindings;
  while(binding){
    if (cmp_sockaddr(&binding->client, client)==0){
      binding->port = 0;
      has_dead_clients = 1;
    }
    binding = binding->_next;
  }
  return 0;
}

static int free_dead_clients(){
  if (!has_dead_clients)
    return 0;
  //TODO send dummy frame?
  struct mdp_binding **binding = &mdp_bindings;
  while(*binding){
    struct mdp_binding *b = (*binding);
    if (b->port==0){
      (*binding) = b->_next;
      free(b);
    }else{
      binding = &b->_next;
    }
  }
  has_dead_clients=1;
  return 0;
}

static int mdp_reply2(struct __sourceloc __whence, const struct socket_address *client, const struct mdp_header *header,
  int flags, const uint8_t *payload, size_t payload_len)
{
  struct mdp_header response_header;
  bcopy(header, &response_header, sizeof(response_header));
  response_header.flags = flags;
  return mdp_send2(__WHENCE__, client, &response_header, payload, payload_len);
}

#define mdp_reply_error(A,B)  mdp_reply2(__WHENCE__,(A),(B),MDP_FLAG_ERROR,NULL,0)
#define mdp_reply_ok(A,B)  mdp_reply2(__WHENCE__,(A),(B),MDP_FLAG_CLOSE,NULL,0)

/* Delete all UNIX socket files in instance directory. */
void overlay_mdp_clean_socket_files()
{
  char path[PATH_MAX];
  if (FORMF_SERVAL_RUN_PATH(path, NULL)) {
    DIR *dir;
    struct dirent *dp;
    if ((dir = opendir(path)) == NULL) {
      WARNF_perror("opendir(%s)", alloca_str_toprint(path));
      return;
    }
    while ((dp = readdir(dir)) != NULL) {
      path[0] = '\0';
      if (!FORMF_SERVAL_RUN_PATH(path, "%s", dp->d_name))
	continue;
      struct stat st;
      if (lstat(path, &st)) {
	WARNF_perror("stat(%s)", alloca_str_toprint(path));
	continue;
      }
      if (S_ISSOCK(st.st_mode))
	unlink(path);
    }
    closedir(dir);
  }
  mdp_loopback_port=0;
}

static void overlay_mdp_fill_legacy(
  const struct internal_mdp_header *header,
  struct overlay_buffer *payload,
  overlay_mdp_frame *mdp)
{
  mdp->out.src.sid = header->source->sid;
  mdp->out.src.port = header->source_port;
  mdp->out.dst.sid = header->destination?header->destination->sid:SID_BROADCAST;
  mdp->out.dst.port = header->destination_port;
  mdp->out.payload_length = ob_remaining(payload);
  ob_get_bytes(payload, mdp->out.payload, mdp->out.payload_length);
  mdp->out.ttl = header->ttl;
  mdp->out.queue = header->qos;
  mdp->packetTypeAndFlags=MDP_TX;
  if (header->crypt_flags & MDP_FLAG_NO_CRYPT)
    mdp->packetTypeAndFlags|=MDP_NOCRYPT;
  if (header->crypt_flags & MDP_FLAG_NO_SIGN)
    mdp->packetTypeAndFlags|=MDP_NOSIGN;
}

static int mdp_bind_socket(const char *name)
{
  struct socket_address addr;
  int sock;
  
  if (make_local_sockaddr(&addr, "%s", name) == -1)
    return -1;
  if ((sock = esocket(addr.addr.sa_family, SOCK_DGRAM, 0)) == -1)
    return -1;
  if (socket_set_reuseaddr(sock, 1) == -1)
    WARN("Could not set socket to reuse addresses");
  if (socket_bind(sock, &addr) == -1) {
    close(sock);
    return -1;
  }
  socket_set_rcvbufsize(sock, 64 * 1024);
  
  INFOF("Socket %s: fd=%d %s", name, sock, alloca_socket_address(&addr));
  return sock;
}

int overlay_mdp_setup_sockets()
{
  /* Delete stale socket files from instance directory. */
  overlay_mdp_clean_socket_files();

  if (mdp_sock.poll.fd == -1) {
    mdp_sock.poll.fd = mdp_bind_socket("mdp.socket");
    if (mdp_sock.poll.fd == -1)
      return -1;
    mdp_sock.poll.events = POLLIN;
    watch(&mdp_sock);
  }
  
  if (mdp_sock2.poll.fd == -1) {
    mdp_sock2.poll.fd = mdp_bind_socket("mdp.2.socket");
    if (mdp_sock2.poll.fd == -1)
      return -1;
    mdp_sock2.poll.events = POLLIN;
    watch(&mdp_sock2);
  }
  
  if (mdp_sock2_inet.poll.fd == -1 && config.mdp.enable_inet) {
    int fd = esocket(PF_INET, SOCK_DGRAM, 0);
    if (fd>=0){
      // try to find a free UDP port somewhere between 4210 & 4260
      uint16_t start_port = 4210;
      
      struct socket_address addr;
      addr.addrlen = sizeof(addr.inet);
      addr.inet.sin_family = AF_INET;
      addr.inet.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
      
      const char *port_str = getenv("SERVAL_MDP_INET_PORT");
      if (port_str)
	start_port = atoi(port_str);
	
      uint16_t end_port = start_port+50;
      uint16_t port;
      
      for (port = start_port; port<=end_port; port++){
	addr.inet.sin_port = htons(port);
	if (bind(fd, &addr.addr, addr.addrlen)!=-1){
	  mdp_sock2_inet.poll.fd = fd;
	  fd = -1;
	  mdp_sock2_inet.poll.events = POLLIN;
	  watch(&mdp_sock2_inet);
	  mdp_loopback_port = port;
	  
	  INFOF("Socket mdp.2.inet: fd=%d %s", fd, alloca_socket_address(&addr));
	  
	  break;
	}
	  
	if (errno != EADDRINUSE)
	  WHY_perror("bind");
      }
      
      if (fd!=-1){
	close(fd);
	return -1;
      }
    }
  }
  return 0;
}

#define MDP_MAX_SOCKET_NAME_LEN 110


static int overlay_mdp_reply(int sock, struct socket_address *client,
			  overlay_mdp_frame *mdpreply)
{
  if (!client) return WHY("No reply address");

  ssize_t replylen = overlay_mdp_relevant_bytes(mdpreply);
  if (replylen<0) return WHY("Invalid MDP frame (could not compute length)");

  ssize_t r=sendto(sock,(char *)mdpreply,replylen,0, &client->addr, client->addrlen);
  if (r == -1){
    WHYF_perror("sendto(fd=%d,len=%zu,addr=%s)", sock, (size_t)replylen, alloca_socket_address(client));
    if (errno == ENOENT){
      /* far-end of socket has died, so drop binding */
      INFOF("Closing dead MDP client '%s'", alloca_socket_address(client));
      mark_dead_client(client);
    }
    return -1;
  }
  if (r != replylen)
    return WHYF("sendto() sent %zu bytes of MDP reply (%zu) to %s", (size_t)r, (size_t)replylen, alloca_socket_address(client));
  return 0;  
}

static int overlay_mdp_reply_error(int sock, struct socket_address *client,
			    int error_number, char *message)
{
  overlay_mdp_frame mdpreply;

  mdpreply.packetTypeAndFlags=MDP_ERROR;
  mdpreply.error.error=error_number;
  if (error_number)
    WHYF("MDP error, code #%d %s",error_number, message);
  
  if (error_number==0||message)
    snprintf(&mdpreply.error.message[0],128,"%s",message?message:"Success");
  else{
    snprintf(&mdpreply.error.message[0],128,"Error code #%d",error_number);
  }
  mdpreply.error.message[127]=0;

  return overlay_mdp_reply(sock, client, &mdpreply);
}

static int overlay_mdp_reply_ok(int sock, struct socket_address *client, 
			 char *message)
{
  return overlay_mdp_reply_error(sock, client, 0, message);
}

static int overlay_mdp_process_bind_request(struct subscriber *subscriber, mdp_port_t port,
				     int flags, struct socket_address *client)
{
  DEBUGF(mdprequests, "Bind request %s:%"PRImdp_port_t, subscriber ? alloca_tohex_sid_t(subscriber->sid) : "NULL", port);
  
  if (port == 0){
    return WHYF("Port %d cannot be bound", port);
  }
 
  /* See if binding already exists */
  struct mdp_binding *b = mdp_bindings;
  while(b){
    /* Look for duplicate bindings */
    if (b->port == port && b->subscriber == subscriber) {
      if (cmp_sockaddr(&b->client, client)==0) {
	// this client already owns this port binding?
	INFO("Identical binding exists");
	return 0;
      }else if(flags&MDP_FORCE){
	// steal the port binding
	break;
      }else if((flags & MDP_FLAG_REUSE) && (b->flags & MDP_FLAG_REUSE)){
	// allow mutliple bindings
      }else{
	return WHY("Port already in use");
      }
    }
    b=b->_next;
  }

  /* Okay, so no binding exists.  Make one, and return success.
     If we have too many bindings, we should return an error.
     XXX - We don't find out when the socket responsible for a binding has died,
     so stale bindings can hang around.  We really need a solution to this, e.g., 
     probing the sockets periodically (by sending an MDP NOOP frame perhaps?) and
     destroying any socket that reports an error.
  */
  if (!b){
    b = emalloc_zero(sizeof(struct mdp_binding));
    b->_next = mdp_bindings;
    mdp_bindings = b;
  }
  /* Okay, record binding and report success */
  b->port=port;
  b->subscriber=subscriber;
  b->version=0;
  b->flags = flags & MDP_FLAG_REUSE;
  b->client.addrlen = client->addrlen;
  memcpy(&b->client.addr, &client->addr, client->addrlen);
  b->binding_time=gettime_ms();
  return 0;
}

static void overlay_mdp_decode_header(struct internal_mdp_header *header, struct overlay_buffer *buff)
{
  /* extract MDP port numbers */
  mdp_port_t port = ob_get_packed_ui32(buff);
  int same = port&1;
  port >>=1;
  header->destination_port = port;
  if (!same)
    port = ob_get_packed_ui32(buff);
  header->source_port = port;
}

static struct overlay_buffer *overlay_mdp_decrypt(struct internal_mdp_header *header, struct overlay_buffer *payload)
{
  IN();

  /* Indicate MDP message type */
  struct overlay_buffer *ret=NULL;
  switch(header->crypt_flags)  {
  case MDP_FLAG_NO_CRYPT|MDP_FLAG_NO_SIGN: 
    /* nothing to do, b already points to the plain text */
    overlay_mdp_decode_header(header, payload);
    ret = ob_slice(payload, ob_position(payload), ob_remaining(payload));
    ob_limitsize(ret, ob_remaining(payload));
    break;
  
  default:
  case MDP_FLAG_NO_SIGN:
    WHY("decryption not implemented");
    break;
      
  case MDP_FLAG_NO_CRYPT:
    {
      size_t len = ob_remaining(payload);
      if (crypto_verify_message(header->source, ob_current_ptr(payload), &len))
	break;
      
      ret = ob_slice(payload, ob_position(payload), len);
      ob_limitsize(ret, len);
      overlay_mdp_decode_header(header, ret);
      break;
    }
      
  case 0:
    {
      unsigned char *k=keyring_get_nm_bytes(header->destination->identity->box_sk,
	header->destination->identity->box_pk,
	&header->source->sid);
      if (!k){
	WHY("I don't have the private key required to decrypt that");
	break;
      }

      unsigned char *nonce=ob_get_bytes_ptr(payload, crypto_box_NONCEBYTES);
      if (!nonce){
	WHYF("Expected %d bytes of nonce", crypto_box_NONCEBYTES);
	break;
      }
      
      int cipher_len=ob_remaining(payload);
      if (cipher_len < (int)crypto_box_MACBYTES){
	WHYF("Expected at least %d bytes of cipher text", crypto_box_MACBYTES);
	break;
      }
      unsigned char *cipher_text=ob_get_bytes_ptr(payload, cipher_len);

      struct overlay_buffer *plaintext = ob_new();
      if (!ob_makespace(plaintext, cipher_len - crypto_box_MACBYTES)){
	ob_free(plaintext);
	break;
      }
      ob_limitsize(plaintext, cipher_len - crypto_box_MACBYTES);

      if (crypto_box_open_easy_afternm(ob_ptr(plaintext), cipher_text, cipher_len, nonce, k)) {
	ob_free(plaintext);
	WHYF("crypto_box_open_easy_afternm() failed (from %s, to %s, len %d)",
		    alloca_tohex_sid_t(header->source->sid), alloca_tohex_sid_t(header->destination->sid), cipher_len);
	break;
      }

      overlay_mdp_decode_header(header, plaintext);
      ret=plaintext;
      break;
    }
  }
  
  RETURN(ret);
  OUT();
}

int overlay_saw_mdp_containing_frame(struct overlay_frame *f)
{
  IN();
  /* Take frame source and destination and use them to populate mdp->in->{src,dst}
     SIDs.
     Take ports from mdp frame itself.
     Take payload from mdp frame itself.
  */
  overlay_mdp_frame mdp;
  bzero(&mdp, sizeof(overlay_mdp_frame));
  struct internal_mdp_header header;
  bzero(&header, sizeof header);
  
  header.qos = mdp.out.queue = f->queue;
  header.ttl = mdp.out.ttl = f->ttl;
  header.source = f->source;
  header.destination = f->destination;
  header.receive_interface = f->interface;
  
  if (!(f->modifiers & OF_CRYPTO_CIPHERED))
    header.crypt_flags |= MDP_FLAG_NO_CRYPT;
  if (!(f->modifiers & OF_CRYPTO_SIGNED))
    header.crypt_flags |= MDP_FLAG_NO_SIGN;
  
  /* Get source and destination addresses */
  mdp.out.dst.sid = (f->destination) ? f->destination->sid : SID_BROADCAST;
  mdp.out.src.sid = f->source->sid;

  /* copy crypto flags from frame so that we know if we need to decrypt or verify it */
  struct overlay_buffer *mdp_payload = overlay_mdp_decrypt(&header, f->payload);
  if (mdp_payload==NULL)
    RETURN(-1);
  
  /* and do something with it! */
  int ret=overlay_saw_mdp_frame(&header, mdp_payload);
  ob_free(mdp_payload);
  RETURN(ret);
  OUT();
}

void mdp_init_response(const struct internal_mdp_header *in, struct internal_mdp_header *out)
{
  out->source = in->destination ? in->destination : my_subscriber;
  out->source_port = in->destination_port;
  out->destination = in->source;
  out->destination_port = in->source_port;
  out->ttl = 0;
  out->qos = in->qos;
}

static int send_packet_to_client(
  struct internal_mdp_header *header,
  struct overlay_buffer *payload,
  int version,
  struct socket_address *client){

  switch(version){
    case 0:
      {
	overlay_mdp_frame mdp;
	bzero(&mdp, sizeof mdp);
	ob_checkpoint(payload);
	overlay_mdp_fill_legacy(header, payload, &mdp);
	ob_rewind(payload);

	ssize_t len = overlay_mdp_relevant_bytes(&mdp);
	if (len < 0)
	  return WHY("unsupported MDP packet type");
	DEBUGF(mdprequests, "Forwarding packet to client %s", alloca_socket_address(client));
	ssize_t r = sendto(mdp_sock.poll.fd, &mdp, len, 0, &client->addr, client->addrlen);
	if (r == -1){
	  WHYF_perror("sendto(fd=%d,len=%zu,addr=%s)", mdp_sock.poll.fd, (size_t)len, alloca_socket_address(client));
	  if (errno == ENOENT){
	    /* far-end of socket has died, so drop binding */
	    INFOF("Closing dead MDP client '%s'", alloca_socket_address(client));
	    mark_dead_client(client);
	  }
	  return -1;
	}
	if (r != len)
	  WARNF("sendto() sent %zu bytes of MDP reply (%zu) to %s", (size_t)r, (size_t)len, alloca_socket_address(client));
	return 0;
      }
    case 1:
      {
	struct mdp_header client_header;
	bzero(&client_header, sizeof(client_header));
	client_header.local.sid=header->destination?header->destination->sid:SID_BROADCAST;
	client_header.local.port=header->destination_port;
	client_header.remote.sid=header->source->sid;
	client_header.remote.port=header->source_port;
	client_header.qos=header->qos;
	client_header.ttl=header->ttl;
	client_header.flags=header->crypt_flags;

	DEBUGF(mdprequests, "Forwarding packet to client v2 %s", alloca_socket_address(client));

	size_t len = ob_remaining(payload);
	const uint8_t *ptr = ob_get_bytes_ptr(payload, len);

	return mdp_send2(__WHENCE__, client, &client_header, ptr, len);
      }
  }
  return -1;
}

static int overlay_saw_mdp_frame(
  struct internal_mdp_header *header, 
  struct overlay_buffer *payload)
{
  if (!allow_inbound_packet(header))
    return 0;

  /* Regular MDP frame addressed to us.  Look for matching port binding,
     and if available, push to client.  Else do nothing, or if we feel nice
     send back a connection refused type message? Silence is probably the
     more prudent path.
  */

  DEBUGF(mdprequests, "Received packet (MDP ports: src=%s*:%"PRImdp_port_t", dst=%"PRImdp_port_t")",
	 alloca_tohex_sid_t_trunc(header->source->sid, 14),
	 header->source_port, header->destination_port);

  struct mdp_binding *b = mdp_bindings;

  // first look for an exact subscriber match
  while(b){
    if (b->port==header->destination_port && b->subscriber &&
      ((!header->destination) || b->subscriber == header->destination)
    ){
      /* match */
      if (send_packet_to_client(header, payload, b->version, &b->client)==0
	&& header->destination
	&& (b->flags & MDP_FLAG_REUSE)==0){
	  goto end;
      }
    }
    b=b->_next;
  }

  // then look for ANY bindings
  while(b){
    if (b->port==header->destination_port && !b->subscriber){
      /* match */
      if (send_packet_to_client(header, payload, b->version, &b->client)==0 && (b->flags & MDP_FLAG_REUSE)==0)
	goto end;
    }
    b=b->_next;
  }

  // look for a compile time defined internal binding
  struct internal_binding *binding;
  for (binding = SECTION_START(bindings); binding < SECTION_END(bindings); ++binding) {
    if (binding->port == header->destination_port){
      binding->function(header, payload);
      goto end;
    }
  }

end:
  free_dead_clients();
  return 0;
}

int overlay_mdp_dnalookup_reply(struct subscriber *dest, mdp_port_t dest_port, 
  struct subscriber *resolved_sid, const char *uri, const char *did, const char *name)
{
  DEBUGF(mdprequests, "MDP_PORT_DNALOOKUP resolved_sid=%s uri=%s did=%s name=%s",
	 alloca_tohex_sid_t(resolved_sid->sid),
	 alloca_str_toprint(uri),
	 alloca_str_toprint(did),
	 alloca_str_toprint(name)
	);
  
  struct internal_mdp_header header;
  bzero(&header, sizeof header);
  header.qos = OQ_ORDINARY;
  header.source = resolved_sid;
  header.source_port = MDP_PORT_DNALOOKUP;
  header.destination = dest;
  header.destination_port = dest_port;
  
  /* build reply as TOKEN|URI|DID|NAME|<NUL> */
  char buff[256];
  strbuf b = strbuf_local_buf(buff);
  strbuf_tohex(b, SID_STRLEN, resolved_sid->sid.binary);
  strbuf_sprintf(b, "|%s|%s|%s|", uri, did, name?name:"");
  if (strbuf_overrun(b))
    return WHY("MDP payload overrun");
  struct overlay_buffer *payload = ob_static((unsigned char*)buff, sizeof buff);
  ob_limitsize(payload, strlen(buff));
  int ret = overlay_send_frame(&header, payload);
  ob_free(payload);
  return ret;
}

static int overlay_mdp_check_binding(struct subscriber *subscriber, mdp_port_t port,
			      struct socket_address *client)
{
  /* System generated frames can send anything they want */
  if (!client)
    return 0;

  /* Check if this client has bound this sid/port */
  struct mdp_binding *b = mdp_bindings;
  while(b){
    if (b->port == port
      && (!b->subscriber || b->subscriber == subscriber)
      && cmp_sockaddr(&b->client, client)==0)
      return 0;
    b=b->_next;
  }

  WARNF("No matching binding: addr=%s port=%"PRImdp_port_t,
	alloca_tohex_sid_t(subscriber->sid),
	port
      );
  return -1;
}

void overlay_mdp_encode_ports(struct overlay_buffer *plaintext, mdp_port_t dst_port, mdp_port_t src_port)
{
  mdp_port_t port = dst_port << 1;
  if (dst_port == src_port)
    port |= 1;
  ob_append_packed_ui32(plaintext, port);
  if (dst_port != src_port)
    ob_append_packed_ui32(plaintext, src_port);
}

static int nonce_initialised=0;
static uint8_t nonce_buffer[128];

static int generate_nonce(uint8_t *nonce, size_t bytes)
{
  if (bytes<1||bytes>128) return -1;
  if (!nonce_initialised) {
    randombytes_buf(nonce_buffer,128);
    nonce_initialised=1;
  }

  // Increment nonce
  unsigned i;
  for(i=0;i<128;i++){
    uint8_t b=nonce_buffer[i]+1;
    nonce_buffer[i]=b;
    if (b) break;
  }

  bcopy(nonce_buffer,nonce,bytes);
  return 0;
}

static struct overlay_buffer * encrypt_payload(
  struct subscriber *source, 
  struct subscriber *dest, 
  const unsigned char *buffer,
  size_t msg_len)
{
  struct overlay_buffer *ret = ob_new();
  if (ret == NULL)
    return NULL;
  
  unsigned char *nonce = ob_append_space(ret, msg_len + crypto_box_NONCEBYTES + crypto_box_MACBYTES);
  if (!nonce){
    ob_free(ret);
    return NULL;
  }
  unsigned char *cipher_text = nonce + crypto_box_NONCEBYTES;

  if (generate_nonce(nonce, crypto_box_NONCEBYTES)){
    ob_free(ret);
    WHY("generate_nonce() failed to generate nonce");
    return NULL;
  }
  
  // reserve the high bit of the nonce as a flag for transmitting a shorter nonce.
  nonce[0]&=0x7f;
  
  /* get pre-computed PKxSK bytes (the slow part of auth-cryption that can be
     retained and reused, and use that to do the encryption quickly. */
  unsigned char *k=keyring_get_nm_bytes(source->identity->box_sk, source->identity->box_pk, &dest->sid);
  if (!k) {
    ob_free(ret);
    WHY("could not compute Curve25519(NxM)");
    return NULL;
  }
  /* Actually authcrypt the payload */
  if (crypto_box_easy_afternm(cipher_text, buffer, msg_len, nonce, k)) {
    ob_free(ret);
    WHY("crypto_box_easy_afternm() failed");
    return NULL;
  }
  
  return ret;
}

// encrypt or sign the plaintext, then queue the frame for transmission.
// Note, the position of the payload MUST be at the start of the data, the limit MUST be used to specify the end
int _overlay_send_frame(struct __sourceloc whence, struct internal_mdp_header *header, struct overlay_buffer *payload)
{
  if ((!header->destination) || header->destination->reachable == REACHABLE_SELF){
    ob_checkpoint(payload);
    overlay_saw_mdp_frame(header, payload);
    ob_rewind(payload);
    if (header->destination) {
      /* Is local, and is not broadcast, so shouldn't get sent out on the wire. */
      DEBUGF(mdprequests, "Local packet, not transmitting");
      return 0;
    }
  }
  
  if (!allow_outbound_packet(header))
    return 0;

  if (header->ttl == 0) 
    header->ttl = PAYLOAD_TTL_DEFAULT;
  else if (header->ttl > PAYLOAD_TTL_MAX)
    return WHYF("Invalid TTL");
  
  if (header->qos == 0)
    header->qos = OQ_ORDINARY;
    
  if (!header->source)
    return WHYF("No source specified");
  
  DEBUGF(mdprequests, "Attempting to queue mdp packet from %s:%d to %s:%d",
         alloca_tohex_sid_t(header->source->sid), header->source_port, 
         header->destination?alloca_tohex_sid_t(header->destination->sid):"broadcast", header->destination_port);
      
  /* Prepare the overlay frame for dispatch */
  struct overlay_frame *frame = emalloc_zero(sizeof(struct overlay_frame));
  if (!frame)
    return -1;
  
  frame->source = header->source;
  frame->destination = header->destination;
  frame->ttl = header->ttl;
  frame->queue = header->qos;
  frame->type = OF_TYPE_DATA;
  frame->resend = header->resend;
  frame->send_context = header->send_context;
  frame->send_hook = header->send_hook;
  
  if (!(header->crypt_flags & MDP_FLAG_NO_CRYPT))
    frame->modifiers |= OF_CRYPTO_CIPHERED;
  if (!(header->crypt_flags & MDP_FLAG_NO_SIGN))
    frame->modifiers |= OF_CRYPTO_SIGNED;
  
  // copy the plain text message into a new buffer, with the wire encoded port numbers
  struct overlay_buffer *plaintext=ob_new();
  if (!plaintext){
    op_free(frame);
    return -1;
  }
  
  overlay_mdp_encode_ports(plaintext, header->destination_port, header->source_port);
  if (payload && ob_remaining(payload)){
    ob_append_bytes(plaintext, ob_current_ptr(payload), ob_remaining(payload));
  }
  
  if (ob_overrun(plaintext)) {
    DEBUGF(mdprequests, "Frame overrun: position=%zu allocSize=%zu sizeLimit=%zu",
	   plaintext->position, plaintext->allocSize, plaintext->sizeLimit);
    op_free(frame);
    ob_free(plaintext);
    return -1;
  }
  DEBUGF(mdprequests, "Send frame %zu bytes", ob_position(plaintext));
  if (IF_DEBUG(mdprequests) && IF_DEBUG(verbose))
    dump("Frame plaintext", ob_ptr(plaintext), ob_position(plaintext));
  
  /* Work out the disposition of the frame->  For now we are only worried
     about the crypto matters, and not compression that may be applied
     before encryption (since applying it after is useless as ciphered
     text should have maximum entropy). */
  switch(header->crypt_flags) {
  case 0:
    if (!frame->destination){
      ob_free(plaintext);
      op_free(frame);
      return WHY("Cannot encrypt to broadcast destinations");
    }
  
    /* crypted and signed (using CryptoBox authcryption primitive) */
    frame->payload = encrypt_payload(frame->source, frame->destination, ob_ptr(plaintext), ob_position(plaintext));
    if (!frame->payload){
      ob_free(plaintext);
      op_free(frame);
      return -1;
    }
#if 0
    if (IF_DEBUG(crypto))
      dump("Frame signed ciphertext", ob_ptr(frame->payload), ob_position(frame->payload));
#endif
    break;
      
  case MDP_FLAG_NO_CRYPT:
    // Lets just append some space into the existing payload buffer for the signature, without copying it.
    frame->payload = plaintext;
    if (   !ob_makespace(frame->payload, SIGNATURE_BYTES)
        || keyring_sign_message(frame->source->identity, ob_ptr(frame->payload), frame->payload->allocSize, &frame->payload->position) == -1
    ) {
      op_free(frame);
      return -1;
    }
#if 0
    if (IF_DEBUG(crypto))
      dump("Frame signed plaintext", ob_ptr(frame->payload), ob_position(frame->payload));
#endif
    break;
      
  case MDP_FLAG_NO_CRYPT|MDP_FLAG_NO_SIGN:
    /* clear text and no signature */
    frame->payload = plaintext;
    break;
    
  default:
    ob_free(plaintext);
    op_free(frame);
    return WHY("Invalid encrypt / sign combination");
  }
  
  if (!frame->destination && frame->ttl>1)
    overlay_broadcast_generate_address(&frame->broadcast_id);
  
  if (_overlay_payload_enqueue(whence, frame)){
    op_free(frame);
    return -1;
  }
  
  return 0;
}

/* Construct MDP packet frame from overlay_mdp_frame structure
   (need to add return address from bindings list, and copy
   payload etc).
   This is for use by the SERVER. 
   Clients should use overlay_mdp_send()
 */
static int overlay_mdp_dispatch(overlay_mdp_frame *mdp, struct socket_address *client)
{
  IN();
  unsigned __d = IF_DEBUG(mdprequests) ? fd_depth() : 0;
  DEBUGF(mdprequests, "[%u] src=%s*:%"PRImdp_port_t", dst=%s*:%"PRImdp_port_t", recv=%s",
	   __d,
	   alloca_tohex_sid_t_trunc(mdp->out.src.sid, 14), mdp->out.src.port,
	   alloca_tohex_sid_t_trunc(mdp->out.dst.sid, 14), mdp->out.dst.port,
	   client ? alloca_socket_address(client) : "NULL"
	);

  if (mdp->out.payload_length > sizeof(mdp->out.payload))
    FATAL("Payload length is past the end of the buffer");

  struct internal_mdp_header header;
  bzero(&header, sizeof(header));
  
  header.source_port = mdp->out.src.port;
  header.destination_port = mdp->out.dst.port;
  header.ttl = mdp->out.ttl;
  header.qos = mdp->out.queue;
  
  if (is_sid_t_any(mdp->out.src.sid)){
    /* set source to ourselves */
    header.source = my_subscriber;
    mdp->out.src.sid = header.source->sid;
  }else if (is_sid_t_broadcast(mdp->out.src.sid)){
    /* Nope, I'm sorry but we simply can't send packets from 
     * broadcast addresses. */
    RETURN(WHY("Packet had broadcast address as source address"));
  }else{
    // assume all local identities have already been unlocked and marked as SELF.
    header.source = find_subscriber(mdp->out.src.sid.binary, SID_SIZE, 0);
    if (!header.source){
      RETURN(WHYF("Possible spoofing attempt, tried to send a packet from %s, which is an unknown SID", alloca_tohex_sid_t(mdp->out.src.sid)));
    }
    if (header.source->reachable!=REACHABLE_SELF){
      RETURN(WHYF("Possible spoofing attempt, tried to send a packet from %s", alloca_tohex_sid_t(mdp->out.src.sid)));
    }
  }
  
  if (overlay_mdp_check_binding(header.source, header.source_port, client)){
    RETURN(overlay_mdp_reply_error
	   (mdp_sock.poll.fd,
	    client,8,
	    "Source address is invalid (you must bind to a source address before"
	    " you can send packets"));
  }
  
  /* Work out if destination is broadcast or not */
  if (is_sid_t_broadcast(mdp->out.dst.sid)){
    DEBUGF(mdprequests, "[%u] Broadcast packet", __d);
    /* broadcast packets cannot be encrypted, so complain if MDP_NOCRYPT
     flag is not set. Also, MDP_NOSIGN must also be applied, until
     NaCl cryptobox keys can be used for signing. */	
    if (!(mdp->packetTypeAndFlags&MDP_NOCRYPT))
      RETURN(overlay_mdp_reply_error(mdp_sock.poll.fd,
				     client,5,
				     "Broadcast packets cannot be encrypted "));
  }else{
    header.destination = find_subscriber(mdp->out.dst.sid.binary, SID_SIZE, 1);
    // should we reply with an error if the destination is not currently routable?
  }
  
  if (header.ttl > PAYLOAD_TTL_MAX) {
    RETURN(overlay_mdp_reply_error(mdp_sock.poll.fd, client, 9, "TTL out of range"));
  }
  
  DEBUGF(mdprequests, "[%u] destination->sid=%s", __d, header.destination ? alloca_tohex_sid_t(header.destination->sid) : "NULL");
    
  if (mdp->packetTypeAndFlags&MDP_NOCRYPT)
    header.crypt_flags |= MDP_FLAG_NO_CRYPT;
  if (mdp->packetTypeAndFlags&MDP_NOSIGN)
    header.crypt_flags |= MDP_FLAG_NO_SIGN;
  
  struct overlay_buffer *buff = ob_static(mdp->out.payload, mdp->out.payload_length);
  ob_limitsize(buff, mdp->out.payload_length);
  
  int ret=overlay_send_frame(&header, buff);
  
  ob_free(buff);
  RETURN(ret);
  OUT();
}

static int search_subscribers(struct subscriber *subscriber, void *context){
  struct overlay_mdp_addrlist *response = context;
  
  if (response->mode == MDP_ADDRLIST_MODE_SELF && subscriber->reachable != REACHABLE_SELF){
    return 0;
  }
  
  if (response->mode == MDP_ADDRLIST_MODE_ROUTABLE_PEERS && 
      (!(subscriber->reachable &REACHABLE))){
    return 0;
  }
    
  if (response->mode == MDP_ADDRLIST_MODE_ALL_PEERS &&
      subscriber->reachable == REACHABLE_SELF){
    return 0;
  }
  
  if (response->server_sid_count++ >= response->first_sid && 
      response->frame_sid_count < MDP_MAX_SID_REQUEST)
    response->sids[response->frame_sid_count++] = subscriber->sid;
  
  return 0;
}

static int overlay_mdp_address_list(struct overlay_mdp_addrlist *request, struct overlay_mdp_addrlist *response)
{
  DEBUGF(mdprequests, "MDP_GETADDRS first_sid=%u mode=%d", request->first_sid, request->mode);
  
  /* Prepare reply packet */
  response->mode = request->mode;
  response->first_sid = request->first_sid;
  response->frame_sid_count = 0;
  
  /* Populate with SIDs */
  enum_subscribers(NULL, search_subscribers, response);
  
  response->last_sid = response->first_sid + response->frame_sid_count - 1;
  
  DEBUGF(mdprequests, "reply MDP_ADDRLIST first_sid=%u last_sid=%u frame_sid_count=%u server_sid_count=%u",
	 response->first_sid,
	 response->last_sid,
	 response->frame_sid_count,
	 response->server_sid_count
	);
  return 0;
}

struct routing_state{
  struct mdp_header *header;
  struct socket_address *client;
};

static void send_route(struct subscriber *subscriber, struct socket_address *client, struct mdp_header *header)
{
  uint8_t payload[MDP_MTU];
  struct overlay_buffer *b = ob_static(payload, sizeof payload);
  ob_limitsize(b, sizeof payload);
  ob_append_bytes(b, subscriber->sid.binary, SID_SIZE);
  ob_append_byte(b, subscriber->reachable);
  if (subscriber->reachable & REACHABLE){
    ob_append_byte(b, subscriber->hop_count);
    if (subscriber->hop_count>1){
      ob_append_bytes(b, subscriber->next_hop->sid.binary, SID_SIZE);
      if (subscriber->hop_count>2){
	ob_append_bytes(b, subscriber->prior_hop->sid.binary, SID_SIZE);
      }
    }else{
      ob_append_byte(b, subscriber->destination->interface - overlay_interfaces);
      ob_append_str(b, subscriber->destination->interface->name);
    }
  }
  assert(!ob_overrun(b));
  mdp_reply2(__WHENCE__, client, header, 0, payload, ob_position(b));
  ob_free(b);
}

static int routing_table(struct subscriber *subscriber, void *context)
{
  if (subscriber->reachable != REACHABLE_NONE){
    struct routing_state *state = (struct routing_state *)context;
    send_route(subscriber, state->client, state->header);
  }
  return 0;
}

static void send_route_changed(struct subscriber *subscriber, int UNUSED(prior_reachable)){
  struct mdp_header header;
  bzero(&header, sizeof(header));
  header.local.sid = SID_INTERNAL;
  header.local.port = MDP_ROUTE_TABLE;
  header.remote.port = MDP_ROUTE_TABLE;

  struct mdp_binding *b = mdp_bindings;
  while(b){
    if (b->port == MDP_ROUTE_TABLE && b->subscriber == internal){
      send_route(subscriber, &b->client, &header);
    }
    b=b->_next;
  }
}
DEFINE_TRIGGER(link_change, send_route_changed);

struct scan_state{
  struct sched_ent alarm;
  overlay_interface *interface;
  uint32_t current;
  uint32_t last;
};
struct scan_state scans[OVERLAY_MAX_INTERFACES];

static void overlay_mdp_scan(struct sched_ent *alarm)
{
  struct socket_address addr;
  bzero(&addr, sizeof(addr));
  addr.addrlen = sizeof(addr.inet);
  addr.inet.sin_family=AF_INET;
  addr.inet.sin_port=htons(PORT_DNA);
  
  struct scan_state *state = (struct scan_state *)alarm;
  uint32_t stop = state->last;
  if (stop - state->current > 25)
    stop = state->current+25;
  
  while(state->current <= stop){
    addr.inet.sin_addr.s_addr=htonl(state->current);
    if (addr.inet.sin_addr.s_addr != state->interface->address.inet.sin_addr.s_addr){
      struct network_destination *destination = create_unicast_destination(&addr, state->interface);
      if (!destination)
	break;
      int ret = overlay_send_probe(NULL, destination, OQ_ORDINARY);
      release_destination_ref(destination);
      if (ret)
	break;
    }
    state->current++;
  }
  
  if (state->current <= state->last){
    time_ms_t now = gettime_ms();
    RESCHEDULE(alarm, now+500, now+500, TIME_MS_NEVER_WILL);
  }else{
    DEBUG(mdprequests, "Scan completed");
    state->interface=NULL;
    state->current=0;
    state->last=0;
  }
}

static int mdp_process_identity_request(struct socket_address *client, struct mdp_header *header, 
  struct overlay_buffer *payload)
{
  if (ob_remaining(payload)<sizeof(struct mdp_identity_request)){
    mdp_reply_error(client, header);
    return WHY("Request too small");
  }
  struct mdp_identity_request request;
  ob_get_bytes(payload, (uint8_t *)&request, sizeof(request));
  
  switch(request.action){
    case ACTION_LOCK:
      switch (request.type){
	case TYPE_PIN:
	  {
	    while(1){
	      const char *pin = ob_get_str_ptr(payload);
	      if (!pin)
		break;
	      keyring_iterator it;
	      keyring_iterator_start(keyring, &it);
	      keyring_next_identity(&it);
	      while(it.identity){
		if (it.identity->subscriber != my_subscriber && strcmp(it.identity->PKRPin, pin) == 0)
		  keyring_release_identity(&it);
		else
		  keyring_next_identity(&it);
	      }
	    }
	  }
	  break;
	case TYPE_SID:
	  while(1){
	    const sid_t *sid=(const sid_t*)ob_get_bytes_ptr(payload,SID_SIZE);
	    if (sid==NULL)
	      break;
	    keyring_release_subscriber(keyring, sid);
	  }
	  break;
	default:
	  mdp_reply_error(client, header);
	  return WHY("Unknown request type");
      }
      break;
    case ACTION_UNLOCK:
      {
	if (request.type!=TYPE_PIN){
	  mdp_reply_error(client, header);
	  return WHY("Unknown request type");
	}
	unsigned unlock_count=0;
	while(1){
	  const char *pin = ob_get_str_ptr(payload);
	  if (!pin)
	    break;
	  unlock_count += keyring_enter_pin(keyring, pin);
	}
	if (unlock_count && directory_service)
	  directory_registration();
      }
      break;
    default:
      mdp_reply_error(client, header);
      return WHY("Unknown request action");
  }
  mdp_reply_ok(client, header);
  return 0;
}

// return one response per matching identity
static int mdp_search_identities(struct socket_address *client, struct mdp_header *header, 
  struct overlay_buffer *payload)
{
  keyring_iterator it;
  keyring_iterator_start(keyring, &it);
  
  const char *tag=NULL;
  const unsigned char *value=NULL;
  size_t value_len=0;
  size_t payload_len = ob_remaining(payload);
  
  if (payload_len){
    if (keyring_unpack_tag(ob_ptr(payload), payload_len, &tag, &value, &value_len)){
      mdp_reply_error(client, header);
      return -1;
    }
  }
  
  while(1){
    if (value_len){
      DEBUGF(mdprequests, "Looking for next %s tag & value", tag);
      if (!keyring_find_public_tag_value(&it, tag, value, value_len))
	break;
    }else if(tag){
      DEBUGF(mdprequests, "Looking for next %s tag", tag);
      if (!keyring_find_public_tag(&it, tag, NULL, NULL))
	break;
    }else{
      DEBUGF(mdprequests, "Looking for next identity");
      if (!keyring_next_identity(&it))
	break;
    }
    unsigned char reply_payload[1200];
    size_t ofs=0;
    
    bcopy(it.identity->subscriber->sid.binary, &reply_payload[ofs], sizeof(it.identity->subscriber->sid));
    ofs+=sizeof(it.identity->subscriber->sid);
     
    // TODO return other details of this identity
     
    mdp_reply2(__WHENCE__, client, header, 0, reply_payload, ofs);
  }
  mdp_reply_ok(client, header);
  return 0;
}

const char *external_name="ext"; // TODO?

int mdp_send_external_packet(struct overlay_interface *interface, struct socket_address *address, const uint8_t *payload, size_t len)
{
  struct mdp_header header;
  bzero(&header, sizeof header);
  header.remote.port = MDP_INTERFACE;
  uint8_t addrlen = address->addrlen;
  
  struct iovec iov[]={
    {
      .iov_base = (void *)&header,
      .iov_len = sizeof(struct mdp_header)
    },
    {
      .iov_base = (void *)&addrlen,
      .iov_len = sizeof addrlen
    },
    {
      .iov_base = (void *)&address->raw,
      .iov_len = addrlen
    },
    {
      .iov_base = (void *)payload,
      .iov_len = len
    }
  };
  
  struct msghdr hdr={
    .msg_name=&interface->address.addr,
    .msg_namelen=interface->address.addrlen,
    .msg_iov=iov,
    .msg_iovlen=4,
  };
  
  int fd=-1;
  switch(interface->address.addr.sa_family){
    case AF_UNIX:
      fd = mdp_sock2.poll.fd;
      break;
    case AF_INET:
      fd = mdp_sock2_inet.poll.fd;
      break;
  }
  if (fd==-1)
    return WHYF("Unhandled client family %d", interface->address.addr.sa_family);
  
  if (sendmsg(fd, &hdr, 0)<0)
    return WHY_perror("sendmsg");
  
  return 0;
}

static void mdp_interface_packet(struct socket_address *client, struct mdp_header *UNUSED(header), 
  struct overlay_buffer *payload){
  int msg_type = ob_get(payload);
  switch (msg_type){
    case MDP_INTERFACE_UP:{
      struct config_network_interface ifconfig;
      cf_dfl_config_network_interface(&ifconfig);
      
      struct cf_om_node *conf_node = NULL;
      int result = cf_om_parse(external_name, (char*)ob_current_ptr(payload), ob_remaining(payload), &conf_node);
      if (result == CFOK || result == CFEMPTY){
	result = conf_node ? cf_opt_config_network_interface(&ifconfig, conf_node) : CFEMPTY;
      }
      
      if (result == CFOK || result == CFEMPTY){
	if (ifconfig.socket_type != SOCK_EXT){
	  // TODO log nice warning, pick right result code
	  result |= CFSUB(CFUNSUPPORTED);
	}
      }
      
      if (result == CFOK || result == CFEMPTY){
	struct overlay_interface *interface=overlay_interface_find_name_addr(external_name, client);
	if (!interface){
	  overlay_interface_init(external_name, client, NULL, NULL, &ifconfig);
	}else{
	  if (overlay_interface_configure(interface, &ifconfig)==-1)
	    overlay_interface_close(interface);
	}
      }
    }break;
    case MDP_INTERFACE_DOWN:{
      struct overlay_interface *interface=overlay_interface_find_name_addr(external_name, client);
      if (interface)
	overlay_interface_close(interface);
    }break;
    case MDP_INTERFACE_RECV:{
      struct overlay_interface *interface=overlay_interface_find_name_addr(external_name, client);
      if (interface){
	struct socket_address addr;
	addr.addrlen = ob_get(payload);
	if (addr.addrlen > sizeof(addr))
	  break; // TODO errors
	bcopy(ob_get_bytes_ptr(payload, addr.addrlen), addr.raw, addr.addrlen);
	packetOkOverlay(interface, ob_current_ptr(payload), ob_remaining(payload), &addr);
      }
      break;
    }
  }
}

static mdp_port_t get_next_port(){
  again:

  if (next_port_binding > 32*1024)
    // note, we're assuming that there are NO internal port bindings >=256
    next_port_binding=256;
  else
    next_port_binding++;

  // make sure there are *no* bindings for this port on any SID.
  struct mdp_binding *b = mdp_bindings;
  while(b){
    if (b->port == next_port_binding)
      goto again;
    b = b->_next;
  }
  return next_port_binding;
}

static void mdp_process_packet(struct socket_address *client, struct mdp_header *header,
  struct overlay_buffer *payload)
{
  struct internal_mdp_header internal_header;
  bzero(&internal_header, sizeof(internal_header));
  
  if ((header->flags & MDP_FLAG_CLOSE) && header->local.port==0){
    mark_dead_client(client);
    free_dead_clients();
    return;
  }
  
  // find local sid
  int sid_type;
  switch(sid_type=sid_get_special_type(&header->local.sid)){
    case SID_TYPE_ANY:
      // leaving the sid blank indicates that we should use our main identity
      internal_header.source = my_subscriber;
      header->local.sid = my_subscriber->sid;
      break;
    case SID_TYPE_INTERNAL:
      internal_header.source = internal;
      header->flags |= MDP_FLAG_REUSE;
    case SID_TYPE_BROADCAST:
      // leave source NULL to indicate listening on all local SID's
      // note that attempting anything else will fail
      break;
    default:
      // find the matching sid from our keyring
      internal_header.source = find_subscriber(header->local.sid.binary, sizeof(header->local.sid), 0);
      if (!internal_header.source || internal_header.source->reachable != REACHABLE_SELF){
	WHY("Subscriber is not local");
	mdp_reply_error(client, header);
	return;
      }
  }

  struct mdp_binding **pclient_binding=NULL;
  struct mdp_binding *client_binding=NULL;
  struct mdp_binding *conflicting_binding=NULL;

  // assign the next available port number
  if (header->local.port==0 && header->flags & MDP_FLAG_BIND){
    header->local.port=get_next_port();
  }else{
    // find existing matching or conflicting bindings
    struct mdp_binding **binding = &mdp_bindings;
    while(*binding){
      struct mdp_binding *b = (*binding);
      if (b->port == header->local.port
	&& b->subscriber == internal_header.source){

	if (cmp_sockaddr(&b->client, client)==0){
	  client_binding = b;
	  pclient_binding = binding;
	  break;
	}

	// any conflicting binding will do;
	conflicting_binding = b;
      }
      binding = &b->_next;
    }
  }
  
  internal_header.source_port = header->local.port;
  internal_header.destination_port = header->remote.port;
  internal_header.ttl = header->ttl;
  internal_header.qos = header->qos;
  
  if (header->flags & MDP_FLAG_BIND){
    if (conflicting_binding && (header->flags & MDP_FLAG_REUSE)==0 && (conflicting_binding->flags & MDP_FLAG_REUSE))
      conflicting_binding = NULL;

    if (conflicting_binding){
      WHYF("Sorry %s, %s:%u is already bound by %s",
	alloca_socket_address(client),
	alloca_tohex_sid_t(header->local.sid),
	header->local.port,
	alloca_socket_address(&conflicting_binding->client));
      mdp_reply_error(client, header);
      return;
    }

    if (!client_binding){
      DEBUGF(mdprequests, "Bind MDP %s:%d to %s",
	     alloca_tohex_sid_t(header->local.sid),
	     header->local.port,
	     alloca_socket_address(client));
      client_binding = emalloc_zero(sizeof(struct mdp_binding));
      if (!client_binding){
	mdp_reply_error(client, header);
	return;
      }
      // claim binding
      client_binding->port = header->local.port;
      client_binding->subscriber = internal_header.source;
      bcopy(&client->addr, &client_binding->client.addr, client->addrlen);
      client_binding->client.addrlen = client->addrlen;
      client_binding->binding_time=gettime_ms();
      client_binding->version=1;

      client_binding->_next = mdp_bindings;
      mdp_bindings = client_binding;
    }
    // tell the client that they (still?) have this binding (with flags & MDP_FLAG_BIND still set)
    mdp_reply2(__WHENCE__, client, header, MDP_FLAG_BIND, NULL, 0);
  }
  
  if (is_sid_t_any(header->remote.sid)){
    // process local commands
    switch(header->remote.port){
      case MDP_LISTEN:
	// double check that you have a binding
	if (!client_binding){
	  WHYF("That port is not bound by you %s",
	    alloca_socket_address(client));
	  mdp_reply_error(client, header);
	}
	break;
      case MDP_IDENTITY:
	DEBUGF(mdprequests, "Processing MDP_IDENTITY from %s", alloca_socket_address(client));
	mdp_process_identity_request(client, header, payload);
	break;
      // seach unlocked identities
      case MDP_SEARCH_IDS:
	DEBUGF(mdprequests, "Processing MDP_SEARCH_IDS from %s", alloca_socket_address(client));
	mdp_search_identities(client, header, payload);
	break;
      case MDP_SYNC_CONFIG:
	DEBUGF(mdprequests, "Processing MDP_SYNC_CONFIG from %s", alloca_socket_address(client));
	server_config_reload(NULL);
	mdp_reply_ok(client, header);
	break;
      case MDP_INTERFACE:
	DEBUGF(mdprequests, "Processing MDP_INTERFACE from %s", alloca_socket_address(client));
	mdp_interface_packet(client, header, payload);
	break;
      case MDP_ROUTE_TABLE:
	DEBUGF(mdprequests, "Processing MDP_ROUTING_TABLE from %s", alloca_socket_address(client));
	{
	  struct routing_state state={
	    .client = client,
	    .header = header
	  };
	  enum_subscribers(NULL, routing_table, &state);
	  mdp_reply_ok(client, header);
	}
	break;
      default:
	WHYF("Unknown command port %d", header->remote.port);
	mdp_reply_error(client, header);
	break;
    }
    
  }else{
    if (sid_type == SID_TYPE_INTERNAL || sid_type == SID_TYPE_BROADCAST){
      WHYF("Can't send data packet from a special SID");
      mdp_reply_error(client, header);
      return;
    }

    // double check that you have a binding
    if (!client_binding){
      WHYF("Can't send data packet, %s:%d is not bound to %s!",
	alloca_tohex_sid_t(header->local.sid),
	header->local.port,
	alloca_socket_address(client));
      mdp_reply_error(client, header);
      return;
    }
    
    if (!is_sid_t_broadcast(header->remote.sid))
      internal_header.destination = find_subscriber(header->remote.sid.binary, SID_SIZE, 1);
    
    internal_header.crypt_flags = header->flags & (MDP_FLAG_NO_CRYPT|MDP_FLAG_NO_SIGN);
    
    // construct, encrypt, sign and queue the packet
    if (overlay_send_frame(
      &internal_header,
      payload)){
      mdp_reply_error(client, header);
      return;
    }
  }
  
  // remove binding
  if (client_binding
    && header->flags & MDP_FLAG_CLOSE){
    DEBUGF(mdprequests, "Unbind MDP %s:%d from %s", 
	   client_binding->subscriber?alloca_tohex_sid_t(client_binding->subscriber->sid):"All",
	   client_binding->port,
	   alloca_socket_address(client));
    *pclient_binding = client_binding->_next;
    free(client_binding);
  }
}

static int mdp_send2(struct __sourceloc __whence, const struct socket_address *client, const struct mdp_header *header, 
  const uint8_t *payload, size_t payload_len)
{
  struct iovec iov[]={
    {
      .iov_base = (void *)header,
      .iov_len = sizeof(struct mdp_header)
    },
    {
      .iov_base = (void *)payload,
      .iov_len = payload_len
    }
  };
  
  struct msghdr hdr={
    .msg_name=(struct sockaddr*)&client->addr,
    .msg_namelen=client->addrlen,
    .msg_iov=iov,
    .msg_iovlen=2,
  };
  
  int fd=-1;
  switch(client->addr.sa_family){
    case AF_UNIX:
      fd = mdp_sock2.poll.fd;
      break;
    case AF_INET:
      fd = mdp_sock2_inet.poll.fd;
      break;
  }
  if (fd==-1)
    return WHYF("Unhandled client family %d", client->addr.sa_family);
  
  if (sendmsg(fd, &hdr, 0)<0){
    WHY_perror("sendmsg");
    if (errno == ENOENT){
      /* far-end of socket has died, so drop binding */
      INFOF("Closing dead MDP client '%s'", alloca_socket_address(client));
      mark_dead_client(client);
    }
    return -1;
  }
  
  return 0;
}

static void mdp_poll2(struct sched_ent *alarm)
{
  if (alarm->poll.revents & POLLIN) {
    uint8_t payload[1400];
    struct mdp_header header;
    struct socket_address client;
    bzero(&client, sizeof client);
    client.addrlen=sizeof(client.addr);
    
    struct iovec iov[]={
      {
	.iov_base = (void *)&header,
	.iov_len = sizeof header
      },
      {
	.iov_base = (void *)payload,
	.iov_len = sizeof payload
      }
    };
    
    struct msghdr hdr={
      .msg_name=&client.addr,
      .msg_namelen=sizeof(client.store),
      .msg_iov=iov,
      .msg_iovlen=2,
    };
    
    ssize_t len = recvmsg(alarm->poll.fd, &hdr, 0);
    if (len == -1){
      WHYF_perror("recvmsg(%d,%p,0)", alarm->poll.fd, &hdr);
      return;
    }
    if ((size_t)len < sizeof header) {
      WHYF("Expected length %zu, got %zu from %s", sizeof header, (size_t)len, alloca_socket_address(&client));
      return;
    }
    
    client.addrlen = hdr.msg_namelen;
    size_t payload_len = (size_t)(len - sizeof header);
    
    struct overlay_buffer *buff = ob_static(payload, payload_len);
    ob_limitsize(buff, payload_len);
    
    mdp_process_packet(&client, &header, buff);
    
    ob_free(buff);
  }
}

static void overlay_mdp_poll(struct sched_ent *alarm)
{
  if (alarm->poll.revents & POLLIN) {
    unsigned char buffer[16384];
    int ttl = -1;
    struct socket_address client;
    client.addrlen = sizeof client.store;
    ssize_t len = recv_message(alarm->poll.fd, &client, &ttl, buffer, sizeof(buffer));

    if ((size_t)len > 0) {
      if (client.addrlen <= sizeof(sa_family_t))
	WHYF("got client.addrlen=%d too short -- ignoring frame len=%zu", (int)client.addrlen, (size_t)len);
      else {
	/* Look at overlay_mdp_frame we have received */
	overlay_mdp_frame *mdp=(overlay_mdp_frame *)&buffer[0];      
	unsigned int mdp_type = mdp->packetTypeAndFlags & MDP_TYPE_MASK;

	switch (mdp_type) {
	case MDP_GOODBYE:
	  DEBUGF(mdprequests, "MDP_GOODBYE from %s", alloca_socket_address(&client));
	  mark_dead_client(&client);
	  return;
	    
	case MDP_GETADDRS:
	  DEBUGF(mdprequests, "MDP_GETADDRS from %s", alloca_socket_address(&client));
	  {
	    overlay_mdp_frame mdpreply;
	    bzero(&mdpreply, sizeof(overlay_mdp_frame));
	    mdpreply.packetTypeAndFlags = MDP_ADDRLIST;
	    if (!overlay_mdp_address_list(&mdp->addrlist, &mdpreply.addrlist))
	    /* Send back to caller */
	      overlay_mdp_reply(alarm->poll.fd,
				&client,
				&mdpreply);
	      
	    return;
	  }
	  break;
	    
	case MDP_TX: /* Send payload (and don't treat it as system privileged) */
	  DEBUGF(mdprequests, "MDP_TX from %s", alloca_socket_address(&client));
	    
	  // Dont allow mdp clients to send very high priority payloads
	  if (mdp->out.queue<=OQ_MESH_MANAGEMENT)
	    mdp->out.queue=OQ_ORDINARY;
	  overlay_mdp_dispatch(mdp, &client);
	  return;
	  break;
	    
	case MDP_BIND: /* Bind to port */
	  DEBUGF(mdprequests, "MDP_BIND from %s", alloca_socket_address(&client));
	  {
	    struct subscriber *subscriber=NULL;
	    /* Make sure source address is either all zeros (listen on all), or a valid
	    local address */
	    
	    if (!is_sid_t_any(mdp->bind.sid)){
	      subscriber = find_subscriber(mdp->bind.sid.binary, SID_SIZE, 0);
	      if ((!subscriber) || subscriber->reachable != REACHABLE_SELF){
		WHYF("Invalid bind request for sid=%s", alloca_tohex_sid_t(mdp->bind.sid));
		/* Source address is invalid */
		overlay_mdp_reply_error(alarm->poll.fd, &client, 7,
					      "Bind address is not valid (must be a local MDP address, or all zeroes).");
		return;
	      }
	      
	    }
	    if (overlay_mdp_process_bind_request(subscriber, mdp->bind.port,
						mdp->packetTypeAndFlags, &client))
	      overlay_mdp_reply_error(alarm->poll.fd, &client, 3, "Port already in use");
	    else
	      overlay_mdp_reply_ok(alarm->poll.fd, &client, "Port bound");
	    return;
	  }
	  break;
	    
	case MDP_SCAN:
	  DEBUGF(mdprequests, "MDP_SCAN from %s", alloca_socket_address(&client));
	  {
	    struct overlay_mdp_scan *scan = (struct overlay_mdp_scan *)&mdp->raw;
	    time_ms_t start=gettime_ms();
	    
	    if (scan->addr.s_addr==0){
	      int i=0;
	      for (i=0;i<OVERLAY_MAX_INTERFACES;i++){
		// skip any interface that is already being scanned
		if (scans[i].interface)
		  continue;
		
		struct overlay_interface *interface = &overlay_interfaces[i];
		if (interface->state!=INTERFACE_STATE_UP)
		  continue;
		if (interface->address.addr.sa_family!=AF_INET)
		  continue;
		scans[i].interface = interface;
		scans[i].current = ntohl(interface->address.inet.sin_addr.s_addr & ~interface->netmask.s_addr)+1;
		scans[i].last = ntohl(interface->destination->address.inet.sin_addr.s_addr)-1;
		if (scans[i].last - scans[i].current>0x10000){
		  INFOF("Skipping scan on interface %s as the address space is too large (%04x %04x)",
		    interface->name, scans[i].last, scans[i].current);
		  continue;
		}
		scans[i].alarm.function=overlay_mdp_scan;
		RESCHEDULE(&scans[i].alarm, start, start, start+500);
		start+=100;
	      }
	    }else{
	      struct overlay_interface *interface = overlay_interface_find(scan->addr, 1);
	      if (!interface){
		overlay_mdp_reply_error(alarm->poll.fd, &client, 1, "Unable to find matching interface");
		return;
	      }
	      int i = interface - overlay_interfaces;
	      
	      if (!scans[i].interface){
		scans[i].interface = interface;
		scans[i].current = ntohl(scan->addr.s_addr);
		scans[i].last = ntohl(scan->addr.s_addr);
		scans[i].alarm.function=overlay_mdp_scan;
		RESCHEDULE(&scans[i].alarm, start, start, start+500);
	      }
	    }
	    
	    overlay_mdp_reply_ok(alarm->poll.fd, &client, "Scan initiated");
	  }
	  break;
	  
	default:
	  /* Client is not allowed to send any other frame type */
	  WARNF("Unsupported MDP frame type [%d] from %s", mdp_type, alloca_socket_address(&client));
	  overlay_mdp_reply_error(alarm->poll.fd, &client, 2, "Illegal request type.  Clients may use only MDP_TX or MDP_BIND.");
	}
      }
    }
  }
  
  if (alarm->poll.revents & (POLLHUP | POLLERR)) {
    INFO("Error on mdp socket");
  }
  return;
}