5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2001 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; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
20 #ifndef CLIENT_INTERNAL_H
21 #define CLIENT_INTERNAL_H
23 /* Context to hold the connection authentication request callbacks that
24 will be called when the server has replied back to our request about
25 current authentication method in the session. */
27 SilcConnectionAuthRequest callback;
30 } *SilcClientConnAuthRequest;
32 /* Generic rekey context for connections */
34 /* Current sending encryption key, provided for re-key. The `pfs'
35 is TRUE if the Perfect Forward Secrecy is performed in re-key. */
36 unsigned char *send_enc_key;
37 SilcUInt32 enc_key_len;
44 /* Internal context for connection process. This is needed as we
45 doing asynchronous connecting. */
48 SilcClientConnection conn;
55 } SilcClientInternalConnectContext;
57 /* Structure to hold ping time information. Every PING command will
58 add entry of this structure and is removed after reply to the ping
60 struct SilcClientPingStruct {
66 /* Structure to hold away messages set by user. This is mainly created
67 for future extensions where away messages could be set according filters
68 such as nickname and hostname. For now only one away message can
69 be set in one connection. */
70 struct SilcClientAwayStruct {
72 struct SilcClientAwayStruct *next;
75 /* Internal context for the client->internal pointer in the SilcClient. */
76 struct SilcClientInternalStruct {
77 /* All client operations that are implemented by the application. */
78 SilcClientOperations *ops;
80 /* Client Parameters */
81 SilcClientParams *params;
83 /* Table of connections in client. All the connection data is saved here. */
84 SilcClientConnection *conns;
85 SilcUInt32 conns_count;
87 /* Table of listenning sockets in client. Client can have listeners
88 (like key agreement protocol server) and those sockets are saved here.
89 This table is checked always if the connection object cannot be found
90 from the `conns' table. */
91 SilcSocketConnection *sockets;
92 SilcUInt32 sockets_count;
94 /* Registered commands */
97 /* Generic cipher and hash objects. */
98 SilcCipher none_cipher;
102 /* Client version. Used to compare to remote host's version strings. */
103 char *silc_client_version;
106 /* Internal context for conn->internal in SilcClientConnection. */
107 struct SilcClientConnectionInternalStruct {
108 /* Keys and stuff negotiated in the SKE protocol */
110 SilcCipher receive_key;
112 SilcHmac hmac_receive;
115 SilcUInt32 psn_receive;
117 /* Client ID and Channel ID cache. Messages transmitted in SILC network
118 are done using different unique ID's. These are the cache for
119 thoses ID's used in the communication. */
120 SilcIDCache client_cache;
121 SilcIDCache channel_cache;
122 SilcIDCache server_cache;
124 /* Pending command queue for this connection */
125 SilcDList pending_commands;
127 /* Requested pings. */
128 SilcClientPing *ping;
129 SilcUInt32 ping_count;
131 /* Set away message */
132 SilcClientAway *away;
135 SilcClientRekey rekey;
137 /* Authentication request context. */
138 SilcClientConnAuthRequest connauth;
140 /* File transmission sessions */
141 SilcDList ftp_sessions;
142 SilcUInt32 next_session_id;
143 SilcClientFtpSession active_session;
145 /* Requested Attributes */
148 /* Connection parameters */
149 SilcClientConnectionParams params;
152 /* Session resuming callback */
153 typedef void (*SilcClientResumeSessionCallback)(SilcClient client,
154 SilcClientConnection conn,
158 /* Rekey must be performed at the lastest when this many packets is sent */
159 #define SILC_CLIENT_REKEY_THRESHOLD 0xfffffe00
163 /* Registers generic task for file descriptor for reading from network and
164 writing to network. As being generic task the actual task is allocated
165 only once and after that the same task applies to all registered fd's. */
166 #define SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(fd) \
168 silc_schedule_task_add(client->schedule, (fd), \
169 silc_client_packet_process, \
172 SILC_TASK_PRI_NORMAL); \
175 #define SILC_CLIENT_SET_CONNECTION_FOR_INPUT(s, fd) \
177 silc_schedule_set_listen_fd((s), (fd), SILC_TASK_READ, FALSE); \
180 #define SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(s, fd) \
182 silc_schedule_set_listen_fd((s), (fd), (SILC_TASK_READ | \
183 SILC_TASK_WRITE), FALSE); \
186 /* Finds socket connection object by file descriptor */
187 #define SILC_CLIENT_GET_SOCK(__x, __fd, __sock) \
191 for (__i = 0; __i < (__x)->internal->conns_count; __i++) \
192 if ((__x)->internal->conns[__i] && \
193 (__x)->internal->conns[__i]->sock->sock == (__fd)) \
196 if (__i >= (__x)->internal->conns_count) { \
198 for (__i = 0; __i < (__x)->internal->sockets_count; __i++) \
199 if ((__x)->internal->sockets[__i] && \
200 (__x)->internal->sockets[__i]->sock == (__fd)) \
201 (__sock) = (__x)->internal->sockets[__i]; \
203 (__sock) = (__x)->internal->conns[__i]->sock; \
206 /* Check whether rekey protocol is active */
207 #define SILC_CLIENT_IS_REKEY(sock) \
208 (sock->protocol && sock->protocol->protocol && \
209 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)
213 SILC_TASK_CALLBACK_GLOBAL(silc_client_packet_process);
214 void silc_client_packet_send(SilcClient client,
215 SilcSocketConnection sock,
218 SilcIdType dst_id_type,
224 bool silc_client_packet_send_real(SilcClient client,
225 SilcSocketConnection sock,
227 void silc_client_ftp_free_sessions(SilcClient client,
228 SilcClientConnection conn);
229 void silc_client_ftp_session_free(SilcClientFtpSession session);
230 void silc_client_ftp_session_free_client(SilcClientConnection conn,
231 SilcClientEntry client_entry);
232 void silc_client_close_connection_real(SilcClient client,
233 SilcSocketConnection sock,
234 SilcClientConnection conn);
235 void silc_client_disconnected_by_server(SilcClient client,
236 SilcSocketConnection sock,
238 void silc_client_error_by_server(SilcClient client,
239 SilcSocketConnection sock,
241 void silc_client_receive_new_id(SilcClient client,
242 SilcSocketConnection sock,
244 void silc_client_save_channel_key(SilcClient client,
245 SilcClientConnection conn,
246 SilcBuffer key_payload,
247 SilcChannelEntry channel);
248 void silc_client_receive_channel_key(SilcClient client,
249 SilcSocketConnection sock,
251 void silc_client_channel_message(SilcClient client,
252 SilcSocketConnection sock,
253 SilcPacketContext *packet);
254 void silc_client_remove_from_channels(SilcClient client,
255 SilcClientConnection conn,
256 SilcClientEntry client_entry);
257 void silc_client_replace_from_channels(SilcClient client,
258 SilcClientConnection conn,
260 SilcClientEntry newclient);
261 void silc_client_process_failure(SilcClient client,
262 SilcSocketConnection sock,
263 SilcPacketContext *packet);
264 void silc_client_key_agreement(SilcClient client,
265 SilcSocketConnection sock,
266 SilcPacketContext *packet);
267 void silc_client_notify_by_server(SilcClient client,
268 SilcSocketConnection sock,
269 SilcPacketContext *packet);
270 void silc_client_private_message(SilcClient client,
271 SilcSocketConnection sock,
272 SilcPacketContext *packet);
273 void silc_client_connection_auth_request(SilcClient client,
274 SilcSocketConnection sock,
275 SilcPacketContext *packet);
276 void silc_client_ftp(SilcClient client,
277 SilcSocketConnection sock,
278 SilcPacketContext *packet);
279 SilcBuffer silc_client_get_detach_data(SilcClient client,
280 SilcClientConnection conn);
281 bool silc_client_process_detach_data(SilcClient client,
282 SilcClientConnection conn,
283 unsigned char **old_id,
284 SilcUInt16 *old_id_len);
285 void silc_client_resume_session(SilcClient client,
286 SilcClientConnection conn,
287 SilcClientResumeSessionCallback callback,
289 SilcBuffer silc_client_attributes_process(SilcClient client,
290 SilcSocketConnection sock,
292 SILC_TASK_CALLBACK_GLOBAL(silc_client_rekey_callback);