|
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/Instructions |
|
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\Instructions; |
|
47
|
|
|
|
|
48
|
|
|
use GanbaroDigital\MessagingPipeline\V1\InstructionTypes; |
|
49
|
|
|
use GanbaroDigital\MessagingPipeline\V1\NextInstruction; |
|
50
|
|
|
use GanbaroDigital\MessagingPipeline\V1\Operations; |
|
51
|
|
|
use GanbaroDigital\MessagingPipeline\V1\Requirements; |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* base class for MessagingPipelineInstructions that work with HMACs |
|
55
|
|
|
*/ |
|
56
|
|
|
abstract class HmacBaseClass implements InstructionTypes\StringInMixedOut |
|
57
|
|
|
{ |
|
58
|
|
|
/** |
|
59
|
|
|
* which HMAC algorithm are we using? |
|
60
|
|
|
* @var string |
|
61
|
|
|
*/ |
|
62
|
|
|
protected $hmacType; |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
65
|
|
|
* what shared secret key are we using for calculating the HMAC? |
|
66
|
|
|
* @var string |
|
67
|
|
|
*/ |
|
68
|
|
|
protected $hmacKey; |
|
69
|
|
|
|
|
70
|
|
|
/** |
|
71
|
|
|
* creates a MessagePipelineInstruction that's ready to use |
|
72
|
|
|
* |
|
73
|
|
|
* expects the following config: |
|
74
|
|
|
* - $config['type'] - a HMAC algorithm |
|
75
|
|
|
* - $config['key'] - a shared secret key |
|
76
|
|
|
* |
|
77
|
|
|
* @param array $config |
|
78
|
|
|
* the config that we require |
|
79
|
|
|
*/ |
|
80
|
|
|
public function __construct(array $config) |
|
81
|
|
|
{ |
|
82
|
|
|
// robustness |
|
83
|
|
|
Requirements\RequireConfigHasKey::apply('type')->to($config); |
|
84
|
|
|
Requirements\RequireConfigHasKey::apply('key')->to($config); |
|
85
|
|
|
|
|
86
|
|
|
$this->hmacType = $config['type']; |
|
87
|
|
|
$this->hmacKey = $config['key']; |
|
88
|
|
|
} |
|
89
|
|
|
|
|
90
|
|
|
/** |
|
91
|
|
|
* executes whatever work this messaging pipeline instruction |
|
92
|
|
|
* is here to do |
|
93
|
|
|
* |
|
94
|
|
|
* @param NextInstruction $next |
|
95
|
|
|
* the instruction to call when our work is done |
|
96
|
|
|
* @param string $payload |
|
97
|
|
|
* the data that we're processing |
|
98
|
|
|
* @return mixed |
|
99
|
|
|
* whatever $next() returns when we call it |
|
100
|
|
|
*/ |
|
101
|
|
|
abstract public function __invoke(NextInstruction $next, string $payload); |
|
102
|
|
|
} |
ganbarodigital /
php-mv-messaging-pipeline
