Library: NetSSL_OpenSSL
Package: SSLSockets
Header: Poco/Net/SecureStreamSocketImpl.h
Description
This class implements a SSL stream socket.
Inheritance
Direct Base Classes: StreamSocketImpl
All Base Classes: SocketImpl, StreamSocketImpl, Poco::RefCountedObject
Member Summary
Member Functions: abort, acceptConnection, acceptSSL, available, bind, close, completeHandshake, connect, connectNB, connectSSL, context, currentSession, error, getLazyHandshake, getPeerHostName, havePeerCertificate, lastError, listen, peerCertificate, receiveBytes, receiveFrom, secure, sendBytes, sendTo, sendUrgent, sessionWasReused, setLazyHandshake, setPeerHostName, shutdown, shutdownReceive, shutdownSend, useSession, verifyPeerCertificate
Inherited Functions: acceptConnection, address, available, bind, bind6, checkBrokenTimeout, close, connect, connectNB, duplicate, error, fcntl, getBlocking, getBroadcast, getError, getKeepAlive, getLinger, getNoDelay, getOOBInline, getOption, getRawOption, getReceiveBufferSize, getReceiveTimeout, getReuseAddress, getReusePort, getSendBufferSize, getSendTimeout, init, initSocket, initialized, ioctl, lastError, listen, peerAddress, poll, receiveBytes, receiveFrom, referenceCount, release, reset, secure, sendBytes, sendFile, sendTo, sendUrgent, setBlocking, setBroadcast, setKeepAlive, setLinger, setNoDelay, setOOBInline, setOption, setRawOption, setReceiveBufferSize, setReceiveTimeout, setReuseAddress, setReusePort, setSendBufferSize, setSendTimeout, shutdown, shutdownReceive, shutdownSend, socketError, sockfd, type, useFileDescriptor
Constructors
SecureStreamSocketImpl
SecureStreamSocketImpl(
Context::Ptr pContext
);
Creates the SecureStreamSocketImpl.
SecureStreamSocketImpl
SecureStreamSocketImpl(
StreamSocketImpl * pStreamSocket,
Context::Ptr pContext
);
Creates the SecureStreamSocketImpl.
Destructor
~SecureStreamSocketImpl 
~SecureStreamSocketImpl() override;
Destroys the SecureStreamSocketImpl.
Member Functions
abort
void abort();
Aborts the connection by closing the underlying TCP connection. No orderly SSL shutdown is performed.
acceptConnection
SocketImpl * acceptConnection(
SocketAddress & clientAddr
) override;
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
available
int available() override;
Returns the number of bytes available that can be read without causing the socket to block.
For an SSL connection, returns the number of bytes that can be read from the currently buffered SSL record, before a new record is read from the underlying socket.
See also: Poco::Net::SocketImpl::available()
bind
void bind(
const SocketAddress & address,
bool reuseAddress = false
) override;
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::bind()
close
void close() override;
Close the socket.
See also: Poco::Net::SocketImpl::close()
completeHandshake
int completeHandshake();
Completes the SSL handshake.
If the SSL connection was the result of an accept(), the server-side handshake is completed, otherwise a client-side handshake is performed.
connect
void connect(
const SocketAddress & address
) override;
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.
See also: Poco::Net::SocketImpl::connect()
connect
void connect(
const SocketAddress & address,
const Poco::Timespan & timeout
) override;
Initializes the socket, sets the socket timeout and establishes a connection to the TCP server at the given address.
See also: Poco::Net::SocketImpl::connect()
connectNB
void connectNB(
const SocketAddress & address
) override;
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.
See also: Poco::Net::SocketImpl::connectNB()
context 
Context::Ptr context() const;
Returns the SSL context used by this socket.
currentSession
Session::Ptr currentSession();
Returns the SSL session of the current connection, for reuse in a future connection (if session caching is enabled).
If no connection is established, returns null.
getLazyHandshake
bool getLazyHandshake() const;
Returns true if setLazyHandshake(true) has been called.
getPeerHostName
const std::string & getPeerHostName() const;
Returns the peer host name.
havePeerCertificate
bool havePeerCertificate() const;
Returns true iff the peer has presented a certificate.
listen
void listen(
int backlog = 64
) override;
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::listen()
peerCertificate
X509Certificate peerCertificate() const;
Returns the peer's X509 certificate.
Throws a SSLException if the peer did not present a certificate.
receiveBytes
int receiveBytes(
void * buffer,
int length,
int flags = 0
) override;
Receives data from the socket and stores it in buffer. Up to length bytes are received.
Returns the number of bytes received.
See also: Poco::Net::SocketImpl::receiveBytes()
receiveFrom
int receiveFrom(
void * buffer,
int length,
SocketAddress & address,
int flags = 0
) override;
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::receiveFrom()
secure
bool secure() const override;
Returns true iff the socket's connection is secure (using SSL or TLS).
See also: Poco::Net::SocketImpl::secure()
sendBytes
int sendBytes(
const void * buffer,
int length,
int flags = 0
) override;
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.
See also: Poco::Net::StreamSocketImpl::sendBytes()
sendTo
int sendTo(
const void * buffer,
int length,
const SocketAddress & address,
int flags = 0
) override;
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::sendTo()
sendUrgent
void sendUrgent(
unsigned char data
) override;
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::sendUrgent()
sessionWasReused
bool sessionWasReused();
Returns true iff a reused session was negotiated during the handshake.
setLazyHandshake
void setLazyHandshake(
bool flag = true
);
Enable lazy SSL handshake. If enabled, the SSL handshake will be performed the first time date is sent or received over the connection.
setPeerHostName
void setPeerHostName(
const std::string & hostName
);
Sets the peer host name for certificate validation purposes.
shutdown
void shutdown() override;
Shuts down the SSL connection.
See also: Poco::Net::SocketImpl::shutdown()
shutdownReceive
void shutdownReceive() override;
Shuts down the receiving part of the socket connection.
Since SSL does not support a half shutdown, this does nothing.
See also: Poco::Net::SocketImpl::shutdownReceive()
shutdownSend
void shutdownSend() override;
Shuts down the receiving part of the socket connection.
Since SSL does not support a half shutdown, this does nothing.
See also: Poco::Net::SocketImpl::shutdownSend()
useSession
void useSession(
Session::Ptr pSession
);
Sets the SSL session to use for the next connection. Setting a previously saved Session object is necessary to enable session caching.
To remove the currently set session, a null pointer can be given.
Must be called before connect() to be effective.
verifyPeerCertificate
void verifyPeerCertificate();
Performs post-connect (or post-accept) peer certificate validation, using the peer's IP address as host name.
verifyPeerCertificate
void verifyPeerCertificate(
const std::string & hostName
);
Performs post-connect (or post-accept) peer certificate validation using the given host name.
acceptSSL
void acceptSSL();
Performs a SSL server-side handshake.
connectSSL
void connectSSL();
Performs a SSL client-side handshake on an already connected TCP socket.
error 
static void error();
error
static void error(
const std::string & arg
);
error
static void error(
int code
);
error
static void error(
int code,
const std::string & arg
);
lastError
static int lastError();