src/modules/m_spanningtree/treesocket.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   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>
   8  *
   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.
  12  *
  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
  16  * details.
  17  *
  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/>.
  20  */
  21
  22
  23 #pragma once
  24
  25 #include "inspircd.h"
  26
  27 #include "utils.h"
  28
  29 /*
  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:
  33  *
  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
  38  *
  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.
  49  *
  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
  57  *                                                      SERVER strings.
  58  * CONNECTED:   represents a fully authorized, fully
  59  *                                                      connected server.
  60  * DYING:       represents a server that has had an error.
  61  */
  62 enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED, DYING };
  63
  64 struct CapabData
  65 {
  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 */
  78
  79         // Data saved from incoming SERVER command, for later use when our credentials have been accepted by the other party
  80         std::string description;
  81         std::string sid;
  82         std::string name;
  83         bool hidden;
  84 };
  85
  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
  89  */
  90 class TreeSocket : public BufferedSocket
  91 {
  92         struct BurstState;
  93
  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         unsigned int proto_version;                     /* Remote protocol version */
  99
 100         /** True if we've sent our burst.
 101          * This only changes the behavior of message translation for 1202 protocol servers and it can be
 102          * removed once 1202 support is dropped.
 103          */
 104         bool burstsent;
 105
 106         /** Checks if the given servername and sid are both free
 107          */
 108         bool CheckDuplicate(const std::string& servername, const std::string& sid);
 109
 110         /** Send all ListModeBase modes set on the channel
 111          */
 112         void SendListModes(Channel* chan);
 113
 114         /** Send all known information about a channel */
 115         void SyncChannel(Channel* chan, BurstState& bs);
 116
 117         /** Send all users and their oper state, away state and metadata */
 118         void SendUsers(BurstState& bs);
 119
 120         /** Send all additional info about the given server to this server */
 121         void SendServerInfo(TreeServer* from);
 122
 123         /** Find the User source of a command given a prefix and a command string.
 124          * This connection must be fully up when calling this function.
 125          * @param prefix Prefix string to find the source User object for. Can be a sid, a uuid or a server name.
 126          * @param command The command whose source to find. This is required because certain commands (like mode
 127          * changes and kills) must be processed even if their claimed source doesn't exist. If the given command is
 128          * such a command and the source does not exist, the function returns a valid FakeUser that can be used to
 129          * to process the command with.
 130          * @return The command source to use when processing the command or NULL if the source wasn't found.
 131          * Note that the direction of the returned source is not verified.
 132          */
 133         User* FindSource(const std::string& prefix, const std::string& command);
 134
 135         /** Finish the authentication phase of this connection.
 136          * Change the state of the connection to CONNECTED, create a TreeServer object for the server on the
 137          * other end of the connection using the details provided in the parameters, and finally send a burst.
 138          * @param remotename Name of the remote server
 139          * @param remotesid SID of the remote server
 140          * @param remotedesc Description of the remote server
 141          * @param hidden True if the remote server is hidden according to the configuration
 142          */
 143         void FinishAuth(const std::string& remotename, const std::string& remotesid, const std::string& remotedesc, bool hidden);
 144
 145         /** Authenticate the remote server.
 146          * Validate the parameters and find the link block that matches the remote server. In case of an error,
 147          * an appropriate snotice is generated, an ERROR message is sent and the connection is closed.
 148          * Failing to find a matching link block counts as an error.
 149          * @param params Parameters they sent in the SERVER command
 150          * @return Link block for the remote server, or NULL if an error occurred
 151          */
 152         Link* AuthRemote(const CommandBase::Params& params);
 153
 154         /** Write a line on this socket with a new line character appended, skipping all translation for old protocols
 155          * @param line Line to write without a new line character at the end
 156          */
 157         void WriteLineNoCompat(const std::string& line);
 158
 159  public:
 160         const time_t age;
 161
 162         /** Because most of the I/O gubbins are encapsulated within
 163          * BufferedSocket, we just call the superclass constructor for
 164          * most of the action, and append a few of our own values
 165          * to it.
 166          */
 167         TreeSocket(Link* link, Autoconnect* myac, const std::string& ipaddr);
 168
 169         /** When a listening socket gives us a new file descriptor,
 170          * we must associate it with a socket without creating a new
 171          * connection. This constructor is used for this purpose.
 172          */
 173         TreeSocket(int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 174
 175         /** Get link state
 176          */
 177         ServerState GetLinkState() const { return LinkState; }
 178
 179         /** Get challenge set in our CAPAB for challenge/response
 180          */
 181         const std::string& GetOurChallenge();
 182
 183         /** Get challenge set in our CAPAB for challenge/response
 184          */
 185         void SetOurChallenge(const std::string &c);
 186
 187         /** Get challenge set in their CAPAB for challenge/response
 188          */
 189         const std::string& GetTheirChallenge();
 190
 191         /** Get challenge set in their CAPAB for challenge/response
 192          */
 193         void SetTheirChallenge(const std::string &c);
 194
 195         /** Compare two passwords based on authentication scheme
 196          */
 197         bool ComparePass(const Link& link, const std::string &theirs);
 198
 199         /** Clean up information used only during server negotiation
 200          */
 201         void CleanNegotiationInfo();
 202
 203         CullResult cull() CXX11_OVERRIDE;
 204         /** Destructor
 205          */
 206         ~TreeSocket();
 207
 208         /** Construct a password, optionally hashed with the other side's
 209          * challenge string
 210          */
 211         std::string MakePass(const std::string &password, const std::string &challenge);
 212
 213         /** When an outbound connection finishes connecting, we receive
 214          * this event, and must send our SERVER string to the other
 215          * side. If the other side is happy, as outlined in the server
 216          * to server docs on the inspircd.org site, the other side
 217          * will then send back its own server string.
 218          */
 219         void OnConnected() CXX11_OVERRIDE;
 220
 221         /** Handle socket error event
 222          */
 223         void OnError(BufferedSocketError e) CXX11_OVERRIDE;
 224
 225         /** Sends an error to the remote server, and displays it locally to show
 226          * that it was sent.
 227          */
 228         void SendError(const std::string &errormessage);
 229
 230         /** Recursively send the server tree with distances as hops.
 231          * This is used during network burst to inform the other server
 232          * (and any of ITS servers too) of what servers we know about.
 233          */
 234         void SendServers(TreeServer* Current, TreeServer* s);
 235
 236         /** Returns module list as a string, filtered by filter
 237          * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
 238          */
 239         std::string MyModules(int filter);
 240
 241         /** Returns mode list as a string, filtered by type.
 242          * @param type The type of modes to return.
 243          */
 244         std::string BuildModeList(ModeType type);
 245
 246         /** Send my capabilities to the remote side
 247          */
 248         void SendCapabilities(int phase);
 249
 250         /* Isolate and return the elements that are different between two lists */
 251         void ListDifference(const std::string &one, const std::string &two, char sep,
 252                 std::string& mleft, std::string& mright);
 253
 254         bool Capab(const CommandBase::Params& params);
 255
 256         /** Send one or more FJOINs for a channel of users.
 257          * If the length of a single line is more than 480-NICKMAX
 258          * in length, it is split over multiple lines.
 259          */
 260         void SendFJoins(Channel* c);
 261
 262         /** Send G-, Q-, Z- and E-lines */
 263         void SendXLines();
 264
 265         /** Send all known information about a channel */
 266         void SyncChannel(Channel* chan);
 267
 268         /** This function is called when we want to send a netburst to a local
 269          * server. There is a set order we must do this, because for example
 270          * users require their servers to exist, and channels require their
 271          * users to exist. You get the idea.
 272          */
 273         void DoBurst(TreeServer* s);
 274
 275         /** This function is called when we receive data from a remote
 276          * server.
 277          */
 278         void OnDataReady() CXX11_OVERRIDE;
 279
 280         /** Send one or more complete lines down the socket
 281          */
 282         void WriteLine(const std::string& line);
 283
 284         /** Handle ERROR command */
 285         void Error(CommandBase::Params& params);
 286
 287         /** (local) -> SERVER
 288          */
 289         bool Outbound_Reply_Server(CommandBase::Params& params);
 290
 291         /** (local) <- SERVER
 292          */
 293         bool Inbound_Server(CommandBase::Params& params);
 294
 295         /** Handle IRC line split
 296          */
 297         void Split(const std::string& line, std::string& tags, std::string& prefix, std::string& command, CommandBase::Params& params);
 298
 299         /** Process complete line from buffer
 300          */
 301         void ProcessLine(std::string &line);
 302
 303         /** Process message tags received from a remote server. */
 304         void ProcessTag(User* source, const std::string& tag, ClientProtocol::TagMap& tags);
 305
 306         /** Process a message for a fully connected server. */
 307         void ProcessConnectedLine(std::string& tags, std::string& prefix, std::string& command, CommandBase::Params& params);
 308
 309         /** Handle socket timeout from connect()
 310          */
 311         void OnTimeout() CXX11_OVERRIDE;
 312         /** Handle server quit on close
 313          */
 314         void Close() CXX11_OVERRIDE;
 315
 316         /** Fixes messages coming from old servers so the new command handlers understand them
 317          */
 318         bool PreProcessOldProtocolMessage(User*& who, std::string& cmd, CommandBase::Params& params);
 319 };