src/modules/m_spanningtree/treesocket.h

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