lib/silcserver/server_util.h

   1 /*
   2
   3   server_util.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2005 Pekka Riikonen
   8
   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.
  12
  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.
  17
  18 */
  19
  20 #ifndef SERVER_UTIL_H
  21 #define SERVER_UTIL_H
  22
  23 /* This function removes all client entries that are originated from
  24    `router' and are owned by `entry'.  `router' and `entry' can be same
  25    too.  If `server_signoff' is TRUE then SERVER_SIGNOFF notify is
  26    distributed to our local clients. */
  27 SilcBool silc_server_remove_clients_by_server(SilcServer server,
  28                                           SilcServerEntry router,
  29                                           SilcServerEntry entry,
  30                                           SilcBool server_signoff);
  31
  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.  If `from' is NULL then all clients (except locally
  38    connected) are updated `to'. */
  39 void silc_server_update_clients_by_server(SilcServer server,
  40                                           SilcServerEntry from,
  41                                           SilcServerEntry to,
  42                                           SilcBool resolve_real_server);
  43
  44 /* Updates servers that are from `from' to be originated from `to'.  This
  45    will also update the server's connection to `to's connection. */
  46 void silc_server_update_servers_by_server(SilcServer server,
  47                                           SilcServerEntry from,
  48                                           SilcServerEntry to);
  49
  50 /* Toggles the enabled/disabled status of local server connections.  Packets
  51    can be sent to the servers when `toggle_enabled' is TRUE and will be
  52    dropped if `toggle_enabled' is FALSE, after this function is called. */
  53 void silc_server_local_servers_toggle_enabled(SilcServer server,
  54                                               SilcBool toggle_enabled);
  55
  56 /* Removes servers that are originated from the `from'.  The server
  57    entry is deleted in this function.  If `remove_clients' is TRUE then
  58    all clients originated from the server are removed too, and server
  59    signoff is sent.  Note that this does not remove the `from'.  This
  60    also does not remove locally connected servers. */
  61 void silc_server_remove_servers_by_server(SilcServer server,
  62                                           SilcServerEntry from,
  63                                           SilcBool remove_clients);
  64
  65 /* Removes channels that are from `from. */
  66 void silc_server_remove_channels_by_server(SilcServer server,
  67                                            SilcServerEntry from);
  68
  69 /* Updates channels that are from `from' to be originated from `to'.  */
  70 void silc_server_update_channels_by_server(SilcServer server,
  71                                            SilcServerEntry from,
  72                                            SilcServerEntry to);
  73
  74 /* Checks whether given channel has global users.  If it does this returns
  75    TRUE and FALSE if there is only locally connected clients on the channel. */
  76 SilcBool silc_server_channel_has_global(SilcChannelEntry channel);
  77
  78 /* Checks whether given channel has locally connected users.  If it does this
  79    returns TRUE and FALSE if there is not one locally connected client. */
  80 SilcBool silc_server_channel_has_local(SilcChannelEntry channel);
  81
  82 /* This function removes the channel and all users on the channel, unless
  83    the channel is permanent.  In this case the channel is disabled but all
  84    users are removed from the channel.  Returns TRUE if the channel is
  85    destroyed totally, and FALSE if it is permanent and remains. */
  86 SilcBool silc_server_channel_delete(SilcServer server,
  87                                 SilcChannelEntry channel);
  88
  89 /* Returns TRUE if the given client is on the channel.  FALSE if not.
  90    This works because we assure that the user list on the channel is
  91    always in up to date thus we can only check the channel list from
  92    `client' which is faster than checking the user list from `channel'. */
  93 SilcBool silc_server_client_on_channel(SilcClientEntry client,
  94                                    SilcChannelEntry channel,
  95                                    SilcChannelClientEntry *chl);
  96
  97 /* Find number of sockets by IP address indicated by `ip'. Returns 0 if
  98    socket connections with the IP address does not exist. */
  99 SilcUInt32 silc_server_num_sockets_by_ip(SilcServer server, const char *ip,
 100                                          SilcSocketType type);
 101
 102 /* Find number of sockets by IP address indicated by remote host, indicated
 103    by `ip' or `hostname', `port', and `type'.  Returns 0 if socket connections
 104    does not exist. If `ip' is provided then `hostname' is ignored. */
 105 SilcUInt32 silc_server_num_sockets_by_remote(SilcServer server,
 106                                              const char *ip,
 107                                              const char *hostname,
 108                                              SilcUInt16 port,
 109                                              SilcSocketType type);
 110
 111 /* Finds locally cached public key by the public key received in the SKE.
 112    If we have it locally cached then we trust it and will use it in the
 113    authentication protocol.  Returns the locally cached public key or NULL
 114    if we do not find the public key.  */
 115 SilcPublicKey silc_server_find_public_key(SilcServer server,
 116                                           SilcHashTable local_public_keys,
 117                                           SilcPublicKey remote_public_key);
 118
 119 /* This returns the first public key from the table of public keys.  This
 120    is used only in cases where single public key exists in the table and
 121    we want to get a pointer to it.  For public key tables that has multiple
 122    keys in it the silc_server_find_public_key must be used. */
 123 SilcPublicKey silc_server_get_public_key(SilcServer server,
 124                                          SilcHashTable local_public_keys);
 125
 126 /* Check whether the connection `sock' is allowed to connect to us.  This
 127    checks for example whether there is too much connections for this host,
 128    and required version for the host etc. */
 129 SilcBool silc_server_connection_allowed(SilcServer server,
 130                                     SilcSocketConnection sock,
 131                                     SilcSocketType type,
 132                                     SilcServerConfigConnParams *global,
 133                                     SilcServerConfigConnParams *params,
 134                                     SilcSKE ske);
 135
 136 /* Checks that client has rights to add or remove channel modes. If any
 137    of the checks fails FALSE is returned. */
 138 SilcBool silc_server_check_cmode_rights(SilcServer server,
 139                                     SilcChannelEntry channel,
 140                                     SilcChannelClientEntry client,
 141                                     SilcUInt32 mode);
 142
 143 /* Check that the client has rights to change its user mode.  Returns
 144    FALSE if setting some mode is not allowed. */
 145 SilcBool silc_server_check_umode_rights(SilcServer server,
 146                                     SilcClientEntry client,
 147                                     SilcUInt32 mode);
 148
 149 /* This function is used to send the notify packets and motd to the
 150    incoming client connection. */
 151 void silc_server_send_connect_notifys(SilcServer server,
 152                                       SilcSocketConnection sock,
 153                                       SilcClientEntry client);
 154
 155 /* Kill the client indicated by `remote_client' sending KILLED notify
 156    to the client, to all channels client has joined and to primary
 157    router if needed.  The killed client is also removed from all channels. */
 158 void silc_server_kill_client(SilcServer server,
 159                              SilcClientEntry remote_client,
 160                              const char *comment,
 161                              void *killer_id,
 162                              SilcIdType killer_id_type);
 163
 164 /* This function checks whether the `client' nickname is being watched
 165    by someone, and notifies the watcher of the notify change of notify
 166    type indicated by `notify'. */
 167 SilcBool silc_server_check_watcher_list(SilcServer server,
 168                                     SilcClientEntry client,
 169                                     const char *new_nick,
 170                                     SilcNotifyType notify);
 171
 172 /* Remove the `client' from watcher list. After calling this the `client'
 173    is not watching any nicknames. */
 174 SilcBool silc_server_del_from_watcher_list(SilcServer server,
 175                                        SilcClientEntry client);
 176
 177 /* Force the client indicated by `chl' to change the channel user mode
 178    on channel indicated by `channel' to `forced_mode'. */
 179 SilcBool silc_server_force_cumode_change(SilcServer server,
 180                                      SilcSocketConnection sock,
 181                                      SilcChannelEntry channel,
 182                                      SilcChannelClientEntry chl,
 183                                      SilcUInt32 forced_mode);
 184
 185 /* Find active socket connection by the IP address and port indicated by
 186    `ip' and `port', and socket connection type of `type'. */
 187 SilcSocketConnection
 188 silc_server_find_socket_by_host(SilcServer server,
 189                                 SilcSocketType type,
 190                                 const char *ip, SilcUInt16 port);
 191
 192 /* This function can be used to match the invite and ban lists. */
 193 SilcBool silc_server_inviteban_match(SilcServer server, SilcHashTable list,
 194                                  SilcUInt8 type, void *check);
 195
 196 /* Process invite or ban information */
 197 SilcBool silc_server_inviteban_process(SilcServer server, SilcHashTable list,
 198                                    SilcUInt8 action, SilcArgumentPayload args);
 199
 200 /* Destructor for invite or ban list entrys */
 201 void silc_server_inviteban_destruct(void *key, void *context,
 202                                     void *user_context);
 203
 204 /* Creates connections according to configuration. */
 205 void silc_server_create_connections(SilcServer server);
 206
 207
 208 /* Processes a channel public key, either adds or removes it. */
 209 SilcStatus
 210 silc_server_process_channel_pk(SilcServer server,
 211                                SilcChannelEntry channel,
 212                                SilcUInt32 type, const unsigned char *pk,
 213                                SilcUInt32 pk_len);
 214
 215 /* Returns the channel public keys as Argument List payload. */
 216 SilcBuffer silc_server_get_channel_pk_list(SilcServer server,
 217                                            SilcChannelEntry channel,
 218                                            SilcBool announce,
 219                                            SilcBool delete);
 220
 221 /* Sets the channel public keys into channel from the list of public keys. */
 222 SilcStatus silc_server_set_channel_pk_list(SilcServer server,
 223                                            SilcSocketConnection sender,
 224                                            SilcChannelEntry channel,
 225                                            const unsigned char *pklist,
 226                                            SilcUInt32 pklist_len);
 227
 228 /* Verifies the Authentication Payload `auth' with one of the public keys
 229    on the `channel' public key list. */
 230 SilcBool silc_server_verify_channel_auth(SilcServer server,
 231                                      SilcChannelEntry channel,
 232                                      SilcClientID *client_id,
 233                                      const unsigned char *auth,
 234                                      SilcUInt32 auth_len);
 235
 236 #endif /* SERVER_UTIL_H */