aboutsummaryrefslogtreecommitdiffstats
path: root/libraries/spongycastle/jce/src/main/java/javax/crypto/interfaces/PBEKey.java
blob: 8d9ab1f67e0f1ebe4f74a14b72702eb7371372de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
package javax.crypto.interfaces;

import javax.crypto.SecretKey;

/**
 * The interface to a PBE key.
 * 
 * @see PBEKeySpec, SecretKey
 */
public interface PBEKey
    extends SecretKey
{
    /**
     * Returns the password.
     * 
     * Note: this method should return a copy of the password. It is the
     * caller's responsibility to zero out the password information after it is
     * no longer needed.
     * 
     * @return the password.
     */
    public char[] getPassword();

    /**
     * Returns the salt or null if not specified.
     * 
     * Note: this method should return a copy of the salt. It is the caller's
     * responsibility to zero out the salt information after it is no longer
     * needed.
     * 
     * @return the salt.
     */
    public byte[] getSalt();

    /**
     * Returns the iteration count or 0 if not specified.
     * 
     * @return the iteration count.
     */
    public int getIterationCount();
}