2 * Copyright (C) 1997-2013 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 deallocate per-command resources.
38 * \param ct The client task.
40 * This frees all resources of the current command but keeps the configuration
43 * \sa \ref client_close().
45 void client_disconnect(struct client_task *ct)
51 free_argv(ct->features);
53 sc_free(ct->scc.recv);
55 sc_free(ct->scc.send);
57 btr_remove_node(&ct->btrn[0]);
58 btr_remove_node(&ct->btrn[1]);
62 * Close the connection to para_server and free all resources.
64 * \param ct Pointer to the client data.
66 * \sa \ref client_open(), \ref client_disconnect().
68 void client_close(struct client_task *ct)
72 client_disconnect(ct);
74 free(ct->config_file);
76 client_cmdline_parser_free(&ct->conf);
77 free(ct->challenge_hash);
84 * The preselect hook for server commands.
86 * \param s Pointer to the scheduler.
87 * \param t Pointer to the task struct for this command.
89 * The task pointer must contain a pointer to the initialized client data
90 * structure as it is returned by client_open().
92 * This function checks the state of the connection and adds the file descriptor
93 * of the connection to the read or write fd set of \a s accordingly.
95 * \sa register_task() client_open(), struct sched, struct task.
97 static void client_pre_select(struct sched *s, struct task *t)
100 struct client_task *ct = container_of(t, struct client_task, task);
104 switch (ct->status) {
107 case CL_SENT_CH_RESPONSE:
108 para_fd_set(ct->scc.fd, &s->rfds, &s->max_fileno);
111 case CL_RECEIVED_WELCOME:
112 case CL_RECEIVED_PROCEED:
113 case CL_RECEIVED_CHALLENGE:
114 para_fd_set(ct->scc.fd, &s->wfds, &s->max_fileno);
119 ret = btr_node_status(ct->btrn[1], 0, BTR_NT_LEAF);
123 para_fd_set(ct->scc.fd, &s->wfds, &s->max_fileno);
128 ret = btr_node_status(ct->btrn[0], 0, BTR_NT_ROOT);
132 para_fd_set(ct->scc.fd, &s->rfds, &s->max_fileno);
138 static int send_sb(struct client_task *ct, int channel, void *buf, size_t numbytes,
139 enum sb_designator band, bool dont_free)
141 int ret, fd = ct->scc.fd;
144 if (!ct->sbc[channel]) {
145 struct sb_buffer sbb;
146 sb_transformation trafo = ct->status < CL_RECEIVED_PROCEED?
148 sbb = (typeof(sbb))SBB_INIT(band, buf, numbytes);
149 ct->sbc[channel] = sb_new_send(&sbb, dont_free, trafo, ct->scc.send);
151 ret = sb_get_send_buffers(ct->sbc[channel], iov);
152 ret = xwritev(fd, iov, ret);
154 sb_free(ct->sbc[channel]);
155 ct->sbc[channel] = NULL;
158 if (sb_sent(ct->sbc[channel], ret)) {
159 ct->sbc[channel] = NULL;
165 static int recv_sb(struct client_task *ct, fd_set *rfds,
166 struct sb_buffer *result)
170 sb_transformation trafo;
174 if (!FD_ISSET(ct->scc.fd, rfds))
176 if (ct->status < CL_SENT_CH_RESPONSE)
177 trafo = trafo_context = NULL;
180 trafo_context = ct->scc.recv;
183 ct->sbc[0] = sb_new_recv(0, trafo, trafo_context);
185 sb_get_recv_buffer(ct->sbc[0], &iov);
186 ret = read_nonblock(ct->scc.fd, iov.iov_base, iov.iov_len, rfds, &n);
194 if (!sb_received(ct->sbc[0], n, result))
201 static char **parse_features(char *buf)
204 const char id[] = "\nFeatures: ";
205 char *p, *q, **features;
215 create_argv(p, ",", &features);
216 for (i = 0; features[i]; i++)
217 PARA_INFO_LOG("server feature: %s\n", features[i]);
221 static int dispatch_sbb(struct client_task *ct, struct sb_buffer *sbb)
224 const char *designator[] = {SB_DESIGNATORS_ARRAY};
228 if (sbb->band < NUM_SB_DESIGNATORS)
229 PARA_DEBUG_LOG("band: %s\n", designator[sbb->band]);
232 case SBD_AWAITING_DATA:
233 ct->status = CL_SENDING;
237 if (iov_valid(&sbb->iov))
238 btr_add_output(sbb->iov.iov_base, sbb->iov.iov_len,
245 case SBD_WARNING_LOG:
249 if (iov_valid(&sbb->iov)) {
250 int ll = sbb->band - SBD_DEBUG_LOG;
251 para_log(ll, "remote: %s", (char *)sbb->iov.iov_base);
255 case SBD_EXIT__SUCCESS:
256 ret = -E_SERVER_CMD_SUCCESS;
258 case SBD_EXIT__FAILURE:
259 ret = -E_SERVER_CMD_FAILURE;
262 PARA_ERROR_LOG("invalid band %d\n", sbb->band);
267 free(sbb->iov.iov_base);
269 sbb->iov.iov_base = NULL;
273 static bool has_feature(const char *feature, struct client_task *ct)
275 return find_arg(feature, ct->features) >= 0? true : false;
278 static int send_sb_command(struct client_task *ct)
285 return send_sb(ct, 0, NULL, 0, 0, false);
287 for (i = 0; i < ct->conf.inputs_num; i++)
288 len += strlen(ct->conf.inputs[i]) + 1;
289 p = command = para_malloc(len);
290 for (i = 0; i < ct->conf.inputs_num; i++) {
291 strcpy(p, ct->conf.inputs[i]);
292 p += strlen(ct->conf.inputs[i]) + 1;
294 PARA_DEBUG_LOG("--> %s\n", command);
295 return send_sb(ct, 0, command, len, SBD_COMMAND, false);
299 * The post select hook for client commands.
301 * \param s Pointer to the scheduler.
302 * \param t Pointer to the task struct for this command.
304 * Depending on the current state of the connection and the status of the read
305 * and write fd sets of \a s, this function performs the necessary steps to
306 * authenticate the connection, to send the command given by \a t->private_data
307 * and to receive para_server's output, if any.
309 * \sa struct sched, struct task.
311 static int client_post_select(struct sched *s, struct task *t)
313 struct client_task *ct = container_of(t, struct client_task, task);
316 char buf[CLIENT_BUFSIZE];
318 ret = task_get_notification(t);
323 switch (ct->status) {
324 case CL_CONNECTED: /* receive welcome message */
325 ret = read_nonblock(ct->scc.fd, buf, sizeof(buf), &s->rfds, &n);
326 if (ret < 0 || n == 0)
328 ct->features = parse_features(buf);
329 if (!has_feature("sideband", ct)) {
330 PARA_ERROR_LOG("server has no sideband support\n");
331 ret = -E_INCOMPAT_FEAT;
334 ct->status = CL_RECEIVED_WELCOME;
336 case CL_RECEIVED_WELCOME: /* send auth command */
337 if (!FD_ISSET(ct->scc.fd, &s->wfds))
339 sprintf(buf, AUTH_REQUEST_MSG "%s sideband", ct->user);
340 PARA_INFO_LOG("--> %s\n", buf);
341 ret = write_buffer(ct->scc.fd, buf);
344 ct->status = CL_SENT_AUTH;
348 * Receive challenge and session keys, decrypt the challenge and
349 * send back the hash of the decrypted challenge.
352 /* decrypted challenge/session key buffer */
353 unsigned char crypt_buf[1024];
354 struct sb_buffer sbb;
356 ret = recv_sb(ct, &s->rfds, &sbb);
359 if (sbb.band != SBD_CHALLENGE) {
361 free(sbb.iov.iov_base);
365 PARA_INFO_LOG("<-- [challenge] (%zu bytes)\n", n);
366 ret = priv_decrypt(ct->key_file, crypt_buf,
367 sbb.iov.iov_base, n);
368 free(sbb.iov.iov_base);
371 ct->challenge_hash = para_malloc(HASH_SIZE);
372 hash_function((char *)crypt_buf, CHALLENGE_SIZE, ct->challenge_hash);
373 ct->scc.send = sc_new(crypt_buf + CHALLENGE_SIZE, SESSION_KEY_LEN);
374 ct->scc.recv = sc_new(crypt_buf + CHALLENGE_SIZE + SESSION_KEY_LEN,
376 hash_to_asc(ct->challenge_hash, buf);
377 PARA_INFO_LOG("--> %s\n", buf);
378 ct->status = CL_RECEIVED_CHALLENGE;
381 case CL_RECEIVED_CHALLENGE:
382 ret = send_sb(ct, 0, ct->challenge_hash, HASH_SIZE,
383 SBD_CHALLENGE_RESPONSE, false);
385 ct->challenge_hash = NULL;
388 ct->status = CL_SENT_CH_RESPONSE;
390 case CL_SENT_CH_RESPONSE: /* read server response */
392 struct sb_buffer sbb;
393 ret = recv_sb(ct, &s->rfds, &sbb);
396 free(sbb.iov.iov_base);
397 if (sbb.band != SBD_PROCEED)
400 ct->status = CL_RECEIVED_PROCEED;
403 case CL_RECEIVED_PROCEED: /* concat args and send command */
405 if (!FD_ISSET(ct->scc.fd, &s->wfds))
407 ret = send_sb_command(ct);
410 ct->status = CL_EXECUTING;
417 ret = btr_node_status(ct->btrn[1], 0, BTR_NT_LEAF);
418 if (ret == -E_BTR_EOF) {
419 /* empty blob data packet indicates EOF */
420 PARA_INFO_LOG("blob sent\n");
421 ret = send_sb(ct, 1, NULL, 0, SBD_BLOB_DATA, true);
427 if (ret > 0 && FD_ISSET(ct->scc.fd, &s->wfds)) {
428 sz = btr_next_buffer(ct->btrn[1], &buf2);
430 ret = send_sb(ct, 1, buf2, sz, SBD_BLOB_DATA, true);
434 btr_consume(ct->btrn[1], sz);
440 ret = btr_node_status(ct->btrn[0], 0, BTR_NT_ROOT);
443 if (ret > 0 && FD_ISSET(ct->scc.fd, &s->rfds)) {
444 struct sb_buffer sbb;
445 ret = recv_sb(ct, &s->rfds, &sbb);
449 ret = dispatch_sbb(ct, &sbb);
459 PARA_INFO_LOG("channel 1: %s\n", para_strerror(-ret));
460 btr_remove_node(&ct->btrn[1]);
465 PARA_INFO_LOG("channel 0: %s\n", para_strerror(-ret));
466 btr_remove_node(&ct->btrn[0]);
467 if (ct->btrn[1] && ct->status == CL_SENDING)
472 btr_remove_node(&ct->btrn[0]);
473 btr_remove_node(&ct->btrn[1]);
474 if (ret != -E_SERVER_CMD_SUCCESS && ret != -E_SERVER_CMD_FAILURE)
475 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
480 * Connect to para_server and register the client task.
482 * \param ct The initialized client task structure.
483 * \param s The scheduler instance to register the client task to.
484 * \param parent The parent node of the client btr node.
485 * \param child The child node of the client node.
487 * The client task structure given by \a ct must be allocated and initialized
488 * by \ref client_parse_config() before this function is called.
492 int client_connect(struct client_task *ct, struct sched *s,
493 struct btr_node *parent, struct btr_node *child)
497 PARA_NOTICE_LOG("connecting %s:%d\n", ct->conf.hostname_arg,
498 ct->conf.server_port_arg);
500 ret = para_connect_simple(IPPROTO_TCP, ct->conf.hostname_arg,
501 ct->conf.server_port_arg);
505 ret = mark_fd_nonblocking(ct->scc.fd);
508 ct->status = CL_CONNECTED;
509 ct->btrn[0] = btr_new_node(&(struct btr_node_description)
510 EMBRACE(.name = "client recv", .parent = NULL, .child = child));
511 ct->btrn[1] = btr_new_node(&(struct btr_node_description)
512 EMBRACE(.name = "client send", .parent = parent, .child = NULL));
513 ct->task.pre_select = client_pre_select;
514 ct->task.post_select = client_post_select;
516 sprintf(ct->task.status, "client");
517 register_task(s, &ct->task);
525 __noreturn static void print_help_and_die(struct client_task *ct)
527 struct ggo_help h = DEFINE_GGO_HELP(client);
528 bool d = ct->conf.detailed_help_given;
530 ggo_print_help(&h, d? GPH_STANDARD_FLAGS_DETAILED : GPH_STANDARD_FLAGS);
535 * Parse a client configuration.
537 * \param argc Usual argument count.
538 * \param argv Usual argument vector.
539 * \param ct_ptr Filled in by this function.
540 * \param loglevel If not \p NULL, the number of the loglevel is stored here.
542 * This checks the command line options given by \a argc and \a argv, sets
543 * default values for the user name and the name of the rsa key file and reads
544 * further options from the config file.
546 * Upon successful return, \a ct_ptr points to a dynamically allocated and
547 * initialized client task struct.
549 * \return The number of non-option arguments in \a argc/argv on success,
550 * negative on errors.
552 int client_parse_config(int argc, char *argv[], struct client_task **ct_ptr,
555 char *home = para_homedir();
557 struct client_task *ct = para_calloc(sizeof(struct client_task));
561 ret = -E_CLIENT_SYNTAX;
562 if (client_cmdline_parser(argc, argv, &ct->conf))
564 version_handle_flag("client", ct->conf.version_given);
565 if (ct->conf.help_given || ct->conf.detailed_help_given)
566 print_help_and_die(ct);
568 ct->config_file = ct->conf.config_file_given?
569 para_strdup(ct->conf.config_file_arg) :
570 make_message("%s/.paraslash/client.conf", home);
571 ret = file_exists(ct->config_file);
572 if (!ret && ct->conf.config_file_given) {
577 struct client_cmdline_parser_params params = {
581 .check_ambiguity = 0,
585 if (client_cmdline_parser_config_file(ct->config_file,
589 ct->user = ct->conf.user_given?
590 para_strdup(ct->conf.user_arg) : para_logname();
592 if (ct->conf.key_file_given)
593 ct->key_file = para_strdup(ct->conf.key_file_arg);
595 ct->key_file = make_message("%s/.paraslash/key.%s",
597 if (!file_exists(ct->key_file)) {
599 ct->key_file = make_message("%s/.ssh/id_rsa", home);
604 *loglevel = get_loglevel_by_name(ct->conf.loglevel_arg);
605 PARA_INFO_LOG("loglevel: %s\n", ct->conf.loglevel_arg);
606 PARA_INFO_LOG("config_file: %s\n", ct->config_file);
607 PARA_INFO_LOG("key_file: %s\n", ct->key_file);
608 ret = ct->conf.inputs_num;
612 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
620 * Parse the client configuration and open a connection to para_server.
622 * \param argc See \ref client_parse_config.
623 * \param argv See \ref client_parse_config.
624 * \param ct_ptr See \ref client_parse_config.
625 * \param loglevel See \ref client_parse_config.
626 * \param parent See \ref client_connect().
627 * \param child See \ref client_connect().
628 * \param sched See \ref client_connect().
630 * This function combines client_parse_config() and client_connect(). It is
631 * considered a syntax error if no command was given, i.e. if the number
632 * of non-option arguments is zero.
636 int client_open(int argc, char *argv[], struct client_task **ct_ptr,
637 int *loglevel, struct btr_node *parent, struct btr_node *child,
640 int ret = client_parse_config(argc, argv, ct_ptr, loglevel);
645 ret = -E_CLIENT_SYNTAX;
648 ret = client_connect(*ct_ptr, sched, parent, child);
653 client_close(*ct_ptr);