apps/silcd/server_internal.h

   1 /*
   2
   3   server_internal.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 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_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   SilcSchedule schedule;             /* Server scheduler */
  74   SilcDList listeners;               /* TCP listeners */
  75   SilcPacketEngine packet_engine;    /* Packet engine */
  76   SilcDList conns;                   /* Connections in server */
  77   SilcSKR repository;                /* Public key repository */
  78   SilcPublicKey public_key;          /* Server public key */
  79   SilcPrivateKey private_key;        /* Server private key */
  80   SilcDList expired_clients;         /* Expired client entries */
  81   SilcHttpServer httpd;              /* HTTP server */
  82
  83   char *server_name;                 /* Server's name */
  84   SilcServerEntry id_entry;          /* Server's local entry */
  85   SilcServerID *id;                  /* Server's ID */
  86   unsigned char id_string[32];       /* Server's ID as string */
  87   SilcUInt32 id_string_len;
  88   SilcUInt32 starttime;              /* Server start time */
  89
  90   SilcServerEntry router;            /* Pointer to the primary router */
  91   unsigned long router_connect;      /* Time when router was connected */
  92   SilcServerConnection router_conn;  /* non-NULL when connecting to the
  93                                         primary router, and NULL otherwise. */
  94   SilcServerBackup backup;           /* Backup routers */
  95
  96   /* Current command identifier, 0 not used */
  97   SilcUInt16 cmd_ident;
  98
  99   /* ID lists. */
 100   SilcIDList local_list;
 101   SilcIDList global_list;
 102   SilcHashTable watcher_list;
 103   SilcHashTable watcher_list_pk;
 104
 105   /* Hash objects for general hashing */
 106   SilcHash md5hash;
 107   SilcHash sha1hash;
 108
 109   /* Configuration object */
 110   SilcServerConfig config;
 111   SilcServerConfigRef config_ref;
 112   char *config_file;
 113
 114   /* Random pool */
 115   SilcRng rng;
 116
 117   /* Server statistics */
 118   SilcServerStatistics stat;
 119
 120   /* Pending command queue */
 121   SilcDList pending_commands;
 122
 123   /* Purge context for disconnected clients */
 124   SilcIDListPurge purge_i;
 125   SilcIDListPurge purge_g;
 126
 127   unsigned int server_type    : 2;   /* Server type (server.h) */
 128   unsigned int standalone     : 1;   /* Set if server is standalone, and
 129                                         does not have connection to network. */
 130   unsigned int listenning     : 1;   /* Set if server is listenning for
 131                                         incoming connections. */
 132   unsigned int background     : 1;   /* Set when server is on background */
 133   unsigned int backup_router  : 1;   /* Set if this is backup router */
 134   unsigned int backup_primary : 1;   /* Set if we've switched our primary
 135                                         router to a backup router. */
 136   unsigned int backup_noswitch: 1;   /* Set if we've won't switch to
 137                                         become primary (we are backup) */
 138   unsigned int backup_closed  : 1;   /* Set if backup closed connection.
 139                                         Do not allow resuming in this case. */
 140   unsigned int wait_backup    : 1;   /* Set if we are waiting for backup
 141                                         router to connect to us. */
 142   unsigned int server_shutdown: 1;   /* Set when shutting down */
 143   unsigned int no_reconnect   : 1;   /* If set, server won't reconnect to
 144                                         router after disconnection. */
 145   unsigned int no_conf        : 1;   /* Set when connecting without
 146                                         configuration. */
 147 };
 148
 149 /* Failure context. This is allocated when failure packet is received.
 150    Failure packets are processed with timeout and data is saved in this
 151    structure. */
 152 typedef struct {
 153   SilcPacketStream sock;
 154   SilcUInt32 failure;
 155 } *SilcServerFailureContext;
 156
 157 /* Rekey must be performed at the lastest when this many packets is sent */
 158 #define SILC_SERVER_REKEY_THRESHOLD 0xfffffe00
 159
 160 /* Macros */
 161
 162 /* Return pointer to the primary router connection */
 163 #define SILC_PRIMARY_ROUTE(server) \
 164   (!server->standalone && server->router ? server->router->connection : NULL)
 165
 166 /* Return TRUE if a packet must be broadcasted (router broadcasts) */
 167 #define SILC_BROADCAST(server) (server->server_type == SILC_ROUTER)
 168
 169 /* Return TRUE if entry is locally connected or local to us */
 170 #define SILC_IS_LOCAL(entry) \
 171   (((SilcIDListData)entry)->status & SILC_IDLIST_STATUS_LOCAL)
 172
 173 /* Registers generic task for file descriptor for reading from network and
 174    writing to network. As being generic task the actual task is allocated
 175    only once and after that the same task applies to all registered fd's. */
 176 #define SILC_REGISTER_CONNECTION_FOR_IO(fd)             \
 177 do {                                                    \
 178   silc_schedule_task_add(server->schedule, (fd),        \
 179                          silc_server_packet_process,    \
 180                          context, 0, 0,                 \
 181                          SILC_TASK_GENERIC,             \
 182                          SILC_TASK_PRI_NORMAL);         \
 183 } while(0)
 184
 185 #define SILC_SET_CONNECTION_FOR_INPUT(s, fd)                            \
 186 do {                                                                    \
 187   silc_schedule_set_listen_fd((s), (fd), SILC_TASK_READ, FALSE);        \
 188 } while(0)
 189
 190 #define SILC_SET_CONNECTION_FOR_OUTPUT(s, fd)                                \
 191 do {                                                                         \
 192   silc_schedule_set_listen_fd((s), (fd), (SILC_TASK_READ | SILC_TASK_WRITE), \
 193                               FALSE);                                        \
 194 } while(0)
 195
 196 #define SILC_OPER_STATS_UPDATE(c, type, mod)    \
 197 do {                                            \
 198   if ((c)->mode & (mod)) {                      \
 199     if (SILC_IS_LOCAL((c)))                     \
 200       server->stat.my_ ## type ## _ops--;       \
 201     if (server->server_type == SILC_ROUTER)     \
 202       server->stat. type ## _ops--;             \
 203     (c)->mode &= ~(mod);                        \
 204   }                                             \
 205 } while(0)
 206
 207 #define SILC_UMODE_STATS_UPDATE(oper, mod)      \
 208 do {                                            \
 209     if (client->mode & (mod)) {                 \
 210       if (!(mode & (mod))) {                    \
 211         if (SILC_IS_LOCAL(client))              \
 212           server->stat.my_ ## oper ## _ops--;   \
 213         if (server->server_type == SILC_ROUTER) \
 214           server->stat. oper ## _ops--;         \
 215       }                                         \
 216     } else {                                    \
 217       if (mode & (mod)) {                       \
 218         if (SILC_IS_LOCAL(client))              \
 219           server->stat.my_ ## oper ## _ops++;   \
 220         if (server->server_type == SILC_ROUTER) \
 221           server->stat. oper ## _ops++;         \
 222       }                                         \
 223     }                                           \
 224 } while(0)
 225
 226 #define SILC_GET_SKE_FLAGS(x, p)                        \
 227   if ((x)) {                                            \
 228     if ((x)->param && (x)->param->key_exchange_pfs)     \
 229       (p) |= SILC_SKE_SP_FLAG_PFS;                      \
 230     if (!(x)->publickeys)                               \
 231       (p) |= SILC_SKE_SP_FLAG_MUTUAL;                   \
 232   }
 233
 234 #define SILC_CONNTYPE_STRING(ctype)                     \
 235   (ctype == SILC_CONN_CLIENT ? "Client" :               \
 236    ctype == SILC_CONN_SERVER ? "Server" :               \
 237    ctype == SILC_CONN_ROUTER ? "Router" : "Unknown")
 238
 239 /* Prototypes */
 240 SILC_TASK_CALLBACK(silc_server_rekey_final);
 241 SILC_TASK_CALLBACK(silc_server_rekey_callback);
 242 SILC_TASK_CALLBACK(silc_server_connect_to_router);
 243 void silc_server_watcher_list_destroy(void *key, void *context,
 244                                       void *user_context);
 245
 246 #endif