You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Damiano Boppart fbd50fe076
Merge in default
6 years ago
asn.1 Fix everything that broke for macOS in the makefiles 6 years ago
build-android JNI-26 add include files to android's build output 6 years ago
build-config Add caveat to common.conf inline documentation 6 years ago
build-linux adding license info to each file 6 years ago
build-mac ENGINE-9: Adding missing file to xcode project 6 years ago
build-windows ENGINE-9: added missing files to windows build 6 years ago
db Do not have make comments as recipes 6 years ago
src Add make variable to select os-provided sqlite3 library 6 years ago
sync Add file to clean target 6 years ago
test Add target for only compiling tests 6 years ago
.hgignore Cleanup test/Makefile, fix src install target 6 years ago
LICENSE.txt should be there 8 years ago
Makefile Add some more documentation, and print PLATFORM_OVERRIDE info during run 6 years ago
Makefile.conf Add some more in-line documentation for various Makefiles 6 years ago Fixed incorrect instructions for running test 6 years ago
README.txt Document findings on asn1c versions regarding 'alloca' POSIX compat. 6 years ago
TODO.txt adding license info to each file 6 years ago adding license info to each file 6 years ago


This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# this file is under Creative Commons License 3.0 cc-by-sa

p≡p Engine

0. What it is

The p≡p engine is a Free Software library encapsulating implementations of:

- Key Management

Key Management in p≡p engine is based on GnuPG key chains (NetPGP on iOS).
Keys are stored in an OpenPGP compatbile format and can be used for different
crypto implementations.

- Trust Rating

p≡p engine is sporting a two phase trust rating system. In phase one there is
a rating based on channel, crypto and key security named “comm_types”. In
phase 2 these are mapped to user representable values which have attached
colors to present them in traffic light semantics.

- Abstract Crypto API

The Abstract Crypto API is providing functions to encrypt and decrypt data or
full messages without requiring an application programmer to understand the
different formats and standards.

- Message Transports

p≡p engine will sport a growing list of Message Transports to support any
widespread text messaging system including E-Mail, SMS, XMPP and many more.

p≡p engine is written in C99. It is not meant to be used in application code
directly. Instead, p≡p engine is coming together with a list of software
adapters for a variety of programming languages and development environments.

p≡p engine is under Gnu General Public License v3. If you want to use it under
a different license, please contact

1. Dependencies

p≡p engine is depending on the following FOSS libraries:

* libetpan, see
git clone

* zlib, see

* OpenSSL, see

* iconv, see

* Cyrus SASL, see

* GnuPG via GPGME, version 1.6.0 or newer, see

* NetPGP/p≡p, see

* Asn1c, download from . Debian 8's v0.9.24 does not work. Debian 9's v0.9.27 generates non-POSIX code, that will cause issues when the engine is compiled with '-std=c99'. Thus, use v0.9.28 for best results.

* yml2, which needs lxml (where to get?)

2. Building p≡p engine

p≡p engine has an old style Makefile for building it.

The build is configured in Makefile.conf

It supports the common targets

$ make all
$ make install
$ make clean

and additionally

$ make package # for building a .tar.bz2 with the source distribution

On Windows, use Visual Studio.

3. How to cross-build

For cross-building, BUILD_FOR is being used. I.e.:

$ BUILD_FOR=yourOS make -e

4. How to build the databases

p≡p Engine uses two databases: ~/.pEp_management (on *NIX) or
%LOCALAPPDATA%\pEp\management.db on Windoze respectively, and
/usr/local/share/system.db on *NIX or %ALLUSERSPROFILE%\pEp\system.db
respectively. The latter contains the Trustwords dbs.

The managment db is being created by the first call of init() of p≡p Engine. It
does not need to be created manually. system.db is being created by using the
DDL in db/create_system_db.sql the content is created by db/
out of hunspell's dictionary packages (or something similar) and then being
imported using sqlite3's .import command. Dictionary files for different
languages are part of p≡p engine source distribution.

$ make db
$ make -C db install

You can test the Trustwords in system.db using db/
Both Python tools have a switch --help

5. How to run the tests

You have to import all the test keys into your local gpg instance:

cd test
cat 0x*.asc *_sec.asc| gpg --import