fabiang / sasl

src/Sasl.php

<?php

/**
 * Sasl library.
 *
 * Copyright (c) 2002-2003 Richard Heyes,
 *               2014-2024 Fabian Grutschus
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * o Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * o Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.|
 * o The names of the authors may not be used to endorse or promote
 *   products derived from this software without specific prior written
 *   permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @author Richard Heyes <richard@php.net>
 */

namespace Fabiang\Sasl;

use Fabiang\Sasl\Exception\InvalidArgumentException;
use Fabiang\Sasl\Options\DowngradeProtectionOptions;

/**
 * Client implementation of various SASL mechanisms
 *
 * @author Richard Heyes <richard@php.net>
 */
class Sasl
{
    /**
     * Known authentication mechanisms classes.
     *
     * @var array
     */
    protected $mechanisms = array(
        'anonymous' => 'Fabiang\\Sasl\Authentication\\Anonymous',
        'login'     => 'Fabiang\\Sasl\Authentication\\Login',
        'plain'     => 'Fabiang\\Sasl\Authentication\\Plain',
        'external'  => 'Fabiang\\Sasl\Authentication\\External',
        'crammd5'   => 'Fabiang\\Sasl\Authentication\\CramMD5',
        'digestmd5' => 'Fabiang\\Sasl\Authentication\\DigestMD5',
    );

    /**
     * Factory class. Returns an object of the request
     * type.
     *
     * @param string $type  One of: Anonymous
     *                              Plain
     *                              CramMD5
     *                              DigestMD5
     *                              SCRAM-* (any mechanism of the SCRAM family)
     *                      Types are not case sensitive
     * @param Options|array Options for authentication
     * @return \Fabiang\Sasl\Authentication\AuthenticationInterface
     */
    public function factory($type, $options = array())
    {
        $className = null;
        $parameter = null;
        $matches   = array();
        $options   = $this->createOptionsObject($options);

        $formatedType = strtolower(str_replace('-', '', $type));

        if (isset($this->mechanisms[$formatedType])) {
            $className = $this->mechanisms[$formatedType];
        } elseif (preg_match('/^scram(?<algo>.{1,9})$/i', $formatedType, $matches)) {
            $className = 'Fabiang\\Sasl\Authentication\\SCRAM';
            $parameter = $matches['algo'];
        }

        if (null === $className) {
            throw new InvalidArgumentException("Invalid SASL mechanism type '$type'");
        }

        return new $className($options, $parameter);
    }

    /**
     * @param Options|array $options
     * @return \Fabiang\Sasl\Options
     * @throws InvalidArgumentException
     */
    private function createOptionsObject($options)
    {
        $optionsObject = $options;

        if (is_array($options)) {
            $downgradeProtectOptions = null;
            if (isset($options['downgrade_protection'])) {
                $dpo = $options['downgrade_protection'];

                $allowedMechanisms = isset($dpo['allowed_mechanisms']) ? $dpo['allowed_mechanisms'] : array();
                $allowedChannelBindings = isset($dpo['allowed_channel_bindings']) ?
                    $dpo['allowed_channel_bindings'] : array();

                $downgradeProtectOptions = new DowngradeProtectionOptions($allowedMechanisms, $allowedChannelBindings);
            }

            $optionsObject = new Options(
                $this->checkEmpty($options, 'authcid'),

It seems like $options can also be of type Fabiang\Sasl\Options; however, parameter $array of Fabiang\Sasl\Sasl::checkEmpty() does only seem to accept array, maybe add an additional type check?

                $this->checkEmpty($options, 'secret'),
                $this->checkEmpty($options, 'authzid'),
                $this->checkEmpty($options, 'service'),
                $this->checkEmpty($options, 'hostname'),
                $downgradeProtectOptions
            );
        }

        if (!($optionsObject instanceof Options)) {
            throw new InvalidArgumentException(
                'Invalid options passed. Argument must be either of type "Fabiang\Sasl\Options" or "array", "'
                . (is_object($options) ? get_class($options) : gettype($options))
                . '" given.'
            );
        }

        return $optionsObject;
    }

    /**
     * @param array  $array
     * @param string $key
     * @return mixed
     */
    private function checkEmpty(array $array, $key)
    {
        if (isset($array[$key])) {
            return $array[$key];
        }

        return null;
    }
}