Hmac::getPrefix() - Code Metrics - jaeger-app/rest-server - Measure and Improve Code Quality continuously with Scrutinizer

Hmac::getPrefix() A
last analyzed 2016-07-05 12:03 UTC

↳ Parent: Hmac

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * Jaeger
 *
 * @copyright	Copyright (c) 2015-2016, mithra62
 * @link		http://jaeger-app.com
 * @version		1.0
 * @filesource 	./Rest/Hmac.php
 */
 
namespace JaegerApp\Rest;

use PhilipBrown\Signature\Auth;
use PhilipBrown\Signature\Token;
use PhilipBrown\Signature\Guards\CheckKey;
use PhilipBrown\Signature\Guards\CheckVersion;
use PhilipBrown\Signature\Guards\CheckTimestamp;
use PhilipBrown\Signature\Guards\CheckSignature;
use PhilipBrown\Signature\Exceptions\SignatureException;

/**
 * Jaeger - REST Hmac Object
 *
 * Allows for Hmac authentication 
 *
 * @package Rest\Authentication
 * @author Eric Lamb <[email protected]>
 */
class Hmac
{
    /**
     * The prefix authentication keys will be named after
     * @var string
     */
    private $prefix = 'm62_auth_';
    
    /**
     * The REQUEST method we're working with
     * @var string
     */
    protected $method = 'get';
    
    /**
     * The route being requested
     * @var string
     */
    protected $route = '';
    
    /**
     * The data to compare
     * @var string
     */
    protected $data = '';
    
    /**
     * Authenticates a request
     * @param string $key
     * @param string $secret
     */
    public function auth($key, $secret)
    {
        //make sure we have the require attributes
        $required = array('timestamp');
        $data = $this->getData();
        foreach($required AS $require) {
            if(!isset($data[$this->prefix.$require])) {
                return false;
            }
        }
        
        //looks good, now let's process it
        $auth  = new Auth($this->getMethod(), $this->getRoute(), $this->getData(), [
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            new CheckKey,
            new CheckVersion,
            new CheckTimestamp,
            new CheckSignature
        ]);
        $token = new Token($key, $secret);
        
        try {
            return $auth->attempt($token, $this->prefix);
        }
        
        catch (SignatureException $e) {
            return false;
        }
    }
    
    /**
     * Sets the HTTP method to use
     * @param string $method
     * @return \JaegerApp\Rest\Hmac
     */
    public function setMethod($method)
    {
        $this->method = $method;
        return $this;
    }
    
    /**
     * Returns the HTTP method
     * @return string
     */
    public function getMethod()
    {
        return $this->method;
    }
    
    /**
     * Sets the route to use
     * @param string $route
     * @return \JaegerApp\Rest\Hmac
     */
    public function setRoute($route)
    {
        $this->route = $route;
        return $this;
    }
    
    /**
     * Returns the route
     * @return string
     */
    public function getRoute()
    {
        return $this->route;
    }
    
    /**
     * Sets the data payload to use
     * @param string $data
     * @return \JaegerApp\Rest\Hmac
     */
    public function setData($data)
    {
        $this->data = $data;
        return $this;
    }
    
    /**
     * Returns the data
     * @return string
     */
    public function getData()
    {
        return $this->data;
    }
    
    public function getPrefix()
    {
        return $this->prefix;
    }
}

1			<?php
2			/**
3			* Jaeger
4			*
5			* @copyright Copyright (c) 2015-2016, mithra62
6			* @link http://jaeger-app.com
7			* @version 1.0
8			* @filesource ./Rest/Hmac.php
9			*/
10
11			namespace JaegerApp\Rest;
12
13			use PhilipBrown\Signature\Auth;
14			use PhilipBrown\Signature\Token;
15			use PhilipBrown\Signature\Guards\CheckKey;
16			use PhilipBrown\Signature\Guards\CheckVersion;
17			use PhilipBrown\Signature\Guards\CheckTimestamp;
18			use PhilipBrown\Signature\Guards\CheckSignature;
19			use PhilipBrown\Signature\Exceptions\SignatureException;
20
21			/**
22			* Jaeger - REST Hmac Object
23			*
24			* Allows for Hmac authentication
25			*
26			* @package Rest\Authentication
27			* @author Eric Lamb <[email protected]>
28			*/
29			class Hmac
30			{
31			/**
32			* The prefix authentication keys will be named after
33			* @var string
34			*/
35			private $prefix = 'm62_auth_';
36
37			/**
38			* The REQUEST method we're working with
39			* @var string
40			*/
41			protected $method = 'get';
42
43			/**
44			* The route being requested
45			* @var string
46			*/
47			protected $route = '';
48
49			/**
50			* The data to compare
51			* @var string
52			*/
53			protected $data = '';
54
55			/**
56			* Authenticates a request
57			* @param string $key
58			* @param string $secret
59			*/
60			public function auth($key, $secret)
61			{
62			//make sure we have the require attributes
63			$required = array('timestamp');
64			$data = $this->getData();
65			foreach($required AS $require) {
66			if(!isset($data[$this->prefix.$require])) {
67			return false;
68			}
69			}
70
71			//looks good, now let's process it
72			$auth = new Auth($this->getMethod(), $this->getRoute(), $this->getData(), [
			0 ignored issues – show Documentation introduced 2016-04-19 04:22 UTC by Report Bug Copy Issue Report `$this->getData()` is of type `string`, but the function expects a `array`. 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...
73			new CheckKey,
74			new CheckVersion,
75			new CheckTimestamp,
76			new CheckSignature
77			]);
78			$token = new Token($key, $secret);
79
80			try {
81			return $auth->attempt($token, $this->prefix);
82			}
83
84			catch (SignatureException $e) {
85			return false;
86			}
87			}
88
89			/**
90			* Sets the HTTP method to use
91			* @param string $method
92			* @return \JaegerApp\Rest\Hmac
93			*/
94			public function setMethod($method)
95			{
96			$this->method = $method;
97			return $this;
98			}
99
100			/**
101			* Returns the HTTP method
102			* @return string
103			*/
104			public function getMethod()
105			{
106			return $this->method;
107			}
108
109			/**
110			* Sets the route to use
111			* @param string $route
112			* @return \JaegerApp\Rest\Hmac
113			*/
114			public function setRoute($route)
115			{
116			$this->route = $route;
117			return $this;
118			}
119
120			/**
121			* Returns the route
122			* @return string
123			*/
124			public function getRoute()
125			{
126			return $this->route;
127			}
128
129			/**
130			* Sets the data payload to use
131			* @param string $data
132			* @return \JaegerApp\Rest\Hmac
133			*/
134			public function setData($data)
135			{
136			$this->data = $data;
137			return $this;
138			}
139
140			/**
141			* Returns the data
142			* @return string
143			*/
144			public function getData()
145			{
146			return $this->data;
147			}
148
149			public function getPrefix()
150			{
151			return $this->prefix;
152			}
153			}

jaeger-app / rest-server

Hmac::getPrefix() A last analyzed 2016-07-05 12:03 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Hmac::getPrefix() A
last analyzed 2016-07-05 12:03 UTC