SSLNetworkConnectionInterface Class Reference

#include <network_ip_ssl.h>

Inheritance diagram for SSLNetworkConnectionInterface:

详细描述

This class handles SSL encrypted network connections.

公共成员函数

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

私有成员函数

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

成员函数文档编制

◆  MAXON_INTERFACE()

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

◆  Init()

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.

参数
[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.
返回
OK on success.

◆  DoHandShake()

MAXON_METHOD Result <void> DoHandShake ( )

Executes the handshake with the server.

返回
OK on success.

◆  GetDefaultCaCertsFile()

MAXON_METHOD Result < Url > GetDefaultCaCertsFile ( ) const

Returns the default ca certification file with trusted root certificates.

返回
Returns the url with the application default trusted ca root certificates.

◆  GetCipherName()

MAXON_METHOD Result < String > GetCipherName ( )

Returns the name of the cipher being.

返回
Returns the name after the handshake succeeded.