extlib/ParagonIE/ConstantTime/EncoderInterface.php

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