2 * Copyright (C) 1997-2012 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. */
10 #include <sys/types.h>
16 #include "client.cmdline.h"
22 #include "client.cmdline.h"
24 #include "buffer_tree.h"
27 /** The size of the receiving buffer. */
28 #define CLIENT_BUFSIZE 4000
31 * Close the connection to para_server and deallocate per-command ressources.
33 * \param ct The client task.
35 * This frees all ressources of the current command but keeps the configuration
38 * \sa \ref client_close().
40 void client_disconnect(struct client_task *ct)
46 free_argv(ct->features);
47 sc_free(ct->scc.recv);
49 sc_free(ct->scc.send);
51 btr_free_node(ct->btrn);
56 * Close the connection to para_server and free all resources.
58 * \param ct Pointer to the client data.
60 * \sa \ref client_open(), \ref client_disconnect().
62 void client_close(struct client_task *ct)
66 client_disconnect(ct);
68 free(ct->config_file);
70 client_cmdline_parser_free(&ct->conf);
71 free(ct->challenge_hash);
77 * The preselect hook for server commands.
79 * \param s Pointer to the scheduler.
80 * \param t Pointer to the task struct for this command.
82 * The task pointer must contain a pointer to the initialized client data
83 * structure as it is returned by client_open().
85 * This function checks the state of the connection and adds the file descriptor
86 * of the connection to the read or write fd set of \a s accordingly.
88 * \sa register_task() client_open(), struct sched, struct task.
90 static void client_pre_select(struct sched *s, struct task *t)
93 struct client_task *ct = container_of(t, struct client_task, task);
94 struct btr_node *btrn = ct->btrn;
101 case CL_SENT_CH_RESPONSE:
102 case CL_SENT_COMMAND:
103 para_fd_set(ct->scc.fd, &s->rfds, &s->max_fileno);
106 case CL_RECEIVED_WELCOME:
107 case CL_RECEIVED_PROCEED:
108 case CL_RECEIVED_CHALLENGE:
109 para_fd_set(ct->scc.fd, &s->wfds, &s->max_fileno);
113 ret = btr_node_status(btrn, 0, BTR_NT_ROOT);
118 para_fd_set(ct->scc.fd, &s->rfds,
123 ret = btr_node_status(btrn, 0, BTR_NT_LEAF);
128 para_fd_set(ct->scc.fd, &s->wfds,
135 static int client_recv_buffer(struct client_task *ct, fd_set *rfds,
136 char *buf, size_t sz, size_t *n)
140 if (ct->status < CL_SENT_CH_RESPONSE)
141 return read_nonblock(ct->scc.fd, buf, sz, rfds, n);
144 ret = sc_recv_buffer(&ct->scc, buf, sz);
146 * sc_recv_buffer is used with blocking fds elsewhere, so it
147 * does not use the nonblock-API. Therefore we need to
148 * check for EOF and EAGAIN.
151 return -E_SERVER_EOF;
152 if (ret == -ERRNO_TO_PARA_ERROR(EAGAIN))
160 static int send_sb(struct client_task *ct, void *buf, size_t numbytes,
161 enum sb_designator band, bool dont_free)
163 int ret, fd = ct->scc.fd;
167 struct sb_buffer sbb;
168 sb_transformation trafo = ct->status < CL_RECEIVED_PROCEED?
170 sbb = (typeof(sbb))SBB_INIT(band, buf, numbytes);
171 ct->sbc = sb_new_send(&sbb, dont_free, trafo, ct->scc.send);
173 ret = sb_get_send_buffers(ct->sbc, iov);
174 ret = xwritev(fd, iov, ret);
180 if (sb_sent(ct->sbc, ret)) {
187 static int recv_sb(struct client_task *ct, fd_set *rfds,
188 struct sb_buffer *result)
192 sb_transformation trafo;
196 if (!FD_ISSET(ct->scc.fd, rfds))
198 if (ct->status < CL_SENT_CH_RESPONSE)
199 trafo = trafo_context = NULL;
202 trafo_context = ct->scc.recv;
205 ct->sbc = sb_new_recv(0, trafo, trafo_context);
207 sb_get_recv_buffer(ct->sbc, &iov);
208 ret = read_nonblock(ct->scc.fd, iov.iov_base, iov.iov_len, rfds, &n);
216 if (!sb_received(ct->sbc, n, result))
223 static char **parse_features(char *buf)
226 const char id[] = "\nFeatures: ";
227 char *p, *q, **features;
237 create_argv(p, ",", &features);
238 for (i = 0; features[i]; i++)
239 PARA_INFO_LOG("server feature: %s\n", features[i]);
243 static bool has_feature(const char *feature, struct client_task *ct)
245 return find_arg(feature, ct->features) >= 0? true : false;
248 static int send_sb_command(struct client_task *ct)
255 return send_sb(ct, NULL, 0, 0, false);
257 for (i = 0; i < ct->conf.inputs_num; i++)
258 len += strlen(ct->conf.inputs[i]) + 1;
259 p = command = para_malloc(len);
260 for (i = 0; i < ct->conf.inputs_num; i++) {
261 strcpy(p, ct->conf.inputs[i]);
262 p += strlen(ct->conf.inputs[i]) + 1;
264 PARA_DEBUG_LOG("--> %s\n", command);
265 return send_sb(ct, command, len, SBD_COMMAND, false);
269 * The post select hook for client commands.
271 * \param s Pointer to the scheduler.
272 * \param t Pointer to the task struct for this command.
274 * Depending on the current state of the connection and the status of the read
275 * and write fd sets of \a s, this function performs the necessary steps to
276 * authenticate the connection, to send the command given by \a t->private_data
277 * and to receive para_server's output, if any.
279 * \sa struct sched, struct task.
281 static void client_post_select(struct sched *s, struct task *t)
283 struct client_task *ct = container_of(t, struct client_task, task);
284 struct btr_node *btrn = ct->btrn;
287 char buf[CLIENT_BUFSIZE];
292 switch (ct->status) {
293 case CL_CONNECTED: /* receive welcome message */
294 ret = client_recv_buffer(ct, &s->rfds, buf, sizeof(buf), &n);
295 if (ret < 0 || n == 0)
297 ct->features = parse_features(buf);
298 ct->status = CL_RECEIVED_WELCOME;
300 case CL_RECEIVED_WELCOME: /* send auth command */
301 if (!FD_ISSET(ct->scc.fd, &s->wfds))
303 if (has_feature("sideband", ct)) {
304 ct->use_sideband = true;
305 sprintf(buf, AUTH_REQUEST_MSG "%s sideband", ct->user);
307 sprintf(buf, AUTH_REQUEST_MSG "%s", ct->user);
308 PARA_INFO_LOG("--> %s\n", buf);
309 ret = write_buffer(ct->scc.fd, buf);
312 ct->status = CL_SENT_AUTH;
316 * Receive challenge and session keys, decrypt the challenge and
317 * send back the hash of the decrypted challenge.
320 /* decrypted challenge/session key buffer */
321 unsigned char crypt_buf[1024];
322 /* the SHA1 of the decrypted challenge */
324 if (ct->use_sideband) {
325 struct sb_buffer sbb;
326 ret = recv_sb(ct, &s->rfds, &sbb);
329 if (sbb.band != SBD_CHALLENGE) {
331 free(sbb.iov.iov_base);
335 PARA_INFO_LOG("<-- [challenge] (%zu bytes)\n", n);
336 ret = priv_decrypt(ct->key_file, crypt_buf,
337 sbb.iov.iov_base, n);
338 free(sbb.iov.iov_base);
342 ret = client_recv_buffer(ct, &s->rfds, buf, sizeof(buf), &n);
343 if (ret < 0 || n == 0)
345 PARA_INFO_LOG("<-- [challenge] (%zu bytes)\n", n);
346 ret = priv_decrypt(ct->key_file, crypt_buf,
347 (unsigned char *)buf, n);
351 ct->challenge_hash = para_malloc(HASH_SIZE);
352 hash_function((char *)crypt_buf, CHALLENGE_SIZE, ct->challenge_hash);
353 ct->scc.send = sc_new(crypt_buf + CHALLENGE_SIZE, SESSION_KEY_LEN);
354 ct->scc.recv = sc_new(crypt_buf + CHALLENGE_SIZE + SESSION_KEY_LEN,
356 hash_to_asc(ct->challenge_hash, buf);
357 PARA_INFO_LOG("--> %s\n", buf);
358 ct->status = CL_RECEIVED_CHALLENGE;
361 case CL_RECEIVED_CHALLENGE:
362 if (ct->use_sideband) {
363 ret = send_sb(ct, ct->challenge_hash, HASH_SIZE,
364 SBD_CHALLENGE_RESPONSE, false);
366 ct->challenge_hash = NULL;
370 ret = write_all(ct->scc.fd, (char *)ct->challenge_hash, HASH_SIZE);
374 ct->status = CL_SENT_CH_RESPONSE;
376 case CL_SENT_CH_RESPONSE: /* read server response */
378 if (ct->use_sideband) {
379 struct sb_buffer sbb;
380 ret = recv_sb(ct, &s->rfds, &sbb);
383 free(sbb.iov.iov_base);
384 if (sbb.band != SBD_PROCEED)
387 ct->status = CL_RECEIVED_PROCEED;
390 ret = client_recv_buffer(ct, &s->rfds, buf, sizeof(buf), &n);
391 if (ret < 0 || n == 0)
393 /* check if server has sent "Proceed" message */
394 ret = -E_CLIENT_AUTH;
395 if (n < PROCEED_MSG_LEN)
397 if (!strstr(buf, PROCEED_MSG))
399 ct->status = CL_RECEIVED_PROCEED;
402 case CL_RECEIVED_PROCEED: /* concat args and send command */
405 char *command = NULL;
406 if (!FD_ISSET(ct->scc.fd, &s->wfds))
408 if (ct->use_sideband) {
409 ret = send_sb_command(ct);
412 ct->status = CL_SENT_COMMAND;
415 for (i = 0; i < ct->conf.inputs_num; i++) {
417 command = make_message("%s\n%s", command?
418 command : "", ct->conf.inputs[i]);
421 command = para_strcat(command, EOC_MSG "\n");
422 PARA_DEBUG_LOG("--> %s\n", command);
423 ret = sc_send_buffer(&ct->scc, command);
427 ct->status = CL_SENT_COMMAND;
430 case CL_SENT_COMMAND:
433 /* can not use "buf" here because we need a malloced buffer */
434 buf2 = para_malloc(CLIENT_BUFSIZE);
435 ret = client_recv_buffer(ct, &s->rfds, buf2, CLIENT_BUFSIZE, &n);
437 if (strstr(buf2, AWAITING_DATA_MSG)) {
439 ct->status = CL_SENDING;
442 ct->status = CL_RECEIVING;
443 btr_add_output(buf2, n, btrn);
452 ret = btr_node_status(btrn, 0, BTR_NT_LEAF);
457 if (!FD_ISSET(ct->scc.fd, &s->wfds))
459 sz = btr_next_buffer(btrn, &buf2);
460 ret = sc_send_bin_buffer(&ct->scc, buf2, sz);
463 btr_consume(btrn, sz);
469 ret = btr_node_status(btrn, 0, BTR_NT_ROOT);
475 * The FD_ISSET() is not strictly necessary, but is allows us
476 * to skip the malloc below if there is nothing to read anyway.
478 if (!FD_ISSET(ct->scc.fd, &s->rfds))
480 buf2 = para_malloc(CLIENT_BUFSIZE);
481 ret = client_recv_buffer(ct, &s->rfds, buf2, CLIENT_BUFSIZE, &n);
483 buf2 = para_realloc(buf2, n);
484 btr_add_output(buf2, n, btrn);
493 if (ret != -E_SERVER_EOF && ret != -E_BTR_EOF && ret != -E_EOF)
494 PARA_ERROR_LOG("%s\n", para_strerror(-t->error));
495 btr_remove_node(btrn);
500 * Connect to para_server and register the client task.
502 * \param ct The initialized client task structure.
503 * \param s The scheduler instance to register the client task to.
504 * \param parent The parent node of the client btr node.
505 * \param child The child node of the client node.
507 * The client task structure given by \a ct must be allocated and initialized
508 * by \ref client_parse_config() before this function is called.
512 int client_connect(struct client_task *ct, struct sched *s,
513 struct btr_node *parent, struct btr_node *child)
517 PARA_NOTICE_LOG("connecting %s:%d\n", ct->conf.hostname_arg,
518 ct->conf.server_port_arg);
520 ret = para_connect_simple(IPPROTO_TCP, ct->conf.hostname_arg,
521 ct->conf.server_port_arg);
525 ret = mark_fd_nonblocking(ct->scc.fd);
528 ct->status = CL_CONNECTED;
529 ct->btrn = btr_new_node(&(struct btr_node_description)
530 EMBRACE(.name = "client", .parent = parent, .child = child));
531 ct->task.pre_select = client_pre_select;
532 ct->task.post_select = client_post_select;
534 sprintf(ct->task.status, "client");
535 register_task(s, &ct->task);
544 * Parse a client configuration.
546 * \param argc Usual argument count.
547 * \param argv Usual argument vector.
548 * \param ct_ptr Filled in by this function.
549 * \param loglevel If not \p NULL, the number of the loglevel is stored here.
551 * This checks the command line options given by \a argc and \a argv, sets
552 * default values for the user name and the name of the rsa key file and reads
553 * further options from the config file.
555 * Upon successful return, \a ct_ptr points to a dynamically allocated and
556 * initialized client task struct.
558 * \return The number of non-option arguments in \a argc/argv on success,
559 * negative on errors.
561 int client_parse_config(int argc, char *argv[], struct client_task **ct_ptr,
564 char *home = para_homedir();
566 struct client_task *ct = para_calloc(sizeof(struct client_task));
570 ret = -E_CLIENT_SYNTAX;
571 if (client_cmdline_parser(argc, argv, &ct->conf))
573 HANDLE_VERSION_FLAG("client", ct->conf);
575 ct->config_file = ct->conf.config_file_given?
576 para_strdup(ct->conf.config_file_arg) :
577 make_message("%s/.paraslash/client.conf", home);
578 ret = file_exists(ct->config_file);
579 if (!ret && ct->conf.config_file_given) {
584 struct client_cmdline_parser_params params = {
588 .check_ambiguity = 0,
592 if (client_cmdline_parser_config_file(ct->config_file,
596 ct->user = ct->conf.user_given?
597 para_strdup(ct->conf.user_arg) : para_logname();
599 if (ct->conf.key_file_given)
600 ct->key_file = para_strdup(ct->conf.key_file_arg);
602 ct->key_file = make_message("%s/.paraslash/key.%s",
604 if (!file_exists(ct->key_file)) {
606 ct->key_file = make_message("%s/.ssh/id_rsa", home);
611 *loglevel = get_loglevel_by_name(ct->conf.loglevel_arg);
612 PARA_INFO_LOG("loglevel: %s\n", ct->conf.loglevel_arg);
613 PARA_INFO_LOG("config_file: %s\n", ct->config_file);
614 PARA_INFO_LOG("key_file: %s\n", ct->key_file);
615 ret = ct->conf.inputs_num;
619 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
627 * Parse the client configuration and open a connection to para_server.
629 * \param argc See \ref client_parse_config.
630 * \param argv See \ref client_parse_config.
631 * \param ct_ptr See \ref client_parse_config.
632 * \param loglevel See \ref client_parse_config.
633 * \param parent See \ref client_connect().
634 * \param child See \ref client_connect().
635 * \param sched See \ref client_connect().
637 * This function combines client_parse_config() and client_connect(). It is
638 * considered a syntax error if no command was given, i.e. if the number
639 * of non-option arguments is zero.
643 int client_open(int argc, char *argv[], struct client_task **ct_ptr,
644 int *loglevel, struct btr_node *parent, struct btr_node *child,
647 int ret = client_parse_config(argc, argv, ct_ptr, loglevel);
652 ret = -E_CLIENT_SYNTAX;
655 ret = client_connect(*ct_ptr, sched, parent, child);
660 client_close(*ct_ptr);