apps/silcd/server.h

   1 /*
   2
   3   server.h
   4
   5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
   6
   7   Copyright (C) 1997 - 2001 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 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;
  28
  29 #define SILC_SERVER_MAX_CONNECTIONS 1000
  30
  31 /* General definitions */
  32
  33 /* SILC port */
  34 #define SILC_PORT 768;
  35
  36 /* Server and router. Used internally by the code. */
  37 #define SILC_SERVER 0
  38 #define SILC_ROUTER 1
  39
  40 /* Connection retry timeout. We implement exponential backoff algorithm
  41    in connection retry. The interval of timeuot grows when retry count
  42    grows. */
  43 #define SILC_SERVER_RETRY_COUNT        4         /* Max retry count */
  44 #define SILC_SERVER_RETRY_MULTIPLIER   7 / 4     /* Interval growth */
  45 #define SILC_SERVER_RETRY_RANDOMIZER   2         /* timeout += rnd % 2 */
  46 #define SILC_SERVER_RETRY_INTERVAL_MIN 10        /* Min retry timeout */
  47 #define SILC_SERVER_RETRY_INTERVAL_MAX 600       /* Max generated timeout */
  48
  49 /*
  50    Silc Server Params.
  51
  52    Structure to hold various default parameters for server that can be
  53    given before running the server.
  54
  55 */
  56 typedef struct {
  57   uint32 retry_count;
  58   uint32 retry_interval_min;
  59   uint32 retry_interval_min_usec;
  60   uint32 retry_interval_max;
  61   char retry_keep_trying;
  62
  63   uint32 protocol_timeout;
  64   uint32 protocol_timeout_usec;
  65
  66   char require_reverse_mapping;
  67 } *SilcServerParams;
  68
  69 /* Macros */
  70
  71 /* This macro is used to send notify messages with formatted string. The
  72    string is formatted with arguments and the formatted string is sent as
  73    argument. */
  74 #define SILC_SERVER_SEND_NOTIFY(server, sock, type, fmt)        \
  75 do {                                                            \
  76   char *__fmt__ = silc_format fmt;                              \
  77   silc_server_send_notify(server, sock, FALSE,                  \
  78                           type, 1, __fmt__, strlen(__fmt__));   \
  79   silc_free(__fmt__);                                           \
  80 } while(0);
  81
  82 /* Check whether rekey protocol is active */
  83 #define SILC_SERVER_IS_REKEY(sock)                                      \
  84   (sock->protocol && sock->protocol->protocol &&                        \
  85    sock->protocol->protocol->type == SILC_PROTOCOL_SERVER_REKEY)
  86
  87 /* Prototypes */
  88 int silc_server_alloc(SilcServer *new_server);
  89 void silc_server_free(SilcServer server);
  90 int silc_server_init(SilcServer server);
  91 void silc_server_daemonise(SilcServer server);
  92 void silc_server_run(SilcServer server);
  93 void silc_server_stop(SilcServer server);
  94 void silc_server_packet_parse(SilcPacketParserContext *parser_context);
  95 void silc_server_packet_parse_type(SilcServer server,
  96                                    SilcSocketConnection sock,
  97                                    SilcPacketContext *packet);
  98 void silc_server_create_connection(SilcServer server,
  99                                    char *remote_host, uint32 port);
 100 void silc_server_close_connection(SilcServer server,
 101                                   SilcSocketConnection sock);
 102 void silc_server_free_client_data(SilcServer server,
 103                                   SilcSocketConnection sock,
 104                                   SilcClientEntry client,
 105                                   int notify,
 106                                   char *signoff);
 107 void silc_server_free_sock_user_data(SilcServer server,
 108                                      SilcSocketConnection sock);
 109 int silc_server_channel_has_global(SilcChannelEntry channel);
 110 int silc_server_channel_has_local(SilcChannelEntry channel);
 111 int silc_server_remove_clients_by_server(SilcServer server,
 112                                          SilcServerEntry entry,
 113                                          int server_signoff);
 114 void silc_server_remove_from_channels(SilcServer server,
 115                                       SilcSocketConnection sock,
 116                                       SilcClientEntry client,
 117                                       int notify,
 118                                       char *signoff_message,
 119                                       int keygen);
 120 int silc_server_remove_from_one_channel(SilcServer server,
 121                                         SilcSocketConnection sock,
 122                                         SilcChannelEntry channel,
 123                                         SilcClientEntry client,
 124                                         int notify);
 125 int silc_server_client_on_channel(SilcClientEntry client,
 126                                   SilcChannelEntry channel);
 127 void silc_server_disconnect_remote(SilcServer server,
 128                                    SilcSocketConnection sock,
 129                                    const char *fmt, ...);
 130 SilcChannelEntry silc_server_create_new_channel(SilcServer server,
 131                                                 SilcServerID *router_id,
 132                                                 char *cipher,
 133                                                 char *hmac,
 134                                                 char *channel_name,
 135                                                 int broadcast);
 136 SilcChannelEntry
 137 silc_server_create_new_channel_with_id(SilcServer server,
 138                                        char *cipher,
 139                                        char *hmac,
 140                                        char *channel_name,
 141                                        SilcChannelID *channel_id,
 142                                        int broadcast);
 143 bool silc_server_create_channel_key(SilcServer server,
 144                                     SilcChannelEntry channel,
 145                                     uint32 key_len);
 146 SilcChannelEntry silc_server_save_channel_key(SilcServer server,
 147                                               SilcBuffer key_payload,
 148                                               SilcChannelEntry channel);
 149 void silc_server_perform_heartbeat(SilcSocketConnection sock,
 150                                    void *hb_context);
 151 void silc_server_announce_get_channel_users(SilcServer server,
 152                                             SilcChannelEntry channel,
 153                                             SilcBuffer *channel_users,
 154                                             SilcBuffer *channel_users_modes);
 155 void silc_server_announce_get_channels(SilcServer server,
 156                                        SilcIDList id_list,
 157                                        SilcBuffer *channels,
 158                                        SilcBuffer *channel_users,
 159                                        SilcBuffer **channel_users_modes,
 160                                        uint32 *channel_users_modes_c,
 161                                        SilcChannelID ***channel_ids);
 162 void silc_server_announce_servers(SilcServer server);
 163 void silc_server_announce_clients(SilcServer server);
 164 void silc_server_announce_channels(SilcServer server);
 165 void silc_server_get_users_on_channel(SilcServer server,
 166                                       SilcChannelEntry channel,
 167                                       SilcBuffer *user_list,
 168                                       SilcBuffer *mode_list,
 169                                       uint32 *user_count);
 170 void silc_server_save_users_on_channel(SilcServer server,
 171                                        SilcSocketConnection sock,
 172                                        SilcChannelEntry channel,
 173                                        SilcClientID *noadd,
 174                                        SilcBuffer user_list,
 175                                        SilcBuffer mode_list,
 176                                        uint32 user_count);
 177 SilcSocketConnection silc_server_get_client_route(SilcServer server,
 178                                                   unsigned char *id_data,
 179                                                   uint32 id_len,
 180                                                   SilcClientID *client_id,
 181                                                   SilcIDListData *idata);
 182 SilcBuffer silc_server_get_client_channel_list(SilcServer server,
 183                                                SilcClientEntry client);
 184 SilcClientEntry silc_server_get_client_resolve(SilcServer server,
 185                                                SilcClientID *client_id);
 186
 187 #endif