README.md
author Krista 'DarthMama' Bennett <krista@pep.foundation>
Mon, 11 May 2020 10:39:27 +0200
branchsync
changeset 4703 4d2e46ee02b4
parent 4394 e5aac7a91341
permissions -rw-r--r--
Bump patch version
     1 <!-- Copyright 2015-2017, pEp foundation, Switzerland
     2 This file is part of the pEp Engine
     3 This file may be used under the terms of the Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) License
     4 See CC_BY-SA.txt -->
     5 
     6 # What is the p≡p Engine?
     7 The p≡p Engine is a Free Software library encapsulating implementations of:
     8 
     9 - Key Management
    10 
    11   Key Management in the p≡p Engine is based on GnuPG key chains (NetPGP on iOS).
    12   Keys are stored in an OpenPGP-compatible format, and can be used for different crypto implementations.
    13 
    14 - Trust Rating
    15 
    16   The p≡p Engine sports a two phase trust rating system for messages:
    17   In phase one a rating is derived based on channel, crypto and key security.
    18   This is named "comm\_types".
    19   In phase two these ratings are mapped to user-representable values mimicking the semantics of a traffic light.
    20 
    21 - Abstract Crypto API
    22 
    23   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.
    24 
    25 - Message Transports
    26 
    27   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.
    28 
    29 The p≡p Engine is written in C99 and is expected to run on any platform that conforms to the SUS/POSIX specification.
    30 Selected non-SUS platforms are supported as well (such as Microsoft Windows).
    31 
    32 # How can I use the p≡p Engine?
    33 Build instructions can be found in the "doc/" subfolder in this repository.
    34 The p≡p Engine is not meant to be used in application code directly.
    35 Instead, the p≡p Engine is meant to be used in conjunction with a so-called "adapter".
    36 An adapter provides an API in a programming language that best accomodates developers in their respective software development ecosystem.
    37 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.
    38 Various adapters are also available at the link provided for the p≡p Engine's code above.
    39 
    40 # What is the current state of the project?
    41 The p≡p Engine is production-ready.
    42 It is under active development by several full-time employees of the p≡p foundation and its partner organizations.
    43 The most recent version of the source code can be obtained here: <https://pep.foundation/dev/repos>.
    44 This is the only offical way to obtain a copy of the source code.
    45 
    46 # I would like to contribute to the p≡p Engine or a realated project, where do I start?
    47 First of all, excellent! You can find further information here: <https://contribution.pep.foundation/>
    48 
    49 # Legal notes
    50 The p≡p Engine is Copyright 2015-2020 by p≡p foundation, Switzerland.
    51 The source code of the p≡p Engine is licensed under the terms of the GNU General Public License version 3.
    52 Accompanying documentation is licensed under the terms of the Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) License.
    53 Each file includes a notice near its beginning, that indicates the applicable license.
    54 If you wish to license the p≡p Engine under different terms, please contact <mailto:council@pep.foundation>.
    55 
    56 _pEp_reallocarray in pgp_sequoia.c is reallocarray from the OpenBSD source. It is 
    57 copyright (c) 2008 Otto Moerbeek <otto@drijf.net> with the following permissions: 
    58 Permission to use, copy, modify, and distribute this software for any
    59 purpose with or without fee is hereby granted, provided that the above
    60 copyright notice and this permission notice appear in all copies.
    61 
    62 # Contact
    63 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>.