Completed
Pull Request — master (#498)
by Dragonqos
04:00
created

Signature   A

Complexity

Total Complexity 17

Size/Duplication

Total Lines 142
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 2

Importance

Changes 0
Metric Value
wmc 17
lcom 1
cbo 2
dl 0
loc 142
rs 10
c 0
b 0
f 0

8 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A setHashingAlgorithm() 0 4 1
A setTokenSecret() 0 4 1
B getSignature() 0 25 3
A buildSignatureDataString() 0 4 1
B prepareParameters() 0 18 6
A getSigningKey() 0 9 2
A hash() 0 11 2
1
<?php
2
3
namespace OAuth\OAuth1\Signature;
4
5
use OAuth\Common\Consumer\CredentialsInterface;
6
use OAuth\Common\Http\Uri\UriInterface;
7
use OAuth\OAuth1\Signature\Exception\UnsupportedHashAlgorithmException;
8
9
class Signature implements SignatureInterface
10
{
11
    /**
12
     * @var Credentials
13
     */
14
    protected $credentials;
15
16
    /**
17
     * @var string
18
     */
19
    protected $algorithm;
20
21
    /**
22
     * @var string
23
     */
24
    protected $tokenSecret = null;
25
26
    /**
27
     * @param CredentialsInterface $credentials
28
     */
29
    public function __construct(CredentialsInterface $credentials)
30
    {
31
        $this->credentials = $credentials;
0 ignored issues
show
Documentation Bug introduced by
It seems like $credentials of type object<OAuth\Common\Cons...r\CredentialsInterface> is incompatible with the declared type object<OAuth\OAuth1\Signature\Credentials> of property $credentials.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
32
    }
33
34
    /**
35
     * @param string $algorithm
36
     */
37
    public function setHashingAlgorithm($algorithm)
38
    {
39
        $this->algorithm = $algorithm;
40
    }
41
42
    /**
43
     * @param string $token
44
     */
45
    public function setTokenSecret($token)
46
    {
47
        $this->tokenSecret = $token;
48
    }
49
50
    /**
51
     * @param UriInterface $uri
52
     * @param array        $params
53
     * @param string       $method
54
     *
55
     * @return string
56
     */
57
    public function getSignature(UriInterface $uri, array $params, $method = 'POST')
58
    {
59
        parse_str($uri->getQuery(), $queryStringData);
60
61
        $params = array_merge($queryStringData, $params);
62
        uksort($params, 'strcmp');
63
        print_R($params);
64
65
        $signatureData = $this->prepareParameters($params);
66
67
        // determine base uri
68
        $baseUri = $uri->getScheme() . '://' . $uri->getRawAuthority();
69
70
        if ('/' === $uri->getPath()) {
71
            $baseUri .= $uri->hasExplicitTrailingHostSlash() ? '/' : '';
72
        } else {
73
            $baseUri .= $uri->getPath();
74
        }
75
76
        $baseString = strtoupper($method) . '&';
77
        $baseString .= rawurlencode($baseUri) . '&';
78
        $baseString .= rawurlencode($this->buildSignatureDataString($signatureData));
79
80
        return base64_encode($this->hash($baseString));
81
    }
82
83
    /**
84
     * @param array $signatureData
85
     *
86
     * @return string
87
     */
88
    protected function buildSignatureDataString(array $signatureData)
89
    {
90
        return http_build_query($signatureData, null, '&', PHP_QUERY_RFC3986);
91
    }
92
93
    /**
94
     * Convert booleans to strings, removed unset parameters, and sorts the array
95
     *
96
     * @param array $data Data array
97
     *
98
     * @return array
99
     */
100
    public function prepareParameters($data)
101
    {
102
        ksort($data);
103
        foreach ($data as $key => &$value) {
104
            switch (gettype($value)) {
105
                case 'NULL':
106
                    unset($data[$key]);
107
                    break;
108
                case 'array':
109
                    $data[$key] = self::prepareParameters($value);
110
                    break;
111
                case 'boolean':
112
                    $data[$key] = $value ? 'true' : 'false';
113
                    break;
114
            }
115
        }
116
        return $data;
117
    }
118
119
    /**
120
     * @return string
121
     */
122
    protected function getSigningKey()
123
    {
124
        $signingKey = rawurlencode($this->credentials->getConsumerSecret()) . '&';
125
        if ($this->tokenSecret !== null) {
126
            $signingKey .= rawurlencode($this->tokenSecret);
127
        }
128
129
        return $signingKey;
130
    }
131
132
    /**
133
     * @param string $data
134
     *
135
     * @return string
136
     *
137
     * @throws UnsupportedHashAlgorithmException
138
     */
139
    protected function hash($data)
140
    {
141
        switch (strtoupper($this->algorithm)) {
142
            case 'HMAC-SHA1':
143
                return hash_hmac('sha1', $data, $this->getSigningKey(), true);
144
            default:
145
                throw new UnsupportedHashAlgorithmException(
146
                    'Unsupported hashing algorithm (' . $this->algorithm . ') used.'
147
                );
148
        }
149
    }
150
}
151