#ifndef CLIENT_H
#define CLIENT_H
-/* Window structure used in client to associate all the important
- connection (window) specific data to this structure. How the window
- actually appears on the screen in handeled by the silc_screen*
- routines in screen.c. */
-typedef struct {
+/* Forward declaration for client */
+typedef struct SilcClientObject *SilcClient;
+
+/* Forward declaration for client connection */
+typedef struct SilcClientConnectionObject *SilcClientConnection;
+
+#include "idlist.h"
+#include "command.h"
+#include "ops.h"
+
+/* Structure to hold ping time information. Every PING command will
+ add entry of this structure and is removed after reply to the ping
+ as been received. */
+typedef struct SilcClientPingStruct {
+ time_t start_time;
+ void *dest_id;
+ char *dest_name;
+} SilcClientPing;
+
+/* Structure to hold away messages set by user. This is mainly created
+ for future extensions where away messages could be set according filters
+ such as nickname and hostname. For now only one away message can
+ be set in one connection. */
+typedef struct SilcClientAwayStruct {
+ char *away;
+ struct SilcClientAwayStruct *next;
+} SilcClientAway;
+
+/* Connection structure used in client to associate all the important
+ connection specific data to this structure. */
+struct SilcClientConnectionObject {
/*
* Local data
*/
char *remote_host;
int remote_port;
int remote_type;
+ char *remote_info;
- /* Remote client ID for this connection */
- SilcClientID *remote_id;
+ /* Remote server ID for this connection */
+ SilcServerID *remote_id;
- /* Remote local ID so that the above defined ID would not have
+ /* Decoded remote ID so that the above defined ID would not have
to be decoded for every packet. */
unsigned char *remote_id_data;
unsigned int remote_id_data_len;
/* Keys */
SilcCipher send_key;
SilcCipher receive_key;
- SilcPKCS public_key;
SilcHmac hmac;
unsigned char *hmac_key;
unsigned int hmac_key_len;
/* Client ID and Channel ID cache. Messages transmitted in SILC network
are done using different unique ID's. These are the cache for
thoses ID's used in the communication. */
- SilcIDCache *client_id_cache[96];
- unsigned int client_id_cache_count[96];
- SilcIDCache *channel_id_cache[96];
- unsigned int channel_id_cache_count[96];
- SilcIDCache *server_id_cache;
- unsigned int server_id_cache_count;
-
- /* Current channel on window. All channel's are saved (allocated) into
+ SilcIDCache client_cache;
+ SilcIDCache channel_cache;
+ SilcIDCache server_cache;
+
+ /* Current channel on window. All channels are saved (allocated) into
the cache entries. */
SilcChannelEntry current_channel;
referencing (sock->user_data). */
SilcSocketConnection sock;
- /* The actual physical screen. This data is handled by the
- screen handling routines. */
- void *screen;
-} *SilcClientWindow;
+ /* Requested pings. */
+ SilcClientPing *ping;
+ unsigned int ping_count;
+
+ /* Set away message */
+ SilcClientAway *away;
+
+ /* Pointer back to the SilcClient. This object is passed to the application
+ and the actual client object is accesible through this pointer. */
+ SilcClient client;
+
+ /* User data context. Library does not touch this. */
+ void *context;
+};
+
+/* Main client structure. */
+struct SilcClientObject {
+ /*
+ * Public data. All the following pointers must be set by the allocator
+ * of this structure.
+ */
-typedef struct {
+ /* Users's username, hostname and realname. */
char *username;
+ char *hostname;
char *realname;
+ /* Private and public key of the user. */
+ SilcPKCS pkcs;
+ SilcPublicKey public_key;
+ SilcPrivateKey private_key;
+
+ /* Application specific user data pointer. Client library does not
+ touch this. */
+ void *application;
+
+ /*
+ * Private data. Following pointers are used internally by the client
+ * library and should be considered read-only fields.
+ */
+
+ /* All client operations that are implemented in the application. */
+ SilcClientOperations *ops;
+
/* SILC client task queues */
SilcTaskQueue io_queue;
SilcTaskQueue timeout_queue;
SilcTaskQueue generic_queue;
- /* Input buffer that holds the characters user types. This is
- used only to store the typed chars for a while. */
- SilcBuffer input_buffer;
-
- /* Table of windows in client. All the data, including connection
- specific data, is saved in here. */
- SilcClientWindow *windows;
- unsigned int windows_count;
+ /* Table of connections in client. All the connection data is saved here. */
+ SilcClientConnection *conns;
+ unsigned int conns_count;
- /* Currently active window. This is pointer to the window table
- defined above. This must never be free'd directly. */
- SilcClientWindow current_win;
-
- /* The SILC client screen object */
- SilcScreen screen;
-
- /* Generic cipher and hash objects */
+ /* Generic cipher and hash objects. These can be used and referenced
+ by the application as well. */
SilcCipher none_cipher;
SilcHash md5hash;
SilcHash sha1hash;
SilcHmac md5hmac;
SilcHmac sha1hmac;
- /* Configuration object */
- SilcClientConfig config;
-
- /* Random Number Generator */
+ /* Random Number Generator. Application should use this as its primary
+ random number generator. */
SilcRng rng;
-
-#ifdef SILC_SIM
- /* SIM (SILC Module) table */
- SilcSimContext **sim;
- unsigned int sim_count;
-#endif
-} SilcClientObject;
-
-typedef SilcClientObject *SilcClient;
+};
/* Macros */
-#ifndef CTRL
-#define CTRL(x) ((x) & 0x1f) /* Ctrl+x */
-#endif
-
/* Registers generic task for file descriptor for reading from network and
writing to network. As being generic task the actual task is allocated
only once and after that the same task applies to all registered fd's. */
do { \
int __i; \
\
- for (__i = 0; __i < (__x)->windows_count; __i++) \
- if ((__x)->windows[__i]->sock->sock == (__fd)) \
+ for (__i = 0; __i < (__x)->conns_count; __i++) \
+ if ((__x)->conns[__i]->sock->sock == (__fd)) \
break; \
\
- if (__i >= (__x)->windows_count) \
+ if (__i >= (__x)->conns_count) \
(__sock) = NULL; \
- (__sock) = (__x)->windows[__i]->sock; \
+ (__sock) = (__x)->conns[__i]->sock; \
} while(0)
-/* Returns TRUE if windows is currently active window */
-#define SILC_CLIENT_IS_CURRENT_WIN(__x, __win) ((__x)->current_win == (__win))
-
/* Prototypes */
-int silc_client_alloc(SilcClient *new_client);
+
+SilcClient silc_client_alloc(SilcClientOperations *ops, void *application);
void silc_client_free(SilcClient client);
int silc_client_init(SilcClient client);
void silc_client_stop(SilcClient client);
void silc_client_run(SilcClient client);
-void silc_client_parse_command_line(unsigned char *buffer,
- unsigned char ***parsed,
- unsigned int **parsed_lens,
- unsigned int **parsed_types,
- unsigned int *parsed_num,
- unsigned int max_args);
+SilcClientConnection silc_client_add_connection(SilcClient client,
+ char *hostname,
+ int port,
+ void *context);
int silc_client_connect_to_server(SilcClient client, int port,
- char *host);
+ char *host, void *context);
+int silc_client_start_key_exchange(SilcClient client,
+ SilcClientConnection conn,
+ int fd);
void silc_client_packet_send(SilcClient client,
SilcSocketConnection sock,
SilcPacketType type,
SilcBuffer message);
void silc_client_notify_by_server(SilcClient client,
SilcSocketConnection sock,
- SilcBuffer message);
+ SilcPacketContext *packet);
void silc_client_receive_new_id(SilcClient client,
SilcSocketConnection sock,
- unsigned char *id_string);
+ SilcIDPayload idp);
void silc_client_new_channel_id(SilcClient client,
SilcSocketConnection sock,
char *channel_name,
- unsigned char *id_string);
+ unsigned int mode, SilcIDPayload idp);
void silc_client_receive_channel_key(SilcClient client,
SilcSocketConnection sock,
SilcBuffer packet);
void silc_client_channel_message(SilcClient client,
SilcSocketConnection sock,
SilcPacketContext *packet);
+void silc_client_private_message(SilcClient client,
+ SilcSocketConnection sock,
+ SilcPacketContext *packet);
+void silc_client_remove_from_channels(SilcClient client,
+ SilcClientConnection conn,
+ SilcClientEntry client_entry);
+void silc_client_replace_from_channels(SilcClient client,
+ SilcClientConnection conn,
+ SilcClientEntry old,
+ SilcClientEntry new);
+char *silc_client_chmode(unsigned int mode);
+char *silc_client_chumode(unsigned int mode);
+char *silc_client_chumode_char(unsigned int mode);
+
#endif
projects / silc.git / blobdiff