Go to file
Meitar M f8e0e997fc
Provide more guidance for understanding examples, update `.travis.yml`.
This commit adds an `example/README.md` file with a little bit of
guidance for running the examples themselves. This is helpful because
the examples all rely on the presence of a `phpseclib` installation
available to the PHP interpreter, and while there is a `composer.json`
file to this effect, none of the examples included the Composer
`autoload.php` file.

This commit makes no modifications to the example code itself, but does
`include_once()` the Composer autoload script so that `phpseclib` loads
and avoids causing a fatal error when a new user attempts to run the
examples to learn how to use the library.

This commit also updates the Travis `before_script` build script, dropping
the `--dev` argument to the `composer install` command. Current versions
of Composer emit a deprecation notice when `--dev` is passed.
2018-12-20 13:42:15 -07:00
examples Provide more guidance for understanding examples, update `.travis.yml`. 2018-12-20 13:42:15 -07:00
lib Wordwrap enarmor output 2018-11-20 20:22:24 -05:00
tests S2K salt is *always* 8 bytes 2018-07-25 15:04:49 -05:00
.gitignore Created repository. 2010-01-22 11:32:59 +01:00
.travis.yml Provide more guidance for understanding examples, update `.travis.yml`. 2018-12-20 13:42:15 -07:00
AUTHORS Add myself as an author 2010-03-30 13:38:28 -05:00
Doxyfile Initial doxygen setup 2014-06-28 14:26:12 -05:00
README Created repository. 2010-01-22 11:32:59 +01:00
README.md Upstream isn't coming back 2018-07-25 19:26:57 -05:00
UNLICENSE Created repository. 2010-01-22 11:32:59 +01:00
VERSION Bump version number 2017-04-12 16:23:15 -05:00
composer.json Tell composer what versions of PHP we test against 2018-07-25 14:16:18 -05:00
phpunit.xml Make autoload work for phpunit tests 2015-03-14 10:59:21 +01:00

README.md

Build Status

OpenPGP.php: OpenPGP for PHP

This is a pure-PHP implementation of the OpenPGP Message Format (RFC 4880).

About OpenPGP

OpenPGP is the most widely-used e-mail encryption standard in the world. It is defined by the OpenPGP Working Group of the Internet Engineering Task Force (IETF) Proposed Standard RFC 4880. The OpenPGP standard was originally derived from PGP (Pretty Good Privacy), first created by Phil Zimmermann in 1991.

Features

  • Encodes and decodes ASCII-armored OpenPGP messages.
  • Parses OpenPGP messages into their constituent packets.
    • Supports both old-format (PGP 2.6.x) and new-format (RFC 4880) packets.
  • Helper class for verifying, signing, encrypting, and decrypting messages http://phpseclib.sourceforge.net
  • Helper class for encrypting and decrypting messages and keys using http://phpseclib.sourceforge.net
    • openssl or mcrypt required for CAST5 encryption and decryption

Bugs, Feature Requests, Patches

This project is primarily maintained by a single volunteer with many other things vying for their attention, please be patient.

Bugs, feature request, pull requests, patches, and general discussion may be submitted publicly via email to: dev@singpolyma.net

Github users may alternately submit on the web there.

Users

OpenPGP.php is currently being used in the following projects:

Download

To get a local working copy of the development repository, do:

git clone https://github.com/singpolyma/openpgp-php.git

Alternatively, you can download the latest development version as a tarball as follows:

wget https://github.com/singpolyma/openpgp-php/tarball/master

Authors

License

OpenPGP.php is free and unencumbered public domain software. For more information, see https://unlicense.org/ or the accompanying UNLICENSE file.