Migrate lib/src/crypto_subtle.dart to use dart:js_interop (#86)

koji-1009 · web-flow · commit 91e80d93cb81 · 2024-02-29T16:51:57.000+01:00
* feat: dart:js_interop

* chore: const

* fix: typo

* refactor: Add empty line

* refactor: getRandomValues method to simplify code

* feat: Add browser_test.dart

* refactor: Create test files for each test environment

* refactor: Fix test case

* feat: Add TypeError case to _translateDomException

* feat: Add crypto.getRandomValues test case

* refactor: Fix firefox test case
diff --git a/lib/src/crypto_subtle.dart b/lib/src/crypto_subtle.dart
diff --git a/lib/src/impl_js/impl_js.aescbc.dart b/lib/src/impl_js/impl_js.aescbc.dart
@@ -16,7 +16,7 @@
 
 part of impl_js;
 
-final _aesCbcAlgorithm = subtle.Algorithm(name: 'AES-CBC');
+const _aesCbcAlgorithm = subtle.Algorithm(name: 'AES-CBC');
 
 Future<AesCbcSecretKey> aesCbc_importRawKey(List<int> keyData) async {
   return _AesCbcSecretKey(await _importKey(
@@ -48,7 +48,7 @@ Future<AesCbcSecretKey> aesCbc_generateKey(int length) async {
 }
 
 class _AesCbcSecretKey implements AesCbcSecretKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _AesCbcSecretKey(this._key);
 
   @override
diff --git a/lib/src/impl_js/impl_js.aesctr.dart b/lib/src/impl_js/impl_js.aesctr.dart
@@ -16,7 +16,7 @@
 
 part of impl_js;
 
-final _aesCtrAlgorithm = subtle.Algorithm(name: 'AES-CTR');
+const _aesCtrAlgorithm = subtle.Algorithm(name: 'AES-CTR');
 
 Future<AesCtrSecretKey> aesCtr_importRawKey(List<int> keyData) async {
   return _AesCtrSecretKey(await _importKey(
@@ -48,7 +48,7 @@ Future<AesCtrSecretKey> aesCtr_generateKey(int length) async {
 }
 
 class _AesCtrSecretKey implements AesCtrSecretKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _AesCtrSecretKey(this._key);
 
   @override
diff --git a/lib/src/impl_js/impl_js.aesgcm.dart b/lib/src/impl_js/impl_js.aesgcm.dart
@@ -16,7 +16,7 @@
 
 part of impl_js;
 
-final _aesGcmAlgorithm = subtle.Algorithm(name: 'AES-GCM');
+const _aesGcmAlgorithm = subtle.Algorithm(name: 'AES-GCM');
 
 Future<AesGcmSecretKey> aesGcm_importRawKey(List<int> keyData) async {
   return _AesGcmSecretKey(await _importKey(
@@ -48,7 +48,7 @@ Future<AesGcmSecretKey> aesGcm_generateKey(int length) async {
 }
 
 class _AesGcmSecretKey implements AesGcmSecretKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _AesGcmSecretKey(this._key);
 
   @override
diff --git a/lib/src/impl_js/impl_js.ecdh.dart b/lib/src/impl_js/impl_js.ecdh.dart
@@ -125,7 +125,7 @@ Future<EcdhPublicKey> ecdhPublicKey_importJsonWebKey(
 }
 
 class _EcdhPrivateKey implements EcdhPrivateKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _EcdhPrivateKey(this._key);
 
   @override
@@ -172,7 +172,7 @@ class _EcdhPrivateKey implements EcdhPrivateKey {
 }
 
 class _EcdhPublicKey implements EcdhPublicKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _EcdhPublicKey(this._key);
 
   @override
diff --git a/lib/src/impl_js/impl_js.ecdsa.dart b/lib/src/impl_js/impl_js.ecdsa.dart
@@ -113,7 +113,7 @@ Future<EcdsaPublicKey> ecdsaPublicKey_importJsonWebKey(
 }
 
 class _EcdsaPrivateKey implements EcdsaPrivateKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _EcdsaPrivateKey(this._key);
 
   @override
@@ -145,7 +145,7 @@ class _EcdsaPrivateKey implements EcdsaPrivateKey {
 }
 
 class _EcdsaPublicKey implements EcdsaPublicKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _EcdsaPublicKey(this._key);
 
   @override
diff --git a/lib/src/impl_js/impl_js.hkdf.dart b/lib/src/impl_js/impl_js.hkdf.dart
@@ -22,7 +22,7 @@ Future<HkdfSecretKey> hkdfSecretKey_importRawKey(List<int> keyData) async {
   return _HkdfSecretKey(await _importKey(
     'raw',
     keyData,
-    subtle.Algorithm(name: _hkdfAlgorithmName),
+    const subtle.Algorithm(name: _hkdfAlgorithmName),
     _usagesDeriveBits,
     'secret',
     // Unlike all other key types it makes no sense to HkdfSecretKey to be
@@ -32,7 +32,7 @@ Future<HkdfSecretKey> hkdfSecretKey_importRawKey(List<int> keyData) async {
 }
 
 class _HkdfSecretKey implements HkdfSecretKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _HkdfSecretKey(this._key);
 
   @override
diff --git a/lib/src/impl_js/impl_js.hmac.dart b/lib/src/impl_js/impl_js.hmac.dart
@@ -16,7 +16,7 @@
 
 part of impl_js;
 
-final _hmacAlgorithm = subtle.Algorithm(name: 'HMAC');
+const _hmacAlgorithm = subtle.Algorithm(name: 'HMAC');
 
 Future<HmacSecretKey> hmacSecretKey_importRawKey(
   List<int> keyData,
@@ -82,7 +82,7 @@ Future<HmacSecretKey> hmacSecretKey_generateKey(Hash hash,
 }
 
 class _HmacSecretKey implements HmacSecretKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _HmacSecretKey(this._key);
 
   @override
diff --git a/lib/src/impl_js/impl_js.pbkdf2.dart b/lib/src/impl_js/impl_js.pbkdf2.dart
@@ -22,7 +22,7 @@ Future<Pbkdf2SecretKey> pbkdf2SecretKey_importRawKey(List<int> keyData) async {
   return _Pbkdf2SecretKey(await _importKey(
     'raw',
     keyData,
-    subtle.Algorithm(name: _pbkdf2AlgorithmName),
+    const subtle.Algorithm(name: _pbkdf2AlgorithmName),
     _usagesDeriveBits,
     'secret',
     // Unlike all other key types it makes no sense to HkdfSecretKey to be
@@ -32,7 +32,7 @@ Future<Pbkdf2SecretKey> pbkdf2SecretKey_importRawKey(List<int> keyData) async {
 }
 
 class _Pbkdf2SecretKey implements Pbkdf2SecretKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _Pbkdf2SecretKey(this._key);
 
   @override
diff --git a/lib/src/impl_js/impl_js.random.dart b/lib/src/impl_js/impl_js.random.dart
@@ -17,7 +17,7 @@ part of impl_js;
 void fillRandomBytes(TypedData destination) {
   try {
     subtle.getRandomValues(destination);
-  } on subtle.DomException catch (e) {
+  } on subtle.JSDomException catch (e) {
     throw _translateDomException(e);
   }
 }
diff --git a/lib/src/impl_js/impl_js.rsaoaep.dart b/lib/src/impl_js/impl_js.rsaoaep.dart
@@ -102,14 +102,14 @@ Future<RsaOaepPublicKey> rsaOaepPublicKey_importJsonWebKey(
 }
 
 class _RsaOaepPrivateKey implements RsaOaepPrivateKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _RsaOaepPrivateKey(this._key);
 
   @override
   Future<Uint8List> decryptBytes(List<int> data, {List<int>? label}) async {
     return _decrypt(
       label == null
-          ? subtle.Algorithm(name: _rsaOaepAlgorithmName)
+          ? const subtle.Algorithm(name: _rsaOaepAlgorithmName)
           : subtle.Algorithm(
               name: _rsaOaepAlgorithmName,
               label: Uint8List.fromList(label),
@@ -131,14 +131,14 @@ class _RsaOaepPrivateKey implements RsaOaepPrivateKey {
 }
 
 class _RsaOaepPublicKey implements RsaOaepPublicKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _RsaOaepPublicKey(this._key);
 
   @override
   Future<Uint8List> encryptBytes(List<int> data, {List<int>? label}) async {
     return _encrypt(
       label == null
-          ? subtle.Algorithm(name: _rsaOaepAlgorithmName)
+          ? const subtle.Algorithm(name: _rsaOaepAlgorithmName)
           : subtle.Algorithm(
               name: _rsaOaepAlgorithmName,
               label: Uint8List.fromList(label),
diff --git a/lib/src/impl_js/impl_js.rsapss.dart b/lib/src/impl_js/impl_js.rsapss.dart
@@ -89,7 +89,7 @@ Future<RsaPssPublicKey> rsaPssPublicKey_importJsonWebKey(
 }
 
 class _RsaPssPrivateKey implements RsaPssPrivateKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _RsaPssPrivateKey(this._key);
 
   @override
@@ -126,7 +126,7 @@ class _RsaPssPrivateKey implements RsaPssPrivateKey {
 }
 
 class _RsaPssPublicKey implements RsaPssPublicKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _RsaPssPublicKey(this._key);
 
   @override
diff --git a/lib/src/impl_js/impl_js.rsassapkcs1v15.dart b/lib/src/impl_js/impl_js.rsassapkcs1v15.dart
@@ -16,7 +16,7 @@
 
 part of impl_js;
 
-final _rsassaPkcs1V15Algorithm = subtle.Algorithm(name: 'RSASSA-PKCS1-v1_5');
+const _rsassaPkcs1V15Algorithm = subtle.Algorithm(name: 'RSASSA-PKCS1-v1_5');
 
 Future<RsassaPkcs1V15PrivateKey> rsassaPkcs1V15PrivateKey_importPkcs8Key(
   List<int> keyData,
@@ -89,7 +89,7 @@ Future<RsassaPkcs1V15PublicKey> rsassaPkcs1V15PublicKey_importJsonWebKey(
 }
 
 class _RsassaPkcs1V15PrivateKey implements RsassaPkcs1V15PrivateKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _RsassaPkcs1V15PrivateKey(this._key);
 
   @override
@@ -114,7 +114,7 @@ class _RsassaPkcs1V15PrivateKey implements RsassaPkcs1V15PrivateKey {
 }
 
 class _RsassaPkcs1V15PublicKey implements RsassaPkcs1V15PublicKey {
-  final subtle.CryptoKey _key;
+  final subtle.JSCryptoKey _key;
   _RsassaPkcs1V15PublicKey(this._key);
 
   @override
diff --git a/lib/src/impl_js/impl_js.utils.dart b/lib/src/impl_js/impl_js.utils.dart
@@ -50,7 +50,7 @@ String _curveToName(EllipticCurve curve) {
 }
 
 Object _translateDomException(
-  subtle.DomException e, {
+  subtle.JSDomException e, {
   bool invalidAccessErrorIsArgumentError = false,
 }) {
   var message = e.message;
@@ -60,6 +60,8 @@ Object _translateDomException(
   switch (e.name) {
     case 'SyntaxError':
       return ArgumentError(message);
+    case 'TypeError':
+      return ArgumentError(message);
     case 'QuotaExceededError':
       return ArgumentError(message);
     case 'NotSupportedError':
@@ -97,7 +99,7 @@ Object _translateDomException(
       '"${e.name}", message: $message');
 }
 
-/// Handle instances of [subtle.DomException] specified in the
+/// Handle instances of [subtle.JSDomException] specified in the
 /// [Web Cryptograpy specification][1].
 ///
 /// [1]: https://www.w3.org/TR/WebCryptoAPI/#SubtleCrypto-Exceptions
@@ -107,7 +109,7 @@ Future<T> _handleDomException<T>(
 }) async {
   try {
     return await fn();
-  } on subtle.DomException catch (e) {
+  } on subtle.JSDomException catch (e) {
     throw _translateDomException(
       e,
       invalidAccessErrorIsArgumentError: invalidAccessErrorIsArgumentError,
@@ -124,7 +126,7 @@ final _usagesEncrypt = ['encrypt'];
 final _usagesDeriveBits = ['deriveBits'];
 
 /// Adapt `crypto.subtle.importKey` to Dart types for JWK.
-Future<subtle.CryptoKey> _importJsonWebKey(
+Future<subtle.JSCryptoKey> _importJsonWebKey(
   Map<String, dynamic> jwk,
   subtle.Algorithm algorithm,
   List<String> usages,
@@ -154,7 +156,7 @@ Future<subtle.CryptoKey> _importJsonWebKey(
 }
 
 /// Adapt `crypto.subtle.importKey` to Dart types.
-Future<subtle.CryptoKey> _importKey(
+Future<subtle.JSCryptoKey> _importKey(
   String format,
   List<int> keyData,
   subtle.Algorithm algorithm,
@@ -181,7 +183,7 @@ Future<subtle.CryptoKey> _importKey(
 /// Adapt `crypto.subtle.sign` to Dart types.
 Future<Uint8List> _sign(
   subtle.Algorithm algorithm,
-  subtle.CryptoKey key,
+  subtle.JSCryptoKey key,
   List<int> data,
 ) {
   return _handleDomException(() async {
@@ -197,7 +199,7 @@ Future<Uint8List> _sign(
 /// Adapt `crypto.subtle.verify` to Dart types.
 Future<bool> _verify(
   subtle.Algorithm algorithm,
-  subtle.CryptoKey key,
+  subtle.JSCryptoKey key,
   List<int> signature,
   List<int> data,
 ) {
@@ -214,7 +216,7 @@ Future<bool> _verify(
 /// Adapt `crypto.subtle.encrypt` to Dart types.
 Future<Uint8List> _encrypt(
   subtle.Algorithm algorithm,
-  subtle.CryptoKey key,
+  subtle.JSCryptoKey key,
   List<int> data,
 ) {
   return _handleDomException(() async {
@@ -230,7 +232,7 @@ Future<Uint8List> _encrypt(
 /// Adapt `crypto.subtle.decrypt` to Dart types.
 Future<Uint8List> _decrypt(
   subtle.Algorithm algorithm,
-  subtle.CryptoKey key,
+  subtle.JSCryptoKey key,
   List<int> data,
 ) {
   return _handleDomException(() async {
@@ -246,7 +248,7 @@ Future<Uint8List> _decrypt(
 /// Adapt `crypto.subtle.deriveBits` to Dart types.
 Future<Uint8List> _deriveBits(
   subtle.Algorithm algorithm,
-  subtle.CryptoKey key,
+  subtle.JSCryptoKey key,
   int length, {
   bool invalidAccessErrorIsArgumentError = false,
 }) {
@@ -263,7 +265,7 @@ Future<Uint8List> _deriveBits(
 /// Adapt `crypto.subtle.export` to Dart types.
 Future<Uint8List> _exportKey(
   String format,
-  subtle.CryptoKey key,
+  subtle.JSCryptoKey key,
 ) {
   return _handleDomException(() async {
     final result = await subtle.exportKey(format, key);
@@ -273,7 +275,7 @@ Future<Uint8List> _exportKey(
 
 /// Adapt `crypto.subtle.export` to Dart types.
 Future<Map<String, Object>> _exportJsonWebKey(
-  subtle.CryptoKey key,
+  subtle.JSCryptoKey key,
   // TODO: Add expected 'use' the way we have it in the FFI implementation
 ) {
   return _handleDomException(() async {
@@ -291,7 +293,7 @@ Future<Map<String, Object>> _exportJsonWebKey(
 }
 
 /// Adapt `crypto.subtle.generateKey` to Dart types.
-Future<subtle.CryptoKey> _generateKey(
+Future<subtle.JSCryptoKey> _generateKey(
   subtle.Algorithm algorithm,
   List<String> usages,
   String expectedType,
@@ -308,7 +310,7 @@ Future<subtle.CryptoKey> _generateKey(
 }
 
 /// Adapt `crypto.subtle.generateKey` to Dart types.
-Future<subtle.CryptoKeyPair> _generateKeyPair(
+Future<subtle.JSCryptoKeyPair> _generateKeyPair(
   subtle.Algorithm algorithm,
   List<String> usages,
 ) {
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -23,7 +23,6 @@ environment:
 
 dependencies:
   ffi: ^2.0.0
-  js: ^0.6.3
   meta: ^1.3.0
   # Needed for `lib/src/flutter/webcrypto_plugin.dart` which allows boiler-plate
   # in `flutter.plugin.platforms.web` added below.
diff --git a/test/browser_chrome_test.dart b/test/browser_chrome_test.dart
diff --git a/test/browser_firefox_test.dart b/test/browser_firefox_test.dart

Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ Future<EcdhPublicKey> ecdhPublicKey_importJsonWebKey(`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`class _EcdhPrivateKey implements EcdhPrivateKey {`
`128`		`- final subtle.CryptoKey _key;`
	`128`	`+ final subtle.JSCryptoKey _key;`
`129`	`129`	`_EcdhPrivateKey(this._key);`
`130`	`130`
`131`	`131`	`@override`
`@@ -172,7 +172,7 @@ class _EcdhPrivateKey implements EcdhPrivateKey {`
`172`	`172`	`}`
`173`	`173`
`174`	`174`	`class _EcdhPublicKey implements EcdhPublicKey {`
`175`		`- final subtle.CryptoKey _key;`
	`175`	`+ final subtle.JSCryptoKey _key;`
`176`	`176`	`_EcdhPublicKey(this._key);`
`177`	`177`
`178`	`178`	`@override`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ Future<EcdsaPublicKey> ecdsaPublicKey_importJsonWebKey(`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`class _EcdsaPrivateKey implements EcdsaPrivateKey {`
`116`		`- final subtle.CryptoKey _key;`
	`116`	`+ final subtle.JSCryptoKey _key;`
`117`	`117`	`_EcdsaPrivateKey(this._key);`
`118`	`118`
`119`	`119`	`@override`
`@@ -145,7 +145,7 @@ class _EcdsaPrivateKey implements EcdsaPrivateKey {`
`145`	`145`	`}`
`146`	`146`
`147`	`147`	`class _EcdsaPublicKey implements EcdsaPublicKey {`
`148`		`- final subtle.CryptoKey _key;`
	`148`	`+ final subtle.JSCryptoKey _key;`
`149`	`149`	`_EcdsaPublicKey(this._key);`
`150`	`150`
`151`	`151`	`@override`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ part of impl_js;`
`17`	`17`	`void fillRandomBytes(TypedData destination) {`
`18`	`18`	`try {`
`19`	`19`	`subtle.getRandomValues(destination);`
`20`		`- } on subtle.DomException catch (e) {`
	`20`	`+ } on subtle.JSDomException catch (e) {`
`21`	`21`	`throw _translateDomException(e);`
`22`	`22`	`}`
`23`	`23`	`}`