2 * Copyright (C) 1997-2014 Andre Noll <maan@systemlinux.org>
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 * \param s Pointer to the scheduler.
60 * \param t Pointer to the task struct for this command.
62 * The task pointer must contain a pointer to the initialized client data
63 * structure as it is returned by client_open().
65 * This function checks the state of the connection and adds the file descriptor
66 * of the connection to the read or write fd set of \a s accordingly.
68 * \sa register_task() client_open(), struct sched, struct task.
70 static void client_pre_select(struct sched *s, struct task *t)
73 struct client_task *ct = container_of(t, struct client_task, task);
80 case CL_SENT_CH_RESPONSE:
81 para_fd_set(ct->scc.fd, &s->rfds, &s->max_fileno);
84 case CL_RECEIVED_WELCOME:
85 case CL_RECEIVED_PROCEED:
86 case CL_RECEIVED_CHALLENGE:
87 para_fd_set(ct->scc.fd, &s->wfds, &s->max_fileno);
92 ret = btr_node_status(ct->btrn[1], 0, BTR_NT_LEAF);
96 para_fd_set(ct->scc.fd, &s->wfds, &s->max_fileno);
101 ret = btr_node_status(ct->btrn[0], 0, BTR_NT_ROOT);
105 para_fd_set(ct->scc.fd, &s->rfds, &s->max_fileno);
111 static int send_sb(struct client_task *ct, int channel, void *buf, size_t numbytes,
112 enum sb_designator band, bool dont_free)
114 int ret, fd = ct->scc.fd;
117 if (!ct->sbc[channel]) {
118 struct sb_buffer sbb;
119 sb_transformation trafo = ct->status < CL_RECEIVED_PROCEED?
121 sbb = (typeof(sbb))SBB_INIT(band, buf, numbytes);
122 ct->sbc[channel] = sb_new_send(&sbb, dont_free, trafo, ct->scc.send);
124 ret = sb_get_send_buffers(ct->sbc[channel], iov);
125 ret = xwritev(fd, iov, ret);
127 sb_free(ct->sbc[channel]);
128 ct->sbc[channel] = NULL;
131 if (sb_sent(ct->sbc[channel], ret)) {
132 ct->sbc[channel] = NULL;
138 static int recv_sb(struct client_task *ct, fd_set *rfds,
139 struct sb_buffer *result)
143 sb_transformation trafo;
147 if (!FD_ISSET(ct->scc.fd, rfds))
149 if (ct->status < CL_SENT_CH_RESPONSE)
150 trafo = trafo_context = NULL;
153 trafo_context = ct->scc.recv;
156 ct->sbc[0] = sb_new_recv(0, trafo, trafo_context);
158 sb_get_recv_buffer(ct->sbc[0], &iov);
159 ret = read_nonblock(ct->scc.fd, iov.iov_base, iov.iov_len, rfds, &n);
167 if (!sb_received(ct->sbc[0], n, result))
174 static char **parse_features(char *buf)
177 const char id[] = "\nFeatures: ";
178 char *p, *q, **features;
188 create_argv(p, ",", &features);
189 for (i = 0; features[i]; i++)
190 PARA_INFO_LOG("server feature: %s\n", features[i]);
194 static int dispatch_sbb(struct client_task *ct, struct sb_buffer *sbb)
197 const char *designator[] = {SB_DESIGNATORS_ARRAY};
201 if (sbb->band < NUM_SB_DESIGNATORS)
202 PARA_DEBUG_LOG("band: %s\n", designator[sbb->band]);
205 case SBD_AWAITING_DATA:
206 ct->status = CL_SENDING;
210 if (iov_valid(&sbb->iov))
211 btr_add_output(sbb->iov.iov_base, sbb->iov.iov_len,
218 case SBD_WARNING_LOG:
222 if (iov_valid(&sbb->iov)) {
223 int ll = sbb->band - SBD_DEBUG_LOG;
224 para_log(ll, "remote: %s", (char *)sbb->iov.iov_base);
228 case SBD_EXIT__SUCCESS:
229 ret = -E_SERVER_CMD_SUCCESS;
231 case SBD_EXIT__FAILURE:
232 ret = -E_SERVER_CMD_FAILURE;
235 PARA_ERROR_LOG("invalid band %d\n", sbb->band);
240 free(sbb->iov.iov_base);
242 sbb->iov.iov_base = NULL;
246 static bool has_feature(const char *feature, struct client_task *ct)
248 return find_arg(feature, ct->features) >= 0? true : false;
251 static int send_sb_command(struct client_task *ct)
258 return send_sb(ct, 0, NULL, 0, 0, false);
260 for (i = 0; i < ct->conf.inputs_num; i++)
261 len += strlen(ct->conf.inputs[i]) + 1;
262 p = command = para_malloc(len);
263 for (i = 0; i < ct->conf.inputs_num; i++) {
264 strcpy(p, ct->conf.inputs[i]);
265 p += strlen(ct->conf.inputs[i]) + 1;
267 PARA_DEBUG_LOG("--> %s\n", command);
268 return send_sb(ct, 0, command, len, SBD_COMMAND, false);
272 * The post select hook for client commands.
274 * \param s Pointer to the scheduler.
275 * \param t Pointer to the task struct for this command.
277 * Depending on the current state of the connection and the status of the read
278 * and write fd sets of \a s, this function performs the necessary steps to
279 * authenticate the connection, to send the command given by \a t->private_data
280 * and to receive para_server's output, if any.
282 * \sa struct sched, struct task.
284 static int client_post_select(struct sched *s, struct task *t)
286 struct client_task *ct = container_of(t, struct client_task, task);
289 char buf[CLIENT_BUFSIZE];
291 ret = task_get_notification(t);
296 switch (ct->status) {
297 case CL_CONNECTED: /* receive welcome message */
298 ret = read_nonblock(ct->scc.fd, buf, sizeof(buf), &s->rfds, &n);
299 if (ret < 0 || n == 0)
301 ct->features = parse_features(buf);
302 if (!has_feature("sideband", ct)) {
303 PARA_ERROR_LOG("server has no sideband support\n");
304 ret = -E_INCOMPAT_FEAT;
307 ct->status = CL_RECEIVED_WELCOME;
309 case CL_RECEIVED_WELCOME: /* send auth command */
310 if (!FD_ISSET(ct->scc.fd, &s->wfds))
312 sprintf(buf, AUTH_REQUEST_MSG "%s sideband%s", ct->user,
313 has_feature("aes_ctr128", ct)? ",aes_ctr128" : "");
314 PARA_INFO_LOG("--> %s\n", buf);
315 ret = write_buffer(ct->scc.fd, buf);
318 ct->status = CL_SENT_AUTH;
322 * Receive challenge and session keys, decrypt the challenge and
323 * send back the hash of the decrypted challenge.
326 /* decrypted challenge/session key buffer */
327 unsigned char crypt_buf[1024];
328 struct sb_buffer sbb;
331 ret = recv_sb(ct, &s->rfds, &sbb);
334 if (sbb.band != SBD_CHALLENGE) {
336 free(sbb.iov.iov_base);
340 PARA_INFO_LOG("<-- [challenge] (%zu bytes)\n", n);
341 ret = priv_decrypt(ct->key_file, crypt_buf,
342 sbb.iov.iov_base, n);
343 free(sbb.iov.iov_base);
346 ct->challenge_hash = para_malloc(HASH_SIZE);
347 hash_function((char *)crypt_buf, CHALLENGE_SIZE, ct->challenge_hash);
348 use_aes = has_feature("aes_ctr128", ct);
349 ct->scc.send = sc_new(crypt_buf + CHALLENGE_SIZE, SESSION_KEY_LEN, use_aes);
350 ct->scc.recv = sc_new(crypt_buf + CHALLENGE_SIZE + SESSION_KEY_LEN,
351 SESSION_KEY_LEN, use_aes);
352 hash_to_asc(ct->challenge_hash, buf);
353 PARA_INFO_LOG("--> %s\n", buf);
354 ct->status = CL_RECEIVED_CHALLENGE;
357 case CL_RECEIVED_CHALLENGE:
358 ret = send_sb(ct, 0, ct->challenge_hash, HASH_SIZE,
359 SBD_CHALLENGE_RESPONSE, false);
361 ct->challenge_hash = NULL;
364 ct->status = CL_SENT_CH_RESPONSE;
366 case CL_SENT_CH_RESPONSE: /* read server response */
368 struct sb_buffer sbb;
369 ret = recv_sb(ct, &s->rfds, &sbb);
372 free(sbb.iov.iov_base);
373 if (sbb.band != SBD_PROCEED)
376 ct->status = CL_RECEIVED_PROCEED;
379 case CL_RECEIVED_PROCEED: /* concat args and send command */
381 if (!FD_ISSET(ct->scc.fd, &s->wfds))
383 ret = send_sb_command(ct);
386 ct->status = CL_EXECUTING;
393 ret = btr_node_status(ct->btrn[1], 0, BTR_NT_LEAF);
394 if (ret == -E_BTR_EOF) {
395 /* empty blob data packet indicates EOF */
396 PARA_INFO_LOG("blob sent\n");
397 ret = send_sb(ct, 1, NULL, 0, SBD_BLOB_DATA, true);
403 if (ret > 0 && FD_ISSET(ct->scc.fd, &s->wfds)) {
404 sz = btr_next_buffer(ct->btrn[1], &buf2);
406 ret = send_sb(ct, 1, buf2, sz, SBD_BLOB_DATA, true);
410 btr_consume(ct->btrn[1], sz);
416 ret = btr_node_status(ct->btrn[0], 0, BTR_NT_ROOT);
419 if (ret > 0 && FD_ISSET(ct->scc.fd, &s->rfds)) {
420 struct sb_buffer sbb;
421 ret = recv_sb(ct, &s->rfds, &sbb);
425 ret = dispatch_sbb(ct, &sbb);
435 PARA_INFO_LOG("channel 1: %s\n", para_strerror(-ret));
436 btr_remove_node(&ct->btrn[1]);
441 PARA_INFO_LOG("channel 0: %s\n", para_strerror(-ret));
442 btr_remove_node(&ct->btrn[0]);
443 if (ct->btrn[1] && ct->status == CL_SENDING)
448 btr_remove_node(&ct->btrn[0]);
449 btr_remove_node(&ct->btrn[1]);
450 if (ret != -E_SERVER_CMD_SUCCESS && ret != -E_SERVER_CMD_FAILURE)
451 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
452 if (ct->scc.fd >= 0) {
456 free_argv(ct->features);
458 sc_free(ct->scc.recv);
460 sc_free(ct->scc.send);
466 * Connect to para_server and register the client task.
468 * \param ct The initialized client task structure.
469 * \param s The scheduler instance to register the client task to.
470 * \param parent The parent node of the client btr node.
471 * \param child The child node of the client node.
473 * The client task structure given by \a ct must be allocated and initialized
474 * by \ref client_parse_config() before this function is called.
478 int client_connect(struct client_task *ct, struct sched *s,
479 struct btr_node *parent, struct btr_node *child)
483 PARA_NOTICE_LOG("connecting %s:%d\n", ct->conf.hostname_arg,
484 ct->conf.server_port_arg);
486 ret = para_connect_simple(IPPROTO_TCP, ct->conf.hostname_arg,
487 ct->conf.server_port_arg);
491 ret = mark_fd_nonblocking(ct->scc.fd);
494 ct->status = CL_CONNECTED;
495 ct->btrn[0] = btr_new_node(&(struct btr_node_description)
496 EMBRACE(.name = "client recv", .parent = NULL, .child = child));
497 ct->btrn[1] = btr_new_node(&(struct btr_node_description)
498 EMBRACE(.name = "client send", .parent = parent, .child = NULL));
499 ct->task.pre_select = client_pre_select;
500 ct->task.post_select = client_post_select;
502 sprintf(ct->task.status, "client");
503 register_task(s, &ct->task);
511 __noreturn static void print_help_and_die(struct client_task *ct)
513 struct ggo_help h = DEFINE_GGO_HELP(client);
514 bool d = ct->conf.detailed_help_given;
516 ggo_print_help(&h, d? GPH_STANDARD_FLAGS_DETAILED : GPH_STANDARD_FLAGS);
521 * Parse a client configuration.
523 * \param argc Usual argument count.
524 * \param argv Usual argument vector.
525 * \param ct_ptr Filled in by this function.
526 * \param loglevel If not \p NULL, the number of the loglevel is stored here.
528 * This checks the command line options given by \a argc and \a argv, sets
529 * default values for the user name and the name of the rsa key file and reads
530 * further options from the config file.
532 * Upon successful return, \a ct_ptr points to a dynamically allocated and
533 * initialized client task struct.
535 * \return The number of non-option arguments in \a argc/argv on success,
536 * negative on errors.
538 int client_parse_config(int argc, char *argv[], struct client_task **ct_ptr,
541 char *home = para_homedir();
543 struct client_task *ct = para_calloc(sizeof(struct client_task));
547 ret = -E_CLIENT_SYNTAX;
548 if (client_cmdline_parser(argc, argv, &ct->conf))
550 version_handle_flag("client", ct->conf.version_given);
551 if (ct->conf.help_given || ct->conf.detailed_help_given)
552 print_help_and_die(ct);
554 ct->config_file = ct->conf.config_file_given?
555 para_strdup(ct->conf.config_file_arg) :
556 make_message("%s/.paraslash/client.conf", home);
557 ret = file_exists(ct->config_file);
558 if (!ret && ct->conf.config_file_given) {
563 struct client_cmdline_parser_params params = {
567 .check_ambiguity = 0,
571 if (client_cmdline_parser_config_file(ct->config_file,
575 ct->user = ct->conf.user_given?
576 para_strdup(ct->conf.user_arg) : para_logname();
578 if (ct->conf.key_file_given)
579 ct->key_file = para_strdup(ct->conf.key_file_arg);
581 ct->key_file = make_message("%s/.paraslash/key.%s",
583 if (!file_exists(ct->key_file)) {
585 ct->key_file = make_message("%s/.ssh/id_rsa", home);
590 *loglevel = get_loglevel_by_name(ct->conf.loglevel_arg);
591 PARA_INFO_LOG("loglevel: %s\n", ct->conf.loglevel_arg);
592 PARA_INFO_LOG("config_file: %s\n", ct->config_file);
593 PARA_INFO_LOG("key_file: %s\n", ct->key_file);
594 ret = ct->conf.inputs_num;
598 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
606 * Parse the client configuration and open a connection to para_server.
608 * \param argc See \ref client_parse_config.
609 * \param argv See \ref client_parse_config.
610 * \param ct_ptr See \ref client_parse_config.
611 * \param loglevel See \ref client_parse_config.
612 * \param parent See \ref client_connect().
613 * \param child See \ref client_connect().
614 * \param sched See \ref client_connect().
616 * This function combines client_parse_config() and client_connect(). It is
617 * considered a syntax error if no command was given, i.e. if the number
618 * of non-option arguments is zero.
622 int client_open(int argc, char *argv[], struct client_task **ct_ptr,
623 int *loglevel, struct btr_node *parent, struct btr_node *child,
626 int ret = client_parse_config(argc, argv, ct_ptr, loglevel);
631 ret = -E_CLIENT_SYNTAX;
634 ret = client_connect(*ct_ptr, sched, parent, child);
639 client_close(*ct_ptr);