Contact form script to send PGP encrypted emails.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
install
public
src
.gitignore
LICENSE
README.md
composer.json
composer.lock
composer.phar

README.md

pgpmailer

This is a script for a contact form which is able to sent PGP encrypted emails. The content of the submission is encrypted to a public key and is done on the server. It is strongly recommended that you only use pgpmailer with a secure connection such as SSL. If you use pgpmailer on an unsecure connection there is a possibility your private data can be intercepted and modified before it is encrypted.

Requirements

  • PHP 5
  • GnuPG
  • composer

Install

Via Composer

{
    "require": {
        "webguerilla/pgpmailer": "~1.0"
    }
}

Usage

pgpmailer requires having a PGP key and exporting an ASCII-armored public key.

  1. Copy an ASCII-armored public key to 'public/assets/' For example: 'public/assets/0xBADB0B1337.asc'.
  2. Modify the config file in 'install/config.sample.php' where it says $publicKeyFilepath. For example: $publicKeyFilepath = PATH_PUBLIC . '/assets/0xBADB0B1337.asc'
  3. Move the file 'install/config.sample.php' to 'src/config.php'.
  4. Run ./composer.phar update

Testing

$ phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

GNU GENERAL PUBLIC LICENSE Version 3. Please see License File for more information.