code cleanup

pubnub · Oct 2, 2023 · ca15732 · ca15732
1 parent 9de18f1
commit ca15732
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 14 deletions.
diff --git a/pubnub/lib/src/crypto/aesCbcCryptor.dart b/pubnub/lib/src/crypto/aesCbcCryptor.dart
@@ -4,6 +4,9 @@ import 'dart:typed_data' show Uint8List;
 
 import 'package:pubnub/core.dart';
 
+/// AesCbcCryptor is new and enhanced cryptor to encrypt/decrypt
+/// PubNub messages.
+/// It's always preferred to use this cryptor instead old cryptor.
 class AesCbcCryptor implements ICryptor {
   CipherKey cipherKey;
 

diff --git a/pubnub/lib/src/crypto/crypto.dart b/pubnub/lib/src/crypto/crypto.dart
@@ -4,6 +4,8 @@ import 'package:pubnub/src/crypto/legacyCryptor.dart';
 import 'cryptoConfiguration.dart';
 import 'cryptorHeader.dart';
 
+/// CryptoModule is responsible for encryption and decryption
+/// of PubNub messages.
 class CryptoModule implements ICryptoModule {
   final ICryptor defaultCryptor;
   List<ICryptor>? cryptors;

diff --git a/pubnub/lib/src/crypto/cryptorHeader.dart b/pubnub/lib/src/crypto/cryptorHeader.dart
@@ -2,6 +2,7 @@ import 'dart:convert' show utf8;
 
 import 'package:pubnub/core.dart';
 
+/// @nodoc
 class CryptorHeader {
   static const SENTINEL = 'PNED';
   static const LEGACY_IDENTIFIER = '';
@@ -49,6 +50,7 @@ class CryptorHeader {
   }
 }
 
+/// @nodoc
 class CryptorHeaderV1 {
   static const VERSION = 1;
   final String _identifier;

diff --git a/pubnub/lib/src/crypto/legacyCryptor.dart b/pubnub/lib/src/crypto/legacyCryptor.dart
@@ -9,6 +9,8 @@ import 'cryptoConfiguration.dart';
 import 'encryption_mode.dart';
 import 'crypto.dart';
 
+/// Legacy cryptor exists so that SDK will be able to decrypt old contents
+/// Which encrypted in past
 class LegacyCryptor implements ICryptor {
   final CryptoConfiguration cryptoConfiguration;
   final CipherKey cipherKey;
@@ -44,7 +46,7 @@ class LegacyCryptor implements ICryptor {
   }
 }
 
-/// Default cryptography module used in PubNub SDK.
+/// Legacy CryptoModule module used in PubNub SDK when CipherKey is not provided.
 class LegacyCryptoModule implements ICryptoModule {
   final CryptoConfiguration defaultConfiguration;
 
@@ -155,18 +157,16 @@ class LegacyCryptoModule implements ICryptoModule {
 
   @override
   List<int> decrypt(List<int> input) {
-    // TODO: implement decrypt
-    throw UnimplementedError();
+    // Note: Unreachable code. Till the time legacy encryption supported.
+    return List.empty();
   }
 
   @override
   List<int> encrypt(List<int> input) {
-    // TODO: implement encrypt
-    throw UnimplementedError();
+    // Note: Unreachable code. Till the time legacy encryption supported.
+    return List.empty();
   }
 
   @override
-  void register(Core core) {
-    // TODO: implement register
-  }
+  void register(Core core) {}
 }
diff --git a/pubnub/test/unit/dx/file_test.dart b/pubnub/test/unit/dx/file_test.dart
@@ -1,5 +1,4 @@
 import 'dart:convert';
-import 'package:pubnub/crypto.dart';
 import 'package:test/test.dart';
 
 import 'package:pubnub/pubnub.dart';
@@ -10,16 +9,12 @@ part 'fixtures/files.dart';
 void main() {
   late PubNub pubnub;
   var keyset =
-      Keyset(subscribeKey: 'test', publishKey: 'test', uuid: UUID('test'));
+      Keyset(subscribeKey: 'test', publishKey: 'test', userId: UserId('test'));
   group('DX [file]', () {
     setUp(() {
       pubnub = PubNub(
         defaultKeyset: keyset,
         networking: FakeNetworkingModule(),
-        // crypto: CryptoModule.legacyCryptoModule(CipherKey.fromUtf8('secret')),
-        // CryptoModule(
-        //   defaultConfiguration:
-        //       CryptoConfiguration(useRandomInitializationVector: false),)
       );
     });