SSL & TLS

Description

This API provides ability to create secure sockets.

Introduction

This module provides SSL APIs for security connection, the implementation is based on xySSL.

The basic flow of using SSL APIs is as follows:

Configure the context, which contains host address and callback to register.
Connect to the host using vm_ssl_connect(context).
Handle the VM_SSL_EVENT_CONNECTED in the registered callback.
Use vm_ssl_read()to read or vm_ssl_write() to write data after the security connection is established, and VM_SSL_EVENT_CAN_WRITE and VM_SSL_EVENT_CAN_READ has arrived.
Close the connection by calling vm_ssl_close().

Limitation

The platform doesn't have preloaded certificate agency certificate, so when connecting to a server and you've set verify type VM_SSL_VERIFY_REQUIRED, you will also need to set the certificate agency certificate of the website you want to connect by calling vm_ssl_load_ca_chain_certificate() after vm_ssl_connect().

Group

Network Protocol

Functions

Function	Description
vm_ssl_base64_decode	This utility function decodes a buffer with base64 encoding. Call this function with destination_length = 0 to obtain the required buffer size in destination_length.
vm_ssl_base64_encode	This utility function encodes a buffer with base64 encoding. Call this function with destination_length = 0 to obtain the required buffer size in destination_length.
vm_ssl_close	Closes the connection.
vm_ssl_connect	Creates SSL connection to remote host.
vm_ssl_get_verify_result	Get the verify result.
vm_ssl_load_ca_chain_certificate	Load certificate agency certificate in X.509 formate (.cer files)
vm_ssl_read	read data from ssl connection.
vm_ssl_sha1_hmac	This utility function hashes input buffer using the HMAC algorithm and the SHA-1 hash function to a 160 bits (20-bytes) hash value.
vm_ssl_write	write data from ssl connection.

Structs, Records, Enums

Struct, Record, Enum	Description
VM_SSL_BASE64_ERROR	Error values for vm_ssl_base64_encode and vm_ssl_base64_decode
vm_ssl_context_t	SSL configuration context
VM_SSL_ERROR	Error values for connection related APIs, e.g. vm_ssl_read and vm_ssl_write.
VM_SSL_EVENT	Events passing to vm_ssl_connection_callback.
VM_SSL_VERIFY_RESULT	Error values for vm_ssl_get_verify_result.
VM_SSL_VERIFY_TYPE	Verification type used for socket connection.
VM_SSL_X509_ERROR	Error values for vm_ssl_load_ca_chain_certificate.

Types

Type	Description
vm_ssl_connection_callback	Callback function for connection events. This is configured in vm_ssl_context_t.
VM_SSL_HANDLE	Handle to a SSL connection.

Links

Topics, Functions, Structs, Records, Enums, Types

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

support@toolsfactory.com.