Merge branch '202-new-credential-types' into 'dev'

[Sync] Support new credential types

See merge request objectbox/objectbox-java!133

Author: greenrobot-team

objectbox-java/src/main/java/io/objectbox/sync/Sync.java

@@ -37,6 +37,9 @@ public static SyncBuilder client(BoxStore boxStore, String url, SyncCredentials
      * Start building a sync server. Requires the BoxStore the server should use,
      * the URL and port the server should bind to and authenticator credentials to authenticate clients.
      * Additional authenticator credentials can be supplied using the builder.
+     * <p>
+     * For the embedded server, currently only {@link SyncCredentials#sharedSecret} and {@link SyncCredentials#none}
+     * are supported.
      */
     public static SyncServerBuilder server(BoxStore boxStore, String url, SyncCredentials authenticatorCredentials) {
         return new SyncServerBuilder(boxStore, url, authenticatorCredentials);

objectbox-java/src/main/java/io/objectbox/sync/SyncClientImpl.java

@@ -167,9 +167,17 @@ public void setSyncListener(@Nullable SyncListener listener) {
 
     @Override
     public void setLoginCredentials(SyncCredentials credentials) {
-        SyncCredentialsToken credentialsInternal = (SyncCredentialsToken) credentials;
-        nativeSetLoginInfo(getHandle(), credentialsInternal.getTypeId(), credentialsInternal.getTokenBytes());
-        credentialsInternal.clear(); // Clear immediately, not needed anymore.
+        if (credentials instanceof SyncCredentialsToken) {
+            SyncCredentialsToken credToken = (SyncCredentialsToken) credentials;
+            nativeSetLoginInfo(getHandle(), credToken.getTypeId(), credToken.getTokenBytes());
+            credToken.clear(); // Clear immediately, not needed anymore.
+        } else if (credentials instanceof SyncCredentialsUserPassword) {
+            SyncCredentialsUserPassword credUserPassword = (SyncCredentialsUserPassword) credentials;
+            nativeSetLoginInfoUserPassword(getHandle(), credUserPassword.getTypeId(), credUserPassword.getUsername(),
+                    credUserPassword.getPassword());
+        } else {
+            throw new IllegalArgumentException("credentials is not a supported type");
+        }
     }
 
     @Override
@@ -296,6 +304,8 @@ public ObjectsMessageBuilder startObjectsMessage(long flags, @Nullable String to
 
     private native void nativeSetLoginInfo(long handle, long credentialsType, @Nullable byte[] credentials);
 
+    private native void nativeSetLoginInfoUserPassword(long handle, long credentialsType, String username, String password);
+
     private native void nativeSetListener(long handle, @Nullable InternalSyncClientListener listener);
 
     private native void nativeSetSyncChangesListener(long handle, @Nullable SyncChangeListener advancedListener);

objectbox-java/src/main/java/io/objectbox/sync/SyncCredentials.java

@@ -1,28 +1,27 @@
 package io.objectbox.sync;
 
-import io.objectbox.annotation.apihint.Experimental;
-
 /**
  * Use the static helper methods to build Sync credentials,
  * for example {@link #sharedSecret(String) SyncCredentials.sharedSecret("secret")}.
  */
 @SuppressWarnings("unused")
-@Experimental
 public class SyncCredentials {
 
+    private final CredentialsType type;
+
     /**
      * Authenticate with a shared secret. This could be a passphrase, big number or randomly chosen bytes.
      * The string is expected to use UTF-8 characters.
      */
     public static SyncCredentials sharedSecret(String secret) {
-        return new SyncCredentialsToken(CredentialsType.SHARED_SECRET, secret);
+        return new SyncCredentialsToken(CredentialsType.SHARED_SECRET_SIPPED, secret);
     }
 
     /**
      * Authenticate with a shared secret. This could be a passphrase, big number or randomly chosen bytes.
      */
     public static SyncCredentials sharedSecret(byte[] secret) {
-        return new SyncCredentialsToken(CredentialsType.SHARED_SECRET, secret);
+        return new SyncCredentialsToken(CredentialsType.SHARED_SECRET_SIPPED, secret);
     }
 
     /**
@@ -33,6 +32,10 @@ public static SyncCredentials google(String idToken) {
         return new SyncCredentialsToken(CredentialsType.GOOGLE, idToken);
     }
 
+    public static SyncCredentials userAndPassword(String user, String password) {
+        return new SyncCredentialsUserPassword(user, password);
+    }
+
     /**
      * No authentication, unsecured. Use only for development and testing purposes.
      */
@@ -44,10 +47,11 @@ public enum CredentialsType {
         // Note: this needs to match with CredentialsType in Core.
 
         NONE(1),
-
         SHARED_SECRET(2),
-
-        GOOGLE(3);
+        GOOGLE(3),
+        SHARED_SECRET_SIPPED(4),
+        OBX_ADMIN_USER(5),
+        USER_PASSWORD(6);
 
         public final long id;
 
@@ -56,7 +60,16 @@ public enum CredentialsType {
         }
     }
 
-    SyncCredentials() {
+    SyncCredentials(CredentialsType type) {
+        this.type = type;
+    }
+
+    public CredentialsType getType() {
+        return type;
+    }
+
+    public long getTypeId() {
+        return type.id;
     }
 
 }

objectbox-java/src/main/java/io/objectbox/sync/SyncCredentialsToken.java

@@ -1,6 +1,6 @@
 package io.objectbox.sync;
 
-import java.io.UnsupportedEncodingException;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 
 import javax.annotation.Nullable;
@@ -11,31 +11,28 @@
  * Internal credentials implementation. Use {@link SyncCredentials} to build credentials.
  */
 @Internal
-public class SyncCredentialsToken extends SyncCredentials {
+public final class SyncCredentialsToken extends SyncCredentials {
 
-    private final CredentialsType type;
     @Nullable private byte[] token;
     private volatile boolean cleared;
 
     SyncCredentialsToken(CredentialsType type) {
-        this.type = type;
+        super(type);
         this.token = null;
     }
 
-    SyncCredentialsToken(CredentialsType type, @SuppressWarnings("NullableProblems") byte[] token) {
+    SyncCredentialsToken(CredentialsType type, byte[] token) {
         this(type);
+        // Annotations do not guarantee non-null values
+        //noinspection ConstantValue
         if (token == null || token.length == 0) {
             throw new IllegalArgumentException("Token must not be empty");
         }
         this.token = token;
     }
 
     SyncCredentialsToken(CredentialsType type, String token) {
-        this(type, asUtf8Bytes(token));
-    }
-
-    public long getTypeId() {
-        return type.id;
+        this(type, token.getBytes(StandardCharsets.UTF_8));
     }
 
     @Nullable
@@ -61,12 +58,4 @@ public void clear() {
         this.token = null;
     }
 
-    private static byte[] asUtf8Bytes(String token) {
-        try {
-            //noinspection CharsetObjectCanBeUsed On Android not available until SDK 19.
-            return token.getBytes("UTF-8");
-        } catch (UnsupportedEncodingException e) {
-            throw new RuntimeException(e);
-        }
-    }
 }

objectbox-java/src/main/java/io/objectbox/sync/SyncCredentialsUserPassword.java

@@ -0,0 +1,28 @@
+package io.objectbox.sync;
+
+import io.objectbox.annotation.apihint.Internal;
+
+/**
+ * Internal credentials implementation for user and password authentication.
+ * Use {@link SyncCredentials} to build credentials.
+ */
+@Internal
+public final class SyncCredentialsUserPassword extends SyncCredentials {
+
+    private final String username;
+    private final String password;
+
+    SyncCredentialsUserPassword(String username, String password) {
+        super(CredentialsType.USER_PASSWORD);
+        this.username = username;
+        this.password = password;
+    }
+
+    public String getUsername() {
+        return username;
+    }
+
+    public String getPassword() {
+        return password;
+    }
+}

objectbox-java/src/main/java/io/objectbox/sync/server/SyncServerBuilder.java

@@ -46,6 +46,9 @@ public SyncServerBuilder certificatePath(String certificatePath) {
 
     /**
      * Adds additional authenticator credentials to authenticate clients with.
+     * <p>
+     * For the embedded server, currently only {@link SyncCredentials#sharedSecret} and {@link SyncCredentials#none}
+     * are supported.
      */
     public SyncServerBuilder authenticatorCredentials(SyncCredentials authenticatorCredentials) {
         checkNotNull(authenticatorCredentials, "Authenticator credentials must not be null.");

objectbox-java/src/main/java/io/objectbox/sync/server/SyncServerImpl.java

@@ -4,6 +4,7 @@
 
 import io.objectbox.annotation.apihint.Internal;
 import io.objectbox.sync.SyncCredentials;
+import io.objectbox.sync.SyncCredentials.CredentialsType;
 import io.objectbox.sync.SyncCredentialsToken;
 import io.objectbox.sync.listener.SyncChangeListener;
 
@@ -31,8 +32,16 @@ public class SyncServerImpl implements SyncServer {
         this.handle = handle;
 
         for (SyncCredentials credentials : builder.credentials) {
+            if (!(credentials instanceof SyncCredentialsToken)) {
+                throw new IllegalArgumentException("Sync credentials of type " + credentials.getType() + " are not supported");
+            }
             SyncCredentialsToken credentialsInternal = (SyncCredentialsToken) credentials;
-            nativeSetAuthenticator(handle, credentialsInternal.getTypeId(), credentialsInternal.getTokenBytes());
+            // The core API used by nativeSetAuthenticator only supports the NONE and SHARED_SECRET types
+            // (however, protocol v3 versions do also add SHARED_SECRET_SIPPED if SHARED_SECRET is given).
+            final CredentialsType type = credentialsInternal.getType() == CredentialsType.SHARED_SECRET_SIPPED
+                    ? CredentialsType.SHARED_SECRET
+                    : credentialsInternal.getType();
+            nativeSetAuthenticator(handle, type.id, credentialsInternal.getTokenBytes());
             credentialsInternal.clear(); // Clear immediately, not needed anymore.
         }