Add common interface for cryptographic hash functions to lib/crypto.dart.

lib/crypto/crypto.dart

Index: lib/crypto/crypto.dart
diff --git a/lib/crypto/crypto.dart b/lib/crypto/crypto.dart
index fc17e8f10fae7586693c6136c1f18d7bef97217b..f4098732bad68ba9dbfdbdd57b70fc05748ee1d7 100644
--- a/lib/crypto/crypto.dart
+++ b/lib/crypto/crypto.dart
@@ -2,73 +2,43 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-#library("crypto");
-
-#source("sha1.dart");
-
-// Helpers used implementing the different crypto algorithms.
-
-final int _BITS_PER_BYTE = 8;
-final int _BYTES_PER_WORD = 4;
-final int _BITS_PER_WORD = _BITS_PER_BYTE * _BYTES_PER_WORD;
-final int _MASK_32 = 0xffffffff;
-
-int _roundUp(int val, int n) {
-  return (val + n - 1) & -n;
+#library('crypto');
+
+#source('sha_utils.dart');
+#source('sha1.dart');
+#source('sha256.dart');
+
+/**
+ * Interface for cryptographic hash functions.
+ *
+ * The [update] method is used to add data to the hash. The [digest] method
+ * is used to extract the message digest. Once the [digest] method has been
+ * called the CryptoHash object is in an invalid state and should not be
+ * used again.

[Ben Laurie (Google), 2012/04/25 13:17:13]

"should not"? You mean "will throw an exception"? Or "will bite you unexpectedly
at some future date"? :-)

In any case, why? Why not allow digest to be called as often as people want?

Also, what about clear()?

[Mads Ager (google), 2012/04/25 13:39:34]

Good point. I should throw an exception at least on calling update after digest
has been called. digest adds the padding to the data and therefore adding more
data makes no sense. I think throwing an exception in both methods if digest has
been called is clearest.
Create a new hasher if you want a hasher for new data.

[Ben Laurie (Google), 2012/04/25 13:55:43]

In, e.g., HMAC I need two instances of the same hash. So, here I am, in
HMAC(Hash hash). How do I create the second one?

+ */
+interface CryptoHash {
+  /**
+   * Add a list of bytes to the hash computation.
+   */
+  CryptoHash update(List<int> data);
+
+  /**
+   * Finish the hash computation and extract the message digest as
+   * a list of bytes.
+   */
+  List<int> digest();
 }
 
-// Rotate left limiting to unsigned 32-bit values.
-int _rotl32(int val, int shift) {
-  var mod_shift = shift & 31;
-  return ((val << mod_shift) & _MASK_32) |
-      ((val & _MASK_32) >> (32 - mod_shift));
-}
-
-// Add limiting to unsigned 32-bit values.
-int _add32(int left, int right) {
-  return (left + right) & _MASK_32;
-}
-
-void _bytesToWords(List<int> input,
-                   int in_offset,
-                   int in_len,
-                   List<int> output,
-                   int out_offset,
-                   int out_len) {
-  var cur = in_offset;
-  var end = in_offset + in_len;
-  var cur_out = out_offset;
-  var unroll_loop_end = in_len ~/ _BYTES_PER_WORD;
-
-  while (cur_out < unroll_loop_end) {
-    var word = (input[cur++] & 0xff) << 24;
-    word |= (input[cur++] & 0xff) << 16;
-    word |= (input[cur++] & 0xff) << 8;
-    word |= (input[cur++] & 0xff);
-    output[cur_out++] = word;
-  }
-  // Fill the rest of the output with the remaining bytes or zeros if no more
-  // data is available.
-  while (cur_out < (out_offset + out_len)) {
-    var word = 0;
-    var bit_shift = (_BYTES_PER_WORD - 1) * _BITS_PER_BYTE;
-    while (cur < end) {
-      word |= (input[cur++] & 0xff) << bit_shift;
-      bit_shift -= _BITS_PER_BYTE;
-    }
-    output[cur_out++] = word;
-  }
+/**
+ * SHA1 hash function implementation.
+ */
+interface SHA1 extends CryptoHash default _SHA1 {
+  SHA1();
 }
 
-List<int> _wordsToBytes(List<int> input) {
-  var len = input.length;
-  var output = new List<int>(len * _BYTES_PER_WORD);
-  var cur = 0;
-  for (var word in input) {
-    output[cur++] = word >> 24;
-    output[cur++] = (word >> 16) & 0xff;
-    output[cur++] = (word >> 8) & 0xff;
-    output[cur++] = word & 0xff;
-  }
-  return output;
+/**
+ * SHA256 hash function implementation.
+ */
+interface SHA256 extends CryptoHash default _SHA256 {
+  SHA256();
 }