1 /*
2  * Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package javax.crypto.interfaces;
27 
28 import java.math.BigInteger;
29 
30 /**
31  * The interface to a PBE key.
32  *
33  * @author Valerie Peng
34  *
35  * @see javax.crypto.spec.PBEKeySpec
36  * @see javax.crypto.SecretKey
37  * @since 1.4
38  */
39 public interface PBEKey extends javax.crypto.SecretKey {
40 
41     /**
42      * The class fingerprint that is set to indicate serialization
43      * compatibility since J2SE 1.4.
44      *
45      * @deprecated A {@code serialVersionUID} field in an interface is
46      * ineffectual. Do not use; no replacement.
47      */
48     @Deprecated
49     @SuppressWarnings("serial")
50     @java.io.Serial
51     static final long serialVersionUID = -1430015993304333921L;
52 
53     /**
54      * Returns the password.
55      *
56      * <p> Note: this method should return a copy of the password. It is
57      * the caller's responsibility to zero out the password information after
58      * it is no longer needed.
59      *
60      * @return the password.
61      */
getPassword()62     char[] getPassword();
63 
64     /**
65      * Returns the salt or null if not specified.
66      *
67      * <p> Note: this method should return a copy of the salt. It is
68      * the caller's responsibility to zero out the salt information after
69      * it is no longer needed.
70      *
71      * @return the salt.
72      */
getSalt()73     byte[] getSalt();
74 
75     /**
76      * Returns the iteration count or 0 if not specified.
77      *
78      * @return the iteration count.
79      */
getIterationCount()80     int getIterationCount();
81 }
82