Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
PasswordBasedCipher | 33 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.crypto.password; | |
21 | ||
22 | import java.io.IOException; | |
23 | ||
24 | import org.xwiki.crypto.cipher.Cipher; | |
25 | import org.xwiki.crypto.params.cipher.symmetric.SymmetricCipherParameters; | |
26 | ||
27 | /** | |
28 | * Password based cipher. | |
29 | * | |
30 | * @version $Id: fbdcae1ffc596d829ca6d85c5adf6e31df7546e2 $ | |
31 | * @since 5.4M1 | |
32 | */ | |
33 | public interface PasswordBasedCipher extends Cipher | |
34 | { | |
35 | /** | |
36 | * @return the key derivation function that has been used to derive the password of this cipher. | |
37 | */ | |
38 | KeyDerivationFunction getKeyDerivationFunction(); | |
39 | ||
40 | /** | |
41 | * @return the cipher parameters that has been used to initialize this cipher. | |
42 | */ | |
43 | SymmetricCipherParameters getParameters(); | |
44 | ||
45 | /** | |
46 | * Serialize the definition of this password based cipher. | |
47 | * | |
48 | * This serialization could be provided to an appropriate factory (like the one that have been used to create this | |
49 | * cipher) to produce an equivalent cipher. The serialization contains the derivation function algorithm and | |
50 | * parameters, and the cipher parameters. | |
51 | * For best interoperability, the recommended encoding is ASN.1 in DER format. | |
52 | * | |
53 | * @return an encoded definition of this password based cipher. | |
54 | * @throws IOException on error | |
55 | */ | |
56 | byte[] getEncoded() throws IOException; | |
57 | } |