add dargon2_interface

Author: tmthecoder

dargon2_interface/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 1.0.1
+- Bump down Dart version to 2.14 so Flutter 2.5 can use
+
+## 1.0.0
+
+- Initial version.
+- Interface from dargon2_core to allow federated plugins (needed for web support)

dargon2_interface/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Tejas Mehta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dargon2_interface/README.md

@@ -0,0 +1,51 @@
+## dargon2_interface
+
+This library generally should not be used in most contexts
+
+This library only provides an interface to implement a dargon2-compatible argon2 hash binding.
+
+This library is used by `dargon2_core` and `dargon2_flutter_web` to maintain cross-platform hashing functionality.
+
+## Usage
+
+A simple usage example:
+
+```dart
+import 'package:dargon2_interface/dargon2_interface.dart';
+
+void main() {
+  // Create an instance of TestDArgon2
+  var dargon2 = TestDArgon2();
+}
+
+class TestDArgon2 extends DArgon2 {
+  @override
+  Future<DArgon2Result> hashPasswordBytes(List<int> password, {required Salt salt, int iterations = 32, int memory = 256, int parallelism = 2, int length = 32, Argon2Type type = Argon2Type.i, Argon2Version version = Argon2Version.V13}) {
+    // Create an implementation for hashing passwords with the given parameters
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<bool> verifyHashBytes(List<int> password, List<int> encodedHash, {Argon2Type type = Argon2Type.i}) {
+    // Create an implementation for verifying passwords with the given parameters
+    throw UnimplementedError();
+  }
+}
+```
+
+## Features and bugs
+
+Please file feature requests and bugs at the [issue tracker].
+
+[issue tracker]: https://github.com/tmthecoder/dargon2_interface/issues
+
+## Licensing
+
+- dargon2_core is Licensed under the [MIT License]
+- The C implementation of [Argon2] is licensed under a dual [Apache and CC0 License]
+
+[MIT License]: https://github.com/tmthecoder/dargon2_interface/blob/main/LICENSE
+
+[Argon2]: https://github.com/P-H-C/phc-winner-argon2
+
+[Apache and CC0 License]: https://github.com/P-H-C/phc-winner-argon2/blob/master/LICENSE

dargon2_interface/analysis_options.yaml

@@ -0,0 +1,30 @@
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
+
+include: package:lints/recommended.yaml
+
+# Uncomment the following section to specify additional rules.
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+# analyzer:
+#   exclude:
+#     - path/to/excluded/files/**
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options

dargon2_interface/dargon2_interface.iml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/build" />
+      <excludeFolder url="file://$MODULE_DIR$/.pub" />
+      <excludeFolder url="file://$MODULE_DIR$/.dart_tool" />
+    </content>
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" name="Dart SDK" level="project" />
+    <orderEntry type="library" name="Dart Packages" level="project" />
+  </component>
+</module>

dargon2_interface/example/dargon2_interface_example.dart

@@ -0,0 +1,20 @@
+import 'package:dargon2_interface/dargon2_interface.dart';
+
+void main() {
+  // Create an instance of TestDArgon2
+  var dargon2 = TestDArgon2();
+}
+
+class TestDArgon2 extends DArgon2 {
+  @override
+  Future<DArgon2Result> hashPasswordBytes(List<int> password, {required Salt salt, int iterations = 32, int memory = 256, int parallelism = 2, int length = 32, Argon2Type type = Argon2Type.i, Argon2Version version = Argon2Version.V13}) {
+    // Create an implementation for hashing passwords with the given parameters
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<bool> verifyHashBytes(List<int> password, List<int> encodedHash, {Argon2Type type = Argon2Type.i}) {
+    // Create an implementation for verifying passwords with the given parameters
+    throw UnimplementedError();
+  }
+}

dargon2_interface/lib/dargon2_interface.dart

@@ -0,0 +1,10 @@
+/// Support for doing something awesome.
+///
+/// More dartdocs go here.
+library dargon2_interface;
+
+export 'src/argon2.dart';
+export 'src/dargon2_error_codes.dart';
+export 'src/dargon2_exception.dart';
+export 'src/dargon2_result.dart';
+export 'src/salt.dart';

dargon2_interface/lib/src/argon2.dart

@@ -0,0 +1,103 @@
+// Copyright 2020 Tejas Mehta <[email protected]>
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+import 'dart:convert';
+import 'dargon2_result.dart';
+
+import 'salt.dart';
+
+/// The enum to determine the Argon2 Type used (Argon2i, Argon2d, Argon2id).
+enum Argon2Type {
+  /// Utilize Argon2d for hashing
+  d,
+
+  /// Utilize Argon2i for hashing
+  i,
+
+  /// Utilize Argon2id for hashing
+  id
+}
+
+/// The enum used to determine the Argon2 Version used (0x10 or 0x13).
+enum Argon2Version {
+  /// Utilize Argon2 V10 for hashing
+  V10,
+
+  /// Utilize Argon2 V13 for hashing
+  V13
+}
+
+/// A class that houses all of the methods to hash and verify a password using
+/// the [Argon2] password hashing algorithm.
+///
+/// [Argon2]: https://github.com/P-H-C/phc-winner-argon2
+///
+/// This should be used via the [argon2] field.
+abstract class DArgon2 {
+  /// The Future method to hash a [String] password with Argon2
+  ///
+  /// Needs a UTF-8 String [password] and a [salt] to be given with
+  /// an optional parameters to control the amount of [iterations], [memory],
+  /// [parallelism] used during the operation. Also optionally takes a [length]
+  /// parameter for the hash's return length, as well as a [type] and [version].
+  ///
+  /// Returns a [Future] containing a [DArgon2Result] with the hashed password,
+  /// encoded hash, and various conversion options for the hash and encoded bytes.
+  Future<DArgon2Result> hashPasswordString(String password,
+          {required Salt salt,
+          int iterations = 32,
+          int memory = 256,
+          int parallelism = 2,
+          int length = 32,
+          Argon2Type type = Argon2Type.i,
+          Argon2Version version = Argon2Version.V13}) =>
+      hashPasswordBytes(utf8.encode(password),
+          salt: salt,
+          iterations: iterations,
+          memory: memory,
+          parallelism: parallelism,
+          length: length,
+          type: type,
+          version: version);
+
+  /// The Future method to hash a List<int> password with Argon2
+  ///
+  /// Needs a [List] of type int [password] and a [salt] to be given with
+  /// an optional parameters to control the amount of [iterations], [memory],
+  /// [parallelism] used during the operation. Also optionally takes a [length]
+  /// parameter for the hash's return length, as well as a [type] and [version].
+  ///
+  /// Returns a [Future] containing a [DArgon2Result] with the hashed password,
+  /// encoded hash, and various conversion options for the hash and encoded bytes.
+  Future<DArgon2Result> hashPasswordBytes(List<int> password,
+      {required Salt salt,
+      int iterations = 32,
+      int memory = 256,
+      int parallelism = 2,
+      int length = 32,
+      Argon2Type type = Argon2Type.i,
+      Argon2Version version = Argon2Version.V13});
+
+  /// The Future method to handle verifying a String argon2 hash against a String password
+  ///
+  /// Needs a UTF-8 String [password], a UTF-8 String [encodedHash], as well as an
+  /// Argon2Type [type] used for the actual hash. This method gets the byte arrays of
+  /// both Strings and calls [verifyHashBytes] with that info.
+  ///
+  /// Returns a [Future] with the [bool] of whether the hashing was a match or not
+  Future<bool> verifyHashString(String password, String encodedHash,
+          {Argon2Type type = Argon2Type.i}) =>
+      verifyHashBytes(utf8.encode(password), utf8.encode(encodedHash),
+          type: type);
+
+  /// The Future method to handle verifying a List<int> argon2 hash against a List<int> password
+  ///
+  /// Needs a [List] of type int [password], a [List] of type int [encodedHash], as well as an
+  /// Argon2Type [type] used for the actual hash.
+  ///
+  /// Returns a [Future] with the [bool] of whether the hashing was a match or not
+  Future<bool> verifyHashBytes(List<int> password, List<int> encodedHash,
+      {Argon2Type type = Argon2Type.i});
+}

dargon2_interface/lib/src/dargon2_error_codes.dart

@@ -0,0 +1,120 @@
+// Copyright 2020 Tejas Mehta <[email protected]>
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+/// The enum with all of the Argon2 Error codes, seen directly from the C
+/// Reference Library of Argon2. The codes are sent into the Exception object as well
+/// as used to retrieve the error message from the C library.
+enum DArgon2ErrorCode {
+  /// No error
+  ARGON2_OK,
+
+  /// Outpointer null
+  ARGON2_OUTPUT_PTR_NULL,
+
+  /// Output pointer too short
+  ARGON2_OUTPUT_TOO_SHORT,
+
+  /// Output pointer too long
+  ARGON2_OUTPUT_TOO_LONG,
+
+  /// Password too short
+  ARGON2_PWD_TOO_SHORT,
+
+  /// Password too long
+  ARGON2_PWD_TOO_LONG,
+
+  /// Salt too short
+  ARGON2_SALT_TOO_SHORT,
+
+  /// Salt too long
+  ARGON2_SALT_TOO_LONG,
+
+  /// Associated Data too short
+  ARGON2_AD_TOO_SHORT,
+
+  /// Associated Data too long
+  ARGON2_AD_TOO_LONG,
+
+  /// Secret too short
+  ARGON2_SECRET_TOO_SHORT,
+
+  /// Secret too long
+  ARGON2_SECRET_TOO_LONG,
+
+  /// Time too short
+  ARGON2_TIME_TOO_SMALL,
+
+  /// Time too long
+  ARGON2_TIME_TOO_LARGE,
+
+  /// Memory too small
+  ARGON2_MEMORY_TOO_LITTLE,
+
+  /// Memory too large
+  ARGON2_MEMORY_TOO_MUCH,
+
+  /// Too few lanes
+  ARGON2_LANES_TOO_FEW,
+
+  /// Too many lanes
+  ARGON2_LANES_TOO_MANY,
+
+  /// Null password pointer with a given nonzero length
+  ARGON2_PWD_PTR_MISMATCH,
+
+  /// Null salt pointer with a given nonzero length
+  ARGON2_SALT_PTR_MISMATCH,
+
+  /// Null secret pointer with a given nonzero length
+  ARGON2_SECRET_PTR_MISMATCH,
+
+  /// Null associated data pointer with a given nonzero length
+  ARGON2_AD_PTR_MISMATCH,
+
+  /// Memory alloc error
+  ARGON2_MEMORY_ALLOCATION_ERROR,
+
+  /// Null free memory call back
+  ARGON2_FREE_MEMORY_CBK_NULL,
+
+  /// Null allocation callback
+  ARGON2_ALLOCATE_MEMORY_CBK_NULL,
+
+  /// Context is null
+  ARGON2_INCORRECT_PARAMETER,
+
+  /// No such type of Argon2
+  ARGON2_INCORRECT_TYPE,
+
+  /// Output pointer mismatch
+  ARGON2_OUT_PTR_MISMATCH,
+
+  /// Too few threads
+  ARGON2_THREADS_TOO_FEW,
+
+  /// Too many threads
+  ARGON2_THREADS_TOO_MANY,
+
+  /// Missing arguments
+  ARGON2_MISSING_ARGS,
+
+  /// Encoding failed
+  ARGON2_ENCODING_FAIL,
+
+  /// Decoding failed
+  ARGON2_DECODING_FAIL,
+
+  /// Threading failed
+  ARGON2_THREAD_FAIL,
+
+  /// Some parameters are too short/long
+  ARGON2_DECODING_LENGTH_FAIL,
+
+  /// Verification mismatch
+  ARGON2_VERIFY_MISMATCH,
+
+  /// Unknown error
+  ARGON2_UNKNOWN_ERROR
+}