StartTls::handleTls() - Code Metrics - Inspection of "cleanup code" - kadet1090/nucleus - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1d0faf...7a5aed )

by Kacper

created 2016-08-06 20:30 UTC

StartTls::handleTls() A

↳ Parent: StartTls

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
cc	2
eloc	6
nc	2
nop	1
rs	9.4285

<?php
/**
 * XMPP Library
 *
 * Copyright (C) 2016, Some right reserved.
 *
 * @author Kacper "Kadet" Donat <[email protected]>
 *
 * Contact with author:
 * Xmpp: [email protected]
 * E-mail: [email protected]
 *
 * From Kadet with love.
 */

namespace Kadet\Xmpp\Module;

use Kadet\Xmpp\Exception\Protocol\TlsException;
use Kadet\Xmpp\Network\SecureStream;
use Kadet\Xmpp\Stream\Features;
use Kadet\Xmpp\Xml\XmlElement;
use Kadet\Xmpp\XmppClient;
use Kadet\Xmpp\XmppClientModule;
use Kadet\Xmpp\Utils\filter as with;

class StartTls extends XmppClientModule
{
    public function setClient(XmppClient $client)
    {
        parent::setClient($client);

        $client->on('features', function (Features $features) {
            return $this->handleFeatures($features);
        }, null, 10);

        $client->on('element', function (XmlElement $element) {
            $this->handleTls($element);
        }, with\xmlns(Features\StartTls::XMLNS));
    }

    protected function handleFeatures(Features $features)
    {
        if ($features->startTls) {
            if ($this->_client->getDecorated() instanceof SecureStream) {
                $this->_client->write(new Features\StartTls());

                return false; // Stop processing
            } elseif ($features->startTls->required) {
                throw new TlsException('Encryption is not available, but server requires it.');
            } else {
                $this->_client->getLogger()->warning('Server offers TLS encryption, but stream is not capable of it.');
            }
        }

        return true;
    }

    private function handleTls(XmlElement $response)
    {
        if ($response->localName === 'proceed') {
            // this function is called only by event, which can be only fired after instanceof check
            /** @noinspection PhpUndefinedMethodInspection */
            $this->_client->getDecorated()->encrypt(STREAM_CRYPTO_METHOD_TLS_CLIENT);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $this->_client->restart();
        } else {
            throw new TlsException('TLS negotiation failed.'); // XMPP does not provide any useful information why it happened
        }
    }
}


1			<?php
2			/**
3			* XMPP Library
4			*
5			* Copyright (C) 2016, Some right reserved.
6			*
7			* @author Kacper "Kadet" Donat <[email protected]>
8			*
9			* Contact with author:
10			* Xmpp: [email protected]
11			* E-mail: [email protected]
12			*
13			* From Kadet with love.
14			*/
15
16			namespace Kadet\Xmpp\Module;
17
18			use Kadet\Xmpp\Exception\Protocol\TlsException;
19			use Kadet\Xmpp\Network\SecureStream;
20			use Kadet\Xmpp\Stream\Features;
21			use Kadet\Xmpp\Xml\XmlElement;
22			use Kadet\Xmpp\XmppClient;
23			use Kadet\Xmpp\XmppClientModule;
24			use Kadet\Xmpp\Utils\filter as with;
25
26			class StartTls extends XmppClientModule
27			{
28			public function setClient(XmppClient $client)
29			{
30			parent::setClient($client);
31
32			$client->on('features', function (Features $features) {
33			return $this->handleFeatures($features);
34			}, null, 10);
35
36			$client->on('element', function (XmlElement $element) {
37			$this->handleTls($element);
38			}, with\xmlns(Features\StartTls::XMLNS));
39			}
40
41			protected function handleFeatures(Features $features)
42			{
43			if ($features->startTls) {
44			if ($this->_client->getDecorated() instanceof SecureStream) {
45			$this->_client->write(new Features\StartTls());
46
47			return false; // Stop processing
48			} elseif ($features->startTls->required) {
49			throw new TlsException('Encryption is not available, but server requires it.');
50			} else {
51			$this->_client->getLogger()->warning('Server offers TLS encryption, but stream is not capable of it.');
52			}
53			}
54
55			return true;
56			}
57
58			private function handleTls(XmlElement $response)
59			{
60			if ($response->localName === 'proceed') {
61			// this function is called only by event, which can be only fired after instanceof check
62			/** @noinspection PhpUndefinedMethodInspection */
63			$this->_client->getDecorated()->encrypt(STREAM_CRYPTO_METHOD_TLS_CLIENT);
			1 ignored issue – show Bug introduced 2016-08-06 20:35 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Stream\DuplexStreamInterface` as the method `encrypt()` does only exist in the following implementations of said interface: `Kadet\Xmpp\Network\TcpStream`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
64			$this->_client->restart();
65			} else {
66			throw new TlsException('TLS negotiation failed.'); // XMPP does not provide any useful information why it happened
67			}
68			}
69			}
70

kadet1090 / nucleus

Push — master ( 1d0faf...7a5aed )

StartTls::handleTls() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like