X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fsocket.h;h=6e4bf9dbdc11331bfcdd34b5f3c41c2b4d93d48f;hb=6d03943426dcce76ba66567a9b18425a5ebb4c0c;hp=43ed322bc26cd100f31c2ee687cd5807a53eef84;hpb=b7d36f5296c1918d65da0d667811b9073b037077;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/socket.h b/include/socket.h index 43ed322bc..6e4bf9dbd 100644 --- a/include/socket.h +++ b/include/socket.h @@ -2,327 +2,203 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits + * * This program is free but copyrighted software; see * the file COPYING for details. * * --------------------------------------------------- */ -#ifndef __INSP_SOCKET_H__ -#define __INSP_SOCKET_H__ +#ifndef INSPIRCD_SOCKET_H +#define INSPIRCD_SOCKET_H + +#ifndef WIN32 +#include +#include +#include #include #include +#include #include -#include -#include -#include "dns.h" +#include +#include +#include -/** - * States which a socket may be in - */ -enum InspSocketState { I_DISCONNECTED, I_RESOLVING, I_CONNECTING, I_CONNECTED, I_LISTENING, I_ERROR }; - -/** - * Error types which a socket may exhibit - */ -enum InspSocketError { I_ERR_TIMEOUT, I_ERR_SOCKET, I_ERR_CONNECT, I_ERR_BIND, I_ERR_RESOLVE }; +#else -/** - * InspSocket is an extendable socket class which modules - * can use for TCP socket support. It is fully integrated - * into InspIRCds socket loop and attaches its sockets to - * the core's instance of the SocketEngine class, meaning - * that any sockets you create have the same power and - * abilities as a socket created by the core itself. - * To use InspSocket, you must inherit a class from it, - * and use the InspSocket constructors to establish connections - * and bindings. - */ -class InspSocket -{ -private: - - /** - * The file descriptor of this socket - */ - int fd; - - /** - * The resolver for this socket - */ - DNS dns; - - /** - * The hostname connected to - */ - std::string host; - - /** - * The port connected to, or the port - * this socket is listening on - */ - int port; - - /** - * The state for this socket, either - * listening, connecting, connected - * or error. - */ - InspSocketState state; +#include "inspircd_win32wrapper.h" - /** - * The host being connected to, - * in sockaddr form - */ - sockaddr_in addr; - - /** - * The host being connected to, - * in in_addr form - */ - in_addr addy; - - /** - * When this time is reached, - * the socket times out if it is - * in the CONNECTING state - */ - time_t timeout_end; - - /** - * This value is true if the - * socket has timed out. - */ - bool timeout; - - /** - * Socket input buffer, used by read(). The class which - * extends InspSocket is expected to implement an extendable - * buffer which can grow much larger than 64k, - * this buffer is just designed to be temporary storage. - * space. - */ - char ibuf[65535]; - - /** - * The output buffer for this socket - */ - std::string Buffer; - - /** - * The IP address being connected - * to stored in string form for - * easy retrieval by accessors. - */ - std::string IP; - - /** - * Client sockaddr structure used - * by accept() - */ - sockaddr_in client; - - /** - * Server sockaddr structure used - * by accept() - */ - sockaddr_in server; - - /** - * Used by accept() to indicate the - * sizes of the sockaddr_in structures - */ - socklen_t length; - - /** Flushes the write buffer - */ - void FlushWriteBuffer(); - -public: - - /** - * The default constructor does nothing - * and should not be used. - */ - InspSocket(); - - /** - * This constructor is used to associate - * an existing connecting with an InspSocket - * class. The given file descriptor must be - * valid, and when initialized, the InspSocket - * will be set with the given IP address - * and placed in CONNECTED state. - */ - InspSocket(int newfd, char* ip); - - /** - * This constructor is used to create a new - * socket, either listening for connections, or an outbound connection to another host. - * Note that if you specify a hostname in the 'host' parameter, then there will be an extra - * step involved (a nonblocking DNS lookup) which will cause your connection to be established - * slower than if it was an IP. Therefore, use an IP address where it is available instead. - * @param host The hostname to connect to, or bind to - * @param port The port number to connect to, or bind to - * @param listening true to listen on the given host:port pair, or false to connect to them - * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated - */ - InspSocket(std::string host, int port, bool listening, unsigned long maxtime); - - /** - * This method is called when an outbound - * connection on your socket is completed. - * @return false to abort the connection, true to continue - */ - virtual bool OnConnected(); - - /** - * This method is called when an error occurs. - * A closed socket in itself is not an error, - * however errors also generate close events. - * @param e The error type which occured - */ - virtual void OnError(InspSocketError e); +#endif - /** - * When an established connection is terminated, - * the OnDisconnect method is triggered. - */ - virtual int OnDisconnect(); +#include +#include "socketengine.h" - /** - * When there is data waiting to be read on a - * socket, the OnDataReady() method is called. - * Within this method, you *MUST* call the Read() - * method to read any pending data. At its lowest - * level, this event is signalled by the core via - * the socket engine. If you return false from this - * function, the core removes your socket from its - * list and erases it from the socket engine, then - * calls InspSocket::Close() and deletes it. - * @return false to close the socket - */ - virtual bool OnDataReady(); +/* Contains irc-specific definitions */ +namespace irc +{ + /** This namespace contains various protocol-independent helper classes. + * It also contains some types which are often used by the core and modules + * in place of inet_* functions and types. + */ + namespace sockets + { + + typedef union { + struct sockaddr sa; + struct sockaddr_in in4; + struct sockaddr_in6 in6; + } sockaddrs; + + /** Match raw binary data using CIDR rules. + * + * This function will use binary comparison to compare the + * two bit sequences, address and mask, up to mask_bits + * bits in size. If they match, it will return true. + * @param address The whole address, of 4 or 16 bytes in length + * @param mask The mask, from 1 to 16 bytes in length, anything + * from 1 to 128 bits of which is significant + * @param mask_Bits How many bits of the mask parameter are significant + * for this comparison. + * @returns True if the first mask_bits of address matches the first + * mask_bits of mask. + */ + CoreExport bool MatchCIDRBits(const unsigned char* address, const unsigned char* mask, unsigned int mask_bits); + + /** Match CIDR, without matching username/nickname parts. + * + * This function will compare a human-readable address against a human- + * readable CIDR mask, for example 1.2.3.4 against 1.2.0.0/16. This + * method supports both IPV4 and IPV6 addresses. + * @param address The human readable address, e.g. 1.2.3.4 + * @param cidr_mask The human readable mask, e.g. 1.2.0.0/16 + * @return True if the mask matches the address + */ + CoreExport bool MatchCIDR(const std::string &address, const std::string &cidr_mask); + + /** Match CIDR, including an optional username/nickname part. + * + * This function will compare a human-readable address (plus + * optional username and nickname) against a human-readable + * CIDR mask, for example joe!bloggs\@1.2.3.4 against + * *!bloggs\@1.2.0.0/16. This method supports both IPV4 and + * IPV6 addresses. + * @param address The human readable address, e.g. fred\@1.2.3.4 + * @param cidr_mask The human readable mask, e.g. *\@1.2.0.0/16 + * @return True if the mask matches the address + */ + CoreExport bool MatchCIDR(const std::string &address, const std::string &cidr_mask, bool match_with_username); + + /** Create a new valid file descriptor using socket() + * @return On return this function will return a value >= 0 for success, + * or a negative value upon failure (negative values are invalid file + * descriptors) + */ + CoreExport int OpenTCPSocket(const char* addr, int socktype = SOCK_STREAM); + + /** Return the size of the structure for syscall passing */ + CoreExport int sa_size(const irc::sockets::sockaddrs& sa); + + /** Convert an address-port pair into a binary sockaddr + * @param addr The IP address, IPv4 or IPv6 + * @param port The port, 0 for unspecified + * @param sa The structure to place the result in. Will be zeroed prior to conversion + * @return true if the conversion was successful, false if not. + */ + CoreExport bool aptosa(const char* addr, int port, irc::sockets::sockaddrs* sa); + /** Convert a binary sockaddr to an address-port pair + * @param sa The structure to convert + * @param addr the IP address + * @param port the port + * @return true if the conversion was successful, false if unknown address family + */ + CoreExport bool satoap(const irc::sockets::sockaddrs* sa, std::string& addr, int &port); + /** Convert a binary sockaddr to a user-readable string. + * This means IPv6 addresses are written as [::1]:6667, and *:6668 is used for 0.0.0.0:6668 + * @param sa The structure to convert + * @return The string; "" if not a valid address + */ + CoreExport std::string satouser(const irc::sockets::sockaddrs* sa); + } +} + + + +/** This class handles incoming connections on client ports. + * It will create a new User for every valid connection + * and assign it a file descriptor. + */ +class CoreExport ListenSocketBase : public EventHandler +{ + protected: + /** Socket description (shown in stats p) */ + std::string desc; - /** - * When an outbound connection fails, and the - * attempt times out, you will receive this event. - * The method will trigger once maxtime seconds are - * reached (as given in the constructor) just - * before the socket's descriptor is closed. - * A failed DNS lookup may cause this event if - * the DNS server is not responding, as well as - * a failed connect() call, because DNS lookups are - * nonblocking as implemented by this class. - */ - virtual void OnTimeout(); + /** Raw address socket is bound to */ + std::string bind_addr; + /** Port socket is bound to */ + int bind_port; + /** Human-readable address/port socket is bound to */ + std::string bind_desc; - /** - * Whenever close() is called, OnClose() will be - * called first. Please note that this means - * OnClose will be called alongside OnError(), - * OnTimeout(), and Close(), and also when - * cancelling a listening socket by calling - * the destructor indirectly. + /** The client address if the most recently connected client. + * Should only be used when accepting a new client. */ - virtual void OnClose(); - - /** - * Reads all pending bytes from the socket - * into a char* array which can be up to - * 16 kilobytes in length. + static irc::sockets::sockaddrs client; + /** The server address used by the most recently connected client. + * This may differ from the bind address by having a nonzero address, + * if the port is wildcard bound, or being IPv4 on a 6to4 IPv6 port. + * The address family will always match that of "client" */ - virtual char* Read(); + static irc::sockets::sockaddrs server; - /** - * Returns the IP address associated with - * this connection, or an empty string if - * no IP address exists. + public: + /** Create a new listening socket */ - std::string GetIP(); - - /** - * This function checks if the socket has - * timed out yet, given the current time - * in the parameter. - * @return true if timed out, false if not timed out + ListenSocketBase(int port, const std::string &addr); + /** Handle an I/O event */ - bool Timeout(time_t current); - - /** - * Writes a std::string to the socket. No carriage - * returns or linefeeds are appended to the string. - * @param data The data to send + void HandleEvent(EventType et, int errornum = 0); + /** Close the socket */ - virtual int Write(std::string data); - - /** - * If your socket is a listening socket, when a new - * connection comes in on the socket this method will - * be called. Given the new file descriptor in the - * parameters, and the IP, it is recommended you copy - * them to a new instance of your socket class, - * e.g.: - * - * MySocket* newsocket = new MySocket(newfd,ip); - * - * Once you have done this, you can then associate the - * new socket with the core using Server::AddSocket(). + ~ListenSocketBase(); + /** Set descriptive text */ - virtual int OnIncomingConnection(int newfd, char* ip); - - /** - * Changes the socket's state. The core uses this - * to change socket states, and you should not call - * it directly. + void SetDescription(const std::string &description) + { + desc = description; + } + /** Get description for socket */ - void SetState(InspSocketState s); - - /** - * Returns the current socket state. + const std::string& GetDescription() { return desc; } + /** Get port number for socket */ - InspSocketState GetState(); + int GetPort() const { return bind_port; } - /** - * Only the core should call this function. - * When called, it is assumed the socket is ready - * to read data, and the method call routes the - * event to the various methods of InspSocket - * for you to handle. This can also cause the - * socket's state to change. + /** Get IP address socket is bound to */ - bool Poll(); + const std::string &GetIP() { return bind_addr; } - /** - * This method returns the socket's file descriptor - * as assigned by the operating system, or -1 - * if no descriptor has been assigned. - */ - int GetFd(); + const std::string &GetBindDesc() { return bind_desc; } - /** - * This method causes the socket to close, and may - * also be triggered by other methods such as OnTimeout - * and OnError. + /** Handles sockets internals crap of a connection, convenience wrapper really */ - virtual void Close(); + void AcceptInternal(); - /** - * The destructor may implicitly call OnClose(), and - * will close() and shutdown() the file descriptor - * used for this socket. + /** Called when a new connection has successfully been accepted on this listener. + * @param fd The file descriptor of the new connection */ - virtual ~InspSocket(); + virtual void OnAcceptReady(int fd) = 0; +}; - virtual bool DoResolve(); - virtual bool DoConnect(); +class CoreExport ClientListenSocket : public ListenSocketBase +{ + virtual void OnAcceptReady(int fd); + public: + ClientListenSocket(int port, const std::string &addr) : ListenSocketBase(port, addr) { } }; #endif +