This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | Next revision Both sides next revision | ||
plugins:opendkim [2016/07/17 10:37] theemstra [Requirements] |
plugins:opendkim [2017/04/24 21:30] nuxwin |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ======OpenDKIM Plugin Documentation====== | + | See https://github.com/i-MSCP/plugins/blob/master/incubator/OpenDKIM/README.md |
- | + | ||
- | Plugin providing an OpenDKIM implementation for i-MSCP. | + | |
- | + | ||
- | ===== Requirements ===== | + | |
- | * i-MSCP versions >= 1.3.0 | + | |
- | * See installation section for required software packages. | + | |
- | + | ||
- | ===== Limitations ===== | + | |
- | + | ||
- | At the moment the DKIM signing is only supported for normal domains and alias domains. \\ It is planned to also support subdomains in a future version. | + | |
- | + | ||
- | ===== Installation instructions ===== | + | |
- | + | ||
- | + | ||
- | **1. Install needed Debian / Ubuntu packages** | + | |
- | + | ||
- | # aptitude update | + | |
- | # aptitude install opendkim opendkim-tools | + | |
- | + | ||
- | **Debian Squeeze** | + | |
- | + | ||
- | Add the backports of Debian Squeeze to your /etc/apt/sources.list: | + | |
- | + | ||
- | deb http://backports.debian.org/debian-backports squeeze-backports main contrib non-free | + | |
- | + | ||
- | Installation of the opendkim packages: | + | |
- | + | ||
- | # aptitude update | + | |
- | # aptitude -t squeeze-backports install opendkim opendkim-tools | + | |
- | + | ||
- | **Ubuntu Lucid** | + | |
- | + | ||
- | Add the backports of Ubuntu Lucid to your /etc/apt/sources.list: | + | |
- | + | ||
- | deb http://archive.ubuntu.com/ubuntu lucid-backports main restricted universe | + | |
- | + | ||
- | Installation of the opendkim packages: | + | |
- | + | ||
- | # aptitude update | + | |
- | # aptitude -t lucid-backports install opendkim opendkim-tools | + | |
- | + | ||
- | **Ubuntu Precise** | + | |
- | + | ||
- | Add the backports of Ubuntu Precise to your /etc/apt/sources.list: | + | |
- | + | ||
- | deb http://archive.ubuntu.com/ubuntu precise-backports main restricted universe | + | |
- | + | ||
- | Installation of the opendkim packages: | + | |
- | + | ||
- | # aptitude update | + | |
- | # aptitude -t precise-backports install opendkim opendkim-tools | + | |
- | + | ||
- | **2. Get the plugin from Plugin Store** | + | |
- | + | ||
- | http://i-mscp.net/filebase/index.php/Filebase/ | + | |
- | + | ||
- | **3. Plugin upload and installation** | + | |
- | + | ||
- | * Login into the panel as admin and go to the plugin management interface | + | |
- | * Upload the OpenDKIM plugin archive | + | |
- | * Install the plugin | + | |
- | + | ||
- | ===== Update ===== | + | |
- | + | ||
- | **1. Get the plugin from Plugin Store** | + | |
- | + | ||
- | http://i-mscp.net/filebase/index.php/Filebase/ | + | |
- | + | ||
- | **2. Backup your current plugin config** | + | |
- | + | ||
- | # plugins/OpenDKIM/config.php | + | |
- | + | ||
- | **3. Plugin upload and update** | + | |
- | + | ||
- | * Login into the panel as admin and go to the plugin management interface | + | |
- | * Upload the OpenDKIM plugin archive | + | |
- | * Update the plugin list | + | |
- | + | ||
- | ===== Configuration ===== | + | |
- | + | ||
- | For the different configuration options please check the plugin config file. | + | |
- | + | ||
- | # plugins/OpenDKIM/config.php | + | |
- | + | ||
- | After you made your config changes, don't forget to update the plugin list. | + | |
- | + | ||
- | * Login into the panel as admin and go to the plugin management interface | + | |
- | * Update the plugin list | + | |
- | + | ||
- | ===== Testing ===== | + | |
- | + | ||
- | ==== Internal DKIM test ==== | + | |
- | + | ||
- | You could check on the command line if OpenDKIM is working for your domain: | + | |
- | + | ||
- | # opendkim-testkey -d example.com -s mail -vvv | + | |
- | + | ||
- | The result should look similar like this one. The 'key not secure' does not indicate an error. It is an expected consequence of not using DNSSSEC. | + | |
- | + | ||
- | opendkim-testkey: checking key 'mail._domainkey.example.com' | + | |
- | opendkim-testkey: key not secure | + | |
- | opendkim-testkey: key OK | + | |
- | + | ||
- | Query your DNS server and check the TXT DKIM record for your domain. | + | |
- | + | ||
- | # dig -t txt mail._domainkey.example.com | + | |
- | + | ||
- | ==== External DKIM test ==== | + | |
- | + | ||
- | Open one of the links below and send a mail from the domain you activated OpenDKIM to the random mail address shown on that page. | + | |
- | + | ||
- | https://www.mail-tester.com | + | |
- | + | ||
- | or | + | |
- | + | ||
- | http://www.brandonchecketts.com/emailtest.php | + | |
- | + | ||
- | After you sent the mail, click on that page the 'View Results' button and verify the **DKIM Information:** section. | + | |
- | + | ||
- | DKIM Information: | + | |
- | + | ||
- | DKIM Signature | + | |
- | + | ||
- | + | ||
- | Message contains this DKIM Signature: | + | |
- | DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=example.com; | + | |
- | s=mail; t=1385558914; | + | |
- | bh=fdkeB/A0FkbVP2k4J4pNPoeWH6vqBm9+b0C3OY87Cw8=; | + | |
- | h=Date:From:To:Subject:From; | + | |
- | b=ZtWi/eDZtQ0RDv60FCDf4c+G9gqhFH3r6RPCw9vr400auTH0PnkOwt2BuLNpv4Uh4 | + | |
- | wjBHhFnIqt+t/c9/DLCC8envKmnzco8BATgXl5I5HHLxDcGMFYlwHDgOLXcCKXOXA5 | + | |
- | 15oFPlimBrwZXnq3XOJCwopZmUmZZhUyYT8pZO9k= | + | |
- | + | ||
- | + | ||
- | Signature Information: | + | |
- | v= Version: 1 | + | |
- | a= Algorithm: rsa-sha256 | + | |
- | c= Method: simple/simple | + | |
- | d= Domain: example.com | + | |
- | s= Selector: mail | + | |
- | q= Protocol: | + | |
- | bh= fdkeB/A0FkbVP2k4J4pNPoeWH6vqBm9+b0C3OY87Cw8= | + | |
- | h= Signed Headers: Date:From:To:Subject:From | + | |
- | b= Data: ZtWi/eDZtQ0RDv60FCDf4c+G9gqhFH3r6RPCw9vr400auTH0PnkOwt2BuLNpv4Uh4 | + | |
- | wjBHhFnIqt+t/c9/DLCC8envKmnzco8BATgXl5I5HHLxDcGMFYlwHDgOLXcCKXOXA5 | + | |
- | 15oFPlimBrwZXnq3XOJCwopZmUmZZhUyYT8pZO9k= | + | |
- | Public Key DNS Lookup | + | |
- | + | ||
- | + | ||
- | Building DNS Query for mail._domainkey.example.com | + | |
- | Retrieved this publickey from DNS: v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDN+HbTA3/7KoENKhMr6qRO0cFeaDX1NSD5Xe7zkGhkvOnajIrhycu0XyxzHLTTSbFLq9juJmUbPmP9OVj44o0p/NqoLQ9oWjfkcM+7nq+S4QYGoM7h+SMcxjFm05mo0LdessYi/Sw5z6x87nMkLD/wQViDvctss4srrPTr/hqD+wIDAQAB | + | |
- | Validating Signature | + | |
- | + | ||
- | + | ||
- | result = pass | + | |
- | Details: | + | |
- | + | ||
- | ===== Authors ===== | + | |
- | + | ||
- | * Sascha Bay <[email protected]> | + | |
- | * Rene Schuster <[email protected]> | + | |
- | + | ||
- | ===== Contributor ===== | + | |
- | + | ||
- | * Laurent Declercq <[email protected]> | + |