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/>.
30 * The server list in InspIRCd is maintained as two structures
31 * which hold the data in different ways. Most of the time, we
32 * want to very quicky obtain three pieces of information:
34 * (1) The information on a server
35 * (2) The information on the server we must send data through
36 * to actually REACH the server we're after
37 * (3) Potentially, the child/parent objects of this server
39 * The InspIRCd spanning protocol provides easy access to these
40 * by storing the data firstly in a recursive structure, where
41 * each item references its parent item, and a dynamic list
42 * of child items, and another structure which stores the items
43 * hashed, linearly. This means that if we want to find a server
44 * by name quickly, we can look it up in the hash, avoiding
45 * any O(n) lookups. If however, during a split or sync, we want
46 * to apply an operation to a server, and any of its child objects
47 * we can resort to recursion to walk the tree structure.
48 * Any socket can have one of five states at any one time.
50 * CONNECTING: indicates an outbound socket which is
51 * waiting to be writeable.
52 * WAIT_AUTH_1: indicates the socket is outbound and
53 * has successfully connected, but has not
54 * yet sent and received SERVER strings.
55 * WAIT_AUTH_2: indicates that the socket is inbound
56 * but has not yet sent and received
58 * CONNECTED: represents a fully authorized, fully
60 * DYING: represents a server that has had an error.
62 enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED, DYING };
66 reference<Link> link; /* Link block used for this connection */
67 reference<Autoconnect> ac; /* Autoconnect used to cause this connection, if any */
68 std::string ModuleList; /* Required module list of other server from CAPAB */
69 std::string OptModuleList; /* Optional module list of other server from CAPAB */
70 std::string ChanModes;
71 std::string UserModes;
72 std::map<std::string,std::string> CapKeys; /* CAPAB keys from other server */
73 std::string ourchallenge; /* Challenge sent for challenge/response */
74 std::string theirchallenge; /* Challenge recv for challenge/response */
75 int capab_phase; /* Have sent CAPAB already */
76 bool auth_fingerprint; /* Did we auth using SSL certificate fingerprint */
77 bool auth_challenge; /* Did we auth using challenge/response */
79 // Data saved from incoming SERVER command, for later use when our credentials have been accepted by the other party
80 std::string description;
86 /** Every SERVER connection inbound or outbound is represented by an object of
87 * type TreeSocket. During setup, the object can be found in Utils->timeoutlist;
88 * after setup, MyRoot will have been created as a child of Utils->TreeRoot
90 class TreeSocket : public BufferedSocket
94 std::string linkID; /* Description for this link */
95 ServerState LinkState; /* Link state */
96 CapabData* capab; /* Link setup data (held until burst is sent) */
97 TreeServer* MyRoot; /* The server we are talking to */
98 time_t NextPing; /* Time when we are due to ping this server */
99 bool LastPingWasGood; /* Responded to last ping we sent? */
100 int proto_version; /* Remote protocol version */
102 /** True if we've sent our burst.
103 * This only changes the behavior of message translation for 1202 protocol servers and it can be
104 * removed once 1202 support is dropped.
108 /** Checks if the given servername and sid are both free
110 bool CheckDuplicate(const std::string& servername, const std::string& sid);
112 /** Send all ListModeBase modes set on the channel
114 void SendListModes(Channel* chan);
116 /** Send all known information about a channel */
117 void SyncChannel(Channel* chan, BurstState& bs);
119 /** Send all users and their oper state, away state and metadata */
120 void SendUsers(BurstState& bs);
122 /** Send all additional info about the given server to this server */
123 void SendServerInfo(TreeServer* from);
125 /** Find the User source of a command given a prefix and a command string.
126 * This connection must be fully up when calling this function.
127 * @param prefix Prefix string to find the source User object for. Can be a sid, a uuid or a server name.
128 * @param command The command whose source to find. This is required because certain commands (like mode
129 * changes and kills) must be processed even if their claimed source doesn't exist. If the given command is
130 * such a command and the source does not exist, the function returns a valid FakeUser that can be used to
131 * to process the command with.
132 * @return The command source to use when processing the command or NULL if the source wasn't found.
133 * Note that the direction of the returned source is not verified.
135 User* FindSource(const std::string& prefix, const std::string& command);
137 /** Finish the authentication phase of this connection.
138 * Change the state of the connection to CONNECTED, create a TreeServer object for the server on the
139 * other end of the connection using the details provided in the parameters, and finally send a burst.
140 * @param remotename Name of the remote server
141 * @param remotesid SID of the remote server
142 * @param remotedesc Description of the remote server
143 * @param hidden True if the remote server is hidden according to the configuration
145 void FinishAuth(const std::string& remotename, const std::string& remotesid, const std::string& remotedesc, bool hidden);
147 /** Authenticate the remote server.
148 * Validate the parameters and find the link block that matches the remote server. In case of an error,
149 * an appropriate snotice is generated, an ERROR message is sent and the connection is closed.
150 * Failing to find a matching link block counts as an error.
151 * @param params Parameters they sent in the SERVER command
152 * @return Link block for the remote server, or NULL if an error occurred
154 Link* AuthRemote(const parameterlist& params);
156 /** Write a line on this socket with a new line character appended, skipping all translation for old protocols
157 * @param line Line to write without a new line character at the end
159 void WriteLineNoCompat(const std::string& line);
164 /** Because most of the I/O gubbins are encapsulated within
165 * BufferedSocket, we just call the superclass constructor for
166 * most of the action, and append a few of our own values
169 TreeSocket(Link* link, Autoconnect* myac, const std::string& ipaddr);
171 /** When a listening socket gives us a new file descriptor,
172 * we must associate it with a socket without creating a new
173 * connection. This constructor is used for this purpose.
175 TreeSocket(int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
179 ServerState GetLinkState();
181 /** Get challenge set in our CAPAB for challenge/response
183 const std::string& GetOurChallenge();
185 /** Get challenge set in our CAPAB for challenge/response
187 void SetOurChallenge(const std::string &c);
189 /** Get challenge set in their CAPAB for challenge/response
191 const std::string& GetTheirChallenge();
193 /** Get challenge set in their CAPAB for challenge/response
195 void SetTheirChallenge(const std::string &c);
197 /** Compare two passwords based on authentication scheme
199 bool ComparePass(const Link& link, const std::string &theirs);
201 /** Clean up information used only during server negotiation
203 void CleanNegotiationInfo();
210 /** Construct a password, optionally hashed with the other side's
213 std::string MakePass(const std::string &password, const std::string &challenge);
215 /** When an outbound connection finishes connecting, we receive
216 * this event, and must send our SERVER string to the other
217 * side. If the other side is happy, as outlined in the server
218 * to server docs on the inspircd.org site, the other side
219 * will then send back its own server string.
223 /** Handle socket error event
225 void OnError(BufferedSocketError e) CXX11_OVERRIDE;
227 /** Sends an error to the remote server, and displays it locally to show
230 void SendError(const std::string &errormessage);
232 /** Recursively send the server tree with distances as hops.
233 * This is used during network burst to inform the other server
234 * (and any of ITS servers too) of what servers we know about.
236 void SendServers(TreeServer* Current, TreeServer* s);
238 /** Returns module list as a string, filtered by filter
239 * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
241 std::string MyModules(int filter);
243 /** Send my capabilities to the remote side
245 void SendCapabilities(int phase);
247 /* Isolate and return the elements that are different between two lists */
248 void ListDifference(const std::string &one, const std::string &two, char sep,
249 std::string& mleft, std::string& mright);
251 bool Capab(const parameterlist ¶ms);
253 /** This function forces this server to quit, removing this server
254 * and any users on it (and servers and users below that, etc etc).
255 * It's very slow and pretty clunky, but luckily unless your network
256 * is having a REAL bad hair day, this function shouldnt be called
257 * too many times a month ;-)
259 void SquitServer(std::string &from, TreeServer* Current, int& num_lost_servers, int& num_lost_users);
261 /** This is a wrapper function for SquitServer above, which
262 * does some validation first and passes on the SQUIT to all
263 * other remaining servers.
265 void Squit(TreeServer* Current, const std::string &reason);
267 /** Send one or more FJOINs for a channel of users.
268 * If the length of a single line is more than 480-NICKMAX
269 * in length, it is split over multiple lines.
271 void SendFJoins(Channel* c);
273 /** Send G, Q, Z and E lines */
276 /** Send all known information about a channel */
277 void SyncChannel(Channel* chan);
279 /** This function is called when we want to send a netburst to a local
280 * server. There is a set order we must do this, because for example
281 * users require their servers to exist, and channels require their
282 * users to exist. You get the idea.
284 void DoBurst(TreeServer* s);
286 /** This function is called when we receive data from a remote
291 /** Send one or more complete lines down the socket
293 void WriteLine(const std::string& line);
295 /** Handle ERROR command */
296 void Error(parameterlist ¶ms);
298 /** (local) -> SERVER
300 bool Outbound_Reply_Server(parameterlist ¶ms);
302 /** (local) <- SERVER
304 bool Inbound_Server(parameterlist ¶ms);
306 /** Handle IRC line split
308 void Split(const std::string &line, std::string& prefix, std::string& command, parameterlist ¶ms);
310 /** Process complete line from buffer
312 void ProcessLine(std::string &line);
314 void ProcessConnectedLine(std::string& prefix, std::string& command, parameterlist& params);
316 /** Handle socket timeout from connect()
319 /** Handle server quit on close
323 /** Returns true if this server was introduced to the rest of the network
327 /** Fixes messages coming from old servers so the new command handlers understand them
329 bool PreProcessOldProtocolMessage(User*& who, std::string& cmd, std::vector<std::string>& params);