src/modules/m_spanningtree/treesocket.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __TREESOCKET_H__
  15 #define __TREESOCKET_H__
  16
  17 #include "configreader.h"
  18 #include "users.h"
  19 #include "channels.h"
  20 #include "modules.h"
  21 #include "commands/cmd_whois.h"
  22 #include "commands/cmd_stats.h"
  23 #include "socket.h"
  24 #include "inspircd.h"
  25 #include "wildcard.h"
  26 #include "xline.h"
  27 #include "transport.h"
  28
  29 #include "m_spanningtree/utils.h"
  30
  31 /*
  32  * The server list in InspIRCd is maintained as two structures
  33  * which hold the data in different ways. Most of the time, we
  34  * want to very quicky obtain three pieces of information:
  35  *
  36  * (1) The information on a server
  37  * (2) The information on the server we must send data through
  38  *     to actually REACH the server we're after
  39  * (3) Potentially, the child/parent objects of this server
  40  *
  41  * The InspIRCd spanning protocol provides easy access to these
  42  * by storing the data firstly in a recursive structure, where
  43  * each item references its parent item, and a dynamic list
  44  * of child items, and another structure which stores the items
  45  * hashed, linearly. This means that if we want to find a server
  46  * by name quickly, we can look it up in the hash, avoiding
  47  * any O(n) lookups. If however, during a split or sync, we want
  48  * to apply an operation to a server, and any of its child objects
  49  * we can resort to recursion to walk the tree structure.
  50  * Any socket can have one of five states at any one time.
  51  * The LISTENER state indicates a socket which is listening
  52  * for connections. It cannot receive data itself, only incoming
  53  * sockets.
  54  * The CONNECTING state indicates an outbound socket which is
  55  * waiting to be writeable.
  56  * The WAIT_AUTH_1 state indicates the socket is outbound and
  57  * has successfully connected, but has not yet sent and received
  58  * SERVER strings.
  59  * The WAIT_AUTH_2 state indicates that the socket is inbound
  60  * (allocated by a LISTENER) but has not yet sent and received
  61  * SERVER strings.
  62  * The CONNECTED state represents a fully authorized, fully
  63  * connected server.
  64  */
  65 enum ServerState { LISTENER, CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
  66
  67 /** Every SERVER connection inbound or outbound is represented by
  68  * an object of type TreeSocket.
  69  * TreeSockets, being inherited from InspSocket, can be tied into
  70  * the core socket engine, and we cn therefore receive activity events
  71  * for them, just like activex objects on speed. (yes really, that
  72  * is a technical term!) Each of these which relates to a locally
  73  * connected server is assocated with it, by hooking it onto a
  74  * TreeSocket class using its constructor. In this way, we can
  75  * maintain a list of servers, some of which are directly connected,
  76  * some of which are not.
  77  */
  78 class TreeSocket : public InspSocket
  79 {
  80         SpanningTreeUtilities* Utils;           /* Utility class */
  81         std::string myhost;                     /* Canonical hostname */
  82         std::string in_buffer;                  /* Input buffer */
  83         ServerState LinkState;                  /* Link state */
  84         std::string InboundServerName;          /* Server name sent to us by other side */
  85         std::string InboundDescription;         /* Server description (GECOS) sent to us by the other side */
  86         int num_lost_users;                     /* Users lost in split */
  87         int num_lost_servers;                   /* Servers lost in split */
  88         time_t NextPing;                        /* Time when we are due to ping this server */
  89         bool LastPingWasGood;                   /* Responded to last ping we sent? */
  90         bool bursting;                          /* True if not finished bursting yet */
  91         unsigned int keylength;                 /* Is this still used? */
  92         std::string ModuleList;                 /* Module list of other server from CAPAB */
  93         std::map<std::string,std::string> CapKeys;      /* CAPAB keys from other server */
  94         Module* Hook;                           /* I/O hooking module that we're attached to for this socket */
  95         std::string ourchallenge;               /* Challenge sent for challenge/response */
  96         std::string theirchallenge;             /* Challenge recv for challenge/response */
  97         std::string OutboundPass;               /* Outbound password */
  98         bool sentcapab;                         /* Have sent CAPAB already */
  99  public:
 100
 101         /** Because most of the I/O gubbins are encapsulated within
 102          * InspSocket, we just call the superclass constructor for
 103          * most of the action, and append a few of our own values
 104          * to it.
 105          */
 106         TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, Module* HookMod = NULL);
 107
 108         /** Because most of the I/O gubbins are encapsulated within
 109          * InspSocket, we just call the superclass constructor for
 110          * most of the action, and append a few of our own values
 111          * to it.
 112          */
 113         TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Module* HookMod = NULL);
 114
 115         /** When a listening socket gives us a new file descriptor,
 116          * we must associate it with a socket without creating a new
 117          * connection. This constructor is used for this purpose.
 118          */
 119         TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, int newfd, char* ip, Module* HookMod = NULL);
 120
 121         /** Get link state
 122          */
 123         ServerState GetLinkState();
 124
 125         /** Get challenge set in our CAPAB for challenge/response
 126          */
 127         const std::string& GetOurChallenge();
 128
 129         /** Get challenge set in our CAPAB for challenge/response
 130          */
 131         void SetOurChallenge(const std::string &c);
 132
 133         /** Get challenge set in their CAPAB for challenge/response
 134          */
 135         const std::string& GetTheirChallenge();
 136
 137         /** Get challenge set in their CAPAB for challenge/response
 138          */
 139         void SetTheirChallenge(const std::string &c);
 140
 141         /** Compare two passwords based on authentication scheme
 142          */
 143         bool ComparePass(const std::string &ours, const std::string &theirs);
 144
 145         /** Return the module which we are hooking to for I/O encapsulation
 146          */
 147         Module* GetHook();
 148
 149         /** Destructor
 150          */
 151         ~TreeSocket();
 152
 153         /** Generate random string used for challenge-response auth
 154          */
 155         std::string RandString(unsigned int length);
 156
 157         /** Construct a password, optionally hashed with the other side's
 158          * challenge string
 159          */
 160         std::string MakePass(const std::string &password, const std::string &challenge);
 161
 162         /** When an outbound connection finishes connecting, we receive
 163          * this event, and must send our SERVER string to the other
 164          * side. If the other side is happy, as outlined in the server
 165          * to server docs on the inspircd.org site, the other side
 166          * will then send back its own server string.
 167          */
 168         virtual bool OnConnected();
 169
 170         /** Handle socket error event
 171          */
 172         virtual void OnError(InspSocketError e);
 173
 174         /** Sends an error to the remote server, and displays it locally to show
 175          * that it was sent.
 176          */
 177         void SendError(const std::string &errormessage);
 178
 179         /** Handle socket disconnect event
 180          */
 181         virtual int OnDisconnect();
 182
 183         /** Recursively send the server tree with distances as hops.
 184          * This is used during network burst to inform the other server
 185          * (and any of ITS servers too) of what servers we know about.
 186          * If at any point any of these servers already exist on the other
 187          * end, our connection may be terminated. The hopcounts given
 188          * by this function are relative, this doesn't matter so long as
 189          * they are all >1, as all the remote servers re-calculate them
 190          * to be relative too, with themselves as hop 0.
 191          */
 192         void SendServers(TreeServer* Current, TreeServer* s, int hops);
 193
 194         /** Returns my capabilities as a string
 195          */
 196         std::string MyCapabilities();
 197
 198         /** Send my capabilities to the remote side
 199          */
 200         void SendCapabilities();
 201
 202         /* Check a comma seperated list for an item */
 203         bool HasItem(const std::string &list, const std::string &item);
 204
 205         /* Isolate and return the elements that are different between two comma seperated lists */
 206         std::string ListDifference(const std::string &one, const std::string &two);
 207
 208         bool Capab(const std::deque<std::string> &params);
 209
 210         /** This function forces this server to quit, removing this server
 211          * and any users on it (and servers and users below that, etc etc).
 212          * It's very slow and pretty clunky, but luckily unless your network
 213          * is having a REAL bad hair day, this function shouldnt be called
 214          * too many times a month ;-)
 215          */
 216         void SquitServer(std::string &from, TreeServer* Current);
 217
 218         /** This is a wrapper function for SquitServer above, which
 219          * does some validation first and passes on the SQUIT to all
 220          * other remaining servers.
 221          */
 222         void Squit(TreeServer* Current, const std::string &reason);
 223
 224         /** FMODE command - server mode with timestamp checks */
 225         bool ForceMode(const std::string &source, std::deque<std::string> &params);
 226
 227         /** FTOPIC command */
 228         bool ForceTopic(const std::string &source, std::deque<std::string> &params);
 229
 230         /** FJOIN, similar to TS6 SJOIN, but not quite. */
 231         bool ForceJoin(const std::string &source, std::deque<std::string> &params);
 232
 233         /** UID command */
 234         bool ParseUID(const std::string &source, std::deque<std::string> &params);
 235
 236         /** Send one or more FJOINs for a channel of users.
 237          * If the length of a single line is more than 480-NICKMAX
 238          * in length, it is split over multiple lines.
 239          */
 240         void SendFJoins(TreeServer* Current, chanrec* c);
 241
 242         /** Send G, Q, Z and E lines */
 243         void SendXLines(TreeServer* Current);
 244
 245         /** Send channel modes and topics */
 246         void SendChannelModes(TreeServer* Current);
 247
 248         /** send all users and their oper state/modes */
 249         void SendUsers(TreeServer* Current);
 250
 251         /** This function is called when we want to send a netburst to a local
 252          * server. There is a set order we must do this, because for example
 253          * users require their servers to exist, and channels require their
 254          * users to exist. You get the idea.
 255          */
 256         void DoBurst(TreeServer* s);
 257
 258         /** This function is called when we receive data from a remote
 259          * server. We buffer the data in a std::string (it doesnt stay
 260          * there for long), reading using InspSocket::Read() which can
 261          * read up to 16 kilobytes in one operation.
 262          *
 263          * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
 264          * THE SOCKET OBJECT FOR US.
 265          */
 266         virtual bool OnDataReady();
 267
 268         /** Send one or more complete lines down the socket
 269          */
 270         int WriteLine(std::string line);
 271
 272         /** Handle ERROR command */
 273         bool Error(std::deque<std::string> &params);
 274
 275         /** remote MOTD. leet, huh? */
 276         bool Motd(const std::string &prefix, std::deque<std::string> &params);
 277
 278         /** remote ADMIN. leet, huh? */
 279         bool Admin(const std::string &prefix, std::deque<std::string> &params);
 280
 281         /** Remote MODULES */
 282         bool Modules(const std::string &prefix, std::deque<std::string> &params);
 283
 284         bool Stats(const std::string &prefix, std::deque<std::string> &params);
 285
 286         /** Because the core won't let users or even SERVERS set +o,
 287          * we use the OPERTYPE command to do this.
 288          */
 289         bool OperType(const std::string &prefix, std::deque<std::string> &params);
 290
 291         /** Because Andy insists that services-compatible servers must
 292          * implement SVSNICK and SVSJOIN, that's exactly what we do :p
 293          */
 294         bool ForceNick(const std::string &prefix, std::deque<std::string> &params);
 295
 296         bool OperQuit(const std::string &prefix, std::deque<std::string> &params);
 297
 298         /** SVSJOIN
 299          */
 300         bool ServiceJoin(const std::string &prefix, std::deque<std::string> &params);
 301
 302         /** REHASH
 303          */
 304         bool RemoteRehash(const std::string &prefix, std::deque<std::string> &params);
 305
 306         /** KILL
 307          */
 308         bool RemoteKill(const std::string &prefix, std::deque<std::string> &params);
 309
 310         /** PONG
 311          */
 312         bool LocalPong(const std::string &prefix, std::deque<std::string> &params);
 313
 314         /** METADATA
 315          */
 316         bool MetaData(const std::string &prefix, std::deque<std::string> &params);
 317
 318         /** VERSION
 319          */
 320         bool ServerVersion(const std::string &prefix, std::deque<std::string> &params);
 321
 322         /** CHGHOST
 323          */
 324         bool ChangeHost(const std::string &prefix, std::deque<std::string> &params);
 325
 326         /** ADDLINE
 327          */
 328         bool AddLine(const std::string &prefix, std::deque<std::string> &params);
 329
 330         /** CHGNAME
 331          */
 332         bool ChangeName(const std::string &prefix, std::deque<std::string> &params);
 333
 334         /** WHOIS
 335          */
 336         bool Whois(const std::string &prefix, std::deque<std::string> &params);
 337
 338         /** PUSH
 339          */
 340         bool Push(const std::string &prefix, std::deque<std::string> &params);
 341
 342         /** SETTIME
 343          */
 344         bool HandleSetTime(const std::string &prefix, std::deque<std::string> &params);
 345
 346         /** TIME
 347          */
 348         bool Time(const std::string &prefix, std::deque<std::string> &params);
 349
 350         /** PING
 351          */
 352         bool LocalPing(const std::string &prefix, std::deque<std::string> &params);
 353
 354         /** Remove all modes from a channel, including statusmodes (+qaovh etc), simplemodes, parameter modes.
 355          * This does not update the timestamp of the target channel, this must be done seperately.
 356          */
 357         bool RemoveStatus(const std::string &prefix, std::deque<std::string> &params);
 358
 359         /** <- (remote) <- SERVER
 360          */
 361         bool RemoteServer(const std::string &prefix, std::deque<std::string> &params);
 362
 363         /** (local) -> SERVER
 364          */
 365         bool Outbound_Reply_Server(std::deque<std::string> &params);
 366
 367         /** (local) <- SERVER
 368          */
 369         bool Inbound_Server(std::deque<std::string> &params);
 370
 371         /** Handle netsplit
 372          */
 373         void Split(const std::string &line, std::deque<std::string> &n);
 374
 375         /** Process complete line from buffer
 376          */
 377         bool ProcessLine(std::string &line);
 378
 379         /** Get this server's name
 380          */
 381         virtual std::string GetName();
 382
 383         /** Handle socket timeout from connect()
 384          */
 385         virtual void OnTimeout();
 386
 387         /** Handle socket close event
 388          */
 389         virtual void OnClose();
 390
 391         /** Handle incoming connection event
 392          */
 393         virtual int OnIncomingConnection(int newsock, char* ip);
 394 };
 395
 396 /* Used to validate the value lengths of multiple parameters for a command */
 397 struct cmd_validation
 398 {
 399         const char* item;
 400         size_t param;
 401         size_t length;
 402 };
 403
 404 /* Used to validate the length values in CAPAB CAPABILITIES */
 405 struct cap_validation
 406 {
 407         const char* reason;
 408         const char* key;
 409         size_t size;
 410 };
 411
 412 #endif
 413