CramMd5Authenticator.php

<?php


/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Mailer\Transport\Smtp\Auth;

use Symfony\Component\Mailer\Exception\InvalidArgumentException;
use Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport;

/**
 * Handles CRAM-MD5 authentication.
 *
 * @author Chris Corbyn
 */
class CramMd5Authenticator implements AuthenticatorInterface {
    public function getAuthKeyword() : string {
        return 'CRAM-MD5';
    }
    
    /**
     * @see https://www.ietf.org/rfc/rfc4954.txt
     */
    public function authenticate(EsmtpTransport $client) : void {
        $challenge = $client->executeCommand("AUTH CRAM-MD5\r\n", [
            334,
        ]);
        $challenge = base64_decode(substr($challenge, 4));
        $message = base64_encode($client->getUsername() . ' ' . $this->getResponse($client->getPassword(), $challenge));
        $client->executeCommand(\sprintf("%s\r\n", $message), [
            235,
        ]);
    }
    
    /**
     * Generates a CRAM-MD5 response from a server challenge.
     */
    private function getResponse(string $secret, string $challenge) : string {
        if (!$secret) {
            throw new InvalidArgumentException('A non-empty secret is required.');
        }
        if (\strlen($secret) > 64) {
            $secret = pack('H32', md5($secret));
        }
        if (\strlen($secret) < 64) {
            $secret = str_pad($secret, 64, \chr(0));
        }
        $kipad = substr($secret, 0, 64) ^ str_repeat(\chr(0x36), 64);
        $kopad = substr($secret, 0, 64) ^ str_repeat(\chr(0x5c), 64);
        $inner = pack('H32', md5($kipad . $challenge));
        return md5($kopad . $inner);
    }

}