framework/main/interfaces/streams/crypto/class_EncryptableStream.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Stream\Crypto;
   4
   5 // Import framework stuff
   6 use CoreFramework\Stream\Stream;
   7
   8 /**
   9  * An interface for encrypted data streams
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 interface EncryptableStream extends Stream {
  31         /**
  32          * Separator on many places
  33          */
  34         const DATA_PAYLOAD_SEPARATOR = '|';
  35
  36         /**
  37          * Encrypt the string with fixed salt
  38          *
  39          * @param       $str            The unencrypted string
  40          * @param       $key            Optional key, if none provided, a random key will be generated
  41          * @return      $encrypted      Encrypted string
  42          */
  43         function encryptStream ($str, $key = NULL);
  44
  45         /**
  46          * Decrypt the string with fixed salt
  47          *
  48          * @param       $encrypted      Encrypted string
  49          * @return      $str            The unencrypted string
  50          */
  51         function decryptStream ($encrypted);
  52
  53 }