Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
CRAP
100.00% covered (success)
100.00%
1 / 1
NonceGenerator
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
2
100.00% covered (success)
100.00%
1 / 1
 getNonce
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
2
1<?php
2
3/**
4 * Class NonceGenerator
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Moravian Library 2019.
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  Security
25 * @author   Josef Moravec <moravec@mzk.cz>
26 * @license  https://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/ Wiki
28 */
29
30namespace VuFind\Security;
31
32/**
33 * VuFind class for generating nonce (number used once) used by content security
34 * policy.
35 *
36 * @category VuFind
37 * @package  Security
38 * @author   Josef Moravec <moravec@mzk.cz>
39 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
40 * @link     https://vufind.org/wiki/ Wiki
41 *
42 * @SuppressWarnings(PHPMD.NumberOfChildren)
43 */
44class NonceGenerator
45{
46    /**
47     * Generated nonce (number used once)
48     *
49     * @var string
50     */
51    protected string $nonce = '';
52
53    /**
54     * Generates a random nonce parameter.
55     *
56     * @return string
57     * @throws \Exception
58     */
59    public function getNonce(): string
60    {
61        if (!$this->nonce) {
62            $this->nonce = base64_encode(random_bytes(32));
63        }
64        return $this->nonce;
65    }
66}