p≡p engine
Go to file
positron abbf677a20 Merge pull request 'IOSAD-232: Tell xcode the generated files (engine, asn.1) so it doesn't expect them from the start' (#76) from dirk/pEpEngine:IOSAD-232 into master
Reviewed-on: pEp.foundation/pEpEngine#76
2022-03-15 12:14:48 +01:00
.gitlab-ci-files CI: build CentOS/RedHat 8 RPM packages 2021-07-14 11:01:51 -07:00
api typos fixed in API spec 2021-11-26 12:12:04 +01:00
asn.1 build system: workaround for asn.1 generated code defining _REENTRANT again 2022-01-11 11:28:04 +01:00
build-android Android build: Add cleanup for installed headers. 2020-07-27 12:49:18 +02:00
build-mac IOSAD-232 Unify names for generated file lists 2022-03-14 16:46:23 +01:00
build-windows Update Windows build file 2021-12-23 13:41:34 +01:00
codegen Fix doxygen for autogenerated code 2022-02-18 11:36:37 +01:00
db fix ENGINE-956 2021-09-07 17:26:35 +02:00
doc make doxygen output nicer 2022-02-18 11:36:37 +01:00
pEpMIME Add support for $(DESTDIR) to Makefiles. 2021-04-13 18:48:00 +02:00
scripts CI: make build jobs much faster 2021-09-14 17:10:29 -07:00
src version: re-add the trailing "+" 2022-03-04 09:58:44 +01:00
test temporary: revert to the old-style sequoia FFI, and an old sequoia as dependency 2022-01-31 15:42:54 +01:00
.gitignore Doxyfile 2022-02-18 11:35:26 +01:00
.gitlab-ci.yml CI: make build jobs much faster 2021-09-14 17:10:29 -07:00
CC_BY-SA.txt Move most documentation to doc/, update README 2017-08-28 14:32:46 +02:00
DEPENDENCIES DEPENDENCIES: add optional sqlite3 dependency 2022-02-28 12:20:22 +01:00
LICENSE.txt Move most documentation to doc/, update README 2017-08-28 14:32:46 +02:00
Makefile manage dependencies in Makefile 2022-02-22 13:39:40 +01:00
Makefile.conf change Makefile again for Seq 1.7.0 and to remove wrong deployment info 2022-03-02 10:39:41 +01:00
README.md fixing a typo 2021-02-17 21:09:04 +01:00
clean_sync_leftovers.sh adding trust sync files to clean_sync_leftovers.sh 2020-04-27 19:27:23 +02:00
engine_doxygen.conf attempts to generate sync doc 2020-11-02 16:11:27 +01:00
pEpErr.py test fix 2020-10-06 15:20:54 +02:00
release_engine.py Removed bells and whistles. Use at your own risk, but hey, at least releases will happen once I'm gone :) 2021-07-26 11:22:06 +02:00


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 related 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.


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.