1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __TREESOCKET_H__
15 #define __TREESOCKET_H__
17 #include "commands/cmd_whois.h"
18 #include "commands/cmd_stats.h"
22 #include "transport.h"
24 #include "m_spanningtree/utils.h"
25 #include "m_spanningtree/handshaketimer.h"
28 * The server list in InspIRCd is maintained as two structures
29 * which hold the data in different ways. Most of the time, we
30 * want to very quicky obtain three pieces of information:
32 * (1) The information on a server
33 * (2) The information on the server we must send data through
34 * to actually REACH the server we're after
35 * (3) Potentially, the child/parent objects of this server
37 * The InspIRCd spanning protocol provides easy access to these
38 * by storing the data firstly in a recursive structure, where
39 * each item references its parent item, and a dynamic list
40 * of child items, and another structure which stores the items
41 * hashed, linearly. This means that if we want to find a server
42 * by name quickly, we can look it up in the hash, avoiding
43 * any O(n) lookups. If however, during a split or sync, we want
44 * to apply an operation to a server, and any of its child objects
45 * we can resort to recursion to walk the tree structure.
46 * Any socket can have one of five states at any one time.
48 * CONNECTING: indicates an outbound socket which is
49 * waiting to be writeable.
50 * WAIT_AUTH_1: indicates the socket is outbound and
51 * has successfully connected, but has not
52 * yet sent and received SERVER strings.
53 * WAIT_AUTH_2: indicates that the socket is inbound
54 * but has not yet sent and received
56 * CONNECTED: represents a fully authorized, fully
59 enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
61 /** Every SERVER connection inbound or outbound is represented by
62 * an object of type TreeSocket.
63 * TreeSockets, being inherited from BufferedSocket, can be tied into
64 * the core socket engine, and we cn therefore receive activity events
65 * for them, just like activex objects on speed. (yes really, that
66 * is a technical term!) Each of these which relates to a locally
67 * connected server is assocated with it, by hooking it onto a
68 * TreeSocket class using its constructor. In this way, we can
69 * maintain a list of servers, some of which are directly connected,
70 * some of which are not.
72 class TreeSocket : public BufferedSocket
74 SpanningTreeUtilities* Utils; /* Utility class */
75 std::string myhost; /* Canonical hostname */
76 std::string in_buffer; /* Input buffer */
77 ServerState LinkState; /* Link state */
78 std::string InboundServerName; /* Server name sent to us by other side */
79 std::string InboundDescription; /* Server description (GECOS) sent to us by the other side */
80 std::string InboundSID; /* Server ID sent to us by the other side */
81 int num_lost_users; /* Users lost in split */
82 int num_lost_servers; /* Servers lost in split */
83 time_t NextPing; /* Time when we are due to ping this server */
84 bool LastPingWasGood; /* Responded to last ping we sent? */
85 unsigned int keylength; /* Is this still used? */
86 std::string ModuleList; /* Module list of other server from CAPAB */
87 std::map<std::string,std::string> CapKeys; /* CAPAB keys from other server */
88 Module* Hook; /* I/O hooking module that we're attached to for this socket */
89 std::string ourchallenge; /* Challenge sent for challenge/response */
90 std::string theirchallenge; /* Challenge recv for challenge/response */
91 std::string OutboundPass; /* Outbound password */
92 bool sentcapab; /* Have sent CAPAB already */
94 HandshakeTimer* hstimer; /* Handshake timer, needed to work around I/O hook buffering */
96 /** Because most of the I/O gubbins are encapsulated within
97 * BufferedSocket, we just call the superclass constructor for
98 * most of the action, and append a few of our own values
101 TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Module* HookMod = NULL);
103 /** When a listening socket gives us a new file descriptor,
104 * we must associate it with a socket without creating a new
105 * connection. This constructor is used for this purpose.
107 TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, int newfd, char* ip, Module* HookMod = NULL);
111 ServerState GetLinkState();
113 /** Get challenge set in our CAPAB for challenge/response
115 const std::string& GetOurChallenge();
117 /** Get challenge set in our CAPAB for challenge/response
119 void SetOurChallenge(const std::string &c);
121 /** Get challenge set in their CAPAB for challenge/response
123 const std::string& GetTheirChallenge();
125 /** Get challenge set in their CAPAB for challenge/response
127 void SetTheirChallenge(const std::string &c);
129 /** Compare two passwords based on authentication scheme
131 bool ComparePass(const std::string &ours, const std::string &theirs);
133 /** Return the module which we are hooking to for I/O encapsulation
141 /** Generate random string used for challenge-response auth
143 std::string RandString(unsigned int length);
145 /** Construct a password, optionally hashed with the other side's
148 std::string MakePass(const std::string &password, const std::string &challenge);
150 /** When an outbound connection finishes connecting, we receive
151 * this event, and must send our SERVER string to the other
152 * side. If the other side is happy, as outlined in the server
153 * to server docs on the inspircd.org site, the other side
154 * will then send back its own server string.
156 virtual bool OnConnected();
158 /** Handle socket error event
160 virtual void OnError(BufferedSocketError e);
162 /** Sends an error to the remote server, and displays it locally to show
165 void SendError(const std::string &errormessage);
167 /** Handle socket disconnect event
169 virtual int OnDisconnect();
171 /** Recursively send the server tree with distances as hops.
172 * This is used during network burst to inform the other server
173 * (and any of ITS servers too) of what servers we know about.
174 * If at any point any of these servers already exist on the other
175 * end, our connection may be terminated. The hopcounts given
176 * by this function are relative, this doesn't matter so long as
177 * they are all >1, as all the remote servers re-calculate them
178 * to be relative too, with themselves as hop 0.
180 void SendServers(TreeServer* Current, TreeServer* s, int hops);
182 /** Returns my capabilities as a string
184 std::string MyCapabilities();
186 /** Send my capabilities to the remote side
188 void SendCapabilities();
190 /* Check a comma seperated list for an item */
191 bool HasItem(const std::string &list, const std::string &item);
193 /* Isolate and return the elements that are different between two comma seperated lists */
194 std::string ListDifference(const std::string &one, const std::string &two);
196 bool Capab(const std::deque<std::string> ¶ms);
198 /** This function forces this server to quit, removing this server
199 * and any users on it (and servers and users below that, etc etc).
200 * It's very slow and pretty clunky, but luckily unless your network
201 * is having a REAL bad hair day, this function shouldnt be called
202 * too many times a month ;-)
204 void SquitServer(std::string &from, TreeServer* Current);
206 /** This is a wrapper function for SquitServer above, which
207 * does some validation first and passes on the SQUIT to all
208 * other remaining servers.
210 void Squit(TreeServer* Current, const std::string &reason);
212 /** FMODE command - server mode with timestamp checks */
213 bool ForceMode(const std::string &source, std::deque<std::string> ¶ms);
215 /** FTOPIC command */
216 bool ForceTopic(const std::string &source, std::deque<std::string> ¶ms);
218 /** FJOIN, similar to TS6 SJOIN, but not quite. */
219 bool ForceJoin(const std::string &source, std::deque<std::string> ¶ms);
221 /* Used on nick collision ... XXX ugly function HACK */
222 int DoCollision(User *u, time_t remotets, const std::string &remoteident, const std::string &remoteip, const std::string &remoteuid);
225 bool ParseUID(const std::string &source, std::deque<std::string> ¶ms);
227 /** Send one or more FJOINs for a channel of users.
228 * If the length of a single line is more than 480-NICKMAX
229 * in length, it is split over multiple lines.
231 void SendFJoins(TreeServer* Current, Channel* c);
233 /** Send G, Q, Z and E lines */
234 void SendXLines(TreeServer* Current);
236 /** Send channel modes and topics */
237 void SendChannelModes(TreeServer* Current);
239 /** send all users and their oper state/modes */
240 void SendUsers(TreeServer* Current);
242 /** This function is called when we want to send a netburst to a local
243 * server. There is a set order we must do this, because for example
244 * users require their servers to exist, and channels require their
245 * users to exist. You get the idea.
247 void DoBurst(TreeServer* s);
249 /** This function is called when we receive data from a remote
250 * server. We buffer the data in a std::string (it doesnt stay
251 * there for long), reading using BufferedSocket::Read() which can
252 * read up to 16 kilobytes in one operation.
254 * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
255 * THE SOCKET OBJECT FOR US.
257 virtual bool OnDataReady();
259 /** Send one or more complete lines down the socket
261 void WriteLine(std::string line);
263 /** Handle ERROR command */
264 bool Error(std::deque<std::string> ¶ms);
266 /** remote MOTD. leet, huh? */
267 bool Motd(const std::string &prefix, std::deque<std::string> ¶ms);
269 /** remote ADMIN. leet, huh? */
270 bool Admin(const std::string &prefix, std::deque<std::string> ¶ms);
272 /** Remote MODULES */
273 bool Modules(const std::string &prefix, std::deque<std::string> ¶ms);
275 bool Stats(const std::string &prefix, std::deque<std::string> ¶ms);
277 /** Because the core won't let users or even SERVERS set +o,
278 * we use the OPERTYPE command to do this.
280 bool OperType(const std::string &prefix, std::deque<std::string> ¶ms);
282 /** Because Andy insists that services-compatible servers must
283 * implement SVSNICK and SVSJOIN, that's exactly what we do :p
285 bool ForceNick(const std::string &prefix, std::deque<std::string> ¶ms);
287 /** PRIVMSG or NOTICE with server origin ONLY
289 bool ServerMessage(const std::string &messagetype, const std::string &prefix, std::deque<std::string> ¶ms, const std::string &sourceserv);
293 bool Encap(const std::string &prefix, std::deque<std::string> ¶ms);
297 bool OperQuit(const std::string &prefix, std::deque<std::string> ¶ms);
301 bool ServiceJoin(const std::string &prefix, std::deque<std::string> ¶ms);
305 bool ServicePart(const std::string &prefix, std::deque<std::string> ¶ms);
309 bool RemoteKill(const std::string &prefix, std::deque<std::string> ¶ms);
313 bool LocalPong(const std::string &prefix, std::deque<std::string> ¶ms);
317 bool MetaData(const std::string &prefix, std::deque<std::string> ¶ms);
321 bool ServerVersion(const std::string &prefix, std::deque<std::string> ¶ms);
325 bool ChangeHost(const std::string &prefix, std::deque<std::string> ¶ms);
329 bool AddLine(const std::string &prefix, std::deque<std::string> ¶ms);
333 bool DelLine(const std::string &prefix, std::deque<std::string> ¶ms);
337 bool ChangeName(const std::string &prefix, std::deque<std::string> ¶ms);
341 bool Whois(const std::string &prefix, std::deque<std::string> ¶ms);
345 bool Push(const std::string &prefix, std::deque<std::string> ¶ms);
349 bool Time(const std::string &prefix, std::deque<std::string> ¶ms);
353 bool LocalPing(const std::string &prefix, std::deque<std::string> ¶ms);
355 /** Remove all modes from a channel, including statusmodes (+qaovh etc), simplemodes, parameter modes.
356 * This does not update the timestamp of the target channel, this must be done seperately.
358 bool RemoveStatus(const std::string &prefix, std::deque<std::string> ¶ms);
360 /** <- (remote) <- SERVER
362 bool RemoteServer(const std::string &prefix, std::deque<std::string> ¶ms);
364 /** (local) -> SERVER
366 bool Outbound_Reply_Server(std::deque<std::string> ¶ms);
368 /** (local) <- SERVER
370 bool Inbound_Server(std::deque<std::string> ¶ms);
374 void Split(const std::string &line, std::deque<std::string> &n);
376 /** Process complete line from buffer
378 bool ProcessLine(std::string &line);
380 /** Get this server's name
382 virtual std::string GetName();
384 /** Handle socket timeout from connect()
386 virtual void OnTimeout();
388 /** Handle socket close event
390 virtual void OnClose();
393 /* Used to validate the value lengths of multiple parameters for a command */
394 struct cmd_validation
401 /* Used to validate the length values in CAPAB CAPABILITIES */
402 struct cap_validation