From f8231a68857f9df4c6682c5db6614bf51c0fe3e2 Mon Sep 17 00:00:00 2001 From: TropicolX Date: Thu, 23 May 2024 18:19:19 +0100 Subject: [PATCH 1/2] Changed all "Remark" notes to use the [!NOTE] format. --- example/pubspec.lock | 32 ++++++++++++------------- lib/src/webcrypto/webcrypto.aesctr.dart | 10 ++++---- lib/src/webcrypto/webcrypto.aesgcm.dart | 5 ++-- lib/src/webcrypto/webcrypto.dart | 3 ++- 4 files changed, 26 insertions(+), 24 deletions(-) diff --git a/example/pubspec.lock b/example/pubspec.lock index 49bfe141..8cdff661 100644 --- a/example/pubspec.lock +++ b/example/pubspec.lock @@ -203,26 +203,26 @@ packages: dependency: transitive description: name: leak_tracker - sha256: "78eb209deea09858f5269f5a5b02be4049535f568c07b275096836f01ea323fa" + sha256: "7f0df31977cb2c0b88585095d168e689669a2cc9b97c309665e3386f3e9d341a" url: "https://pub.dev" source: hosted - version: "10.0.0" + version: "10.0.4" leak_tracker_flutter_testing: dependency: transitive description: name: leak_tracker_flutter_testing - sha256: b46c5e37c19120a8a01918cfaf293547f47269f7cb4b0058f21531c2465d6ef0 + sha256: "06e98f569d004c1315b991ded39924b21af84cf14cc94791b8aea337d25b57f8" url: "https://pub.dev" source: hosted - version: "2.0.1" + version: "3.0.3" leak_tracker_testing: dependency: transitive description: name: leak_tracker_testing - sha256: a597f72a664dbd293f3bfc51f9ba69816f84dcd403cdac7066cb3f6003f3ab47 + sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3" url: "https://pub.dev" source: hosted - version: "2.0.1" + version: "3.0.1" logging: dependency: transitive description: @@ -251,10 +251,10 @@ packages: dependency: transitive description: name: meta - sha256: d584fa6707a52763a52446f02cc621b077888fb63b93bbcb1143a7be5a0c0c04 + sha256: "7687075e408b093f36e6bbf6c91878cc0d4cd10f409506f7bc996f68220b9136" url: "https://pub.dev" source: hosted - version: "1.11.0" + version: "1.12.0" mime: dependency: transitive description: @@ -424,26 +424,26 @@ packages: dependency: "direct dev" description: name: test - sha256: a1f7595805820fcc05e5c52e3a231aedd0b72972cb333e8c738a8b1239448b6f + sha256: "7ee446762c2c50b3bd4ea96fe13ffac69919352bd3b4b17bac3f3465edc58073" url: "https://pub.dev" source: hosted - version: "1.24.9" + version: "1.25.2" test_api: dependency: transitive description: name: test_api - sha256: "5c2f730018264d276c20e4f1503fd1308dfbbae39ec8ee63c5236311ac06954b" + sha256: "9955ae474176f7ac8ee4e989dadfb411a58c30415bcfb648fa04b2b8a03afa7f" url: "https://pub.dev" source: hosted - version: "0.6.1" + version: "0.7.0" test_core: dependency: transitive description: name: test_core - sha256: a757b14fc47507060a162cc2530d9a4a2f92f5100a952c7443b5cad5ef5b106a + sha256: "2bc4b4ecddd75309300d8096f781c0e3280ca1ef85beda558d33fcbedc2eead4" url: "https://pub.dev" source: hosted - version: "0.5.9" + version: "0.6.0" typed_data: dependency: transitive description: @@ -464,10 +464,10 @@ packages: dependency: transitive description: name: vm_service - sha256: b3d56ff4341b8f182b96aceb2fa20e3dcb336b9f867bc0eafc0de10f1048e957 + sha256: "3923c89304b715fb1eb6423f017651664a03bf5f4b29983627c4da791f74a4ec" url: "https://pub.dev" source: hosted - version: "13.0.0" + version: "14.2.1" watcher: dependency: transitive description: diff --git a/lib/src/webcrypto/webcrypto.aesctr.dart b/lib/src/webcrypto/webcrypto.aesctr.dart index 6cfc936b..8527de24 100644 --- a/lib/src/webcrypto/webcrypto.aesctr.dart +++ b/lib/src/webcrypto/webcrypto.aesctr.dart @@ -168,11 +168,11 @@ abstract class AesCtrSecretKey { /// {@endtemplate} /// /// {@template AesCtrSecretKey-compatibility-notes} - /// **Remark** Firefox does not implement counter rollover for AES-CTR - /// correctly. Picking a sufficiently large [length] and using a [counter] - /// that isn't filled with `0xff` will likely avoid counter rollovers. - /// See [bug 1803105](https://bugzilla.mozilla.org/show_bug.cgi?id=1803105) - /// for details. + /// > [!NOTE] + /// > Firefox does not implement counter rollover for AES-CTR correctly. + /// Picking a sufficiently large `length` and using a `counter` that isn't + /// filled with 0xff will likely avoid counter rollovers. + /// See [bug 1803105](https://bugzilla.mozilla.org/show_bug.cgi?id=1803105) for details. /// {@endtemplate} /// /// [1]: https://csrc.nist.gov/publications/detail/sp/800-38a/final diff --git a/lib/src/webcrypto/webcrypto.aesgcm.dart b/lib/src/webcrypto/webcrypto.aesgcm.dart index 86429377..c27f09b1 100644 --- a/lib/src/webcrypto/webcrypto.aesgcm.dart +++ b/lib/src/webcrypto/webcrypto.aesgcm.dart @@ -202,7 +202,8 @@ abstract class AesGcmSecretKey { /// {@endtemplate} /// /// {@template AesGcmSecretKey-remark:no-stream-api} - /// **Remark** this package does not offer a streaming API for + /// > [!NOTE] + /// > This package does not offer a streaming API for /// encryption / decryption using AES-GCM, because reading deciphered /// plaintext prior to complete verification of the tag breaks the /// authenticity assurances. Specifically, until the entire message is @@ -221,7 +222,7 @@ abstract class AesGcmSecretKey { // TODO: Document this method, notice that [data] must be concatenation of // ciphertext and authentication tag. - // TODO: Document what happens if the authenticity validation fails? Some Exception? + // TODO: Document what happens if the authenticity validation fails? Some Exception? Future decryptBytes( List data, List iv, { diff --git a/lib/src/webcrypto/webcrypto.dart b/lib/src/webcrypto/webcrypto.dart index fbda8881..4d0ecbc3 100644 --- a/lib/src/webcrypto/webcrypto.dart +++ b/lib/src/webcrypto/webcrypto.dart @@ -62,7 +62,8 @@ abstract class KeyPair { /// Elliptic curves supported by ECDSA and ECDH. /// -/// **Remark**, additional values may be added to this enum in the future. +/// > [!NOTE] +/// > Additional values may be added to this enum in the future. enum EllipticCurve { p256, p384, From 3af4a5e34b31c58930d03bd30be3c7dc32bd21b9 Mon Sep 17 00:00:00 2001 From: Oluwabusayo Jacobs <68024640+TropicolX@users.noreply.github.com> Date: Mon, 27 May 2024 10:45:28 +0100 Subject: [PATCH 2/2] Undo update to pubspec.lock --- example/pubspec.lock | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/example/pubspec.lock b/example/pubspec.lock index 8cdff661..49bfe141 100644 --- a/example/pubspec.lock +++ b/example/pubspec.lock @@ -203,26 +203,26 @@ packages: dependency: transitive description: name: leak_tracker - sha256: "7f0df31977cb2c0b88585095d168e689669a2cc9b97c309665e3386f3e9d341a" + sha256: "78eb209deea09858f5269f5a5b02be4049535f568c07b275096836f01ea323fa" url: "https://pub.dev" source: hosted - version: "10.0.4" + version: "10.0.0" leak_tracker_flutter_testing: dependency: transitive description: name: leak_tracker_flutter_testing - sha256: "06e98f569d004c1315b991ded39924b21af84cf14cc94791b8aea337d25b57f8" + sha256: b46c5e37c19120a8a01918cfaf293547f47269f7cb4b0058f21531c2465d6ef0 url: "https://pub.dev" source: hosted - version: "3.0.3" + version: "2.0.1" leak_tracker_testing: dependency: transitive description: name: leak_tracker_testing - sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3" + sha256: a597f72a664dbd293f3bfc51f9ba69816f84dcd403cdac7066cb3f6003f3ab47 url: "https://pub.dev" source: hosted - version: "3.0.1" + version: "2.0.1" logging: dependency: transitive description: @@ -251,10 +251,10 @@ packages: dependency: transitive description: name: meta - sha256: "7687075e408b093f36e6bbf6c91878cc0d4cd10f409506f7bc996f68220b9136" + sha256: d584fa6707a52763a52446f02cc621b077888fb63b93bbcb1143a7be5a0c0c04 url: "https://pub.dev" source: hosted - version: "1.12.0" + version: "1.11.0" mime: dependency: transitive description: @@ -424,26 +424,26 @@ packages: dependency: "direct dev" description: name: test - sha256: "7ee446762c2c50b3bd4ea96fe13ffac69919352bd3b4b17bac3f3465edc58073" + sha256: a1f7595805820fcc05e5c52e3a231aedd0b72972cb333e8c738a8b1239448b6f url: "https://pub.dev" source: hosted - version: "1.25.2" + version: "1.24.9" test_api: dependency: transitive description: name: test_api - sha256: "9955ae474176f7ac8ee4e989dadfb411a58c30415bcfb648fa04b2b8a03afa7f" + sha256: "5c2f730018264d276c20e4f1503fd1308dfbbae39ec8ee63c5236311ac06954b" url: "https://pub.dev" source: hosted - version: "0.7.0" + version: "0.6.1" test_core: dependency: transitive description: name: test_core - sha256: "2bc4b4ecddd75309300d8096f781c0e3280ca1ef85beda558d33fcbedc2eead4" + sha256: a757b14fc47507060a162cc2530d9a4a2f92f5100a952c7443b5cad5ef5b106a url: "https://pub.dev" source: hosted - version: "0.6.0" + version: "0.5.9" typed_data: dependency: transitive description: @@ -464,10 +464,10 @@ packages: dependency: transitive description: name: vm_service - sha256: "3923c89304b715fb1eb6423f017651664a03bf5f4b29983627c4da791f74a4ec" + sha256: b3d56ff4341b8f182b96aceb2fa20e3dcb336b9f867bc0eafc0de10f1048e957 url: "https://pub.dev" source: hosted - version: "14.2.1" + version: "13.0.0" watcher: dependency: transitive description: