Swift_Signers_OpenDKIMSigner

Complexity

Total Complexity

33

Size/Duplication

Total Lines	234
Duplicated Lines	6.41 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	newInstance()	0	4	1
A	addSignature()	0	12	2
A	startBody()	0	10	2
A	endBody()	0	9	2
A	reset()	0	7	1
A	setSignatureTimestamp()	0	6	1
A	setSignatureExpiration()	0	6	1
A	setDebugHeaders()	0	6	1
C	_canonicalizeBody()	0	22	7
F	setHeaders()	15	46	13

<?php

/*
 * This file is part of SwiftMailer.
 * (c) 2004-2009 Chris Corbyn
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * DKIM Signer used to apply DKIM Signature to a message
 * Takes advantage of pecl extension.
 *
 * @author Xavier De Cock <xdecock@gmail.com>
 */
class Swift_Signers_OpenDKIMSigner extends Swift_Signers_DKIMSigner

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * @var bool
     */
    private $_peclLoaded = false;

    /**
     * @var null|OpenDKIMSign
     */
    private $_dkimHandler = null;

    /**
     * @var bool
     */
    private $dropFirstLF = true;

    const CANON_RELAXED = 1;
    const CANON_SIMPLE = 2;
    const SIG_RSA_SHA1 = 3;
    const SIG_RSA_SHA256 = 4;

    /**
     * Swift_Signers_OpenDKIMSigner constructor.
     *
     * @param string $privateKey
     * @param string $domainName
     * @param string $selector
     *
     * @throws Swift_SwiftException
     */
    public function __construct($privateKey, $domainName, $selector)
    {
        if (!extension_loaded('opendkim')) {
            throw new Swift_SwiftException('php-opendkim extension not found');
        }

        $this->_peclLoaded = true;

        parent::__construct($privateKey, $domainName, $selector);
    }

    /**
     * @param string $privateKey
     * @param string $domainName
     * @param string $selector
     *
     * @return static
     */
    public static function newInstance($privateKey, $domainName, $selector)
    {
        return new static($privateKey, $domainName, $selector);
    }

    /**
     * @param Swift_Mime_HeaderSet $headers
     *
     * @return $this
     * @throws Swift_SwiftException
     */
    public function addSignature(Swift_Mime_HeaderSet $headers)
    {
        $header = new Swift_Mime_Headers_OpenDKIMHeader('DKIM-Signature');
        $headerVal = $this->_dkimHandler->getSignatureHeader();
        if (!$headerVal) {
            throw new Swift_SwiftException('OpenDKIM Error: ' . $this->_dkimHandler->getError());
        }
        $header->setValue($headerVal);
        $headers->set($header);

        return $this;
    }

    /**
     * @param Swift_Mime_HeaderSet $headers
     *
     * @return $this
     * @throws Swift_SwiftException
     */
    public function setHeaders(Swift_Mime_HeaderSet $headers)
    {
        $bodyLen = $this->_bodyLen;
        if (is_bool($bodyLen)) {
            $bodyLen = -1;
        }

        $hash = $this->_hashAlgorithm === 'rsa-sha1' ? OpenDKIMSign::ALG_RSASHA1 : OpenDKIMSign::ALG_RSASHA256;
        $bodyCanon = $this->_bodyCanon === 'simple' ? OpenDKIMSign::CANON_SIMPLE : OpenDKIMSign::CANON_RELAXED;
        $headerCanon = $this->_headerCanon === 'simple' ? OpenDKIMSign::CANON_SIMPLE : OpenDKIMSign::CANON_RELAXED;
        $this->_dkimHandler = new OpenDKIMSign($this->_privateKey, $this->_selector, $this->_domainName, $headerCanon, $bodyCanon, $hash, $bodyLen);

        // Hardcode signature Margin for now
        $this->_dkimHandler->setMargin(78);

        if (!is_numeric($this->_signatureTimestamp)) {
            OpenDKIM::setOption(OpenDKIM::OPTS_FIXEDTIME, time());
        } else {
            if (!OpenDKIM::setOption(OpenDKIM::OPTS_FIXEDTIME, $this->_signatureTimestamp)) {
                throw new Swift_SwiftException('Unable to force signature timestamp [' . openssl_error_string() . ']');
            }
        }

        if (isset($this->_signerIdentity)) {
            $this->_dkimHandler->setSigner($this->_signerIdentity);
        }

        $listHeaders = $headers->listAll();
        foreach ($listHeaders as $hName) {

This code seems to be duplicated across your project.

            // Check if we need to ignore Header
            if (!isset($this->_ignoredHeaders[Swift::strtolowerWithStaticCache($hName)])) {
                $tmp = $headers->getAll($hName);
                if ($headers->has($hName)) {
                    foreach ($tmp as $header) {
                        if ($header->getFieldBody() != '') {
                            $htosign = $header->toString();
                            $this->_dkimHandler->header($htosign);
                            $this->_signedHeaders[] = $header->getFieldName();
                        }
                    }
                }
            }
        }

        return $this;
    }

    /**
     * @return $this|Swift_Signers_HeaderSigner|void
     */
    public function startBody()
    {
        if (!$this->_peclLoaded) {
            return parent::startBody();
        }
        $this->dropFirstLF = true;
        $this->_dkimHandler->eoh();

        return $this;
    }

    /**
     * @return $this|Swift_Signers_HeaderSigner|void
     */
    public function endBody()
    {
        if (!$this->_peclLoaded) {
            return parent::endBody();
        }
        $this->_dkimHandler->eom();

        return $this;
    }

    /**
     * @return $this
     */
    public function reset()
    {
        $this->_dkimHandler = null;
        parent::reset();

        return $this;
    }

    /**
     * Set the signature timestamp.
     *
     * @param int $time
     *
     * @return $this
     */
    public function setSignatureTimestamp($time)
    {
        $this->_signatureTimestamp = $time;

        return $this;
    }

    /**
     * Set the signature expiration timestamp.
     *
     * @param int $time
     *
     * @return $this
     */
    public function setSignatureExpiration($time)
    {
        $this->_signatureExpiration = $time;

        return $this;
    }

    /**
     * Enable / disable the DebugHeaders.
     *
     * @param bool $debug
     *
     * @return $this
     */
    public function setDebugHeaders($debug)
    {
        $this->_debugHeaders = (bool) $debug;

        return $this;
    }

    // Protected

    /**
     * @param $string
     */
    protected function _canonicalizeBody($string)
    {
        if (!$this->_peclLoaded) {
            return parent::_canonicalizeBody($string);
        }

        if (false && $this->dropFirstLF === true) {
            if (
                $string[0] === "\r"
                &&
                $string[1] === "\n"
            ) {
                $string = substr($string, 2);
            }
        }

        $this->dropFirstLF = false;

        if ($string !== '') {
            $this->_dkimHandler->body($string);
        }
    }
}