README.txt
author Edouard Tisserant
Mon, 25 Apr 2016 23:48:39 +0200
branchasync_key_management
changeset 543 2da34d127c5e
parent 528 587f602bf045
child 702 3d4c85291dea
permissions -rw-r--r--
More fixes, unfinished, commit before switching back to main branch for other hot fixes
     1 p≡p Engine
     2 ==========
     3 
     4 0. What it is
     5 -------------
     6 
     7 The p≡p engine is a Free Software library encapsulating implementations of:
     8 
     9 - Key Management
    10 
    11   Key Management in p≡p engine is based on GnuPG key chains (NetPGP on iOS).
    12   Keys are stored in an OpenPGP compatbile format and can be used for different
    13   crypto implementations.
    14 
    15 - Trust Rating
    16 
    17   p≡p engine is sporting a two phase trust rating system. In phase one there is
    18   a rating based on channel, crypto and key security named “comm_types”. In
    19   phase 2 these are mapped to user representable values which have attached
    20   colors to present them in traffic light semantics.
    21 
    22 - Abstract Crypto API
    23 
    24   The Abstract Crypto API is providing functions to encrypt and decrypt data or
    25   full messages without requiring an application programmer to understand the
    26   different formats and standards.
    27 
    28 - Message Transports
    29 
    30   p≡p engine will sport a growing list of Message Transports to support any
    31   widespread text messaging system including E-Mail, SMS, XMPP and many more.
    32 
    33 p≡p engine is written in C99. It is not meant to be used in application code
    34 directly. Instead, p≡p engine is coming together with a list of software
    35 adapters for a variety of programming languages and development environments.
    36 
    37 p≡p engine is under Gnu General Public License v3. If you want to use it under
    38 a different license, please contact mailto:council@pep.foundation.
    39 
    40 
    41 1. Dependencies
    42 ---------------
    43 
    44 p≡p engine is depending on the following FOSS libraries:
    45 
    46 libetpan, see https://github.com/fdik/libetpan
    47 zlib, see http://zlib.net/
    48 OpenSSL, see http://openssl.org/
    49 iconv, see http://www.gnu.org/software/libiconv/
    50 Cyrus SASL, see http://cyrusimap.org/
    51 GnuPG via GPGME, see https://gnupg.org/
    52 NetPGP/p≡p, see https://cacert.pep.foundation/dev/repos/netpgp-et/
    53 
    54 
    55 2. Building p≡p engine
    56 ----------------------
    57 
    58 p≡p engine has an old style Makefile for building it.
    59 
    60 The build is configured in Makefile.conf
    61 
    62 It supports the common targets
    63 
    64 $ make all
    65 $ make install
    66 $ make clean
    67 
    68 and additionally
    69 
    70 $ make package # for building a .tar.bz2 with the source distribution
    71 
    72 On Windows, use Visual Studio.
    73 
    74 
    75 3. How to cross-build
    76 ---------------------
    77 
    78 For cross-building, BUILD_FOR is being used. I.e.:
    79 
    80 $ BUILD_FOR=yourOS make -e
    81 
    82 
    83 4. How to build the databases
    84 -----------------------------
    85 
    86 p≡p Engine uses two databases: ~/.pEp_management (on *NIX) or
    87 %LOCALAPPDATA%\pEp\management.db on Windoze respectively, and
    88 /usr/local/share/system.db on *NIX or %ALLUSERSPROFILE%\pEp\system.db
    89 respectively. The latter contains the Trustwords dbs.
    90 
    91 The managment db is being created by the first call of init() of p≡p Engine. It
    92 does not need to be created manually. system.db is being created by using the
    93 DDL in db/create_system_db.sql – the content is created by db/dic2csv.py
    94 out of hunspell's dictionary packages (or something similar) and then being
    95 imported using sqlite3's .import command. Dictionary files for different
    96 languages are part of p≡p engine source distribution.
    97 
    98 $ make db
    99 $ make -C db install
   100 
   101 You can test the Trustwords in system.db using db/trustwords.py
   102 Both Python tools have a switch --help
   103 
   104 
   105 5. How to run the tests
   106 -----------------------
   107 
   108 You have to import all the test keys into your local gpg instance:
   109 
   110 	cd test
   111 	cat *.asc | gpg --import
   112