bitstream: Improve documentation.
[paraslash.git] / client.h
1 /*
2 * Copyright (C) 1997-2014 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file client.h Common client functions and exported symbols from client_common.c. */
8
9 /** The different states of a connection from the view of the client. */
10 enum {
11 /** TCP connection is established. */
12 CL_CONNECTED,
13 /** Server sends the welcome message. */
14 CL_RECEIVED_WELCOME,
15 /** Client sends the authentication request. */
16 CL_SENT_AUTH,
17 /** Server sends encrypted challenge. */
18 CL_RECEIVED_CHALLENGE,
19 /** Client solves the challenge and sends the result. */
20 CL_SENT_CH_RESPONSE,
21 /** Server accepts this authentication. */
22 CL_RECEIVED_PROCEED,
23 /** Command is executing. */
24 CL_EXECUTING,
25 /** Server is expecting data (addblob commands only). */
26 CL_SENDING,
27 };
28
29 /** Data specific to a client task. */
30 struct client_task {
31 /** The state of the connection. */
32 int status;
33 /** The file descriptor and the session keys. */
34 struct stream_cipher_context scc;
35 /** The sideband contexts for receiving/sending. */
36 struct sb_context *sbc[2];
37 /** The buffer tree nodes for receiving/sending. */
38 struct btr_node *btrn[2];
39 /** The hash value of the decrypted challenge. */
40 unsigned char *challenge_hash;
41 /** The configuration (including the command). */
42 struct client_args_info conf;
43 /** The config file for client options. */
44 char *config_file;
45 /** The RSA private key. */
46 char *key_file;
47 /** Paraslash user name. */
48 char *user;
49 /** The client task structure. */
50 struct task task;
51 /** List of features supported by the server. */
52 char **features;
53 };
54
55 void client_disconnect(struct client_task *ct);
56 void client_close(struct client_task *ct);
57 int client_parse_config(int argc, char *argv[], struct client_task **ct_ptr,
58 int *loglevel);
59 int client_connect(struct client_task *ct, struct sched *s,
60 struct btr_node *parent, struct btr_node *child);
61 int client_open(int argc, char *argv[], struct client_task **ct_ptr,
62 int *loglevel, struct btr_node *parent, struct btr_node *child,
63 struct sched *sched);