esp-tls: add support for using hardware security module

components/cryptoauthlib/component.mk

@@ -29,7 +29,7 @@ COMPONENT_OBJEXCLUDE := $(CRYPTOAUTHLIB_DIR)/atca_cfgs.o
 # Add the hal directory back in for source search paths
 COMPONENT_SRCDIRS += $(CRYPTOAUTHLIB_DIR)/hal
 
-COMPONENT_ADD_INCLUDEDIRS := $(CRYPTOAUTHLIB_DIR) $(CRYPTOAUTHLIB_DIR)/hal
+COMPONENT_ADD_INCLUDEDIRS := $(CRYPTOAUTHLIB_DIR) $(CRYPTOAUTHLIB_DIR)/hal port
 
 # Library requires some global defines
 CFLAGS+=-DESP32 -DATCA_HAL_I2C -DATCA_USE_RTOS_TIMER

components/cryptoauthlib/port/cert_def_1_signer.c

@@ -0,0 +1,151 @@
+
+#include "atcacert/atcacert_def.h"
+
+const atcacert_def_t g_cert_def_0_root = {
+    .public_key_dev_loc     = {
+        .zone      = DEVZONE_DATA,
+        .slot      = 15,
+        .is_genkey = 0,
+        .offset    = 0,
+        .count     = 72
+    }
+};
+
+const atcacert_cert_element_t g_cert_elements_1_signer[] = {
+    {
+        .id         = "IssueDate",
+        .device_loc = {
+            .zone      = DEVZONE_DATA,
+            .slot      = 14,
+            .is_genkey = 0,
+            .offset    = 35-13,
+            .count     = 13
+        },
+        .cert_loc   = {
+            .offset = 97,
+            .count  = 13
+        }
+    },
+    {
+        .id         = "ExpireDate",
+        .device_loc = {
+            .zone      = DEVZONE_DATA,
+            .slot      = 14,
+            .is_genkey = 0,
+            .offset    = 50-13,
+            .count     = 13
+        },
+        .cert_loc   = {
+            .offset = 112,
+            .count  = 13
+        }
+    }
+};
+
+const uint8_t g_cert_template_1_signer[] = {
+    0x30, 0x82, 0x01, 0xc8, 0x30, 0x82, 0x01, 0x6e,  0xa0, 0x03, 0x02, 0x01, 0x02, 0x02, 0x10, 0x57,
+    0x06, 0x2e, 0xf0, 0x05, 0xea, 0x8a, 0x70, 0x44,  0xff, 0x1b, 0x90, 0x00, 0x21, 0x78, 0xd6, 0x30,
+    0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d,  0x04, 0x03, 0x02, 0x30, 0x30, 0x31, 0x14, 0x30,
+    0x12, 0x06, 0x03, 0x55, 0x04, 0x0a, 0x0c, 0x0b,  0x45, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x20,
+    0x49, 0x6e, 0x63, 0x31, 0x18, 0x30, 0x16, 0x06,  0x03, 0x55, 0x04, 0x03, 0x0c, 0x0f, 0x45, 0x78,
+    0x61, 0x6d, 0x70, 0x6c, 0x65, 0x20, 0x52, 0x6f,  0x6f, 0x74, 0x20, 0x43, 0x41, 0x30, 0x1e, 0x17,
+    0x0d, 0x31, 0x37, 0x30, 0x36, 0x30, 0x37, 0x31,  0x37, 0x35, 0x36, 0x31, 0x32, 0x5a, 0x17, 0x0d,
+    0x32, 0x37, 0x30, 0x36, 0x30, 0x37, 0x31, 0x37,  0x35, 0x36, 0x31, 0x32, 0x5a, 0x30, 0x34, 0x31,
+    0x14, 0x30, 0x12, 0x06, 0x03, 0x55, 0x04, 0x0a,  0x0c, 0x0b, 0x45, 0x78, 0x61, 0x6d, 0x70, 0x6c,
+    0x65, 0x20, 0x49, 0x6e, 0x63, 0x31, 0x1c, 0x30,  0x1a, 0x06, 0x03, 0x55, 0x04, 0x03, 0x0c, 0x13,
+    0x45, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x20,  0x53, 0x69, 0x67, 0x6e, 0x65, 0x72, 0x20, 0x46,
+    0x46, 0x46, 0x46, 0x30, 0x59, 0x30, 0x13, 0x06,  0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02, 0x01,
+    0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x03,  0x01, 0x07, 0x03, 0x42, 0x00, 0x04, 0xb1, 0xf5,
+    0x9c, 0xbe, 0x22, 0x11, 0x7f, 0x28, 0x2f, 0x7f,  0x2e, 0xcb, 0xa2, 0x8c, 0x30, 0x3b, 0xae, 0x59,
+    0x45, 0xb9, 0x5c, 0x0e, 0xba, 0xaa, 0x9b, 0x81,  0x73, 0x52, 0x63, 0x41, 0xbf, 0x37, 0x3c, 0x2e,
+    0xdd, 0xcd, 0xea, 0x0e, 0x7c, 0x9d, 0x90, 0xea,  0x25, 0x9c, 0x64, 0xeb, 0xc6, 0x54, 0x47, 0x32,
+    0x81, 0x63, 0xbf, 0x42, 0x5f, 0xdd, 0x5a, 0x3f,  0xd5, 0x71, 0x81, 0x9b, 0x77, 0x44, 0xa3, 0x66,
+    0x30, 0x64, 0x30, 0x12, 0x06, 0x03, 0x55, 0x1d,  0x13, 0x01, 0x01, 0xff, 0x04, 0x08, 0x30, 0x06,
+    0x01, 0x01, 0xff, 0x02, 0x01, 0x00, 0x30, 0x0e,  0x06, 0x03, 0x55, 0x1d, 0x0f, 0x01, 0x01, 0xff,
+    0x04, 0x04, 0x03, 0x02, 0x01, 0x86, 0x30, 0x1d,  0x06, 0x03, 0x55, 0x1d, 0x0e, 0x04, 0x16, 0x04,
+    0x14, 0x81, 0x1d, 0xc6, 0x7c, 0x0f, 0x18, 0x2b,  0x65, 0x96, 0xeb, 0x22, 0x73, 0xdb, 0xf3, 0x23,
+    0x63, 0x6d, 0x79, 0x0f, 0xc8, 0x30, 0x1f, 0x06,  0x03, 0x55, 0x1d, 0x23, 0x04, 0x18, 0x30, 0x16,
+    0x80, 0x14, 0xdb, 0x2a, 0x0d, 0x06, 0x05, 0xc7,  0x98, 0xbc, 0xda, 0xc0, 0x34, 0x67, 0x66, 0xf4,
+    0xe2, 0xb0, 0x61, 0xa3, 0xd2, 0xc8, 0x30, 0x0a,  0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x04,
+    0x03, 0x02, 0x03, 0x48, 0x00, 0x30, 0x45, 0x02,  0x20, 0x49, 0xfe, 0xdf, 0xc9, 0x94, 0xe3, 0x07,
+    0xdb, 0x08, 0xb3, 0x99, 0x9e, 0x04, 0xe4, 0x78,  0xe5, 0xf8, 0xb9, 0x09, 0xa9, 0xf0, 0x41, 0x66,
+    0xc6, 0x69, 0x1b, 0x87, 0x30, 0x86, 0x10, 0xaf,  0x64, 0x02, 0x21, 0x00, 0xc8, 0xd6, 0x86, 0x61,
+    0x94, 0x95, 0xdb, 0x45, 0xb3, 0x40, 0x8e, 0xac,  0x14, 0x9a, 0x19, 0xb6, 0x8c, 0x5c, 0x79, 0x9d,
+    0x06, 0xcb, 0x52, 0x08, 0xa0, 0x1f, 0x49, 0x8b,  0x22, 0x4e, 0x52, 0x71
+};
+
+const atcacert_def_t g_cert_def_1_signer = {
+    .type                   = CERTTYPE_X509,
+    .template_id            = 1,
+    .chain_id               = 0,
+    .private_key_slot       = 0,
+    .sn_source              = SNSRC_STORED,
+    .cert_sn_dev_loc        = { 
+        .zone      = DEVZONE_DATA,
+        .slot      = 14,
+        .is_genkey = 0,
+        .offset    = 20-16,
+        .count     = 16
+    },
+    .issue_date_format      = DATEFMT_RFC5280_UTC,
+    .expire_date_format     = DATEFMT_RFC5280_UTC,
+    .tbs_cert_loc           = {
+        .offset = 4,
+        .count  = 370
+    },
+    .expire_years           = 10,
+    .public_key_dev_loc     = {
+        .zone      = DEVZONE_DATA,
+        .slot      = 11,
+        .is_genkey = 0,
+        .offset    = 0,
+        .count     = 72
+    },
+    .comp_cert_dev_loc      = {
+        .zone      = DEVZONE_DATA,
+        .slot      = 12,
+        .is_genkey = 0,
+        .offset    = 0,
+        .count     = 72
+    },
+    .std_cert_elements      = {
+        { // STDCERT_PUBLIC_KEY
+            .offset = 206,
+            .count  = 64
+        },
+        { // STDCERT_SIGNATURE
+            .offset = 386,
+            .count  = 74
+        },
+        { // STDCERT_ISSUE_DATE
+            .offset = 97,
+            .count  = 13
+        },
+        { // STDCERT_EXPIRE_DATE
+            .offset = 112,
+            .count  = 13
+        },
+        { // STDCERT_SIGNER_ID
+            .offset = 175,
+            .count  = 4
+        },
+        { // STDCERT_CERT_SN
+            .offset = 15,
+            .count  = 16
+        },
+        { // STDCERT_AUTH_KEY_ID
+            .offset = 354,
+            .count  = 20
+        },
+        { // STDCERT_SUBJ_KEY_ID
+            .offset = 321,
+            .count  = 20
+        }
+    },
+    .cert_elements          = g_cert_elements_1_signer,
+    .cert_elements_count    = sizeof(g_cert_elements_1_signer) / sizeof(g_cert_elements_1_signer[0]),
+    .cert_template          = g_cert_template_1_signer,
+    .cert_template_size     = sizeof(g_cert_template_1_signer),
+    .ca_cert_def            = &g_cert_def_0_root
+};
+

components/cryptoauthlib/port/cert_def_1_signer.h

@@ -0,0 +1,18 @@
+#ifndef CERT_DEF_1_SIGNER_H
+#define CERT_DEF_1_SIGNER_H
+
+#include "atcacert/atcacert_def.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern const atcacert_def_t g_cert_def_0_root;
+
+extern const atcacert_def_t g_cert_def_1_signer;
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // CERT_DEF_1_SIGNER_H

components/cryptoauthlib/port/cert_def_2_device.c

@@ -0,0 +1,109 @@
+
+#include "atcacert/atcacert_def.h"
+#include "cert_def_1_signer.h"
+
+const uint8_t g_cert_template_2_device[] = {
+    0x30, 0x82, 0x01, 0xa6, 0x30, 0x82, 0x01, 0x4b,  0xa0, 0x03, 0x02, 0x01, 0x02, 0x02, 0x10, 0x41,
+    0xa6, 0x8b, 0xe4, 0x36, 0xdd, 0xc3, 0xd8, 0x39,  0xfa, 0xbd, 0xd7, 0x27, 0xd9, 0x74, 0xe7, 0x30,
+    0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d,  0x04, 0x03, 0x02, 0x30, 0x34, 0x31, 0x14, 0x30,
+    0x12, 0x06, 0x03, 0x55, 0x04, 0x0a, 0x0c, 0x0b,  0x45, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x20,
+    0x49, 0x6e, 0x63, 0x31, 0x1c, 0x30, 0x1a, 0x06,  0x03, 0x55, 0x04, 0x03, 0x0c, 0x13, 0x45, 0x78,
+    0x61, 0x6d, 0x70, 0x6c, 0x65, 0x20, 0x53, 0x69,  0x67, 0x6e, 0x65, 0x72, 0x20, 0x46, 0x46, 0x46,
+    0x46, 0x30, 0x20, 0x17, 0x0d, 0x31, 0x37, 0x30,  0x37, 0x31, 0x30, 0x32, 0x30, 0x30, 0x30, 0x30,
+    0x30, 0x5a, 0x18, 0x0f, 0x33, 0x30, 0x30, 0x30,  0x31, 0x32, 0x33, 0x31, 0x32, 0x33, 0x35, 0x39,
+    0x35, 0x39, 0x5a, 0x30, 0x2f, 0x31, 0x14, 0x30,  0x12, 0x06, 0x03, 0x55, 0x04, 0x0a, 0x0c, 0x0b,
+    0x45, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x20,  0x49, 0x6e, 0x63, 0x31, 0x17, 0x30, 0x15, 0x06,
+    0x03, 0x55, 0x04, 0x03, 0x0c, 0x0e, 0x45, 0x78,  0x61, 0x6d, 0x70, 0x6c, 0x65, 0x20, 0x44, 0x65,
+    0x76, 0x69, 0x63, 0x65, 0x30, 0x59, 0x30, 0x13,  0x06, 0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02,
+    0x01, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d,  0x03, 0x01, 0x07, 0x03, 0x42, 0x00, 0x04, 0x96,
+    0x27, 0xf1, 0x3e, 0x80, 0xac, 0xf9, 0xd4, 0x12,  0xce, 0x3b, 0x0d, 0x68, 0xf7, 0x4e, 0xb2, 0xc6,
+    0x07, 0x35, 0x00, 0xb7, 0x78, 0x5b, 0xac, 0xe6,  0x50, 0x30, 0x54, 0x77, 0x7f, 0xc8, 0x62, 0x21,
+    0xce, 0xf2, 0x5a, 0x9a, 0x9e, 0x86, 0x40, 0xc2,  0x29, 0xd6, 0x4a, 0x32, 0x1e, 0xb9, 0x4a, 0x1b,
+    0x1c, 0x94, 0xf5, 0x39, 0x88, 0xae, 0xfe, 0x49,  0xcc, 0xfd, 0xbf, 0x8a, 0x0d, 0x34, 0xb8, 0xa3,
+    0x42, 0x30, 0x40, 0x30, 0x1d, 0x06, 0x03, 0x55,  0x1d, 0x0e, 0x04, 0x16, 0x04, 0x14, 0x2d, 0xda,
+    0x6c, 0x36, 0xd5, 0xa5, 0x5a, 0xce, 0x97, 0x10,  0x3d, 0xbb, 0xaf, 0x9c, 0x66, 0x2a, 0xcd, 0x3e,
+    0xe6, 0xcf, 0x30, 0x1f, 0x06, 0x03, 0x55, 0x1d,  0x23, 0x04, 0x18, 0x30, 0x16, 0x80, 0x14, 0xc6,
+    0x70, 0xe0, 0x5e, 0x8a, 0x45, 0x0d, 0xb8, 0x2c,  0x00, 0x2a, 0x40, 0x06, 0x39, 0x4c, 0x19, 0x58,
+    0x04, 0x35, 0x76, 0x30, 0x0a, 0x06, 0x08, 0x2a,  0x86, 0x48, 0xce, 0x3d, 0x04, 0x03, 0x02, 0x03,
+    0x49, 0x00, 0x30, 0x46, 0x02, 0x21, 0x00, 0xe1,  0xfc, 0x00, 0x23, 0xc1, 0x3d, 0x01, 0x3f, 0x22,
+    0x31, 0x0b, 0xf0, 0xb8, 0xf4, 0xf4, 0x22, 0xfc,  0x95, 0x96, 0x33, 0x9c, 0xb9, 0x62, 0xb1, 0xfc,
+    0x8a, 0x2d, 0xa8, 0x5c, 0xee, 0x67, 0x72, 0x02,  0x21, 0x00, 0xa1, 0x0d, 0x47, 0xe4, 0xfd, 0x0d,
+    0x15, 0xd8, 0xde, 0xa1, 0xb5, 0x96, 0x28, 0x4e,  0x7a, 0x0b, 0xbe, 0xcc, 0xec, 0xe8, 0x8e, 0xcc,
+    0x7a, 0x31, 0xb3, 0x00, 0x8b, 0xc0, 0x2e, 0x4f,  0x99, 0xc5
+};
+
+const atcacert_def_t g_cert_def_2_device = {
+    .type                   = CERTTYPE_X509,
+    .template_id            = 2,
+    .chain_id               = 0,
+    .private_key_slot       = 0,
+    .sn_source              = SNSRC_PUB_KEY_HASH,
+    .cert_sn_dev_loc        = { 
+        .zone      = DEVZONE_NONE,
+        .slot      = 0,
+        .is_genkey = 0,
+        .offset    = 0,
+        .count     = 0
+    },
+    .issue_date_format      = DATEFMT_RFC5280_UTC,
+    .expire_date_format     = DATEFMT_RFC5280_GEN,
+    .tbs_cert_loc           = {
+        .offset = 4,
+        .count  = 335
+    },
+    .expire_years           = 0,
+    .public_key_dev_loc     = {
+        .zone      = DEVZONE_DATA,
+        .slot      = 0,
+        .is_genkey = 1,
+        .offset    = 0,
+        .count     = 64
+    },
+    .comp_cert_dev_loc      = {
+        .zone      = DEVZONE_DATA,
+        .slot      = 10,
+        .is_genkey = 0,
+        .offset    = 0,
+        .count     = 72
+    },
+    .std_cert_elements      = {
+        { // STDCERT_PUBLIC_KEY
+            .offset = 207,
+            .count  = 64
+        },
+        { // STDCERT_SIGNATURE
+            .offset = 351,
+            .count  = 75
+        },
+        { // STDCERT_ISSUE_DATE
+            .offset = 101,
+            .count  = 13
+        },
+        { // STDCERT_EXPIRE_DATE
+            .offset = 0,
+            .count  = 0
+        },
+        { // STDCERT_SIGNER_ID
+            .offset = 93,
+            .count  = 4
+        },
+        { // STDCERT_CERT_SN
+            .offset = 15,
+            .count  = 16
+        },
+        { // STDCERT_AUTH_KEY_ID
+            .offset = 319,
+            .count  = 20
+        },
+        { // STDCERT_SUBJ_KEY_ID
+            .offset = 286,
+            .count  = 20
+        }
+    },
+    .cert_elements          = NULL,
+    .cert_elements_count    = 0,
+    .cert_template          = g_cert_template_2_device,
+    .cert_template_size     = sizeof(g_cert_template_2_device),
+    .ca_cert_def            = &g_cert_def_1_signer
+};
+

components/cryptoauthlib/port/cert_def_2_device.h

@@ -0,0 +1,16 @@
+#ifndef CERT_DEF_2_DEVICE_H
+#define CERT_DEF_2_DEVICE_H
+
+#include "atcacert/atcacert_def.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern const atcacert_def_t g_cert_def_2_device;
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // CERT_DEF_2_DEVICE_H

components/esp-tls/esp_tls.h

@@ -183,6 +183,9 @@ typedef struct esp_tls_cfg {
                                                  underneath socket will be configured in non
                                                  blocking mode after tls session is established */
 
+    bool use_hsm;                           /*!< Enable this option to use Hardware Security Module or ATECC chip
+                                              ( available on WROOM32SE )*/
+
     int timeout_ms;                         /*!< Network timeout in milliseconds */
 
     bool use_global_ca_store;               /*!< Use a global ca_store for all the connections in which

components/esp-tls/esp_tls_mbedtls.c

@@ -30,6 +30,12 @@
 #include "esp_crt_bundle.h"
 #endif
 
+/* cryptoauthlib includes */
+#include "mbedtls/atca_mbedtls_wrap.h"
+#include "cryptoauthlib.h"
+#include "cert_def_1_signer.h"
+#include "cert_def_2_device.h"
+
 
 static const char *TAG = "esp-tls-mbedtls";
 static mbedtls_x509_crt *global_cacert = NULL;
@@ -448,7 +454,38 @@ esp_err_t set_client_config(const char *hostname, size_t hostlen, esp_tls_cfg_t
         mbedtls_ssl_conf_authmode(&tls->conf, MBEDTLS_SSL_VERIFY_NONE);
     }
 
-    if (cfg->clientcert_buf != NULL && cfg->clientkey_buf != NULL) {
+    if (cfg->use_hsm) {
+        ESP_LOGI(TAG, "Initialize the ATECC interface...");
+        if(0 != (ret = atcab_init(&cfg_ateccx08a_i2c_default))) {
+            ESP_LOGE(TAG, "Failed\n !atcab_init returned %02x\n", ret);
+            goto exit;
+        }
+
+        /* Convert to an mbedtls key */
+        if (0 != atca_mbedtls_pk_init(&tls->clientkey, 0)) {
+            ESP_LOGE(TAG, "Failed to parse key from device\n");
+            goto exit;
+        }
+
+        mbedtls_x509_crt_init(&tls->clientcert);
+        /* Extract the device certificate and convert to mbedtls cert */
+        if (0 != atca_mbedtls_cert_add(&tls->clientcert, &g_cert_def_2_device)) {
+            ESP_LOGE(TAG, "Failed to parse cert from device\n");
+            goto exit;
+        }
+
+        /* Extract the signer certificate, convert, then attach to the chain */
+        if (0 != atca_mbedtls_cert_add(&tls->clientcert, &g_cert_def_1_signer)) {
+            ESP_LOGE(TAG, "Failed to parse cert from device\n");
+            goto exit;
+        }
+
+        if (0 != (ret = mbedtls_ssl_conf_own_cert(&tls->conf, &tls->clientcert, &tls->clientkey))) {
+            ESP_LOGE(TAG, "Failed\n ! mbedtls_ssl_conf_own_cert returned %d\r\n", ret);
+            goto exit;
+
+        }
+    } else if (cfg->clientcert_pem_buf != NULL && cfg->clientkey_pem_buf != NULL) {
         esp_tls_pki_t pki = {
             .public_cert = &tls->clientcert,
             .pk_key = &tls->clientkey,