author | coffeys |
Thu, 23 Aug 2018 11:37:14 +0100 | |
changeset 51504 | c9a3e3cac9c7 |
parent 51293 | 53c3b460503c |
child 57950 | 4612a3cfb927 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
51293
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
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 com.sun.crypto.provider; |
|
27 |
||
48560 | 28 |
import java.lang.ref.Reference; |
31695 | 29 |
import java.security.MessageDigest; |
2 | 30 |
import java.security.KeyRep; |
31 |
import java.security.spec.InvalidKeySpecException; |
|
51293
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
32 |
import java.util.Arrays; |
25402
0c24d9aa8fb9
7065233: To interpret case-insensitive string locale independently
juh
parents:
14342
diff
changeset
|
33 |
import java.util.Locale; |
2 | 34 |
import javax.crypto.SecretKey; |
35 |
import javax.crypto.spec.PBEKeySpec; |
|
36 |
||
46097
22316369c9b0
8184744: Replace finalizer in crypto classes with Cleaner
rriggs
parents:
44534
diff
changeset
|
37 |
import jdk.internal.ref.CleanerFactory; |
22316369c9b0
8184744: Replace finalizer in crypto classes with Cleaner
rriggs
parents:
44534
diff
changeset
|
38 |
|
2 | 39 |
/** |
40 |
* This class represents a PBE key. |
|
41 |
* |
|
42 |
* @author Jan Luehe |
|
43 |
* |
|
44 |
*/ |
|
45 |
final class PBEKey implements SecretKey { |
|
46 |
||
47 |
static final long serialVersionUID = -2234768909660948176L; |
|
48 |
||
49 |
private byte[] key; |
|
50 |
||
51 |
private String type; |
|
52 |
||
53 |
/** |
|
54 |
* Creates a PBE key from a given PBE key specification. |
|
55 |
* |
|
46097
22316369c9b0
8184744: Replace finalizer in crypto classes with Cleaner
rriggs
parents:
44534
diff
changeset
|
56 |
* @param keytype the given PBE key specification |
2 | 57 |
*/ |
51293
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
58 |
PBEKey(PBEKeySpec keySpec, String keytype, boolean useCleaner) |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
59 |
throws InvalidKeySpecException { |
2 | 60 |
char[] passwd = keySpec.getPassword(); |
61 |
if (passwd == null) { |
|
62 |
// Should allow an empty password. |
|
63 |
passwd = new char[0]; |
|
64 |
} |
|
11835
c9e7cfc908b3
6879539: enable empty password support for pkcs12 keystore
weijun
parents:
10336
diff
changeset
|
65 |
// Accept "\0" to signify "zero-length password with no terminator". |
c9e7cfc908b3
6879539: enable empty password support for pkcs12 keystore
weijun
parents:
10336
diff
changeset
|
66 |
if (!(passwd.length == 1 && passwd[0] == 0)) { |
c9e7cfc908b3
6879539: enable empty password support for pkcs12 keystore
weijun
parents:
10336
diff
changeset
|
67 |
for (int i=0; i<passwd.length; i++) { |
c9e7cfc908b3
6879539: enable empty password support for pkcs12 keystore
weijun
parents:
10336
diff
changeset
|
68 |
if ((passwd[i] < '\u0020') || (passwd[i] > '\u007E')) { |
c9e7cfc908b3
6879539: enable empty password support for pkcs12 keystore
weijun
parents:
10336
diff
changeset
|
69 |
throw new InvalidKeySpecException("Password is not ASCII"); |
c9e7cfc908b3
6879539: enable empty password support for pkcs12 keystore
weijun
parents:
10336
diff
changeset
|
70 |
} |
2 | 71 |
} |
72 |
} |
|
73 |
this.key = new byte[passwd.length]; |
|
74 |
for (int i=0; i<passwd.length; i++) |
|
75 |
this.key[i] = (byte) (passwd[i] & 0x7f); |
|
51504
c9a3e3cac9c7
8209129: Further improvements to cipher buffer management
coffeys
parents:
51293
diff
changeset
|
76 |
Arrays.fill(passwd, '\0'); |
2 | 77 |
type = keytype; |
46097
22316369c9b0
8184744: Replace finalizer in crypto classes with Cleaner
rriggs
parents:
44534
diff
changeset
|
78 |
|
22316369c9b0
8184744: Replace finalizer in crypto classes with Cleaner
rriggs
parents:
44534
diff
changeset
|
79 |
// Use the cleaner to zero the key when no longer referenced |
51293
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
80 |
if (useCleaner) { |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
81 |
final byte[] k = this.key; |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
82 |
CleanerFactory.cleaner().register(this, |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
83 |
() -> Arrays.fill(k, (byte) 0x00)); |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
84 |
} |
2 | 85 |
} |
86 |
||
87 |
public byte[] getEncoded() { |
|
48560 | 88 |
// The key is zeroized by finalize() |
89 |
// The reachability fence ensures finalize() isn't called early |
|
90 |
byte[] result = key.clone(); |
|
91 |
Reference.reachabilityFence(this); |
|
92 |
return result; |
|
2 | 93 |
} |
94 |
||
95 |
public String getAlgorithm() { |
|
96 |
return type; |
|
97 |
} |
|
98 |
||
99 |
public String getFormat() { |
|
100 |
return "RAW"; |
|
101 |
} |
|
102 |
||
103 |
/** |
|
104 |
* Calculates a hash code value for the object. |
|
105 |
* Objects that are equal will also have the same hashcode. |
|
106 |
*/ |
|
107 |
public int hashCode() { |
|
108 |
int retval = 0; |
|
109 |
for (int i = 1; i < this.key.length; i++) { |
|
110 |
retval += this.key[i] * i; |
|
111 |
} |
|
25402
0c24d9aa8fb9
7065233: To interpret case-insensitive string locale independently
juh
parents:
14342
diff
changeset
|
112 |
return(retval ^= getAlgorithm().toLowerCase(Locale.ENGLISH).hashCode()); |
2 | 113 |
} |
114 |
||
115 |
public boolean equals(Object obj) { |
|
116 |
if (obj == this) |
|
117 |
return true; |
|
118 |
||
119 |
if (!(obj instanceof SecretKey)) |
|
120 |
return false; |
|
121 |
||
122 |
SecretKey that = (SecretKey)obj; |
|
123 |
||
124 |
if (!(that.getAlgorithm().equalsIgnoreCase(type))) |
|
125 |
return false; |
|
126 |
||
127 |
byte[] thatEncoded = that.getEncoded(); |
|
31695 | 128 |
boolean ret = MessageDigest.isEqual(this.key, thatEncoded); |
51293
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
129 |
Arrays.fill(thatEncoded, (byte)0x00); |
2 | 130 |
return ret; |
131 |
} |
|
132 |
||
133 |
/** |
|
51293
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
134 |
* Clears the internal copy of the key. |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
135 |
* |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
136 |
*/ |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
137 |
@Override |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
138 |
public void destroy() { |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
139 |
if (key != null) { |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
140 |
Arrays.fill(key, (byte) 0x00); |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
141 |
key = null; |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
142 |
} |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
143 |
} |
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
144 |
|
53c3b460503c
8208583: Better management of internal KeyStore buffers
coffeys
parents:
48560
diff
changeset
|
145 |
/** |
2 | 146 |
* readObject is called to restore the state of this key from |
147 |
* a stream. |
|
148 |
*/ |
|
149 |
private void readObject(java.io.ObjectInputStream s) |
|
150 |
throws java.io.IOException, ClassNotFoundException |
|
151 |
{ |
|
152 |
s.defaultReadObject(); |
|
10336
0bb1999251f8
7064075: Security libraries don't build with javac -Xlint:all,-deprecation -Werror
jjg
parents:
5506
diff
changeset
|
153 |
key = key.clone(); |
2 | 154 |
} |
155 |
||
156 |
||
157 |
/** |
|
158 |
* Replace the PBE key to be serialized. |
|
159 |
* |
|
160 |
* @return the standard KeyRep object to be serialized |
|
161 |
* |
|
162 |
* @throws java.io.ObjectStreamException if a new object representing |
|
163 |
* this PBE key could not be created |
|
164 |
*/ |
|
165 |
private Object writeReplace() throws java.io.ObjectStreamException { |
|
166 |
return new KeyRep(KeyRep.Type.SECRET, |
|
167 |
getAlgorithm(), |
|
168 |
getFormat(), |
|
169 |
getEncoded()); |
|
170 |
} |
|
171 |
} |