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"
25 #include "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 std::string ModuleList; /* Required module list of other server from CAPAB */
86 std::string OptModuleList; /* Optional 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 */
93 bool auth_fingerprint; /* Did we auth using SSL fingerprint */
94 bool auth_challenge; /* Did we auth using challenge/response */
96 HandshakeTimer* hstimer; /* Handshake timer, needed to work around I/O hook buffering */
99 /** Because most of the I/O gubbins are encapsulated within
100 * BufferedSocket, we just call the superclass constructor for
101 * most of the action, and append a few of our own values
104 TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Module* HookMod = NULL);
106 /** When a listening socket gives us a new file descriptor,
107 * we must associate it with a socket without creating a new
108 * connection. This constructor is used for this purpose.
110 TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, int newfd, char* ip, Module* HookMod = NULL);
114 ServerState GetLinkState();
116 /** Get challenge set in our CAPAB for challenge/response
118 const std::string& GetOurChallenge();
120 /** Get challenge set in our CAPAB for challenge/response
122 void SetOurChallenge(const std::string &c);
124 /** Get challenge set in their CAPAB for challenge/response
126 const std::string& GetTheirChallenge();
128 /** Get challenge set in their CAPAB for challenge/response
130 void SetTheirChallenge(const std::string &c);
132 /** Compare two passwords based on authentication scheme
134 bool ComparePass(const Link& link, const std::string &theirs);
136 /** Clean up information used only during server negotiation
138 void CleanNegotiationInfo();
140 /** Return the module which we are hooking to for I/O encapsulation
148 /** Generate random string used for challenge-response auth
150 std::string RandString(unsigned int length);
152 /** Construct a password, optionally hashed with the other side's
155 std::string MakePass(const std::string &password, const std::string &challenge);
157 /** When an outbound connection finishes connecting, we receive
158 * this event, and must send our SERVER string to the other
159 * side. If the other side is happy, as outlined in the server
160 * to server docs on the inspircd.org site, the other side
161 * will then send back its own server string.
163 virtual bool OnConnected();
165 /** Handle socket error event
167 virtual void OnError(BufferedSocketError e);
169 /** Sends an error to the remote server, and displays it locally to show
172 void SendError(const std::string &errormessage);
174 /** Handle socket disconnect event
176 virtual int OnDisconnect();
178 /** Recursively send the server tree with distances as hops.
179 * This is used during network burst to inform the other server
180 * (and any of ITS servers too) of what servers we know about.
181 * If at any point any of these servers already exist on the other
182 * end, our connection may be terminated. The hopcounts given
183 * by this function are relative, this doesn't matter so long as
184 * they are all >1, as all the remote servers re-calculate them
185 * to be relative too, with themselves as hop 0.
187 void SendServers(TreeServer* Current, TreeServer* s, int hops);
189 /** Returns module list as a string, filtered by filter
190 * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
192 std::string MyModules(int filter);
194 /** Send my capabilities to the remote side
196 void SendCapabilities();
198 /* Check a comma seperated list for an item */
199 bool HasItem(const std::string &list, const std::string &item);
201 /* Isolate and return the elements that are different between two comma seperated lists */
202 std::string ListDifference(const std::string &one, const std::string &two);
204 bool Capab(const parameterlist ¶ms);
206 /** This function forces this server to quit, removing this server
207 * and any users on it (and servers and users below that, etc etc).
208 * It's very slow and pretty clunky, but luckily unless your network
209 * is having a REAL bad hair day, this function shouldnt be called
210 * too many times a month ;-)
212 void SquitServer(std::string &from, TreeServer* Current);
214 /** This is a wrapper function for SquitServer above, which
215 * does some validation first and passes on the SQUIT to all
216 * other remaining servers.
218 void Squit(TreeServer* Current, const std::string &reason);
220 /** FMODE command - server mode with timestamp checks */
221 bool ForceMode(const std::string &source, parameterlist ¶ms);
223 /** FTOPIC command */
224 bool ForceTopic(const std::string &source, parameterlist ¶ms);
226 /** FJOIN, similar to TS6 SJOIN, but not quite. */
227 bool ForceJoin(const std::string &source, parameterlist ¶ms);
229 /* Used on nick collision ... XXX ugly function HACK */
230 int DoCollision(User *u, time_t remotets, const std::string &remoteident, const std::string &remoteip, const std::string &remoteuid);
233 bool ParseUID(const std::string &source, parameterlist ¶ms);
235 /** Send one or more FJOINs for a channel of users.
236 * If the length of a single line is more than 480-NICKMAX
237 * in length, it is split over multiple lines.
239 void SendFJoins(TreeServer* Current, Channel* c);
241 /** Send G, Q, Z and E lines */
242 void SendXLines(TreeServer* Current);
244 /** Send channel modes and topics */
245 void SendChannelModes(TreeServer* Current);
247 /** send all users and their oper state/modes */
248 void SendUsers(TreeServer* Current);
250 /** This function is called when we want to send a netburst to a local
251 * server. There is a set order we must do this, because for example
252 * users require their servers to exist, and channels require their
253 * users to exist. You get the idea.
255 void DoBurst(TreeServer* s);
257 /** This function is called when we receive data from a remote
258 * server. We buffer the data in a std::string (it doesnt stay
259 * there for long), reading using BufferedSocket::Read() which can
260 * read up to 16 kilobytes in one operation.
262 * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
263 * THE SOCKET OBJECT FOR US.
265 virtual bool OnDataReady();
267 /** Send one or more complete lines down the socket
269 void WriteLine(std::string line);
271 /** Handle ERROR command */
272 bool Error(parameterlist ¶ms);
274 /** remote MOTD. leet, huh? */
275 bool Motd(const std::string &prefix, parameterlist ¶ms);
277 /** remote ADMIN. leet, huh? */
278 bool Admin(const std::string &prefix, parameterlist ¶ms);
280 /** Remote MODULES */
281 bool Modules(const std::string &prefix, parameterlist ¶ms);
283 bool Stats(const std::string &prefix, parameterlist ¶ms);
285 /** Because the core won't let users or even SERVERS set +o,
286 * we use the OPERTYPE command to do this.
288 bool OperType(const std::string &prefix, parameterlist ¶ms);
290 /** Because Andy insists that services-compatible servers must
291 * implement SVSNICK and SVSJOIN, that's exactly what we do :p
293 bool ForceNick(const std::string &prefix, parameterlist ¶ms);
295 /** PRIVMSG or NOTICE with server origin ONLY
297 bool ServerMessage(const std::string &messagetype, const std::string &prefix, parameterlist ¶ms, const std::string &sourceserv);
301 bool Encap(const std::string &prefix, parameterlist ¶ms);
305 bool OperQuit(const std::string &prefix, parameterlist ¶ms);
309 bool ServiceJoin(const std::string &prefix, parameterlist ¶ms);
313 bool ServicePart(const std::string &prefix, parameterlist ¶ms);
317 bool RemoteKill(const std::string &prefix, parameterlist ¶ms);
321 bool LocalPong(const std::string &prefix, parameterlist ¶ms);
325 bool MetaData(const std::string &prefix, parameterlist ¶ms);
329 bool ServerVersion(const std::string &prefix, parameterlist ¶ms);
333 bool ChangeHost(const std::string &prefix, parameterlist ¶ms);
337 bool AddLine(const std::string &prefix, parameterlist ¶ms);
341 bool DelLine(const std::string &prefix, parameterlist ¶ms);
345 bool ChangeName(const std::string &prefix, parameterlist ¶ms);
348 bool ChangeIdent(const std::string &prefix, parameterlist ¶ms);
352 bool Whois(const std::string &prefix, parameterlist ¶ms);
356 bool Push(const std::string &prefix, parameterlist ¶ms);
360 bool Time(const std::string &prefix, parameterlist ¶ms);
364 bool LocalPing(const std::string &prefix, parameterlist ¶ms);
366 /** Remove all modes from a channel, including statusmodes (+qaovh etc), simplemodes, parameter modes.
367 * This does not update the timestamp of the target channel, this must be done seperately.
369 bool RemoveStatus(const std::string &prefix, parameterlist ¶ms);
371 /** <- (remote) <- SERVER
373 bool RemoteServer(const std::string &prefix, parameterlist ¶ms);
375 /** (local) -> SERVER
377 bool Outbound_Reply_Server(parameterlist ¶ms);
379 /** (local) <- SERVER
381 bool Inbound_Server(parameterlist ¶ms);
385 void Split(const std::string &line, parameterlist &n);
387 /** Process complete line from buffer
389 bool ProcessLine(std::string &line);
391 /** Get this server's name
393 virtual std::string GetName();
395 /** Handle socket timeout from connect()
397 virtual void OnTimeout();
399 /** Handle socket close event
401 virtual void OnClose();
404 /* Used to validate the value lengths of multiple parameters for a command */
405 struct cmd_validation
412 /* Used to validate the length values in CAPAB CAPABILITIES */
413 struct cap_validation