ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
SHA256.cpp
1 /*
2  * Copyright (C) 2015 Southern Storm Software, Pty Ltd.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
23 #include "SHA256.h"
24 #include "Crypto.h"
25 #include "utility/RotateUtil.h"
26 #include "utility/EndianUtil.h"
27 #include "utility/ProgMemUtil.h"
28 #include <string.h>
29 
43 {
44  reset();
45 }
46 
52 {
53  clean(state);
54 }
55 
56 size_t SHA256::hashSize() const
57 {
58  return 32;
59 }
60 
61 size_t SHA256::blockSize() const
62 {
63  return 64;
64 }
65 
67 {
68  state.h[0] = 0x6a09e667;
69  state.h[1] = 0xbb67ae85;
70  state.h[2] = 0x3c6ef372;
71  state.h[3] = 0xa54ff53a,
72  state.h[4] = 0x510e527f;
73  state.h[5] = 0x9b05688c;
74  state.h[6] = 0x1f83d9ab;
75  state.h[7] = 0x5be0cd19;
76  state.chunkSize = 0;
77  state.length = 0;
78 }
79 
80 void SHA256::update(const void *data, size_t len)
81 {
82  // Update the total length (in bits, not bytes).
83  state.length += ((uint64_t)len) << 3;
84 
85  // Break the input up into 512-bit chunks and process each in turn.
86  const uint8_t *d = (const uint8_t *)data;
87  while (len > 0) {
88  uint8_t size = 64 - state.chunkSize;
89  if (size > len)
90  size = len;
91  memcpy(((uint8_t *)state.w) + state.chunkSize, d, size);
92  state.chunkSize += size;
93  len -= size;
94  d += size;
95  if (state.chunkSize == 64) {
96  processChunk();
97  state.chunkSize = 0;
98  }
99  }
100 }
101 
102 void SHA256::finalize(void *hash, size_t len)
103 {
104  // Pad the last chunk. We may need two padding chunks if there
105  // isn't enough room in the first for the padding and length.
106  uint8_t *wbytes = (uint8_t *)state.w;
107  if (state.chunkSize <= (64 - 9)) {
108  wbytes[state.chunkSize] = 0x80;
109  memset(wbytes + state.chunkSize + 1, 0x00, 64 - 8 - (state.chunkSize + 1));
110  state.w[14] = htobe32((uint32_t)(state.length >> 32));
111  state.w[15] = htobe32((uint32_t)state.length);
112  processChunk();
113  } else {
114  wbytes[state.chunkSize] = 0x80;
115  memset(wbytes + state.chunkSize + 1, 0x00, 64 - (state.chunkSize + 1));
116  processChunk();
117  memset(wbytes, 0x00, 64 - 8);
118  state.w[14] = htobe32((uint32_t)(state.length >> 32));
119  state.w[15] = htobe32((uint32_t)state.length);
120  processChunk();
121  }
122 
123  // Convert the result into big endian and return it.
124  for (uint8_t posn = 0; posn < 8; ++posn)
125  state.w[posn] = htobe32(state.h[posn]);
126 
127  // Copy the hash to the caller's return buffer.
128  if (len > 32)
129  len = 32;
130  memcpy(hash, state.w, len);
131 }
132 
134 {
135  clean(state);
136  reset();
137 }
138 
144 void SHA256::processChunk()
145 {
146  // Round constants for SHA-256.
147  static uint32_t const k[64] PROGMEM = {
148  0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5,
149  0x3956c25b, 0x59f111f1, 0x923f82a4, 0xab1c5ed5,
150  0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3,
151  0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174,
152  0xe49b69c1, 0xefbe4786, 0x0fc19dc6, 0x240ca1cc,
153  0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,
154  0x983e5152, 0xa831c66d, 0xb00327c8, 0xbf597fc7,
155  0xc6e00bf3, 0xd5a79147, 0x06ca6351, 0x14292967,
156  0x27b70a85, 0x2e1b2138, 0x4d2c6dfc, 0x53380d13,
157  0x650a7354, 0x766a0abb, 0x81c2c92e, 0x92722c85,
158  0xa2bfe8a1, 0xa81a664b, 0xc24b8b70, 0xc76c51a3,
159  0xd192e819, 0xd6990624, 0xf40e3585, 0x106aa070,
160  0x19a4c116, 0x1e376c08, 0x2748774c, 0x34b0bcb5,
161  0x391c0cb3, 0x4ed8aa4a, 0x5b9cca4f, 0x682e6ff3,
162  0x748f82ee, 0x78a5636f, 0x84c87814, 0x8cc70208,
163  0x90befffa, 0xa4506ceb, 0xbef9a3f7, 0xc67178f2
164  };
165 
166  // Convert the first 16 words from big endian to host byte order.
167  uint8_t index;
168  for (index = 0; index < 16; ++index)
169  state.w[index] = be32toh(state.w[index]);
170 
171  // Initialise working variables to the current hash value.
172  uint32_t a = state.h[0];
173  uint32_t b = state.h[1];
174  uint32_t c = state.h[2];
175  uint32_t d = state.h[3];
176  uint32_t e = state.h[4];
177  uint32_t f = state.h[5];
178  uint32_t g = state.h[6];
179  uint32_t h = state.h[7];
180 
181  // Perform the first 16 rounds of the compression function main loop.
182  uint32_t temp1, temp2;
183  for (index = 0; index < 16; ++index) {
184  temp1 = h + pgm_read_dword(k + index) + state.w[index] +
185  (rightRotate6(e) ^ rightRotate11(e) ^ rightRotate25(e)) +
186  ((e & f) ^ ((~e) & g));
187  temp2 = (rightRotate2(a) ^ rightRotate13(a) ^ rightRotate22(a)) +
188  ((a & b) ^ (a & c) ^ (b & c));
189  h = g;
190  g = f;
191  f = e;
192  e = d + temp1;
193  d = c;
194  c = b;
195  b = a;
196  a = temp1 + temp2;
197  }
198 
199  // Perform the 48 remaining rounds. We expand the first 16 words to
200  // 64 in-place in the "w" array. This saves 192 bytes of memory
201  // that would have otherwise need to be allocated to the "w" array.
202  for (; index < 64; ++index) {
203  // Expand the next word.
204  temp1 = state.w[(index - 15) & 0x0F];
205  temp2 = state.w[(index - 2) & 0x0F];
206  temp1 = state.w[index & 0x0F] =
207  state.w[(index - 16) & 0x0F] + state.w[(index - 7) & 0x0F] +
208  (rightRotate7(temp1) ^ rightRotate18(temp1) ^ (temp1 >> 3)) +
209  (rightRotate17(temp2) ^ rightRotate19(temp2) ^ (temp2 >> 10));
210 
211  // Perform the round.
212  temp1 = h + pgm_read_dword(k + index) + temp1 +
213  (rightRotate6(e) ^ rightRotate11(e) ^ rightRotate25(e)) +
214  ((e & f) ^ ((~e) & g));
215  temp2 = (rightRotate2(a) ^ rightRotate13(a) ^ rightRotate22(a)) +
216  ((a & b) ^ (a & c) ^ (b & c));
217  h = g;
218  g = f;
219  f = e;
220  e = d + temp1;
221  d = c;
222  c = b;
223  b = a;
224  a = temp1 + temp2;
225  }
226 
227  // Add the compressed chunk to the current hash value.
228  state.h[0] += a;
229  state.h[1] += b;
230  state.h[2] += c;
231  state.h[3] += d;
232  state.h[4] += e;
233  state.h[5] += f;
234  state.h[6] += g;
235  state.h[7] += h;
236 
237  // Attempt to clean up the stack.
238  a = b = c = d = e = f = g = h = temp1 = temp2 = 0;
239 }
void reset()
Resets the hash ready for a new hashing process.
Definition: SHA256.cpp:66
SHA256()
Constructs a SHA-256 hash object.
Definition: SHA256.cpp:42
void finalize(void *hash, size_t len)
Finalizes the hashing process and returns the hash.
Definition: SHA256.cpp:102
virtual ~SHA256()
Destroys this SHA-256 hash object after clearing sensitive information.
Definition: SHA256.cpp:51
size_t blockSize() const
Size of the internal block used by the hash algorithm.
Definition: SHA256.cpp:61
void update(const void *data, size_t len)
Updates the hash with more data.
Definition: SHA256.cpp:80
size_t hashSize() const
Size of the hash result from finalize().
Definition: SHA256.cpp:56
void clear()
Clears the hash state, removing all sensitive data, and then resets the hash ready for a new hashing ...
Definition: SHA256.cpp:133