2.3 KiB
Third-party dependencies
This directory is for mostly external building blocks that are built or linked by mars-nwe but are not project-specific service forks. Code here should normally be accessed through a mars-nwe facade or subsystem instead of being included from endpoint/provider code directly.
yyjson
The salvage metadata backend uses the bundled yyjson submodule for JSON read/write support. The submodule is required and is linked statically into the mars-nwe server targets that use salvage metadata.
Setup:
git submodule update --init --recursive third_party/yyjson
CMake expects third_party/yyjson/CMakeLists.txt to exist. Reader and writer
support stay enabled; yyjson tests, fuzzer, misc tools, docs, install targets,
JSON5/non-standard support, utilities and incremental reader support are disabled
for the mars-nwe build.
Planned: wolfSSL
wolfSSL is the planned fixed TLS implementation for mars-nwe. It should be
added as third_party/wolfssl and configured by CMake for the server's supported
platforms and enabled TLS features.
mars-nwe code should not include wolfSSL headers directly from arbitrary
subsystems. TLS users should go through the future include/nwtls.h facade and
its wolfSSL backend, for example:
include/nwtls.h
src/nwtls.c
src/nwtls_wolfssl.c
Planned uses include LDAP/LDAPS/StartTLS in nwdirectory and any future
TCP-based internal provider IPC that requires mTLS.
Planned: zlog
zlog is the planned optional advanced logging backend. If added, it should live
under third_party/zlog and be used only through the mars-nwe nwlog facade:
include/nwlog.h
src/nwlog.c
src/nwlog_zlog.c
Endpoint and provider code must not call zlog APIs directly. This keeps secret redaction, request correlation fields, and fallback logging centralized.
Forked components are not third_party
Components that are forked and integrated as mars-nwe services should live at the
repository root, following the existing pattern used by admin, dosutils,
mail, and smart.
The planned tinyldap fork is such a component. It should live as
mars-tinyldap/ at the repository root, build the project-facing nwdirectory
service, gain CMake support, and later use libdirectory/libflaim-backed
storage instead of tinyldap's original flat-file storage.