Skip to content

GUIDE.md

Latest commit

 

History

History
88 lines (66 loc) · 6.02 KB

GUIDE.md

File metadata and controls

88 lines (66 loc) · 6.02 KB
Raw

Build Instructions

Module-Specific Guides: For detailed build and run instructions, select your module below.

📦 Modules

🔐 NanoSSH

Component Description Guide
SSH Server Secure Shell server → Build & Run
SSH Client Secure Shell client → Build & Run
SSH Unit Test Unit tests for NanoSSH → Build & Run

📡 NanoMQTT

Component Description Guide
MQTT Client MQTT client → Build & Run
MQTT Functional Test Functional tests for NanoMQTT → Build & Run
MQTT Unit Test Unit tests for NanoMQTT → Build & Run

⚙️ NanoROOT

Component Description Guide
NanoROOT NanoROOT SMP library → Build & Run

🔒 NanoCrypto Example

Component Description Guide
NanoCrypto Example Demonstrates NanoCrypto usage via crypto interface → Build & Run

🛠️ NanoSSL

Component Description Guide
SSL Server SSL server → Build & Run
SSL Client SSL client → Build & Run

🧩 TAP API Example

Component Description Guide
TAP API Example Demonstrates TAP API with TPM2 → Build & Run

📜 NanoCert SCEP

Component Description Guide
SCEP Sample SCEP certificate enrollment sample → Build & Run

🔐 NanoCert EST

Component Description Guide
EST Sample EST certificate enrollment sample → Build & Run

🛡️ NanoSec

Component Description Guide
NanoSec IPsec/IKE security sample → Build & Run

🔗 OpenSSL Connector

Component Description Guide
OpenSSL Connector Demonstrates OpenSSL Connector Usage → Build & Run

🏢 TrustEdge

Component Description Guide
TrustEdge IoT device provisioning and lifecycle management executable → Build & Run

⚙️ Commonly Used CMake Options

Option Description Default
BUILD_SAMPLES Build sample applications OFF
WITH_LOGGING Build with logging enabled OFF
SECURE_PATH Enable secure path restriction Not set

📝 Build Notes

  • SSL Library: Built by default (CM_ENABLE_SSL=ON).
  • BUILD_SAMPLES: Builds sample applications only for enabled modules (e.g., SSH client sample requires ENABLE_SSH_CLIENT=ON).
  • SECURE_PATH: When set (e.g., -DSECURE_PATH="/path/to/directory"), restricts file operations to the specified directory only.

Note: For module-specific CMake options, refer to the respective BUILD_RUN.md (e.g., samples/ssh_client/BUILD_RUN.md) in the samples/<module> directories. These may include additional flags tailored to individual components.

🛠️ Build Steps

For detailed build and run instructions, including specific CMake commands and examples, refer to the BUILD_RUN.md file for your selected module above.