OpenTop namespace:

Overview

Namespace

Class

Glossary

Index

OpenTop Portal

OpenTop 1.5

PREV NAMESPACE NEXT NAMESPACE

FRAMES NO FRAMES

Namespace ot::ssl

Provides classes for secure network communication using the "Secure Sockets Layer" (SSL) and IETF "Transport Layer Security" (TLS) protocols. Secure communications are facilitated via the SSLSocket and SSLServerSocket abstract classes which extend Socket and ServerSocket respectively.

OpenTop does not directly include the cryptographic algorithms required to implement secure communications. Instead it uses a security provider model to allow the integration of other third-party security packages. This model comprises a number of abstract base classes and factory classes from which a concrete SSL implementation can be derived.

OpenTop support for SSL/TLS using OpenSSL

As previously stated, OpenTop does not contain cryptographic algorithms, however the OpenTop source package does include a set of C++ classes which can optionally establish OpenSSL as a security provider.

The OpenTop FAQ describes how to enable the OpenSSL feature when the library is built.

Getting started with SSL

The starting point for an application programmer wishing to incorporate SSL is the SSLContext class. This class provides the root point from which the SSL package can be initialized and socket factories created.

Class Summary
`HandshakeCompletedEvent`	Encapsulates the SSL socket and session involved in a completed SSL handshake.
`HandshakeCompletedListener`	Abstract event listener interface class, implemented by clients wishing to be notified when a SSL handshake event completes on a SSLSocket.
`HostnameVerifier`	Abstract class providing an interface that allows applications to control whether TLS/SSL connections can be established with a HTTP server when the server's hostname does not match the fully qualified domain name (FQDN) contained within the server's X509 certificate.
`HttpsURLConnection`	A specialized URLConnection class that represents a connection with a resource specified by a `HTTPS` URL.
`SSLContext`	An abstract interface class providing the root entry-point for applications to initialize and control a SSL implementation.
`SSLInitParameters`	Structure containing parameters to initialize a SSLContext instance.
`SSLServerSocket`	Extends ServerSocket to provide support for secure communications over TCP/IP using SSL/TLS.
`SSLServerSocketFactory`	An abstract factory class for creating instances of SSLServerSocket.
`SSLSession`	An abstract interface class providing a means for client applications to access and control SSL session information.
`SSLSocket`	Extends the Socket class to provide secure communications using the "Secure Sockets Layer" ( SSL ) or IETF "Transport Layer Security" ( TLS ) protocols.
`SSLSocketFactory`

Exception Summary
`SSLException`	Thrown when an error condition is detected by the SSL framework classes.
`SSLHandshakeException`	Thrown when a SSL client and server are unable to negotiate a successful handshake. This may be due to inconsistencies between the client and server such as the level of the SSL/TLS protocol or the cipher suites which have been enabled.
`SSLPeerUnverifiedException`	Thrown when the identity of a peer host could not be verified.