1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 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__
24 * The server list in InspIRCd is maintained as two structures
25 * which hold the data in different ways. Most of the time, we
26 * want to very quicky obtain three pieces of information:
28 * (1) The information on a server
29 * (2) The information on the server we must send data through
30 * to actually REACH the server we're after
31 * (3) Potentially, the child/parent objects of this server
33 * The InspIRCd spanning protocol provides easy access to these
34 * by storing the data firstly in a recursive structure, where
35 * each item references its parent item, and a dynamic list
36 * of child items, and another structure which stores the items
37 * hashed, linearly. This means that if we want to find a server
38 * by name quickly, we can look it up in the hash, avoiding
39 * any O(n) lookups. If however, during a split or sync, we want
40 * to apply an operation to a server, and any of its child objects
41 * we can resort to recursion to walk the tree structure.
42 * Any socket can have one of five states at any one time.
44 * CONNECTING: indicates an outbound socket which is
45 * waiting to be writeable.
46 * WAIT_AUTH_1: indicates the socket is outbound and
47 * has successfully connected, but has not
48 * yet sent and received SERVER strings.
49 * WAIT_AUTH_2: indicates that the socket is inbound
50 * but has not yet sent and received
52 * CONNECTED: represents a fully authorized, fully
55 enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
57 /** Every SERVER connection inbound or outbound is represented by
58 * an object of type TreeSocket.
59 * TreeSockets, being inherited from BufferedSocket, can be tied into
60 * the core socket engine, and we cn therefore receive activity events
61 * for them, just like activex objects on speed. (yes really, that
62 * is a technical term!) Each of these which relates to a locally
63 * connected server is assocated with it, by hooking it onto a
64 * TreeSocket class using its constructor. In this way, we can
65 * maintain a list of servers, some of which are directly connected,
66 * some of which are not.
68 class TreeSocket : public BufferedSocket
70 SpanningTreeUtilities* Utils; /* Utility class */
71 std::string myhost; /* Canonical hostname */
72 ServerState LinkState; /* Link state */
73 std::string InboundServerName; /* Server name sent to us by other side */
74 std::string InboundDescription; /* Server description (GECOS) sent to us by the other side */
75 std::string InboundSID; /* Server ID sent to us by the other side */
76 int num_lost_users; /* Users lost in split */
77 int num_lost_servers; /* Servers lost in split */
78 time_t NextPing; /* Time when we are due to ping this server */
79 bool LastPingWasGood; /* Responded to last ping we sent? */
81 std::string ModuleList; /* Required module list of other server from CAPAB */
82 std::string OptModuleList; /* Optional module list of other server from CAPAB */
83 std::map<std::string,std::string> CapKeys; /* CAPAB keys from other server */
84 std::string ourchallenge; /* Challenge sent for challenge/response */
85 std::string theirchallenge; /* Challenge recv for challenge/response */
86 std::string OutboundPass; /* Outbound password */
87 int capab_phase; /* Have sent CAPAB already */
88 bool auth_fingerprint; /* Did we auth using SSL fingerprint */
89 bool auth_challenge; /* Did we auth using challenge/response */
90 int proto_version; /* Remote protocol version */
92 reference<Autoconnect> myautoconnect; /* Autoconnect used to cause this connection, if any */
95 /** Because most of the I/O gubbins are encapsulated within
96 * BufferedSocket, we just call the superclass constructor for
97 * most of the action, and append a few of our own values
100 TreeSocket(SpanningTreeUtilities* Util, const std::string& host, int port, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Autoconnect* myac, const std::string& Hook);
102 /** When a listening socket gives us a new file descriptor,
103 * we must associate it with a socket without creating a new
104 * connection. This constructor is used for this purpose.
106 TreeSocket(SpanningTreeUtilities* Util, int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
110 ServerState GetLinkState();
112 /** Get challenge set in our CAPAB for challenge/response
114 const std::string& GetOurChallenge();
116 /** Get challenge set in our CAPAB for challenge/response
118 void SetOurChallenge(const std::string &c);
120 /** Get challenge set in their CAPAB for challenge/response
122 const std::string& GetTheirChallenge();
124 /** Get challenge set in their CAPAB for challenge/response
126 void SetTheirChallenge(const std::string &c);
128 /** Compare two passwords based on authentication scheme
130 bool ComparePass(const Link& link, const std::string &theirs);
132 /** Clean up information used only during server negotiation
134 void CleanNegotiationInfo();
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 void 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 /** Recursively send the server tree with distances as hops.
168 * This is used during network burst to inform the other server
169 * (and any of ITS servers too) of what servers we know about.
170 * If at any point any of these servers already exist on the other
171 * end, our connection may be terminated. The hopcounts given
172 * by this function are relative, this doesn't matter so long as
173 * they are all >1, as all the remote servers re-calculate them
174 * to be relative too, with themselves as hop 0.
176 void SendServers(TreeServer* Current, TreeServer* s, int hops);
178 /** Returns module list as a string, filtered by filter
179 * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
181 std::string MyModules(int filter);
183 /** Send my capabilities to the remote side
185 void SendCapabilities(int phase);
187 /** Add modules to VF_COMMON list for backwards compatability */
188 void CompatAddModules(std::vector<std::string>& modlist);
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 parameterlist ¶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 void ForceMode(User* who, parameterlist ¶ms);
215 /** FTOPIC command */
216 bool ForceTopic(const std::string &source, parameterlist ¶ms);
218 /** FJOIN, similar to TS6 SJOIN, but not quite. */
219 void ForceJoin(User* who, parameterlist ¶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, parameterlist ¶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
254 /** Send one or more complete lines down the socket
256 void WriteLine(std::string line);
258 /** Handle ERROR command */
259 void Error(parameterlist ¶ms);
262 bool Motd(const std::string &prefix, parameterlist ¶ms);
265 bool Admin(const std::string &prefix, parameterlist ¶ms);
267 bool Stats(const std::string &prefix, parameterlist ¶ms);
269 /** Because the core won't let users or even SERVERS set +o,
270 * we use the OPERTYPE command to do this.
272 bool OperType(const std::string &prefix, parameterlist ¶ms);
275 bool Away(const std::string &prefix, parameterlist ¶ms);
277 /** SAVE to resolve nick collisions without killing */
278 bool ForceNick(const std::string &prefix, parameterlist ¶ms);
282 void Encap(User* who, parameterlist ¶ms);
286 bool OperQuit(const std::string &prefix, parameterlist ¶ms);
290 bool RemoteKill(const std::string &prefix, parameterlist ¶ms);
294 bool LocalPong(const std::string &prefix, parameterlist ¶ms);
298 bool MetaData(const std::string &prefix, parameterlist ¶ms);
302 bool ServerVersion(const std::string &prefix, parameterlist ¶ms);
306 bool ChangeHost(const std::string &prefix, parameterlist ¶ms);
310 bool AddLine(const std::string &prefix, parameterlist ¶ms);
314 bool DelLine(const std::string &prefix, parameterlist ¶ms);
318 bool ChangeName(const std::string &prefix, parameterlist ¶ms);
321 bool ChangeIdent(const std::string &prefix, parameterlist ¶ms);
325 bool Whois(const std::string &prefix, parameterlist ¶ms);
329 bool Push(const std::string &prefix, parameterlist ¶ms);
333 bool Time(const std::string &prefix, parameterlist ¶ms);
337 bool LocalPing(const std::string &prefix, parameterlist ¶ms);
339 /** Remove all modes from a channel, including statusmodes (+qaovh etc), simplemodes, parameter modes.
340 * This does not update the timestamp of the target channel, this must be done seperately.
342 void RemoveStatus(User* source, parameterlist ¶ms);
344 /** <- (remote) <- SERVER
346 bool RemoteServer(const std::string &prefix, parameterlist ¶ms);
348 /** (local) -> SERVER
350 bool Outbound_Reply_Server(parameterlist ¶ms);
352 /** (local) <- SERVER
354 bool Inbound_Server(parameterlist ¶ms);
356 /** Handle IRC line split
358 void Split(const std::string &line, std::string& prefix, std::string& command, parameterlist ¶ms);
360 /** Process complete line from buffer
362 void ProcessLine(std::string &line);
364 void ProcessConnectedLine(std::string& prefix, std::string& command, parameterlist& params);
366 /** Get this server's name
368 virtual std::string GetName();
370 /** Handle socket timeout from connect()
372 virtual void OnTimeout();
373 /** Handle server quit on close
375 virtual void Close();
378 /* Used to validate the value lengths of multiple parameters for a command */
379 struct cmd_validation
386 /* Used to validate the length values in CAPAB CAPABILITIES */
387 struct cap_validation