This project is a wrapper of PHP-DKIM library as a component for usage in conjunction with Yii framework. Nothing new, just convenient.
Download ¶
You can always download the latest version from the extensions's GitHub repository.
Installation ¶
While DKIM relies on cryptographic signatures, it is quite easy to configure but it requires the use of OpenSSL on the command line (from your web server or on any platform).
- Extract yii-dkim from archive to your application's extension directory
- Generate the RSA private key (in the example key size is 384 bits
which is very small and not very secure):
openssl genrsa -out key.priv 384 - Generate the RSA public key from the new RSA private key:
openssl rsa -in key.priv -out key.pub -pubout -outform PEM - Copy and paste the private & public keys into configuration of this component.
- Configure the remaining items in component configuration
- Configure the DNS zone file of your domain.
Configuration ¶
I prefer to keep dkim configuration in separate config/dkim.php file as it includes big chunks of text (RSA keys) that don't look pretty in main config:
<?php
// ...
'components' => array(
// ...
'dkim' => include(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'dkim.php'),
// ...
)
And here is config/dkim.php file:
<?php
return array(
'class' => 'ext.dkim.Dkim',
'open_SSL_pub' => '...', // Here comes public RSA key
'open_SSL_priv' => '...', // Enter private RSA key here
'domain' => 'domain.com', // Your domain
'selector' => '...' // DKIM record selector
);
Usage ¶
The basic PHP-DKIM usage for an HTML e-mail is:
<?php
$sender = 'john@example.com';
$headers = "From: \"Fresh DKIM Manager\" <$sender>>\r\n".
"To: $to\r\n".
"Reply-To: $sender\r\n".
"Content-Type: text/html\r\n".
"MIME-Version: 1.0";
$headers = Yii::app()->dkim->add($headers,$subject,$body) . $headers;
$result = mail($to,$subject,$body,$headers,"-f $sender");
The core function is add() which generates the DKIM-Signature: heading (which must preceede the other headers)).
suggestion: remove openssl requirement by using phpseclib's Crypt_RSA
You can generate private / public keys with phpseclib, a pure PHP RSA implementation, and if you're willing to modify php-dkim you can eliminate the openssl requirement from that as well, using the same. ie. instead of "openssl_sign($s, $signature, $open_SSL_priv)" you'd do this:
<?php include('Crypt/RSA.php'); $rsa = new Crypt_RSA(); $rsa->loadKey($open_SSL_priv); $rsa->setSignatureMode(CRYPT_RSA_SIGNATURE_PKCS1); $signature = $rsa->sign($plaintext); ?>Among other advantages phpseclib confers is portability and a much greater support of key formats.
If you have any questions, please ask in the forum instead.
Signup or Login in order to comment.