RsaSha1 - Code Metrics - Inspection of "[Auth/ID] Added OAuth 1.0a RSA-SHA1 Request Signer..." - unyx/auth - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9473ea...cfd0e6 )

by Michał

created 2016-11-23 05:47 UTC

RsaSha1 A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

Metric	Value
dl	0
loc	52
c	0
b	0
f	0
wmc	6
lcom	0
cbo	3
rs	10

3 Methods

Rating	Name	Size	Complexity
A	getSignatureMethod()	4	1
A	sign()	19	3
A	createKey()	11	2

<?php namespace nyx\auth\id\protocols\oauth1\signers;

// External dependencies
use Psr\Http\Message\RequestInterface as Request;

// Internal dependencies
use nyx\auth\id\protocols\oauth1;
use nyx\auth;

/**
 * OAuth 1.0a RSA-SHA1 Request Signer
 *
 * Note: Relies on the OpenSSL extension being available but will *not throw* on its own until a function
 * provided by the OpenSSL extension gets invoked.
 *
 * @package     Nyx\Auth
 * @version     0.1.0
 * @author      Michal Chojnacki <[email protected]>
 * @copyright   2012-2017 Nyx Dev Team
 * @link        https://github.com/unyx/nyx
 * ----
 * @see         https://oauth.net/core/1.0a/#anchor18 (Spec #9.3 RSA-SHA1)
 */
class RsaSha1 extends oauth1\Signer
{
    /**
     * {@inheritDoc}
     */
    public function getSignatureMethod() : string
    {
        return oauth1\interfaces\Signer::METHOD_RSA_SHA1;
    }

    /**
     * {@inheritDoc}
     *
     * Note: The OAUth Token is entirely ignored in this signing flow, as per spec.
     */
    public function sign(Request $request, array $params, auth\id\credentials\Client $client, auth\interfaces\Credentials $token = null) : string
    {
        if (false === $key = $this->createKey($client)) {
            throw new \RuntimeException('Failed to open the private key (invalid passphrase?).');
        }

        // openssl_sign() populates this by reference so we need a holder value.
        $signature = '';
        $success = openssl_sign($this->buildBaseString($request, $params), $signature, $key, OPENSSL_ALGO_SHA1);

        // Free the resource in any case, before the potential throw.
        openssl_free_key($key);

        if (false === $success) {
            throw new \RuntimeException('Failed to sign the Request with the provided private key.');
        }

        return base64_encode($signature);
    }

    /**
     * {@inheritDoc}
     *
     * @return  resource|bool
     */
    protected function createKey(auth\id\credentials\Client $client, auth\interfaces\Credentials $token = null)
    {
        // If it's a nested Credentials instance, we assume the id is the key (either the full key or
        // a path starting with "file://", as understood by openssl_pkey_get_private(), and the secret is the
        // key's passphrase).
        if (($key = $client->getSecret()) instanceof auth\interfaces\Credentials) {
            return openssl_pkey_get_private($key->getId(), $key->getSecret());
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return openssl_pkey_get_private($key);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1			<?php namespace nyx\auth\id\protocols\oauth1\signers;
2
3			// External dependencies
4			use Psr\Http\Message\RequestInterface as Request;
5
6			// Internal dependencies
7			use nyx\auth\id\protocols\oauth1;
8			use nyx\auth;
9
10			/**
11			* OAuth 1.0a RSA-SHA1 Request Signer
12			*
13			* Note: Relies on the OpenSSL extension being available but will not throw on its own until a function
14			* provided by the OpenSSL extension gets invoked.
15			*
16			* @package Nyx\Auth
17			* @version 0.1.0
18			* @author Michal Chojnacki <[email protected]>
19			* @copyright 2012-2017 Nyx Dev Team
20			* @link https://github.com/unyx/nyx
21			* ----
22			* @see https://oauth.net/core/1.0a/#anchor18 (Spec #9.3 RSA-SHA1)
23			*/
24			class RsaSha1 extends oauth1\Signer
25			{
26			/**
27			* {@inheritDoc}
28			*/
29			public function getSignatureMethod() : string
30			{
31			return oauth1\interfaces\Signer::METHOD_RSA_SHA1;
32			}
33
34			/**
35			* {@inheritDoc}
36			*
37			* Note: The OAUth Token is entirely ignored in this signing flow, as per spec.
38			*/
39			public function sign(Request $request, array $params, auth\id\credentials\Client $client, auth\interfaces\Credentials $token = null) : string
40			{
41			if (false === $key = $this->createKey($client)) {
42			throw new \RuntimeException('Failed to open the private key (invalid passphrase?).');
43			}
44
45			// openssl_sign() populates this by reference so we need a holder value.
46			$signature = '';
47			$success = openssl_sign($this->buildBaseString($request, $params), $signature, $key, OPENSSL_ALGO_SHA1);
48
49			// Free the resource in any case, before the potential throw.
50			openssl_free_key($key);
51
52			if (false === $success) {
53			throw new \RuntimeException('Failed to sign the Request with the provided private key.');
54			}
55
56			return base64_encode($signature);
57			}
58
59			/**
60			* {@inheritDoc}
61			*
62			* @return resource\|bool
63			*/
64			protected function createKey(auth\id\credentials\Client $client, auth\interfaces\Credentials $token = null)
65			{
66			// If it's a nested Credentials instance, we assume the id is the key (either the full key or
67			// a path starting with "file://", as understood by openssl_pkey_get_private(), and the secret is the
68			// key's passphrase).
69			if (($key = $client->getSecret()) instanceof auth\interfaces\Credentials) {
70			return openssl_pkey_get_private($key->getId(), $key->getSecret());
			0 ignored issues – show Bug Best Practice introduced 2016-11-23 05:53 UTC by Report Bug Copy Issue Report The return type of `return openssl_pkey_get_...(), $key->getSecret());` (`resource`) is incompatible with the return type of the parent method `nyx\auth\id\protocols\oauth1\Signer::createKey` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
71			}
72
73			return openssl_pkey_get_private($key);
			0 ignored issues – show Bug Best Practice introduced 2016-11-23 05:53 UTC by Report Bug Copy Issue Report The return type of `return openssl_pkey_get_private($key);` (`resource`) is incompatible with the return type of the parent method `nyx\auth\id\protocols\oauth1\Signer::createKey` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
74			}
75			}
76

unyx / auth

Push — master ( 9473ea...cfd0e6 )

RsaSha1 A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like