m2mb_ssl.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2M_M2MB_SSL_H
#define M2M_M2MB_SSL_H
 
/* Global declarations ==========================================================================*/
 
/* Failure return codes MUST be < 0 */
#define M2MB_SSL_SUCCESS             0   /* Generic Success */
#define M2MB_SSL_FAILURE            -1   /* Generic failure */
#define M2MB_SSL_ARG_FAIL           -6   /* Failure due to bad function param */
#define M2MB_SSL_PLATFORM_FAIL      -7   /* Not used */
#define M2MB_SSL_MEM_FAIL           -8   /* Not used */
#define M2MB_SSL_LIMIT_FAIL         -9   /* Not used */
#define M2MB_SSL_UNSUPPORTED_FAIL  -10   /* Not used */
#define M2MB_SSL_PROTOCOL_FAIL     -12   /* A protocol error occurred */
#define M2MB_SSL_TIMEOUT_FAIL      -13   /* A timeout occurred and MAY be an error */
#define M2MB_SSL_INTERRUPT_FAIL    -14   /* An interrupt occurred and MAY be an error */
#define M2MB_SSL_WRITE_ERROR       -15   /* An error occured while encoding on socket */
#define M2MB_SSL_READ_ERROR        -16   /* An error occured while decoding from socket */
#define M2MB_SSL_END_OF_FILE       -17   /* There is no data to read in SSL */
#define M2MB_SSL_CLOSE_NOTIFY      -18   /* SSL connection has been closed by remote host */
#define M2MB_SSL_CERT_AUTH_FAIL    -35   /* Authentication fails */
#define M2MB_SSL_FULL              -50   /* Not used */
#define M2MB_SSL_ALERT             -54   /* We've decoded an alert */
#define M2MB_SSL_FILE_NOT_FOUND    -55   /* File not found */
 
#define M2MB_SSL_MAX_CA_LIST        10
#define M2MB_SSL_MAX_CIPHERSUITES    8
 
/* Global typedefs ==============================================================================*/
 
typedef HANDLE M2MB_SSL_CTXT_HANDLE;
typedef HANDLE M2MB_SSL_CONFIG_HANDLE;
typedef uiHANDLE M2MB_SSL_CONNECTION_HANDLE;
 
/* TLS protocol version */
typedef enum M2MB_SSL_PROTOCOL_VERSION_E
{
  M2MB_SSL_PROTOCOL_TLS_1_0,
  M2MB_SSL_PROTOCOL_TLS_1_1,
  M2MB_SSL_PROTOCOL_TLS_1_2,
  M2MB_SSL_PROTOCOL_TLS_1_3,
  M2MB_SSL_PROTOCOL_DTLS_1_0,
  M2MB_SSL_PROTOCOL_DTLS_1_2,
  M2MB_SSL_PROTOCOL_TLS /* use highest and allow downgrade */
} M2MB_SSL_PROTOCOL_VERSION_E;
 
/* TLS ciphersuites */
typedef enum M2MB_SSL_CIPHER_SUITE_E
{
  M2MB_TLS_PSK_WITH_RC4_128_SHA,
  M2MB_TLS_PSK_WITH_3DES_EDE_CBC_SHA,
  M2MB_TLS_PSK_WITH_AES_128_CBC_SHA,
  M2MB_TLS_PSK_WITH_AES_256_CBC_SHA,
  M2MB_TLS_PSK_WITH_AES_128_GCM_SHA256,
  M2MB_TLS_PSK_WITH_AES_256_GCM_SHA384,
  M2MB_TLS_PSK_WITH_AES_128_CBC_SHA256,
  M2MB_TLS_PSK_WITH_AES_256_CBC_SHA384,
  M2MB_TLS_RSA_WITH_AES_128_CBC_SHA,
  M2MB_TLS_DHE_RSA_WITH_AES_128_CBC_SHA,
  M2MB_TLS_RSA_WITH_AES_256_CBC_SHA,
  M2MB_TLS_DHE_RSA_WITH_AES_256_CBC_SHA,
  M2MB_TLS_RSA_WITH_AES_128_CBC_SHA256,
  M2MB_TLS_RSA_WITH_AES_256_CBC_SHA256,
  M2MB_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256,
  M2MB_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256,
  M2MB_TLS_RSA_WITH_AES_128_GCM_SHA256,
  M2MB_TLS_RSA_WITH_AES_256_GCM_SHA384,
  M2MB_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,
  M2MB_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384,
  M2MB_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA,
  M2MB_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA,
  M2MB_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,
  M2MB_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,
  M2MB_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA,
  M2MB_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA,
  M2MB_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
  M2MB_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
  M2MB_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,
  M2MB_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,
  M2MB_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256,
  M2MB_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384,
  M2MB_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,
  M2MB_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,
  M2MB_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256,
  M2MB_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384,
  M2MB_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
  M2MB_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
  M2MB_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256,
  M2MB_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384,
  M2MB_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
  M2MB_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
  M2MB_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256,
  M2MB_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384,
  M2MB_TLS_RSA_WITH_AES_128_CCM_8,
  M2MB_TLS_RSA_WITH_AES_256_CCM_8,
  M2MB_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256,
  M2MB_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,
  M2MB_TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256,
 
  /* Additional Cipher Suites TLS v1.3*/
  M2MB_TLS_AES_128_GCM_SHA256,
  M2MB_TLS_AES_256_GCM_SHA384,
  M2MB_TLS_CHACHA20_POLY1305_SHA256,
  M2MB_TLS_AES_128_CCM_SHA256,
  M2MB_TLS_AES_128_CCM_8_SHA256,
 
  /* Additional PSK Cipher Suites */
  M2MB_TLS_PSK_WITH_AES_128_CCM_8,
  M2MB_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256,
  M2MB_TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256,
} M2MB_SSL_CIPHER_SUITE_E;
 
typedef enum M2MB_SSL_CERT_TYPE_E
{
  M2MB_SSL_CACERT, /* root CA certificate to authenticate the server */
  M2MB_SSL_CERT,   /* client certificate and private key in case of client authentication */
  M2MB_SSL_PSKTABLE /* PSK table in case of DTLS */
} M2MB_SSL_CERT_TYPE_E;
 
typedef struct M2MB_SSL_PSK_TABLE_T
{
  UINT32 psk_Size;
  UINT8 *psk_Buf;
} M2MB_SSL_PSK_TABLE_T;
 
typedef struct M2MB_SSL_CERT_T
{
  UINT8 *cert_Buf;
  UINT32 cert_Size;
  UINT8 *key_Buf;
  UINT32 key_Size;
  UINT8 *pass_Key;
} M2MB_SSL_CERT_T;
 
typedef struct M2MB_SSL_CA_INFO_T
{
  UINT8 *ca_Buf;
  UINT32 ca_Size;
} M2MB_SSL_CA_INFO_T;
 
typedef struct M2MB_SSL_CA_LIST_T
{
  UINT32 ca_Cnt;
  M2MB_SSL_CA_INFO_T *ca_Info[M2MB_SSL_MAX_CA_LIST];
} M2MB_SSL_CA_LIST_T;
 
typedef union
{
  M2MB_SSL_CERT_T cert;   /* client certificate and key */
  M2MB_SSL_CA_LIST_T ca_List;  /* CA list in case of server auth */
  M2MB_SSL_PSK_TABLE_T psk_Tbl; /* PSK table */
} M2MB_SSL_SEC_INFO_U;
 
typedef enum M2MB_SSL_AUTH_TYPE_E
{
  M2MB_SSL_NO_AUTH,
  M2MB_SSL_SERVER_AUTH,
  M2MB_SSL_SERVER_CLIENT_AUTH
} M2MB_SSL_AUTH_TYPE_E;
 
typedef struct M2MB_SSL_CONFIG_T
{
  M2MB_SSL_PROTOCOL_VERSION_E ProtVers; /* SSL TLS protocol version */
  M2MB_SSL_AUTH_TYPE_E AuthType; /* SSL TLS auth type */
  M2MB_SSL_CIPHER_SUITE_E *CipherSuites; /* ciphersuites set */
  UINT8 CipherSuitesNum;        /* note: max 8 allowed */
} M2MB_SSL_CONFIG_T;
 
typedef enum
{
  M2MB_SSL_NAME_CHECK           = 0,
  M2MB_SSL_NAME_SNI             = 1,
  M2MB_SSL_DTLS_SET_SOCKET_NAME = 2,
  M2MB_SSL_CONNECT_TIMEOUT      = 3,
  ENUM_TO_INT( M2MB_SSL_CONF_REQUEST_E )
} M2MB_SSL_CONF_REQUEST_E;
 
/* Global functions =============================================================================*/
 
/*-----------------------------------------------------------------------------------------------*/
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_SSL_CTXT_HANDLE m2mb_ssl_create_ctxt( void );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_SSL_CONFIG_HANDLE m2mb_ssl_create_config( M2MB_SSL_CONFIG_T sslConfig, INT32 *result );
 
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_delete_config( M2MB_SSL_CONFIG_HANDLE sslConfigHndl );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_SSL_CONNECTION_HANDLE m2mb_ssl_secure_socket( M2MB_SSL_CONFIG_HANDLE sslConfigHndl, M2MB_SSL_CTXT_HANDLE sslCtxtHndl, M2MB_SOCKET_BSD_SOCKET socket_fd, INT32 *result );
 
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_connect( M2MB_SSL_CONNECTION_HANDLE sslConnectionHandle );
 
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_write( M2MB_SSL_CONNECTION_HANDLE sslConnectionHandle, void *buf, UINT32 len );
 
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_read( M2MB_SSL_CONNECTION_HANDLE sslConnectionHandle, void *buf, UINT32 len );
 
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_shutdown( M2MB_SSL_CONNECTION_HANDLE sslConnectionHandle );
 
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_cert_store( M2MB_SSL_CERT_TYPE_E sslCertType, M2MB_SSL_SEC_INFO_U sslSecInfo, CHAR *name );
 
/*-----------------------------------------------------------------------------------------------*/
 
INT32 m2mb_ssl_cert_load( M2MB_SSL_CTXT_HANDLE sslCtxtHndl, M2MB_SSL_CERT_TYPE_E sslCertType, CHAR *name );
 
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_cert_delete( M2MB_SSL_CERT_TYPE_E sslCertType, CHAR *name );
 
/*-----------------------------------------------------------------------------------------------*/
void m2mb_ssl_delete_ctxt( M2MB_SSL_CTXT_HANDLE sslCtxtHndl );
 
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_config( M2MB_SSL_CONFIG_HANDLE sslConfigHndl, INT32 cmd, void *argp );
 
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_get_pending_bytes( M2MB_SOCKET_BSD_SOCKET socket_fd, M2MB_SSL_CONNECTION_HANDLE sslConnectionHandle );
 
 
#endif /* M2M_M2MB_SSL_H */