2 * Copyright (C) 1997-2014 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file client_common.c Common functions of para_client and para_audiod. */
9 #include <netinet/in.h>
10 #include <sys/socket.h>
12 #include <sys/types.h>
13 #include <arpa/inet.h>
26 #include "client.cmdline.h"
28 #include "buffer_tree.h"
32 /** The size of the receiving buffer. */
33 #define CLIENT_BUFSIZE 4000
36 * Close the connection to para_server and free all resources.
38 * \param ct Pointer to the client data.
40 * \sa \ref client_open().
42 void client_close(struct client_task *ct)
47 free(ct->config_file);
49 client_cmdline_parser_free(&ct->conf);
50 free(ct->challenge_hash);
57 * The preselect hook for server commands.
59 * The task pointer must contain a pointer to the initialized client data
60 * structure as it is returned by client_open().
62 * This function checks the state of the connection and adds the file descriptor
63 * of the connection to the read or write fd set of s accordingly.
65 static void client_pre_select(struct sched *s, void *context)
68 struct client_task *ct = context;
75 case CL_SENT_CH_RESPONSE:
76 para_fd_set(ct->scc.fd, &s->rfds, &s->max_fileno);
79 case CL_RECEIVED_WELCOME:
80 case CL_RECEIVED_PROCEED:
81 case CL_RECEIVED_CHALLENGE:
82 para_fd_set(ct->scc.fd, &s->wfds, &s->max_fileno);
87 ret = btr_node_status(ct->btrn[1], 0, BTR_NT_LEAF);
91 para_fd_set(ct->scc.fd, &s->wfds, &s->max_fileno);
96 ret = btr_node_status(ct->btrn[0], 0, BTR_NT_ROOT);
100 para_fd_set(ct->scc.fd, &s->rfds, &s->max_fileno);
106 static int send_sb(struct client_task *ct, int channel, void *buf, size_t numbytes,
107 enum sb_designator band, bool dont_free)
109 int ret, fd = ct->scc.fd;
112 if (!ct->sbc[channel]) {
113 struct sb_buffer sbb;
114 sb_transformation trafo = ct->status < CL_RECEIVED_PROCEED?
116 sbb = (typeof(sbb))SBB_INIT(band, buf, numbytes);
117 ct->sbc[channel] = sb_new_send(&sbb, dont_free, trafo, ct->scc.send);
119 ret = sb_get_send_buffers(ct->sbc[channel], iov);
120 ret = xwritev(fd, iov, ret);
122 sb_free(ct->sbc[channel]);
123 ct->sbc[channel] = NULL;
126 if (sb_sent(ct->sbc[channel], ret)) {
127 ct->sbc[channel] = NULL;
133 static int recv_sb(struct client_task *ct, fd_set *rfds,
134 struct sb_buffer *result)
138 sb_transformation trafo;
142 if (!FD_ISSET(ct->scc.fd, rfds))
144 if (ct->status < CL_SENT_CH_RESPONSE)
145 trafo = trafo_context = NULL;
148 trafo_context = ct->scc.recv;
151 ct->sbc[0] = sb_new_recv(0, trafo, trafo_context);
153 sb_get_recv_buffer(ct->sbc[0], &iov);
154 ret = read_nonblock(ct->scc.fd, iov.iov_base, iov.iov_len, rfds, &n);
162 if (!sb_received(ct->sbc[0], n, result))
169 static char **parse_features(char *buf)
172 const char id[] = "\nFeatures: ";
173 char *p, *q, **features;
183 create_argv(p, ",", &features);
184 for (i = 0; features[i]; i++)
185 PARA_INFO_LOG("server feature: %s\n", features[i]);
189 static int dispatch_sbb(struct client_task *ct, struct sb_buffer *sbb)
192 const char *designator[] = {SB_DESIGNATORS_ARRAY};
196 if (sbb->band < NUM_SB_DESIGNATORS)
197 PARA_DEBUG_LOG("band: %s\n", designator[sbb->band]);
200 case SBD_AWAITING_DATA:
201 ct->status = CL_SENDING;
205 if (iov_valid(&sbb->iov))
206 btr_add_output(sbb->iov.iov_base, sbb->iov.iov_len,
213 case SBD_WARNING_LOG:
217 if (iov_valid(&sbb->iov)) {
218 int ll = sbb->band - SBD_DEBUG_LOG;
219 para_log(ll, "remote: %s", (char *)sbb->iov.iov_base);
223 case SBD_EXIT__SUCCESS:
224 ret = -E_SERVER_CMD_SUCCESS;
226 case SBD_EXIT__FAILURE:
227 ret = -E_SERVER_CMD_FAILURE;
230 PARA_ERROR_LOG("invalid band %d\n", sbb->band);
235 free(sbb->iov.iov_base);
237 sbb->iov.iov_base = NULL;
241 static bool has_feature(const char *feature, struct client_task *ct)
243 return find_arg(feature, ct->features) >= 0? true : false;
246 static int send_sb_command(struct client_task *ct)
253 return send_sb(ct, 0, NULL, 0, 0, false);
255 for (i = 0; i < ct->conf.inputs_num; i++)
256 len += strlen(ct->conf.inputs[i]) + 1;
257 p = command = para_malloc(len);
258 for (i = 0; i < ct->conf.inputs_num; i++) {
259 strcpy(p, ct->conf.inputs[i]);
260 p += strlen(ct->conf.inputs[i]) + 1;
262 PARA_DEBUG_LOG("--> %s\n", command);
263 return send_sb(ct, 0, command, len, SBD_COMMAND, false);
267 * The post select hook for client commands.
269 * Depending on the current state of the connection and the status of the read
270 * and write fd sets of s, this function performs the necessary steps to
271 * authenticate the connection, to send the command given by t->private_data
272 * and to receive para_server's output, if any.
274 static int client_post_select(struct sched *s, void *context)
276 struct client_task *ct = context;
279 char buf[CLIENT_BUFSIZE];
281 ret = task_get_notification(ct->task);
286 switch (ct->status) {
287 case CL_CONNECTED: /* receive welcome message */
288 ret = read_nonblock(ct->scc.fd, buf, sizeof(buf), &s->rfds, &n);
289 if (ret < 0 || n == 0)
291 ct->features = parse_features(buf);
292 if (!has_feature("sideband", ct)) {
293 PARA_ERROR_LOG("server has no sideband support\n");
294 ret = -E_INCOMPAT_FEAT;
297 ct->status = CL_RECEIVED_WELCOME;
299 case CL_RECEIVED_WELCOME: /* send auth command */
300 if (!FD_ISSET(ct->scc.fd, &s->wfds))
302 sprintf(buf, AUTH_REQUEST_MSG "%s sideband%s", ct->user,
303 has_feature("aes_ctr128", ct)? ",aes_ctr128" : "");
304 PARA_INFO_LOG("--> %s\n", buf);
305 ret = write_buffer(ct->scc.fd, buf);
308 ct->status = CL_SENT_AUTH;
312 * Receive challenge and session keys, decrypt the challenge and
313 * send back the hash of the decrypted challenge.
316 /* decrypted challenge/session key buffer */
317 unsigned char crypt_buf[1024];
318 struct sb_buffer sbb;
321 ret = recv_sb(ct, &s->rfds, &sbb);
324 if (sbb.band != SBD_CHALLENGE) {
326 free(sbb.iov.iov_base);
330 PARA_INFO_LOG("<-- [challenge] (%zu bytes)\n", n);
331 ret = priv_decrypt(ct->key_file, crypt_buf,
332 sbb.iov.iov_base, n);
333 free(sbb.iov.iov_base);
336 ct->challenge_hash = para_malloc(HASH_SIZE);
337 hash_function((char *)crypt_buf, CHALLENGE_SIZE, ct->challenge_hash);
338 use_aes = has_feature("aes_ctr128", ct);
339 ct->scc.send = sc_new(crypt_buf + CHALLENGE_SIZE, SESSION_KEY_LEN, use_aes);
340 ct->scc.recv = sc_new(crypt_buf + CHALLENGE_SIZE + SESSION_KEY_LEN,
341 SESSION_KEY_LEN, use_aes);
342 hash_to_asc(ct->challenge_hash, buf);
343 PARA_INFO_LOG("--> %s\n", buf);
344 ct->status = CL_RECEIVED_CHALLENGE;
347 case CL_RECEIVED_CHALLENGE:
348 ret = send_sb(ct, 0, ct->challenge_hash, HASH_SIZE,
349 SBD_CHALLENGE_RESPONSE, false);
351 ct->challenge_hash = NULL;
354 ct->status = CL_SENT_CH_RESPONSE;
356 case CL_SENT_CH_RESPONSE: /* read server response */
358 struct sb_buffer sbb;
359 ret = recv_sb(ct, &s->rfds, &sbb);
362 free(sbb.iov.iov_base);
363 if (sbb.band != SBD_PROCEED)
366 ct->status = CL_RECEIVED_PROCEED;
369 case CL_RECEIVED_PROCEED: /* concat args and send command */
371 if (!FD_ISSET(ct->scc.fd, &s->wfds))
373 ret = send_sb_command(ct);
376 ct->status = CL_EXECUTING;
383 ret = btr_node_status(ct->btrn[1], 0, BTR_NT_LEAF);
384 if (ret == -E_BTR_EOF) {
385 /* empty blob data packet indicates EOF */
386 PARA_INFO_LOG("blob sent\n");
387 ret = send_sb(ct, 1, NULL, 0, SBD_BLOB_DATA, true);
393 if (ret > 0 && FD_ISSET(ct->scc.fd, &s->wfds)) {
394 sz = btr_next_buffer(ct->btrn[1], &buf2);
396 ret = send_sb(ct, 1, buf2, sz, SBD_BLOB_DATA, true);
400 btr_consume(ct->btrn[1], sz);
406 ret = btr_node_status(ct->btrn[0], 0, BTR_NT_ROOT);
409 if (ret > 0 && FD_ISSET(ct->scc.fd, &s->rfds)) {
410 struct sb_buffer sbb;
411 ret = recv_sb(ct, &s->rfds, &sbb);
415 ret = dispatch_sbb(ct, &sbb);
425 PARA_INFO_LOG("channel 1: %s\n", para_strerror(-ret));
426 btr_remove_node(&ct->btrn[1]);
431 PARA_INFO_LOG("channel 0: %s\n", para_strerror(-ret));
432 btr_remove_node(&ct->btrn[0]);
433 if (ct->btrn[1] && ct->status == CL_SENDING)
438 btr_remove_node(&ct->btrn[0]);
439 btr_remove_node(&ct->btrn[1]);
440 if (ret != -E_SERVER_CMD_SUCCESS && ret != -E_SERVER_CMD_FAILURE)
441 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
442 if (ct->scc.fd >= 0) {
446 free_argv(ct->features);
448 sc_free(ct->scc.recv);
450 sc_free(ct->scc.send);
456 * Connect to para_server and register the client task.
458 * \param ct The initialized client task structure.
459 * \param s The scheduler instance to register the client task to.
460 * \param parent The parent node of the client btr node.
461 * \param child The child node of the client node.
463 * The client task structure given by \a ct must be allocated and initialized
464 * by \ref client_parse_config() before this function is called.
468 int client_connect(struct client_task *ct, struct sched *s,
469 struct btr_node *parent, struct btr_node *child)
473 PARA_NOTICE_LOG("connecting %s:%d\n", ct->conf.hostname_arg,
474 ct->conf.server_port_arg);
476 ret = para_connect_simple(IPPROTO_TCP, ct->conf.hostname_arg,
477 ct->conf.server_port_arg);
481 ret = mark_fd_nonblocking(ct->scc.fd);
484 ct->status = CL_CONNECTED;
485 ct->btrn[0] = btr_new_node(&(struct btr_node_description)
486 EMBRACE(.name = "client recv", .parent = NULL, .child = child));
487 ct->btrn[1] = btr_new_node(&(struct btr_node_description)
488 EMBRACE(.name = "client send", .parent = parent, .child = NULL));
490 ct->task = task_register(&(struct task_info) {
492 .pre_select = client_pre_select,
493 .post_select = client_post_select,
503 __noreturn static void print_help_and_die(struct client_task *ct)
505 struct ggo_help h = DEFINE_GGO_HELP(client);
506 bool d = ct->conf.detailed_help_given;
508 ggo_print_help(&h, d? GPH_STANDARD_FLAGS_DETAILED : GPH_STANDARD_FLAGS);
513 * Parse a client configuration.
515 * \param argc Usual argument count.
516 * \param argv Usual argument vector.
517 * \param ct_ptr Filled in by this function.
518 * \param loglevel If not \p NULL, the number of the loglevel is stored here.
520 * This checks the command line options given by \a argc and \a argv, sets
521 * default values for the user name and the name of the rsa key file and reads
522 * further options from the config file.
524 * Upon successful return, \a ct_ptr points to a dynamically allocated and
525 * initialized client task struct.
527 * \return The number of non-option arguments in \a argc/argv on success,
528 * negative on errors.
530 int client_parse_config(int argc, char *argv[], struct client_task **ct_ptr,
533 char *home = para_homedir();
535 struct client_task *ct = para_calloc(sizeof(struct client_task));
539 ret = -E_CLIENT_SYNTAX;
540 if (client_cmdline_parser(argc, argv, &ct->conf))
542 version_handle_flag("client", ct->conf.version_given);
543 if (ct->conf.help_given || ct->conf.detailed_help_given)
544 print_help_and_die(ct);
546 ct->config_file = ct->conf.config_file_given?
547 para_strdup(ct->conf.config_file_arg) :
548 make_message("%s/.paraslash/client.conf", home);
549 ret = file_exists(ct->config_file);
550 if (!ret && ct->conf.config_file_given) {
555 struct client_cmdline_parser_params params = {
559 .check_ambiguity = 0,
563 if (client_cmdline_parser_config_file(ct->config_file,
567 ct->user = ct->conf.user_given?
568 para_strdup(ct->conf.user_arg) : para_logname();
570 if (ct->conf.key_file_given)
571 ct->key_file = para_strdup(ct->conf.key_file_arg);
573 ct->key_file = make_message("%s/.paraslash/key.%s",
575 if (!file_exists(ct->key_file)) {
577 ct->key_file = make_message("%s/.ssh/id_rsa", home);
582 *loglevel = get_loglevel_by_name(ct->conf.loglevel_arg);
583 PARA_INFO_LOG("loglevel: %s\n", ct->conf.loglevel_arg);
584 PARA_INFO_LOG("config_file: %s\n", ct->config_file);
585 PARA_INFO_LOG("key_file: %s\n", ct->key_file);
586 ret = ct->conf.inputs_num;
590 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
598 * Parse the client configuration and open a connection to para_server.
600 * \param argc See \ref client_parse_config.
601 * \param argv See \ref client_parse_config.
602 * \param ct_ptr See \ref client_parse_config.
603 * \param loglevel See \ref client_parse_config.
604 * \param parent See \ref client_connect().
605 * \param child See \ref client_connect().
606 * \param sched See \ref client_connect().
608 * This function combines client_parse_config() and client_connect(). It is
609 * considered a syntax error if no command was given, i.e. if the number
610 * of non-option arguments is zero.
614 int client_open(int argc, char *argv[], struct client_task **ct_ptr,
615 int *loglevel, struct btr_node *parent, struct btr_node *child,
618 int ret = client_parse_config(argc, argv, ct_ptr, loglevel);
623 ret = -E_CLIENT_SYNTAX;
626 ret = client_connect(*ct_ptr, sched, parent, child);
631 client_close(*ct_ptr);