nn::ssl::Connection Class

Syntax

class Connection : private ADLFireWall::NonCopyable

Description

Class that represents SSL communication. One instance of this class handles SSL communication for one socket.

Member Functions

Initialization/Finalization
Connection Constructor. Sets a socket to use for SSL communication.
V ~Connection Destructor.
AssignSocket Sets a socket to use for SSL communication. Cannot set the socket if one is already set for this Connection object.
SetServerCertBuffer Configures the buffer used to get the server certificate. Use this after invoking the Initialize function. This function handles everything up to and including the buffer configuration. The server certificate will actually be written to the buffer when the DoHandshake function is called.
Initialize Initializes the connection.
Note: This function only configures communication settings; it does not connect on the network level. Network communication begins when the DoHandshake function is called.
AssignServer Alternate name for the Initialize function. This is left for compatibility. Use the Initialize function instead from now on.
Shutdown Finalizes communication. Any sockets set for the connection will be freed when the connection is finalized.
SSL Handshakes
DoHandshake Performs an SSL handshake.
Sending and Receiving Data
Read Loads data over an SSL connection.
Peek Reads ahead in data received via SSL without changing the data's state.
Write Writes data over an SSL connection.
Certificate & CRL Settings
SetServerCertStore Sets the certificate store to use in SSL communication. This API function is provided to allow API users to set their own certificate stores.
SetClientCert Sets the client certificate to use in SSL communication.
SetCRLStore Sets the CRL store to use in SSL communication. This API function is provided to allow API users to set their own CRL stores.
AddEVPolicyId Configures a trusted EV certificate policy ID.
Other
DisableVerifyOptionForDebug Removes the SSL communication verification contents for the specified bits. The items that are verified by default were chosen for security reasons. Do not exclude any items from verification except for debugging purposes.
GetCipherInfo Gets information about the encryption used for the target SSL communication. This function is intended for special use cases; it is not envisioned for use by normal users.

Class Hierarchy

ADLFireWall::NonCopyable
  nn::ssl::Connection

Revision History

2010/06/14
Initial version.

CONFIDENTIAL