5 Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
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; 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 SILC Server object. The actual object is
25 defined in internal header file for server routines. I want to keep
26 the object private hence this declaration. */
27 typedef struct SilcServerStruct *SilcServer;
29 /* Forward declaration of backup server context */
30 typedef struct SilcServerBackupStruct *SilcServerBackup;
32 #define SILC_SERVER_MAX_CONNECTIONS 1000
34 /* General definitions */
37 #define SILC_PORT 768;
39 /* Server and router. Used internally by the code. */
42 #define SILC_BACKUP_ROUTER 2
44 /* Connection retry timeout. We implement exponential backoff algorithm
45 in connection retry. The interval of timeuot grows when retry count
47 #define SILC_SERVER_RETRY_COUNT 4 /* Max retry count */
48 #define SILC_SERVER_RETRY_MULTIPLIER 7 / 4 /* Interval growth */
49 #define SILC_SERVER_RETRY_RANDOMIZER 2 /* timeout += rnd % 2 */
50 #define SILC_SERVER_RETRY_INTERVAL_MIN 10 /* Min retry timeout */
51 #define SILC_SERVER_RETRY_INTERVAL_MAX 600 /* Max generated timeout */
56 Structure to hold various default parameters for server that can be
57 given before running the server.
62 uint32 retry_interval_min;
63 uint32 retry_interval_min_usec;
64 uint32 retry_interval_max;
65 char retry_keep_trying;
67 uint32 protocol_timeout;
68 uint32 protocol_timeout_usec;
70 char require_reverse_mapping;
73 /* Callback function that is called after the key exchange and connection
74 authentication protocols has been completed with a remote router. The
75 `server_entry' is the remote router entry. */
76 typedef void (*SilcServerConnectRouterCallback)(SilcServer server,
77 SilcServerEntry server_entry,
81 SilcSocketConnection sock;
83 /* Remote host name and port */
87 char *backup_replace_ip;
88 int backup_replace_port;
90 /* Current connection retry info */
94 /* Back pointer to server */
97 SilcServerConnectRouterCallback callback;
98 void *callback_context;
99 } *SilcServerConnection;
103 /* This macro is used to send notify messages with formatted string. The
104 string is formatted with arguments and the formatted string is sent as
106 #define SILC_SERVER_SEND_NOTIFY(server, sock, type, fmt) \
108 char *__fmt__ = silc_format fmt; \
109 silc_server_send_notify(server, sock, FALSE, \
110 type, 1, __fmt__, strlen(__fmt__)); \
111 silc_free(__fmt__); \
114 /* Check whether rekey protocol is active */
115 #define SILC_SERVER_IS_REKEY(sock) \
116 (sock->protocol && sock->protocol->protocol && \
117 sock->protocol->protocol->type == SILC_PROTOCOL_SERVER_REKEY)
120 int silc_server_alloc(SilcServer *new_server);
121 void silc_server_free(SilcServer server);
122 int silc_server_init(SilcServer server);
123 void silc_server_daemonise(SilcServer server);
124 void silc_server_drop(SilcServer server);
125 void silc_server_run(SilcServer server);
126 void silc_server_stop(SilcServer server);
127 void silc_server_start_key_exchange(SilcServer server,
128 SilcServerConnection sconn,
130 bool silc_server_packet_parse(SilcPacketParserContext *parser_context,
132 void silc_server_packet_parse_type(SilcServer server,
133 SilcSocketConnection sock,
134 SilcPacketContext *packet);
135 void silc_server_create_connection(SilcServer server,
136 char *remote_host, uint32 port);
137 void silc_server_close_connection(SilcServer server,
138 SilcSocketConnection sock);
139 void silc_server_free_client_data(SilcServer server,
140 SilcSocketConnection sock,
141 SilcClientEntry client,
144 void silc_server_free_sock_user_data(SilcServer server,
145 SilcSocketConnection sock);
146 void silc_server_remove_from_channels(SilcServer server,
147 SilcSocketConnection sock,
148 SilcClientEntry client,
150 char *signoff_message,
152 int silc_server_remove_from_one_channel(SilcServer server,
153 SilcSocketConnection sock,
154 SilcChannelEntry channel,
155 SilcClientEntry client,
157 void silc_server_disconnect_remote(SilcServer server,
158 SilcSocketConnection sock,
159 const char *fmt, ...);
160 SilcChannelEntry silc_server_create_new_channel(SilcServer server,
161 SilcServerID *router_id,
167 silc_server_create_new_channel_with_id(SilcServer server,
171 SilcChannelID *channel_id,
173 bool silc_server_create_channel_key(SilcServer server,
174 SilcChannelEntry channel,
176 SilcChannelEntry silc_server_save_channel_key(SilcServer server,
177 SilcBuffer key_payload,
178 SilcChannelEntry channel);
179 void silc_server_perform_heartbeat(SilcSocketConnection sock,
181 void silc_server_announce_get_channel_users(SilcServer server,
182 SilcChannelEntry channel,
183 SilcBuffer *channel_users,
184 SilcBuffer *channel_users_modes);
185 void silc_server_announce_get_channels(SilcServer server,
187 SilcBuffer *channels,
188 SilcBuffer *channel_users,
189 SilcBuffer **channel_users_modes,
190 uint32 *channel_users_modes_c,
191 SilcChannelID ***channel_ids,
192 unsigned long creation_time);
193 void silc_server_announce_servers(SilcServer server, bool global,
194 unsigned long creation_time,
195 SilcSocketConnection remote);
196 void silc_server_announce_clients(SilcServer server,
197 unsigned long creation_time,
198 SilcSocketConnection remote);
199 void silc_server_announce_channels(SilcServer server,
200 unsigned long creation_time,
201 SilcSocketConnection remote);
202 void silc_server_get_users_on_channel(SilcServer server,
203 SilcChannelEntry channel,
204 SilcBuffer *user_list,
205 SilcBuffer *mode_list,
207 void silc_server_save_users_on_channel(SilcServer server,
208 SilcSocketConnection sock,
209 SilcChannelEntry channel,
211 SilcBuffer user_list,
212 SilcBuffer mode_list,
214 SilcSocketConnection silc_server_get_client_route(SilcServer server,
215 unsigned char *id_data,
217 SilcClientID *client_id,
218 SilcIDListData *idata);
219 SilcBuffer silc_server_get_client_channel_list(SilcServer server,
220 SilcClientEntry client);
221 SilcClientEntry silc_server_get_client_resolve(SilcServer server,
222 SilcClientID *client_id);