First draft of the libosl patch series.
[paraslash.git] / client_common.c
index 5a55546..5bce7fb 100644 (file)
@@ -1,12 +1,16 @@
 /*
- * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file client_common.c common functions of para_client and para_audiod */
+/** \file client_common.c Common functions of para_client and para_audiod. */
+
+#include <sys/types.h>
+#include <dirent.h>
 
 #include "para.h"
+#include "error.h"
 #include "list.h"
 #include "sched.h"
 #include "client.cmdline.h"
 #include "string.h"
 #include "client.cmdline.h"
 #include "client.h"
-#include "error.h"
 
 /*
- * rc4 encrypt data before sending
+ * Rc4-encrypt data before sending.
  *
- * \param len the number of bytes to encrypt
- * \param indata pointer to the input data of length \a len to be encrypted
- * \param outdata pointer that holds the encrypted data after return
- * \param private_data pointer to the private client data containing
- * the rc4 key
- * */
+ * \param len The number of bytes to encrypt.
+ * \param indata Pointer to the input data of length \a len to be encrypted.
+ * \param outdata Result-pointer that holds the encrypted data.
+ * \param private_data Contains the rc4 key.
+ */
 static void rc4_send(unsigned long len, const unsigned char *indata,
                unsigned char *outdata, void *private_data)
 {
-       struct private_client_data *pcd = private_data;
-       RC4(&pcd->rc4_send_key, len, indata, outdata);
+       struct client_task *ct = private_data;
+       RC4(&ct->rc4_send_key, len, indata, outdata);
 }
 
 /*
- * rc4 decrypt received data
+ * Rc4-decrypt received data.
  *
- * \param len the number of bytes to decrypt
- * \param indata pointer to the input data of length \a len
- * \param outdata pointer that holds the decrypted data after return
- * \param private_data pointer to the private client data containing
- * the rc4 key
- * */
+ * Parameters are identical to those of rc4_send.
+ */
 static void rc4_recv(unsigned long len, const unsigned char *indata,
                unsigned char *outdata, void *private_data)
 {
-       struct private_client_data *pcd = private_data;
-       RC4(&pcd->rc4_recv_key, len, indata, outdata);
+       struct client_task *ct = private_data;
+       RC4(&ct->rc4_recv_key, len, indata, outdata);
 }
 
 /**
- * close the connection to para_server and free all resources
+ * Close the connection to para_server and free all resources.
  *
- * \param pcd pointer to the client data
+ * \param ct Pointer to the client data.
  *
  * \sa client_open.
- * */
-void client_close(struct private_client_data *pcd)
-{
-       if (!pcd)
-               return;
-       if (pcd->fd >= 0) {
-               disable_crypt(pcd->fd);
-               close(pcd->fd);
-       }
-       free(pcd->user);
-       free(pcd->config_file);
-       free(pcd->key_file);
-       client_cmdline_parser_free(&pcd->conf);
-       free(pcd);
-}
-
-static int client_connect(struct private_client_data *pcd)
-{
-       int ret;
-       struct hostent *he;
-       struct sockaddr_in their_addr;
-
-       pcd->fd = -1;
-       ret = get_host_info(pcd->conf.hostname_arg, &he);
-       if (ret < 0)
-               return ret;
-       /* get new socket */
-       ret = get_stream_socket(AF_INET);
-       if (ret < 0)
-               return ret;
-       pcd->fd = ret;
-       /* init their_addr */
-       init_sockaddr(&their_addr, pcd->conf.server_port_arg, he);
-       ret = para_connect(pcd->fd, &their_addr);
-       if (ret < 0)
-               goto err_out;
-       pcd->status = CL_CONNECTED;
-       ret = mark_fd_nonblock(pcd->fd);
-       if (ret < 0)
-               goto err_out;
-       pcd->task.pre_select = client_pre_select;
-       pcd->task.post_select = client_post_select;
-       pcd->task.private_data = pcd;
-       sprintf(pcd->task.status, "client");
-       register_task(&pcd->task);
-       return 1;
-err_out:
-       close(pcd->fd);
-       pcd->fd = -1;
-       return ret;
-}
-
-/**
- * open connection to para_server
- *
- * \param argc usual argument count
- * \param argv usual argument vector
- * \param pcd_ptr points to dynamically allocated and initialized private client data
- * upon successful return
- *
- * Check the command line options given by \a argc and argv, set default values
- * for user name and rsa key file, read further option from the config file.
- * Finally, establish a connection to para_server.
- *
- * \return Positive on success, negative on errors.
  */
-int client_open(int argc, char *argv[], struct private_client_data **pcd_ptr)
+void client_close(struct client_task *ct)
 {
-       char *home = para_homedir();
-       struct stat statbuf;
-       int ret;
-       struct private_client_data *pcd =
-               para_calloc(sizeof(struct private_client_data));
-
-       *pcd_ptr = pcd;
-       pcd->fd = -1;
-       ret = client_cmdline_parser(argc, argv, &pcd->conf);
-       HANDLE_VERSION_FLAG("client", pcd->conf);
-       ret = -E_CLIENT_SYNTAX;
-       if (!pcd->conf.inputs_num)
-               goto out;
-       pcd->user = pcd->conf.user_given?
-               para_strdup(pcd->conf.user_arg) : para_logname();
-
-       pcd->key_file = pcd->conf.key_file_given?
-               para_strdup(pcd->conf.key_file_arg) :
-               make_message("%s/.paraslash/key.%s", home, pcd->user);
-
-       pcd->config_file = pcd->conf.config_file_given?
-               para_strdup(pcd->conf.config_file_arg) :
-               make_message("%s/.paraslash/client.conf", home);
-       ret = stat(pcd->config_file, &statbuf);
-       if (ret && pcd->conf.config_file_given) {
-               ret = -E_NO_CONFIG;
-               goto out;
-       }
-       if (!ret) {
-               struct client_cmdline_parser_params params = {
-                       .override = 0,
-                       .initialize = 0,
-                       .check_required = 0,
-                       .check_ambiguity = 0
-               };
-               client_cmdline_parser_config_file(pcd->config_file,
-                       &pcd->conf, &params);
-       }
-       ret = 1;
-       PARA_INFO_LOG("loglevel: %d\n", pcd->conf.loglevel_arg);
-       PARA_INFO_LOG("config_file: %s\n", pcd->config_file);
-       PARA_INFO_LOG("key_file: %s\n", pcd->key_file);
-       PARA_NOTICE_LOG("connecting %s:%d\n", pcd->conf.hostname_arg,
-               pcd->conf.server_port_arg);
-       ret = client_connect(pcd);
-out:
-       free(home);
-       if (ret < 0) {
-               PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
-               client_close(pcd);
-               *pcd_ptr = NULL;
+       if (!ct)
+               return;
+       if (ct->fd >= 0) {
+               disable_crypt(ct->fd);
+               close(ct->fd);
        }
-       return ret;
+       free(ct->buf);
+       free(ct->user);
+       free(ct->config_file);
+       free(ct->key_file);
+       client_cmdline_parser_free(&ct->conf);
+       free(ct);
 }
 
 /**
- * the preselect hook for server commands
+ * The preselect hook for server commands.
  *
- * \param s pointer to the scheduler
- * \param t pointer to the task struct for this command
+ * \param s Pointer to the scheduler.
+ * \param t Pointer to the task struct for this command.
  *
  * The task pointer must contain a pointer to the initialized client data
  * structure as it is returned by client_open().
@@ -192,47 +84,48 @@ out:
  * This function checks the state of the connection and adds the file descriptor
  * of the connection to the read or write fd set of \a s accordingly.
  *
- * \sa register_task() client_open(), struct sched, struct task
+ * \sa register_task() client_open(), struct sched, struct task.
  */
-void client_pre_select(struct sched *s, struct task *t)
+static void client_pre_select(struct sched *s, struct task *t)
 {
-       struct private_client_data *pcd = t->private_data;
+       struct client_task *ct = container_of(t, struct client_task, task);
 
-       t->ret = 1;
-       pcd->check_r = 0;
-       pcd->check_w = 0;
-       if (pcd->fd < 0)
+       ct->check_r = 0;
+       ct->check_w = 0;
+       if (ct->fd < 0)
                return;
-       switch (pcd->status) {
+       switch (ct->status) {
        case CL_CONNECTED:
        case CL_SENT_AUTH:
        case CL_SENT_CH_RESPONSE:
        case CL_SENT_COMMAND:
-               para_fd_set(pcd->fd, &s->rfds, &s->max_fileno);
-               pcd->check_r = 1;
+               para_fd_set(ct->fd, &s->rfds, &s->max_fileno);
+               ct->check_r = 1;
                return;
 
        case CL_RECEIVED_WELCOME:
        case CL_RECEIVED_CHALLENGE:
        case CL_RECEIVED_PROCEED:
-               para_fd_set(pcd->fd, &s->wfds, &s->max_fileno);
-               pcd->check_w = 1;
+               para_fd_set(ct->fd, &s->wfds, &s->max_fileno);
+               ct->check_w = 1;
                return;
 
        case CL_RECEIVING:
-               if (pcd->loaded < CLIENT_BUFSIZE - 1) {
-                       para_fd_set(pcd->fd, &s->rfds, &s->max_fileno);
-                       pcd->check_r = 1;
+               if (ct->loaded < CLIENT_BUFSIZE - 1) {
+                       para_fd_set(ct->fd, &s->rfds, &s->max_fileno);
+                       ct->check_r = 1;
                }
                return;
        case CL_SENDING:
-               if (*pcd->in_loaded) {
-                       PARA_INFO_LOG("loaded: %zd\n", *pcd->in_loaded);
-                       para_fd_set(pcd->fd, &s->wfds, &s->max_fileno);
-                       pcd->check_w = 1;
+               if (!ct->in_loaded) /* stdin task not yet started */
+                       return;
+               if (*ct->in_loaded) {
+                       PARA_INFO_LOG("loaded: %zd\n", *ct->in_loaded);
+                       para_fd_set(ct->fd, &s->wfds, &s->max_fileno);
+                       ct->check_w = 1;
                } else {
-                       if (*pcd->in_eof) {
-                               t->ret = -E_INPUT_EOF;
+                       if (*ct->in_error) {
+                               t->error = *ct->in_error;
                                s->timeout.tv_sec = 0;
                                s->timeout.tv_usec = 1;
                        }
@@ -241,150 +134,252 @@ void client_pre_select(struct sched *s, struct task *t)
        }
 }
 
-static ssize_t client_recv_buffer(struct private_client_data *pcd)
+static ssize_t client_recv_buffer(struct client_task *ct)
 {
-       ssize_t ret = recv_buffer(pcd->fd, pcd->buf + pcd->loaded,
-               CLIENT_BUFSIZE - pcd->loaded);
+       ssize_t ret = recv_buffer(ct->fd, ct->buf + ct->loaded,
+               CLIENT_BUFSIZE - ct->loaded);
        if (!ret)
                return -E_SERVER_EOF;
        if (ret > 0)
-               pcd->loaded += ret;
+               ct->loaded += ret;
        return ret;
 
 }
 
 /**
- * the post select hook for client commands
+ * The post select hook for client commands.
  *
- * \param s pointer to the scheduler
- * \param t pointer to the task struct for this command
+ * \param s Pointer to the scheduler.
+ * \param t Pointer to the task struct for this command.
  *
  * Depending on the current state of the connection and the status of the read
- * and write fd sets of \a s, this function performs the neccessary steps to
- * authenticate the connection, to send the commmand given by \a
- * t->private_data and to receive para_server's output, if any.
+ * and write fd sets of \a s, this function performs the necessary steps to
+ * authenticate the connection, to send the command given by \a t->private_data
+ * and to receive para_server's output, if any.
  *
- * \sa struct sched, struct task
+ * \sa struct sched, struct task.
  */
-void client_post_select(struct sched *s, struct task *t)
+static void client_post_select(struct sched *s, struct task *t)
 {
-       struct private_client_data *pcd = t->private_data;
+       struct client_task *ct = container_of(t, struct client_task, task);
 
-//     PARA_INFO_LOG("status %d\n", pcd->status);
-       t->ret = 1;
-       if (pcd->fd < 0)
+       t->error = 0;
+       if (ct->fd < 0)
                return;
-       if (!pcd->check_r && !pcd->check_w)
+       if (!ct->check_r && !ct->check_w)
                return;
-       if (pcd->check_r && !FD_ISSET(pcd->fd, &s->rfds))
+       if (ct->check_r && !FD_ISSET(ct->fd, &s->rfds))
                return;
-       if (pcd->check_w && !FD_ISSET(pcd->fd, &s->wfds))
+       if (ct->check_w && !FD_ISSET(ct->fd, &s->wfds))
                return;
-       switch (pcd->status) {
+       switch (ct->status) {
        case CL_CONNECTED: /* receive welcome message */
-               t->ret = client_recv_buffer(pcd);
-               if (t->ret > 0)
-                       pcd->status = CL_RECEIVED_WELCOME;
+               t->error = client_recv_buffer(ct);
+               if (t->error > 0)
+                       ct->status = CL_RECEIVED_WELCOME;
                return;
        case CL_RECEIVED_WELCOME: /* send auth command */
-               sprintf(pcd->buf, "auth %s%s", pcd->conf.plain_given?
-                       "" : "rc4 ", pcd->user);
-               PARA_INFO_LOG("--> %s\n", pcd->buf);
-               t->ret = send_buffer(pcd->fd, pcd->buf);
-               if (t->ret >= 0)
-                       pcd->status = CL_SENT_AUTH;
+               sprintf(ct->buf, "auth %s%s", ct->conf.plain_given?
+                       "" : "rc4 ", ct->user);
+               PARA_INFO_LOG("--> %s\n", ct->buf);
+               t->error = send_buffer(ct->fd, ct->buf);
+               if (t->error >= 0)
+                       ct->status = CL_SENT_AUTH;
                return;
        case CL_SENT_AUTH: /* receive challenge number */
-               pcd->loaded = 0;
-               t->ret = client_recv_buffer(pcd);
-               if (t->ret < 0)
+               ct->loaded = 0;
+               t->error = client_recv_buffer(ct);
+               if (t->error < 0)
                        return;
-               if (t->ret != 64) {
-                       t->ret = -E_INVALID_CHALLENGE;
-                       PARA_ERROR_LOG("received the following: %s\n", pcd->buf);
+               if (t->error != 64) {
+                       t->error = -E_INVALID_CHALLENGE;
+                       PARA_ERROR_LOG("received the following: %s\n", ct->buf);
                        return;
                }
-               PARA_INFO_LOG("%s", "<-- [challenge]\n");
+               PARA_INFO_LOG("<-- [challenge]\n");
                /* decrypt challenge number */
-               t->ret = para_decrypt_challenge(pcd->key_file, &pcd->challenge_nr,
-                       (unsigned char *) pcd->buf, 64);
-               if (t->ret > 0)
-                       pcd->status = CL_RECEIVED_CHALLENGE;
+               t->error = para_decrypt_challenge(ct->key_file, &ct->challenge_nr,
+                       (unsigned char *) ct->buf, 64);
+               if (t->error > 0)
+                       ct->status = CL_RECEIVED_CHALLENGE;
                return;
        case CL_RECEIVED_CHALLENGE: /* send decrypted challenge */
-               PARA_INFO_LOG("--> %lu\n", pcd->challenge_nr);
-               t->ret = send_va_buffer(pcd->fd, "%s%lu", CHALLENGE_RESPONSE_MSG,
-                       pcd->challenge_nr);
-               if (t->ret > 0)
-                       pcd->status = CL_SENT_CH_RESPONSE;
+               PARA_INFO_LOG("--> %lu\n", ct->challenge_nr);
+               t->error = send_va_buffer(ct->fd, "%s%lu", CHALLENGE_RESPONSE_MSG,
+                       ct->challenge_nr);
+               if (t->error > 0)
+                       ct->status = CL_SENT_CH_RESPONSE;
                return;
        case CL_SENT_CH_RESPONSE: /* read server response */
                {
                size_t bytes_received;
                unsigned char rc4_buf[2 * RC4_KEY_LEN] = "";
-               pcd->loaded = 0;
-               t->ret = client_recv_buffer(pcd);
-               if (t->ret < 0)
+               ct->loaded = 0;
+               t->error = client_recv_buffer(ct);
+               if (t->error < 0)
                        return;
-               bytes_received = t->ret;
+               bytes_received = t->error;
                PARA_DEBUG_LOG("++++ server info ++++\n%s\n++++ end of server "
-                       "info ++++\n", pcd->buf);
+                       "info ++++\n", ct->buf);
                /* check if server has sent "Proceed" message */
-               t->ret = -E_CLIENT_AUTH;
-               if (!strstr(pcd->buf, PROCEED_MSG))
+               t->error = -E_CLIENT_AUTH;
+               if (!strstr(ct->buf, PROCEED_MSG))
                        return;
-               t->ret = 1;
-               pcd->status = CL_RECEIVED_PROCEED;
+               t->error = 0;
+               ct->status = CL_RECEIVED_PROCEED;
                if (bytes_received < PROCEED_MSG_LEN + 32)
                        return;
-               PARA_INFO_LOG("%s", "decrypting session key\n");
-               t->ret = para_decrypt_buffer(pcd->key_file, rc4_buf,
-                       (unsigned char *)pcd->buf + PROCEED_MSG_LEN + 1,
+               PARA_INFO_LOG("decrypting session key\n");
+               t->error = para_decrypt_buffer(ct->key_file, rc4_buf,
+                       (unsigned char *)ct->buf + PROCEED_MSG_LEN + 1,
                        bytes_received - PROCEED_MSG_LEN - 1);
-               if (t->ret < 0)
+               if (t->error < 0)
                        return;
-               RC4_set_key(&pcd->rc4_send_key, RC4_KEY_LEN, rc4_buf);
-               RC4_set_key(&pcd->rc4_recv_key, RC4_KEY_LEN, rc4_buf + RC4_KEY_LEN);
-               enable_crypt(pcd->fd, rc4_recv, rc4_send, pcd);
+               RC4_set_key(&ct->rc4_send_key, RC4_KEY_LEN, rc4_buf);
+               RC4_set_key(&ct->rc4_recv_key, RC4_KEY_LEN, rc4_buf + RC4_KEY_LEN);
+               enable_crypt(ct->fd, rc4_recv, rc4_send, ct);
                }
        case CL_RECEIVED_PROCEED: /* concat args and send command */
                {
                int i;
                char *command = NULL;
-               for (i = 0; i < pcd->conf.inputs_num; i++) {
+               for (i = 0; i < ct->conf.inputs_num; i++) {
                        char *tmp = command;
                        command = make_message("%s\n%s", command?
-                               command : "", pcd->conf.inputs[i]);
+                               command : "", ct->conf.inputs[i]);
                        free(tmp);
                }
                command = para_strcat(command, EOC_MSG "\n");
                PARA_DEBUG_LOG("--> %s\n", command);
-               t->ret = send_buffer(pcd->fd, command);
+               t->error = send_buffer(ct->fd, command);
                free(command);
-               if (t->ret > 0)
-                       pcd->status = CL_SENT_COMMAND;
+               if (t->error > 0)
+                       ct->status = CL_SENT_COMMAND;
                return;
                }
        case CL_SENT_COMMAND:
-               pcd->loaded = 0;
-               t->ret = client_recv_buffer(pcd);
-               if (t->ret < 0)
+               ct->loaded = 0;
+               t->error = client_recv_buffer(ct);
+               if (t->error < 0)
                        return;
-               t->ret = -E_HANDSHAKE_COMPLETE;
-               if (strstr(pcd->buf, AWAITING_DATA_MSG))
-                       pcd->status = CL_SENDING;
+               if (strstr(ct->buf, AWAITING_DATA_MSG))
+                       ct->status = CL_SENDING;
                else
-                       pcd->status = CL_RECEIVING;
+                       ct->status = CL_RECEIVING;
                return;
        case CL_SENDING: /* FIXME: might block */
-               PARA_INFO_LOG("loaded: %zd\n", *pcd->in_loaded);
-               t->ret = send_bin_buffer(pcd->fd, pcd->inbuf, *pcd->in_loaded);
-               if (t->ret < 0)
+               PARA_INFO_LOG("loaded: %zd\n", *ct->in_loaded);
+               t->error = send_bin_buffer(ct->fd, ct->inbuf, *ct->in_loaded);
+               if (t->error < 0)
                        return;
-               *pcd->in_loaded = 0; /* FIXME: short writes */
+               *ct->in_loaded = 0;
                return;
        case CL_RECEIVING:
-               t->ret = client_recv_buffer(pcd);
+               t->error = client_recv_buffer(ct);
                return;
        }
 }
+
+/* connect to para_server and register the client task */
+static int client_connect(struct client_task *ct)
+{
+       int ret;
+
+       ct->fd = -1;
+       ret = makesock(AF_UNSPEC, IPPROTO_TCP, 0, ct->conf.hostname_arg,
+               ct->conf.server_port_arg);
+       if (ret < 0)
+               return ret;
+       ct->fd = ret;
+       ct->status = CL_CONNECTED;
+       ret = mark_fd_nonblocking(ct->fd);
+       if (ret < 0)
+               goto err_out;
+       ct->task.pre_select = client_pre_select;
+       ct->task.post_select = client_post_select;
+       sprintf(ct->task.status, "client");
+       register_task(&ct->task);
+       return 1;
+err_out:
+       close(ct->fd);
+       ct->fd = -1;
+       return ret;
+}
+
+/**
+ * Open connection to para_server.
+ *
+ * \param argc Usual argument count.
+ * \param argv Usual argument vector.
+ * \param ct_ptr Points to dynamically allocated and initialized client task
+ * struct upon successful return.
+ * \param loglevel If not \p NULL, the number of the loglevel is stored here.
+ *
+ * Check the command line options given by \a argc and argv, set default values
+ * for user name and rsa key file, read further option from the config file.
+ * Finally, establish a connection to para_server.
+ *
+ * \return Standard.
+ */
+int client_open(int argc, char *argv[], struct client_task **ct_ptr,
+               int *loglevel)
+{
+       char *home = para_homedir();
+       int ret;
+       struct client_task *ct = para_calloc(sizeof(struct client_task));
+
+       ct->buf = para_malloc(CLIENT_BUFSIZE);
+       *ct_ptr = ct;
+       ct->fd = -1;
+       ret = -E_CLIENT_SYNTAX;
+       if (client_cmdline_parser(argc, argv, &ct->conf))
+               goto out;
+       HANDLE_VERSION_FLAG("client", ct->conf);
+       ret = -E_CLIENT_SYNTAX;
+       if (!ct->conf.inputs_num)
+               goto out;
+       ct->user = ct->conf.user_given?
+               para_strdup(ct->conf.user_arg) : para_logname();
+
+       ct->key_file = ct->conf.key_file_given?
+               para_strdup(ct->conf.key_file_arg) :
+               make_message("%s/.paraslash/key.%s", home, ct->user);
+
+       ct->config_file = ct->conf.config_file_given?
+               para_strdup(ct->conf.config_file_arg) :
+               make_message("%s/.paraslash/client.conf", home);
+       ret = file_exists(ct->config_file);
+       if (!ret && ct->conf.config_file_given) {
+               ret = -E_NO_CONFIG;
+               goto out;
+       }
+       if (ret) {
+               struct client_cmdline_parser_params params = {
+                       .override = 0,
+                       .initialize = 0,
+                       .check_required = 0,
+                       .check_ambiguity = 0,
+                       .print_errors = 0
+               };
+               ret = -E_BAD_CONFIG;
+               if (client_cmdline_parser_config_file(ct->config_file,
+                       &ct->conf, &params))
+                       goto out;
+       }
+       if (loglevel)
+               *loglevel = get_loglevel_by_name(ct->conf.loglevel_arg);
+       PARA_INFO_LOG("loglevel: %s\n", ct->conf.loglevel_arg);
+       PARA_INFO_LOG("config_file: %s\n", ct->config_file);
+       PARA_INFO_LOG("key_file: %s\n", ct->key_file);
+       PARA_NOTICE_LOG("connecting %s:%d\n", ct->conf.hostname_arg,
+               ct->conf.server_port_arg);
+       ret = client_connect(ct);
+out:
+       free(home);
+       if (ret < 0) {
+               PARA_ERROR_LOG("%s\n", para_strerror(-ret));
+               client_close(ct);
+               *ct_ptr = NULL;
+       }
+       return ret;
+}