This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::SSLSocket Class

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Engineering / Sim SDK edition to use it.
Header: #include <UnigineSSLSocket.h>
Inherits from: Socket

SSLSocket Class

Enums

SSL_HANDSHAKE#

NameDescription
SSL_HANDSHAKE_ERROR_NONE = 0The TLS/SSL I/O operation completed.
SSL_HANDSHAKE_ERROR_SSL = 1A non-recoverable, fatal error in the SSL library occurred, usually a protocol error. The OpenSSL error queue contains more information on the error. If this error occurs then no further I/O operations should be performed on the connection.
SSL_HANDSHAKE_ERROR_WANT_READ = 2Error code returned when the last operation was a read operation from a nonblocking BIO. It means that not enough data was available at this time to complete the operation. If at a later time the underlying BIO has data available for reading the same function can be called again.
SSL_HANDSHAKE_ERROR_WANT_WRITE = 3Error code returned when the last operation was a write to a nonblocking BIO and it was unable to sent all data to the BIO. When the BIO is writable again, the same function can be called again.
SSL_HANDSHAKE_ERROR_WANT_X509_LOOKUP = 4The operation did not complete because an application callback has asked to be called again. The TLS/SSL I/O function should be called again later. Details depend on the application.
SSL_HANDSHAKE_ERROR_SYSCALL = 5Some non-recoverable, fatal I/O error occurred. The OpenSSL error queue may contain more information on the error. For socket I/O on Unix systems, consult errno for details. If this error occurs then no further I/O operations should be performed on the connection.
SSL_HANDSHAKE_ERROR_ZERO_RETURN = 6The TLS/SSL peer has closed the connection for writing by sending the close_notify alert. No more data can be read. Note that SSL_ERROR_ZERO_RETURN does not necessarily indicate that the underlying transport has been closed.
SSL_HANDSHAKE_ERROR_WANT_CONNECT = 7The operation did not complete; the same TLS/SSL I/O function should be called again later. The underlying BIO was not connected yet to the peer and the call would block in connect(). The SSL function should be called again when the connection is established.
SSL_HANDSHAKE_ERROR_WANT_ACCEPT = 8The operation did not complete; the same TLS/SSL I/O function should be called again later. The underlying BIO was not connected yet to the peer and the call would block in accept(). The SSL function should be called again when the connection is established.
SSL_HANDSHAKE_ERROR_WANT_ASYNC = 9The operation did not complete because an asynchronous engine is still processing data. The TLS/SSL I/O function should be called again later. The function must be called from the same thread that the original call was made from.
SSL_HANDSHAKE_ERROR_WANT_ASYNC_JOB = 10The asynchronous job could not be started because there were no async jobs available in the pool. The application should retry the operation after a currently executing asynchronous operation for the current thread has completed.
SSL_HANDSHAKE_ERROR_WANT_CLIENT_HELLO_CB = 11The operation did not complete because an application callback set by SSL_CTX_set_client_hello_cb() has asked to be called again. The TLS/SSL I/O function should be called again later. Details depend on the application.
SSL_HANDSHAKE_OK = 100Hadnshake operation was successful.
SSL_HANDSHAKE_FAILED = 101Hadnshake operation failed.

SSL_CTX_METHOD#

NameDescription
SSL_CTX_METHOD_TLS = 0General-purpose version-flexible SSL/TLS methods. The actual protocol version used will be negotiated to the highest version mutually supported by the client and the server. Currently supported protocols are TLS 1.0, TLS 1.1, and TLS 1.2.
SSL_CTX_METHOD_TLS_1_0 = 1Transport Layer Security Version 1.0 protocol.
SSL_CTX_METHOD_TLS_1_1 = 2Transport Layer Security Version 1.1 protocol.
SSL_CTX_METHOD_TLS_1_2 = 3Transport Layer Security Version 1.2 protocol.
SSL_CTX_METHOD_DTLS = 4Version-flexible DTLS methods. Currently supported protocols are DTLS 1.0 and DTLS 1.2.
SSL_CTX_METHOD_DTLS_1 = 5Datagram Transport Layer Security Version 1.0 protocol.
SSL_CTX_METHOD_DTLS_1_2 = 6Datagram Transport Layer Security Version 1.2 protocol.

LOADER_TYPE#

NameDescription
LOADER_TYPE_RSA_KEY = 3RSA key.
LOADER_TYPE_X509_CERT = 1Self-signed X.509 certificate.
LOADER_TYPE_X509_CACERT = 2X.509 certificate issued by a Certification Agency.

Members


SSLSocket ( ) #

Constructor. Creates a new SSL socket with default parameters (TLS).

SSLSocket ( Socket::SOCKET_TYPE socket_type, SSLSocket::SSL_CTX_METHOD ssl_method ) #

Constructor. Creates a new SSL socket with the specified parameters.

Arguments

void close ( ) #

Closes the socket.

bool accept ( const Ptr<Socket> & socket ) #

Accepts a connection on the socket.

Arguments

  • const Ptr<Socket> & socket - Socket that is bound to an address and listens to connections.

Return value

true if the connection is accepted; otherwise, fals.

bool connect ( ) #

Initiates a connection on the socket.

Return value

true if the connection is initialized; otherwise, false.

bool load ( SSLSocket::LOADER_TYPE loader_type, const char * path ) #

Loads a certificate from the file.

Arguments

Return value

true if the certificate is loaded successfully, otherwise false.

bool parse ( SSLSocket::LOADER_TYPE loader_type, const char * data ) #

Parses a specified certificate.

Arguments

Return value

true if the certificate is parsed successfully, otherwise false.

SSLSocket::SSL_HANDSHAKE handshake ( ) #

Starts a handshake and returns the result.

Return value

Handshake status.

bool isAvailable ( ) const#

Checks if the socket has been established, but not opened.

Return value

true if the socket is available; otherwise, false.

bool isCertificateVerified ( ) const#

Returns a value indicating if SSL certificate for the socket is successfully verified.

Return value

true if SSL certificate for the socket is successfully verified; otherwise, false.

int pending ( ) const#

Returns the number of bytes available for immediate retrieval without reading from the socket object. This function is essential if you work with event loops.

Return value

Number of bytes.

size_t read ( void * ptr, size_t size, size_t nmemb ) const#

Reads the specified number of blocks of the specified size from the SSL connection to the specified destination buffer.

Arguments

  • void * ptr - Pointer to the destination buffer to which the data is to be read.
  • size_t size - Size of a message block in bytes.
  • size_t nmemb - Number of message blocks to read from the SSL connection.

Return value

Number of bytes actually read.

size_t write ( const void * ptr, size_t size, size_t nmemb ) const#

Writes the specified number of blocks of the specified size from the specified source buffer to the SSL connection.

Arguments

  • const void * ptr - Pointer to the source buffer from which the data is to be written.
  • size_t size - Size of a message block in bytes.
  • size_t nmemb - Number of message blocks to be written to the SSL connection.

Return value

Number of bytes actually written.

size_t peek ( void * ptr, size_t size, size_t nmemb ) const#

Reads the specified number of blocks of the specified size from the SSL connection to the specified destination buffer. This method is identical to read except no bytes are actually removed from the underlying BIO during the read, so that a subsequent call to read will yield at least the same bytes.

Arguments

  • void * ptr - Pointer to the destination buffer to which the data is to be read.
  • size_t size - Size of a message block in bytes.
  • size_t nmemb - Number of message blocks to be written to the SSL connection.

Return value

Number of bytes actually written.
Last update: 2024-04-19
Build: ()