Detailed Description

This class handles SSL encrypted network connections.

Public Member Functions
MAXON_METHOD Result< void >	Init (const String &authority, const NetworkConnectionRef &wrapConnection, SSLSOCKETTYPE type, SSLPROTOCOLVERSION protocolVersion, SSLCERTREQUIREMENTS certRequire, const Url &keyFile, const Url &certificateFile, const Url &caCertsFile, Bool useClientCertOverride)

MAXON_METHOD Result< void >	DoHandShake ()

MAXON_METHOD Result< Url >	GetDefaultCaCertsFile () const

MAXON_METHOD Result< String >	GetCipherName ()

Private Member Functions
	MAXON_INTERFACE (SSLNetworkConnectionInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.sslnetworkconnection")

Member Function Documentation

MAXON_INTERFACE	(	SSLNetworkConnectionInterface	,
		MAXON_REFERENCE_NORMAL	,
		"net.maxon.interface.sslnetworkconnection"
	)

private

MAXON_METHOD Result<void> Init	(	const String &	authority,
		const NetworkConnectionRef &	wrapConnection,
		SSLSOCKETTYPE	type,
		SSLPROTOCOLVERSION	protocolVersion,
		SSLCERTREQUIREMENTS	certRequire,
		const Url &	keyFile,
		const Url &	certificateFile,
		const Url &	caCertsFile,
		Bool	useClientCertOverride
	)

Initializes the object. This connection wraps a basic NetworkConnectionRef into an SSL connection.

Parameters

[in]	authority	Server Name/Authority. This name will be used to compare it against the certificate common name when SSLCERTREQUIREMENTS::VERIFY_AUTHORITY is set.
[in]	wrapConnection	Wraps a basic ip connection into an SSL layer.
[in]	type	Select if the connection is a server or client connection.
[in]	protocolVersion	Choose the SSL encryption type.
[in]	certRequire	Option to select if certificates are required or not.
[in]	keyFile	TODO: (Anybody) not implemented yet.
[in]	certificateFile	TODO: (Anybody) not implemented yet.
[in]	caCertsFile	Url to a file with trusted ca root certificates to verify the server certificate. You can use SSLNetworkConnectionInterface::GetDefaultCaCertsFile() to get the applications default ca file.
[in]	useClientCertOverride	TODO: (Anybody) describe.

MAXON_METHOD Result<void> DoHandShake ( )

Executes the handshake with the server.

MAXON_METHOD Result<Url> GetDefaultCaCertsFile ( ) const

Returns the default ca certification file with trusted root certificates.

Returns: Returns the url with the application default trusted ca root certificates.

MAXON_METHOD Result<String> GetCipherName ( )

Returns the name of the cipher being.