1927933f5SAndreas Gohr<?php 2927933f5SAndreas Gohrdeclare(strict_types=1); 3927933f5SAndreas Gohrnamespace ParagonIE\ConstantTime; 4927933f5SAndreas Gohr 5*8e88a29bSAndreas Gohruse SensitiveParameter; 6*8e88a29bSAndreas Gohr 7927933f5SAndreas Gohr/** 8927933f5SAndreas Gohr * Copyright (c) 2016 - 2022 Paragon Initiative Enterprises. 9927933f5SAndreas Gohr * Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com) 10927933f5SAndreas Gohr * 11927933f5SAndreas Gohr * Permission is hereby granted, free of charge, to any person obtaining a copy 12927933f5SAndreas Gohr * of this software and associated documentation files (the "Software"), to deal 13927933f5SAndreas Gohr * in the Software without restriction, including without limitation the rights 14927933f5SAndreas Gohr * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 15927933f5SAndreas Gohr * copies of the Software, and to permit persons to whom the Software is 16927933f5SAndreas Gohr * furnished to do so, subject to the following conditions: 17927933f5SAndreas Gohr * 18927933f5SAndreas Gohr * The above copyright notice and this permission notice shall be included in all 19927933f5SAndreas Gohr * copies or substantial portions of the Software. 20927933f5SAndreas Gohr * 21927933f5SAndreas Gohr * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 22927933f5SAndreas Gohr * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 23927933f5SAndreas Gohr * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 24927933f5SAndreas Gohr * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 25927933f5SAndreas Gohr * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 26927933f5SAndreas Gohr * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 27927933f5SAndreas Gohr * SOFTWARE. 28927933f5SAndreas Gohr */ 29927933f5SAndreas Gohr 30927933f5SAndreas Gohr/** 31927933f5SAndreas Gohr * Interface EncoderInterface 32927933f5SAndreas Gohr * @package ParagonIE\ConstantTime 33927933f5SAndreas Gohr */ 34927933f5SAndreas Gohrinterface EncoderInterface 35927933f5SAndreas Gohr{ 36927933f5SAndreas Gohr /** 37927933f5SAndreas Gohr * Convert a binary string into a hexadecimal string without cache-timing 38927933f5SAndreas Gohr * leaks 39927933f5SAndreas Gohr * 40927933f5SAndreas Gohr * @param string $binString (raw binary) 41927933f5SAndreas Gohr * @return string 42927933f5SAndreas Gohr */ 43*8e88a29bSAndreas Gohr public static function encode( 44*8e88a29bSAndreas Gohr #[SensitiveParameter] 45*8e88a29bSAndreas Gohr string $binString 46*8e88a29bSAndreas Gohr ): string; 47927933f5SAndreas Gohr 48927933f5SAndreas Gohr /** 49927933f5SAndreas Gohr * Convert a binary string into a hexadecimal string without cache-timing 50927933f5SAndreas Gohr * leaks 51927933f5SAndreas Gohr * 52927933f5SAndreas Gohr * @param string $encodedString 53927933f5SAndreas Gohr * @param bool $strictPadding Error on invalid padding 54927933f5SAndreas Gohr * @return string (raw binary) 55927933f5SAndreas Gohr */ 56*8e88a29bSAndreas Gohr public static function decode( 57*8e88a29bSAndreas Gohr #[SensitiveParameter] 58*8e88a29bSAndreas Gohr string $encodedString, 59*8e88a29bSAndreas Gohr bool $strictPadding = false 60*8e88a29bSAndreas Gohr ): string; 61927933f5SAndreas Gohr} 62