PublicKey::doEquals() - Code Metrics - Inspection of "update composer.json and travis.yml - no need for..." - Bit-Wasp/bitcoin-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8782bc...7383d7 )

by thomas

created 2018-07-16 12:13 UTC

PublicKey::doEquals() A

↳ Parent: PublicKey

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	4.0312

Importance

Changes

Metric	Value
cc	4
nc	4
nop	1
dl	0
loc	13
ccs	7
cts	8
cp	0.875
crap	4.0312
rs	9.8333
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Key;

use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Adapter\EcAdapter;
use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Serializer\Key\PublicKeySerializer;
use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Signature\Signature;
use BitWasp\Bitcoin\Crypto\EcAdapter\Key\Key;
use BitWasp\Bitcoin\Crypto\EcAdapter\Key\KeyInterface;
use BitWasp\Bitcoin\Crypto\EcAdapter\Key\PublicKeyInterface;
use BitWasp\Bitcoin\Crypto\EcAdapter\Signature\SignatureInterface;
use BitWasp\Buffertools\Buffer;
use BitWasp\Buffertools\BufferInterface;

class PublicKey extends Key implements PublicKeyInterface
{
    /**
     * @var EcAdapter
     */
    private $ecAdapter;

    /**
     * @var bool|false
     */
    private $compressed;

    /**
     * @var resource
     */
    private $pubkey_t;

    /**
     * @param EcAdapter $ecAdapter
     * @param resource $secp256k1_pubkey_t
     * @param bool|false $compressed
     */
    public function __construct(EcAdapter $ecAdapter, $secp256k1_pubkey_t, bool $compressed = false)
    {
        if (!is_resource($secp256k1_pubkey_t) ||
            !get_resource_type($secp256k1_pubkey_t) === SECP256K1_TYPE_PUBKEY) {
            throw new \InvalidArgumentException('Secp256k1\Key\PublicKey expects ' . SECP256K1_TYPE_PUBKEY . ' resource');
        }

        if (false === is_bool($compressed)) {
            throw new \InvalidArgumentException('PublicKey: Compressed must be a boolean');
        }

        $this->ecAdapter = $ecAdapter;
        $this->pubkey_t = $secp256k1_pubkey_t;
        $this->compressed = $compressed;
    }
    
    /**
     * @param BufferInterface $msg32
     * @param SignatureInterface $signature
     * @return bool
     */
    public function verify(BufferInterface $msg32, SignatureInterface $signature): bool
    {
        $ctx = $this->ecAdapter->getContext();
        $normalized = null;
        secp256k1_ecdsa_signature_normalize($ctx, $normalized, $signature->getResource());
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.
    }
}
        /** @var Signature $signature */
        return (bool) secp256k1_ecdsa_verify($ctx, $normalized, $msg32->getBinary(), $this->pubkey_t);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @param PublicKey $other
     * @return bool
     */
    private function doEquals(PublicKey $other): bool
    {
        $context = $this->ecAdapter->getContext();
        $pubA = '';
        $pubB = '';
        $flags = $this->compressed ? SECP256K1_EC_COMPRESSED : SECP256K1_EC_UNCOMPRESSED;

        if (!(secp256k1_ec_pubkey_serialize($context, $pubA, $this->pubkey_t, $flags) && secp256k1_ec_pubkey_serialize($context, $pubB, $other->pubkey_t, $flags))) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            throw new \RuntimeException('Unable to serialize public key during equals');
        }

        return hash_equals($pubA, $pubB);
    }

    /**
     * @param PublicKeyInterface $other
     * @return bool
     */
    public function equals(PublicKeyInterface $other): bool
    {
        /** @var PublicKey $other */
        return $this->doEquals($other);
    }

    /**
     * @return bool|false
     */
    public function isCompressed(): bool
    {
        return $this->compressed;
    }

    /**
     * @return resource
     */
    public function getResource()
    {
        return $this->pubkey_t;
    }

    /**
     * @return resource
     * @throws \Exception
     */
    private function clonePubkey()
    {
        $context = $this->ecAdapter->getContext();
        $serialized = '';
        $flags = $this->compressed ? SECP256K1_EC_COMPRESSED : SECP256K1_EC_UNCOMPRESSED;
        if (1 !== secp256k1_ec_pubkey_serialize($context, $serialized, $this->pubkey_t, $flags)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            throw new \Exception('Secp256k1: pubkey serialize');
        }

        /** @var resource $clone */
        $clone = null;
        if (1 !== secp256k1_ec_pubkey_parse($context, $clone, $serialized)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            throw new \Exception('Secp256k1 pubkey parse');
        }

        return $clone;
    }

    /**
     * @param \GMP $tweak
     * @return KeyInterface
     * @throws \Exception
     */
    public function tweakAdd(\GMP $tweak): KeyInterface
    {
        $context = $this->ecAdapter->getContext();
        $bin = Buffer::int(gmp_strval($tweak, 10), 32)->getBinary();

        $clone = $this->clonePubkey();
        if (1 !== secp256k1_ec_pubkey_tweak_add($context, $clone, $bin)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            throw new \RuntimeException('Secp256k1: tweak add failed.');
        }

        return new PublicKey($this->ecAdapter, $clone, $this->compressed);
    }

    /**
     * @param \GMP $tweak
     * @return KeyInterface
     * @throws \Exception
     */
    public function tweakMul(\GMP $tweak): KeyInterface
    {
        $context = $this->ecAdapter->getContext();
        $bin = Buffer::int(gmp_strval($tweak, 10), 32)->getBinary();

        $clone = $this->clonePubkey();
        if (1 !== secp256k1_ec_pubkey_tweak_mul($context, $clone, $bin)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            throw new \RuntimeException('Secp256k1: tweak mul failed.');
        }

        return new PublicKey($this->ecAdapter, $clone, $this->compressed);
    }

    /**
     * @return BufferInterface
     */
    public function getBuffer(): BufferInterface
    {
        return (new PublicKeySerializer($this->ecAdapter))->serialize($this);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Key;
6
7		use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Adapter\EcAdapter;
8		use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Serializer\Key\PublicKeySerializer;
9		use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Signature\Signature;
10		use BitWasp\Bitcoin\Crypto\EcAdapter\Key\Key;
11		use BitWasp\Bitcoin\Crypto\EcAdapter\Key\KeyInterface;
12		use BitWasp\Bitcoin\Crypto\EcAdapter\Key\PublicKeyInterface;
13		use BitWasp\Bitcoin\Crypto\EcAdapter\Signature\SignatureInterface;
14		use BitWasp\Buffertools\Buffer;
15		use BitWasp\Buffertools\BufferInterface;
16
17		class PublicKey extends Key implements PublicKeyInterface
18		{
19		/**
20		* @var EcAdapter
21		*/
22		private $ecAdapter;
23
24		/**
25		* @var bool\|false
26		*/
27		private $compressed;
28
29		/**
30		* @var resource
31		*/
32		private $pubkey_t;
33
34		/**
35		* @param EcAdapter $ecAdapter
36		* @param resource $secp256k1_pubkey_t
37		* @param bool\|false $compressed
38		*/
39	222	public function __construct(EcAdapter $ecAdapter, $secp256k1_pubkey_t, bool $compressed = false)
40		{
41	222	if (!is_resource($secp256k1_pubkey_t) \|\|
42	222	!get_resource_type($secp256k1_pubkey_t) === SECP256K1_TYPE_PUBKEY) {
43		throw new \InvalidArgumentException('Secp256k1\Key\PublicKey expects ' . SECP256K1_TYPE_PUBKEY . ' resource');
44		}
45
46	222	if (false === is_bool($compressed)) {
47		throw new \InvalidArgumentException('PublicKey: Compressed must be a boolean');
48		}
49
50	222	$this->ecAdapter = $ecAdapter;
51	222	$this->pubkey_t = $secp256k1_pubkey_t;
52	222	$this->compressed = $compressed;
53	222	}
54
55		/**
56		* @param BufferInterface $msg32
57		* @param SignatureInterface $signature
58		* @return bool
59		*/
60	148	public function verify(BufferInterface $msg32, SignatureInterface $signature): bool
61		{
62	148	$ctx = $this->ecAdapter->getContext();
63	148	$normalized = null;
64	148	secp256k1_ecdsa_signature_normalize($ctx, $normalized, $signature->getResource());
		0 ignored issues – show Bug introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `BitWasp\Bitcoin\Crypto\E...ture\SignatureInterface` as the method `getResource()` does only exist in the following implementations of said interface: `BitWasp\Bitcoin\Crypto\E...nature\CompactSignature`, `BitWasp\Bitcoin\Crypto\E...6k1\Signature\Signature`. 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... Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$ctx` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
65		/** @var Signature $signature */
66	148	return (bool) secp256k1_ecdsa_verify($ctx, $normalized, $msg32->getBinary(), $this->pubkey_t);
		0 ignored issues – show Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$ctx` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$normalized` is of type `resource\|null`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$this->pubkey_t` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
67		}
68
69		/**
70		* @param PublicKey $other
71		* @return bool
72		*/
73	26	private function doEquals(PublicKey $other): bool
74		{
75	26	$context = $this->ecAdapter->getContext();
76	26	$pubA = '';
77	26	$pubB = '';
78	26	$flags = $this->compressed ? SECP256K1_EC_COMPRESSED : SECP256K1_EC_UNCOMPRESSED;
79
80	26	if (!(secp256k1_ec_pubkey_serialize($context, $pubA, $this->pubkey_t, $flags) && secp256k1_ec_pubkey_serialize($context, $pubB, $other->pubkey_t, $flags))) {
		0 ignored issues – show Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$context` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$this->pubkey_t` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$other->pubkey_t` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
81		throw new \RuntimeException('Unable to serialize public key during equals');
82		}
83
84	26	return hash_equals($pubA, $pubB);
85		}
86
87		/**
88		* @param PublicKeyInterface $other
89		* @return bool
90		*/
91	26	public function equals(PublicKeyInterface $other): bool
92		{
93		/** @var PublicKey $other */
94	26	return $this->doEquals($other);
95		}
96
97		/**
98		* @return bool\|false
99		*/
100	92	public function isCompressed(): bool
101		{
102	92	return $this->compressed;
103		}
104
105		/**
106		* @return resource
107		*/
108	82	public function getResource()
109		{
110	82	return $this->pubkey_t;
111		}
112
113		/**
114		* @return resource
115		* @throws \Exception
116		*/
117	3	private function clonePubkey()
118		{
119	3	$context = $this->ecAdapter->getContext();
120	3	$serialized = '';
121	3	$flags = $this->compressed ? SECP256K1_EC_COMPRESSED : SECP256K1_EC_UNCOMPRESSED;
122	3	if (1 !== secp256k1_ec_pubkey_serialize($context, $serialized, $this->pubkey_t, $flags)) {
		0 ignored issues – show Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$context` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$this->pubkey_t` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
123		throw new \Exception('Secp256k1: pubkey serialize');
124		}
125
126		/** @var resource $clone */
127	3	$clone = null;
128	3	if (1 !== secp256k1_ec_pubkey_parse($context, $clone, $serialized)) {
		0 ignored issues – show Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$context` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
129		throw new \Exception('Secp256k1 pubkey parse');
130		}
131
132	3	return $clone;
133		}
134
135		/**
136		* @param \GMP $tweak
137		* @return KeyInterface
138		* @throws \Exception
139		*/
140	2	public function tweakAdd(\GMP $tweak): KeyInterface
141		{
142	2	$context = $this->ecAdapter->getContext();
143	2	$bin = Buffer::int(gmp_strval($tweak, 10), 32)->getBinary();
144
145	2	$clone = $this->clonePubkey();
146	2	if (1 !== secp256k1_ec_pubkey_tweak_add($context, $clone, $bin)) {
		0 ignored issues – show Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$context` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$clone` is of type `resource\|null`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
147		throw new \RuntimeException('Secp256k1: tweak add failed.');
148		}
149
150	2	return new PublicKey($this->ecAdapter, $clone, $this->compressed);
151		}
152
153		/**
154		* @param \GMP $tweak
155		* @return KeyInterface
156		* @throws \Exception
157		*/
158	1	public function tweakMul(\GMP $tweak): KeyInterface
159		{
160	1	$context = $this->ecAdapter->getContext();
161	1	$bin = Buffer::int(gmp_strval($tweak, 10), 32)->getBinary();
162
163	1	$clone = $this->clonePubkey();
164	1	if (1 !== secp256k1_ec_pubkey_tweak_mul($context, $clone, $bin)) {
		0 ignored issues – show Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$context` is of type `resource`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2018-07-12 16:31 UTC by Report Bug Copy Issue Report `$clone` is of type `resource\|null`, but the function expects a `object<resource>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
165		throw new \RuntimeException('Secp256k1: tweak mul failed.');
166		}
167
168	1	return new PublicKey($this->ecAdapter, $clone, $this->compressed);
169		}
170
171		/**
172		* @return BufferInterface
173		*/
174	77	public function getBuffer(): BufferInterface
175		{
176	77	return (new PublicKeySerializer($this->ecAdapter))->serialize($this);
177		}
178		}
179

Bit-Wasp / bitcoin-php

Push — master ( 8782bc...7383d7 )

PublicKey::doEquals() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like