Library: NetSSL_OpenSSL
Package: SSLSockets
Header: Poco/Net/SecureSocketImpl.h
Description
The SocketImpl for SecureStreamSocket.
Member Summary
Member Functions: acceptConnection, bind, close, connect, connectNB, connectSSL, containsWildcards, establishTunnel, invalidate, listen, matchByAlias, postConnectionCheck, receiveBytes, receiveFrom, sendBytes, sendTo, sendUrgent, setSockfd, setTunnelEndPoint, sockfd
Constructors
SecureSocketImpl
Creates the SecureSocketImpl.
SecureSocketImpl
SecureSocketImpl(
SSL * _pSSL
);
Creates the SecureSocketImpl.
Destructor
~SecureSocketImpl 
virtual ~SecureSocketImpl();
Destroys the SecureSocketImpl.
Member Functions
acceptConnection
SocketImpl * acceptConnection(
SocketAddress & clientAddr
);
Get the next completed connection from the socket's completed connection queue.
If the queue is empty, waits until a connection request completes.
Returns a new TCP socket for the connection with the client.
The client socket's address is returned in clientAddr.
bind
void bind(
const SocketAddress & address,
bool reuseAddress = false
);
Bind a local address to the socket.
This is usually only done when establishing a server socket. TCP clients should not bind a socket to a specific address.
If reuseAddress is true, sets the SO_REUSEADDR socket option.
close
void close();
Close the socket.
connect
void connect(
const SocketAddress & address
);
Initializes the socket and establishes a connection to the TCP server at the given address.
Can also be used for UDP sockets. In this case, no connection is established. Instead, incoming and outgoing packets are restricted to the specified address.
connect
void connect(
const SocketAddress & address,
const Poco::Timespan & timeout
);
Initializes the socket, sets the socket timeout and establishes a connection to the TCP server at the given address.
connectNB
void connectNB(
const SocketAddress & address
);
Initializes the socket and establishes a connection to the TCP server at the given address. Prior to opening the connection the socket is set to nonblocking mode.
listen
void listen(
int backlog = 64
);
Puts the socket into listening state.
The socket becomes a passive socket that can accept incoming connection requests.
The backlog argument specifies the maximum number of connections that can be queued for this socket.
postConnectionCheck 
static long postConnectionCheck(
SSLManager::ContextPtr pContext,
X509 * pCert,
const std::string & hostName
);
receiveBytes
int receiveBytes(
void * buffer,
int length,
int flags = 0
);
Receives data from the socket and stores it in buffer. Up to length bytes are received.
Returns the number of bytes received.
receiveFrom
int receiveFrom(
void * buffer,
int length,
SocketAddress & address,
int flags = 0
);
Receives data from the socket and stores it in buffer. Up to length bytes are received. Stores the address of the sender in address.
Returns the number of bytes received.
sendBytes
int sendBytes(
const void * buffer,
int length,
int flags = 0
);
Sends the contents of the given buffer through the socket. Any specified flags are ignored.
Returns the number of bytes sent, which may be less than the number of bytes specified.
sendTo
int sendTo(
const void * buffer,
int length,
const SocketAddress & address,
int flags = 0
);
Sends the contents of the given buffer through the socket to the given address.
Returns the number of bytes sent, which may be less than the number of bytes specified.
sendUrgent
void sendUrgent(
unsigned char data
);
Sends one byte of urgent data through the socket.
The data is sent with the MSG_OOB flag.
The preferred way for a socket to receive urgent data is by enabling the SO_OOBINLINE option.
setTunnelEndPoint 
void setTunnelEndPoint(
const std::string & endHost,
Poco::UInt16 endPort
);
Due to the fact that SSLConnections that run over proxies require a different connect phase (ie send an unencrypted HTTP CONNECT before establishing, we must inform the socket that is only used as a proxy that works as a tunnel to the given endPoint. Only call this method on disconnected sockets.
sockfd
SOCKET sockfd();
connectSSL 
void connectSSL(
const SocketAddress & address
);
Creates and connects an SSL connection. Set _pSSL on success or exception otherwise.
containsWildcards
static bool containsWildcards(
const std::string & commonName
);
Checks if the commonName of a certificate contains wildcards
establishTunnel
void establishTunnel();
Creates a socket to the proxy and sends CONNECT.
invalidate
void invalidate();
Invalidate the current socket. Must only be called on closed sockets.
matchByAlias
static bool matchByAlias(
const std::string & alias,
const HostEntry & heData
);
Checks if the alias is contained in heData
postConnectionCheck
static long postConnectionCheck(
bool onServer,
SSL * pSSL,
const std::string & host
);
PostConnectionCheck to verify that a peer really presented a valid certificate. if onserver is false, used by clients to verify that a server is really the one it claims. if onserver is true, used by the server to verify that a client is really the one it claims.
setSockfd
void setSockfd(
SOCKET sock
);
Set a socket description iff no socket is already set.