xref: /dokuwiki/vendor/paragonie/constant_time_encoding/src/EncoderInterface.php (revision 927933f55f286c8bea68959a13975cbcb59eb8ee)
1*927933f5SAndreas Gohr<?php
2*927933f5SAndreas Gohrdeclare(strict_types=1);
3*927933f5SAndreas Gohrnamespace ParagonIE\ConstantTime;
4*927933f5SAndreas Gohr
5*927933f5SAndreas Gohr/**
6*927933f5SAndreas Gohr *  Copyright (c) 2016 - 2022 Paragon Initiative Enterprises.
7*927933f5SAndreas Gohr *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
8*927933f5SAndreas Gohr *
9*927933f5SAndreas Gohr *  Permission is hereby granted, free of charge, to any person obtaining a copy
10*927933f5SAndreas Gohr *  of this software and associated documentation files (the "Software"), to deal
11*927933f5SAndreas Gohr *  in the Software without restriction, including without limitation the rights
12*927933f5SAndreas Gohr *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13*927933f5SAndreas Gohr *  copies of the Software, and to permit persons to whom the Software is
14*927933f5SAndreas Gohr *  furnished to do so, subject to the following conditions:
15*927933f5SAndreas Gohr *
16*927933f5SAndreas Gohr *  The above copyright notice and this permission notice shall be included in all
17*927933f5SAndreas Gohr *  copies or substantial portions of the Software.
18*927933f5SAndreas Gohr *
19*927933f5SAndreas Gohr *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20*927933f5SAndreas Gohr *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21*927933f5SAndreas Gohr *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22*927933f5SAndreas Gohr *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23*927933f5SAndreas Gohr *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24*927933f5SAndreas Gohr *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25*927933f5SAndreas Gohr *  SOFTWARE.
26*927933f5SAndreas Gohr */
27*927933f5SAndreas Gohr
28*927933f5SAndreas Gohr/**
29*927933f5SAndreas Gohr * Interface EncoderInterface
30*927933f5SAndreas Gohr * @package ParagonIE\ConstantTime
31*927933f5SAndreas Gohr */
32*927933f5SAndreas Gohrinterface EncoderInterface
33*927933f5SAndreas Gohr{
34*927933f5SAndreas Gohr    /**
35*927933f5SAndreas Gohr     * Convert a binary string into a hexadecimal string without cache-timing
36*927933f5SAndreas Gohr     * leaks
37*927933f5SAndreas Gohr     *
38*927933f5SAndreas Gohr     * @param string $binString (raw binary)
39*927933f5SAndreas Gohr     * @return string
40*927933f5SAndreas Gohr     */
41*927933f5SAndreas Gohr    public static function encode(string $binString): string;
42*927933f5SAndreas Gohr
43*927933f5SAndreas Gohr    /**
44*927933f5SAndreas Gohr     * Convert a binary string into a hexadecimal string without cache-timing
45*927933f5SAndreas Gohr     * leaks
46*927933f5SAndreas Gohr     *
47*927933f5SAndreas Gohr     * @param string $encodedString
48*927933f5SAndreas Gohr     * @param bool $strictPadding Error on invalid padding
49*927933f5SAndreas Gohr     * @return string (raw binary)
50*927933f5SAndreas Gohr     */
51*927933f5SAndreas Gohr    public static function decode(string $encodedString, bool $strictPadding = false): string;
52*927933f5SAndreas Gohr}
53