2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
7 * Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
9 * This file is part of InspIRCd. InspIRCd is free software: you can
10 * redistribute it and/or modify it under the terms of the GNU General Public
11 * License as published by the Free Software Foundation, version 2.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #ifndef M_SPANNINGTREE_TREESOCKET_H
24 #define M_SPANNINGTREE_TREESOCKET_H
33 * The server list in InspIRCd is maintained as two structures
34 * which hold the data in different ways. Most of the time, we
35 * want to very quicky obtain three pieces of information:
37 * (1) The information on a server
38 * (2) The information on the server we must send data through
39 * to actually REACH the server we're after
40 * (3) Potentially, the child/parent objects of this server
42 * The InspIRCd spanning protocol provides easy access to these
43 * by storing the data firstly in a recursive structure, where
44 * each item references its parent item, and a dynamic list
45 * of child items, and another structure which stores the items
46 * hashed, linearly. This means that if we want to find a server
47 * by name quickly, we can look it up in the hash, avoiding
48 * any O(n) lookups. If however, during a split or sync, we want
49 * to apply an operation to a server, and any of its child objects
50 * we can resort to recursion to walk the tree structure.
51 * Any socket can have one of five states at any one time.
53 * CONNECTING: indicates an outbound socket which is
54 * waiting to be writeable.
55 * WAIT_AUTH_1: indicates the socket is outbound and
56 * has successfully connected, but has not
57 * yet sent and received SERVER strings.
58 * WAIT_AUTH_2: indicates that the socket is inbound
59 * but has not yet sent and received
61 * CONNECTED: represents a fully authorized, fully
63 * DYING: represents a server that has had an error.
65 enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED, DYING };
69 reference<Link> link; /* Link block used for this connection */
70 reference<Autoconnect> ac; /* Autoconnect used to cause this connection, if any */
71 std::string ModuleList; /* Required module list of other server from CAPAB */
72 std::string OptModuleList; /* Optional module list of other server from CAPAB */
73 std::string ChanModes;
74 std::string UserModes;
75 std::map<std::string,std::string> CapKeys; /* CAPAB keys from other server */
76 std::string ourchallenge; /* Challenge sent for challenge/response */
77 std::string theirchallenge; /* Challenge recv for challenge/response */
78 int capab_phase; /* Have sent CAPAB already */
79 bool auth_fingerprint; /* Did we auth using SSL fingerprint */
80 bool auth_challenge; /* Did we auth using challenge/response */
82 // Data saved from incoming SERVER command, for later use when our credentials have been accepted by the other party
83 std::string description;
89 /** Every SERVER connection inbound or outbound is represented by an object of
90 * type TreeSocket. During setup, the object can be found in Utils->timeoutlist;
91 * after setup, MyRoot will have been created as a child of Utils->TreeRoot
93 class TreeSocket : public BufferedSocket
95 SpanningTreeUtilities* Utils; /* Utility class */
96 std::string linkID; /* Description for this link */
97 ServerState LinkState; /* Link state */
98 CapabData* capab; /* Link setup data (held until burst is sent) */
99 TreeServer* MyRoot; /* The server we are talking to */
100 time_t NextPing; /* Time when we are due to ping this server */
101 bool LastPingWasGood; /* Responded to last ping we sent? */
102 int proto_version; /* Remote protocol version */
103 bool ConnectionFailureShown; /* Set to true if a connection failure message was shown */
105 /** Checks if the given servername and sid are both free
107 bool CheckDuplicate(const std::string& servername, const std::string& sid);
112 /** Because most of the I/O gubbins are encapsulated within
113 * BufferedSocket, we just call the superclass constructor for
114 * most of the action, and append a few of our own values
117 TreeSocket(SpanningTreeUtilities* Util, Link* link, Autoconnect* myac, const std::string& ipaddr);
119 /** When a listening socket gives us a new file descriptor,
120 * we must associate it with a socket without creating a new
121 * connection. This constructor is used for this purpose.
123 TreeSocket(SpanningTreeUtilities* Util, int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
127 ServerState GetLinkState();
129 /** Get challenge set in our CAPAB for challenge/response
131 const std::string& GetOurChallenge();
133 /** Get challenge set in our CAPAB for challenge/response
135 void SetOurChallenge(const std::string &c);
137 /** Get challenge set in their CAPAB for challenge/response
139 const std::string& GetTheirChallenge();
141 /** Get challenge set in their CAPAB for challenge/response
143 void SetTheirChallenge(const std::string &c);
145 /** Compare two passwords based on authentication scheme
147 bool ComparePass(const Link& link, const std::string &theirs);
149 /** Clean up information used only during server negotiation
151 void CleanNegotiationInfo();
158 /** Construct a password, optionally hashed with the other side's
161 std::string MakePass(const std::string &password, const std::string &challenge);
163 /** When an outbound connection finishes connecting, we receive
164 * this event, and must send our SERVER string to the other
165 * side. If the other side is happy, as outlined in the server
166 * to server docs on the inspircd.org site, the other side
167 * will then send back its own server string.
169 virtual void OnConnected();
171 /** Handle socket error event
173 virtual void OnError(BufferedSocketError e);
175 /** Sends an error to the remote server, and displays it locally to show
178 void SendError(const std::string &errormessage);
180 /** Recursively send the server tree with distances as hops.
181 * This is used during network burst to inform the other server
182 * (and any of ITS servers too) of what servers we know about.
183 * If at any point any of these servers already exist on the other
184 * end, our connection may be terminated. The hopcounts given
185 * by this function are relative, this doesn't matter so long as
186 * they are all >1, as all the remote servers re-calculate them
187 * to be relative too, with themselves as hop 0.
189 void SendServers(TreeServer* Current, TreeServer* s, int hops);
191 /** Returns module list as a string, filtered by filter
192 * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
194 std::string MyModules(int filter);
196 /** Send my capabilities to the remote side
198 void SendCapabilities(int phase);
200 /** Add modules to VF_COMMON list for backwards compatability */
201 void CompatAddModules(std::vector<std::string>& modlist);
203 /* Isolate and return the elements that are different between two lists */
204 void ListDifference(const std::string &one, const std::string &two, char sep,
205 std::string& mleft, std::string& mright);
207 bool Capab(const parameterlist ¶ms);
209 /** This function forces this server to quit, removing this server
210 * and any users on it (and servers and users below that, etc etc).
211 * It's very slow and pretty clunky, but luckily unless your network
212 * is having a REAL bad hair day, this function shouldnt be called
213 * too many times a month ;-)
215 void SquitServer(std::string &from, TreeServer* Current, int& num_lost_servers, int& num_lost_users);
217 /** This is a wrapper function for SquitServer above, which
218 * does some validation first and passes on the SQUIT to all
219 * other remaining servers.
221 void Squit(TreeServer* Current, const std::string &reason);
223 /* Used on nick collision ... XXX ugly function HACK */
224 int DoCollision(User *u, time_t remotets, const std::string &remoteident, const std::string &remoteip, const std::string &remoteuid);
226 /** Send one or more FJOINs for a channel of users.
227 * If the length of a single line is more than 480-NICKMAX
228 * in length, it is split over multiple lines.
230 void SendFJoins(Channel* c);
232 /** Send G, Q, Z and E lines */
235 /** Send channel modes and topics */
236 void SendChannelModes();
238 /** send all users and their oper state/modes */
241 /** This function is called when we want to send a netburst to a local
242 * server. There is a set order we must do this, because for example
243 * users require their servers to exist, and channels require their
244 * users to exist. You get the idea.
246 void DoBurst(TreeServer* s);
248 /** This function is called when we receive data from a remote
253 /** Send one or more complete lines down the socket
255 void WriteLine(std::string line);
257 /** Handle ERROR command */
258 void Error(parameterlist ¶ms);
261 bool Away(const std::string &prefix, parameterlist ¶ms);
263 /** SAVE to resolve nick collisions without killing */
264 bool ForceNick(const std::string &prefix, parameterlist ¶ms);
268 void Encap(User* who, parameterlist ¶ms);
272 bool OperQuit(const std::string &prefix, parameterlist ¶ms);
276 bool LocalPong(const std::string &prefix, parameterlist ¶ms);
280 bool ServerVersion(const std::string &prefix, parameterlist ¶ms);
284 bool AddLine(const std::string &prefix, parameterlist ¶ms);
288 bool DelLine(const std::string &prefix, parameterlist ¶ms);
292 bool Whois(const std::string &prefix, parameterlist ¶ms);
296 bool Push(const std::string &prefix, parameterlist ¶ms);
300 bool LocalPing(const std::string &prefix, parameterlist ¶ms);
302 /** <- (remote) <- SERVER
304 bool RemoteServer(const std::string &prefix, parameterlist ¶ms);
306 /** (local) -> SERVER
308 bool Outbound_Reply_Server(parameterlist ¶ms);
310 /** (local) <- SERVER
312 bool Inbound_Server(parameterlist ¶ms);
314 /** Handle IRC line split
316 void Split(const std::string &line, std::string& prefix, std::string& command, parameterlist ¶ms);
318 /** Process complete line from buffer
320 void ProcessLine(std::string &line);
322 void ProcessConnectedLine(std::string& prefix, std::string& command, parameterlist& params);
324 /** Handle socket timeout from connect()
326 virtual void OnTimeout();
327 /** Handle server quit on close
329 virtual void Close();
331 /** Returns true if this server was introduced to the rest of the network