apps/silcd/server_internal.h

   1 /*
   2
   3   server_internal.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_INTERNAL_H
  21 #define SERVER_INTERNAL_H
  22
  23 /* Server statistics structure. This holds various statistics about
  24    various things. */
  25 typedef struct {
  26   /* Local stats (server and router) */
  27   SilcUInt32 my_clients;                  /* Locally connected clients */
  28   SilcUInt32 my_servers;                  /* Locally connected servers */
  29   SilcUInt32 my_routers;                  /* Locally connected routers */
  30   SilcUInt32 my_channels;                 /* Locally created channels */
  31   SilcUInt32 my_chanclients;              /* Local clients on local channels */
  32   SilcUInt32 my_aways;                    /* Local clients away (gone) */
  33   SilcUInt32 my_detached;                 /* Local clients detached */
  34   SilcUInt32 my_server_ops;               /* Local server operators */
  35   SilcUInt32 my_router_ops;               /* Local router operators */
  36
  37   /* Global stats (mainly for router) */
  38   SilcUInt32 cell_clients;                /* All clients in cell */
  39   SilcUInt32 cell_servers;                /* All servers in cell */
  40   SilcUInt32 cell_channels;               /* All channels in cell */
  41   SilcUInt32 cell_chanclients;            /* All clients on cell's channels */
  42   SilcUInt32 clients;                     /* All clients */
  43   SilcUInt32 servers;                     /* All servers */
  44   SilcUInt32 routers;                     /* All routers */
  45   SilcUInt32 channels;                    /* All channels */
  46   SilcUInt32 chanclients;                 /* All clients on channels */
  47   SilcUInt32 aways;                       /* All clients away (gone) */
  48   SilcUInt32 detached;                    /* All clients detached */
  49   SilcUInt32 server_ops;                  /* All server operators */
  50   SilcUInt32 router_ops;                  /* All router operators */
  51   /* More to add
  52   SilcUInt32 secret_channels;
  53   SilcUInt32 private_channels;
  54   */
  55
  56   /* General */
  57   SilcUInt32 conn_attempts;               /* Connection attempts */
  58   SilcUInt32 conn_failures;               /* Connection failure */
  59   SilcUInt32 auth_attempts;               /* Authentication attempts */
  60   SilcUInt32 auth_failures;               /* Authentication failures */
  61   SilcUInt32 packets_sent;                /* Sent SILC packets */
  62   SilcUInt32 packets_received;            /* Received SILC packets */
  63   SilcUInt32 conn_num;                    /* Number of connections */
  64   SilcUInt32 commands_sent;               /* Commands/replies sent */
  65   SilcUInt32 commands_received;           /* Commands/replies received */
  66 } SilcServerStatistics;
  67
  68 /*
  69    SILC Server Object.
  70
  71 */
  72 struct SilcServerStruct {
  73   char *server_name;
  74   SilcServerEntry id_entry;
  75   SilcServerID *id;
  76   unsigned char *id_string;
  77   SilcUInt32 id_string_len;
  78   SilcUInt32 starttime;
  79
  80   unsigned int server_type    : 2;   /* Server type (server.h) */
  81   unsigned int standalone     : 1;   /* Set if server is standalone, and
  82                                         does not have connection to network. */
  83   unsigned int listenning     : 1;   /* Set if server is listenning for
  84                                         incoming connections. */
  85   unsigned int background     : 1;   /* Set when server is on background */
  86   unsigned int backup_router  : 1;   /* Set if this is backup router */
  87   unsigned int backup_primary : 1;   /* Set if we've switched our primary
  88                                         router to a backup router. */
  89   unsigned int backup_noswitch: 1;   /* Set if we've won't switch to
  90                                         become primary (we are backup) */
  91   unsigned int backup_closed  : 1;   /* Set if backup closed connection.
  92                                         Do not allow resuming in this case. */
  93   unsigned int wait_backup    : 1;   /* Set if we are waiting for backup
  94                                         router to connect to us. */
  95   unsigned int server_shutdown: 1;   /* Set when shutting down */
  96   unsigned int no_reconnect   : 1;   /* If set, server won't reconnect to
  97                                         router after disconnection. */
  98   unsigned int no_conf        : 1;   /* Set when connecting without
  99                                         configuration. */
 100
 101   SilcServerEntry router;            /* Pointer to the primary router */
 102   unsigned long router_connect;      /* Time when router was connected */
 103   SilcServerConnection router_conn;  /* non-NULL when connecting to the
 104                                         primary router, and NULL otherwise. */
 105   SilcServerBackup backup;           /* Backup routers */
 106
 107   /* Current command identifier, 0 not used */
 108   SilcUInt16 cmd_ident;
 109
 110   /* SILC server scheduler */
 111   SilcSchedule schedule;
 112
 113   /* ID lists. */
 114   SilcIDList local_list;
 115   SilcIDList global_list;
 116   SilcHashTable watcher_list;
 117   SilcHashTable watcher_list_pk;
 118
 119   SilcDList listeners;               /* TCP listeners */
 120   SilcPacketEngine packet_engine;    /* Packet engine */
 121   SilcDList conns;
 122   SilcSKR repository;
 123
 124   /* Table of connected sockets */
 125   SilcPacketStream *sockets;
 126
 127   /* Server public key */
 128   SilcPublicKey public_key;
 129   SilcPrivateKey private_key;
 130
 131   /* Hash objects for general hashing */
 132   SilcHash md5hash;
 133   SilcHash sha1hash;
 134
 135   /* Configuration object */
 136   SilcServerConfig config;
 137   SilcServerConfigRef config_ref;
 138   char *config_file;
 139
 140   /* Random pool */
 141   SilcRng rng;
 142
 143   /* Server statistics */
 144   SilcServerStatistics stat;
 145
 146   /* Pending command queue */
 147   SilcDList pending_commands;
 148
 149   /* Purge context for disconnected clients */
 150   SilcIDListPurge purge_i;
 151   SilcIDListPurge purge_g;
 152
 153   /* Hash table for public keys of all clients */
 154   SilcHashTable pk_hash;
 155 };
 156
 157 /* Failure context. This is allocated when failure packet is received.
 158    Failure packets are processed with timeout and data is saved in this
 159    structure. */
 160 typedef struct {
 161   SilcPacketStream sock;
 162   SilcUInt32 failure;
 163 } *SilcServerFailureContext;
 164
 165 /* Rekey must be performed at the lastest when this many packets is sent */
 166 #define SILC_SERVER_REKEY_THRESHOLD 0xfffffe00
 167
 168 /* Macros */
 169
 170 /* Return pointer to the primary router connection */
 171 #define SILC_PRIMARY_ROUTE(server) \
 172   (!server->standalone && server->router ? server->router->connection : NULL)
 173
 174 /* Return TRUE if a packet must be broadcasted (router broadcasts) */
 175 #define SILC_BROADCAST(server) (server->server_type == SILC_ROUTER)
 176
 177 /* Return TRUE if entry is locally connected or local to us */
 178 #define SILC_IS_LOCAL(entry) \
 179   (((SilcIDListData)entry)->status & SILC_IDLIST_STATUS_LOCAL)
 180
 181 /* Registers generic task for file descriptor for reading from network and
 182    writing to network. As being generic task the actual task is allocated
 183    only once and after that the same task applies to all registered fd's. */
 184 #define SILC_REGISTER_CONNECTION_FOR_IO(fd)             \
 185 do {                                                    \
 186   silc_schedule_task_add(server->schedule, (fd),        \
 187                          silc_server_packet_process,    \
 188                          context, 0, 0,                 \
 189                          SILC_TASK_GENERIC,             \
 190                          SILC_TASK_PRI_NORMAL);         \
 191 } while(0)
 192
 193 #define SILC_SET_CONNECTION_FOR_INPUT(s, fd)                            \
 194 do {                                                                    \
 195   silc_schedule_set_listen_fd((s), (fd), SILC_TASK_READ, FALSE);        \
 196 } while(0)
 197
 198 #define SILC_SET_CONNECTION_FOR_OUTPUT(s, fd)                                \
 199 do {                                                                         \
 200   silc_schedule_set_listen_fd((s), (fd), (SILC_TASK_READ | SILC_TASK_WRITE), \
 201                               FALSE);                                        \
 202 } while(0)
 203
 204 #define SILC_OPER_STATS_UPDATE(c, type, mod)    \
 205 do {                                            \
 206   if ((c)->mode & (mod)) {                      \
 207     if (SILC_IS_LOCAL((c)))                     \
 208       server->stat.my_ ## type ## _ops--;       \
 209     if (server->server_type == SILC_ROUTER)     \
 210       server->stat. type ## _ops--;             \
 211     (c)->mode &= ~(mod);                        \
 212   }                                             \
 213 } while(0)
 214
 215 #define SILC_UMODE_STATS_UPDATE(oper, mod)      \
 216 do {                                            \
 217     if (client->mode & (mod)) {                 \
 218       if (!(mode & (mod))) {                    \
 219         if (SILC_IS_LOCAL(client))              \
 220           server->stat.my_ ## oper ## _ops--;   \
 221         if (server->server_type == SILC_ROUTER) \
 222           server->stat. oper ## _ops--;         \
 223       }                                         \
 224     } else {                                    \
 225       if (mode & (mod)) {                       \
 226         if (SILC_IS_LOCAL(client))              \
 227           server->stat.my_ ## oper ## _ops++;   \
 228         if (server->server_type == SILC_ROUTER) \
 229           server->stat. oper ## _ops++;         \
 230       }                                         \
 231     }                                           \
 232 } while(0)
 233
 234 #define SILC_GET_SKE_FLAGS(x, p)                        \
 235   if ((x)) {                                            \
 236     if ((x)->param && (x)->param->key_exchange_pfs)     \
 237       (p) |= SILC_SKE_SP_FLAG_PFS;                      \
 238     if (!(x)->publickeys)                               \
 239       (p) |= SILC_SKE_SP_FLAG_MUTUAL;                   \
 240   }
 241
 242 #define SILC_CONNTYPE_STRING(ctype)                     \
 243   (ctype == SILC_CONN_CLIENT ? "Client" :               \
 244    ctype == SILC_CONN_SERVER ? "Server" :               \
 245    ctype == SILC_CONN_ROUTER ? "Router" : "Unknown")
 246
 247 /* Prototypes */
 248 SILC_TASK_CALLBACK(silc_server_rekey_final);
 249 SILC_TASK_CALLBACK(silc_server_rekey_callback);
 250 SILC_TASK_CALLBACK(silc_server_connect_to_router);
 251 void silc_server_watcher_list_destroy(void *key, void *context,
 252                                       void *user_context);
 253
 254 #endif