5 Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
7 Copyright (C) 1997 - 2000 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
24 /* Forward declaration for client */
25 typedef struct SilcClientObject *SilcClient;
27 /* Forward declaration for client connection */
28 typedef struct SilcClientConnectionObject *SilcClientConnection;
34 /* Structure to hold ping time information. Every PING command will
35 add entry of this structure and is removed after reply to the ping
37 typedef struct SilcClientPingStruct {
43 /* Structure to hold away messages set by user. This is mainly created
44 for future extensions where away messages could be set according filters
45 such as nickname and hostname. For now only one away message can
46 be set in one connection. */
47 typedef struct SilcClientAwayStruct {
49 struct SilcClientAwayStruct *next;
52 /* Connection structure used in client to associate all the important
53 connection specific data to this structure. */
54 struct SilcClientConnectionObject {
60 /* Local client ID for this connection */
61 SilcClientID *local_id;
63 /* Decoded local ID so that the above defined ID would not have
64 to be decoded for every packet. */
65 unsigned char *local_id_data;
66 unsigned int local_id_data_len;
68 /* Own client entry. */
69 SilcClientEntry local_entry;
79 /* Remote server ID for this connection */
80 SilcServerID *remote_id;
82 /* Decoded remote ID so that the above defined ID would not have
83 to be decoded for every packet. */
84 unsigned char *remote_id_data;
85 unsigned int remote_id_data_len;
92 SilcCipher receive_key;
94 unsigned char *hmac_key;
95 unsigned int hmac_key_len;
97 /* Client ID and Channel ID cache. Messages transmitted in SILC network
98 are done using different unique ID's. These are the cache for
99 thoses ID's used in the communication. */
100 SilcIDCache client_cache;
101 SilcIDCache channel_cache;
102 SilcIDCache server_cache;
104 /* Current channel on window. All channels are saved (allocated) into
105 the cache entries. */
106 SilcChannelEntry current_channel;
108 /* Socket connection object for this connection (window). This
109 object will have a back-pointer to this window object for fast
110 referencing (sock->user_data). */
111 SilcSocketConnection sock;
113 /* Requested pings. */
114 SilcClientPing *ping;
115 unsigned int ping_count;
117 /* Set away message */
118 SilcClientAway *away;
120 /* Pointer back to the SilcClient. This object is passed to the application
121 and the actual client object is accesible thourh this pointer. */
124 /* User data context. Library does not touch this. */
128 /* Main client structure. */
129 struct SilcClientObject {
131 * Public data. All the following pointers must be set by the allocator
135 /* Users's username and realname. */
139 /* Private and public key of the user. */
141 SilcPublicKey public_key;
142 SilcPrivateKey private_key;
144 /* Application specific user data pointer. Client library does not
149 * Private data. Following pointers are used internally by the client
150 * library and should be considered read-only fields.
153 /* All client operations that are implemented in the application. */
154 SilcClientOperations *ops;
156 /* SILC client task queues */
157 SilcTaskQueue io_queue;
158 SilcTaskQueue timeout_queue;
159 SilcTaskQueue generic_queue;
161 /* Table of connections in client. All the connection data is saved here. */
162 SilcClientConnection *conns;
163 unsigned int conns_count;
165 /* Generic cipher and hash objects. These can be used and referenced
166 by the application as well. */
167 SilcCipher none_cipher;
173 /* Random Number Generator. Application should use this as its primary
174 random number generator. */
180 /* Registers generic task for file descriptor for reading from network and
181 writing to network. As being generic task the actual task is allocated
182 only once and after that the same task applies to all registered fd's. */
183 #define SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(fd) \
185 SilcTask tmptask = silc_task_register(client->generic_queue, (fd), \
186 silc_client_packet_process, \
189 SILC_TASK_PRI_NORMAL); \
190 silc_task_set_iotype(tmptask, SILC_TASK_WRITE); \
193 #define SILC_CLIENT_SET_CONNECTION_FOR_INPUT(fd) \
195 silc_schedule_set_listen_fd((fd), (1L << SILC_TASK_READ)); \
198 #define SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(fd) \
200 silc_schedule_set_listen_fd((fd), ((1L << SILC_TASK_READ) | \
201 (1L << SILC_TASK_WRITE))); \
204 /* Finds socket connection object by file descriptor */
205 #define SILC_CLIENT_GET_SOCK(__x, __fd, __sock) \
209 for (__i = 0; __i < (__x)->conns_count; __i++) \
210 if ((__x)->conns[__i]->sock->sock == (__fd)) \
213 if (__i >= (__x)->conns_count) \
215 (__sock) = (__x)->conns[__i]->sock; \
220 SilcClient silc_client_alloc(SilcClientOperations *ops, void *application);
221 void silc_client_free(SilcClient client);
222 int silc_client_init(SilcClient client);
223 void silc_client_stop(SilcClient client);
224 void silc_client_run(SilcClient client);
225 SilcClientConnection silc_client_add_connection(SilcClient client,
227 int silc_client_connect_to_server(SilcClient client, int port,
228 char *host, void *context);
229 int silc_client_start_key_exchange(SilcClient client,
230 SilcClientConnection conn,
232 void silc_client_packet_send(SilcClient client,
233 SilcSocketConnection sock,
236 SilcIdType dst_id_type,
240 unsigned int data_len,
242 void silc_client_packet_send_to_channel(SilcClient client,
243 SilcSocketConnection sock,
244 SilcChannelEntry channel,
246 unsigned int data_len,
248 void silc_client_packet_send_private_message(SilcClient client,
249 SilcSocketConnection sock,
250 SilcClientEntry client_entry,
252 unsigned int data_len,
254 void silc_client_close_connection(SilcClient client,
255 SilcSocketConnection sock);
256 void silc_client_disconnected_by_server(SilcClient client,
257 SilcSocketConnection sock,
259 void silc_client_error_by_server(SilcClient client,
260 SilcSocketConnection sock,
262 void silc_client_notify_by_server(SilcClient client,
263 SilcSocketConnection sock,
265 void silc_client_receive_new_id(SilcClient client,
266 SilcSocketConnection sock,
267 unsigned char *id_string);
268 void silc_client_new_channel_id(SilcClient client,
269 SilcSocketConnection sock,
272 unsigned char *id_string);
273 void silc_client_receive_channel_key(SilcClient client,
274 SilcSocketConnection sock,
276 void silc_client_channel_message(SilcClient client,
277 SilcSocketConnection sock,
278 SilcPacketContext *packet);
279 void silc_client_private_message(SilcClient client,
280 SilcSocketConnection sock,
281 SilcPacketContext *packet);