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

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