*Currently testing migration to Git* - p≡p Enginer
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.
Thomas 1b58b737d5 Make yml2 path relative in Windows build script 2 weeks ago
asn.1 new message: ReceiverRating 2 months ago
build-android Android build: Add cleanup for installed headers. 4 months ago
build-mac IOSAD-182 Xcode: Use sqlite amalgamation from own mirror 1 month ago
build-windows Make yml2 path relative in Windows build script 2 weeks ago
db PER_MACHINE_DIRECTORY basically has to be defined with a sensible default. 1 year ago
doc Removing rancid doc files. If we have build instructions, we have a responsibility to keep them up to date. If not, they're more dangerous than they're worth. 6 months ago
src remove occurences of key id in parameter description because we only deal with full fingerprints 2 weeks ago
sync attempts to generate sync doc 3 weeks ago
test Doc cleanup (some) 4 weeks ago
.hgignore ignore generated test data 7 months ago
CC_BY-SA.txt Move most documentation to doc/, update README 3 years ago
LICENSE.txt Move most documentation to doc/, update README 3 years ago
Makefile Android build: Add cleanup for installed headers. 4 months ago
Makefile.conf Don't call pkg-config if the sequoia vars are already set in local.conf - we should probably refactor this so local.conf comes afterward anyway. I don't understand damiano's reasoning here. 6 months ago
README.md contribution 10 months ago
clean_sync_leftovers.sh adding trust sync files to clean_sync_leftovers.sh 7 months ago
engine_doxygen.conf attempts to generate sync doc 3 weeks ago
pEpErr.py test fix 1 month ago
release_rc.py Fixed release script newline error 4 months ago

README.md

What is the p≡p Engine?

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

  • Key Management

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

  • Trust Rating

    The p≡p Engine sports a two phase trust rating system for messages: In phase one a rating is derived based on channel, crypto and key security. This is named “comm_types”. In phase two these ratings are mapped to user-representable values mimicking the semantics of a traffic light.

  • Abstract Crypto API

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

  • Message Transports

    The p≡p Engine will sport a growing list of message transports, to support any widespread text-based messaging system such as E-Mail, SMS, XMPP and many more.

The p≡p Engine is written in C99 and is expected to run on any platform that conforms to the SUS/POSIX specification. Selected non-SUS platforms are supported as well (such as Microsoft Windows).

How can I use the p≡p Engine?

Build instructions can be found in the “doc/” subfolder in this repository. The p≡p Engine is not meant to be used in application code directly. Instead, the p≡p Engine is meant to be used in conjunction with a so-called “adapter”. An adapter provides an API in a programming language that best accomodates developers in their respective software development ecosystem. So, for example, a Java Native Interface adapter exists for development of apps for the Android mobile operating system, or a .NET adapter exists for development of applications on Microsoft Windows. Various adapters are also available at the link provided for the p≡p Engine's code above.

What is the current state of the project?

The p≡p Engine is production-ready. It is under active development by several full-time employees of the p≡p foundation and its partner organizations. The most recent version of the source code can be obtained here: https://pep.foundation/dev/repos. This is the only offical way to obtain a copy of the source code.

I would like to contribute to the p≡p Engine or a realated project, where do I start?

First of all, excellent! You can find further information here: https://contribution.pep.foundation/

Legal notes

The p≡p Engine is Copyright 2015-2020 by p≡p foundation, Switzerland. The source code of the p≡p Engine is licensed under the terms of the GNU General Public License version 3. Accompanying documentation is licensed under the terms of the Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) License. Each file includes a notice near its beginning, that indicates the applicable license. If you wish to license the p≡p Engine under different terms, please contact mailto:council@pep.foundation.

_pEp_reallocarray in pgp_sequoia.c is reallocarray from the OpenBSD source. It is copyright (c) 2008 Otto Moerbeek otto@drijf.net with the following permissions: Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

Contact

The p≡p foundation and the developers of the p≡p Engine can be reached as detailed here: https://pep.foundation/contact-us/index.html.