Export methods and update documentation

- Export codecs
- Update documentation
- Truncate seed to 32-bit integer for xxh32

Author: dipu-bd

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.11.2
+
+- Export codecs
+- Update documentation
+- Truncate seed to 32-bit integer for xxh32
+
 # 1.11.1
 
 - Export a few additional clases

README.md

@@ -77,7 +77,6 @@ Examples can be found inside the `example` folder.
 
 ```dart
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 
 void main() {
   var text = "Happy Hashing!";

example/hashlib_example.dart

@@ -1,5 +1,4 @@
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 
 void main() {
   var text = "Happy Hashing!";

example/otpauth_parser.dart

@@ -1,7 +1,6 @@
 import 'dart:typed_data';
 
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 
 /// Parse any otpauth URI
 OTPAuth parse(String keyUri) {

lib/src/algorithms/xxh32_32bit.dart

@@ -32,10 +32,10 @@ class XXHash32Sink extends BlockHashSink {
   @override
   void reset() {
     super.reset();
-    _acc1 = seed + prime32_1 + prime32_2;
-    _acc2 = seed + prime32_2;
-    _acc3 = seed + 0;
-    _acc4 = seed - prime32_1;
+    _acc1 = (seed & _mask32) + prime32_1 + prime32_2;
+    _acc2 = (seed & _mask32) + prime32_2;
+    _acc3 = (seed & _mask32) + 0;
+    _acc4 = (seed & _mask32) - prime32_1;
   }
 
   @override
@@ -94,7 +94,7 @@ class XXHash32Sink extends BlockHashSink {
     int _hash;
 
     if (messageLength < 16) {
-      _hash = seed + prime32_5;
+      _hash = (seed & _mask32) + prime32_5;
     } else {
       _hash = rotl32(_acc1, 1);
       _hash += rotl32(_acc2, 7);

lib/src/algorithms/xxh32_64bit.dart

@@ -33,10 +33,10 @@ class XXHash32Sink extends BlockHashSink {
   @override
   void reset() {
     super.reset();
-    _acc1 = seed + prime32_1 + prime32_2;
-    _acc2 = seed + prime32_2;
-    _acc3 = seed + 0;
-    _acc4 = seed - prime32_1;
+    _acc1 = (seed & _mask32) + prime32_1 + prime32_2;
+    _acc2 = (seed & _mask32) + prime32_2;
+    _acc3 = (seed & _mask32) + 0;
+    _acc4 = (seed & _mask32) - prime32_1;
   }
 
   @override
@@ -80,7 +80,7 @@ class XXHash32Sink extends BlockHashSink {
     int _hash;
 
     if (messageLength < 16) {
-      _hash = seed + prime32_5;
+      _hash = (seed & _mask32) + prime32_5;
     } else {
       _hash = (_acc1 << 1) | (_acc1 >>> 31);
       _hash += (_acc2 << 7) | (_acc2 >>> 25);

lib/src/codecs_base.dart

@@ -1,8 +1,10 @@
 // Copyright (c) 2023, Sudipto Chandra
 // All rights reserved. Check LICENSE file for details.
 
-export 'codecs/ascii.dart';
-export 'codecs/base16.dart';
-export 'codecs/base32.dart';
-export 'codecs/base64.dart';
-export 'codecs/base64url.dart';
+export 'codecs/ascii.dart' hide ASCIICodec;
+export 'codecs/base16.dart' hide B16Codec;
+export 'codecs/base32.dart' hide B32Codec;
+export 'codecs/base64.dart' hide B64Codec;
+export 'codecs/base64url.dart' hide B64URLCodec;
+export 'codecs/codec.dart';
+export 'codecs/converter.dart';

lib/src/hashlib_base.dart

@@ -5,10 +5,12 @@ export 'alder32.dart';
 export 'argon2.dart';
 export 'blake2b.dart';
 export 'blake2s.dart';
-export 'codecs/codec.dart' show Uint8Codec;
-export 'core/block_hash.dart' show BlockHashBase, BlockHashSink;
-export 'core/hash_base.dart' show HashBase, HashDigestSink;
-export 'core/hash_digest.dart' show HashDigest;
+export 'codecs_base.dart';
+export 'core/block_hash.dart';
+export 'core/hash_base.dart';
+export 'core/hash_digest.dart';
+export 'core/kdf_base.dart';
+export 'core/mac_base.dart';
 export 'crc16.dart';
 export 'crc32.dart';
 export 'crc64.dart';
@@ -22,7 +24,7 @@ export 'otpauth.dart';
 export 'pbkdf2.dart';
 export 'poly1305.dart';
 export 'random.dart';
-export 'registry.dart' show BlockHashRegistry, HashRegistry;
+export 'registry.dart';
 export 'ripemd128.dart';
 export 'ripemd160.dart';
 export 'ripemd256.dart';

lib/src/md5.dart

@@ -8,7 +8,7 @@ import 'package:hashlib/src/core/block_hash.dart';
 import 'package:hashlib/src/core/hash_digest.dart';
 
 /// MD5 can be used as a checksum to verify data integrity against unintentional
-/// corruption. Although it was widely used as a cryptographic has function
+/// corruption. Although it was widely used as a cryptographic hash function
 /// once, it has been found to suffer from extensive vulnerabilities.
 ///
 /// **WARNING: It should not be used for cryptographic purposes.**

lib/src/xxh128.dart

@@ -30,6 +30,12 @@ class XXH128 extends BlockHashBase {
   final int seed;
   final List<int>? secret;
 
+  /// Creates a new instance of [XXH128].
+  ///
+  /// Paramters:
+  /// - [seed] is an optional 64-bit integer. Default: 0
+  /// - [secret] is an array of bytes. The length should be at least 136.
+  /// - If the [secret] is present, the [seed] is ignored.
   const XXH128({this.seed = 0, this.secret});
 
   @override

lib/src/xxh3.dart

@@ -30,6 +30,12 @@ class XXH3 extends BlockHashBase {
   final int seed;
   final List<int>? secret;
 
+  /// Creates a new instance of [XXH3].
+  ///
+  /// Paramters:
+  /// - [seed] is an optional 64-bit integer. Default: 0
+  /// - [secret] is an array of bytes. The length should be at least 136.
+  /// - If the [secret] is present, the [seed] is ignored.
   const XXH3({this.seed = 0, this.secret});
 
   @override

lib/src/xxh32.dart

@@ -23,6 +23,10 @@ const XXHash32 xxh32 = XXHash32(0);
 class XXHash32 extends BlockHashBase {
   final int seed;
 
+  /// Creates a new instance of [XXHash32].
+  ///
+  /// Paramters:
+  /// - [seed] is an optional 32-bit integer. Default: 0
   const XXHash32([this.seed = 0]);
 
   @override

lib/src/xxh64.dart

@@ -23,6 +23,10 @@ const XXHash64 xxh64 = XXHash64(0);
 class XXHash64 extends BlockHashBase {
   final int seed;
 
+  /// Creates a new instance of [XXHash64].
+  ///
+  /// Paramters:
+  /// - [seed] is an optional 64-bit integer. Default: 0
   const XXHash64([this.seed = 0]);
 
   @override

pubspec.yaml

@@ -1,7 +1,7 @@
 name: hashlib
 description: Secure hash functions, checksum generators, and key derivation algorithms optimized for Dart.
 homepage: https://github.com/dipu-bd/hashlib
-version: 1.11.1
+version: 1.11.2
 
 environment:
   sdk: ">=2.14.0 <4.0.0"

test/argon2_test.dart

@@ -2,7 +2,6 @@
 // All rights reserved. Check LICENSE file for details.
 
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 import 'package:test/test.dart';
 
 void main() {

test/base16_test.dart

@@ -2,7 +2,6 @@
 // All rights reserved. Check LICENSE file for details.
 
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 import 'package:test/test.dart';
 
 void main() {

test/base32_test.dart

@@ -1,7 +1,7 @@
 // Copyright (c) 2023, Sudipto Chandra
 // All rights reserved. Check LICENSE file for details.
 
-import 'package:hashlib/src/codecs_base.dart';
+import 'package:hashlib/hashlib.dart';
 import 'package:test/test.dart';
 
 void main() {

test/base64_test.dart

@@ -4,7 +4,6 @@
 import 'dart:convert';
 
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 import 'package:test/test.dart';
 
 void main() {

test/base64url_test.dart

@@ -4,7 +4,6 @@
 import 'dart:convert';
 
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 import 'package:test/test.dart';
 
 void main() {

test/compare_test.dart

@@ -6,7 +6,6 @@ import 'dart:typed_data';
 
 import 'package:crypto/crypto.dart' as crypto;
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 import 'package:pointycastle/digests/blake2b.dart' as pc_blake2b;
 import 'package:pointycastle/digests/keccak.dart' as pc_keccak;
 import 'package:pointycastle/digests/sha3.dart' as pc_sha3;

test/poly1305_test.dart

@@ -3,7 +3,6 @@
 
 import 'package:hashlib/hashlib.dart';
 import 'package:hashlib/src/algorithms/poly1305.dart';
-import 'package:hashlib/src/codecs_base.dart';
 import 'package:test/test.dart';
 
 const cases = [

test/sha3_test.dart

@@ -2,7 +2,6 @@
 // All rights reserved. Check LICENSE file for details.
 
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 import 'package:test/test.dart';
 
 void main() {

test/xxh128_test.dart

@@ -6,7 +6,6 @@
 })
 
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 import 'package:test/test.dart';
 
 const seed = 0x9e3779b185ebca8d;

test/xxh3_test.dart

@@ -6,7 +6,6 @@
 })
 
 import 'package:hashlib/hashlib.dart';
-import 'package:hashlib/src/codecs_base.dart';
 import 'package:test/test.dart';
 
 const seed = 0x9e3779b185ebca8d;