m2mb_ssl.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
/* Global declarations ==========================================================================*/
#ifndef M2MB_SSL_H_
#define M2MB_SSL_H_
/* Failure return codes MUST be < 0 */
#include <stdint.h>
#include <string.h>
#include "m2mb_types.h"
#include "m2mb_os.h"
#include "nwk/m2mb_socket.h"
#include "m2mb_nwif.h"


/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/

#define M2MB_SSL_FAILURE            -1   
#define M2MB_SSL_ARG_FAIL           -6   
#define M2MB_SSL_PLATFORM_FAIL      -7   
#define M2MB_SSL_MEM_FAIL           -8   
#define M2MB_SSL_LIMIT_FAIL         -9   
#define M2MB_SSL_UNSUPPORTED_FAIL  -10   
#define M2MB_SSL_PROTOCOL_FAIL     -12   
#define M2MB_SSL_TIMEOUT_FAIL      -13   
#define M2MB_SSL_INTERRUPT_FAIL    -14   
#define M2MB_SSL_WRITE_ERROR       -15   
#define M2MB_SSL_READ_ERROR        -16   
#define M2MB_SSL_END_OF_FILE       -17   
#define M2MB_SSL_CLOSE_NOTIFY      -18   
#define M2MB_SSL_CERT_AUTH_FAIL    -35   
#define M2MB_SSL_FULL              -50   
#define M2MB_SSL_ALERT             -54   
#define M2MB_SSL_FILE_NOT_FOUND    -55   
#define M2MB_SSL_FALSE              0   
#define M2MB__SSL_TRUE              1   
#define M2MB_SSL_MAX_CA_LIST 10                 
#define M2MB_SSL_INVALID_HANDLE (0)             
typedef enum SSL_CFG_PARAM
{
        M2MB_SSL_CONF_INVALID = 0,              
        M2MB_SSL_CONF_PROTOCOL, 
        M2MB_SSL_CONF_CACERT,
        M2MB_SSL_CONF_CERT,
        M2MB_SSL_CONF_CIPHER,
        M2MB_SSL_CONF_TIME,
        M2MB_SSL_CONF_ALERT,
        M2MB_SSL_CONF_DOMAIN,
        M2MB_SSL_CONF_MAX_FRAG_LEN,
        M2MB_SSL_CONF_NEG_DISABLE,
        M2MB_SSL_CONF_SNI,
        M2MB_SSL_CONF_ALPN
}SSL_CFG_PARAM_E;


/* Global typedefs ==============================================================================*/

//typedef HANDLE M2MB_SSL_LOCATIONS_STORE;
typedef HANDLE M2MB_SSL_CTXT_HANDLE;

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_DTLS_1_0,   
  M2MB_SSL_PROTOCOL_DTLS_1_2    
} M2MB_SSL_PROTOCOL_VERSION_E;

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,                                        
  M2MB_TLS_RSA_WITH_AES_256_CCM,                                        
  M2MB_TLS_DHE_RSA_WITH_AES_128_CCM,                            
  M2MB_TLS_DHE_RSA_WITH_AES_256_CCM,                            
  M2MB_TLS_RSA_WITH_AES_128_CCM_8,                                      
  M2MB_TLS_RSA_WITH_AES_256_CCM_8,                                      
  M2MB_TLS_DHE_RSA_WITH_AES_128_CCM_8,                          
  M2MB_TLS_DHE_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        
} M2MB_SSL_CIPHER_SUITE_E;

typedef enum M2MB_SSL_CERT_TYPE_E
{
  M2MB_SSL_CACERT,              
  M2MB_SSL_CERT,                
  M2MB_SSL_PRIVKEY,     
  M2MB_SSL_PSKTABLE,    
  M2MB_SSL_CERTALL              
} M2MB_SSL_CERT_TYPE_E;


typedef enum M2MB_SSL_PEMCERT_TYPE_E
{
  M2MB_SSL_PEM_CERT,            
  M2MB_SSL_PEM_PKCS1_PRIVKEY,   
  M2MB_SSL_PEM_PKCS8_PRIVKEY,
  M2MB_SSL_PEM_PKCS8_ENC_PRIVKEY,
  M2MB_SSL_PEM_EC_PRIVKEY,      
} M2MB_SSL_PEMCERT_TYPE_E;


typedef enum M2MB_SSL_CERT_FMT_E
{
  M2MB_SSL_DER,                 
  M2MB_SSL_PEM,                 
} M2MB_SSL_CERT_FMT_E;


typedef enum M2MB_SSL_UPPROTO_TYPE
{
  M2MB_SSL_CLIENT,
  M2MB_SSL_HTTPC,               
  M2MB_SSL_HTTPD,
  M2MB_SSL_MQTT,                
  M2MB_SSL_WEBSOCKET,   
} M2MB_SSL_UPPROTO_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 struct M2MB_SSL_CERT_LIST_T {
    char name[10][64];  
} M2MB_SSL_CERT_LIST_T;

typedef union
{
  M2MB_SSL_CERT_T cert;                 
  M2MB_SSL_CA_LIST_T ca_List;   
  M2MB_SSL_PSK_TABLE_T psk_Tbl; 
} 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 enum M2MB_SSL_SSL_ROLE_E
{
        M2MB_SSL_SSL_ROLE_SERVER_E = 0, 
        M2MB_SSL_SSL_ROLE_CLIENT_E = 1  
} M2MB_SSL_SSL_ROLE_E;


#define M2MB_SSL_MAX_CIPHER_COUNT 64    
#define M2MB_SSL_MAX_CERT_NAME_LEN 64   
#define M2MB_SSL_MAX_SNI_NAME_LEN (64)  
typedef struct  {
    uint8_t domain ;
    uint8_t time_Validity ;
    uint8_t send_Alert ;
    char match_Name[M2MB_SSL_MAX_CERT_NAME_LEN];
}  M2MB_SSL_CONFIG_VERIFY_POLICY_T;

typedef struct {

        M2MB_SSL_SSL_ROLE_E role;                       
        /*<* Role of the SSL instance- Client/Server */
#if 0
        UINT32 CipherSuitesNum;

        UINT32 CipherSuites[M2MB_SSL_MAX_CIPHER_COUNT];
    //uint16_t sni_name_size;
#endif

    uint16_t max_frag_Len;
    uint16_t max_frag_fen_neg_disable;
    char sni_name[M2MB_SSL_MAX_SNI_NAME_LEN];
    void *alpn;
    void *extensions;
    M2MB_SSL_CONFIG_VERIFY_POLICY_T policy;
}M2MB_SSL_CONFIG_MORE_T;

typedef struct M2MB_SSL_CONFIG_T 
{
        M2MB_SSL_PROTOCOL_VERSION_E ProtVers ;  
    M2MB_SSL_AUTH_TYPE_E AuthType ;             
    M2MB_SSL_CIPHER_SUITE_E CipherSuites[M2MB_SSL_MAX_CIPHER_COUNT]; 
        UINT8 CipherSuitesNum;                          
    M2MB_SSL_CONFIG_MORE_T cfg;                         
}  M2MB_SSL_CONFIG_T;



#endif

/* Global functions =============================================================================*/
/* ======================================================================= */


/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/
M2MB_SSL_CTXT_HANDLE m2mb_ssl_init( M2MB_SSL_SSL_ROLE_E role );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_set_config( M2MB_SSL_CTXT_HANDLE sslContextHndl,  SSL_CFG_PARAM_E  CONF_ID, INT8*   CONF_VAL );


/*-----------------------------------------------------------------------------------------------*/
void m2mb_ssl_close( M2MB_SSL_CTXT_HANDLE sslContextHndl );


/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_secure_protocol(M2MB_SSL_CTXT_HANDLE sslContextHndl, M2MB_SSL_UPPROTO_TYPE_E protoType, VOID *protoCtxHndl);

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_connect( M2MB_SSL_CTXT_HANDLE sslContextHndl,M2MB_SOCKET_BSD_SOCKET socket_fd );


/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_write( M2MB_SSL_CTXT_HANDLE sslContextHndl, void *buf, UINT32 len );

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_read( M2MB_SSL_CTXT_HANDLE sslContextHndl, void *buf, UINT32 len );


/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_cert_store( M2MB_SSL_CERT_TYPE_E sslCertType, M2MB_SSL_SEC_INFO_U sslSecInfo, CHAR *name, M2MB_SSL_CERT_FMT_E format);


/*-----------------------------------------------------------------------------------------------*/

INT32 m2mb_ssl_cert_load( M2MB_SSL_CTXT_HANDLE sslCtxtHndl, M2MB_SSL_CERT_TYPE_E sslCertType, CHAR *name );


/*-----------------------------------------------------------------------------------------------*/

UINT8 m2mb_ssl_get_certloadStatus( M2MB_SSL_CTXT_HANDLE sslCtxtHndl, M2MB_SSL_CERT_TYPE_E sslCertType);


/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ssl_cert_delete( M2MB_SSL_CERT_TYPE_E sslCertType, CHAR *name );


 /*-----------------------------------------------------------------------------------------------*/
 INT32
m2mb_ssl_status(M2MB_SSL_CTXT_HANDLE sslContextHndl);

 
 /*-----------------------------------------------------------------------------------------------*/
 
 INT32
 m2mb_ssl_accept( M2MB_SSL_CTXT_HANDLE sslSvrContextHndl, M2MB_SOCKET_BSD_SOCKET socket_fd,     
                                                M2MB_SSL_CTXT_HANDLE* sslClientCtxHndl);

/*-----------------------------------------------------------------------------------------------*/

INT32 m2mb_ssl_cert_get(M2MB_SSL_CERT_TYPE_E sslCertType , M2MB_SSL_CERT_LIST_T *sslCertList);

/*-----------------------------------------------------------------------------------------------*/


UINT32 m2mb_ssl_get_internal_ssl_obj(M2MB_SSL_CTXT_HANDLE sslContextHndl);

/*-----------------------------------------------------------------------------------------------*/

INT32 m2mb_ssl_cert_search(M2MB_SSL_CERT_TYPE_E sslCertType , CHAR *certName);


/*-----------------------------------------------------------------------------------------------*/