Add support for managing registration lock

Author: Trolldemorted

libsignal-service-dotnet/SignalServiceAccountManager.cs

@@ -61,6 +61,14 @@ public SignalServiceAccountManager(SignalServiceConfiguration configuration, Can
             PushServiceSocket = new PushServiceSocket(configuration, new StaticCredentialsProvider(null, null, null, (int)SignalServiceAddress.DEFAULT_DEVICE_ID), userAgent);
         }
 
+        public void SetPin(string pin)
+        {
+            if (pin != null)
+                PushServiceSocket.SetPin(pin);
+            else
+                PushServiceSocket.RemovePin();
+        }
+
         /// <summary>
         /// Register/Unregister a Google Cloud Messaging registration ID.
         /// </summary>
@@ -111,10 +119,10 @@ public void RequestVoiceVerificationCode()// throws IOException
         /// <param name="fetchesMessages">True if the client does not support GCM</param>
         /// <returns></returns>
         public void VerifyAccountWithCode(string verificationCode, string signalingKey,
-                                   uint signalProtocolRegistrationId, bool fetchesMessages)
+                                   uint signalProtocolRegistrationId, bool fetchesMessages, string pin)
         {
             this.PushServiceSocket.VerifyAccountCode(verificationCode, signalingKey,
-                                                 signalProtocolRegistrationId, fetchesMessages);
+                                                 signalProtocolRegistrationId, fetchesMessages, pin);
         }
 
         /// <summary>
@@ -127,9 +135,9 @@ public void VerifyAccountWithCode(string verificationCode, string signalingKey,
         /// separate installs.</param>
         /// <param name="fetchesMessages">True if the client does not support GCM</param>
         /// <returns></returns>
-        public void SetAccountAttributes(string signalingKey, uint signalProtocolRegistrationId, bool fetchesMessages)
+        public void SetAccountAttributes(string signalingKey, uint signalProtocolRegistrationId, bool fetchesMessages, string pin)
         {
-            this.PushServiceSocket.SetAccountAttributes(signalingKey, signalProtocolRegistrationId, fetchesMessages);
+            this.PushServiceSocket.SetAccountAttributes(signalingKey, signalProtocolRegistrationId, fetchesMessages, pin);
         }
 
         /// <summary>
@@ -210,15 +218,6 @@ public List<ContactTokenDetails> GetContacts(IList<string> e164numbers)
             return activeTokens;
         }
 
-        /// <summary>
-        /// Soon to be deprecated
-        /// </summary>
-        /// <returns></returns>
-        public string GetAccountVerificationToken()
-        {
-            return PushServiceSocket.GetAccountVerificationToken();
-        }
-
         /// <summary>
         /// Request a UUID from the server for linking as a new device.
         /// Called by the new device.

libsignal-service-dotnet/push/AccountAttributes.cs

@@ -23,27 +23,31 @@ namespace libsignalservice.push
     internal class AccountAttributes
     {
         [JsonProperty("signalingKey", Required = Required.Always)]
-        private string SignalingKey { get; set; }
+        private string SignalingKey { get; }
 
         [JsonProperty("registrationId", Required = Required.Always)]
-        private uint RegistrationId { get; set; }
+        private uint RegistrationId { get; }
 
         [JsonProperty("voice", Required = Required.Always)]
-        private bool Voice { get; set; }
+        private bool Voice { get; }
 
         [JsonProperty("video", Required = Required.Always)]
-        private bool Video { get; set; }
+        private bool Video { get; }
 
         [JsonProperty("fetchesMessages", Required = Required.Always)]
-        private bool FetchesMessages { get; set; }
+        private bool FetchesMessages { get; }
+
+        [JsonProperty("pin")]
+        private string Pin { get; }
 
-        public AccountAttributes(string signalingKey, uint registrationId, bool fetchesMessages)
+        public AccountAttributes(string signalingKey, uint registrationId, bool fetchesMessages, string pin)
         {
             SignalingKey = signalingKey;
             RegistrationId = registrationId;
             Voice = true;
             Video = true;
-            FetchesMessages = fetchesMessages;
+            FetchesMessages = fetchesMessages;
+            Pin = pin;
         }
     }
 }

libsignal-service-dotnet/push/LockedException.cs

@@ -0,0 +1,20 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace libsignalservice.push
+{
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+    public class LockedException : Exception
+    {
+        public int Length { get; }
+        public long TimeRemaining { get; }
+
+        public LockedException(int length, long timeRemaining)
+        {
+            Length = length;
+            TimeRemaining = timeRemaining;
+        }
+    }
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
+}

libsignal-service-dotnet/push/PushServiceSocket.cs

@@ -36,11 +36,11 @@ internal class PushServiceSocket
         private static readonly string CREATE_ACCOUNT_SMS_PATH = "/v1/accounts/sms/code/{0}";
         private static readonly string CREATE_ACCOUNT_VOICE_PATH = "/v1/accounts/voice/code/{0}";
         private static readonly string VERIFY_ACCOUNT_CODE_PATH = "/v1/accounts/code/{0}";
-        private static readonly string VERIFY_ACCOUNT_TOKEN_PATH = "/v1/accounts/token/{0}";
         private static readonly string REGISTER_GCM_PATH = "/v1/accounts/gcm/";
         private static readonly string REQUEST_TOKEN_PATH = "/v1/accounts/token";
         private static readonly string TURN_SERVER_INFO = "/v1/accounts/turn";
         private static readonly string SET_ACCOUNT_ATTRIBUTES = "/v1/accounts/attributes";
+        private static readonly String PIN_PATH = "/v1/accounts/pin/";
 
         private static readonly string PREKEY_METADATA_PATH = "/v2/keys/";
         private static readonly string PREKEY_PATH = "/v2/keys/{0}";
@@ -77,26 +77,20 @@ public bool CreateAccount(bool voice)
             return true;
         }
 
-        public bool VerifyAccountCode(string verificationCode, string signalingKey, uint registrationId, bool fetchesMessages)
+        public bool VerifyAccountCode(string verificationCode, string signalingKey, uint registrationId, bool fetchesMessages, string pin)
         {
-            AccountAttributes signalingKeyEntity = new AccountAttributes(signalingKey, registrationId, fetchesMessages);
+            AccountAttributes signalingKeyEntity = new AccountAttributes(signalingKey, registrationId, fetchesMessages, pin);
             MakeServiceRequest(string.Format(VERIFY_ACCOUNT_CODE_PATH, verificationCode), "PUT", JsonUtil.toJson(signalingKeyEntity));
             return true;
         }
 
-        public bool SetAccountAttributes(string signalingKey, uint registrationId, bool fetchesMessages)
+        public bool SetAccountAttributes(string signalingKey, uint registrationId, bool fetchesMessages, string pin)
         {
-            AccountAttributes accountAttributesEntity = new AccountAttributes(signalingKey, registrationId, fetchesMessages);
+            AccountAttributes accountAttributesEntity = new AccountAttributes(signalingKey, registrationId, fetchesMessages, pin);
             MakeServiceRequest(SET_ACCOUNT_ATTRIBUTES, "PUT", JsonUtil.toJson(accountAttributesEntity));
             return true;
         }
 
-        public string GetAccountVerificationToken()// throws IOException
-        {
-            string responseText = MakeServiceRequest(REQUEST_TOKEN_PATH, "GET", null);
-            return JsonUtil.fromJson<AuthorizationToken>(responseText).Token;
-        }
-
         public int FinishNewDeviceRegistration(String code, String signalingKey, bool supportsSms, bool fetchesMessages, int registrationId, String deviceName)
         {
             ConfirmCodeMessage javaJson = new ConfirmCodeMessage(signalingKey, supportsSms, fetchesMessages, registrationId, deviceName);
@@ -142,6 +136,17 @@ public void UnregisterGcmId()
             MakeServiceRequest(REGISTER_GCM_PATH, "DELETE", null);
         }
 
+        public void SetPin(string pin)
+        {
+            RegistrationLock accountLock = new RegistrationLock(pin);
+            MakeServiceRequest(PIN_PATH, "PUT", JsonUtil.toJson(accountLock));
+        }
+
+        public void RemovePin()
+        {
+            MakeServiceRequest(PIN_PATH, "PUT", null);
+        }
+
         public SendMessageResponse SendMessage(OutgoingPushMessageList bundle)
         {
             try
@@ -350,13 +355,13 @@ public bool SetCurrentSignedPreKey(SignedPreKeyRecord signedPreKey)// throws IOE
             string response = MakeServiceRequest(string.Format(ATTACHMENT_PATH, ""), "GET", null);
             AttachmentDescriptor attachmentKey = JsonUtil.fromJson<AttachmentDescriptor>(response);
 
-            if (attachmentKey == null || attachmentKey.getLocation() == null)
+            if (attachmentKey == null || attachmentKey.Location == null)
             {
                 throw new Exception("Server failed to allocate an attachment key!");
             }
 
-            Debug.WriteLine("Got attachment content location: " + attachmentKey.getLocation(), TAG);
-            return (attachmentKey.getId(), attachmentKey.getLocation());
+            Debug.WriteLine("Got attachment content location: " + attachmentKey.Location, TAG);
+            return (attachmentKey.Id, attachmentKey.Location);
         }
 
         public void RetrieveAttachment(string relay, ulong attachmentId, Stream tmpDestination, int maxSizeBytes)
@@ -383,8 +388,8 @@ public string RetrieveAttachmentDownloadUrl(string relay, ulong attachmentId)
             string response = MakeServiceRequest(path, "GET", null);
             Debug.WriteLine("PushServiceSocket: Received resp " + response);
             AttachmentDescriptor descriptor = JsonUtil.fromJson<AttachmentDescriptor>(response);
-            Debug.WriteLine("PushServiceSocket: Attachment: " + attachmentId + " is at: " + descriptor.getLocation());
-            return descriptor.getLocation();
+            Debug.WriteLine("PushServiceSocket: Attachment: " + attachmentId + " is at: " + descriptor.Location);
+            return descriptor.Location;
         }
 
         public SignalServiceProfile RetrieveProfile(SignalServiceAddress target)
@@ -627,16 +632,16 @@ private string MakeServiceRequest(string urlFragment, string method, string body
                 throw new PushNetworkException(ioe);
             }
 
-            switch (responseCode)
+            switch ((uint)responseCode)
             {
-                case HttpStatusCode.RequestEntityTooLarge: // 413
+                case 413: // HttpStatusCode.RequestEntityTooLarge
                     throw new RateLimitException("Rate limit exceeded: " + responseCode);
-                case HttpStatusCode.Unauthorized: // 401
-                case HttpStatusCode.Forbidden: // 403
+                case 401: // HttpStatusCode.Unauthorized
+                case 403: // HttpStatusCode.Forbidden
                     throw new AuthorizationFailedException("Authorization failed!");
-                case HttpStatusCode.NotFound: // 404
+                case 404: // HttpStatusCode.NotFound
                     throw new NotFoundException("Not found");
-                case HttpStatusCode.Conflict: // 409
+                case 409: // HttpStatusCode.Conflict
                     MismatchedDevices mismatchedDevices = null;
                     try
                     {
@@ -649,7 +654,7 @@ private string MakeServiceRequest(string urlFragment, string method, string body
                         throw new PushNetworkException(e);
                     }
                     throw new MismatchedDevicesException(mismatchedDevices);
-                case HttpStatusCode.Gone: // 410
+                case 410: // HttpStatusCode.Gone
                     StaleDevices staleDevices = null;
                     try
                     {
@@ -662,21 +667,30 @@ private string MakeServiceRequest(string urlFragment, string method, string body
                         throw new PushNetworkException(e);
                     }
                     throw new StaleDevicesException(staleDevices);
-                case HttpStatusCode.LengthRequired://411:
+                case 411: //HttpStatusCode.LengthRequired
                     DeviceLimit deviceLimit = null;
                     try
                     {
                         deviceLimit = JsonUtil.fromJson<DeviceLimit>(responseBody);
                     }
                     catch (Exception e)
                     {
-                        Debug.WriteLine(e);
-                        Debug.WriteLine(e.StackTrace);
                         throw new PushNetworkException(e);
                     }
                     throw new DeviceLimitExceededException(deviceLimit);
-                case HttpStatusCode.ExpectationFailed: // 417
+                case 417: // HttpStatusCode.ExpectationFailed
                     throw new ExpectationFailedException();
+                case 423:
+                    RegistrationLockFailure accountLockFailure;
+                    try
+                    {
+                        accountLockFailure = JsonUtil.fromJson<RegistrationLockFailure>(responseBody);
+                    }
+                    catch (Exception e)
+                    {
+                        throw new PushNetworkException(e);
+                    }
+                    throw new LockedException(accountLockFailure.Length, accountLockFailure.TimeRemaining);
             }
 
             if (responseCode != HttpStatusCode.OK && responseCode != HttpStatusCode.NoContent) // 200 & 204
@@ -780,39 +794,44 @@ private SignalUrl GetRandom(SignalUrl[] connections)
 
     internal class GcmRegistrationId
     {
-        [JsonProperty]
-        private string wnsRegistrationId;
+        [JsonProperty("wnsRegistrationId")]
+        public string WnsRegistrationId { get; }
 
-        [JsonProperty]
-        private bool webSocketChannel;
-
-        public GcmRegistrationId()
-        {
-        }
+        [JsonProperty("webSocketChannel")]
+        public bool WebSocketChannel { get; }
 
         public GcmRegistrationId(string wnsRegistrationId, bool webSocketChannel)
         {
-            this.wnsRegistrationId = wnsRegistrationId;
-            this.webSocketChannel = webSocketChannel;
+            WnsRegistrationId = wnsRegistrationId;
+            WebSocketChannel = webSocketChannel;
         }
     }
 
-    internal class AttachmentDescriptor
+    internal class RegistrationLock
     {
-        [JsonProperty]
-        private ulong id;
+        [JsonProperty("pin")]
+        public string Pin { get; }
 
-        [JsonProperty]
-        private string location;
-
-        public ulong getId()
+        public RegistrationLock(string pin)
         {
-            return id;
+            Pin = pin;
         }
+    }
 
-        public string getLocation()
-        {
-            return location;
-        }
+    internal class RegistrationLockFailure
+    {
+        [JsonProperty("length")]
+        public int Length { get; }
+        [JsonProperty("timeRemaining")]
+        public long TimeRemaining { get; }
+    }
+
+    internal class AttachmentDescriptor
+    {
+        [JsonProperty("id")]
+        public ulong Id { get; }
+
+        [JsonProperty("location")]
+        public string Location { get; }
     }
 }