Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
2 / 2
CRAP
100.00% covered (success)
100.00%
1 / 1
HMAC
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
2 / 2
3
100.00% covered (success)
100.00%
1 / 1
 __construct
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 generate
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
1 / 1
2
1<?php
2
3/**
4 * HMAC hash generator
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2007.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  Crypt
25 * @author   Luke O'Sullivan <l.osullivan@swansea.ac.uk>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development Wiki
28 */
29
30namespace VuFind\Crypt;
31
32/**
33 * HMAC hash generator wrapper
34 *
35 * @category VuFind
36 * @package  Crypt
37 * @author   Luke O'Sullivan <l.osullivan@swansea.ac.uk>
38 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
39 * @link     https://vufind.org/wiki/development Wiki
40 */
41class HMAC
42{
43    /**
44     * Hash key
45     *
46     * @var string
47     */
48    protected $hashKey;
49
50    /**
51     * Constructor
52     *
53     * @param string $key Hash key
54     */
55    public function __construct($key)
56    {
57        $this->hashKey = $key;
58    }
59
60    /**
61     * Accepts $keysToHash, a list of array keys, and $keyValueArray, a keyed array
62     *
63     * @param array $keysToHash    A list of keys to hash
64     * @param array $keyValueArray A keyed array
65     *
66     * @return string A hash_hmac string using md5
67     */
68    public function generate($keysToHash, $keyValueArray)
69    {
70        $str = '';
71        foreach ($keysToHash as $key) {
72            $value = $keyValueArray[$key] ?? '';
73            $str .= $key . '=' . $value . '|';
74        }
75        return hash_hmac('md5', $str, $this->hashKey);
76    }
77}