Merged from silc_1_0_branch.
[silc.git] / apps / silcd / server.h
index 58113779eeef5660844dfa6810193e629bb031b3..1204b2449f59feb6bf3406b17db736bb5130ff97 100644 (file)
@@ -2,15 +2,15 @@
 
   server.h
 
-  Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
+  Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1997 - 2001 Pekka Riikonen
+  Copyright (C) 1997 - 2002 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
-  
+
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 #ifndef SERVER_H
 #define SERVER_H
 
-/* Forward declaration for SILC Server object. The actual object is
-   defined in internal header file for server routines. I want to keep
-   the object private hence this declaration. */
-typedef struct SilcServerStruct *SilcServer;
-
 /* Forward declaration of backup server context */
 typedef struct SilcServerBackupStruct *SilcServerBackup;
 
-#define SILC_SERVER_MAX_CONNECTIONS 1000
-
-/* General definitions */
-
-/* SILC port */
-#define SILC_PORT 768;
-
-/* Server and router. Used internally by the code. */
-#define SILC_SERVER 0
-#define SILC_ROUTER 1
-#define SILC_BACKUP_ROUTER 2
-
-/* Connection retry timeout. We implement exponential backoff algorithm
-   in connection retry. The interval of timeuot grows when retry count
-   grows. */
-#define SILC_SERVER_RETRY_COUNT        4        /* Max retry count */
-#define SILC_SERVER_RETRY_MULTIPLIER   7 / 4    /* Interval growth */
-#define SILC_SERVER_RETRY_RANDOMIZER   2        /* timeout += rnd % 2 */
-#define SILC_SERVER_RETRY_INTERVAL_MIN 10       /* Min retry timeout */
-#define SILC_SERVER_RETRY_INTERVAL_MAX 600      /* Max generated timeout */
-
-/* 
-   Silc Server Params.
-
-   Structure to hold various default parameters for server that can be
-   given before running the server. 
-
-*/
-typedef struct {
-  uint32 retry_count;
-  uint32 retry_interval_min;
-  uint32 retry_interval_min_usec;
-  uint32 retry_interval_max;
-  char retry_keep_trying;
-
-  uint32 protocol_timeout;
-  uint32 protocol_timeout_usec;
-
-  char require_reverse_mapping;
-} *SilcServerParams;
-
 /* Callback function that is called after the key exchange and connection
    authentication protocols has been completed with a remote router. The
-   `server_entry' is the remote router entry. */
+   `server_entry' is the remote router entry or NULL on error. */
 typedef void (*SilcServerConnectRouterCallback)(SilcServer server,
                                                SilcServerEntry server_entry,
                                                void *context);
 
+/* Connection structure used when connection to remote */
 typedef struct {
   SilcSocketConnection sock;
 
@@ -86,18 +41,53 @@ typedef struct {
   bool backup;
   char *backup_replace_ip;
   int backup_replace_port;
-  
-  /* Current connection retry info */
-  uint32 retry_count;
-  uint32 retry_timeout;
+  bool no_reconnect;
+
+  /* Connection configuration (maybe NULL) */
+  SilcServerConfigRef conn;
 
-  /* Back pointer to server */
-  SilcServer server;
+  /* Current connection retry info */
+  SilcUInt32 retry_count;
+  SilcUInt32 retry_timeout;
 
   SilcServerConnectRouterCallback callback;
   void *callback_context;
 } *SilcServerConnection;
 
+/* General definitions */
+
+/* SILC port */
+#define SILC_PORT 706
+
+/* Server and router. Used internally by the code. */
+#define SILC_SERVER 0
+#define SILC_ROUTER 1
+#define SILC_BACKUP_ROUTER 2
+
+/* Default parameter values */
+
+/* Connection retry timeout. We implement exponential backoff algorithm
+   in connection retry. The interval of timeout grows when retry count
+   grows. */
+#define SILC_SERVER_RETRY_COUNT        7        /* Max retry count */
+#define SILC_SERVER_RETRY_MULTIPLIER   2        /* Interval growth */
+#define SILC_SERVER_RETRY_RANDOMIZER   2        /* timeout += rnd % 2 */
+#define SILC_SERVER_RETRY_INTERVAL_MIN 10       /* Min retry timeout */
+#define SILC_SERVER_RETRY_INTERVAL_MAX 600      /* Max generated timeout */
+
+#define SILC_SERVER_KEEPALIVE          300      /* Heartbeat interval */
+#define SILC_SERVER_CHANNEL_REKEY      3600     /* Channel rekey interval */
+#define SILC_SERVER_REKEY              3600     /* Session rekey interval */
+#define SILC_SERVER_SKE_TIMEOUT        60       /* SKE timeout */
+#define SILC_SERVER_CONNAUTH_TIMEOUT   60       /* CONN_AUTH timeout */
+#define SILC_SERVER_MAX_CONNECTIONS    1000     /* Max connections */
+#define SILC_SERVER_MAX_CONNECTIONS_SINGLE 1000  /* Max connections per host */
+#define SILC_SERVER_LOG_FLUSH_DELAY    300       /* Default log flush delay */
+#define SILC_SERVER_QOS_RATE_LIMIT     10        /* Default QoS rate limit */
+#define SILC_SERVER_QOS_BYTES_LIMIT    2048      /* Default QoS bytes limit */
+#define SILC_SERVER_QOS_LIMIT_SEC      0         /* Default QoS limit sec */
+#define SILC_SERVER_QOS_LIMIT_USEC     500000    /* Default QoS limit usec */
+
 /* Macros */
 
 /* This macro is used to send notify messages with formatted string. The
@@ -109,19 +99,43 @@ do {                                                               \
   silc_server_send_notify(server, sock, FALSE,                         \
                          type, 1, __fmt__, strlen(__fmt__));   \
   silc_free(__fmt__);                                          \
-} while(0);
+} while(0)
+
+/* Send notify to operators */
+#define SILC_SERVER_SEND_OPERS(server, route, local, type, fmt)                \
+do {                                                                   \
+  char *__fmt__ = silc_format fmt;                                     \
+  silc_server_send_opers_notify(server, route, local,                  \
+                               type, 1, __fmt__, strlen(__fmt__));     \
+  silc_free(__fmt__);                                                  \
+} while(0)
 
 /* Check whether rekey protocol is active */
 #define SILC_SERVER_IS_REKEY(sock)                                     \
   (sock->protocol && sock->protocol->protocol &&                       \
    sock->protocol->protocol->type == SILC_PROTOCOL_SERVER_REKEY)
 
+/* Check whether backup resuming protocol is active */
+#define SILC_SERVER_IS_BACKUP(sock)                                    \
+  (sock->protocol && sock->protocol->protocol &&                       \
+   sock->protocol->protocol->type == SILC_PROTOCOL_SERVER_BACKUP)
+
+/* Output a message to stderr or to the appropriate log facility wether
+   we are in the background or not. */
+#define SILC_SERVER_LOG_INFO(fmt)                                      \
+  silc_server_stderr(SILC_LOG_INFO, silc_format fmt)
+#define SILC_SERVER_LOG_WARNING(fmt)                                   \
+  silc_server_stderr(SILC_LOG_WARNING, silc_format fmt)
+#define SILC_SERVER_LOG_ERROR(fmt)                                     \
+  silc_server_stderr(SILC_LOG_ERROR, silc_format fmt)
+#define SILC_SERVER_LOG_FATAL(fmt)                                     \
+  silc_server_stderr(SILC_LOG_WARNING, silc_format fmt)
+
 /* Prototypes */
 int silc_server_alloc(SilcServer *new_server);
 void silc_server_free(SilcServer server);
-int silc_server_init(SilcServer server);
-void silc_server_daemonise(SilcServer server);
-void silc_server_drop(SilcServer server);
+bool silc_server_init(SilcServer server);
+bool silc_server_rehash(SilcServer server);
 void silc_server_run(SilcServer server);
 void silc_server_stop(SilcServer server);
 void silc_server_start_key_exchange(SilcServer server,
@@ -129,51 +143,51 @@ void silc_server_start_key_exchange(SilcServer server,
                                    int sock);
 bool silc_server_packet_parse(SilcPacketParserContext *parser_context,
                              void *context);
-void silc_server_packet_parse_type(SilcServer server, 
+void silc_server_packet_parse_type(SilcServer server,
                                   SilcSocketConnection sock,
                                   SilcPacketContext *packet);
 void silc_server_create_connection(SilcServer server,
-                                  char *remote_host, uint32 port);
+                                  const char *remote_host, SilcUInt32 port);
 void silc_server_close_connection(SilcServer server,
                                  SilcSocketConnection sock);
-void silc_server_free_client_data(SilcServer server, 
+void silc_server_free_client_data(SilcServer server,
                                  SilcSocketConnection sock,
-                                 SilcClientEntry client, 
+                                 SilcClientEntry client,
                                  int notify,
                                  const char *signoff);
-void silc_server_free_sock_user_data(SilcServer server, 
+void silc_server_free_sock_user_data(SilcServer server,
                                     SilcSocketConnection sock,
                                     const char *signoff_message);
-void silc_server_remove_from_channels(SilcServer server, 
+void silc_server_remove_from_channels(SilcServer server,
                                      SilcSocketConnection sock,
                                      SilcClientEntry client,
-                                     int notify,
-                                     char *signoff_message,
-                                     int keygen);
-int silc_server_remove_from_one_channel(SilcServer server, 
-                                       SilcSocketConnection sock,
-                                       SilcChannelEntry channel,
-                                       SilcClientEntry client,
-                                       int notify);
+                                     bool notify,
+                                     const char *signoff_message,
+                                     bool keygen, bool killed);
+bool silc_server_remove_from_one_channel(SilcServer server,
+                                        SilcSocketConnection sock,
+                                        SilcChannelEntry channel,
+                                        SilcClientEntry client,
+                                        bool notify);
 void silc_server_disconnect_remote(SilcServer server,
                                   SilcSocketConnection sock,
-                                  const char *fmt, ...);
-SilcChannelEntry silc_server_create_new_channel(SilcServer server, 
+                                  SilcStatus status, ...);
+SilcChannelEntry silc_server_create_new_channel(SilcServer server,
                                                SilcServerID *router_id,
-                                               char *cipher, 
+                                               char *cipher,
                                                char *hmac,
                                                char *channel_name,
                                                int broadcast);
-SilcChannelEntry 
-silc_server_create_new_channel_with_id(SilcServer server, 
-                                      char *cipher, 
+SilcChannelEntry
+silc_server_create_new_channel_with_id(SilcServer server,
+                                      char *cipher,
                                       char *hmac,
                                       char *channel_name,
                                       SilcChannelID *channel_id,
                                       int broadcast);
-bool silc_server_create_channel_key(SilcServer server, 
+bool silc_server_create_channel_key(SilcServer server,
                                    SilcChannelEntry channel,
-                                   uint32 key_len);
+                                   SilcUInt32 key_len);
 SilcChannelEntry silc_server_save_channel_key(SilcServer server,
                                              SilcBuffer key_payload,
                                              SilcChannelEntry channel);
@@ -184,14 +198,16 @@ void silc_server_announce_get_channel_topic(SilcServer server,
                                            SilcBuffer *topic);
 void silc_server_announce_get_channel_users(SilcServer server,
                                            SilcChannelEntry channel,
+                                           SilcBuffer *channel_modes,
                                            SilcBuffer *channel_users,
                                            SilcBuffer *channel_users_modes);
 void silc_server_announce_get_channels(SilcServer server,
                                       SilcIDList id_list,
                                       SilcBuffer *channels,
+                                      SilcBuffer **channel_modes,
                                       SilcBuffer *channel_users,
                                       SilcBuffer **channel_users_modes,
-                                      uint32 *channel_users_modes_c,
+                                      SilcUInt32 *channel_users_modes_c,
                                       SilcBuffer **channel_topics,
                                       SilcChannelID ***channel_ids,
                                       unsigned long creation_time);
@@ -204,26 +220,35 @@ void silc_server_announce_clients(SilcServer server,
 void silc_server_announce_channels(SilcServer server,
                                   unsigned long creation_time,
                                   SilcSocketConnection remote);
-void silc_server_get_users_on_channel(SilcServer server,
+bool silc_server_get_users_on_channel(SilcServer server,
                                      SilcChannelEntry channel,
                                      SilcBuffer *user_list,
                                      SilcBuffer *mode_list,
-                                     uint32 *user_count);
+                                     SilcUInt32 *user_count);
 void silc_server_save_users_on_channel(SilcServer server,
                                       SilcSocketConnection sock,
                                       SilcChannelEntry channel,
                                       SilcClientID *noadd,
                                       SilcBuffer user_list,
                                       SilcBuffer mode_list,
-                                      uint32 user_count);
-SilcSocketConnection silc_server_get_client_route(SilcServer server,
-                                                 unsigned char *id_data,
-                                                 uint32 id_len,
-                                                 SilcClientID *client_id,
-                                                 SilcIDListData *idata);
+                                      SilcUInt32 user_count);
+void silc_server_save_user_channels(SilcServer server,
+                                   SilcSocketConnection sock,
+                                   SilcClientEntry client,
+                                   SilcBuffer channels,
+                                   SilcBuffer channels_user_modes);
+SilcSocketConnection
+silc_server_get_client_route(SilcServer server,
+                            unsigned char *id_data,
+                            SilcUInt32 id_len,
+                            SilcClientID *client_id,
+                            SilcIDListData *idata,
+                            SilcClientEntry *client_entry);
 SilcBuffer silc_server_get_client_channel_list(SilcServer server,
-                                              SilcClientEntry client);
-SilcClientEntry silc_server_get_client_resolve(SilcServer server,
-                                              SilcClientID *client_id);
+                                              SilcClientEntry client,
+                                              bool get_private,
+                                              bool get_secret,
+                                              SilcBuffer *user_mode_list);
+void silc_server_stderr(SilcLogType type, char *message);
 
 #endif