This library provides an implementation of the [p≡ p Engine]'s
This library provides an implementation of the [pE p Engine]'s
[cryptotech] interface using [Sequoia].
[ p≡ p Engine ]: https://gitea.pep.foundation/pEp.foundation/pEpEngine
[ pE p Engine ]: https://gitea.pep.foundation/pEp.foundation/pEpEngine
[ cryptotech ]: https://gitea.pep.foundation/pEp.foundation/pEpEngine/src/branch/master/src/cryptotech.h
[ Sequoia ]: https://sequoia-pgp.org
Building
========
# Building
## Linux and MacOS
You need at least version 1.60 of `rustc` and `cargo` .
... ... @@ -15,39 +16,58 @@ You can build this library as follows:
```
$ git clone https://gitea.pep.foundation/pEp.foundation/pEpEngineSequoiaBackend.git
$ cd pEpEngineSequoiaBackend
$ mkdir -p /tmp/pep_engine_sequoia_backend
$ CARGO_TARGET_DIR=/tmp/pep_engine_sequoia_backend cargo build # Add --release for a release build
$ CARGO_TARGET_DIR=/tmp/pep_engine_sequoia_backend cargo test
$ make
$ make install
```
This will generate, among others
`/tmp/pep_engine_sequoia_backend/debug/pep_engine_sequoia_backend.pc` .
This can be used to easily link to the library *in place* . That is,
no installation is required.
To configure how this library is built, edit `local.conf` .
Hence to build and test the engine, we can do:
When built in debug mode, the library always generates trace output.
If you encounter problems in release mode, you can get a trace of the
library's execution by setting the `PEP_TRACE` environment
variable.
```
$ cd ~/src/pEpEngine
$ export PKG_CONFIG_PATH=/tmp/pep_engine_sequoia_backend/debug${PKG_CONFIG_PATH+:$PKG_CONFIG_PATH}
$ make
$ LD_LIBRARY_PATH=$(for p in $(pkg-config pep_engine_sequoia_backend --libs-only-L); do echo ${p#-L}; done | paste -sd ':')${LD_LIBRARY_PATH+:$LD_LIBRARY_PATH} RUST_BACKTRACE=1 make -C test test
## Windows
On Windows, the Sequoia PGP backend for the pEp engine uses the CNG
backend.
### Use the Visual Studio compatible Rust compiler
You can check this by trying:
``` text
C:\Users\vb\source\repos\pEpEngineSequoiaBackend> rustup show active-toolchain
1.60.0-x86_64-pc-windows-msvc (default)
```
Of course when installing the engine, we'll need to distribute the
generated library.
### Call NMake with the delivered NMakefile
Note: when profiling the library (or doing a release), be sure to
build in release mode! That is, build the library with `cargo build
--release` and replace `debug` with `release` in the second set of
commands.
``` text
C:\Users\vb\source\repos\pEpEngineSequoiaBackend> nmake /F NMakefile
When built in debug mode, the library always generates trace output.
If you encounter problems in release mode, you can get a trace of the
library's execution by setting the `PEP_TRACE` environment
variable. For example:
Microsoft (R) Program Maintenance Utility, Version 14.34.31937.0
Copyright (C) Microsoft Corporation. Alle Rechte vorbehalten.
cargo build --features crypto-cng --no-default-features --release
Finished release [optimized] target(s) in 0.20s
Built target\release\pep_engine_sequoia_backend.dll
```
$ cd ~/src/pEpEngine/test
$ PKG_CONFIG_PATH=/tmp/pep_engine_sequoia_backend/debug${PKG_CONFIG_PATH+:$PKG_CONFIG_PATH} LD_LIBRARY_PATH=$(for p in $(pkg-config pep_engine_sequoia_backend --libs-only-L); do echo ${p#-L}; done | paste -sd ':')${LD_LIBRARY_PATH+:$LD_LIBRARY_PATH} PEP_TRACE=1 ./EngineTests -- --gtest_filter=DeleteKeyTest.check_delete_single_pubkey
### To get a debug version instead of the release set environment DEBUG=debug
``` text
C:\Users\vb\source\repos\pEpEngineSequoiaBackend> nmake /F NMakefile /E DEBUG=debug
Microsoft (R) Program Maintenance Utility, Version 14.34.31937.0
Copyright (C) Microsoft Corporation. Alle Rechte vorbehalten.
cargo build --features crypto-cng --no-default-features
Finished dev [unoptimized + debuginfo] target(s) in 0.18s
Built target\debug\pep_engine_sequoia_backend.dll
```
Unlike with GNU Make, `DEBUG` must not be defined if you want to build a
release.