1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
declare(strict_types=1); |
4
|
|
|
|
5
|
|
|
/** |
6
|
|
|
* Copyright (c) 2017-present Ganbaro Digital Ltd |
7
|
|
|
* All rights reserved. |
8
|
|
|
* |
9
|
|
|
* Redistribution and use in source and binary forms, with or without |
10
|
|
|
* modification, are permitted provided that the following conditions |
11
|
|
|
* are met: |
12
|
|
|
* |
13
|
|
|
* * Redistributions of source code must retain the above copyright |
14
|
|
|
* notice, this list of conditions and the following disclaimer. |
15
|
|
|
* |
16
|
|
|
* * Redistributions in binary form must reproduce the above copyright |
17
|
|
|
* notice, this list of conditions and the following disclaimer in |
18
|
|
|
* the documentation and/or other materials provided with the |
19
|
|
|
* distribution. |
20
|
|
|
* |
21
|
|
|
* * Neither the names of the copyright holders nor the names of his |
22
|
|
|
* contributors may be used to endorse or promote products derived |
23
|
|
|
* from this software without specific prior written permission. |
24
|
|
|
* |
25
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
26
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
27
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
28
|
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
29
|
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
30
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
31
|
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
32
|
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
33
|
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
34
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
35
|
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
36
|
|
|
* POSSIBILITY OF SUCH DAMAGE. |
37
|
|
|
* |
38
|
|
|
* @category Libraries |
39
|
|
|
* @package MessagingPipeline/Operations |
40
|
|
|
* @author Stuart Herbert <[email protected]> |
41
|
|
|
* @copyright 2017-present Ganbaro Digital Ltd www.ganbarodigital.com |
42
|
|
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License |
43
|
|
|
* @link http://ganbarodigital.github.io/php-mv-messaging-pipeline |
44
|
|
|
*/ |
45
|
|
|
|
46
|
|
|
namespace GanbaroDigital\MessagingPipeline\V1\Operations; |
47
|
|
|
|
48
|
|
|
use GanbaroDigital\MessagingPipeline\V1\Requirements\RequireValidHmacAlgorithm; |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* create a hashed-message authentication code (HMAC) for a message |
52
|
|
|
*/ |
53
|
|
|
class CalculateHmac |
|
|
|
|
54
|
|
|
{ |
55
|
|
|
/** |
56
|
|
|
* create hashed-message authentication code (HMAC) for a message |
57
|
|
|
* |
58
|
|
|
* @param string $message |
59
|
|
|
* the message you want to sign |
60
|
|
|
* @param string $hashAlgo |
61
|
|
|
* the hash algorithm you want to use |
62
|
|
|
* this must be supported by hash_hmac() |
63
|
|
|
* @param string $key |
64
|
|
|
* the shared password you want to use to calculate the HMAC |
65
|
|
|
* @return string |
66
|
|
|
* the HMAC that we calculated |
67
|
|
|
* |
68
|
|
|
* @throws UnsupportedHmacAlgorithm |
69
|
|
|
* if $hashAlgo isn't supported by our PHP runtime |
70
|
|
|
*/ |
71
|
|
|
public static function for(string $message, string $hashAlgo, string $key) : string |
72
|
|
|
{ |
73
|
|
|
// robustness! |
74
|
|
|
RequireValidHmacAlgorithm::apply()->to($hashAlgo); |
75
|
|
|
return hash_hmac($hashAlgo, $message, $key); |
76
|
|
|
} |
77
|
|
|
} |