securemail/vendor/singpolyma/openpgp-php/README.md

   1 OpenPGP.php: OpenPGP for PHP
   2 ============================
   3
   4 This is a pure-PHP implementation of the OpenPGP Message Format (RFC 4880).
   5
   6 * <http://github.com/bendiken/openpgp-php>
   7
   8 ### About OpenPGP
   9
  10 OpenPGP is the most widely-used e-mail encryption standard in the world. It
  11 is defined by the OpenPGP Working Group of the Internet Engineering Task
  12 Force (IETF) Proposed Standard RFC 4880. The OpenPGP standard was originally
  13 derived from PGP (Pretty Good Privacy), first created by Phil Zimmermann in
  14 1991.
  15
  16 * <http://tools.ietf.org/html/rfc4880>
  17 * <http://www.openpgp.org/>
  18
  19 Features
  20 --------
  21
  22 * Encodes and decodes ASCII-armored OpenPGP messages.
  23 * Parses OpenPGP messages into their constituent packets.
  24   * Supports both old-format (PGP 2.6.x) and new-format (RFC 4880) packets.
  25 * Helper class for verifying, signing, encrypting, and decrypting messages using Crypt_RSA from <http://phpseclib.sourceforge.net>
  26 * Helper class for encrypting and decrypting messages and keys using Crypt_AES and Crypt_TripleDES from <http://phpseclib.sourceforge.net>
  27
  28 Users
  29 -----
  30
  31 OpenPGP.php is currently being used in the following projects:
  32
  33 * <https://drupal.org/project/openpgp>
  34 * <https://wordpress.org/plugins/wp-pgp-encrypted-emails/>
  35
  36 Download
  37 --------
  38
  39 To get a local working copy of the development repository, do:
  40
  41     % git clone git://github.com/bendiken/openpgp-php.git
  42
  43 Alternatively, you can download the latest development version as a tarball
  44 as follows:
  45
  46     % wget http://github.com/bendiken/openpgp-php/tarball/master
  47
  48 Authors
  49 -------
  50
  51 * [Arto Bendiken](mailto:arto.bendiken@gmail.com) - <http://ar.to/>
  52 * [Stephen Paul Weber](mailto:singpolyma@singpolyma.net) - <http://singpolyma.net/>
  53
  54 License
  55 -------
  56
  57 OpenPGP.php is free and unencumbered public domain software. For more
  58 information, see <http://unlicense.org/> or the accompanying UNLICENSE file.