\JVconseil\DkimPhpMailSignatureDKIMconfig

Step by Step guide to generate your encryption keys and populate them through your DNS records.

Make your own copy of config file

Before starting you should make a copy of folder config/ and store it outside your vendor/ Composer repository in a non-public area of your website e.g.:

/www/inc/config/jv-conseil/dkim-php-mail-signature/

Failing to do so will expose you to lose all your settings in case of a future Composer udpate.

Generate your Public & Private Encryption keys

In Terminal enter this command line to start working under the path of your config/ folder:

cd /www/inc/config/jv-conseil/dkim-php-mail-signature/

In Terminal enter this command line to generate a new private 2048 bit encryption key:

openssl genrsa -des3 -out private.pem 2048

Enter your Pass Phrase and save it for editing your config.inc.php file in the next step.

Then retrieve your public key:

openssl rsa -in private.pem -out public.pem -outform PEM -pubout

You can delete the two originals *.pem file keys stored in the config/ folder if they create a conflict in the creation process of your keys.

Edit your DNS with a new DKIM record

Access your registrar interface (e.g.: OVH.com) and create a new DKIM record:

selector._domainkey  IN TXT  ( "v=DKIM1;k=rsa;p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ekggNf9vuzzL4SlVc8QZyyqbEwR5bVTPC9cEZ8hFqTKOc7go180n3RZilYJZvveaxBkLCVJSTQaMPtKuSptY5au6Pi3AkFlizzhUJ80+0zgZXSGx7gfbginbRwhD+XdGOe9NXpo0PfrD6dEJ49Ytx4/nHB0TKiL227C0kGWb7RfWTVWccgJq4+kQb4l+4" "oDU5rGomSYK+zmMV13QTSETcJnoXhmjoJ30omyJfEXAsK5Ny0LJo8rWCucLD31BxHrM9/+M/Ye+TWxcrD2mRh5Jxqcnyj00/7kCnWeGPTftVKkAJBP3JMRqCNShLUchLhaz0qeXUtxAe9dx7ltr8042QIDAQAB;" )

DKIM works better with SPF and DMARC records, you should consider editing them too:

3600     IN TXT  "v=spf1 include:_spf.google.com ~all"
_dmarc   IN TXT  "v=DMARC1; p=quarantine; rua=mailto:me@yourdomain.name"

Further reading:

Edit your Config File

Under config/config.sample.inc.php you will find a config file example to help you set your own details.

Now you can drop .sample in the filename and start editing it:

  • domain: your domain name e.g: google.com
  • selector: used in your DKIM DNS record, e.g.: selector._domainkey.MAIL_DKIM_DOMAIN
  • passphrase: your pass phrase used to generate your keys e.g.: myPassPhrase.
  • ... other parameters can be omitted.

Usage

Sample lines to import into your mail code to start signing with DKIM:

require_once __DIR__ . '/../vendor/autoload.php' ; // Autoload files using Composer autoload
use JVconseil\DkimPhpMailSignature\DKIMsign ;
use JVconseil\DkimPhpMailSignature\DKIMconfig ;

// init
$config = new DKIMconfig('/www/inc/config/jv-conseil/dkim-php-mail-signature/config.inc.php') ;

// set: this calls __set()
$config->domain = "mynewdomain.name" ;

// get: this calls __get()
$config->domain ; // => "mynewdomain.name" ;

Sponsorship

If this project helps you reduce time to develop, you can give me a cup of coffee ☕️ :-)

Donate with PayPal

Examples

Here is config.sample.inc.php:

<?php
/** 
 * The File to store your Configuration paramaters.
 * 
 * Before starting you should make a copy of folder `config/` and store it outside your `vendor/` Composer repository in a non-public area of your website e.g.: 
 * 
 * ```
 * /www/inc/config/jv-conseil/dkim-php-mail-signature/
 * ```
 * 
 * Failing to do so will expose you to lose all your settings in case of a future Composer udpate.
 * 
 * ## Generate your Public & Private Encryption keys
 * 
 * In Terminal enter this command line to start working under the path of your `config/` folder:
 * ```
 * cd /www/inc/config/jv-conseil/dkim-php-mail-signature/
 * ```
 * 
 * In Terminal enter this command line to generate a new **private 2048 bit encryption key**:
 * ```
 * openssl genrsa -des3 -out private.pem 2048
 * ```
 * 
 * Enter your **Pass Phrase** and save it for editing your `config.inc.php` file in the next step.
 * 
 * Then retrieve your **public key**:
 * ```
 * openssl rsa -in private.pem -out public.pem -outform PEM -pubout
 * ```
 * 
 * _You can delete the two originals `*.pem` file keys stored in the `config/` folder if they create a conflict in the creation process of your keys._
 * 
 * 
 * # Sponsorship
 * 
 * If this project helps you reduce time to develop, you can give me a cup of coffee ☕️ :-)
 * 
 * [![Donate with PayPal](https://www.paypalobjects.com/en_US/FR/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=P3DGL6EANDY96&source=url)
 * 
 * @var string domain: domain name e.g.: google.com.
 * @var string selector: selector used in your DKIM DNS record, e.g.: selector._domainkey.MAIL_DKIM_DOMAIN
 * @var string passphrase: your pass phrase used to generate your keys e.g.: myPassPhrase.
 * @var string private_key: string retrieved from private.pem file. 
 * @var string public_key: string retrieved from public.pem file.
 * @var string identity: Allowed user, defaults is "@<MAIL_DKIM_DOMAIN>", meaning anybody in the MAIL_DKIM_DOMAIN domain. Ex: 'admin@mydomain.tld'. You'll never have to use this unless you do not control the "From" value in the e-mails you send. 
 * 
 * @return array an array of configuration paramaters.
 * 
 * @author JV conseil — Internet Consulting <contact@jv-conseil.net>
 * @see http://www.jv-conseil.net
 * @see https://github.com/JV-conseil-Internet-Consulting/dkim-php-mail-signature
 * @see https://packagist.org/packages/jv-conseil/dkim-php-mail-signature
 * @license BSD 3-Clause License, Copyright (c) 2019, JV conseil – Internet Consulting, All rights reserved.
 * @version v1.2.2
 */
return array(
    'domain'        =>  'example.com',
    'selector'      =>  'selector',
    'passphrase'    =>  'myPassPhrase',
    'private_key'   =>  file_get_contents('private.pem', true) ,
    'public_key'    =>  file_get_contents('public.pem', true) ,
    'identity'      =>  NULL,
) ;

Summary

Methods
Properties
Constants
__construct()
__set()
__get()
No public properties found
No constants found
No protected methods found
$_config_file
N/A
_include_config_file()
$_data
N/A

Properties

$_config_file

$_config_file : string

Type

string — store the path to your <config/config.inc.php> file

$_data

$_data : array

Type

array — populated by an array of items stored in $_config_file

Methods

__construct()

__construct(  $_config_file) : object

Parameters

$_config_file

Returns

object —

populated items to DKIMconfig class

__set()

__set(  $property,   $value) : string

Parameters

$property
$value

Returns

string —

magic methods!

__get()

__get(  $property) : string

Parameters

$property

Returns

string —

the property value

_include_config_file()

_include_config_file(  $_config_file = null) : array

Parameters

$_config_file

Returns

array —

an array of configuration paramaters stored in $_config_file