Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
6.67% |
1 / 15 |
|
0.00% |
0 / 1 |
CRAP | |
0.00% |
0 / 1 |
| TokenGenerator | |
6.67% |
1 / 15 |
|
0.00% |
0 / 1 |
17.01 | |
0.00% |
0 / 1 |
| generate | |
6.67% |
1 / 15 |
|
0.00% |
0 / 1 |
17.01 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU General Public License |
| 6 | * as published by the Free Software Foundation; under version 2 |
| 7 | * of the License (non-upgradable). |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 17 | * |
| 18 | * Copyright (c) 2016-2017 (original work) Open Assessment Technologies SA ; |
| 19 | */ |
| 20 | |
| 21 | namespace oat\tao\model\security; |
| 22 | |
| 23 | /** |
| 24 | * This traits let's you generate a random token |
| 25 | * |
| 26 | * @author Jean-Sébastien Conan <jean-sebastien.conan@vesperiagroup.com> |
| 27 | * @author Bertrand Chevrier <bertrand@taotesting.com> |
| 28 | */ |
| 29 | trait TokenGenerator |
| 30 | { |
| 31 | /** |
| 32 | * Generates a security token |
| 33 | * @param int $length the expected token length |
| 34 | * @return string the token |
| 35 | * @throws \common_Exception |
| 36 | */ |
| 37 | protected function generate($length = 40) |
| 38 | { |
| 39 | try { |
| 40 | return bin2hex(random_bytes($length / 2)); |
| 41 | } catch (\TypeError $e) { |
| 42 | // This is okay, so long as `Error` is caught before `Exception`. |
| 43 | throw new \common_Exception( |
| 44 | "An unexpected error has occurred while trying to generate a security token", |
| 45 | 0, |
| 46 | $e |
| 47 | ); |
| 48 | } catch (\Error $e) { |
| 49 | // This is required, if you do not need to do anything just rethrow. |
| 50 | throw new \common_Exception( |
| 51 | "An unexpected error has occurred while trying to generate a security token", |
| 52 | 0, |
| 53 | $e |
| 54 | ); |
| 55 | } catch (\Exception $e) { |
| 56 | throw new \common_Exception("Could not generate a security token. Is our OS secure?", 0, $e); |
| 57 | } |
| 58 | } |
| 59 | } |