1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
|
/* +------------------------------------+
* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
* InspIRCd: (C) 2002-2009 InspIRCd Development Team
* See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
#ifndef __TREESOCKET_H__
#define __TREESOCKET_H__
#include "socket.h"
#include "inspircd.h"
#include "xline.h"
#include "../transport.h"
#include "utils.h"
#include "handshaketimer.h"
/*
* The server list in InspIRCd is maintained as two structures
* which hold the data in different ways. Most of the time, we
* want to very quicky obtain three pieces of information:
*
* (1) The information on a server
* (2) The information on the server we must send data through
* to actually REACH the server we're after
* (3) Potentially, the child/parent objects of this server
*
* The InspIRCd spanning protocol provides easy access to these
* by storing the data firstly in a recursive structure, where
* each item references its parent item, and a dynamic list
* of child items, and another structure which stores the items
* hashed, linearly. This means that if we want to find a server
* by name quickly, we can look it up in the hash, avoiding
* any O(n) lookups. If however, during a split or sync, we want
* to apply an operation to a server, and any of its child objects
* we can resort to recursion to walk the tree structure.
* Any socket can have one of five states at any one time.
*
* CONNECTING: indicates an outbound socket which is
* waiting to be writeable.
* WAIT_AUTH_1: indicates the socket is outbound and
* has successfully connected, but has not
* yet sent and received SERVER strings.
* WAIT_AUTH_2: indicates that the socket is inbound
* but has not yet sent and received
* SERVER strings.
* CONNECTED: represents a fully authorized, fully
* connected server.
*/
enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
/** Every SERVER connection inbound or outbound is represented by
* an object of type TreeSocket.
* TreeSockets, being inherited from BufferedSocket, can be tied into
* the core socket engine, and we cn therefore receive activity events
* for them, just like activex objects on speed. (yes really, that
* is a technical term!) Each of these which relates to a locally
* connected server is assocated with it, by hooking it onto a
* TreeSocket class using its constructor. In this way, we can
* maintain a list of servers, some of which are directly connected,
* some of which are not.
*/
class TreeSocket : public BufferedSocket
{
SpanningTreeUtilities* Utils; /* Utility class */
std::string myhost; /* Canonical hostname */
ServerState LinkState; /* Link state */
std::string InboundServerName; /* Server name sent to us by other side */
std::string InboundDescription; /* Server description (GECOS) sent to us by the other side */
std::string InboundSID; /* Server ID sent to us by the other side */
int num_lost_users; /* Users lost in split */
int num_lost_servers; /* Servers lost in split */
time_t NextPing; /* Time when we are due to ping this server */
bool LastPingWasGood; /* Responded to last ping we sent? */
std::string IP;
std::string ModuleList; /* Required module list of other server from CAPAB */
std::string OptModuleList; /* Optional module list of other server from CAPAB */
std::map<std::string,std::string> CapKeys; /* CAPAB keys from other server */
std::string ourchallenge; /* Challenge sent for challenge/response */
std::string theirchallenge; /* Challenge recv for challenge/response */
std::string OutboundPass; /* Outbound password */
int capab_phase; /* Have sent CAPAB already */
bool auth_fingerprint; /* Did we auth using SSL fingerprint */
bool auth_challenge; /* Did we auth using challenge/response */
int proto_version; /* Remote protocol version */
public:
HandshakeTimer* hstimer; /* Handshake timer, needed to work around I/O hook buffering */
reference<Autoconnect> myautoconnect; /* Autoconnect used to cause this connection, if any */
time_t age;
/** Because most of the I/O gubbins are encapsulated within
* BufferedSocket, we just call the superclass constructor for
* most of the action, and append a few of our own values
* to it.
*/
TreeSocket(SpanningTreeUtilities* Util, std::string host, int port, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Autoconnect* myac, Module* HookMod = NULL);
/** When a listening socket gives us a new file descriptor,
* we must associate it with a socket without creating a new
* connection. This constructor is used for this purpose.
*/
TreeSocket(SpanningTreeUtilities* Util, int newfd, char* ip, Autoconnect* myac, Module* HookMod = NULL);
/** Get link state
*/
ServerState GetLinkState();
/** Get challenge set in our CAPAB for challenge/response
*/
const std::string& GetOurChallenge();
/** Get challenge set in our CAPAB for challenge/response
*/
void SetOurChallenge(const std::string &c);
/** Get challenge set in their CAPAB for challenge/response
*/
const std::string& GetTheirChallenge();
/** Get challenge set in their CAPAB for challenge/response
*/
void SetTheirChallenge(const std::string &c);
/** Compare two passwords based on authentication scheme
*/
bool ComparePass(const Link& link, const std::string &theirs);
/** Clean up information used only during server negotiation
*/
void CleanNegotiationInfo();
/** Destructor
*/
~TreeSocket();
/** Generate random string used for challenge-response auth
*/
std::string RandString(unsigned int length);
/** Construct a password, optionally hashed with the other side's
* challenge string
*/
std::string MakePass(const std::string &password, const std::string &challenge);
/** When an outbound connection finishes connecting, we receive
* this event, and must send our SERVER string to the other
* side. If the other side is happy, as outlined in the server
* to server docs on the inspircd.org site, the other side
* will then send back its own server string.
*/
virtual void OnConnected();
/** Handle socket error event
*/
virtual void OnError(BufferedSocketError e);
/** Sends an error to the remote server, and displays it locally to show
* that it was sent.
*/
void SendError(const std::string &errormessage);
/** Recursively send the server tree with distances as hops.
* This is used during network burst to inform the other server
* (and any of ITS servers too) of what servers we know about.
* If at any point any of these servers already exist on the other
* end, our connection may be terminated. The hopcounts given
* by this function are relative, this doesn't matter so long as
* they are all >1, as all the remote servers re-calculate them
* to be relative too, with themselves as hop 0.
*/
void SendServers(TreeServer* Current, TreeServer* s, int hops);
/** Returns module list as a string, filtered by filter
* @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
*/
std::string MyModules(int filter);
/** Send my capabilities to the remote side
*/
void SendCapabilities(int phase);
/** Add modules to VF_COMMON list for backwards compatability */
void CompatAddModules(std::vector<std::string>& modlist);
/* Check a comma seperated list for an item */
bool HasItem(const std::string &list, const std::string &item);
/* Isolate and return the elements that are different between two comma seperated lists */
std::string ListDifference(const std::string &one, const std::string &two);
bool Capab(const parameterlist ¶ms);
/** This function forces this server to quit, removing this server
* and any users on it (and servers and users below that, etc etc).
* It's very slow and pretty clunky, but luckily unless your network
* is having a REAL bad hair day, this function shouldnt be called
* too many times a month ;-)
*/
void SquitServer(std::string &from, TreeServer* Current);
/** This is a wrapper function for SquitServer above, which
* does some validation first and passes on the SQUIT to all
* other remaining servers.
*/
void Squit(TreeServer* Current, const std::string &reason);
/** FMODE command - server mode with timestamp checks */
bool ForceMode(const std::string &source, parameterlist ¶ms);
/** FTOPIC command */
bool ForceTopic(const std::string &source, parameterlist ¶ms);
/** FJOIN, similar to TS6 SJOIN, but not quite. */
bool ForceJoin(const std::string &source, parameterlist ¶ms);
/* Used on nick collision ... XXX ugly function HACK */
int DoCollision(User *u, time_t remotets, const std::string &remoteident, const std::string &remoteip, const std::string &remoteuid);
/** UID command */
bool ParseUID(const std::string &source, parameterlist ¶ms);
/** Send one or more FJOINs for a channel of users.
* If the length of a single line is more than 480-NICKMAX
* in length, it is split over multiple lines.
*/
void SendFJoins(TreeServer* Current, Channel* c);
/** Send G, Q, Z and E lines */
void SendXLines(TreeServer* Current);
/** Send channel modes and topics */
void SendChannelModes(TreeServer* Current);
/** send all users and their oper state/modes */
void SendUsers(TreeServer* Current);
/** This function is called when we want to send a netburst to a local
* server. There is a set order we must do this, because for example
* users require their servers to exist, and channels require their
* users to exist. You get the idea.
*/
void DoBurst(TreeServer* s);
/** This function is called when we receive data from a remote
* server.
*/
void OnDataReady();
/** Send one or more complete lines down the socket
*/
void WriteLine(std::string line);
/** Handle ERROR command */
bool Error(parameterlist ¶ms);
/** remote MOTD. leet, huh? */
bool Motd(const std::string &prefix, parameterlist ¶ms);
/** remote ADMIN. leet, huh? */
bool Admin(const std::string &prefix, parameterlist ¶ms);
/** Remote MODULES */
bool Modules(const std::string &prefix, parameterlist ¶ms);
bool Stats(const std::string &prefix, parameterlist ¶ms);
/** Because the core won't let users or even SERVERS set +o,
* we use the OPERTYPE command to do this.
*/
bool OperType(const std::string &prefix, parameterlist ¶ms);
/** Remote AWAY */
bool Away(const std::string &prefix, parameterlist ¶ms);
/** Because Andy insists that services-compatible servers must
* implement SVSNICK and SVSJOIN, that's exactly what we do :p
*/
bool SVSNick(const std::string &prefix, parameterlist ¶ms);
/** SAVE to resolve nick collisions without killing */
bool ForceNick(const std::string &prefix, parameterlist ¶ms);
/** PRIVMSG or NOTICE with server origin ONLY
*/
bool ServerMessage(const std::string &messagetype, const std::string &prefix, parameterlist ¶ms, const std::string &sourceserv);
/** ENCAP command
*/
bool Encap(const std::string &prefix, parameterlist ¶ms);
/** OPERQUIT command
*/
bool OperQuit(const std::string &prefix, parameterlist ¶ms);
/** SVSJOIN
*/
bool ServiceJoin(const std::string &prefix, parameterlist ¶ms);
/** SVSPART
*/
bool ServicePart(const std::string &prefix, parameterlist ¶ms);
/** KILL
*/
bool RemoteKill(const std::string &prefix, parameterlist ¶ms);
/** PONG
*/
bool LocalPong(const std::string &prefix, parameterlist ¶ms);
/** METADATA
*/
bool MetaData(const std::string &prefix, parameterlist ¶ms);
/** VERSION
*/
bool ServerVersion(const std::string &prefix, parameterlist ¶ms);
/** CHGHOST
*/
bool ChangeHost(const std::string &prefix, parameterlist ¶ms);
/** ADDLINE
*/
bool AddLine(const std::string &prefix, parameterlist ¶ms);
/** DELLINE
*/
bool DelLine(const std::string &prefix, parameterlist ¶ms);
/** CHGNAME
*/
bool ChangeName(const std::string &prefix, parameterlist ¶ms);
/** FIDENT */
bool ChangeIdent(const std::string &prefix, parameterlist ¶ms);
/** WHOIS
*/
bool Whois(const std::string &prefix, parameterlist ¶ms);
/** PUSH
*/
bool Push(const std::string &prefix, parameterlist ¶ms);
/** TIME
*/
bool Time(const std::string &prefix, parameterlist ¶ms);
/** PING
*/
bool LocalPing(const std::string &prefix, parameterlist ¶ms);
/** Remove all modes from a channel, including statusmodes (+qaovh etc), simplemodes, parameter modes.
* This does not update the timestamp of the target channel, this must be done seperately.
*/
bool RemoveStatus(const std::string &prefix, parameterlist ¶ms);
/** <- (remote) <- SERVER
*/
bool RemoteServer(const std::string &prefix, parameterlist ¶ms);
/** (local) -> SERVER
*/
bool Outbound_Reply_Server(parameterlist ¶ms);
/** (local) <- SERVER
*/
bool Inbound_Server(parameterlist ¶ms);
/** Handle netsplit
*/
void Split(const std::string &line, parameterlist &n);
/** Process complete line from buffer
*/
bool ProcessLine(std::string &line);
/** Get this server's name
*/
virtual std::string GetName();
/** Handle socket timeout from connect()
*/
virtual void OnTimeout();
/** Handle server quit on close
*/
virtual void Close();
};
/* Used to validate the value lengths of multiple parameters for a command */
struct cmd_validation
{
const char* item;
size_t param;
size_t length;
};
/* Used to validate the length values in CAPAB CAPABILITIES */
struct cap_validation
{
const char* reason;
const char* key;
size_t size;
};
#endif
|