]> nmode's Git Repositories - signal-cli/blobdiff - src/main/java/org/asamk/signal/Main.java
Support registration lock PIN
[signal-cli] / src / main / java / org / asamk / signal / Main.java
index 5dd471f94f4fa1d25dc0cc66b2c29d4894f74aea..5968904937c23484a4c47853ff8e015245c6a344 100644 (file)
  */
 package org.asamk.signal;
 
+import com.fasterxml.jackson.annotation.JsonAutoDetect;
+import com.fasterxml.jackson.annotation.PropertyAccessor;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import net.sourceforge.argparse4j.ArgumentParsers;
 import net.sourceforge.argparse4j.impl.Arguments;
 import net.sourceforge.argparse4j.inf.*;
 import org.apache.http.util.TextUtils;
 import org.asamk.Signal;
+import org.asamk.signal.storage.contacts.ContactInfo;
+import org.asamk.signal.storage.groups.GroupInfo;
+import org.asamk.signal.storage.protocol.JsonIdentityKeyStore;
+import org.asamk.signal.util.Hex;
 import org.freedesktop.dbus.DBusConnection;
 import org.freedesktop.dbus.DBusSigHandler;
 import org.freedesktop.dbus.exceptions.DBusException;
 import org.freedesktop.dbus.exceptions.DBusExecutionException;
 import org.whispersystems.libsignal.InvalidKeyException;
+import org.whispersystems.libsignal.util.guava.Optional;
 import org.whispersystems.signalservice.api.crypto.UntrustedIdentityException;
 import org.whispersystems.signalservice.api.messages.*;
+import org.whispersystems.signalservice.api.messages.calls.*;
 import org.whispersystems.signalservice.api.messages.multidevice.*;
 import org.whispersystems.signalservice.api.push.SignalServiceAddress;
 import org.whispersystems.signalservice.api.push.exceptions.EncapsulatedExceptions;
 import org.whispersystems.signalservice.api.push.exceptions.NetworkFailureException;
 import org.whispersystems.signalservice.api.push.exceptions.UnregisteredUserException;
 import org.whispersystems.signalservice.api.util.PhoneNumberFormatter;
+import org.whispersystems.signalservice.internal.push.LockedException;
+import org.whispersystems.signalservice.internal.util.Base64;
 
 import java.io.File;
 import java.io.IOException;
@@ -46,6 +61,7 @@ import java.security.Security;
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 import java.util.*;
+import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 
 public class Main {
@@ -87,6 +103,9 @@ public class Main {
                     ts = (Signal) dBusConn.getRemoteObject(
                             SIGNAL_BUSNAME, SIGNAL_OBJECTPATH,
                             Signal.class);
+                } catch (UnsatisfiedLinkError e) {
+                    System.err.println("Missing native library dependency for dbus service: " + e.getMessage());
+                    return 1;
                 } catch (DBusException e) {
                     e.printStackTrace();
                     if (dBusConn != null) {
@@ -134,6 +153,71 @@ public class Main {
                         return 3;
                     }
                     break;
+                case "unregister":
+                    if (dBusConn != null) {
+                        System.err.println("unregister is not yet implemented via dbus");
+                        return 1;
+                    }
+                    if (!m.isRegistered()) {
+                        System.err.println("User is not registered.");
+                        return 1;
+                    }
+                    try {
+                        m.unregister();
+                    } catch (IOException e) {
+                        System.err.println("Unregister error: " + e.getMessage());
+                        return 3;
+                    }
+                    break;
+                case "updateAccount":
+                    if (dBusConn != null) {
+                        System.err.println("updateAccount is not yet implemented via dbus");
+                        return 1;
+                    }
+                    if (!m.isRegistered()) {
+                        System.err.println("User is not registered.");
+                        return 1;
+                    }
+                    try {
+                        m.updateAccountAttributes();
+                    } catch (IOException e) {
+                        System.err.println("UpdateAccount error: " + e.getMessage());
+                        return 3;
+                    }
+                    break;
+                case "setPin":
+                    if (dBusConn != null) {
+                        System.err.println("setPin is not yet implemented via dbus");
+                        return 1;
+                    }
+                    if (!m.isRegistered()) {
+                        System.err.println("User is not registered.");
+                        return 1;
+                    }
+                    try {
+                        String registrationLockPin = ns.getString("registrationLockPin");
+                        m.setRegistrationLockPin(Optional.of(registrationLockPin));
+                    } catch (IOException e) {
+                        System.err.println("Set pin error: " + e.getMessage());
+                        return 3;
+                    }
+                    break;
+                case "removePin":
+                    if (dBusConn != null) {
+                        System.err.println("removePin is not yet implemented via dbus");
+                        return 1;
+                    }
+                    if (!m.isRegistered()) {
+                        System.err.println("User is not registered.");
+                        return 1;
+                    }
+                    try {
+                        m.setRegistrationLockPin(Optional.<String>absent());
+                    } catch (IOException e) {
+                        System.err.println("Remove pin error: " + e.getMessage());
+                        return 3;
+                    }
+                    break;
                 case "verify":
                     if (dBusConn != null) {
                         System.err.println("verify is not yet implemented via dbus");
@@ -148,7 +232,13 @@ public class Main {
                         return 1;
                     }
                     try {
-                        m.verifyAccount(ns.getString("verificationCode"));
+                        String verificationCode = ns.getString("verificationCode");
+                        String pin = ns.getString("pin");
+                        m.verifyAccount(verificationCode, pin);
+                    } catch (LockedException e) {
+                        System.err.println("Verification failed! This number is locked with a pin. Hours remaining until reset: " + (e.getTimeRemaining() / 1000 / 60 / 60));
+                        System.err.println("Use '--pin PIN_CODE' to specify the registration lock PIN");
+                        return 3;
                     } catch (IOException e) {
                         System.err.println("Verify error: " + e.getMessage());
                         return 3;
@@ -177,6 +267,9 @@ public class Main {
                     } catch (IOException e) {
                         System.err.println("Link request error: " + e.getMessage());
                         return 3;
+                    } catch (AssertionError e) {
+                        handleAssertionError(e);
+                        return 1;
                     } catch (InvalidKeyException e) {
                         e.printStackTrace();
                         return 2;
@@ -202,6 +295,9 @@ public class Main {
                     } catch (InvalidKeyException e) {
                         e.printStackTrace();
                         return 2;
+                    } catch (AssertionError e) {
+                        handleAssertionError(e);
+                        return 1;
                     } catch (URISyntaxException e) {
                         e.printStackTrace();
                         return 2;
@@ -221,8 +317,8 @@ public class Main {
                         for (DeviceInfo d : devices) {
                             System.out.println("Device " + d.getId() + (d.getId() == m.getDeviceId() ? " (this device)" : "") + ":");
                             System.out.println(" Name: " + d.getName());
-                            System.out.println(" Created: " + d.getCreated());
-                            System.out.println(" Last seen: " + d.getLastSeen());
+                            System.out.println(" Created: " + formatTimestamp(d.getCreated()));
+                            System.out.println(" Last seen: " + formatTimestamp(d.getLastSeen()));
                         }
                     } catch (IOException e) {
                         e.printStackTrace();
@@ -343,6 +439,16 @@ public class Main {
                                     System.out.println();
                                 }
                             });
+                            dBusConn.addSigHandler(Signal.ReceiptReceived.class, new DBusSigHandler<Signal.ReceiptReceived>() {
+                                @Override
+                                public void handle(Signal.ReceiptReceived s) {
+                                    System.out.print(String.format("Receipt from: %s\nTimestamp: %s\n",
+                                            s.getSender(), formatTimestamp(s.getTimestamp())));
+                                }
+                            });
+                        } catch (UnsatisfiedLinkError e) {
+                            System.err.println("Missing native library dependency for dbus service: " + e.getMessage());
+                            return 1;
                         } catch (DBusException e) {
                             e.printStackTrace();
                             return 1;
@@ -359,17 +465,19 @@ public class Main {
                         System.err.println("User is not registered.");
                         return 1;
                     }
-                    int timeout = 5;
-                    if (ns.getInt("timeout") != null) {
-                        timeout = ns.getInt("timeout");
+                    double timeout = 5;
+                    if (ns.getDouble("timeout") != null) {
+                        timeout = ns.getDouble("timeout");
                     }
                     boolean returnOnTimeout = true;
                     if (timeout < 0) {
                         returnOnTimeout = false;
                         timeout = 3600;
                     }
+                    boolean ignoreAttachments = ns.getBoolean("ignore_attachments");
                     try {
-                        m.receiveMessages(timeout, returnOnTimeout, new ReceiveMessageHandler(m));
+                        final Manager.ReceiveMessageHandler handler = ns.getBoolean("json") ? new JsonReceiveMessageHandler(m) : new ReceiveMessageHandler(m);
+                        m.receiveMessages((long) (timeout * 1000), TimeUnit.MILLISECONDS, returnOnTimeout, ignoreAttachments, handler);
                     } catch (IOException e) {
                         System.err.println("Error while receiving messages: " + e.getMessage());
                         return 3;
@@ -409,11 +517,7 @@ public class Main {
 
                     break;
                 case "updateGroup":
-                    if (dBusConn != null) {
-                        System.err.println("updateGroup is not yet implemented via dbus");
-                        return 1;
-                    }
-                    if (!m.isRegistered()) {
+                    if (dBusConn == null && !m.isRegistered()) {
                         System.err.println("User is not registered.");
                         return 1;
                     }
@@ -423,8 +527,23 @@ public class Main {
                         if (ns.getString("group") != null) {
                             groupId = decodeGroupId(ns.getString("group"));
                         }
-                        byte[] newGroupId = m.sendUpdateGroupMessage(groupId, ns.getString("name"), ns.<String>getList("member"), ns.getString("avatar"));
                         if (groupId == null) {
+                            groupId = new byte[0];
+                        }
+                        String groupName = ns.getString("name");
+                        if (groupName == null) {
+                            groupName = "";
+                        }
+                        List<String> groupMembers = ns.<String>getList("member");
+                        if (groupMembers == null) {
+                            groupMembers = new ArrayList<String>();
+                        }
+                        String groupAvatar = ns.getString("avatar");
+                        if (groupAvatar == null) {
+                            groupAvatar = "";
+                        }
+                        byte[] newGroupId = ts.updateGroup(groupId, groupName, groupMembers, groupAvatar);
+                        if (groupId.length != newGroupId.length) {
                             System.out.println("Creating new group \"" + Base64.encodeBytes(newGroupId) + "\" …");
                         }
                     } catch (IOException e) {
@@ -445,6 +564,23 @@ public class Main {
                         return 3;
                     }
 
+                    break;
+                case "listGroups":
+                    if (dBusConn != null) {
+                        System.err.println("listGroups is not yet implemented via dbus");
+                        return 1;
+                    }
+                    if (!m.isRegistered()) {
+                        System.err.println("User is not registered.");
+                        return 1;
+                    }
+
+                    List<GroupInfo> groups = m.getGroups();
+                    boolean detailed = ns.getBoolean("detailed");
+
+                    for (GroupInfo group : groups) {
+                        printGroup(group, detailed);
+                    }
                     break;
                 case "listIdentities":
                     if (dBusConn != null) {
@@ -538,12 +674,16 @@ public class Main {
                             conn = DBusConnection.getConnection(busType);
                             conn.exportObject(SIGNAL_OBJECTPATH, m);
                             conn.requestBusName(SIGNAL_BUSNAME);
+                        } catch (UnsatisfiedLinkError e) {
+                            System.err.println("Missing native library dependency for dbus service: " + e.getMessage());
+                            return 1;
                         } catch (DBusException e) {
                             e.printStackTrace();
                             return 2;
                         }
+                        ignoreAttachments = ns.getBoolean("ignore_attachments");
                         try {
-                            m.receiveMessages(3600, false, new DbusReceiveMessageHandler(m, conn));
+                            m.receiveMessages(1, TimeUnit.HOURS, false, ignoreAttachments, new DbusReceiveMessageHandler(m, conn));
                         } catch (IOException e) {
                             System.err.println("Error while receiving messages: " + e.getMessage());
                             return 3;
@@ -568,9 +708,19 @@ public class Main {
     }
 
     private static void printIdentityFingerprint(Manager m, String theirUsername, JsonIdentityKeyStore.Identity theirId) {
-        String digits = formatSafetyNumber(m.computeSafetyNumber(theirUsername, theirId.identityKey));
+        String digits = formatSafetyNumber(m.computeSafetyNumber(theirUsername, theirId.getIdentityKey()));
         System.out.println(String.format("%s: %s Added: %s Fingerprint: %s Safety Number: %s", theirUsername,
-                theirId.trustLevel, theirId.added, Hex.toStringCondensed(theirId.getFingerprint()), digits));
+                theirId.getTrustLevel(), theirId.getDateAdded(), Hex.toStringCondensed(theirId.getFingerprint()), digits));
+    }
+
+    private static void printGroup(GroupInfo group, boolean detailed) {
+        if (detailed) {
+            System.out.println(String.format("Id: %s Name: %s  Active: %s Members: %s",
+                    Base64.encodeBytes(group.groupId), group.name, group.active, group.members));
+        } else {
+            System.out.println(String.format("Id: %s Name: %s  Active: %s", Base64.encodeBytes(group.groupId),
+                    group.name, group.active));
+        }
     }
 
     private static String formatSafetyNumber(String digits) {
@@ -612,7 +762,8 @@ public class Main {
     }
 
     private static Namespace parseArgs(String[] args) {
-        ArgumentParser parser = ArgumentParsers.newArgumentParser("signal-cli")
+        ArgumentParser parser = ArgumentParsers.newFor("signal-cli")
+                .build()
                 .defaultHelp(true)
                 .description("Commandline interface for Signal.")
                 .version(Manager.PROJECT_NAME + " " + Manager.PROJECT_VERSION);
@@ -661,9 +812,23 @@ public class Main {
                 .help("The verification should be done over voice, not sms.")
                 .action(Arguments.storeTrue());
 
+        Subparser parserUnregister = subparsers.addParser("unregister");
+        parserUnregister.help("Unregister the current device from the signal server.");
+
+        Subparser parserUpdateAccount = subparsers.addParser("updateAccount");
+        parserUpdateAccount.help("Update the account attributes on the signal server.");
+
+        Subparser parserSetPin = subparsers.addParser("setPin");
+        parserSetPin.addArgument("registrationLockPin")
+                .help("The registration lock PIN, that will be required for new registrations (resets after 7 days of inactivity)");
+
+        Subparser parserRemovePin = subparsers.addParser("removePin");
+
         Subparser parserVerify = subparsers.addParser("verify");
         parserVerify.addArgument("verificationCode")
                 .help("The verification code you received via sms or voice call.");
+        parserVerify.addArgument("-p", "--pin")
+                .help("The registration lock PIN, that was set by the user (Optional)");
 
         Subparser parserSend = subparsers.addParser("send");
         parserSend.addArgument("-g", "--group")
@@ -696,6 +861,11 @@ public class Main {
                 .nargs("*")
                 .help("Specify one or more members to add to the group");
 
+        Subparser parserListGroups = subparsers.addParser("listGroups");
+        parserListGroups.addArgument("-d", "--detailed").action(Arguments.storeTrue())
+                .help("List members of each group");
+        parserListGroups.help("List group name and ids");
+
         Subparser parserListIdentities = subparsers.addParser("listIdentities");
         parserListIdentities.addArgument("-n", "--number")
                 .help("Only show identity keys for the given phone number.");
@@ -713,13 +883,22 @@ public class Main {
 
         Subparser parserReceive = subparsers.addParser("receive");
         parserReceive.addArgument("-t", "--timeout")
-                .type(int.class)
+                .type(double.class)
                 .help("Number of seconds to wait for new messages (negative values disable timeout)");
+        parserReceive.addArgument("--ignore-attachments")
+                .help("Don’t download attachments of received messages.")
+                .action(Arguments.storeTrue());
+        parserReceive.addArgument("--json")
+                .help("Output received messages in json format, one json object per line.")
+                .action(Arguments.storeTrue());
 
         Subparser parserDaemon = subparsers.addParser("daemon");
         parserDaemon.addArgument("--system")
                 .action(Arguments.storeTrue())
                 .help("Use DBus system bus instead of user bus.");
+        parserDaemon.addArgument("--ignore-attachments")
+                .help("Don’t download attachments of received messages.")
+                .action(Arguments.storeTrue());
 
         try {
             Namespace ns = parser.parseArgs(args);
@@ -828,8 +1007,13 @@ public class Main {
                         SignalServiceSyncMessage syncMessage = content.getSyncMessage().get();
 
                         if (syncMessage.getContacts().isPresent()) {
-                            System.out.println("Received sync contacts");
-                            printAttachment(syncMessage.getContacts().get());
+                            final ContactsMessage contactsMessage = syncMessage.getContacts().get();
+                            if (contactsMessage.isComplete()) {
+                                System.out.println("Received complete sync contacts");
+                            } else {
+                                System.out.println("Received sync contacts");
+                            }
+                            printAttachment(contactsMessage.getContactsStream());
                         }
                         if (syncMessage.getGroups().isPresent()) {
                             System.out.println("Received sync groups");
@@ -877,6 +1061,61 @@ public class Main {
                                 System.out.println(" - " + number);
                             }
                         }
+                        if (syncMessage.getVerified().isPresent()) {
+                            System.out.println("Received sync message with verified identities:");
+                            final VerifiedMessage verifiedMessage = syncMessage.getVerified().get();
+                            System.out.println(" - " + verifiedMessage.getDestination() + ": " + verifiedMessage.getVerified());
+                            String safetyNumber = formatSafetyNumber(m.computeSafetyNumber(verifiedMessage.getDestination(), verifiedMessage.getIdentityKey()));
+                            System.out.println("   " + safetyNumber);
+                        }
+                        if (syncMessage.getConfiguration().isPresent()) {
+                            System.out.println("Received sync message with configuration:");
+                            final ConfigurationMessage configurationMessage = syncMessage.getConfiguration().get();
+                            if (configurationMessage.getReadReceipts().isPresent()) {
+                                System.out.println(" - Read receipts: " + (configurationMessage.getReadReceipts().get() ? "enabled" : "disabled"));
+                            }
+                        }
+                    }
+                    if (content.getCallMessage().isPresent()) {
+                        System.out.println("Received a call message");
+                        SignalServiceCallMessage callMessage = content.getCallMessage().get();
+                        if (callMessage.getAnswerMessage().isPresent()) {
+                            AnswerMessage answerMessage = callMessage.getAnswerMessage().get();
+                            System.out.println("Answer message: " + answerMessage.getId() + ": " + answerMessage.getDescription());
+                        }
+                        if (callMessage.getBusyMessage().isPresent()) {
+                            BusyMessage busyMessage = callMessage.getBusyMessage().get();
+                            System.out.println("Busy message: " + busyMessage.getId());
+                        }
+                        if (callMessage.getHangupMessage().isPresent()) {
+                            HangupMessage hangupMessage = callMessage.getHangupMessage().get();
+                            System.out.println("Hangup message: " + hangupMessage.getId());
+                        }
+                        if (callMessage.getIceUpdateMessages().isPresent()) {
+                            List<IceUpdateMessage> iceUpdateMessages = callMessage.getIceUpdateMessages().get();
+                            for (IceUpdateMessage iceUpdateMessage : iceUpdateMessages) {
+                                System.out.println("Ice update message: " + iceUpdateMessage.getId() + ", sdp: " + iceUpdateMessage.getSdp());
+                            }
+                        }
+                        if (callMessage.getOfferMessage().isPresent()) {
+                            OfferMessage offerMessage = callMessage.getOfferMessage().get();
+                            System.out.println("Offer message: " + offerMessage.getId() + ": " + offerMessage.getDescription());
+                        }
+                    }
+                    if (content.getReceiptMessage().isPresent()) {
+                        System.out.println("Received a receipt message");
+                        SignalServiceReceiptMessage receiptMessage = content.getReceiptMessage().get();
+                        System.out.println(" - When: " + formatTimestamp(receiptMessage.getWhen()));
+                        if (receiptMessage.isDeliveryReceipt()) {
+                            System.out.println(" - Is delivery receipt");
+                        }
+                        if (receiptMessage.isReadReceipt()) {
+                            System.out.println(" - Is read receipt");
+                        }
+                        System.out.println(" - Timestamps:");
+                        for (long timestamp : receiptMessage.getTimestamps()) {
+                            System.out.println("    " + formatTimestamp(timestamp));
+                        }
                     }
                 }
             } else {
@@ -925,6 +1164,9 @@ public class Main {
             if (message.getExpiresInSeconds() > 0) {
                 System.out.println("Expires in: " + message.getExpiresInSeconds() + " seconds");
             }
+            if (message.isProfileKeyUpdate() && message.getProfileKey().isPresent()) {
+                System.out.println("Profile key update, key length:" + message.getProfileKey().get().length);
+            }
 
             if (message.getAttachments().isPresent()) {
                 System.out.println("Attachments: ");
@@ -939,7 +1181,10 @@ public class Main {
             if (attachment.isPointer()) {
                 final SignalServiceAttachmentPointer pointer = attachment.asPointer();
                 System.out.println("  Id: " + pointer.getId() + " Key length: " + pointer.getKey().length + (pointer.getRelay().isPresent() ? " Relay: " + pointer.getRelay().get() : ""));
+                System.out.println("  Filename: " + (pointer.getFileName().isPresent() ? pointer.getFileName().get() : "-"));
                 System.out.println("  Size: " + (pointer.getSize().isPresent() ? pointer.getSize().get() + " bytes" : "<unavailable>") + (pointer.getPreview().isPresent() ? " (Preview is available: " + pointer.getPreview().get().length + " bytes)" : ""));
+                System.out.println("  Voice note: " + (pointer.getVoiceNote() ? "yes" : "no"));
+                System.out.println("  Dimensions: " + pointer.getWidth() + "x" + pointer.getHeight());
                 File file = m.getAttachmentFile(pointer.getId());
                 if (file.exists()) {
                     System.out.println("  Stored plaintext in: " + file);
@@ -960,7 +1205,17 @@ public class Main {
         public void handleMessage(SignalServiceEnvelope envelope, SignalServiceContent content, Throwable exception) {
             super.handleMessage(envelope, content, exception);
 
-            if (!envelope.isReceipt() && content != null && content.getDataMessage().isPresent()) {
+            if (envelope.isReceipt()) {
+                try {
+                    conn.sendSignal(new Signal.ReceiptReceived(
+                            SIGNAL_OBJECTPATH,
+                            envelope.getTimestamp(),
+                            envelope.getSource()
+                    ));
+                } catch (DBusException e) {
+                    e.printStackTrace();
+                }
+            } else if (content != null && content.getDataMessage().isPresent()) {
                 SignalServiceDataMessage message = content.getDataMessage().get();
 
                 if (!message.isEndSession() &&
@@ -989,7 +1244,37 @@ public class Main {
                 }
             }
         }
+    }
 
+    private static class JsonReceiveMessageHandler implements Manager.ReceiveMessageHandler {
+        final Manager m;
+        final ObjectMapper jsonProcessor;
+
+        public JsonReceiveMessageHandler(Manager m) {
+            this.m = m;
+            this.jsonProcessor = new ObjectMapper();
+            jsonProcessor.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); // disable autodetect
+            jsonProcessor.enable(SerializationFeature.WRITE_NULL_MAP_VALUES);
+            jsonProcessor.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
+            jsonProcessor.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET);
+        }
+
+        @Override
+        public void handleMessage(SignalServiceEnvelope envelope, SignalServiceContent content, Throwable exception) {
+            ObjectNode result = jsonProcessor.createObjectNode();
+            if (exception != null) {
+                result.putPOJO("error", new JsonError(exception));
+            }
+            if (envelope != null) {
+                result.putPOJO("envelope", new JsonMessageEnvelope(envelope, content));
+            }
+            try {
+                jsonProcessor.writeValue(System.out, result);
+                System.out.println();
+            } catch (IOException e) {
+                e.printStackTrace();
+            }
+        }
     }
 
     private static String formatTimestamp(long timestamp) {