Further cleanup of tr_gss and usage for tids handling
[trust_router.git] / tid / tids.c
index acdf332..9e6f4d9 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, JANET(UK)
+ * Copyright (c) 2012, 2015, JANET(UK)
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  *
  */
 
-#include <assert.h>
 #include <stdlib.h>
 #include <unistd.h>
+#include <fcntl.h>
 #include <string.h>
 #include <stdio.h>
 #include <errno.h>
 #include <sys/socket.h>
-#include <netinet/in.h>
+#include <sys/wait.h>
+#include <netdb.h>
 #include <jansson.h>
-
-#include <trust_router/tid.h>
+#include <talloc.h>
+#include <poll.h>
+#include <tid_internal.h>
 #include <gsscon.h>
+#include <tr_debug.h>
 #include <tr_msg.h>
+#include <tr_socket.h>
+#include <tr_gss.h>
+#include <tr_event.h>
 
-static TID_RESP *tids_create_response (TIDS_INSTANCE *tids, TID_REQ *req) 
+static TID_RESP *tids_create_response(TALLOC_CTX *mem_ctx, TIDS_INSTANCE *tids, TID_REQ *req)
 {
-  TID_RESP *resp;
+  TID_RESP *resp=NULL;
+  int success=0;
 
-  if ((NULL == (resp = calloc(sizeof(TID_RESP), 1)))) {
-    fprintf(stderr, "tids_create_response: Error allocating response structure.\n");
+  if (NULL == (resp = tid_resp_new(mem_ctx))) {
+    tr_crit("tids_create_response: Error allocating response structure.");
     return NULL;
   }
   
@@ -59,221 +66,175 @@ static TID_RESP *tids_create_response (TIDS_INSTANCE *tids, TID_REQ *req)
   if ((NULL == (resp->rp_realm = tr_dup_name(req->rp_realm))) ||
       (NULL == (resp->realm = tr_dup_name(req->realm))) ||
       (NULL == (resp->comm = tr_dup_name(req->comm)))) {
-    fprintf(stderr, "tids_create_response: Error allocating fields in response.\n");
-    return NULL;
+    tr_crit("tids_create_response: Error allocating fields in response.");
+    goto cleanup;
   }
   if (req->orig_coi) {
     if (NULL == (resp->orig_coi = tr_dup_name(req->orig_coi))) {
-      fprintf(stderr, "tids_create_response: Error allocating fields in response.\n");
-      return NULL;
+      tr_crit("tids_create_response: Error allocating fields in response.");
+      goto cleanup;
     }
   }
-  return resp;
-}
-
-static void tids_destroy_response(TIDS_INSTANCE *tids, TID_RESP *resp) 
-{
-  if (resp) {
-    if (resp->err_msg)
-      tr_free_name(resp->err_msg);
-    if (resp->rp_realm)
-      tr_free_name(resp->rp_realm);
-    if (resp->realm)
-      tr_free_name(resp->realm);
-    if (resp->comm)
-      tr_free_name(resp->comm);
-    if (resp->orig_coi)
-      tr_free_name(resp->orig_coi);
-    free (resp);
-  }
-}
-
-static int tids_listen (TIDS_INSTANCE *tids, int port) 
-{
-    int rc = 0;
-    int conn = -1;
-    int optval = 1;
-
-    union {
-      struct sockaddr_storage storage;
-      struct sockaddr_in in4;
-    } addr;
-
-    struct sockaddr_in *saddr = (struct sockaddr_in *) &addr.in4;
-    
-    saddr->sin_port = htons (port);
-    saddr->sin_family = AF_INET;
-    saddr->sin_addr.s_addr = INADDR_ANY;
-
-    if (0 > (conn = socket (AF_INET, SOCK_STREAM, 0)))
-      return conn;
-        
-    setsockopt(conn, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof(optval));
-
-    if (0 > (rc = bind (conn, (struct sockaddr *) saddr, sizeof(struct sockaddr_in))))
-      return rc;
-        
-    if (0 > (rc = listen(conn, 512)))
-      return rc;
-    
-    fprintf (stdout, "tids_listen: TID Server listening on port %d\n", port);
-    return conn; 
-}
-
-static int tids_auth_cb(gss_name_t clientName, gss_buffer_t displayName,
-                       void *data)
-{
-  struct tids_instance *inst = (struct tids_instance *) data;
-  TR_NAME name ={(char *) displayName->value,
-                displayName->length};
-  return inst->auth_handler(clientName, &name, inst->cookie);
-}
 
-static int tids_auth_connection (struct tids_instance *inst,
-                                int conn, gss_ctx_id_t *gssctx)
-{
-  int rc = 0;
-  int auth, autherr = 0;
-  gss_buffer_desc nameBuffer = {0, NULL};
-  char *name = 0;
-  int nameLen = 0;
-
-  nameLen = asprintf(&name, "trustidentity@%s", inst->hostname);
-  nameBuffer.length = nameLen;
-  nameBuffer.value = name;
-  
-  if (rc = gsscon_passive_authenticate(conn, nameBuffer, gssctx, tids_auth_cb, inst)) {
-    fprintf(stderr, "tids_auth_connection: Error from gsscon_passive_authenticate(), rc = %d.\n", rc);
-    return -1;
-  }
+  success=1;
 
-  if (rc = gsscon_authorize(*gssctx, &auth, &autherr)) {
-    fprintf(stderr, "tids_auth_connection: Error from gsscon_authorize, rc = %d, autherr = %d.\n", 
-           rc, autherr);
-    return -1;
+cleanup:
+  if ((!success) && (resp!=NULL)) {
+    talloc_free(resp);
+    resp=NULL;
   }
-
-  if (auth)
-    fprintf(stdout, "tids_auth_connection: Connection authenticated, conn = %d.\n", conn);
-  else
-    fprintf(stderr, "tids_auth_connection: Authentication failed, conn %d.\n", conn);
-
-  return !auth;
-}
-
-static int tids_read_request (TIDS_INSTANCE *tids, int conn, gss_ctx_id_t *gssctx, TR_MSG **mreq)
-{
-  int err;
-  char *buf;
-  size_t buflen = 0;
-
-  if (err = gsscon_read_encrypted_token(conn, *gssctx, &buf, &buflen)) {
-    if (buf)
-      free(buf);
-    return -1;
-  }
-
-  fprintf(stdout, "tids_read_request():Request Received, %u bytes.\n", (unsigned) buflen);
-
-  /* Parse request */
-  if (NULL == ((*mreq) = tr_msg_decode(buf, buflen))) {
-    fprintf(stderr, "tids_read_request():Error decoding request.\n");
-    free (buf);
-    return -1;
-  }
-
-  /* If this isn't a TID Request, just drop it. */
-  if (TID_REQUEST != (*mreq)->msg_type) {
-    fprintf(stderr, "tids_read_request(): Not a TID Request, dropped.\n");
-    return -1;
-  }
-
-  free (buf);
-  return buflen;
+  return resp;
 }
 
-static int tids_handle_request (TIDS_INSTANCE *tids, TR_MSG *mreq, TID_RESP **resp) 
+static int tids_handle_request(TIDS_INSTANCE *tids, TID_REQ *req, TID_RESP *resp)
 {
-  int rc;
+  int rc=-1;
 
   /* Check that this is a valid TID Request.  If not, send an error return. */
-  if ((!mreq->tid_req) ||
-      (!mreq->tid_req->rp_realm) ||
-      (!mreq->tid_req->realm) ||
-      (!mreq->tid_req->comm)) {
-    fprintf(stderr, "tids_handle_request():Not a valid TID Request.\n");
-    (*resp)->result = TID_ERROR;
-    (*resp)->err_msg = tr_new_name("Bad request format");
+  if ((!req) ||
+      (!(req->rp_realm)) ||
+      (!(req->realm)) ||
+      (!(req->comm))) {
+    tr_notice("tids_handle_request(): Not a valid TID Request.");
+    resp->result = TID_ERROR;
+    resp->err_msg = tr_new_name("Bad request format");
     return -1;
   }
 
+  tr_debug("tids_handle_request: adding self to req path.");
+  tid_req_add_path(req, tids->hostname, tids->tids_port);
+  
   /* Call the caller's request handler */
   /* TBD -- Handle different error returns/msgs */
-  if (0 > (rc = (*tids->req_handler)(tids, mreq->tid_req, &(*resp), tids->cookie))) {
+  if (0 > (rc = (*tids->req_handler)(tids, req, resp, tids->cookie))) {
     /* set-up an error response */
-    (*resp)->result = TID_ERROR;
-    if (!(*resp)->err_msg)     /* Use msg set by handler, if any */
-      (*resp)->err_msg = tr_new_name("Internal processing error");
+    tr_debug("tids_handle_request: req_handler returned error.");
+    resp->result = TID_ERROR;
+    if (!resp->err_msg)        /* Use msg set by handler, if any */
+      resp->err_msg = tr_new_name("Internal processing error");
   }
   else {
     /* set-up a success response */
-    (*resp)->result = TID_SUCCESS;
-    (*resp)->err_msg = NULL;   /* No error msg on successful return */
+    tr_debug("tids_handle_request: req_handler returned success.");
+    resp->result = TID_SUCCESS;
+    resp->err_msg = NULL;      /* No error msg on successful return */
   }
     
   return rc;
 }
 
+/**
+ * Produces a JSON-encoded msg containing the TID response
+ *
+ * @param mem_ctx talloc context for the return value
+ * @param tids TIDS_INSTANCE handling the request
+ * @param req incoming request
+ * @param resp outgoing response
+ * @return JSON-encoded message containing the TID response
+ */
+static char *tids_encode_response(TALLOC_CTX *mem_ctx, TIDS_INSTANCE *tids, TID_REQ *req, TID_RESP *resp)
+{
+  TR_MSG mresp;
+  char *resp_buf = NULL;
+
+  /* Construct the response message */
+  mresp.msg_type = TID_RESPONSE;
+  tr_msg_set_resp(&mresp, resp);
+
+  /* Encode the message to JSON */
+  resp_buf = tr_msg_encode(mem_ctx, &mresp);
+  if (resp_buf == NULL) {
+    tr_err("tids_encode_response: Error encoding json response.");
+    return NULL;
+  }
+  tr_debug("tids_encode_response: Encoded response: %s", resp_buf);
+
+  /* Success */
+  return resp_buf;
+}
+
+/**
+ * Encode/send an error response
+ *
+ * Part of the public interface
+ *
+ * @param tids
+ * @param req
+ * @param err_msg
+ * @return
+ */
 int tids_send_err_response (TIDS_INSTANCE *tids, TID_REQ *req, const char *err_msg) {
   TID_RESP *resp = NULL;
   int rc = 0;
 
+  if ((!tids) || (!req) || (!err_msg)) {
+    tr_debug("tids_send_err_response: Invalid parameters.");
+    return -1;
+  }
+
   /* If we already sent a response, don't send another no matter what. */
   if (req->resp_sent)
     return 0;
 
-  if (NULL == (resp = tids_create_response(tids, req))) {
-    fprintf(stderr, "tids_send_err_response: Can't create response.\n");
+  if (NULL == (resp = tids_create_response(req, tids, req))) {
+    tr_crit("tids_send_err_response: Can't create response.");
     return -1;
   }
 
   /* mark this as an error response, and include the error message */
   resp->result = TID_ERROR;
   resp->err_msg = tr_new_name((char *)err_msg);
+  resp->error_path = req->path;
 
   rc = tids_send_response(tids, req, resp);
-  
-  tids_destroy_response(tids, resp);
+
+  tid_resp_free(resp);
   return rc;
 }
 
+/**
+ * Encode/send a response
+ *
+ * Part of the public interface
+ *
+ * @param tids
+ * @param req
+ * @param resp
+ * @return
+ */
 int tids_send_response (TIDS_INSTANCE *tids, TID_REQ *req, TID_RESP *resp)
 {
   int err;
-  TR_MSG mresp;
   char *resp_buf;
 
-  if ((!tids) || (!req) || (!resp))
-    fprintf (stderr, "tids_send_response: Invalid parameters.\n");
+  if ((!tids) || (!req) || (!resp)) {
+    tr_debug("tids_send_response: Invalid parameters.");
+    return -1;
+  }
 
   /* Never send a second response if we already sent one. */
   if (req->resp_sent)
     return 0;
 
-  mresp.msg_type = TID_RESPONSE;
-  mresp.tid_resp = resp;
-  
-  if (NULL == (resp_buf = tr_msg_encode(&mresp))) {
-    fprintf(stderr, "tids_send_response: Error encoding json response.\n");
+  resp_buf = tids_encode_response(NULL, tids, req, resp);
+  if (resp_buf == NULL) {
+    tr_err("tids_send_response: Error encoding json response.");
+    tr_audit_req(req);
     return -1;
   }
 
-  fprintf(stderr, "tids_send_response: Encoded response:\n%s\n", resp_buf);
-  
+  tr_debug("tids_send_response: Encoded response: %s", resp_buf);
+
+  /* If external logging is enabled, fire off a message */
+  /* TODO Can be moved to end once segfault in gsscon_write_encrypted_token fixed */
+  tr_audit_resp(resp);
+
   /* Send the response over the connection */
-  if (err = gsscon_write_encrypted_token (req->conn, req->gssctx, resp_buf, 
-                                         strlen(resp_buf) + 1)) {
-    fprintf(stderr, "tids_send_response: Error sending response over connection.\n");
+  err = gsscon_write_encrypted_token (req->conn, req->gssctx, resp_buf,
+                                            strlen(resp_buf) + 1);
+  if (err) {
+    tr_notice("tids_send_response: Error sending response over connection.");
+    tr_audit_req(req);
     return -1;
   }
 
@@ -285,116 +246,225 @@ int tids_send_response (TIDS_INSTANCE *tids, TID_REQ *req, TID_RESP *resp)
   return 0;
 }
 
-static void tids_handle_connection (TIDS_INSTANCE *tids, int conn)
+/**
+ * Callback to process a request and produce a response
+ *
+ * @param req_str JSON-encoded request
+ * @param data pointer to a TIDS_INSTANCE
+ * @return pointer to the response string or null to send no response
+ */
+static char *tids_req_cb(TALLOC_CTX *mem_ctx, const char *req_str, void *data)
 {
+  TIDS_INSTANCE *tids = talloc_get_type_abort(data, TIDS_INSTANCE);
   TR_MSG *mreq = NULL;
+  TID_REQ *req = NULL;
   TID_RESP *resp = NULL;
+  char *resp_str = NULL;
   int rc = 0;
-  gss_ctx_id_t gssctx = GSS_C_NO_CONTEXT;
 
-  if (tids_auth_connection(tids, conn, &gssctx)) {
-    fprintf(stderr, "tids_handle_connection: Error authorizing TID Server connection.\n");
-    close(conn);
-    return;
+  mreq = tr_msg_decode(req_str, strlen(req_str)); // allocates memory on success!
+  if (mreq == NULL) {
+    tr_debug("tids_req_cb: Error decoding request.");
+    return NULL;
   }
 
-  fprintf(stdout, "tids_handle_connection: Connection authorized!\n");
+  /* If this isn't a TID Request, just drop it. */
+  if (mreq->msg_type != TID_REQUEST) {
+    tr_msg_free_decoded(mreq);
+    tr_debug("tids_req_cb: Not a TID request, dropped.");
+    return NULL;
+  }
 
-  while (1) {  /* continue until an error breaks us out */
+  /* Get a handle on the request itself. Don't free req - it belongs to mreq */
+  req = tr_msg_get_req(mreq);
+
+  /* Allocate a response structure and populate common fields. The resp is in req's talloc context,
+   * which will be cleaned up when mreq is freed. */
+  resp = tids_create_response(req, tids, req);
+  if (resp == NULL) {
+    /* If we were unable to create a response, we cannot reply. Log an
+     * error if we can, then drop the request. */
+    tr_msg_free_decoded(mreq);
+    tr_crit("tids_req_cb: Error creating response structure.");
+    return NULL;
+  }
 
-    if (0 > (rc = tids_read_request(tids, conn, &gssctx, &mreq))) {
-      fprintf(stderr, "tids_handle_connection: Error from tids_read_request(), rc = %d.\n", rc);
-      return;
-    } else if (0 == rc) {
-      continue;
-    }
+  /* Handle the request and fill in resp */
+  rc = tids_handle_request(tids, req, resp);
+  if (rc < 0) {
+    tr_debug("tids_req_cb: Error from tids_handle_request(), rc = %d.", rc);
+    /* Fall through, to send the response, either way */
+  }
 
-    /* Put connection information into the request structure */
-    mreq->tid_req->conn = conn;
-    mreq->tid_req->gssctx = gssctx;
+  /* Convert the completed response into an encoded response */
+  resp_str = tids_encode_response(mem_ctx, tids, req, resp);
 
-    /* Allocate a response structure and populate common fields */
-    if (NULL == (resp = tids_create_response (tids, mreq->tid_req))) {
-      fprintf(stderr, "tids_handle_connection: Error creating response structure.\n");
-      /* try to send an error */
-      tids_send_err_response(tids, mreq->tid_req, "Error creating response.\n");
-      return;
-    }
+  /* Finished; free the request and return */
+  tr_msg_free_decoded(mreq); // this frees req and resp, too
+  return resp_str;
+}
 
-    if (0 > (rc = tids_handle_request(tids, mreq, &resp))) {
-      fprintf(stderr, "tids_handle_connection: Error from tids_handle_request(), rc = %d.\n", rc);
-      /* Fall through, to send the response, either way */
-    }
+TIDS_INSTANCE *tids_new(TALLOC_CTX *mem_ctx)
+{
+  return talloc_zero(mem_ctx, TIDS_INSTANCE);
+}
 
-    if (0 > (rc = tids_send_response(tids, mreq->tid_req, resp))) {
-      fprintf(stderr, "tids_handle_connection: Error from tids_send_response(), rc = %d.\n", rc);
-      /* if we didn't already send a response, try to send a generic error. */
-      if (!mreq->tid_req->resp_sent)
-       tids_send_err_response(tids, mreq->tid_req, "Error sending response.\n");
-      /* Fall through to free the response, either way. */
-    }
+/**
+ * Create a new TIDS instance
+ *
+ * Deprecated: exists for ABI compatibility, but tids_new() should be used instead
+ *
+ */
+TIDS_INSTANCE *tids_create(void)
+{
+  return talloc_zero(NULL, TIDS_INSTANCE);
+}
+/* Get a listener for tids requests, returns its socket fd. Accept
+ * connections with tids_accept() */
+nfds_t tids_get_listener(TIDS_INSTANCE *tids,
+                         TIDS_REQ_FUNC *req_handler,
+                         tids_auth_func *auth_handler,
+                         const char *hostname,
+                         unsigned int port,
+                         void *cookie,
+                         int *fd_out,
+                         size_t max_fd)
+{
+  nfds_t n_fd = 0;
+  nfds_t ii = 0;
+
+  tids->tids_port = port;
+  n_fd = tr_sock_listen_all(port, fd_out, max_fd);
+
+  if (n_fd == 0)
+    tr_err("tids_get_listener: Error opening port %d");
+  else {
+    /* opening port succeeded */
+    tr_info("tids_get_listener: Opened port %d.", port);
     
-    tids_destroy_response(tids, resp);
-    return;
-  } 
+    /* make this socket non-blocking */
+    for (ii=0; ii<n_fd; ii++) {
+      if (0 != fcntl(fd_out[ii], F_SETFL, O_NONBLOCK)) {
+        tr_err("tids_get_listener: Error setting O_NONBLOCK.");
+        for (ii=0; ii<n_fd; ii++) {
+          close(fd_out[ii]);
+          fd_out[ii]=-1;
+        }
+        n_fd = 0;
+        break;
+      }
+    }
+  }
+
+  if (n_fd > 0) {
+    /* store the caller's request handler & cookie */
+    tids->req_handler = req_handler;
+    tids->auth_handler = auth_handler;
+    tids->hostname = hostname;
+    tids->cookie = cookie;
+  }
+
+  return (int)n_fd;
 }
 
-TIDS_INSTANCE *tids_create (void)
+/* Accept and process a connection on a port opened with tids_get_listener() */
+int tids_accept(TIDS_INSTANCE *tids, int listen)
 {
-  TIDS_INSTANCE *tids = NULL;
-  if (tids = malloc(sizeof(TIDS_INSTANCE)))
-    memset(tids, 0, sizeof(TIDS_INSTANCE));
-  return tids;
+  int conn=-1;
+  int pid=-1;
+
+  if (0 > (conn = accept(listen, NULL, NULL))) {
+    perror("Error from TIDS Server accept()");
+    return 1;
+  }
+
+  if (0 > (pid = fork())) {
+    perror("Error on fork()");
+    return 1;
+  }
+
+  if (pid == 0) {
+    close(listen);
+    tr_gss_handle_connection(conn,
+                             "trustidentity", tids->hostname, /* acceptor name */
+                             tids->auth_handler, tids->cookie, /* auth callback and cookie */
+                             tids_req_cb, tids /* req callback and cookie */
+    );
+    close(conn);
+    exit(0); /* exit to kill forked child process */
+  } else {
+    close(conn);
+  }
+
+  /* clean up any processes that have completed  (TBD: move to main loop?) */
+  while (waitpid(-1, 0, WNOHANG) > 0);
+
+  return 0;
 }
 
-int tids_start (TIDS_INSTANCE *tids, 
-               TIDS_REQ_FUNC *req_handler,
-               tids_auth_func *auth_handler,
-               const char *hostname,
-               void *cookie)
+/* Process tids requests forever. Should not return except on error. */
+int tids_start (TIDS_INSTANCE *tids,
+                TIDS_REQ_FUNC *req_handler,
+                tids_auth_func *auth_handler,
+                const char *hostname,
+                unsigned int port,
+                void *cookie)
 {
-  int listen = -1;
-  int conn = -1;
-  pid_t pid;
+  int fd[TR_MAX_SOCKETS]={0};
+  nfds_t n_fd=0;
+  struct pollfd poll_fd[TR_MAX_SOCKETS]={{0}};
+  int ii=0;
 
-  if (0 > (listen = tids_listen(tids, TID_PORT)))
+  n_fd = tids_get_listener(tids, req_handler, auth_handler, hostname, port, cookie, fd, TR_MAX_SOCKETS);
+  if (n_fd <= 0) {
     perror ("Error from tids_listen()");
+    return 1;
+  }
 
-  /* store the caller's request handler & cookie */
-  tids->req_handler = req_handler;
-  tids->auth_handler = auth_handler;
-  tids->hostname = hostname;
-  tids->cookie = cookie;
+  tr_info("Trust Path Query Server starting on host %s:%d.", hostname, port);
+
+  /* set up the poll structs */
+  for (ii=0; ii<n_fd; ii++) {
+    poll_fd[ii].fd=fd[ii];
+    poll_fd[ii].events=POLLIN;
+  }
 
   while(1) {   /* accept incoming conns until we are stopped */
+    /* clear out events from previous iteration */
+    for (ii=0; ii<n_fd; ii++)
+      poll_fd[ii].revents=0;
 
-    if (0 > (conn = accept(listen, NULL, NULL))) {
-      perror("Error from TIDS Server accept()");
+    /* wait indefinitely for a connection */
+    if (poll(poll_fd, n_fd, -1) < 0) {
+      perror("Error from poll()");
       return 1;
     }
 
-    if (0 > (pid = fork())) {
-      perror("Error on fork()");
-      return 1;
-    }
+    /* fork handlers for any sockets that have data */
+    for (ii=0; ii<n_fd; ii++) {
+      if (poll_fd[ii].revents == 0)
+        continue;
+
+      if ((poll_fd[ii].revents & POLLERR) || (poll_fd[ii].revents & POLLNVAL)) {
+        perror("Error polling fd");
+        continue;
+      }
 
-    if (pid == 0) {
-      close(listen);
-      tids_handle_connection(tids, conn);
-      close(conn);
-      return 0;
-    } else {
-      close(conn);
+      if (poll_fd[ii].revents & POLLIN) {
+        if (tids_accept(tids, poll_fd[ii].fd))
+          tr_err("tids_start: error in tids_accept().");
+      }
     }
   }
 
-  return 1;    /* should never get here */
+  return 1;    /* should never get here, loops "forever" */
 }
 
 void tids_destroy (TIDS_INSTANCE *tids)
 {
+  /* clean up logfiles */
+  tr_log_close();
+
   if (tids)
     free(tids);
 }
-
-