Merge branch '99-new-credential-types' into 'main'

Sync credentials: add user and password auth

See merge request objectbox/objectbox-dart!77

Author: greenrobot-team

objectbox/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## latest
 
+* Add `SyncCredentials.userAndPassword()`.
+* Change `SyncCredentials` from constructors to static methods. This should not require any changes
+  in your code.
+
 ## 2.5.0 (2024-02-14)
 
 * Support creating file-less in-memory databases, for example for caching or testing. To create one

objectbox/lib/internal.dart

@@ -8,4 +8,3 @@ export 'src/native/store.dart' show InternalStoreAccess;
 export 'src/relations/info.dart';
 export 'src/relations/to_many.dart'
     show InternalToManyAccess, InternalToManyTestAccess;
-export 'src/sync.dart' show InternalSyncTestAccess;

objectbox/lib/src/native/sync.dart

@@ -5,7 +5,6 @@ import 'dart:isolate';
 import 'dart:typed_data';
 
 import 'package:ffi/ffi.dart';
-import 'package:meta/meta.dart';
 
 import '../common.dart';
 import '../util.dart';
@@ -16,32 +15,61 @@ import 'store.dart';
 /// Credentials used to authenticate a sync client against a server.
 class SyncCredentials {
   final int _type;
-  final Uint8List _data;
 
-  SyncCredentials._(this._type, String data)
-      : _data = Uint8List.fromList(utf8.encode(data));
+  SyncCredentials._(this._type);
 
   /// No credentials - usually only for development purposes with a server
   /// configured to accept all connections without authentication.
-  SyncCredentials.none()
-      : _type = OBXSyncCredentialsType.NONE,
-        _data = Uint8List(0);
+  static SyncCredentials none() => _SyncCredentialsNone._();
 
   /// Shared secret authentication.
-  SyncCredentials.sharedSecretUint8List(this._data)
-      : _type = OBXSyncCredentialsType.SHARED_SECRET;
+  static SyncCredentials sharedSecretUint8List(Uint8List data) =>
+      SyncCredentialsSecret._(
+          OBXSyncCredentialsType.SHARED_SECRET_SIPPED, data);
 
   /// Shared secret authentication.
-  SyncCredentials.sharedSecretString(String data)
-      : this._(OBXSyncCredentialsType.SHARED_SECRET, data);
+  static SyncCredentials sharedSecretString(String data) =>
+      SyncCredentialsSecret._encode(
+          OBXSyncCredentialsType.SHARED_SECRET_SIPPED, data);
 
   /// Google authentication.
-  SyncCredentials.googleAuthUint8List(this._data)
-      : _type = OBXSyncCredentialsType.GOOGLE_AUTH;
+  static SyncCredentials googleAuthUint8List(Uint8List data) =>
+      SyncCredentialsSecret._(OBXSyncCredentialsType.GOOGLE_AUTH, data);
 
   /// Google authentication.
-  SyncCredentials.googleAuthString(String data)
-      : this._(OBXSyncCredentialsType.GOOGLE_AUTH, data);
+  static SyncCredentials googleAuthString(String data) =>
+      SyncCredentialsSecret._encode(OBXSyncCredentialsType.GOOGLE_AUTH, data);
+
+  /// Username and password authentication.
+  static SyncCredentials userAndPassword(String user, String password) =>
+      _SyncCredentialsUserPassword._(
+          OBXSyncCredentialsType.USER_PASSWORD, user, password);
+}
+
+class _SyncCredentialsNone extends SyncCredentials {
+  _SyncCredentialsNone._() : super._(OBXSyncCredentialsType.NONE);
+}
+
+/// Do not export, internal use only.
+///
+/// Sync credential that is a single secret string.
+class SyncCredentialsSecret extends SyncCredentials {
+  /// UTF-8 encoded string.
+  final Uint8List data;
+
+  SyncCredentialsSecret._(super.type, this.data) : super._();
+
+  SyncCredentialsSecret._encode(super.type, String data)
+      : data = Uint8List.fromList(utf8.encode(data)),
+        super._();
+}
+
+class _SyncCredentialsUserPassword extends SyncCredentials {
+  final String _user;
+  final String _password;
+
+  _SyncCredentialsUserPassword._(super._type, this._user, this._password)
+      : super._();
 }
 
 /// Current state of the [SyncClient].
@@ -205,11 +233,18 @@ class SyncClient {
 
   /// Configure authentication credentials, depending on your server config.
   void setCredentials(SyncCredentials creds) {
-    if (creds._type == OBXSyncCredentialsType.NONE) {
+    if (creds is _SyncCredentialsNone) {
       checkObx(C.sync_credentials(_ptr, creds._type, nullptr, 0));
-    } else {
+    } else if (creds is _SyncCredentialsUserPassword) {
+      withNativeString(
+          creds._user,
+          (userCStr) => withNativeString(
+              creds._password,
+              (passwordCStr) => C.sync_credentials_user_password(
+                  _ptr, creds._type, userCStr, passwordCStr)));
+    } else if (creds is SyncCredentialsSecret) {
       withNativeBytes(
-          creds._data,
+          creds.data,
           (Pointer<Uint8> credsPtr, int credsSize) => checkObx(
               C.sync_credentials(_ptr, creds._type, credsPtr, credsSize)));
     }
@@ -583,10 +618,3 @@ class Sync {
     return client;
   }
 }
-
-/// Tests only.
-@visibleForTesting
-class InternalSyncTestAccess {
-  /// Access credentials internal data representation.
-  static Uint8List credentialsData(SyncCredentials creds) => creds._data;
-}

objectbox_test/test/sync_test.dart

@@ -4,6 +4,7 @@ import 'dart:typed_data';
 
 import 'package:objectbox/internal.dart';
 import 'package:objectbox/src/native/store.dart';
+import 'package:objectbox/src/native/sync.dart';
 import 'package:test/test.dart';
 
 import 'entity.dart';
@@ -63,8 +64,7 @@ void main() {
     // an utf-8 encoded json file (i.e. the usual way).
     final str = 'uũú';
     expect(
-        InternalSyncTestAccess.credentialsData(
-            SyncCredentials.sharedSecretString(str)),
+        (SyncCredentials.sharedSecretString(str) as SyncCredentialsSecret).data,
         equals(Uint8List.fromList([117, 197, 169, 195, 186])));
   });
 
@@ -159,6 +159,7 @@ void main() {
           SyncCredentials.googleAuthUint8List(Uint8List.fromList([13, 0, 25])));
       c.setCredentials(SyncCredentials.sharedSecretUint8List(
           Uint8List.fromList([13, 0, 25])));
+      c.setCredentials(SyncCredentials.userAndPassword('obx', 'secret'));
       c.setCredentials(SyncCredentials.none());
       c.setRequestUpdatesMode(SyncRequestUpdatesMode.manual);
       c.start();