add user-defined dkim-selector

Florian Schaal

2014-03-31 69f5c9ad8749cd9b72270bdfea1cf1186a81067c

add user-defined dkim-selector

 install/sql/incremental/upd_0073.sql

New file
@@ -0,0 +1 @@
ALTER TABLE `mail_domain` ADD `dkim_selector` VARCHAR(63) DEFAULT 'default' AFTER `dkim`;

 install/sql/ispconfig3.sql

@@ -740,6 +740,7 @@
  `server_id` int(11) unsigned NOT NULL default '0',
  `domain` varchar(255) NOT NULL default '',
  `dkim` ENUM( 'n', 'y' ) NOT NULL default 'n',
  `dkim_selector` varchar(63) NOT NULL DEFAULT 'default',
  `dkim_private` mediumtext NOT NULL,
  `dkim_public` mediumtext NOT NULL,
  `active` enum('n','y') NOT NULL,

 interface/web/mail/form/mail_domain.tform.php

@@ -125,6 +125,18 @@
            'cols'          => '30',
            'rows'          => '10'
        ),
        'dkim_selector' => array (
            'datatype'      => 'VARCHAR',
            'formtype'      => 'TEXT',
            'default'       => 'default',
            'value'         => 'default',
            'width'  => '20',
            'maxlength' => '63',
            'validators' => array (  0 => array (   'type' => 'REGEX',
                    'regex' => '/^[a-z0-9]{0,63}$/',
                    'errmsg'=> 'dkim_selector_error'),
            ),
        ),
        'active' => array (
            'datatype' => 'VARCHAR',
            'formtype' => 'CHECKBOX',

 interface/web/mail/lib/lang/ar_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/bg_mail_domain.lng

@@ -13,6 +13,8 @@
$wb["dkim_public_txt"] = 'DKIM Public-key\nfor information only';
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['policy_txt'] = 'Спамфилтър';
$wb['no_policy'] = '- не е разрешен -';

 interface/web/mail/lib/lang/br_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/cz_mail_domain.lng

@@ -14,6 +14,8 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
$wb['policy_txt'] = 'Spamový filtr';
$wb['no_policy'] = '- nepovoleno -';
?>

 interface/web/mail/lib/lang/de_mail_domain.lng

@@ -16,4 +16,6 @@
$wb['limit_maildomain_txt'] = 'Die maximale Anzahl an E-Mail Domains für Ihr Konto wurde erreicht.';
$wb['policy_txt'] = 'Spamfilter';
$wb['no_policy'] = '- nicht aktiviert -';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Ungültiger DKIM-Selector.  Verwenden Sie nur alphanumerische Zeichen (a-z oder 0-9)';
?>

 interface/web/mail/lib/lang/en_mail_domain.lng

@@ -18,4 +18,6 @@
$wb["policy_txt"] = 'Spamfilter';
$wb["no_policy"] = '- not enabled -';
$wb['error_not_allowed_server_id'] = 'Chosen server is not allowed for this account.';
?>
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/es_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/fi_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/fr_mail_domain.lng

@@ -18,4 +18,6 @@
$wb['policy_txt'] = 'Filtre antispam';
$wb['no_policy'] = '- inactif -';
$wb['error_not_allowed_server_id'] = 'Le serveur choisi n\'est pas autorisé pour ce compte.';
?>
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/hr_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/hu_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/id_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/it_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/nl_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/pl_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/pt_mail_domain.lng

@@ -10,4 +10,12 @@
$wb['limit_maildomain_txt'] = 'O número máximo de contas de correio eletrônico para este domínio foi atingido.';
$wb['policy_txt'] = 'Filtro Anti-Spam';
$wb['no_policy'] = '- desactivado -';
$wb["dkim_txt"] = 'enable DKIM';
$wb["dkim_private_txt"] = 'DKIM Private-key';
$wb["dkim_public_txt"] = 'DKIM Public-key\nfor information only';
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/ro_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/se_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/lib/lang/sk_mail_domain.lng

@@ -14,6 +14,9 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';

$wb['policy_txt'] = 'Spamfilter';
$wb['no_policy'] = '- Nie je aktivovaný -';
?>

 interface/web/mail/lib/lang/tr_mail_domain.lng

@@ -16,4 +16,6 @@
$wb["dkim_generate_txt"] = 'Generate DKIM Private-key';
$wb["dkim_dns_txt"] = 'DNS-Record (TYPE TXT)<br><br>add this record to your DNS';
$wb["dkim_private_key_error"] = 'Invalid DKIM-Private key';
$wb['dkim_selector_txt'] = 'DKIM-Selector';
$wb['dkim_selector_error'] = 'Invalid DKIM-Selector. Use only lower-case alphanumeric characters (a-z or 0-9)';
?>

 interface/web/mail/templates/mail_domain_edit.htm

@@ -87,6 +87,10 @@
                </div>
              </div>
              <div class="ctrlHolder">
                <label for="dkim_selector">{tmpl_var name='dkim_selector_txt'}</label>
                <input name="dkim_selector" id="dkim_selector" value="{tmpl_var name='dkim_selector'}" size="20" maxlength="63" type="text" class="textInput" />
              </div>
              <div class="ctrlHolder">
                <label for="dkim_private">{tmpl_var name='dkim_private_txt'}</label>
                <textarea name="dkim_private" id="dkim_private" rows='10' cols='30'>{tmpl_var name='dkim_private'}</textarea>
<a href="javascript:setRequest('create','{tmpl_var name='domain'}')">{tmpl_var name='dkim_generate_txt'}</a>

 server/plugins-available/mail_plugin_dkim.inc.php

@@ -208,16 +208,18 @@
    function add_to_amavis($key_domain) {
        global $app, $mail_config;

        if (empty($selector)) $selector = 'default';
        $restart = false;
        $selector = 'default';
        $amavis_configfile = $this->get_amavis_config();

        $search_regex = "/(\n|\r)?dkim_key\(\'".$key_domain."\',\ \'(".$selector."|".$old_selector."){1}?\'.*/";

        //* If we are using seperate config-files with amavis remove existing keys from 50-user to avoid duplicate keys
        if (substr_compare($amavis_configfile, '60-dkim', -7) === 0) {
            $temp_configfile = str_replace('60-dkim', '50-user', $amavis_configfile);
            $temp_config = file_get_contents($temp_configfile);
            if (preg_match("/(\n|\r)?dkim_key.*".$key_domain.".*/", $temp_config)) {
                $temp_config = preg_replace("/(\n|\r)?dkim_key.*".$key_domain.".*(\n|\r)?/", '', $temp_config)."\n";
            if (preg_match($search_regex, $temp_config)) {
                $temp_config = preg_replace($search_regex, '', $temp_config)."\n";
                file_put_contents($temp_configfile, $temp_config);
            }
            unset($temp_configfile);
@@ -226,7 +228,7 @@

        $key_value="dkim_key('".$key_domain."', '".$selector."', '".$mail_config['dkim_path']."/".$key_domain.".private');\n";
        $amavis_config = file_get_contents($amavis_configfile);
        $amavis_config = preg_replace("/(\n|\r)?dkim_key.*".$key_domain.".*/", '', $amavis_config).$key_value;
        $amavis_config = preg_replace($search_regex, '', $amavis_config).$key_value;

        if (file_put_contents($amavis_configfile, $amavis_config)) {
            $app->log('Adding DKIM Private-key to amavis-config.', LOGLEVEL_DEBUG);
@@ -249,8 +251,10 @@
        $amavis_configfile = $this->get_amavis_config();
        $amavis_config = file_get_contents($amavis_configfile);

        if (preg_match("/(\n|\r)?dkim_key.*".$key_domain.".*/", $amavis_config)) {
            $amavis_config = preg_replace("/(\n|\r)?dkim_key.*".$key_domain.".*(\n|\r)?/", '', $amavis_config);
        $search_regex = "/(\n|\r)?dkim_key.*".$key_domain.".*(\n|\r)?/";

        if (preg_match($search_regex, $amavis_config)) {
            $amavis_config = preg_replace($search_regex, '', $amavis_config);
            file_put_contents($amavis_configfile, $amavis_config);
            $app->log('Deleted the DKIM settings from amavis-config for '.$key_domain.'.', LOGLEVEL_DEBUG);
            $restart = true;
@@ -260,8 +264,8 @@
        if (substr_compare($amavis_configfile, '60-dkim', -7) === 0) {
            $temp_configfile = str_replace('60-dkim', '50-user', $amavis_configfile);
            $temp_config = file_get_contents($temp_configfile);
            if (preg_match("/(\n|\r)?dkim_key.*".$key_domain.".*/", $temp_config)) {
                $temp_config = preg_replace("/dkim_key.*".$key_domain.".*/", '', $temp_config);
            if (preg_match($search_regex, $temp_config)) {
                $temp_config = preg_replace($search_regex, '', $temp_config);
                file_put_contents($temp_configfile, $temp_config);
                $restart = true;
            }
@@ -291,9 +295,6 @@
            } else {
                $app->log('Error saving the DKIM Private-key for '.$data['new']['domain'].' - DKIM is not enabled for the domain.', LOGLEVEL_ERROR);
            }
        }
        else {
            $app->log('DKIM for '.$data['new']['domain'].' not written to disk - domain is inactive', LOGLEVEL_DEBUG);
        }
    }

@@ -360,6 +361,10 @@
                if ($data['new']['dkim_private'] != $data['old']['dkim_private'] && $data['new']['dkim'] == 'y') {
                    $this->add_dkim($data);
                }
                /* new selector */
                if ($data['new']['dkim_selector'] != $data['old']['dkim_selector'] && $data['new']['dkim'] == 'y') {
                    $this->add_dkim($data);
                }
                /* new domain-name */
                if ($data['new']['domain'] != $data['old']['domain']) {
                    $this->remove_dkim($data['old']);