apps/silcd/server.h

   1 /*
   2
   3   server.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2002 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; either version 2 of the License, or
  12   (at your option) any later version.
  13
  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.
  18
  19 */
  20
  21 #ifndef SERVER_H
  22 #define SERVER_H
  23
  24 /* Forward declaration of backup server context */
  25 typedef struct SilcServerBackupStruct *SilcServerBackup;
  26
  27 /* Callback function that is called after the key exchange and connection
  28    authentication protocols has been completed with a remote router. The
  29    `server_entry' is the remote router entry or NULL on error. */
  30 typedef void (*SilcServerConnectRouterCallback)(SilcServer server,
  31                                                 SilcServerEntry server_entry,
  32                                                 void *context);
  33
  34 /* Connection structure used when connection to remote */
  35 typedef struct {
  36   SilcSocketConnection sock;
  37
  38   /* Remote host name and port */
  39   char *remote_host;
  40   int remote_port;
  41   bool backup;
  42   char *backup_replace_ip;
  43   int backup_replace_port;
  44   bool no_reconnect;
  45
  46   /* Connection configuration (maybe NULL) */
  47   SilcServerConfigRef conn;
  48
  49   /* Current connection retry info */
  50   SilcUInt32 retry_count;
  51   SilcUInt32 retry_timeout;
  52
  53   SilcServerConnectRouterCallback callback;
  54   void *callback_context;
  55 } *SilcServerConnection;
  56
  57 /* General definitions */
  58
  59 /* SILC port */
  60 #define SILC_PORT 706
  61
  62 /* Server and router. Used internally by the code. */
  63 #define SILC_SERVER 0
  64 #define SILC_ROUTER 1
  65 #define SILC_BACKUP_ROUTER 2
  66
  67 /* Default parameter values */
  68
  69 /* Connection retry timeout. We implement exponential backoff algorithm
  70    in connection retry. The interval of timeout grows when retry count
  71    grows. */
  72 #define SILC_SERVER_RETRY_COUNT        7         /* Max retry count */
  73 #define SILC_SERVER_RETRY_MULTIPLIER   2         /* Interval growth */
  74 #define SILC_SERVER_RETRY_RANDOMIZER   2         /* timeout += rnd % 2 */
  75 #define SILC_SERVER_RETRY_INTERVAL_MIN 10        /* Min retry timeout */
  76 #define SILC_SERVER_RETRY_INTERVAL_MAX 600       /* Max generated timeout */
  77
  78 #define SILC_SERVER_KEEPALIVE          300       /* Heartbeat interval */
  79 #define SILC_SERVER_CHANNEL_REKEY      3600      /* Channel rekey interval */
  80 #define SILC_SERVER_REKEY              3600      /* Session rekey interval */
  81 #define SILC_SERVER_SKE_TIMEOUT        60        /* SKE timeout */
  82 #define SILC_SERVER_CONNAUTH_TIMEOUT   60        /* CONN_AUTH timeout */
  83 #define SILC_SERVER_MAX_CONNECTIONS    1000      /* Max connections */
  84 #define SILC_SERVER_MAX_CONNECTIONS_SINGLE 1000  /* Max connections per host */
  85 #define SILC_SERVER_LOG_FLUSH_DELAY    300       /* Default log flush delay */
  86 #define SILC_SERVER_QOS_RATE_LIMIT     10        /* Default QoS rate limit */
  87 #define SILC_SERVER_QOS_BYTES_LIMIT    2048      /* Default QoS bytes limit */
  88 #define SILC_SERVER_QOS_LIMIT_SEC      0         /* Default QoS limit sec */
  89 #define SILC_SERVER_QOS_LIMIT_USEC     500000    /* Default QoS limit usec */
  90
  91 /* Macros */
  92
  93 /* This macro is used to send notify messages with formatted string. The
  94    string is formatted with arguments and the formatted string is sent as
  95    argument. */
  96 #define SILC_SERVER_SEND_NOTIFY(server, sock, type, fmt)        \
  97 do {                                                            \
  98   char *__fmt__ = silc_format fmt;                              \
  99   silc_server_send_notify(server, sock, FALSE,                  \
 100                           type, 1, __fmt__, strlen(__fmt__));   \
 101   silc_free(__fmt__);                                           \
 102 } while(0)
 103
 104 /* Send notify to operators */
 105 #define SILC_SERVER_SEND_OPERS(server, route, local, type, fmt)         \
 106 do {                                                                    \
 107   char *__fmt__ = silc_format fmt;                                      \
 108   silc_server_send_opers_notify(server, route, local,                   \
 109                                 type, 1, __fmt__, strlen(__fmt__));     \
 110   silc_free(__fmt__);                                                   \
 111 } while(0)
 112
 113 /* Check whether rekey protocol is active */
 114 #define SILC_SERVER_IS_REKEY(sock)                                      \
 115   (sock->protocol && sock->protocol->protocol &&                        \
 116    sock->protocol->protocol->type == SILC_PROTOCOL_SERVER_REKEY)
 117
 118 /* Check whether backup resuming protocol is active */
 119 #define SILC_SERVER_IS_BACKUP(sock)                                     \
 120   (sock->protocol && sock->protocol->protocol &&                        \
 121    sock->protocol->protocol->type == SILC_PROTOCOL_SERVER_BACKUP)
 122
 123 /* Output a message to stderr or to the appropriate log facility wether
 124    we are in the background or not. */
 125 #define SILC_SERVER_LOG_INFO(fmt)                                       \
 126   silc_server_stderr(SILC_LOG_INFO, silc_format fmt)
 127 #define SILC_SERVER_LOG_WARNING(fmt)                                    \
 128   silc_server_stderr(SILC_LOG_WARNING, silc_format fmt)
 129 #define SILC_SERVER_LOG_ERROR(fmt)                                      \
 130   silc_server_stderr(SILC_LOG_ERROR, silc_format fmt)
 131 #define SILC_SERVER_LOG_FATAL(fmt)                                      \
 132   silc_server_stderr(SILC_LOG_WARNING, silc_format fmt)
 133
 134 /* Prototypes */
 135 int silc_server_alloc(SilcServer *new_server);
 136 void silc_server_free(SilcServer server);
 137 bool silc_server_init(SilcServer server);
 138 bool silc_server_rehash(SilcServer server);
 139 void silc_server_run(SilcServer server);
 140 void silc_server_stop(SilcServer server);
 141 void silc_server_start_key_exchange(SilcServer server,
 142                                     SilcServerConnection sconn,
 143                                     int sock);
 144 bool silc_server_packet_parse(SilcPacketParserContext *parser_context,
 145                               void *context);
 146 void silc_server_packet_parse_type(SilcServer server,
 147                                    SilcSocketConnection sock,
 148                                    SilcPacketContext *packet);
 149 void silc_server_create_connection(SilcServer server,
 150                                    const char *remote_host, SilcUInt32 port);
 151 void silc_server_close_connection(SilcServer server,
 152                                   SilcSocketConnection sock);
 153 void silc_server_free_client_data(SilcServer server,
 154                                   SilcSocketConnection sock,
 155                                   SilcClientEntry client,
 156                                   int notify,
 157                                   const char *signoff);
 158 void silc_server_free_sock_user_data(SilcServer server,
 159                                      SilcSocketConnection sock,
 160                                      const char *signoff_message);
 161 void silc_server_remove_from_channels(SilcServer server,
 162                                       SilcSocketConnection sock,
 163                                       SilcClientEntry client,
 164                                       bool notify,
 165                                       const char *signoff_message,
 166                                       bool keygen, bool killed);
 167 bool silc_server_remove_from_one_channel(SilcServer server,
 168                                          SilcSocketConnection sock,
 169                                          SilcChannelEntry channel,
 170                                          SilcClientEntry client,
 171                                          bool notify);
 172 void silc_server_disconnect_remote(SilcServer server,
 173                                    SilcSocketConnection sock,
 174                                    SilcStatus status, ...);
 175 SilcChannelEntry silc_server_create_new_channel(SilcServer server,
 176                                                 SilcServerID *router_id,
 177                                                 char *cipher,
 178                                                 char *hmac,
 179                                                 char *channel_name,
 180                                                 int broadcast);
 181 SilcChannelEntry
 182 silc_server_create_new_channel_with_id(SilcServer server,
 183                                        char *cipher,
 184                                        char *hmac,
 185                                        char *channel_name,
 186                                        SilcChannelID *channel_id,
 187                                        int broadcast);
 188 bool silc_server_create_channel_key(SilcServer server,
 189                                     SilcChannelEntry channel,
 190                                     SilcUInt32 key_len);
 191 SilcChannelEntry silc_server_save_channel_key(SilcServer server,
 192                                               SilcBuffer key_payload,
 193                                               SilcChannelEntry channel);
 194 void silc_server_perform_heartbeat(SilcSocketConnection sock,
 195                                    void *hb_context);
 196 void silc_server_announce_get_channel_topic(SilcServer server,
 197                                             SilcChannelEntry channel,
 198                                             SilcBuffer *topic);
 199 void silc_server_announce_get_channel_users(SilcServer server,
 200                                             SilcChannelEntry channel,
 201                                             SilcBuffer *channel_modes,
 202                                             SilcBuffer *channel_users,
 203                                             SilcBuffer *channel_users_modes);
 204 void silc_server_announce_get_channels(SilcServer server,
 205                                        SilcIDList id_list,
 206                                        SilcBuffer *channels,
 207                                        SilcBuffer **channel_modes,
 208                                        SilcBuffer *channel_users,
 209                                        SilcBuffer **channel_users_modes,
 210                                        SilcUInt32 *channel_users_modes_c,
 211                                        SilcBuffer **channel_topics,
 212                                        SilcBuffer **channel_invites,
 213                                        SilcBuffer **channel_bans,
 214                                        SilcChannelID ***channel_ids,
 215                                        unsigned long creation_time);
 216 void silc_server_announce_servers(SilcServer server, bool global,
 217                                   unsigned long creation_time,
 218                                   SilcSocketConnection remote);
 219 void silc_server_announce_clients(SilcServer server,
 220                                   unsigned long creation_time,
 221                                   SilcSocketConnection remote);
 222 void silc_server_announce_channels(SilcServer server,
 223                                    unsigned long creation_time,
 224                                    SilcSocketConnection remote);
 225 bool silc_server_get_users_on_channel(SilcServer server,
 226                                       SilcChannelEntry channel,
 227                                       SilcBuffer *user_list,
 228                                       SilcBuffer *mode_list,
 229                                       SilcUInt32 *user_count);
 230 void silc_server_save_users_on_channel(SilcServer server,
 231                                        SilcSocketConnection sock,
 232                                        SilcChannelEntry channel,
 233                                        SilcClientID *noadd,
 234                                        SilcBuffer user_list,
 235                                        SilcBuffer mode_list,
 236                                        SilcUInt32 user_count);
 237 void silc_server_save_user_channels(SilcServer server,
 238                                     SilcSocketConnection sock,
 239                                     SilcClientEntry client,
 240                                     SilcBuffer channels,
 241                                     SilcBuffer channels_user_modes);
 242 SilcSocketConnection
 243 silc_server_get_client_route(SilcServer server,
 244                              unsigned char *id_data,
 245                              SilcUInt32 id_len,
 246                              SilcClientID *client_id,
 247                              SilcIDListData *idata,
 248                              SilcClientEntry *client_entry);
 249 SilcBuffer silc_server_get_client_channel_list(SilcServer server,
 250                                                SilcClientEntry client,
 251                                                bool get_private,
 252                                                bool get_secret,
 253                                                SilcBuffer *user_mode_list);
 254 void silc_server_stderr(SilcLogType type, char *message);
 255
 256 #endif