Spelling fix: "nick name" -> "nickname"
[ngircd-alex.git] / src / ngircd / conf.h
1 /*
2  * ngIRCd -- The Next Generation IRC Daemon
3  * Copyright (c)2001-2012 Alexander Barton (alex@barton.de) and Contributors.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  * Please read the file COPYING, README and AUTHORS for more information.
10  */
11
12 #ifndef __conf_h__
13 #define __conf_h__
14
15 /**
16  * @file
17  * Configuration management (header)
18  */
19
20 #include <time.h>
21
22 #include "defines.h"
23 #include "array.h"
24 #include "portab.h"
25 #include "tool.h"
26 #include "ng_ipaddr.h"
27 #include "proc.h"
28 #include "conf-ssl.h"
29
30 /**
31  * Configured IRC operator.
32  * Please note the the name of the IRC operaor and his nick have nothing to
33  * do with each other! The IRC operator is only identified by the name and
34  * password configured in this structure.
35  */
36 struct Conf_Oper {
37         char name[CLIENT_PASS_LEN];     /**< Name (ID) */
38         char pwd[CLIENT_PASS_LEN];      /**< Password */
39         char *mask;                     /**< Allowed host mask */
40 };
41
42 /**
43  * Configured server.
44  * Peers to which this daemon should establish an outgoing server link must
45  * have set a port number; all other servers are allowed to connect to this one.
46  */
47 typedef struct _Conf_Server
48 {
49         char host[HOST_LEN];            /**< Hostname */
50         char name[CLIENT_ID_LEN];       /**< IRC client ID */
51         char pwd_in[CLIENT_PASS_LEN];   /**< Password which must be received */
52         char pwd_out[CLIENT_PASS_LEN];  /**< Password to send to the peer */
53         UINT16 port;                    /**< Server port to connect to */
54         int group;                      /**< Group ID of this server */
55         time_t lasttry;                 /**< Time of last connection attempt */
56         PROC_STAT res_stat;             /**< Status of the resolver */
57         int flags;                      /**< Server flags */
58         CONN_ID conn_id;                /**< ID of server connection or NONE */
59         ng_ipaddr_t bind_addr;          /**< Source address to use for outgoing
60                                              connections */
61         ng_ipaddr_t dst_addr[2];        /**< List of addresses to connect to */
62 #ifdef SSL_SUPPORT
63         bool SSLConnect;                /**< Establish connection using SSL? */
64 #endif
65         char svs_mask[CLIENT_ID_LEN];   /**< Mask of nicknames that should be
66                                              treated and counted as services */
67 } CONF_SERVER;
68
69
70 #ifdef SSL_SUPPORT
71 /** Configuration options required for SSL support */
72 struct SSLOptions {
73         char *KeyFile;                  /**< SSL key file */
74         char *CertFile;                 /**< SSL certificate file */
75         char *DHFile;                   /**< File containing DH parameters */
76         array ListenPorts;              /**< Array of listening SSL ports */
77         array KeyFilePassword;          /**< Key file password */
78 };
79 #endif
80
81
82 /** Pre-defined channels */
83 struct Conf_Channel {
84         char name[CHANNEL_NAME_LEN];    /**< Name of the channel */
85         char modes[CHANNEL_MODE_LEN];   /**< Initial channel modes */
86         char key[CLIENT_PASS_LEN];      /**< Channel key ("password", mode "k" ) */
87         char topic[COMMAND_LEN];        /**< Initial topic */
88         char keyfile[512];              /**< Path and name of channel key file */
89         unsigned long maxusers;         /**< User limit for this channel, mode "l" */
90 };
91
92
93 #define CONF_SFLAG_ONCE 1               /* Delete this entry after next disconnect */
94 #define CONF_SFLAG_DISABLED 2           /* This server configuration entry is disabled */
95
96
97 /** Name (ID, "nick") of this server */
98 GLOBAL char Conf_ServerName[CLIENT_ID_LEN];
99
100 /** Server info text */
101 GLOBAL char Conf_ServerInfo[CLIENT_INFO_LEN];
102
103 /** Global server passwort */
104 GLOBAL char Conf_ServerPwd[CLIENT_PASS_LEN];
105
106 /** Administrative information */
107 GLOBAL char Conf_ServerAdmin1[CLIENT_INFO_LEN];
108 GLOBAL char Conf_ServerAdmin2[CLIENT_INFO_LEN];
109 GLOBAL char Conf_ServerAdminMail[CLIENT_INFO_LEN];
110
111 /** Message of the day (MOTD) of this server */
112 GLOBAL array Conf_Motd;
113
114 /** Array of ports this server should listen on */
115 GLOBAL array Conf_ListenPorts;
116
117 /** Address to which sockets should be bound to or empty (=all) */
118 GLOBAL char *Conf_ListenAddress;
119
120 /** User and group ID this daemon should run with */
121 GLOBAL uid_t Conf_UID;
122 GLOBAL gid_t Conf_GID;
123
124 /** The directory to chroot() into */
125 GLOBAL char Conf_Chroot[FNAME_LEN];
126
127 /** Full path and name of a file to which the PID of daemon should be written */
128 GLOBAL char Conf_PidFile[FNAME_LEN];
129
130 /** Timeout (in seconds) for PING commands */
131 GLOBAL int Conf_PingTimeout;
132
133 /** Timeout (in seconds) for PONG replies */
134 GLOBAL int Conf_PongTimeout;
135
136 /** Seconds between connection attempts to other servers */
137 GLOBAL int Conf_ConnectRetry;
138
139 /** Array of configured IRC operators */
140 GLOBAL array Conf_Opers;
141
142 /** Array of configured IRC servers */
143 GLOBAL CONF_SERVER Conf_Server[MAX_SERVERS];
144
145 /** Array of pre-defined channels */
146 GLOBAL array Conf_Channels;
147
148 /** Flag indicating if only pre-defined channels are allowed (true) or not */
149 GLOBAL bool Conf_PredefChannelsOnly;
150
151 /** Flag indicating if IRC operators are allowed to always use MODE (true) */
152 GLOBAL bool Conf_OperCanMode;
153
154 /** Flag indicating if IRC operators get AutoOp in persistent (+P) channels */
155 GLOBAL bool Conf_OperChanPAutoOp;
156
157 /**
158  * If true, mask channel MODE commands of IRC operators to the server.
159  * Background: ircd2 will ignore channel MODE commands if an IRC operator
160  * gives channel operator privileges to someone without being a channel operator
161  * himself. This enables a workaround: it masks the MODE command as coming
162  * from the IRC server and not the IRC operator.
163  */
164 GLOBAL bool Conf_OperServerMode;
165
166 /** Flag indicating if remote IRC operators are allowed to manage this server */
167 GLOBAL bool Conf_AllowRemoteOper;
168
169 /** Cloaked hostname of the clients */
170 GLOBAL char Conf_CloakHost[CLIENT_ID_LEN];
171
172 /** Cloaked hostname for clients that did +x */
173 GLOBAL char Conf_CloakHostModeX[CLIENT_ID_LEN];
174
175 /** Salt for hostname hash for cloaked hostnames */
176 GLOBAL char Conf_CloakHostSalt[CLIENT_ID_LEN];
177
178 /** Use nickname as user name? */
179 GLOBAL bool Conf_CloakUserToNick;
180
181 /** Enable all DNS functions? */
182 GLOBAL bool Conf_DNS;
183
184 /** Enable IDENT lookups, even when compiled with support for it */
185 GLOBAL bool Conf_Ident;
186
187 /** Enable "more privacy" mode and "censor" some user-related information */
188 GLOBAL bool Conf_MorePrivacy;
189
190 /** Enable NOTICE AUTH messages on connect */
191 GLOBAL bool Conf_NoticeAuth;
192
193 /** Enable all usage of PAM, even when compiled with support for it */
194 GLOBAL bool Conf_PAM;
195
196 /** Don't require all clients to send a password an to be PAM authenticated */
197 GLOBAL bool Conf_PAMIsOptional;
198
199 /** Disable all CTCP commands except for /me ? */
200 GLOBAL bool Conf_ScrubCTCP;
201
202 /*
203  * try to connect to remote systems using the ipv6 protocol,
204  * if they have an ipv6 address? (default yes)
205  */
206 GLOBAL bool Conf_ConnectIPv6;
207
208 /** Try to connect to remote systems using the IPv4 protocol (true) */
209 GLOBAL bool Conf_ConnectIPv4;
210
211 /** Maximum number of simultaneous connections to this server */
212 GLOBAL int Conf_MaxConnections;
213
214 /** Maximum number of channels a user can join */
215 GLOBAL int Conf_MaxJoins;
216
217 /** Maximum number of connections per IP address */
218 GLOBAL int Conf_MaxConnectionsIP;
219
220 /** Maximum length of a nickname */
221 GLOBAL unsigned int Conf_MaxNickLength;
222
223 /** Maximum number of channels returned to /list */
224 GLOBAL int Conf_MaxListSize;
225
226 #ifndef STRICT_RFC
227
228 /** Require "AUTH PING-PONG" on login */
229 GLOBAL bool Conf_AuthPing;
230
231 #endif
232
233 #ifdef SYSLOG
234
235 /* Syslog "facility" */
236 GLOBAL int Conf_SyslogFacility;
237
238 #endif
239
240 GLOBAL void Conf_Init PARAMS((void));
241 GLOBAL bool Conf_Rehash PARAMS((void));
242 GLOBAL int Conf_Test PARAMS((void));
243
244 GLOBAL void Conf_UnsetServer PARAMS(( CONN_ID Idx ));
245 GLOBAL bool Conf_SetServer PARAMS(( int ConfServer, CONN_ID Idx ));
246 GLOBAL int Conf_GetServer PARAMS(( CONN_ID Idx ));
247
248 GLOBAL bool Conf_EnableServer PARAMS(( const char *Name, UINT16 Port ));
249 GLOBAL bool Conf_EnablePassiveServer PARAMS((const char *Name));
250 GLOBAL bool Conf_DisableServer PARAMS(( const char *Name ));
251 GLOBAL bool Conf_AddServer PARAMS(( const char *Name, UINT16 Port, const char *Host, const char *MyPwd, const char *PeerPwd ));
252
253 GLOBAL bool Conf_NickIsService PARAMS((int ConfServer, const char *Nick));
254 GLOBAL bool Conf_NickIsBlocked PARAMS((const char *Nick));
255
256 /* Password required by WEBIRC command */
257 GLOBAL char Conf_WebircPwd[CLIENT_PASS_LEN];
258
259 #ifdef DEBUG
260 GLOBAL void Conf_DebugDump PARAMS((void));
261 #endif
262
263
264 #endif
265
266
267 /* -eof- */