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 };
59 std::string ModuleList; /* Required module list of other server from CAPAB */
60 std::string OptModuleList; /* Optional module list of other server from CAPAB */
61 std::string ChanModes;
62 std::string UserModes;
63 std::map<std::string,std::string> CapKeys; /* CAPAB keys from other server */
64 std::string ourchallenge; /* Challenge sent for challenge/response */
65 std::string theirchallenge; /* Challenge recv for challenge/response */
66 std::string OutboundPass; /* Outbound password */
67 int capab_phase; /* Have sent CAPAB already */
68 bool auth_fingerprint; /* Did we auth using SSL fingerprint */
69 bool auth_challenge; /* Did we auth using challenge/response */
72 /** Every SERVER connection inbound or outbound is represented by
73 * an object of type TreeSocket.
74 * TreeSockets, being inherited from BufferedSocket, can be tied into
75 * the core socket engine, and we cn therefore receive activity events
76 * for them, just like activex objects on speed. (yes really, that
77 * is a technical term!) Each of these which relates to a locally
78 * connected server is assocated with it, by hooking it onto a
79 * TreeSocket class using its constructor. In this way, we can
80 * maintain a list of servers, some of which are directly connected,
81 * some of which are not.
83 class TreeSocket : public BufferedSocket
85 SpanningTreeUtilities* Utils; /* Utility class */
86 std::string myhost; /* Canonical hostname */
87 ServerState LinkState; /* Link state */
88 std::string InboundServerName; /* Server name sent to us by other side */
89 std::string InboundDescription; /* Server description (GECOS) sent to us by the other side */
90 std::string InboundSID; /* Server ID sent to us by the other side */
93 int num_lost_users; /* Users lost in split */
94 int num_lost_servers; /* Servers lost in split */
95 time_t NextPing; /* Time when we are due to ping this server */
96 bool LastPingWasGood; /* Responded to last ping we sent? */
97 int proto_version; /* Remote protocol version */
99 reference<Autoconnect> myautoconnect; /* Autoconnect used to cause this connection, if any */
102 /** Because most of the I/O gubbins are encapsulated within
103 * BufferedSocket, we just call the superclass constructor for
104 * most of the action, and append a few of our own values
107 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);
109 /** When a listening socket gives us a new file descriptor,
110 * we must associate it with a socket without creating a new
111 * connection. This constructor is used for this purpose.
113 TreeSocket(SpanningTreeUtilities* Util, int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
117 ServerState GetLinkState();
119 /** Get challenge set in our CAPAB for challenge/response
121 const std::string& GetOurChallenge();
123 /** Get challenge set in our CAPAB for challenge/response
125 void SetOurChallenge(const std::string &c);
127 /** Get challenge set in their CAPAB for challenge/response
129 const std::string& GetTheirChallenge();
131 /** Get challenge set in their CAPAB for challenge/response
133 void SetTheirChallenge(const std::string &c);
135 /** Compare two passwords based on authentication scheme
137 bool ComparePass(const Link& link, const std::string &theirs);
139 /** Clean up information used only during server negotiation
141 void CleanNegotiationInfo();
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 void 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 /** Recursively send the server tree with distances as hops.
175 * This is used during network burst to inform the other server
176 * (and any of ITS servers too) of what servers we know about.
177 * If at any point any of these servers already exist on the other
178 * end, our connection may be terminated. The hopcounts given
179 * by this function are relative, this doesn't matter so long as
180 * they are all >1, as all the remote servers re-calculate them
181 * to be relative too, with themselves as hop 0.
183 void SendServers(TreeServer* Current, TreeServer* s, int hops);
185 /** Returns module list as a string, filtered by filter
186 * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
188 std::string MyModules(int filter);
190 /** Send my capabilities to the remote side
192 void SendCapabilities(int phase);
194 /** Add modules to VF_COMMON list for backwards compatability */
195 void CompatAddModules(std::vector<std::string>& modlist);
197 /* Isolate and return the elements that are different between two lists */
198 void ListDifference(const std::string &one, const std::string &two, char sep,
199 std::string& mleft, std::string& mright);
201 bool Capab(const parameterlist ¶ms);
203 /** This function forces this server to quit, removing this server
204 * and any users on it (and servers and users below that, etc etc).
205 * It's very slow and pretty clunky, but luckily unless your network
206 * is having a REAL bad hair day, this function shouldnt be called
207 * too many times a month ;-)
209 void SquitServer(std::string &from, TreeServer* Current);
211 /** This is a wrapper function for SquitServer above, which
212 * does some validation first and passes on the SQUIT to all
213 * other remaining servers.
215 void Squit(TreeServer* Current, const std::string &reason);
217 /** FMODE command - server mode with timestamp checks */
218 void ForceMode(User* who, parameterlist ¶ms);
220 /** FTOPIC command */
221 bool ForceTopic(const std::string &source, parameterlist ¶ms);
223 /** FJOIN, similar to TS6 SJOIN, but not quite. */
224 void ForceJoin(User* who, parameterlist ¶ms);
226 /* Used on nick collision ... XXX ugly function HACK */
227 int DoCollision(User *u, time_t remotets, const std::string &remoteident, const std::string &remoteip, const std::string &remoteuid);
230 bool ParseUID(const std::string &source, parameterlist ¶ms);
232 /** Send one or more FJOINs for a channel of users.
233 * If the length of a single line is more than 480-NICKMAX
234 * in length, it is split over multiple lines.
236 void SendFJoins(TreeServer* Current, Channel* c);
238 /** Send G, Q, Z and E lines */
239 void SendXLines(TreeServer* Current);
241 /** Send channel modes and topics */
242 void SendChannelModes(TreeServer* Current);
244 /** send all users and their oper state/modes */
245 void SendUsers(TreeServer* Current);
247 /** This function is called when we want to send a netburst to a local
248 * server. There is a set order we must do this, because for example
249 * users require their servers to exist, and channels require their
250 * users to exist. You get the idea.
252 void DoBurst(TreeServer* s);
254 /** This function is called when we receive data from a remote
259 /** Send one or more complete lines down the socket
261 void WriteLine(std::string line);
263 /** Handle ERROR command */
264 void Error(parameterlist ¶ms);
267 bool Motd(const std::string &prefix, parameterlist ¶ms);
270 bool Admin(const std::string &prefix, parameterlist ¶ms);
272 bool Stats(const std::string &prefix, parameterlist ¶ms);
274 /** Because the core won't let users or even SERVERS set +o,
275 * we use the OPERTYPE command to do this.
277 bool OperType(const std::string &prefix, parameterlist ¶ms);
280 bool Away(const std::string &prefix, parameterlist ¶ms);
282 /** SAVE to resolve nick collisions without killing */
283 bool ForceNick(const std::string &prefix, parameterlist ¶ms);
287 void Encap(User* who, parameterlist ¶ms);
291 bool OperQuit(const std::string &prefix, parameterlist ¶ms);
295 bool RemoteKill(const std::string &prefix, parameterlist ¶ms);
299 bool LocalPong(const std::string &prefix, parameterlist ¶ms);
303 bool MetaData(const std::string &prefix, parameterlist ¶ms);
307 bool ServerVersion(const std::string &prefix, parameterlist ¶ms);
311 bool ChangeHost(const std::string &prefix, parameterlist ¶ms);
315 bool AddLine(const std::string &prefix, parameterlist ¶ms);
319 bool DelLine(const std::string &prefix, parameterlist ¶ms);
323 bool ChangeName(const std::string &prefix, parameterlist ¶ms);
326 bool ChangeIdent(const std::string &prefix, parameterlist ¶ms);
330 bool Whois(const std::string &prefix, parameterlist ¶ms);
334 bool Push(const std::string &prefix, parameterlist ¶ms);
338 bool Time(const std::string &prefix, parameterlist ¶ms);
342 bool LocalPing(const std::string &prefix, parameterlist ¶ms);
344 /** Remove all modes from a channel, including statusmodes (+qaovh etc), simplemodes, parameter modes.
345 * This does not update the timestamp of the target channel, this must be done seperately.
347 void RemoveStatus(User* source, parameterlist ¶ms);
349 /** <- (remote) <- SERVER
351 bool RemoteServer(const std::string &prefix, parameterlist ¶ms);
353 /** (local) -> SERVER
355 bool Outbound_Reply_Server(parameterlist ¶ms);
357 /** (local) <- SERVER
359 bool Inbound_Server(parameterlist ¶ms);
361 /** Handle IRC line split
363 void Split(const std::string &line, std::string& prefix, std::string& command, parameterlist ¶ms);
365 /** Process complete line from buffer
367 void ProcessLine(std::string &line);
369 void ProcessConnectedLine(std::string& prefix, std::string& command, parameterlist& params);
371 /** Get this server's name
373 virtual std::string GetName();
375 /** Handle socket timeout from connect()
377 virtual void OnTimeout();
378 /** Handle server quit on close
380 virtual void Close();
383 /* Used to validate the value lengths of multiple parameters for a command */
384 struct cmd_validation
391 /* Used to validate the length values in CAPAB CAPABILITIES */
392 struct cap_validation