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.
 
 
 
 
Krista Bennett 503bc6ae78 Deprecated and replaced misspellings of 'compromised' and 'secret' in the API and constants. Nothing should be broken for existing implementations. 4 years ago
asn.1 Add default.conf into the build system 5 years ago
build-android Take out Engine header files for Android Build. 5 years ago
build-linux adding license info to each file 6 years ago
build-mac IOS-935 update xcode project 4 years ago
build-windows OUT-403: Add pEp_string.c and pEp_string.h to pEpEngine.vcxproj 4 years ago
db Add default.conf into the build system 5 years ago
doc Add build instructions with homebrew and LXML debugging tip 5 years ago
src Deprecated and replaced misspellings of 'compromised' and 'secret' in the API and constants. Nothing should be broken for existing implementations. 4 years ago
sync SYNC HAS RETURNED. Keysync still removed from Engine. 5 years ago
test Deprecated and replaced misspellings of 'compromised' and 'secret' in the API and constants. Nothing should be broken for existing implementations. 4 years ago
.hgignore ignoring generated artificial homes 5 years ago
CC_BY-SA.txt Move most documentation to doc/, update README 5 years ago
LICENSE.txt Move most documentation to doc/, update README 5 years ago
Makefile SYNC HAS RETURNED. Keysync still removed from Engine. 5 years ago
Makefile.conf Fix Makefile.conf, add reference to documentation in Makefiles 4 years ago
README.md Move most documentation to doc/, update README 5 years ago
default.conf Change default value, to not imply that 'NO' works as expected 4 years 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://cacert.pep.foundation/dev. 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! We'd love to dicuss this opportunity further with you. Please contact the upstream developers to get started. See the Contact section.

Legal notes

The p≡p Engine is Copyright 2015-2017 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.

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.