5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2002 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.
23 /* This function is used to remove all client entries by the server `entry'.
24 This is called when the connection is lost to the server. In this case
25 we must invalidate all the client entries owned by the server `entry'.
26 If the `server_signoff' is TRUE then the SERVER_SIGNOFF notify is
27 distributed to our local clients. */
28 bool silc_server_remove_clients_by_server(SilcServer server,
29 SilcServerEntry entry,
32 /* Updates the clients that are originated from the `from' to be originated
33 from the `to'. If the `resolve_real_server' is TRUE then this will
34 attempt to figure out which clients really are originated from the
35 `from' and which are originated from a server that we have connection
36 to, when we've acting as backup router. If it is FALSE the `to' will
37 be the new source. This function also removes the clients that are
38 *really* originated from `from' if `remove_from' is TRUE. These are
39 clients that the `from' owns, and not just clients that are behind
40 the `from'. If `from' is NULL then all non-local clients are switched
42 void silc_server_update_clients_by_server(SilcServer server,
45 bool resolve_real_server,
48 /* Updates servers that are from `from' to be originated from `to'. This
49 will also update the server's connection to `to's connection. */
50 void silc_server_update_servers_by_server(SilcServer server,
54 /* Toggles the enabled/disabled status of local server connections. Packets
55 can be sent to the servers when `toggle_enabled' is TRUE and will be
56 dropped if `toggle_enabled' is FALSE, after this function is called. */
57 void silc_server_local_servers_toggle_enabled(SilcServer server,
60 /* Removes channels that are from `from. */
61 void silc_server_remove_channels_by_server(SilcServer server,
62 SilcServerEntry from);
64 /* Updates channels that are from `from' to be originated from `to'. */
65 void silc_server_update_channels_by_server(SilcServer server,
69 /* Checks whether given channel has global users. If it does this returns
70 TRUE and FALSE if there is only locally connected clients on the channel. */
71 bool silc_server_channel_has_global(SilcChannelEntry channel);
73 /* Checks whether given channel has locally connected users. If it does this
74 returns TRUE and FALSE if there is not one locally connected client. */
75 bool silc_server_channel_has_local(SilcChannelEntry channel);
77 /* This function removes the channel and all users on the channel, unless
78 the channel is permanent. In this case the channel is disabled but all
79 users are removed from the channel. Returns TRUE if the channel is
80 destroyed totally, and FALSE if it is permanent and remains. */
81 bool silc_server_channel_delete(SilcServer server,
82 SilcChannelEntry channel);
84 /* Returns TRUE if the given client is on the channel. FALSE if not.
85 This works because we assure that the user list on the channel is
86 always in up to date thus we can only check the channel list from
87 `client' which is faster than checking the user list from `channel'. */
88 bool silc_server_client_on_channel(SilcClientEntry client,
89 SilcChannelEntry channel,
90 SilcChannelClientEntry *chl);
92 /* Checks string for bad characters and returns TRUE if they are found. */
93 bool silc_server_name_bad_chars(const char *name, SilcUInt32 name_len);
95 /* Modifies the `nick' if it includes bad characters and returns new
96 allocated nickname that does not include bad characters. */
97 char *silc_server_name_modify_bad(const char *name, SilcUInt32 name_len);
99 /* Find number of sockets by IP address indicated by `ip'. Returns 0 if
100 socket connections with the IP address does not exist. */
101 SilcUInt32 silc_server_num_sockets_by_ip(SilcServer server, const char *ip,
102 SilcSocketType type);
104 /* Find number of sockets by IP address indicated by remote host, indicated
105 by `ip' or `hostname', `port', and `type'. Returns 0 if socket connections
106 does not exist. If `ip' is provided then `hostname' is ignored. */
107 SilcUInt32 silc_server_num_sockets_by_remote(SilcServer server,
109 const char *hostname,
111 SilcSocketType type);
113 /* Finds locally cached public key by the public key received in the SKE.
114 If we have it locally cached then we trust it and will use it in the
115 authentication protocol. Returns the locally cached public key or NULL
116 if we do not find the public key. */
117 SilcPublicKey silc_server_find_public_key(SilcServer server,
118 SilcHashTable local_public_keys,
119 SilcPublicKey remote_public_key);
121 /* This returns the first public key from the table of public keys. This
122 is used only in cases where single public key exists in the table and
123 we want to get a pointer to it. For public key tables that has multiple
124 keys in it the silc_server_find_public_key must be used. */
125 SilcPublicKey silc_server_get_public_key(SilcServer server,
126 SilcHashTable local_public_keys);
128 /* Check whether the connection `sock' is allowed to connect to us. This
129 checks for example whether there is too much connections for this host,
130 and required version for the host etc. */
131 bool silc_server_connection_allowed(SilcServer server,
132 SilcSocketConnection sock,
134 SilcServerConfigConnParams *global,
135 SilcServerConfigConnParams *params,
138 /* Checks that client has rights to add or remove channel modes. If any
139 of the checks fails FALSE is returned. */
140 bool silc_server_check_cmode_rights(SilcServer server,
141 SilcChannelEntry channel,
142 SilcChannelClientEntry client,
145 /* Check that the client has rights to change its user mode. Returns
146 FALSE if setting some mode is not allowed. */
147 bool silc_server_check_umode_rights(SilcServer server,
148 SilcClientEntry client,
151 /* This function is used to send the notify packets and motd to the
152 incoming client connection. */
153 void silc_server_send_connect_notifys(SilcServer server,
154 SilcSocketConnection sock,
155 SilcClientEntry client);
157 /* Kill the client indicated by `remote_client' sending KILLED notify
158 to the client, to all channels client has joined and to primary
159 router if needed. The killed client is also removed from all channels. */
160 void silc_server_kill_client(SilcServer server,
161 SilcClientEntry remote_client,
164 SilcIdType killer_id_type);
166 /* This function checks whether the `client' nickname is being watched
167 by someone, and notifies the watcher of the notify change of notify
168 type indicated by `notify'. */
169 bool silc_server_check_watcher_list(SilcServer server,
170 SilcClientEntry client,
171 const char *new_nick,
172 SilcNotifyType notify);
174 /* Remove the `client' from watcher list. After calling this the `client'
175 is not watching any nicknames. */
176 bool silc_server_del_from_watcher_list(SilcServer server,
177 SilcClientEntry client);
179 /* Force the client indicated by `chl' to change the channel user mode
180 on channel indicated by `channel' to `forced_mode'. */
181 bool silc_server_force_cumode_change(SilcServer server,
182 SilcSocketConnection sock,
183 SilcChannelEntry channel,
184 SilcChannelClientEntry chl,
185 SilcUInt32 forced_mode);
187 /* Find active socket connection by the IP address and port indicated by
188 `ip' and `port', and socket connection type of `type'. */
190 silc_server_find_socket_by_host(SilcServer server,
192 const char *ip, SilcUInt16 port);
194 #endif /* SERVER_UTIL_H */