Go to file
positron db19a2497e pEp_set_pid_and_tid: do not use gettid that would require a recent kernel
This helps when building against very old Linux headers.  However I would like
to conditionalise this fallback solution, since gettid gives ids which are much
nicer to use for debugging.
2023-04-05 18:36:23 +02:00
.gitlab-ci-files CI: use Docker-in-Docker instead of KVM 2023-03-16 21:04:02 -05:00
api YML API: add commented-out stubs and method specification. Some might be moved to other files: the boundary between each API is not completely clear to me 2023-03-22 12:00:33 +01:00
asn.1 introduce Distribution.Echo and Media key, ported from Release_2.1, not completely cleaned up yet 2022-09-13 15:59:56 +02:00
build-android PEMA-103 Make engine depend on transport 2022-11-17 11:16:49 +01:00
build-mac gitea-139 [xcode] Add string_utilities 2023-02-23 10:23:50 +01:00
build-windows Issue #123: Make Engine 3.2 compile on Windows. Work mostly by Alex Sualdea. 2023-02-04 22:55:21 +01:00
codegen use the functionality from sql_reliability.h in existing Engine code 2023-01-18 13:27:21 +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
old add release script 2022-11-30 22:10:20 +01:00
pEpMIME Add support for $(DESTDIR) to Makefiles. 2021-04-13 18:48:00 +02:00
scripts CI: execute testsuite in pipeline 2023-03-16 21:04:03 -05:00
src pEp_set_pid_and_tid: do not use gettid that would require a recent kernel 2023-04-05 18:36:23 +02:00
test solve intermittent test suite failures by initialising the path cache very early 2023-03-22 14:15:21 +01:00
.gitignore PEMA-103 Fixed and improved android build 2022-11-17 11:16:49 +01:00
.gitlab-ci.yml CI: execute testsuite in pipeline 2023-03-16 21:04:03 -05:00
CC_BY-SA.txt Move most documentation to doc/, update README 2017-08-28 14:32:46 +02:00
DEPENDENCIES DEPENDENCIES: require an official release of libpEpTransport 2023-03-23 13:28:29 +01:00
LICENSE.txt Move most documentation to doc/, update README 2017-08-28 14:32:46 +02:00
Makefile factor makefiles 2023-01-26 12:30:59 +01:00
Makefile.conf when building in release mode omit debugging symbols: this is a workaround for pEp.foundation/pEpEngine#115 2023-03-01 10:55:34 +01:00
NEWS NEWS 2023-04-04 15:18:32 +02:00
README.WINDOWS add some windows documentation and comments 2022-11-03 14:47:25 +01:00
README.md README: trivial updates 2023-03-29 11:22:01 +02:00
THANKS documentation: punctuation 2023-01-30 17:21:47 +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
local.conf.example major Makefile.conf refactoring and simplification; solve gitea-117 2023-01-25 19:54:19 +01:00
pEpErr.py test fix 2020-10-06 15:20:54 +02:00
release improve release script 2023-03-23 14:12:28 +01:00

README.md

CI Status

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 C17 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?

The official build instructions can be found at the URL https://dev.pep.foundation/Adapter/Adapter%20Build%20Instructions_Version_3.x_DRAFT 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://gitea.pep.foundation/pEp.foundation/. 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-2023 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.

src/pEp_rmd160.c is adapted from LibTomCrypt by Tom St Denis and contributors, which was released by its authors into the public domain.

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.