Added parameter 'key' to encryption methods to allow own keys

[core.git] / inc / classes / interfaces / streams / crypto / class_EncryptableStream.php

diff --git a/inc/classes/interfaces/streams/crypto/class_EncryptableStream.php b/inc/classes/interfaces/streams/crypto/class_EncryptableStream.php
index fafb299a58780fc7fdfd89e83636ab2025a52fcd..d40e19158bc36c414c78694c549104bc86ddd727 100644 (file)
--- a/inc/classes/interfaces/streams/crypto/class_EncryptableStream.php
+++ b/inc/classes/interfaces/streams/crypto/class_EncryptableStream.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -22,7 +22,23 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 interface EncryptableStream extends Streamable {
+       /**
+        * Encrypt the string with fixed salt
+        *
+        * @param       $str            The unencrypted string
+        * @param       $key            Optional key, if none provided, a random key will be generated
+        * @return      $encrypted      Encrypted string
+        */
+       function encryptStream ($str, $key = null);
+
+       /**
+        * Decrypt the string with fixed salt
+        *
+        * @param       $encrypted      Encrypted string
+        * @return      $str            The unencrypted string
+        */
+       function decryptStream ($encrypted);
 }
 
-//
+// [EOF]
 ?>