1 /*
2 * Copyright (c) 2002, 2012, 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 sun.security.provider;
27
28 import java.security.*;
29 import java.util.Objects;
30 import java.math.BigInteger;
31
32 import jdk.internal.HotSpotIntrinsicCandidate;
33 import static sun.security.provider.ByteArrayAccess.*;
34
35 /**
36 * This class implements the Secure Hash Algorithm SHA-384 and SHA-512
37 * developed by the National Institute of Standards and Technology along
38 * with the National Security Agency.
39 *
40 * The two algorithms are almost identical. This file contains a base
41 * class SHA5 and two nested static subclasses as the classes to be used
42 * by the JCA framework.
43 *
44 * <p>It implements java.security.MessageDigestSpi, and can be used
45 * through Java Cryptography Architecture (JCA), as a pluggable
46 * MessageDigest implementation.
47 *
48 * @since 1.4.2
49 * @author Valerie Peng
50 * @author Andreas Sterbenz
51 */
52 abstract class SHA5 extends DigestBase {
53
54 private static final int ITERATION = 80;
55 // Constants for each round/iteration
56 private static final long[] ROUND_CONSTS = {
57 0x428A2F98D728AE22L, 0x7137449123EF65CDL, 0xB5C0FBCFEC4D3B2FL,
58 0xE9B5DBA58189DBBCL, 0x3956C25BF348B538L, 0x59F111F1B605D019L,
59 0x923F82A4AF194F9BL, 0xAB1C5ED5DA6D8118L, 0xD807AA98A3030242L,
60 0x12835B0145706FBEL, 0x243185BE4EE4B28CL, 0x550C7DC3D5FFB4E2L,
61 0x72BE5D74F27B896FL, 0x80DEB1FE3B1696B1L, 0x9BDC06A725C71235L,
62 0xC19BF174CF692694L, 0xE49B69C19EF14AD2L, 0xEFBE4786384F25E3L,
63 0x0FC19DC68B8CD5B5L, 0x240CA1CC77AC9C65L, 0x2DE92C6F592B0275L,
64 0x4A7484AA6EA6E483L, 0x5CB0A9DCBD41FBD4L, 0x76F988DA831153B5L,
65 0x983E5152EE66DFABL, 0xA831C66D2DB43210L, 0xB00327C898FB213FL,
66 0xBF597FC7BEEF0EE4L, 0xC6E00BF33DA88FC2L, 0xD5A79147930AA725L,
67 0x06CA6351E003826FL, 0x142929670A0E6E70L, 0x27B70A8546D22FFCL,
68 0x2E1B21385C26C926L, 0x4D2C6DFC5AC42AEDL, 0x53380D139D95B3DFL,
69 0x650A73548BAF63DEL, 0x766A0ABB3C77B2A8L, 0x81C2C92E47EDAEE6L,
70 0x92722C851482353BL, 0xA2BFE8A14CF10364L, 0xA81A664BBC423001L,
71 0xC24B8B70D0F89791L, 0xC76C51A30654BE30L, 0xD192E819D6EF5218L,
72 0xD69906245565A910L, 0xF40E35855771202AL, 0x106AA07032BBD1B8L,
73 0x19A4C116B8D2D0C8L, 0x1E376C085141AB53L, 0x2748774CDF8EEB99L,
74 0x34B0BCB5E19B48A8L, 0x391C0CB3C5C95A63L, 0x4ED8AA4AE3418ACBL,
75 0x5B9CCA4F7763E373L, 0x682E6FF3D6B2B8A3L, 0x748F82EE5DEFB2FCL,
76 0x78A5636F43172F60L, 0x84C87814A1F0AB72L, 0x8CC702081A6439ECL,
77 0x90BEFFFA23631E28L, 0xA4506CEBDE82BDE9L, 0xBEF9A3F7B2C67915L,
78 0xC67178F2E372532BL, 0xCA273ECEEA26619CL, 0xD186B8C721C0C207L,
79 0xEADA7DD6CDE0EB1EL, 0xF57D4F7FEE6ED178L, 0x06F067AA72176FBAL,
80 0x0A637DC5A2C898A6L, 0x113F9804BEF90DAEL, 0x1B710B35131C471BL,
81 0x28DB77F523047D84L, 0x32CAAB7B40C72493L, 0x3C9EBE0A15C9BEBCL,
82 0x431D67C49C100D4CL, 0x4CC5D4BECB3E42B6L, 0x597F299CFC657E2AL,
83 0x5FCB6FAB3AD6FAECL, 0x6C44198C4A475817L
84 };
85
86 // buffer used by implCompress()
87 private long[] W;
88
89 // state of this object
90 private long[] state;
91
92 // initial state value. different between SHA-384 and SHA-512
93 private final long[] initialHashes;
94
95 /**
96 * Creates a new SHA object.
97 */
98 SHA5(String name, int digestLength, long[] initialHashes) {
99 super(name, digestLength, 128);
100 this.initialHashes = initialHashes;
101 state = new long[8];
102 W = new long[80];
103 implReset();
104 }
105
106 final void implReset() {
107 System.arraycopy(initialHashes, 0, state, 0, state.length);
108 }
109
110 final void implDigest(byte[] out, int ofs) {
111 long bitsProcessed = bytesProcessed << 3;
112
113 int index = (int)bytesProcessed & 0x7f;
114 int padLen = (index < 112) ? (112 - index) : (240 - index);
115 engineUpdate(padding, 0, padLen + 8);
116
117 i2bBig4((int)(bitsProcessed >>> 32), buffer, 120);
118 i2bBig4((int)bitsProcessed, buffer, 124);
119 implCompress(buffer, 0);
120
121 l2bBig(state, 0, out, ofs, engineGetDigestLength());
122 }
123
124 /**
125 * logical function ch(x,y,z) as defined in spec:
126 * @return (x and y) xor ((complement x) and z)
127 * @param x long
128 * @param y long
129 * @param z long
130 */
131 private static long lf_ch(long x, long y, long z) {
132 return (x & y) ^ ((~x) & z);
133 }
134
135 /**
136 * logical function maj(x,y,z) as defined in spec:
137 * @return (x and y) xor (x and z) xor (y and z)
138 * @param x long
139 * @param y long
140 * @param z long
141 */
142 private static long lf_maj(long x, long y, long z) {
143 return (x & y) ^ (x & z) ^ (y & z);
144 }
145
146 /**
147 * logical function R(x,s) - right shift
148 * @return x right shift for s times
149 * @param x long
150 * @param s int
151 */
152 private static long lf_R(long x, int s) {
153 return (x >>> s);
154 }
155
156 /**
157 * logical function S(x,s) - right rotation
158 * @return x circular right shift for s times
159 * @param x long
160 * @param s int
161 */
162 private static long lf_S(long x, int s) {
163 return (x >>> s) | (x << (64 - s));
164 }
165
166 /**
167 * logical function sigma0(x) - xor of results of right rotations
168 * @return S(x,28) xor S(x,34) xor S(x,39)
169 * @param x long
170 */
171 private static long lf_sigma0(long x) {
172 return lf_S(x, 28) ^ lf_S(x, 34) ^ lf_S(x, 39);
173 }
174
175 /**
176 * logical function sigma1(x) - xor of results of right rotations
177 * @return S(x,14) xor S(x,18) xor S(x,41)
178 * @param x long
179 */
180 private static long lf_sigma1(long x) {
181 return lf_S(x, 14) ^ lf_S(x, 18) ^ lf_S(x, 41);
182 }
183
184 /**
185 * logical function delta0(x) - xor of results of right shifts/rotations
186 * @return long
187 * @param x long
188 */
189 private static long lf_delta0(long x) {
190 return lf_S(x, 1) ^ lf_S(x, 8) ^ lf_R(x, 7);
191 }
192
193 /**
194 * logical function delta1(x) - xor of results of right shifts/rotations
195 * @return long
196 * @param x long
197 */
198 private static long lf_delta1(long x) {
199 return lf_S(x, 19) ^ lf_S(x, 61) ^ lf_R(x, 6);
200 }
201
202 /**
203 * Compute the hash for the current block.
204 *
205 * This is in the same vein as Peter Gutmann's algorithm listed in
206 * the back of Applied Cryptography, Compact implementation of
207 * "old" NIST Secure Hash Algorithm.
208 */
209 final void implCompress(byte[] buf, int ofs) {
210 implCompressCheck(buf, ofs);
211 implCompress0(buf, ofs);
212 }
213
214 private void implCompressCheck(byte[] buf, int ofs) {
215 Objects.requireNonNull(buf);
216
217 // The checks performed by the method 'b2iBig128'
218 // are sufficient for the case when the method
219 // 'implCompressImpl' is replaced with a compiler
220 // intrinsic.
221 b2lBig128(buf, ofs, W);
222 }
223
224 // The method 'implCompressImpl' seems not to use its parameters.
225 // The method can, however, be replaced with a compiler intrinsic
226 // that operates directly on the array 'buf' (starting from
227 // offset 'ofs') and not on array 'W', therefore 'buf' and 'ofs'
228 // must be passed as parameter to the method.
229 @HotSpotIntrinsicCandidate
230 private final void implCompress0(byte[] buf, int ofs) {
231 // The first 16 longs are from the byte stream, compute the rest of
232 // the W[]'s
233 for (int t = 16; t < ITERATION; t++) {
234 W[t] = lf_delta1(W[t-2]) + W[t-7] + lf_delta0(W[t-15])
235 + W[t-16];
236 }
237
238 long a = state[0];
239 long b = state[1];
240 long c = state[2];
241 long d = state[3];
242 long e = state[4];
243 long f = state[5];
244 long g = state[6];
245 long h = state[7];
246
247 for (int i = 0; i < ITERATION; i++) {
248 long T1 = h + lf_sigma1(e) + lf_ch(e,f,g) + ROUND_CONSTS[i] + W[i];
249 long T2 = lf_sigma0(a) + lf_maj(a,b,c);
250 h = g;
251 g = f;
252 f = e;
253 e = d + T1;
254 d = c;
255 c = b;
256 b = a;
257 a = T1 + T2;
258 }
259 state[0] += a;
260 state[1] += b;
261 state[2] += c;
262 state[3] += d;
263 state[4] += e;
264 state[5] += f;
265 state[6] += g;
266 state[7] += h;
267 }
268
269 public Object clone() throws CloneNotSupportedException {
270 SHA5 copy = (SHA5) super.clone();
271 copy.state = copy.state.clone();
272 copy.W = new long[80];
273 return copy;
274 }
275
276 /**
277 * SHA-512 implementation class.
278 */
279 public static final class SHA512 extends SHA5 {
280
281 private static final long[] INITIAL_HASHES = {
282 0x6a09e667f3bcc908L, 0xbb67ae8584caa73bL,
283 0x3c6ef372fe94f82bL, 0xa54ff53a5f1d36f1L,
284 0x510e527fade682d1L, 0x9b05688c2b3e6c1fL,
285 0x1f83d9abfb41bd6bL, 0x5be0cd19137e2179L
286 };
287
288 public SHA512() {
289 super("SHA-512", 64, INITIAL_HASHES);
290 }
291 }
292
293 /**
294 * SHA-384 implementation class.
295 */
296 public static final class SHA384 extends SHA5 {
297
298 private static final long[] INITIAL_HASHES = {
299 0xcbbb9d5dc1059ed8L, 0x629a292a367cd507L,
300 0x9159015a3070dd17L, 0x152fecd8f70e5939L,
301 0x67332667ffc00b31L, 0x8eb44a8768581511L,
302 0xdb0c2e0d64f98fa7L, 0x47b5481dbefa4fa4L
303 };
304
305 public SHA384() {
306 super("SHA-384", 48, INITIAL_HASHES);
307 }
308 }
309 }