Merge pull request #68 from tropicsquare/develop

pavelpolach321 · web-flow · commit 7cba7d13aa4d · 2025-03-27T08:44:16.000+01:00
Develop
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -15,7 +15,7 @@ option(LT_ENABLE_FW_UPDATE "Enable firmware update functions and compile firmwar
 # This switch controls if helper utilities are compiled in. In most cases this should be ON,
 # examples and tests need to have helpers utilities compiled.
 # Switch it off to compile only basic libtropic API.
-option(LT_UTILS "Compile helper function" ON)
+option(LT_HELPERS "Compile helper function" ON)
 
 # Check if cryptography provider is defined
 if(
@@ -160,7 +160,7 @@ if(LT_USE_TREZOR_CRYPTO)
     target_compile_definitions(tropic PRIVATE LT_USE_TREZOR_CRYPTO)
 endif()
 
-if(LT_UTILS)
-    target_compile_definitions(tropic PUBLIC LT_UTILS)
+if(LT_HELPERS)
+    target_compile_definitions(tropic PUBLIC LT_HELPERS)
 endif()
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,11 +1,11 @@
 # Contributing
 
-We love contributions! To make contributing simple for both sides please:
+We love contributions! To make contributing simple for both sides, please:
 
 - Open an issue
 - Describe how you would like to contribute and discuss details with us
 - Make sure your code is properly formatted
-- Make sure your comit messages follow conventional commit guidelines [link](https://www.conventionalcommits.org/en/v1.0.0/#specification)
+- Make sure your commit messages follow [Conventional Commits guidelines](https://www.conventionalcommits.org/en/v1.0.0/#specification)
 - Create pull request
 
 ### Commit messages:
diff --git a/docs/contributors.md b/docs/contributors.md
@@ -16,7 +16,9 @@ Library architecture explained: core, examples, helpers, layers, hal, …
 
 “Libtropic is standalone library expected to be used within a parent project”
 
-TBD add picture
+<a href="libtropic_arch.drawio.png" target="_blank">
+    <img src="libtropic_arch.drawio.png" alt="Secure Tropic Click" width="50%"/>
+</a>
 
 ## How to: Adding new embedded platform {#adding-new-embedded-platform}
 
diff --git a/docs/img/libtropic_arch.drawio.png b/docs/img/libtropic_arch.drawio.png
diff --git a/docs/index.md b/docs/index.md
@@ -77,7 +77,7 @@ We recommend to add libtropic as a submodule. Libtropic uses CMAKE build system,
 set(PATH_LIBTROPIC "libtropic/")
 
 # This switch will expose not only core library functions, but also helper functions
-set(LT_UTILS ON)
+set(LT_HELPERS ON)
 
 # This switch exposes also functions containing example of usage.
 # Might be a good starting point.
@@ -116,7 +116,7 @@ Libtropic is configurable with cmake options. They are either passed from parent
 # This switch controls if helper utilities are compiled in. In most cases this should be ON,
 # examples and tests need to have helpers utilities compiled.
 # Switch it off to compile only libtropic's core
--DLT_UTILS=1
+-DLT_HELPERS=1
 
 # Build libtropic documentation
 -DLT_BUILD_DOCS=1
@@ -137,7 +137,7 @@ In order to have examples exposed in your parent project, libtropic must be comp
 # This switch controls if helper utilities are compiled in. In most cases this should be ON,
 # examples and tests need to have helpers utilities compiled.
 # Switch it off to compile only libtropic's core
--DLT_UTILS=1
+-DLT_HELPERS=1
 
 # Compile libtropic also with functions containing example usage - good for initial evaluation
 -DLT_ADD_EXAMPLES=1
diff --git a/examples/libtropic_examples.h b/examples/libtropic_examples.h
@@ -1,5 +1,5 @@
-#ifndef HELLO_WORLD_EXAMPLE
-#define HELLO_WORLD_EXAMPLE
+#ifndef LT_LIBTROPIC_EXAMPLES_H
+#define LT_LIBTROPIC_EXAMPLES_H
 
 /**
  * @file TROPIC01_hw_wallet.h
diff --git a/examples/lt_ex_fw_update.c b/examples/lt_ex_fw_update.c
@@ -46,31 +46,31 @@ void print_headers(lt_handle_t *h)
 {
         LOG_OUT("  Chip contains following headers:\r\n");
         uint8_t header[LT_L2_GET_INFO_FW_HEADER_SIZE] = {0};
-        LOG_OUT("    lt_get_info_fw_bank()  FW_BANK_FW1        %s\r\n", lt_ret_verbose(lt_get_info_fw_bank(&h, FW_BANK_FW1, header, LT_L2_GET_INFO_FW_HEADER_SIZE)));
+        LOG_OUT("    lt_get_info_fw_bank()  FW_BANK_FW1        %s\r\n", lt_ret_verbose(lt_get_info_fw_bank(h, FW_BANK_FW1, header, LT_L2_GET_INFO_FW_HEADER_SIZE)));
         LOG_OUT("    Header:                                   %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\r\n", header[0], header[1], header[2], header[3],
                                                                                                                      header[4], header[5], header[6], header[7],
                                                                                                                  header[8], header[9]);
         LOG_OUT("                                              %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\r\n", header[10], header[11], header[12], header[13],
                                                                                                                  header[14], header[15], header[16], header[17],
                                                                                                                  header[18], header[19]);
 
-        LOG_OUT("    lt_get_info_fw_bank()  FW_BANK_FW2        %s\r\n", lt_ret_verbose(lt_get_info_fw_bank(&h, FW_BANK_FW2, header, LT_L2_GET_INFO_FW_HEADER_SIZE)));
+        LOG_OUT("    lt_get_info_fw_bank()  FW_BANK_FW2        %s\r\n", lt_ret_verbose(lt_get_info_fw_bank(h, FW_BANK_FW2, header, LT_L2_GET_INFO_FW_HEADER_SIZE)));
         LOG_OUT("    Header:                                   %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\r\n", header[0], header[1], header[2], header[3],
                                                                                                                  header[4], header[5], header[6], header[7],
                                                                                                                  header[8], header[9]);
         LOG_OUT("                                              %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\r\n", header[10], header[11], header[12], header[13],
                                                                                                                  header[14], header[15], header[16], header[17],
                                                                                                                  header[18], header[19]);
 
-        LOG_OUT("    lt_get_info_fw_bank()  FW_BANK_SPECT1     %s\r\n", lt_ret_verbose(lt_get_info_fw_bank(&h, FW_BANK_SPECT1, header, LT_L2_GET_INFO_FW_HEADER_SIZE)));
+        LOG_OUT("    lt_get_info_fw_bank()  FW_BANK_SPECT1     %s\r\n", lt_ret_verbose(lt_get_info_fw_bank(h, FW_BANK_SPECT1, header, LT_L2_GET_INFO_FW_HEADER_SIZE)));
         LOG_OUT("    Header:                                   %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\r\n", header[0], header[1], header[2], header[3],
                                                                                                                  header[4], header[5], header[6], header[7],
                                                                                                                  header[8], header[9]);
         LOG_OUT("                                              %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\r\n", header[10], header[11], header[12], header[13],
                                                                                                                  header[14], header[15], header[16], header[17],
                                                                                                                  header[18], header[19]);
 
-        LOG_OUT("    lt_get_info_fw_bank()  FW_BANK_SPECT2     %s\r\n", lt_ret_verbose(lt_get_info_fw_bank(&h, FW_BANK_SPECT2, header, LT_L2_GET_INFO_FW_HEADER_SIZE)));
+        LOG_OUT("    lt_get_info_fw_bank()  FW_BANK_SPECT2     %s\r\n", lt_ret_verbose(lt_get_info_fw_bank(h, FW_BANK_SPECT2, header, LT_L2_GET_INFO_FW_HEADER_SIZE)));
         LOG_OUT("    Header:                                   %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\r\n", header[0], header[1], header[2], header[3],
                                                                                                                  header[4], header[5], header[6], header[7],
                                                                                                                  header[8], header[9]);
diff --git a/include/libtropic.h b/include/libtropic.h
@@ -681,7 +681,7 @@ struct lt_config_t {
     uint32_t obj[27];
 };
 
-#ifdef LT_UTILS
+#ifdef LT_HELPERS
 /**
  * @brief Get the conf desc object from config description table
  *
diff --git a/src/libtropic.c b/src/libtropic.c
@@ -1653,7 +1653,7 @@ const char *lt_ret_verbose(lt_ret_t ret) {
 }
 
 //--------------------------------------------------------------------------------------------------------//
-#ifdef LT_UTILS
+#ifdef LT_HELPERS
 /** @brief This helper structure together with two get* interfaces is meant to be used to simplify looping
  *         through all config addresses and printing them out into log */
 struct lt_config_obj_desc_t config_description_table[27] = {
diff --git a/tests/model_based/CMakeLists.txt b/tests/model_based/CMakeLists.txt
@@ -0,0 +1,92 @@
+cmake_minimum_required(VERSION 3.21.0)
+
+
+###########################################################################
+#                                                                         #
+#   Paths and setup                                                       #
+#                                                                         #
+###########################################################################
+
+#set(CMAKE_BUILD_TYPE Debug)
+
+set(PATH_LIBTROPIC "../../")
+
+
+###########################################################################
+#                                                                         #
+#   Define project's name                                                 #
+#                                                                         #
+###########################################################################
+
+project(libtropic_unix_example
+        VERSION 0.1.0
+        DESCRIPTION "Example of libtropic's usage in Unix environment"
+        LANGUAGES C)
+
+
+###########################################################################
+#                                                                         #
+#   Sources defined by this project                                       #
+#                                                                         #
+###########################################################################
+
+add_executable(run main.c
+            ${CMAKE_CURRENT_SOURCE_DIR}/${PATH_LIBTROPIC}hal/port/unix/lt_port_unix_tcp.c
+)
+
+
+###########################################################################
+#                                                                         #
+#   Define what examples will be compiled into main().                    #
+#   If any of examples is enabled, libtropic is compiled with             #
+#   examples exposed.                                                     #
+#                                                                         #
+###########################################################################
+
+# -DLT_EX_HW_WALLET=1
+if(LT_EX_HW_WALLET)
+    set(LT_ADD_EXAMPLES ON)
+    target_compile_definitions(run PRIVATE LT_EX_HW_WALLET)
+endif()
+# -DLT_EX_HELLO_WORLD=1
+if(LT_EX_HELLO_WORLD)
+    set(LT_ADD_EXAMPLES ON)
+    target_compile_definitions(run PRIVATE LT_EX_HELLO_WORLD)
+endif()
+# -DLT_EX_TEST_REVERSIBLE=1
+if(LT_EX_TEST_REVERSIBLE)
+    set(LT_ADD_EXAMPLES ON)
+    target_compile_definitions(run PRIVATE LT_EX_TEST_REVERSIBLE)
+endif()
+# --DLT_EX_TEST_IREVERSIBLE=1
+if(LT_EX_TEST_IREVERSIBLE)
+    set(LT_ADD_EXAMPLES ON)
+    target_compile_definitions(run PRIVATE LT_EX_TEST_IREVERSIBLE)
+endif()
+
+###########################################################################
+#                                                                         #
+#   Add libtropic and set it up                                           #
+#                                                                         #
+###########################################################################
+
+# Use trezor crypto as a source of backend cryptography code
+set(LT_USE_TREZOR_CRYPTO ON)
+
+# Add path to libtropic's repository root folder
+add_subdirectory(${PATH_LIBTROPIC} "libtropic")
+
+# Customize libtropic's compilation
+target_compile_options(tropic PRIVATE -Wall)
+target_compile_options(tropic PRIVATE -ffunction-sections -fdata-sections)
+target_compile_options(tropic PRIVATE -Wno-implicit-function-declaration)
+
+
+###########################################################################
+#                                                                         #
+#   Link executable                                                       #
+#                                                                         #
+###########################################################################
+
+target_link_options(run PRIVATE -Wl,--gc-sections)
+target_link_libraries(run PRIVATE tropic)
diff --git a/tests/model_based/README.md b/tests/model_based/README.md
@@ -0,0 +1,43 @@
+# Integration tests
+
+This code is meant to be compiled under Unix and all tests here are running against TROPIC01's emulation model, that means no chip or external hardware is needed.
+
+## Model of TROPIC01
+
+To start a model, follow readme in [its](https://github.com/tropicsquare/ts-tvl) repository.
+
+Don't forget to provide model with config file, keys and chip's certificate as is described [here](https://github.com/tropicsquare/ts-tvl?tab=readme-ov-file#configuration-file)!
+
+
+
+## Compile integration tests
+
+Keep the model running in its own terminal, open a new terminal and compile integration tests:
+
+```
+$ cd tests/integration_tests/
+$ mkdir build
+$ cd build
+$ cmake ..
+$ make
+```
+
+Compilation shouldn't take long, for compiling in debug mode replace `cmake ..` with `cmake -DCMAKE_BUILD_TYPE=Debug ..` (this will allow to step through with a debugger)
+
+
+## Run it all together
+
+While model is still running in first terminal, execute integration tests:
+
+```
+./build/integration_test
+```
+
+## How it works?
+
+Both processes will talk to each other through TCP socket 127.0.0.1:28992.
+
+*Note: During tests against model, SPI layer between libtropic and model is emulated through TCP connection.
+Model responses are exactly the same as from physical TROPIC01 chip.*
+
+*Note2: Restarting the model is equivalent to plugging a fresh TROPIC01 straight out factory*
diff --git a/tests/model_based/main.c b/tests/model_based/main.c
@@ -0,0 +1,33 @@
+/**
+ * @file main.c
+ * @author Tropic Square s.r.o.
+ *
+ * @license For the license see file LICENSE.txt file in the root directory of this source tree.
+ */
+
+#include <stdio.h>
+#include "string.h"
+#include "libtropic_examples.h"
+
+int main(void)
+{
+    // Test routines
+#ifdef LT_EX_TEST_REVERSIBLE
+    lt_ex_test_reversible();
+#endif
+#ifdef LT_EX_TEST_IREVERSIBLE
+    lt_ex_test_ireversible();
+#endif
+
+    // Full examples
+#ifdef LT_FEATURES_FWUPDATE
+    lt_ex_fwupdate();
+#endif
+#ifdef LT_EX_HELLO_WORLD
+    /*int*/ lt_ex_hello_world();
+#endif
+#ifdef LT_EX_HW_WALLET
+    /*int*/ lt_ex_hardware_wallet();
+#endif
+
+}

Original file line number	Diff line number	Diff line change
`@@ -681,7 +681,7 @@ struct lt_config_t {`
`681`	`681`	`uint32_t obj[27];`
`682`	`682`	`};`
`683`	`683`
`684`		`-#ifdef LT_UTILS`
	`684`	`+#ifdef LT_HELPERS`
`685`	`685`	`/**`
`686`	`686`	`* @brief Get the conf desc object from config description table`
`687`	`687`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1653,7 +1653,7 @@ const char *lt_ret_verbose(lt_ret_t ret) {`
`1653`	`1653`	`}`
`1654`	`1654`
`1655`	`1655`	`//--------------------------------------------------------------------------------------------------------//`
`1656`		`-#ifdef LT_UTILS`
	`1656`	`+#ifdef LT_HELPERS`
`1657`	`1657`	`/** @brief This helper structure together with two get* interfaces is meant to be used to simplify looping`
`1658`	`1658`	`* through all config addresses and printing them out into log */`
`1659`	`1659`	`struct lt_config_obj_desc_t config_description_table[27] = {`