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