PlasmaPHP / driver-mysql

src/Messages/HandshakeMessage.php

<?php
/**
 * Plasma Driver MySQL component
 * Copyright 2018 PlasmaPHP, All Rights Reserved
 *
 * Website: https://github.com/PlasmaPHP
 * License: https://github.com/PlasmaPHP/driver-mysql/blob/master/LICENSE
*/

namespace Plasma\Drivers\MySQL\Messages;

/**
 * Represents a Handshake Message.
 * @internal
 */
class HandshakeMessage implements \Plasma\Drivers\MySQL\Messages\MessageInterface {
    /**
     * The Handshake Protocol version.
     * @var int
     */
    public $protocolVersion;
    
    /**
     * A human readable server version.
     * @var string
     */
    public $serverVersion;
    
    /**
     * The connection ID.
     * @var int
     */
    public $connectionID;
    
    /**
     * Authentication data.
     * @var string
     */
    public $scramble;
    
    /**
     * The server's capability flags.
     * @var int
     */
    public $capability;
    
    /**
     * The character set.
     * @var int|null
     */
    public $characterSet;
    
    /**
     * The status flags.
     * @var int|null
     * @see \Plasma\Drivers\MySQL\StatusFlags
     */
    public $statusFlags;
    
    /**
     * The authentication plugin name.
     * @var string|null
     */
    public $authPluginName;
    
    /**
     * @var \Plasma\Drivers\MySQL\ProtocolParser
     */
    protected $parser;
    
    /**
     * Constructor.
     * @param \Plasma\Drivers\MySQL\ProtocolParser  $parser
     */
    function __construct(\Plasma\Drivers\MySQL\ProtocolParser $parser) {
        $this->parser = $parser;
    }
    
    /**
     * Get the identifier for the packet.
     * @return string
     */
    static function getID(): string {
        return "";
    }
    
    /**
     * Parses the message, once the complete string has been received.
     * Returns false if not enough data has been received, or the remaining buffer.
     * @param \Plasma\BinaryBuffer  $buffer
     * @return bool
     * @throws \Plasma\Drivers\MySQL\Messages\ParseException
     */
    function parseMessage(\Plasma\BinaryBuffer $buffer): bool {
        $protocol = $buffer->readInt1();
        
        switch($protocol) {
            case 0x0A:
                $this->parseProtocol10($buffer);
            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            default:
                $exception = new \Plasma\Drivers\MySQL\Messages\ParseException('Unsupported protocol version');
                $exception->setState(\Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE_ERROR);
                $exception->setBuffer('');
                
                throw $exception;
            break;
        }
        
        return true;
    }
    
    /**
     * Get the parser which created this message.
     * @return \Plasma\Drivers\MySQL\ProtocolParser
     */
    function getParser(): \Plasma\Drivers\MySQL\ProtocolParser {
        return $this->parser;
    }
    
    /**
     * Sets the parser state, if necessary. If not, return `-1`.
     * @return int
     */
    function setParserState(): int {
        return \Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE;
    }
    
    /**
     * Parses the message as Handshake V10.
     * @return bool
     * @throws \Plasma\Drivers\MySQL\Messages\ParseException
     */
    protected function parseProtocol10(\Plasma\BinaryBuffer $buffer): bool {
        $versionLength = \strpos($buffer->getContents(), "\x00");
        if($versionLength === false) {
            return false;
        }
        
        $buffLength = $buffer->getSize();
        $minLength = $versionLength + 1 + 15;
        $moreDataLength = $buffLength - $minLength;
        
        if($buffLength < $minLength) {
            return false;
        } elseif($moreDataLength > 0 && $moreDataLength < 16) {
            return false;
        }
        
        $this->protocolVersion = 10;
        $this->serverVersion = $buffer->readStringNull();
        $this->connectionID = $buffer->readInt4();
        $this->scramble = $buffer->readStringLength(8); // Part 1
        
        $buffer->readStringLength(1); // Remove filler byte
        
        $this->capability = $buffer->readInt2();
        
        if($buffer->getSize() > 0) {
            $this->characterSet = $buffer->readInt1();
            $this->statusFlags = $buffer->readInt2();
            $this->capability += $buffer->readInt2() << 16;
            
            if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_PROTOCOL_41) === 0) {
                $exception = new \Plasma\Drivers\MySQL\Messages\ParseException('The old MySQL protocol 320 is not supported');
                $exception->setState(\Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE_ERROR);
                $exception->setBuffer('');
                
                throw $exception;
            }
            
            if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_PLUGIN_AUTH) !== 0) {
                $authDataLength = $buffer->readInt1();
            } else {
                $authDataLength  = 0;
                $buffer->readStringLength(1);
            }
            
            $buffer->readStringLength(10);
            
            if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_SECURE_CONNECTION) !== 0) {
                $len = \max(13, ($authDataLength - 8));
                $this->scramble .= \rtrim($buffer->readStringLength($len), "\x00");
            }
            
            if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_PLUGIN_AUTH) !== 0) {
                $this->authPluginName = $buffer->readStringNull();
            }
        }
        
        return true;
    }
}