X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fsocket.h;h=1e6ca56a2b4b23ac4634753a6efc0d05133d3dfb;hb=fe46f3c228ae993b59fbf5eca423c3171d90e1b3;hp=92cd57130af1cea54de5865b822692b762448ee7;hpb=f9636a2eff46f6829bf9e01c711ab1ba45a7d50a;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/socket.h b/include/socket.h index 92cd57130..1e6ca56a2 100644 --- a/include/socket.h +++ b/include/socket.h @@ -2,12 +2,9 @@ * | 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-2007 InspIRCd Development Team + * See: http://www.inspircd.org/wiki/index.php/Credits + * * This program is free but copyrighted software; see * the file COPYING for details. * @@ -26,46 +23,155 @@ #include #include #include -#include #include #include - #include "inspircd_config.h" +#include "socketengine.h" 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 { /* macros to the relevant system address description structs */ #ifdef IPV6 - + /** insp_sockaddr for ipv6 + */ typedef struct sockaddr_in6 insp_sockaddr; + /** insp_inaddr for ipv6 + */ typedef struct in6_addr insp_inaddr; #define AF_FAMILY AF_INET6 #define PF_PROTOCOL PF_INET6 #else - + /** insp_sockaddr for ipv4 + */ typedef struct sockaddr_in insp_sockaddr; + /** insp_inaddr for ipv4 + */ typedef struct in_addr insp_inaddr; #define AF_FAMILY AF_INET #define PF_PROTOCOL PF_INET #endif - + /** 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. + */ bool MatchCIDRBits(unsigned char* address, 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 + */ bool MatchCIDR(const char* address, const char* 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 + */ bool MatchCIDR(const char* address, const char* cidr_mask, bool match_with_username); + /** Convert an insp_inaddr into human readable form. + * + * @param n An insp_inaddr (IP address) structure + * @return A human-readable address. IPV6 addresses + * will be shortened to remove fields which are 0. + */ const char* insp_ntoa(insp_inaddr n); + + /** Convert a human-readable address into an insp_inaddr. + * + * @param a A human-readable address + * @param n An insp_inaddr struct which the result + * will be copied into on success. + * @return This method will return a negative value if address + * does not contain a valid address family. 0 if the address is + * does not contain a valid string representing a valid network + * address. A positive value is returned if the network address + * was successfully converted. + + * or any other number upon failure. + */ int insp_aton(const char* a, insp_inaddr* n); + /** Make a socket file descriptor a blocking socket + * @param s A valid file descriptor + */ void Blocking(int s); + + /** Make a socket file descriptor into a nonblocking socket + * @param s A valid file descriptor + */ void NonBlocking(int s); + /** 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) + */ int OpenTCPSocket(); }; }; +/** This class handles incoming connections on client ports. + * It will create a new userrec for every valid connection + * and assign it a file descriptor. + */ +class ListenSocket : public EventHandler +{ + protected: + /** The creator/owner of this object + */ + InspIRCd* ServerInstance; + std::string desc; + public: + /** Create a new listening socket + */ + ListenSocket(InspIRCd* Instance, int sockfd, irc::sockets::insp_sockaddr client, irc::sockets::insp_sockaddr server, int port, char* addr); + /** Handle an I/O event + */ + void HandleEvent(EventType et, int errornum = 0); + /** Close the socket + */ + ~ListenSocket(); + /** Set descriptive text + */ + void SetDescription(const std::string &description) + { + desc = description; + } + + const std::string& GetDescription() + { + return desc; + } +}; + #endif