Code

frontend: Send connection-related log messages to the client.
authorSebastian Harl <sh@tokkee.org>
Thu, 6 Feb 2014 19:12:38 +0000 (20:12 +0100)
committerSebastian Harl <sh@tokkee.org>
Thu, 6 Feb 2014 19:12:38 +0000 (20:12 +0100)
This is done by registering a logging callback which will send all messages
originating from a thread currently handling a connection to the respective
client. For this, the connection object is stored in a thread-specific data
segment.

src/frontend/connection.c
src/include/frontend/connection.h
src/include/frontend/proto.h
src/tools/sysdbd/main.c

index 24735de2f0e55fac5ce8f7313445068f0ce9263e..4ba12dcdd568cf0449c45de60b3984607e5ce17d 100644 (file)
@@ -27,6 +27,7 @@
 
 #include "sysdb.h"
 #include "core/object.h"
+#include "core/plugin.h"
 #include "frontend/connection-private.h"
 #include "utils/error.h"
 #include "utils/strbuf.h"
 #include <arpa/inet.h>
 #include <fcntl.h>
 
+#include <stdlib.h>
 #include <string.h>
 
+#include <pthread.h>
+
+/*
+ * private variables
+ */
+
+static pthread_key_t conn_ctx_key;
+static _Bool         conn_ctx_key_initialized = 0;
+
 /*
- * private data types
+ * private types
  */
 
 /* name of connection objects */
@@ -145,10 +156,74 @@ static sdb_type_t connection_type = {
        /* destroy = */ connection_destroy,
 };
 
+/*
+ * private helper functions
+ */
+
+static void
+sdb_conn_ctx_destructor(void *c)
+{
+       sdb_object_t *conn = c;
+
+       if (! conn)
+               return;
+       sdb_object_deref(conn);
+} /* sdb_conn_ctx_destructor */
+
+static void
+sdb_conn_ctx_init(void)
+{
+       if (conn_ctx_key_initialized)
+               return;
+
+       pthread_key_create(&conn_ctx_key, sdb_conn_ctx_destructor);
+       conn_ctx_key_initialized = 1;
+} /* sdb_conn_ctx_init */
+
+static void
+sdb_conn_set_ctx(sdb_conn_t *conn)
+{
+       sdb_conn_ctx_init();
+       if (conn)
+               sdb_object_ref(SDB_OBJ(conn));
+       pthread_setspecific(conn_ctx_key, conn);
+} /* sdb_conn_set_ctx */
+
+static sdb_conn_t *
+sdb_conn_get_ctx(void)
+{
+       if (! conn_ctx_key_initialized)
+               return NULL;
+       return pthread_getspecific(conn_ctx_key);
+} /* sdb_conn_get_ctx */
+
 /*
  * connection handler functions
  */
 
+/*
+ * connection_log:
+ * Send a log message originating from the current thread to the client.
+ */
+static int
+connection_log(int __attribute__((unused)) prio, const char *msg,
+               sdb_object_t __attribute__((unused)) *user_data)
+{
+       sdb_conn_t *conn;
+
+       conn = sdb_conn_get_ctx();
+       /* no connection associated to this thread
+        * or user not authenticated yet => don't leak any information */
+       if ((! conn) || (! conn->username))
+               return 0;
+
+       /* TODO: Use CONNECTION_LOG_<prio>? */
+       if (sdb_connection_send(conn, CONNECTION_LOG,
+                               (uint32_t)strlen(msg), msg) < 0)
+               return -1;
+       return 0;
+} /* connection_log */
+
 static uint32_t
 connection_get_int32(sdb_conn_t *conn, size_t offset)
 {
@@ -303,6 +378,13 @@ connection_read(sdb_conn_t *conn)
  * public API
  */
 
+int
+sdb_connection_enable_logging(void)
+{
+       return sdb_plugin_register_log("connection-logger", connection_log,
+                       /* user_data = */ NULL);
+} /* sdb_connection_enable_logging */
+
 sdb_conn_t *
 sdb_connection_accept(int fd)
 {
@@ -326,6 +408,8 @@ sdb_connection_read(sdb_conn_t *conn)
 {
        ssize_t n = 0;
 
+       sdb_conn_set_ctx(conn);
+
        while (42) {
                ssize_t status = connection_read(conn);
 
@@ -341,6 +425,8 @@ sdb_connection_read(sdb_conn_t *conn)
 
                n += status;
        }
+
+       sdb_conn_set_ctx(NULL);
        return n;
 } /* sdb_connection_read */
 
index 45d377e10df2ffb9ff28220b9c331f0410e47e0a..dc93db6c782ed46ddb03bfae613445dc78815973 100644 (file)
@@ -52,6 +52,20 @@ typedef struct {
 } sdb_conn_node_t;
 #define SDB_CONN_NODE(obj) ((sdb_conn_node_t *)(obj))
 
+/*
+ * sdb_connection_enable_logging:
+ * Enable logging of connection-related messages to the current client
+ * connection. After this function has been called all log messages
+ * originating from the thread handling the current client connection will
+ * also be sent to the client.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_connection_enable_logging(void);
+
 /*
  * sdb_connection_accpet:
  * Accept a new connection on the specified file-descriptor 'fd' and return a
index fd78c26cf61833bd5ac07cc40a17217982c71fdb..af336d535f6bfb91bf2bf93e18c98fe8b7994390 100644 (file)
@@ -35,7 +35,9 @@ extern "C" {
 /* status codes returned to a client */
 typedef enum {
        CONNECTION_OK = 0,
-       CONNECTION_ERROR
+       CONNECTION_ERROR,
+
+       CONNECTION_LOG,
 } sdb_conn_status_t;
 
 /* accepted commands / state of the connection */
index 2e35c16b5d3e029f643c44933b1d8a8be69a4cc3..ca1c50de3866318efefe06f399539d65a762f35d 100644 (file)
@@ -34,6 +34,7 @@
 #include "core/store.h"
 #include "utils/error.h"
 
+#include "frontend/connection.h"
 #include "frontend/sock.h"
 
 #include "tools/sysdbd/configfile.h"
@@ -278,6 +279,8 @@ main(int argc, char **argv)
                        if (sdb_fe_sock_add_listener(sock, listen_addresses[i]))
                                break;
 
+               sdb_connection_enable_logging();
+
                /* break on error */
                if (i >= listen_addresses_num)
                        sdb_fe_sock_listen_and_serve(sock, &frontend_main_loop);