Library: NetSSL_OpenSSL
Package: SSLSockets
Header: Poco/Net/SecureStreamSocketImpl.h
This class implements a SSL stream socket.
Direct Base Classes: StreamSocketImpl
All Base Classes: SocketImpl, StreamSocketImpl, Poco::RefCountedObject
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, close, connect, connectNB, duplicate, error, getBlocking, getBroadcast, 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, sendTo, sendUrgent, setBlocking, setBroadcast, setKeepAlive, setLinger, setNoDelay, setOOBInline, setOption, setRawOption, setReceiveBufferSize, setReceiveTimeout, setReuseAddress, setReusePort, setSendBufferSize, setSendTimeout, shutdown, shutdownReceive, shutdownSend, socketError, sockfd
SecureStreamSocketImpl(
Context::Ptr pContext
);
Creates the SecureStreamSocketImpl.
SecureStreamSocketImpl(
StreamSocketImpl * pStreamSocket,
Context::Ptr pContext
);
Creates the SecureStreamSocketImpl.
Destroys the SecureStreamSocketImpl.
void abort();
Aborts the connection by closing the underlying TCP connection. No orderly SSL shutdown is performed.
SocketImpl * acceptConnection(
SocketAddress & clientAddr
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
int available();
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()
void bind(
const SocketAddress & address,
bool reuseAddress = false
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::bind()
void close();
Close the socket.
See also: Poco::Net::SocketImpl::close()
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.
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.
See also: Poco::Net::SocketImpl::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.
See also: Poco::Net::SocketImpl::connect()
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.
See also: Poco::Net::SocketImpl::connectNB()
Context::Ptr context() const;
Returns the SSL context used by this socket.
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.
bool getLazyHandshake() const;
Returns true if setLazyHandshake(true) has been called.
const std::string & getPeerHostName() const;
Returns the peer host name.
bool havePeerCertificate() const;
Returns true if and only if the peer has presented a certificate.
void listen(
int backlog = 64
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::listen()
X509Certificate peerCertificate() const;
Returns the peer's X509 certificate.
Throws a SSLException if the peer did not present a certificate.
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.
See also: Poco::Net::SocketImpl::receiveBytes()
int receiveFrom(
void * buffer,
int length,
SocketAddress & address,
int flags = 0
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::receiveFrom()
bool secure() const;
Returns true if and only if the socket's connection is secure (using SSL or TLS).
See also: Poco::Net::SocketImpl::secure()
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.
See also: Poco::Net::StreamSocketImpl::sendBytes()
int sendTo(
const void * buffer,
int length,
const SocketAddress & address,
int flags = 0
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::sendTo()
void sendUrgent(
unsigned char data
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::sendUrgent()
bool sessionWasReused();
Returns true if and only if a reused session was negotiated during the handshake.
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.
void setPeerHostName(
const std::string & hostName
);
Sets the peer host name for certificate validation purposes.
void shutdown();
Shuts down the SSL connection.
See also: Poco::Net::SocketImpl::shutdown()
void shutdownReceive();
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()
void shutdownSend();
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()
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.
void verifyPeerCertificate();
Performs post-connect (or post-accept) peer certificate validation, using the peer's IP address as host name.
void verifyPeerCertificate(
const std::string & hostName
);
Performs post-connect (or post-accept) peer certificate validation using the given host name.
void acceptSSL();
Performs a SSL server-side handshake.
void connectSSL();
Performs a SSL client-side handshake on an already connected TCP socket.
static void error();
static void error(
const std::string & arg
);
static void error(
int code
);
static void error(
int code,
const std::string & arg
);
static int lastError();