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

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