Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

irc::sockets

irc::sockets Namespace Reference

This namespace contains various protocol-independent helper classes. More...

Typedefs
typedef sockaddr_in	insp_sockaddr
	insp_sockaddr for ipv4
typedef in_addr	insp_inaddr
	insp_inaddr for ipv4
Functions
bool	MatchCIDRBits (unsigned char *address, unsigned char *mask, unsigned int mask_bits)
	Match raw binary data using CIDR rules.
bool	MatchCIDR (const char *address, const char *cidr_mask)
	Match CIDR, without matching username/nickname parts.
bool	MatchCIDR (const char *address, const char *cidr_mask, bool match_with_username)
	Match CIDR, including an optional username/nickname part.
void	Blocking (int s)
	Make a socket file descriptor a blocking socket.
void	NonBlocking (int s)
	Make a socket file descriptor into a nonblocking socket.
int	OpenTCPSocket (char *addr, int socktype=SOCK_STREAM)
	Create a new valid file descriptor using socket().
const char *	insp_ntoa (insp_inaddr n)
	Convert an insp_inaddr into human readable form.
int	insp_aton (const char *a, insp_inaddr *n)
	Convert a human-readable address into an insp_inaddr.

---

Detailed Description

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.

---

Typedef Documentation

typedef struct in_addr irc::sockets::insp_inaddr

insp_inaddr for ipv4 Definition at line 84 of file socket.h.

typedef struct sockaddr_in irc::sockets::insp_sockaddr

insp_sockaddr for ipv4 Definition at line 81 of file socket.h.

---

Function Documentation

CoreExport void irc::sockets::Blocking (  int  s  )

Make a socket file descriptor a blocking socket. Parameters: s  A valid file descriptor Definition at line 298 of file socket.cpp. { #ifndef WIN32 int flags = fcntl(s, F_GETFL, 0); fcntl(s, F_SETFL, flags ^ O_NONBLOCK); #else unsigned long opt = 0; ioctlsocket(s, FIONBIO, &opt); #endif }

CoreExport int irc::sockets::insp_aton (  const char *  a, insp_inaddr *  n )

Convert a human-readable address into an insp_inaddr. Parameters: a  A human-readable address n  An insp_inaddr struct which the result will be copied into on success. Returns: 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. Definition at line 563 of file socket.cpp. References AF_FAMILY. Referenced by DispatcherThread(), Resolver::Resolver(), and SQLConn::SendNotify(). { return inet_pton(AF_FAMILY, a, n); }

CoreExport const char * irc::sockets::insp_ntoa (  insp_inaddr  n  )

Convert an insp_inaddr into human readable form. Parameters: n  An insp_inaddr (IP address) structure Returns: A human-readable address. IPV6 addresses will be shortened to remove fields which are 0. Definition at line 556 of file socket.cpp. References AF_FAMILY. Referenced by DNS::GetName(). { static char buf[1024]; inet_ntop(AF_FAMILY, &n, buf, sizeof(buf)); return buf; }

CoreExport bool irc::sockets::MatchCIDR (  const char *  address, const char *  cidr_mask, bool  match_with_username )

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. Parameters: address  The human readable address, e.g. fred@1.2.3.4 cidr_mask  The human readable mask, e.g. *@1.2.0.0/16 Returns: True if the mask matches the address Definition at line 164 of file socket.cpp. References match(), MatchCIDR(), and MatchCIDRBits(). { unsigned char addr_raw[16]; unsigned char mask_raw[16]; unsigned int bits = 0; char* mask = NULL; /* The caller is trying to match ident@<mask>/bits. * Chop off the ident@ portion, use match() on it * seperately. */ if (match_with_username) { /* Duplicate the strings, and try to find the position * of the @ symbol in each */ char* address_dupe = strdup(address); char* cidr_dupe = strdup(cidr_mask); /* Use strchr not strrchr, because its going to be nearer to the left */ char* username_mask_pos = strrchr(cidr_dupe, '@'); char* username_addr_pos = strrchr(address_dupe, '@'); /* Both strings have an @ symbol in them */ if (username_mask_pos && username_addr_pos) { /* Zero out the location of the @ symbol */ *username_mask_pos = *username_addr_pos = 0; /* Try and match() the strings before the @ * symbols, and recursively call MatchCIDR without * username matching enabled to match the host part. */ bool result = (match(address_dupe, cidr_dupe) && MatchCIDR(username_addr_pos + 1, username_mask_pos + 1, false)); /* Free the stuff we created */ free(address_dupe); free(cidr_dupe); /* Return a result */ return result; } else { /* One or both didnt have an @ in, * just match as CIDR */ free(address_dupe); free(cidr_dupe); mask = strdup(cidr_mask); } } else { /* Make a copy of the cidr mask string, * we're going to change it */ mask = strdup(cidr_mask); } in_addr address_in4; in_addr mask_in4; /* Use strrchr for this, its nearer to the right */ char* bits_chars = strrchr(mask,'/'); if (bits_chars) { bits = atoi(bits_chars + 1); *bits_chars = 0; } else { /* No 'number of bits' field! */ free(mask); return false; } #ifdef SUPPORT_IP6LINKS in6_addr address_in6; in6_addr mask_in6; if (inet_pton(AF_INET6, address, &address_in6) > 0) { if (inet_pton(AF_INET6, mask, &mask_in6) > 0) { memcpy(&addr_raw, &address_in6.s6_addr, 16); memcpy(&mask_raw, &mask_in6.s6_addr, 16); if (bits > 128) bits = 128; } else { /* The address was valid ipv6, but the mask * that goes with it wasnt. */ free(mask); return false; } } else #endif if (inet_pton(AF_INET, address, &address_in4) > 0) { if (inet_pton(AF_INET, mask, &mask_in4) > 0) { memcpy(&addr_raw, &address_in4.s_addr, 4); memcpy(&mask_raw, &mask_in4.s_addr, 4); if (bits > 32) bits = 32; } else { /* The address was valid ipv4, * but the mask that went with it wasnt. */ free(mask); return false; } } else { /* The address was neither ipv4 or ipv6 */ free(mask); return false; } /* Low-level-match the bits in the raw data */ free(mask); return MatchCIDRBits(addr_raw, mask_raw, bits); }

CoreExport bool irc::sockets::MatchCIDR (  const char *  address, const char *  cidr_mask )

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. Parameters: address  The human readable address, e.g. 1.2.3.4 cidr_mask  The human readable mask, e.g. 1.2.0.0/16 Returns: True if the mask matches the address Definition at line 152 of file socket.cpp. Referenced by match(), MatchCIDR(), and TreeSocket::OnIncomingConnection(). { return MatchCIDR(address, cidr_mask, false); }

CoreExport bool irc::sockets::MatchCIDRBits (  unsigned char *  address, unsigned char *  mask, unsigned int  mask_bits )

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. Parameters: address  The whole address, of 4 or 16 bytes in length mask  The mask, from 1 to 16 bytes in length, anything from 1 to 128 bits of which is significant 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. Definition at line 132 of file socket.cpp. References inverted_bits. Referenced by MatchCIDR(). { unsigned int modulus = mask_bits % 8; /* Number of whole bytes in the mask */ unsigned int divisor = mask_bits / 8; /* Remaining bits in the mask after whole bytes are dealt with */ /* First compare the whole bytes, if they dont match, return false */ if (memcmp(address, mask, divisor)) return false; /* Now if there are any remainder bits, we compare them with logic AND */ if (modulus) if ((address[divisor] & inverted_bits[modulus]) != (mask[divisor] & inverted_bits[modulus])) /* If they dont match, return false */ return false; /* The address matches the mask, to mask_bits bits of mask */ return true; }

CoreExport void irc::sockets::NonBlocking (  int  s  )

Make a socket file descriptor into a nonblocking socket. Parameters: s  A valid file descriptor Definition at line 309 of file socket.cpp. Referenced by InspIRCd::BindSocket(), ListenSocket::HandleEvent(), IdentRequestSocket::IdentRequestSocket(), InspSocket::Poll(), and DNS::Rehash(). { #ifndef WIN32 int flags = fcntl(s, F_GETFL, 0); fcntl(s, F_SETFL, flags | O_NONBLOCK); #else unsigned long opt = 1; ioctlsocket(s, FIONBIO, &opt); #endif }

CoreExport int irc::sockets::OpenTCPSocket (  char *  addr, int  socktype = SOCK_STREAM )

Create a new valid file descriptor using socket(). Returns: On return this function will return a value >= 0 for success, or a negative value upon failure (negative values are invalid file descriptors) Definition at line 446 of file socket.cpp. References ERROR. Referenced by InspSocket::InspSocket(), ListenSocket::ListenSocket(), and DNS::Rehash(). { int sockfd; int on = 1; struct linger linger = { 0 }; #ifdef IPV6 if (strchr(addr,':') || (!*addr)) sockfd = socket (PF_INET6, socktype, 0); else sockfd = socket (PF_INET, socktype, 0); if (sockfd < 0) #else if ((sockfd = socket (PF_INET, socktype, 0)) < 0) #endif { return ERROR; } else { setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, (char*)&on, sizeof(on)); /* This is BSD compatible, setting l_onoff to 0 is *NOT* http://web.irc.org/mla/ircd-dev/msg02259.html */ linger.l_onoff = 1; linger.l_linger = 1; setsockopt(sockfd, SOL_SOCKET, SO_LINGER, (char*)&linger,sizeof(linger)); return (sockfd); } }