316 lines
10 KiB
C
316 lines
10 KiB
C
/* test main.c
|
|
*
|
|
* Copyright (C) 2006-2025 wolfSSL Inc.
|
|
*
|
|
* This file is part of wolfSSL.
|
|
*
|
|
* wolfSSL is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* wolfSSL is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
|
|
*/
|
|
|
|
/* ESP-IDF */
|
|
#include <esp_log.h>
|
|
#include "sdkconfig.h"
|
|
|
|
/* wolfSSL */
|
|
/* Always include wolfcrypt/settings.h before any other wolfSSL file. */
|
|
/* Reminder: settings.h pulls in user_settings.h; don't include it here. */
|
|
#if defined(WOLFSSL_USER_SETTINGS)
|
|
#include <wolfssl/wolfcrypt/settings.h>
|
|
#if defined(WOLFSSL_ESPIDF)
|
|
#include <wolfssl/version.h>
|
|
#include <wolfssl/wolfcrypt/types.h>
|
|
#include <wolfcrypt/test/test.h>
|
|
#include <wolfssl/wolfcrypt/port/Espressif/esp-sdk-lib.h>
|
|
#include <wolfssl/wolfcrypt/port/Espressif/esp32-crypt.h>
|
|
#else
|
|
#error "Problem with wolfSSL user_settings. " \
|
|
"Check components/wolfssl/include " \
|
|
"and confirm WOLFSSL_USER_SETTINGS is defined, " \
|
|
"typically in the component CMakeLists.txt"
|
|
#endif
|
|
#else
|
|
/* Define WOLFSSL_USER_SETTINGS project wide for settings.h to include */
|
|
/* wolfSSL user settings in ./components/wolfssl/include/user_settings.h */
|
|
#error "Missing WOLFSSL_USER_SETTINGS in CMakeLists or Makefile:\
|
|
CFLAGS +=-DWOLFSSL_USER_SETTINGS"
|
|
#endif
|
|
|
|
/* Hardware; include after other libraries,
|
|
* particularly after freeRTOS from settings.h */
|
|
#include <driver/uart.h>
|
|
|
|
/* set to 0 for one test,
|
|
** set to 1 for continuous test loop */
|
|
#define TEST_LOOP 0
|
|
|
|
#define THIS_MONITOR_UART_RX_BUFFER_SIZE 200
|
|
|
|
#ifdef CONFIG_ESP8266_XTAL_FREQ_26
|
|
/* 26MHz crystal: 74880 bps */
|
|
#define THIS_MONITOR_UART_BAUD_DATE 74880
|
|
#else
|
|
/* 40MHz crystal: 115200 bps */
|
|
#define THIS_MONITOR_UART_BAUD_DATE 115200
|
|
#endif
|
|
|
|
/*
|
|
** the wolfssl component can be installed in either:
|
|
**
|
|
** - the ESP-IDF component directory
|
|
**
|
|
** ** OR **
|
|
**
|
|
** - the local project component directory
|
|
**
|
|
** it is not recommended to install in both.
|
|
**
|
|
*/
|
|
|
|
/*
|
|
** although the wolfcrypt/test includes a default time setting,
|
|
** see the enclosed optional time helper for adding NNTP.
|
|
** be sure to add "time_helper.c" in main/CMakeLists.txt
|
|
*/
|
|
#undef WOLFSSL_USE_TIME_HELPER
|
|
#if defined(WOLFSSL_USE_TIME_HELPER)
|
|
#include "time_helper.h"
|
|
#endif
|
|
|
|
/* see wolfssl/wolfcrypt/test/test.h */
|
|
extern void wolf_crypt_task();
|
|
|
|
static const char* const TAG = "wolfssl_test";
|
|
|
|
#if defined(WOLFSSL_ESPWROOM32SE) && defined(HAVE_PK_CALLBACKS) \
|
|
&& defined(WOLFSSL_ATECC508A)
|
|
|
|
#include "wolfssl/wolfcrypt/port/atmel/atmel.h"
|
|
|
|
/* when you need to use a custom slot allocation, */
|
|
/* enable the definition CUSTOM_SLOT_ALLOCAION. */
|
|
#if defined(CUSTOM_SLOT_ALLOCATION)
|
|
|
|
static byte mSlotList[ATECC_MAX_SLOT];
|
|
|
|
/* initialize slot array */
|
|
void my_atmel_slotInit()
|
|
{
|
|
int i;
|
|
for (i = 0; i < ATECC_MAX_SLOT; i++) {
|
|
mSlotList[i] = ATECC_INVALID_SLOT;
|
|
}
|
|
}
|
|
|
|
/* allocate slot depending on slotType */
|
|
int my_atmel_alloc(int slotType)
|
|
{
|
|
int i, slot = ATECC_INVALID_SLOT;
|
|
|
|
switch (slotType) {
|
|
case ATMEL_SLOT_ENCKEY:
|
|
slot = 4;
|
|
break;
|
|
case ATMEL_SLOT_DEVICE:
|
|
slot = 0;
|
|
break;
|
|
case ATMEL_SLOT_ECDHE:
|
|
slot = 0;
|
|
break;
|
|
case ATMEL_SLOT_ECDHE_ENC:
|
|
slot = 4;
|
|
break;
|
|
case ATMEL_SLOT_ANY:
|
|
for (i = 0; i < ATECC_MAX_SLOT; i++) {
|
|
if (mSlotList[i] == ATECC_INVALID_SLOT) {
|
|
slot = i;
|
|
break;
|
|
} /* if */
|
|
} /* for */
|
|
} /* switch */
|
|
|
|
return slot;
|
|
}
|
|
|
|
/* free slot array */
|
|
void my_atmel_free(int slotId)
|
|
{
|
|
if (slotId >= 0 && slotId < ATECC_MAX_SLOT) {
|
|
mSlotList[slotId] = ATECC_INVALID_SLOT;
|
|
}
|
|
}
|
|
|
|
#endif /* CUSTOM_SLOT_ALLOCATION */
|
|
#endif /* WOLFSSL_ESPWROOM32SE && HAVE_PK_CALLBACK && WOLFSSL_ATECC508A */
|
|
|
|
/* entry point */
|
|
void app_main(void)
|
|
{
|
|
uart_config_t uart_config = {
|
|
.baud_rate = THIS_MONITOR_UART_BAUD_DATE,
|
|
.data_bits = UART_DATA_8_BITS,
|
|
.parity = UART_PARITY_DISABLE,
|
|
.stop_bits = UART_STOP_BITS_1,
|
|
};
|
|
int stack_start = 0;
|
|
int heap_start = 0;
|
|
int heap_current = 0;
|
|
int loops = 0;
|
|
esp_err_t ret = 0;
|
|
|
|
stack_start = esp_sdk_stack_pointer();
|
|
|
|
/* uart_set_pin(UART_NUM_0, TX_PIN, RX_PIN,
|
|
* UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE); */
|
|
|
|
/* Some targets may need to have UART speed set, such as ESP8266 */
|
|
ESP_LOGI(TAG, "UART init");
|
|
uart_param_config(UART_NUM_0, &uart_config);
|
|
uart_driver_install(UART_NUM_0,
|
|
THIS_MONITOR_UART_RX_BUFFER_SIZE, 0, 0, NULL, 0);
|
|
|
|
ESP_LOGI(TAG, "------------------ wolfSSL Test Example ----------------");
|
|
ESP_LOGI(TAG, "--------------------------------------------------------");
|
|
ESP_LOGI(TAG, "--------------------------------------------------------");
|
|
ESP_LOGI(TAG, "---------------------- BEGIN MAIN ----------------------");
|
|
ESP_LOGI(TAG, "--------------------------------------------------------");
|
|
ESP_LOGI(TAG, "--------------------------------------------------------");
|
|
ESP_LOGI(TAG, "Stack Start: 0x%x", stack_start);
|
|
|
|
#ifdef WOLFSSL_ESP_NO_WATCHDOG
|
|
ESP_LOGW(TAG, "Found WOLFSSL_ESP_NO_WATCHDOG, disabling...");
|
|
esp_DisableWatchdog();
|
|
#endif
|
|
|
|
#ifdef ESP_TASK_MAIN_STACK
|
|
ESP_LOGI(TAG, "ESP_TASK_MAIN_STACK: %d", ESP_TASK_MAIN_STACK);
|
|
#endif
|
|
#ifdef TASK_EXTRA_STACK_SIZE
|
|
ESP_LOGI(TAG, "TASK_EXTRA_STACK_SIZE: %d", TASK_EXTRA_STACK_SIZE);
|
|
#endif
|
|
|
|
#ifdef INCLUDE_uxTaskGetStackHighWaterMark
|
|
ESP_LOGI(TAG, "CONFIG_ESP_MAIN_TASK_STACK_SIZE = %d bytes (%d words)",
|
|
CONFIG_ESP_MAIN_TASK_STACK_SIZE,
|
|
(int)(CONFIG_ESP_MAIN_TASK_STACK_SIZE / sizeof(void*)));
|
|
|
|
/* Returns the high water mark of the stack associated with xTask. That is,
|
|
* the minimum free stack space there has been (in bytes not words, unlike
|
|
* vanilla FreeRTOS) since the task started. The smaller the returned
|
|
* number the closer the task has come to overflowing its stack.
|
|
* see Espressif esp32/api-reference/system/freertos_idf.html
|
|
*/
|
|
stack_start = uxTaskGetStackHighWaterMark(NULL);
|
|
ESP_LOGI(TAG, "Stack Start HWM: %d bytes", stack_start);
|
|
#endif
|
|
|
|
#if defined(HAVE_VERSION_EXTENDED_INFO)
|
|
esp_ShowExtendedSystemInfo();
|
|
#endif
|
|
|
|
/* all platforms: stack high water mark check */
|
|
ESP_LOGI(TAG, "Stack HWM: %d\n", uxTaskGetStackHighWaterMark(NULL));
|
|
|
|
#if defined (WOLFSSL_USE_TIME_HELPER)
|
|
set_time();
|
|
#endif
|
|
|
|
/* when using atecc608a on esp32-WROOM-32se */
|
|
#if defined(WOLFSSL_ESPWROOM32SE) && defined(HAVE_PK_CALLBACKS) \
|
|
&& defined(WOLFSSL_ATECC508A)
|
|
#if defined(CUSTOM_SLOT_ALLOCATION)
|
|
my_atmel_slotInit();
|
|
/* to register the callback, it needs to be initialized. */
|
|
if ((wolfCrypt_Init()) != 0) {
|
|
ESP_LOGE(TAG, "wolfCrypt_Init failed");
|
|
return;
|
|
}
|
|
atmel_set_slot_allocator(my_atmel_alloc, my_atmel_free);
|
|
#endif
|
|
#endif
|
|
|
|
#ifdef NO_CRYPT_TEST
|
|
ESP_LOGI(TAG, "NO_CRYPT_TEST defined, skipping wolf_test_task");
|
|
#else
|
|
/* Although wolfCrypt_Init() may be explicitly called above,
|
|
** note it is still always called in wolf_test_task.
|
|
*/
|
|
stack_start = uxTaskGetStackHighWaterMark(NULL);
|
|
heap_start = heap_caps_get_free_size(MALLOC_CAP_8BIT);
|
|
|
|
do {
|
|
heap_current = heap_caps_get_free_size(MALLOC_CAP_8BIT);
|
|
ESP_LOGI(TAG, "Free heap memory: %d bytes; Start %d",
|
|
heap_current, heap_start);
|
|
ESP_LOGI(TAG, "Stack HWM: %d\n", uxTaskGetStackHighWaterMark(NULL));
|
|
|
|
ret = wolf_test_task();
|
|
#if defined(WOLFSSL_ESP32_CRYPT_RSA_PRI) && defined(WOLFSSL_HW_METRICS)
|
|
esp_hw_show_metrics();
|
|
#endif
|
|
loops++; /* count of the number of tests run before fail. */
|
|
ESP_LOGI(TAG, "Stack HWM: %d\n", uxTaskGetStackHighWaterMark(NULL));
|
|
ESP_LOGI(TAG, "loops = %d", loops);
|
|
|
|
} while (TEST_LOOP && (ret == 0));
|
|
|
|
/* Reminder: wolfCrypt_Cleanup() should always be called at completion,
|
|
** and is called in wolf_test_task(). */
|
|
|
|
#if defined TEST_LOOP && (TEST_LOOP == 1)
|
|
ESP_LOGI(TAG, "Test loops completed: %d", loops);
|
|
#endif
|
|
|
|
#if defined(SINGLE_THREADED)
|
|
/* need stack monitor for single thread */
|
|
#else
|
|
ESP_LOGI(TAG, "Stack HWM: %d\n", uxTaskGetStackHighWaterMark(NULL));
|
|
#endif
|
|
|
|
#if defined(WOLFSSL_HW_METRICS) && defined(WOLFSSL_ESP32_CRYPT_RSA_PRI)
|
|
esp_hw_show_mp_metrics();
|
|
#endif
|
|
|
|
#ifdef INCLUDE_uxTaskGetStackHighWaterMark
|
|
ESP_LOGI(TAG, "Stack HWM: %d", uxTaskGetStackHighWaterMark(NULL));
|
|
|
|
ESP_LOGI(TAG, "Stack used: %d", CONFIG_ESP_MAIN_TASK_STACK_SIZE
|
|
- (uxTaskGetStackHighWaterMark(NULL)));
|
|
#endif
|
|
|
|
#ifdef WOLFSSL_ESPIDF_VERBOSE_EXIT_MESSAGE
|
|
if (ret == 0) {
|
|
ESP_LOGI(TAG, WOLFSSL_ESPIDF_VERBOSE_EXIT_MESSAGE("Success!", ret));
|
|
}
|
|
else {
|
|
ESP_LOGE(TAG, WOLFSSL_ESPIDF_VERBOSE_EXIT_MESSAGE("Failed!", ret));
|
|
}
|
|
#elif defined(WOLFSSL_ESPIDF_EXIT_MESSAGE)
|
|
ESP_LOGI(TAG, WOLFSSL_ESPIDF_EXIT_MESSAGE);
|
|
#else
|
|
ESP_LOGI(TAG, "\n\nDone!\n\n"
|
|
"If running from idf.py monitor, press twice: Ctrl+]");
|
|
#endif
|
|
|
|
/* After completion, we'll just wait */
|
|
while (1) {
|
|
#if defined(SINGLE_THREADED)
|
|
while (1);
|
|
#else
|
|
vTaskDelay(60000);
|
|
#endif
|
|
} /* done while */
|
|
#endif
|
|
}
|