author | darcy |
Thu, 29 Aug 2019 10:52:21 -0700 | |
changeset 57950 | 4612a3cfb927 |
parent 51437 | 6221a199ec20 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
51317
e122220d7d7e
8209024: Use SuppressWarnings on serialVersionUID fields in interfaces
darcy
parents:
47216
diff
changeset
|
2 |
* Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved. |
2 | 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 |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 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 |
* |
|
5506 | 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. |
|
2 | 24 |
*/ |
25 |
||
26 |
package javax.crypto; |
|
27 |
||
28 |
/** |
|
29 |
* A secret (symmetric) key. |
|
15287
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
30 |
* The purpose of this interface is to group (and provide type safety |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
31 |
* for) all secret key interfaces. |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
32 |
* <p> |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
33 |
* Provider implementations of this interface must overwrite the |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
34 |
* {@code equals} and {@code hashCode} methods inherited from |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
35 |
* {@link java.lang.Object}, so that secret keys are compared based on |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
36 |
* their underlying key material and not based on reference. |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
37 |
* Implementations should override the default {@code destroy} and |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
38 |
* {@code isDestroyed} methods from the |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
39 |
* {@link javax.security.auth.Destroyable} interface to enable |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
40 |
* sensitive key information to be destroyed, cleared, or in the case |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
41 |
* where such information is immutable, unreferenced. |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
42 |
* Finally, since {@code SecretKey} is {@code Serializable}, implementations |
15290 | 43 |
* should also override |
44 |
* {@link java.io.ObjectOutputStream#writeObject(java.lang.Object)} |
|
15287
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
45 |
* to prevent keys that have been destroyed from being serialized. |
2 | 46 |
* |
15287
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
47 |
* <p>Keys that implement this interface return the string {@code RAW} |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
48 |
* as their encoding format (see {@code getFormat}), and return the |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
49 |
* raw key bytes as the result of a {@code getEncoded} method call. (The |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
50 |
* {@code getFormat} and {@code getEncoded} methods are inherited |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
51 |
* from the {@link java.security.Key} parent interface.) |
2 | 52 |
* |
53 |
* @author Jan Luehe |
|
54 |
* |
|
55 |
* @see SecretKeyFactory |
|
56 |
* @see Cipher |
|
57 |
* @since 1.4 |
|
58 |
*/ |
|
59 |
||
15287
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
60 |
public interface SecretKey extends |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
61 |
java.security.Key, javax.security.auth.Destroyable { |
cfebcf362320
6263419: No way to clean the memory for a java.security.Key
vinnie
parents:
5506
diff
changeset
|
62 |
|
2 | 63 |
/** |
64 |
* The class fingerprint that is set to indicate serialization |
|
65 |
* compatibility since J2SE 1.4. |
|
51437
6221a199ec20
8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents:
51317
diff
changeset
|
66 |
* |
6221a199ec20
8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents:
51317
diff
changeset
|
67 |
* @deprecated A {@code serialVersionUID} field in an interface is |
6221a199ec20
8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents:
51317
diff
changeset
|
68 |
* ineffectual. Do not use; no replacement. |
2 | 69 |
*/ |
51437
6221a199ec20
8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents:
51317
diff
changeset
|
70 |
@Deprecated |
6221a199ec20
8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents:
51317
diff
changeset
|
71 |
@SuppressWarnings("serial") |
2 | 72 |
static final long serialVersionUID = -4795878709595146952L; |
73 |
} |