1 /* Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file client_common.c Common functions of para_client and para_audiod. */
5 #include <netinet/in.h>
6 #include <sys/socket.h>
14 #include "client.lsg.h"
26 #include "buffer_tree.h"
29 /** The size of the receiving buffer. */
30 #define CLIENT_BUFSIZE 4000
33 * Close the connection to para_server and free all resources.
35 * \param ct Pointer to the client data.
37 * \sa \ref client_open().
39 void client_close(struct client_task *ct)
45 lls_free_parse_result(ct->lpr, CLIENT_CMD_PTR);
46 free(ct->challenge_hash);
53 * This function asks the scheduler to monitor a file descriptor which
54 * corresponds to an active connection. The descriptor is monitored for either
55 * reading or writing, depending on the state of the connection.
57 * The context pointer is assumed to refer to a client task structure that was
58 * initialized earlier by client_open().
60 static void client_pre_select(struct sched *s, void *context)
63 struct client_task *ct = context;
70 case CL_SENT_CH_RESPONSE:
71 para_fd_set(ct->scc.fd, &s->rfds, &s->max_fileno);
74 case CL_RECEIVED_WELCOME:
75 case CL_RECEIVED_PROCEED:
76 case CL_RECEIVED_CHALLENGE:
77 para_fd_set(ct->scc.fd, &s->wfds, &s->max_fileno);
82 ret = btr_node_status(ct->btrn[1], 0, BTR_NT_LEAF);
86 para_fd_set(ct->scc.fd, &s->wfds, &s->max_fileno);
88 __attribute__ ((fallthrough));
91 ret = btr_node_status(ct->btrn[0], 0, BTR_NT_ROOT);
95 para_fd_set(ct->scc.fd, &s->rfds, &s->max_fileno);
101 static int send_sb(struct client_task *ct, int channel, void *buf, size_t numbytes,
102 enum sb_designator band, bool dont_free)
104 int ret, fd = ct->scc.fd;
107 if (!ct->sbc[channel]) {
108 struct sb_buffer sbb;
109 sb_transformation trafo = ct->status < CL_RECEIVED_PROCEED?
111 sbb = (typeof(sbb))SBB_INIT(band, buf, numbytes);
112 ct->sbc[channel] = sb_new_send(&sbb, dont_free, trafo, ct->scc.send);
114 ret = sb_get_send_buffers(ct->sbc[channel], iov);
115 ret = xwritev(fd, iov, ret);
117 sb_free(ct->sbc[channel]);
118 ct->sbc[channel] = NULL;
121 if (sb_sent(ct->sbc[channel], ret)) {
122 ct->sbc[channel] = NULL;
128 static int recv_sb(struct client_task *ct, fd_set *rfds,
129 struct sb_buffer *result)
133 sb_transformation trafo;
137 if (!FD_ISSET(ct->scc.fd, rfds))
139 if (ct->status < CL_SENT_CH_RESPONSE)
140 trafo = trafo_context = NULL;
143 trafo_context = ct->scc.recv;
146 ct->sbc[0] = sb_new_recv(0, trafo, trafo_context);
148 sb_get_recv_buffer(ct->sbc[0], &iov);
149 ret = read_nonblock(ct->scc.fd, iov.iov_base, iov.iov_len, rfds, &n);
157 ret = sb_received(ct->sbc[0], n, result);
167 static char **parse_features(char *buf)
170 const char id[] = "\nFeatures: ";
171 char *p, *q, **features;
181 create_argv(p, ",", &features);
182 for (i = 0; features[i]; i++)
183 PARA_INFO_LOG("server feature: %s\n", features[i]);
187 static int dispatch_sbb(struct client_task *ct, struct sb_buffer *sbb)
190 const char *designator[] = {SB_DESIGNATORS_ARRAY};
194 if (sbb->band < NUM_SB_DESIGNATORS)
195 PARA_DEBUG_LOG("band: %s\n", designator[sbb->band]);
198 case SBD_AWAITING_DATA:
199 ct->status = CL_SENDING;
203 if (iov_valid(&sbb->iov))
204 btr_add_output(sbb->iov.iov_base, sbb->iov.iov_len,
211 case SBD_WARNING_LOG:
215 if (iov_valid(&sbb->iov)) {
216 int ll = sbb->band - SBD_DEBUG_LOG;
217 para_log(ll, "remote: %s", (char *)sbb->iov.iov_base);
221 case SBD_EXIT__SUCCESS:
222 ret = -E_SERVER_CMD_SUCCESS;
224 case SBD_EXIT__FAILURE:
225 ret = -E_SERVER_CMD_FAILURE;
228 PARA_ERROR_LOG("invalid band %d\n", sbb->band);
233 free(sbb->iov.iov_base);
235 sbb->iov.iov_base = NULL;
239 static int send_sb_command(struct client_task *ct)
244 unsigned num_inputs = lls_num_inputs(ct->lpr);
247 return send_sb(ct, 0, NULL, 0, 0, false);
249 for (i = 0; i < num_inputs; i++)
250 len += strlen(lls_input(i, ct->lpr)) + 1;
251 p = command = para_malloc(len);
252 for (i = 0; i < num_inputs; i++) {
253 const char *str = lls_input(i, ct->lpr);
255 p += strlen(str) + 1;
257 PARA_DEBUG_LOG("--> %s\n", command);
258 return send_sb(ct, 0, command, len, SBD_COMMAND, false);
262 * This function reads or writes to the socket file descriptor which
263 * corresponds to an established connection between the client and the server.
264 * It depends on the current state of the connection and on the readiness of
265 * the socket file descriptor which type of I/O is going to be performed.
266 * Besides the initial handshake and authentication, the function sends the
267 * server command and receives the output from the server, if any.
269 * The context pointer refers to a client task structure that was initialized
270 * earlier by client_open().
272 static int client_post_select(struct sched *s, void *context)
274 struct client_task *ct = context;
277 char buf[CLIENT_BUFSIZE];
279 ret = task_get_notification(ct->task);
284 switch (ct->status) {
285 case CL_CONNECTED: /* receive welcome message */
286 ret = read_nonblock(ct->scc.fd, buf, sizeof(buf), &s->rfds, &n);
287 if (ret < 0 || n == 0)
289 ct->features = parse_features(buf);
290 ct->status = CL_RECEIVED_WELCOME;
292 case CL_RECEIVED_WELCOME: /* send auth command */
293 if (!FD_ISSET(ct->scc.fd, &s->wfds))
295 sprintf(buf, AUTH_REQUEST_MSG "%s", ct->user);
296 PARA_INFO_LOG("--> %s\n", buf);
297 ret = write_buffer(ct->scc.fd, buf);
300 ct->status = CL_SENT_AUTH;
304 * Receive challenge and session keys, decrypt the challenge and
305 * send back the hash of the decrypted challenge.
308 /* decrypted challenge/session key buffer */
309 unsigned char crypt_buf[1024];
310 struct sb_buffer sbb;
312 ret = recv_sb(ct, &s->rfds, &sbb);
315 if (sbb.band != SBD_CHALLENGE) {
317 free(sbb.iov.iov_base);
321 PARA_INFO_LOG("<-- [challenge] (%zu bytes)\n", n);
322 ret = apc_priv_decrypt(ct->key_file, crypt_buf,
323 sbb.iov.iov_base, n);
324 free(sbb.iov.iov_base);
327 ct->challenge_hash = para_malloc(HASH_SIZE);
328 hash_function((char *)crypt_buf, APC_CHALLENGE_SIZE, ct->challenge_hash);
329 ct->scc.send = sc_new(crypt_buf + APC_CHALLENGE_SIZE, SESSION_KEY_LEN);
330 ct->scc.recv = sc_new(crypt_buf + APC_CHALLENGE_SIZE + SESSION_KEY_LEN,
332 hash_to_asc(ct->challenge_hash, buf);
333 PARA_INFO_LOG("--> %s\n", buf);
334 ct->status = CL_RECEIVED_CHALLENGE;
337 case CL_RECEIVED_CHALLENGE:
338 ret = send_sb(ct, 0, ct->challenge_hash, HASH_SIZE,
339 SBD_CHALLENGE_RESPONSE, false);
341 ct->challenge_hash = NULL;
344 ct->status = CL_SENT_CH_RESPONSE;
346 case CL_SENT_CH_RESPONSE: /* read server response */
348 struct sb_buffer sbb;
349 ret = recv_sb(ct, &s->rfds, &sbb);
352 free(sbb.iov.iov_base);
353 if (sbb.band != SBD_PROCEED)
356 ct->status = CL_RECEIVED_PROCEED;
359 case CL_RECEIVED_PROCEED: /* concat args and send command */
361 if (!FD_ISSET(ct->scc.fd, &s->wfds))
363 ret = send_sb_command(ct);
366 ct->status = CL_EXECUTING;
373 ret = btr_node_status(ct->btrn[1], 0, BTR_NT_LEAF);
374 if (ret == -E_BTR_EOF) {
375 /* empty blob data packet indicates EOF */
376 PARA_INFO_LOG("blob sent\n");
377 ret = send_sb(ct, 1, NULL, 0, SBD_BLOB_DATA, true);
383 if (ret > 0 && FD_ISSET(ct->scc.fd, &s->wfds)) {
384 sz = btr_next_buffer(ct->btrn[1], &buf2);
386 ret = send_sb(ct, 1, buf2, sz, SBD_BLOB_DATA, true);
390 btr_consume(ct->btrn[1], sz);
393 __attribute__ ((fallthrough));
396 ret = btr_node_status(ct->btrn[0], 0, BTR_NT_ROOT);
399 if (ret > 0 && FD_ISSET(ct->scc.fd, &s->rfds)) {
400 struct sb_buffer sbb;
401 ret = recv_sb(ct, &s->rfds, &sbb);
405 ret = dispatch_sbb(ct, &sbb);
415 PARA_INFO_LOG("channel 1: %s\n", para_strerror(-ret));
416 btr_remove_node(&ct->btrn[1]);
421 PARA_INFO_LOG("channel 0: %s\n", para_strerror(-ret));
422 btr_remove_node(&ct->btrn[0]);
423 if (ct->btrn[1] && ct->status == CL_SENDING)
428 btr_remove_node(&ct->btrn[0]);
429 btr_remove_node(&ct->btrn[1]);
430 if (ret != -E_SERVER_CMD_SUCCESS && ret != -E_SERVER_CMD_FAILURE)
431 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
432 if (ct->scc.fd >= 0) {
436 free_argv(ct->features);
438 sc_free(ct->scc.recv);
440 sc_free(ct->scc.send);
446 * Connect to para_server and register the client task.
448 * \param ct The initialized client task structure.
449 * \param s The scheduler instance to register the client task to.
450 * \param parent The parent node of the client btr node.
451 * \param child The child node of the client node.
453 * The client task structure given by \a ct must be allocated and initialized
454 * by \ref client_parse_config() before this function is called.
458 int client_connect(struct client_task *ct, struct sched *s,
459 struct btr_node *parent, struct btr_node *child)
462 const char *host = CLIENT_OPT_STRING_VAL(HOSTNAME, ct->lpr);
463 uint32_t port = CLIENT_OPT_UINT32_VAL(SERVER_PORT, ct->lpr);
465 PARA_NOTICE_LOG("connecting %s:%u\n", host, port);
467 ret = para_connect_simple(IPPROTO_TCP, host, port);
471 ret = mark_fd_nonblocking(ct->scc.fd);
474 ct->status = CL_CONNECTED;
475 ct->btrn[0] = btr_new_node(&(struct btr_node_description)
476 EMBRACE(.name = "client recv", .parent = NULL, .child = child));
477 ct->btrn[1] = btr_new_node(&(struct btr_node_description)
478 EMBRACE(.name = "client send", .parent = parent, .child = NULL));
480 ct->task = task_register(&(struct task_info) {
482 .pre_select = client_pre_select,
483 .post_select = client_post_select,
493 static void handle_help_flag(struct lls_parse_result *lpr)
497 if (CLIENT_OPT_GIVEN(DETAILED_HELP, lpr))
498 help = lls_long_help(CLIENT_CMD_PTR);
499 else if (CLIENT_OPT_GIVEN(HELP, lpr))
500 help = lls_short_help(CLIENT_CMD_PTR);
503 printf("%s\n", help);
509 * Parse a client configuration.
511 * \param argc Usual argument count.
512 * \param argv Usual argument vector.
513 * \param ct_ptr Filled in by this function.
514 * \param loglevel If not \p NULL, the number of the loglevel is stored here.
516 * This checks the command line options given by \a argc and \a argv, sets
517 * default values for the user name and the name of the rsa key file and reads
518 * further options from the config file.
520 * Upon successful return, \a ct_ptr points to a dynamically allocated and
521 * initialized client task struct.
523 * \return The number of non-option arguments in \a argc/argv on success,
524 * negative on errors.
526 int client_parse_config(int argc, char *argv[], struct client_task **ct_ptr,
529 const struct lls_command *cmd = CLIENT_CMD_PTR;
530 struct lls_parse_result *lpr;
532 struct client_task *ct;
533 char *kf = NULL, *user, *errctx, *home = para_homedir();
535 ret = lls(lls_parse(argc, argv, cmd, &lpr, &errctx));
538 version_handle_flag("client", CLIENT_OPT_GIVEN(VERSION, lpr));
539 handle_help_flag(lpr);
541 ret = lsu_merge_config_file_options(CLIENT_OPT_STRING_VAL(CONFIG_FILE, lpr),
542 "client.conf", &lpr, cmd, client_suite, 0U /* default flags */);
546 ll = CLIENT_OPT_UINT32_VAL(LOGLEVEL, lpr);
549 user = CLIENT_OPT_GIVEN(USER, lpr)?
550 para_strdup(CLIENT_OPT_STRING_VAL(USER, lpr)) : para_logname();
552 if (CLIENT_OPT_GIVEN(KEY_FILE, lpr))
553 kf = para_strdup(CLIENT_OPT_STRING_VAL(KEY_FILE, lpr));
555 kf = make_message("%s/.paraslash/key.%s", home, user);
556 if (!file_exists(kf)) {
558 kf = make_message("%s/.ssh/id_rsa", home);
561 PARA_INFO_LOG("user: %s\n", user);
562 PARA_INFO_LOG("key file: %s\n", kf);
563 PARA_INFO_LOG("loglevel: %d\n", ll);
564 ct = para_calloc(sizeof(*ct));
570 ret = lls_num_inputs(lpr);
575 PARA_ERROR_LOG("%s\n", errctx);
577 lls_free_parse_result(lpr, cmd);
585 * Parse the client configuration and open a connection to para_server.
587 * \param argc See \ref client_parse_config.
588 * \param argv See \ref client_parse_config.
589 * \param ct_ptr See \ref client_parse_config.
590 * \param loglevel See \ref client_parse_config.
591 * \param parent See \ref client_connect().
592 * \param child See \ref client_connect().
593 * \param sched See \ref client_connect().
595 * This function combines client_parse_config() and client_connect(). It is
596 * considered a syntax error if no command was given, i.e. if the number
597 * of non-option arguments is zero.
601 int client_open(int argc, char *argv[], struct client_task **ct_ptr,
602 int *loglevel, struct btr_node *parent, struct btr_node *child,
605 int ret = client_parse_config(argc, argv, ct_ptr, loglevel);
610 ret = -E_CLIENT_SYNTAX;
613 ret = client_connect(*ct_ptr, sched, parent, child);
618 client_close(*ct_ptr);