Make device id configurable (#178)

* Allow settings of deviceId for blob-authentication

* Use hex string for device ID + minor changes

Co-authored-by: ma5309 <[email protected]>
Co-authored-by: devgianlu <[email protected]>

Author: 3 people

common/src/main/java/xyz/gianlu/librespot/common/Utils.java

@@ -34,6 +34,13 @@ public final class Utils {
     private Utils() {
     }
 
+    @NotNull
+    public static String randomHexString(@NotNull Random random, int length) {
+        byte[] bytes = new byte[length / 2];
+        random.nextBytes(bytes);
+        return bytesToHex(bytes, 0, bytes.length, false, length);
+    }
+
     @NotNull
     public static String randomString(@NotNull Random random, int length) {
         char[] chars = new char[length];

core/src/main/java/xyz/gianlu/librespot/AbsConfiguration.java

@@ -17,6 +17,9 @@
  */
 public abstract class AbsConfiguration implements ApiConfiguration, Session.ProxyConfiguration, TimeProvider.Configuration, Player.Configuration, CacheManager.Configuration, AuthConfiguration, ZeroconfServer.Configuration {
 
+    @Nullable
+    public abstract String deviceId();
+
     @Nullable
     public abstract String deviceName();
 

core/src/main/java/xyz/gianlu/librespot/FileConfiguration.java

@@ -304,6 +304,11 @@ public boolean stopPlaybackOnChunkError() {
         return config.get("player.stopPlaybackOnChunkError");
     }
 
+    @Override
+    public @Nullable String deviceId() {
+        return config.get("deviceId");
+    }
+
     @Override
     public @Nullable String deviceName() {
         return config.get("deviceName");

core/src/main/java/xyz/gianlu/librespot/core/Session.java

@@ -667,7 +667,10 @@ private Inner(Connect.DeviceType deviceType, String deviceName, AbsConfiguration
             this.deviceName = deviceName;
             this.configuration = configuration;
             this.random = new SecureRandom();
-            this.deviceId = Utils.randomString(random, 40);
+
+            String configuredDeviceId = configuration.deviceId();
+            this.deviceId = (configuredDeviceId == null || configuredDeviceId.isEmpty()) ?
+                    Utils.randomHexString(random, 40).toLowerCase() : configuredDeviceId;
         }
 
         @NotNull

core/src/main/resources/default.toml

@@ -1,3 +1,4 @@
+deviceId = "" ### Device ID (40 chars, leave empty for random)  ###
 deviceName = "librespot-java" ### Device name ###
 deviceType = "COMPUTER" ### Device type (COMPUTER, TABLET, SMARTPHONE, SPEAKER, TV, AVR, STB, AUDIO_DONGLE, GAME_CONSOLE, CAST_VIDEO, CAST_AUDIO, AUTOMOBILE, WEARABLE, UNKNOWN_SPOTIFY, CAR_THING, UNKNOWN) ###
 preferredLocale = "en" ### Preferred locale ###