Adding to an Existing Project¶

We recommend adding libtropic to an existing project as a git submodule. Libtropic uses CMake build system, therefore it could be added to compilation of existing CMake projects in a following way:

# Your CMakeLists.txt file

# Set path to the libtropic submodule. For example:
set(PATH_LIBTROPIC ${CMAKE_CURRENT_SOURCE_DIR}/../libtropic/)

# It is necessary to set provider of cryptography functions.
# You can use e.g. trezor_crypto as the cryptography provider.
set(LT_CRYPTO "trezor_crypto")

# Add path to the libtropic's repository root folder.
add_subdirectory(${PATH_LIBTROPIC} "libtropic")

# Add HAL functions to sources and includes depending on your platform.
# For example, to include Linux SPI HAL to MY_PROJECTS_SOURCES source list:
set(MY_PROJECT_SOURCES
    ${PATH_LIBTROPIC}/hal/port/unix/libtropic_port_unix_spi.c
)
include_directories(
    ${PATH_LIBTROPIC}/hal/port/unix
)

# Link libtropic with your binary.
target_link_libraries(my_binary_name PRIVATE tropic)

Note

The exact CMake calls depend on a configuration of the project into which libtropic is being added. For more inspiration, refer to the Integration Examples section and the CMake Documentation.

Note

We offer multiple CMake options - to see all of them, go to the beginning of the CMakeLists.txt file in the repository's root directory.

Do You Use a Makefile Instead of CMake?¶

If you use a Makefile instead of CMake, you need to:

Manually list all *.c and *.h files from libtropic in your Makefile.
For each required CMake option <CMAKE_OPTION>, add the -D<CMAKE_OPTION> flag when building with Make.

You must also follow the same steps for the cryptographic provider library, such as the one located in vendor/trezor_crypto/.

Note

You can find available CMake options in the root CMakeLists.txt of the libtropic.

Note

You can compile libtropic as a static library using CMake separately and include only the resulting library file in your Makefile. This approach eliminates the need to compile the entire libtropic library and its dependencies in your Makefile. For more details, see Compiling as a Static Library.