apps/silcd/server_util.h

   1 /*
   2
   3   server_util.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2005, 2007 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                                          SilcConnectionType 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
 110 /* Get public key by key usage and key context. */
 111 SilcPublicKey silc_server_get_public_key(SilcServer server,
 112                                          SilcSKRKeyUsage usage,
 113                                          void *key_context);
 114
 115 /* Check whether the connection `sock' is allowed to connect to us.  This
 116    checks for example whether there is too much connections for this host,
 117    and required version for the host etc. */
 118 SilcBool silc_server_connection_allowed(SilcServer server,
 119                                         SilcPacketStream sock,
 120                                         SilcConnectionType type,
 121                                         SilcServerConfigConnParams *global,
 122                                         SilcServerConfigConnParams *params,
 123                                         SilcSKE ske);
 124
 125 /* Checks that client has rights to add or remove channel modes. If any
 126    of the checks fails FALSE is returned. */
 127 SilcBool silc_server_check_cmode_rights(SilcServer server,
 128                                     SilcChannelEntry channel,
 129                                     SilcChannelClientEntry client,
 130                                     SilcUInt32 mode);
 131
 132 /* Check that the client has rights to change its user mode.  Returns
 133    FALSE if setting some mode is not allowed. */
 134 SilcBool silc_server_check_umode_rights(SilcServer server,
 135                                     SilcClientEntry client,
 136                                     SilcUInt32 mode);
 137
 138 /* This function is used to send the notify packets and motd to the
 139    incoming client connection. */
 140 void silc_server_send_connect_notifys(SilcServer server,
 141                                       SilcPacketStream sock,
 142                                       SilcClientEntry client);
 143
 144 /* Kill the client indicated by `remote_client' sending KILLED notify
 145    to the client, to all channels client has joined and to primary
 146    router if needed.  The killed client is also removed from all channels. */
 147 void silc_server_kill_client(SilcServer server,
 148                              SilcClientEntry remote_client,
 149                              const char *comment,
 150                              void *killer_id,
 151                              SilcIdType killer_id_type);
 152
 153 /* This function checks whether the `client' nickname is being watched
 154    by someone, and notifies the watcher of the notify change of notify
 155    type indicated by `notify'. */
 156 SilcBool silc_server_check_watcher_list(SilcServer server,
 157                                     SilcClientEntry client,
 158                                     const char *new_nick,
 159                                     SilcNotifyType notify);
 160
 161 /* Remove the `client' from watcher list. After calling this the `client'
 162    is not watching any nicknames. */
 163 SilcBool silc_server_del_from_watcher_list(SilcServer server,
 164                                        SilcClientEntry client);
 165
 166 /* Force the client indicated by `chl' to change the channel user mode
 167    on channel indicated by `channel' to `forced_mode'. */
 168 SilcBool silc_server_force_cumode_change(SilcServer server,
 169                                      SilcPacketStream sock,
 170                                      SilcChannelEntry channel,
 171                                      SilcChannelClientEntry chl,
 172                                      SilcUInt32 forced_mode);
 173
 174 /* Find active socket connection by the IP address and port indicated by
 175    `ip' and `port', and socket connection type of `type'. */
 176 SilcPacketStream
 177 silc_server_find_socket_by_host(SilcServer server,
 178                                 SilcConnectionType type,
 179                                 const char *ip, SilcUInt16 port);
 180
 181 /* This function can be used to match the invite and ban lists. */
 182 SilcBool silc_server_inviteban_match(SilcServer server, SilcHashTable list,
 183                                  SilcUInt8 type, void *check);
 184
 185 /* Process invite or ban information */
 186 SilcBool silc_server_inviteban_process(SilcServer server, SilcHashTable list,
 187                                    SilcUInt8 action, SilcArgumentPayload args);
 188
 189 /* Destructor for invite or ban list entrys */
 190 void silc_server_inviteban_destruct(void *key, void *context,
 191                                     void *user_context);
 192
 193 /* Creates connections according to configuration. */
 194 void silc_server_create_connections(SilcServer server);
 195
 196
 197 /* Processes a channel public key, either adds or removes it. */
 198 SilcStatus
 199 silc_server_process_channel_pk(SilcServer server,
 200                                SilcChannelEntry channel,
 201                                SilcUInt32 type, const unsigned char *pk,
 202                                SilcUInt32 pk_len);
 203
 204 /* Returns the channel public keys as Argument List payload. */
 205 SilcBuffer silc_server_get_channel_pk_list(SilcServer server,
 206                                            SilcChannelEntry channel,
 207                                            SilcBool announce,
 208                                            SilcBool delete);
 209
 210 /* Sets the channel public keys into channel from the list of public keys. */
 211 SilcStatus silc_server_set_channel_pk_list(SilcServer server,
 212                                            SilcPacketStream sender,
 213                                            SilcChannelEntry channel,
 214                                            const unsigned char *pklist,
 215                                            SilcUInt32 pklist_len);
 216
 217 /* Verifies the Authentication Payload `auth' with one of the public keys
 218    on the `channel' public key list. */
 219 SilcBool silc_server_verify_channel_auth(SilcServer server,
 220                                      SilcChannelEntry channel,
 221                                      SilcClientID *client_id,
 222                                      const unsigned char *auth,
 223                                      SilcUInt32 auth_len);
 224
 225 #endif /* SERVER_UTIL_H */