webguerilla/pgpmailer

1.0.0-alpha.2 2014-06-13 11:19 UTC

This package is not auto-updated.

Last update: 2025-06-17 06:35:56 UTC


README

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.