framework/main/classes/streams/crypto/class_NullCryptoStream.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Stream\Crypto;
   4
   5 // Import framework stuff
   6 use CoreFramework\Stream\BaseStream;
   7
   8 /**
   9  * A null-encryption stream does not encrypt anything but can be used if e.e.
  10  * mcrypt is not installed.
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009  Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class NullCryptoStream extends BaseStream implements EncryptableStream {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Creates an instance of this node class
  44          *
  45          * @return      $streamInstance         An instance of this node class
  46          */
  47         public static final function createNullCryptoStream () {
  48                 // Get a new instance
  49                 $streamInstance = new NullCryptoStream();
  50
  51                 // Return the instance
  52                 return $streamInstance;
  53         }
  54
  55         /**
  56          * Encrypt the string with fixed salt
  57          *
  58          * @param       $str            The unencrypted string
  59          * @param       $key            Optional key, if none provided, a random key will be generated
  60          * @return      $encrypted      Encrypted string
  61          */
  62         public function encryptStream ($str, $key = NULL) {
  63                 // Just handle it over
  64                 $encrypted = (string) $str;
  65
  66                 // Return it
  67                 return $encrypted;
  68         }
  69
  70         /**
  71          * Decrypt the string with fixed salt
  72          *
  73          * @param       $encrypted      Encrypted string
  74          * @return      $str            The unencrypted string
  75          */
  76         public function decryptStream ($encrypted) {
  77                 // Just handle it over
  78                 $str = (string) $encrypted;
  79
  80                 // Return it
  81                 return $str;
  82         }
  83
  84         /**
  85          * Streams the data and maybe does something to it
  86          *
  87          * @param       $data   The data (string mostly) to "stream"
  88          * @return      $data   The data (string mostly) to "stream"
  89          * @throws      UnsupportedOperationException   If this method is called (which is a mistake)
  90          */
  91         public function streamData ($data) {
  92                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
  93                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  94         }
  95
  96 }