Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Enumerations and Typedefs

    Specifies the enums and Data Structures used by the SSL APIs.

Data Structures

struct  tstrSslSetActiveCsList
 
struct  tstrTlsCrlEntry
 Certificate data for inclusion in a revocation list (CRL) More...
 
struct  tstrTlsCrlInfo
 Certificate revocation list details. More...
 
struct  tstrTlsSrvChunkHdr
 
struct  tstrTlsSrvSecFileEntry
 This struct contains a TLS certificate. More...
 
struct  tstrTlsSrvSecHdr
 This struct contains a set of TLS certificates. More...
 

Enumerations

enum  tenuM2mSslCmd {
  M2M_SSL_REQ_CERT_VERIF,
  M2M_SSL_REQ_ECC,
  M2M_SSL_RESP_ECC,
  M2M_SSL_RSV,
  M2M_SSL_REQ_WRITE_OWN_CERTS,
  M2M_SSL_REQ_SET_CS_LIST,
  M2M_SSL_RESP_SET_CS_LIST,
  M2M_SSL_RESP_WRITE_OWN_CERTS,
  M2M_SSL_REQ_CERT_VERIF,
  M2M_SSL_REQ_ECC,
  M2M_SSL_RESP_ECC,
  M2M_SSL_IND_CRL,
  M2M_SSL_REQ_WRITE_OWN_CERTS,
  M2M_SSL_REQ_SET_CS_LIST,
  M2M_SSL_RESP_SET_CS_LIST,
  M2M_SSL_RESP_WRITE_OWN_CERTS
}
 This enum contains WINC commands related to TLS handshake. More...
 
enum  tenuM2mSslCmd {
  M2M_SSL_REQ_CERT_VERIF,
  M2M_SSL_REQ_ECC,
  M2M_SSL_RESP_ECC,
  M2M_SSL_RSV,
  M2M_SSL_REQ_WRITE_OWN_CERTS,
  M2M_SSL_REQ_SET_CS_LIST,
  M2M_SSL_RESP_SET_CS_LIST,
  M2M_SSL_RESP_WRITE_OWN_CERTS,
  M2M_SSL_REQ_CERT_VERIF,
  M2M_SSL_REQ_ECC,
  M2M_SSL_RESP_ECC,
  M2M_SSL_IND_CRL,
  M2M_SSL_REQ_WRITE_OWN_CERTS,
  M2M_SSL_REQ_SET_CS_LIST,
  M2M_SSL_RESP_SET_CS_LIST,
  M2M_SSL_RESP_WRITE_OWN_CERTS
}
 
enum  tenuSslCertExpSettings {
  SSL_CERT_EXP_CHECK_DISABLE,
  SSL_CERT_EXP_CHECK_ENABLE,
  SSL_CERT_EXP_CHECK_EN_IF_SYS_TIME
}
 SSL Certificate Expiry Validation Options. More...
 
enum  tenuTlsFlashStatus {
  TLS_FLASH_OK,
  TLS_FLASH_OK_NO_CHANGE,
  TLS_FLASH_ERR_CORRUPT,
  TLS_FLASH_ERR_NO_CHANGE,
  TLS_FLASH_ERR_UNKNOWN,
  TLS_FLASH_OK,
  TLS_FLASH_OK_NO_CHANGE,
  TLS_FLASH_ERR_CORRUPT,
  TLS_FLASH_ERR_NO_CHANGE,
  TLS_FLASH_ERR_UNKNOWN
}
 
enum  tenuTlsFlashStatus {
  TLS_FLASH_OK,
  TLS_FLASH_OK_NO_CHANGE,
  TLS_FLASH_ERR_CORRUPT,
  TLS_FLASH_ERR_NO_CHANGE,
  TLS_FLASH_ERR_UNKNOWN,
  TLS_FLASH_OK,
  TLS_FLASH_OK_NO_CHANGE,
  TLS_FLASH_ERR_CORRUPT,
  TLS_FLASH_ERR_NO_CHANGE,
  TLS_FLASH_ERR_UNKNOWN
}
 

Functions

 _Static_assert ((sizeof(tstrTlsCrlEntry)%4)==0,"Structure alignment error")
 

This enum contains WINC commands related to TLS handshake.

Enumerator
M2M_SSL_REQ_CERT_VERIF 

For internal use only during RSA signature verification.

M2M_SSL_REQ_ECC 

Request from WINC for an elliptic curve operation.

M2M_SSL_RESP_ECC 

Response to WINC with the result of an elliptic curve operation.

M2M_SSL_RSV 

Reserved.

M2M_SSL_REQ_WRITE_OWN_CERTS 

Request to WINC with local certificates to write into WINC flash.

M2M_SSL_REQ_SET_CS_LIST 

Request to WINC to set the list of ciphersuites to be globally enabled.

M2M_SSL_RESP_SET_CS_LIST 

Response from WINC with the list of ciphersuites that are globally enabled.

M2M_SSL_RESP_WRITE_OWN_CERTS 

Response from WINC to indicate that local certificates have been written into WINC flash.

M2M_SSL_REQ_CERT_VERIF 

For internal use only during RSA signature verification.

M2M_SSL_REQ_ECC 

Request from WINC for an elliptic curve operation.

M2M_SSL_RESP_ECC 

Response to WINC with the result of an elliptic curve operation.

M2M_SSL_IND_CRL 

Indication to WINC of a custom-format certificate revocation list.

M2M_SSL_REQ_WRITE_OWN_CERTS 

Request to WINC with local certificates to write into WINC flash.

M2M_SSL_REQ_SET_CS_LIST 

Request to WINC to set the list of ciphersuites to be globally enabled.

M2M_SSL_RESP_SET_CS_LIST 

Response from WINC with the list of ciphersuites that are globally enabled.

M2M_SSL_RESP_WRITE_OWN_CERTS 

Response from WINC to indicate that local certificates have been written into WINC flash.

Enumerator
M2M_SSL_REQ_CERT_VERIF 

For internal use only during RSA signature verification.

M2M_SSL_REQ_ECC 

Request from WINC for an elliptic curve operation.

M2M_SSL_RESP_ECC 

Response to WINC with the result of an elliptic curve operation.

M2M_SSL_RSV 

Reserved.

M2M_SSL_REQ_WRITE_OWN_CERTS 

Request to WINC with local certificates to write into WINC flash.

M2M_SSL_REQ_SET_CS_LIST 

Request to WINC to set the list of ciphersuites to be globally enabled.

M2M_SSL_RESP_SET_CS_LIST 

Response from WINC with the list of ciphersuites that are globally enabled.

M2M_SSL_RESP_WRITE_OWN_CERTS 

Response from WINC to indicate that local certificates have been written into WINC flash.

M2M_SSL_REQ_CERT_VERIF 

For internal use only during RSA signature verification.

M2M_SSL_REQ_ECC 

Request from WINC for an elliptic curve operation.

M2M_SSL_RESP_ECC 

Response to WINC with the result of an elliptic curve operation.

M2M_SSL_IND_CRL 

Indication to WINC of a custom-format certificate revocation list.

M2M_SSL_REQ_WRITE_OWN_CERTS 

Request to WINC with local certificates to write into WINC flash.

M2M_SSL_REQ_SET_CS_LIST 

Request to WINC to set the list of ciphersuites to be globally enabled.

M2M_SSL_RESP_SET_CS_LIST 

Response from WINC with the list of ciphersuites that are globally enabled.

M2M_SSL_RESP_WRITE_OWN_CERTS 

Response from WINC to indicate that local certificates have been written into WINC flash.

SSL Certificate Expiry Validation Options.

Enumerator
SSL_CERT_EXP_CHECK_DISABLE 

ALWAYS OFF. Ignore certificate expiration date validation. If a certificate is expired or there is no configured system time, the SSL connection SUCCEEDs.

SSL_CERT_EXP_CHECK_ENABLE 

ALWAYS ON. Validate certificate expiration date. If a certificate is expired or there is no configured system time, the SSL connection FAILs.

SSL_CERT_EXP_CHECK_EN_IF_SYS_TIME 

CONDITIONAL VALIDATION (Default setting at startup). Validate the certificate expiration date only if there is a configured system time. If there is no configured system time, the certificate expiration is bypassed and the SSL connection SUCCEEDs.

Enumerator
TLS_FLASH_OK 

Operation succeeded. Flash modified.

TLS_FLASH_OK_NO_CHANGE 

Operation was unnecessary. Flash not modified.

TLS_FLASH_ERR_CORRUPT 

Operation failed. Flash modified.

TLS_FLASH_ERR_NO_CHANGE 

Operation failed. Flash not modified.

TLS_FLASH_ERR_UNKNOWN 

Operation failed. Flash status unknown.

TLS_FLASH_OK 

Operation succeeded. Flash modified.

TLS_FLASH_OK_NO_CHANGE 

Operation was unnecessary. Flash not modified.

TLS_FLASH_ERR_CORRUPT 

Operation failed. Flash modified.

TLS_FLASH_ERR_NO_CHANGE 

Operation failed. Flash not modified.

TLS_FLASH_ERR_UNKNOWN 

Operation failed. Flash status unknown.

Enumerator
TLS_FLASH_OK 

Operation succeeded. Flash modified.

TLS_FLASH_OK_NO_CHANGE 

Operation was unnecessary. Flash not modified.

TLS_FLASH_ERR_CORRUPT 

Operation failed. Flash modified.

TLS_FLASH_ERR_NO_CHANGE 

Operation failed. Flash not modified.

TLS_FLASH_ERR_UNKNOWN 

Operation failed. Flash status unknown.

TLS_FLASH_OK 

Operation succeeded. Flash modified.

TLS_FLASH_OK_NO_CHANGE 

Operation was unnecessary. Flash not modified.

TLS_FLASH_ERR_CORRUPT 

Operation failed. Flash modified.

TLS_FLASH_ERR_NO_CHANGE 

Operation failed. Flash not modified.

TLS_FLASH_ERR_UNKNOWN 

Operation failed. Flash status unknown.

_Static_assert ( (sizeof(tstrTlsCrlEntry)%4)  = =0,
"Structure alignment error"   
)