README.txt
author Roker <roker@pep-project.org>
Wed, 01 Jun 2016 10:32:30 +0200
changeset 702 3d4c85291dea
parent 528 587f602bf045
child 703 5f979670b2a6
permissions -rw-r--r--
add asn1c to README
     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 Asn1c, dowload from https://lionet.info/soft/asn1c-0.9.27.tar.gz
    54        (Debian's version 0.9.24 does not work)
    55 
    56 
    57 2. Building p≡p engine
    58 ----------------------
    59 
    60 p≡p engine has an old style Makefile for building it.
    61 
    62 The build is configured in Makefile.conf
    63 
    64 It supports the common targets
    65 
    66 $ make all
    67 $ make install
    68 $ make clean
    69 
    70 and additionally
    71 
    72 $ make package # for building a .tar.bz2 with the source distribution
    73 
    74 On Windows, use Visual Studio.
    75 
    76 
    77 3. How to cross-build
    78 ---------------------
    79 
    80 For cross-building, BUILD_FOR is being used. I.e.:
    81 
    82 $ BUILD_FOR=yourOS make -e
    83 
    84 
    85 4. How to build the databases
    86 -----------------------------
    87 
    88 p≡p Engine uses two databases: ~/.pEp_management (on *NIX) or
    89 %LOCALAPPDATA%\pEp\management.db on Windoze respectively, and
    90 /usr/local/share/system.db on *NIX or %ALLUSERSPROFILE%\pEp\system.db
    91 respectively. The latter contains the Trustwords dbs.
    92 
    93 The managment db is being created by the first call of init() of p≡p Engine. It
    94 does not need to be created manually. system.db is being created by using the
    95 DDL in db/create_system_db.sql – the content is created by db/dic2csv.py
    96 out of hunspell's dictionary packages (or something similar) and then being
    97 imported using sqlite3's .import command. Dictionary files for different
    98 languages are part of p≡p engine source distribution.
    99 
   100 $ make db
   101 $ make -C db install
   102 
   103 You can test the Trustwords in system.db using db/trustwords.py
   104 Both Python tools have a switch --help
   105 
   106 
   107 5. How to run the tests
   108 -----------------------
   109 
   110 You have to import all the test keys into your local gpg instance:
   111 
   112 	cd test
   113 	cat *.asc | gpg --import
   114