Poco::Net

class SecureStreamSocketImpl

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: acceptConnection, acceptSSL, bind, close, completeHandshake, connect, connectNB, connectSSL, context, error, getLazyHandshake, getPeerHostName, lastError, listen, peerCertificate, receiveBytes, receiveFrom, sendBytes, sendTo, sendUrgent, setLazyHandshake, setPeerHostName, shutdown, shutdownReceive, shutdownSend, verifyPeerCertificate

Inherited Functions: acceptConnection, address, available, bind, 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, sendBytes, sendTo, sendUrgent, setBlocking, setBroadcast, setKeepAlive, setLinger, setNoDelay, setOOBInline, setOption, setRawOption, setReceiveBufferSize, setReceiveTimeout, setReuseAddress, setReusePort, setSendBufferSize, setSendTimeout, shutdown, shutdownReceive, shutdownSend, socketError, sockfd

Constructors

SecureStreamSocketImpl

SecureStreamSocketImpl(
    Context::Ptr pContext
);

Creates the SecureStreamSocketImpl.

SecureStreamSocketImpl

SecureStreamSocketImpl(
    StreamSocketImpl * pStreamSocket,
    Context::Ptr pContext
);

Creates the SecureStreamSocketImpl.

Destructor

~SecureStreamSocketImpl protected virtual

~SecureStreamSocketImpl();

Destroys the SecureStreamSocketImpl.

Member Functions

acceptConnection virtual

SocketImpl * acceptConnection(
    SocketAddress & clientAddr
);

Not supported by a SecureStreamSocket.

Throws a Poco::InvalidAccessException.

See also: Poco::Net::SocketImpl::acceptConnection()

bind virtual

void bind(
    const SocketAddress & address,
    bool reuseAddress = false
);

Not supported by a SecureStreamSocket.

Throws a Poco::InvalidAccessException.

See also: Poco::Net::SocketImpl::bind()

close virtual

void close();

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 virtual

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()

connect virtual

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()

connectNB virtual

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 inline

Context::Ptr context() const;

Returns the SSL context used by this socket.

getLazyHandshake

bool getLazyHandshake() const;

Returns true if setLazyHandshake(true) has been called.

getPeerHostName inline

const std::string & getPeerHostName() const;

Returns the peer host name.

listen virtual

void listen(
    int backlog = 64
);

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.

receiveBytes virtual

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()

receiveFrom virtual

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()

sendBytes virtual

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()

sendTo virtual

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()

sendUrgent virtual

void sendUrgent(
    unsigned char data
);

Not supported by a SecureStreamSocket.

Throws a Poco::InvalidAccessException.

See also: Poco::Net::SocketImpl::sendUrgent()

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 inline

void setPeerHostName(
    const std::string & hostName
);

Sets the peer host name for certificate validation purposes.

shutdown virtual

void shutdown();

Shuts down the SSL connection.

See also: Poco::Net::SocketImpl::shutdown()

shutdownReceive virtual

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()

shutdownSend virtual

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()

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 protected

void acceptSSL();

Performs a SSL server-side handshake.

connectSSL protected

void connectSSL();

Performs a SSL client-side handshake on an already connected TCP socket.

error protected static inline

static void error();

error protected static

static void error(
    const std::string & arg
);

error protected static

static void error(
    int code
);

error protected static

static void error(
    int code,
    const std::string & arg
);

lastError protected static inline

static int lastError();