2 * Copyright (C) 2015 AsamK
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org
.asamk
.signal
;
19 import net
.sourceforge
.argparse4j
.ArgumentParsers
;
20 import net
.sourceforge
.argparse4j
.impl
.Arguments
;
21 import net
.sourceforge
.argparse4j
.inf
.*;
22 import org
.apache
.commons
.io
.IOUtils
;
23 import org
.apache
.http
.util
.TextUtils
;
24 import org
.asamk
.Signal
;
25 import org
.freedesktop
.dbus
.DBusConnection
;
26 import org
.freedesktop
.dbus
.DBusSigHandler
;
27 import org
.freedesktop
.dbus
.exceptions
.DBusException
;
28 import org
.freedesktop
.dbus
.exceptions
.DBusExecutionException
;
29 import org
.whispersystems
.signalservice
.api
.crypto
.UntrustedIdentityException
;
30 import org
.whispersystems
.signalservice
.api
.messages
.*;
31 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.ReadMessage
;
32 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.SentTranscriptMessage
;
33 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.SignalServiceSyncMessage
;
34 import org
.whispersystems
.signalservice
.api
.push
.SignalServiceAddress
;
35 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.EncapsulatedExceptions
;
36 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.NetworkFailureException
;
37 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UnregisteredUserException
;
38 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
41 import java
.io
.IOException
;
42 import java
.security
.Security
;
43 import java
.util
.ArrayList
;
44 import java
.util
.List
;
48 public static final String SIGNAL_BUSNAME
= "org.asamk.Signal";
49 public static final String SIGNAL_OBJECTPATH
= "/org/asamk/Signal";
51 public static void main(String
[] args
) {
52 // Workaround for BKS truststore
53 Security
.insertProviderAt(new org
.bouncycastle
.jce
.provider
.BouncyCastleProvider(), 1);
55 Namespace ns
= parseArgs(args
);
60 final String username
= ns
.getString("username");
63 DBusConnection dBusConn
= null;
65 if (ns
.getBoolean("dbus") || ns
.getBoolean("dbus_system")) {
69 if (ns
.getBoolean("dbus_system")) {
70 busType
= DBusConnection
.SYSTEM
;
72 busType
= DBusConnection
.SESSION
;
74 dBusConn
= DBusConnection
.getConnection(busType
);
75 ts
= (Signal
) dBusConn
.getRemoteObject(
76 SIGNAL_BUSNAME
, SIGNAL_OBJECTPATH
,
78 } catch (DBusException e
) {
80 if (dBusConn
!= null) {
81 dBusConn
.disconnect();
87 String settingsPath
= ns
.getString("config");
88 if (TextUtils
.isEmpty(settingsPath
)) {
89 settingsPath
= System
.getProperty("user.home") + "/.config/signal";
90 if (!new File(settingsPath
).exists()) {
91 String legacySettingsPath
= System
.getProperty("user.home") + "/.config/textsecure";
92 if (new File(legacySettingsPath
).exists()) {
93 settingsPath
= legacySettingsPath
;
98 m
= new Manager(username
, settingsPath
);
100 if (m
.userExists()) {
103 } catch (Exception e
) {
104 System
.err
.println("Error loading state file \"" + m
.getFileName() + "\": " + e
.getMessage());
111 switch (ns
.getString("command")) {
113 if (dBusConn
!= null) {
114 System
.err
.println("register is not yet implemented via dbus");
117 if (!m
.userHasKeys()) {
118 m
.createNewIdentity();
121 m
.register(ns
.getBoolean("voice"));
122 } catch (IOException e
) {
123 System
.err
.println("Request verify error: " + e
.getMessage());
128 if (dBusConn
!= null) {
129 System
.err
.println("verify is not yet implemented via dbus");
132 if (!m
.userHasKeys()) {
133 System
.err
.println("User has no keys, first call register.");
136 if (m
.isRegistered()) {
137 System
.err
.println("User registration is already verified");
141 m
.verifyAccount(ns
.getString("verificationCode"));
142 } catch (IOException e
) {
143 System
.err
.println("Verify error: " + e
.getMessage());
148 if (dBusConn
== null && !m
.isRegistered()) {
149 System
.err
.println("User is not registered.");
153 if (ns
.getBoolean("endsession")) {
154 if (ns
.getList("recipient") == null) {
155 System
.err
.println("No recipients given");
156 System
.err
.println("Aborting sending.");
160 ts
.sendEndSessionMessage(ns
.<String
>getList("recipient"));
161 } catch (IOException e
) {
162 handleIOException(e
);
163 } catch (EncapsulatedExceptions e
) {
164 handleEncapsulatedExceptions(e
);
165 } catch (AssertionError e
) {
166 handleAssertionError(e
);
167 } catch (DBusExecutionException e
) {
168 handleDBusExecutionException(e
);
171 String messageText
= ns
.getString("message");
172 if (messageText
== null) {
174 messageText
= IOUtils
.toString(System
.in);
175 } catch (IOException e
) {
176 System
.err
.println("Failed to read message from stdin: " + e
.getMessage());
177 System
.err
.println("Aborting sending.");
183 List
<String
> attachments
= ns
.getList("attachment");
184 if (attachments
== null) {
185 attachments
= new ArrayList
<>();
187 if (ns
.getString("group") != null) {
188 byte[] groupId
= decodeGroupId(ns
.getString("group"));
189 ts
.sendGroupMessage(messageText
, attachments
, groupId
);
191 ts
.sendMessage(messageText
, attachments
, ns
.<String
>getList("recipient"));
193 } catch (IOException e
) {
194 handleIOException(e
);
195 } catch (EncapsulatedExceptions e
) {
196 handleEncapsulatedExceptions(e
);
197 } catch (AssertionError e
) {
198 handleAssertionError(e
);
199 } catch (GroupNotFoundException e
) {
200 handleGroupNotFoundException(e
);
201 } catch (AttachmentInvalidException e
) {
202 System
.err
.println("Failed to add attachment: " + e
.getMessage());
203 System
.err
.println("Aborting sending.");
205 } catch (DBusExecutionException e
) {
206 handleDBusExecutionException(e
);
212 if (dBusConn
!= null) {
214 dBusConn
.addSigHandler(Signal
.MessageReceived
.class, new DBusSigHandler
<Signal
.MessageReceived
>() {
216 public void handle(Signal
.MessageReceived s
) {
217 System
.out
.print(String
.format("Envelope from: %s\nTimestamp: %d\nBody: %s\n",
218 s
.getSender(), s
.getTimestamp(), s
.getMessage()));
219 if (s
.getGroupId().length
> 0) {
220 System
.out
.println("Group info:");
221 System
.out
.println(" Id: " + Base64
.encodeBytes(s
.getGroupId()));
223 if (s
.getAttachments().size() > 0) {
224 System
.out
.println("Attachments: ");
225 for (String attachment
: s
.getAttachments()) {
226 System
.out
.println("- Stored plaintext in: " + attachment
);
229 System
.out
.println();
232 } catch (DBusException e
) {
238 } catch (InterruptedException e
) {
243 if (!m
.isRegistered()) {
244 System
.err
.println("User is not registered.");
248 if (ns
.getInt("timeout") != null) {
249 timeout
= ns
.getInt("timeout");
251 boolean returnOnTimeout
= true;
253 returnOnTimeout
= false;
257 m
.receiveMessages(timeout
, returnOnTimeout
, new ReceiveMessageHandler(m
));
258 } catch (IOException e
) {
259 System
.err
.println("Error while receiving messages: " + e
.getMessage());
261 } catch (AssertionError e
) {
262 handleAssertionError(e
);
266 if (dBusConn
!= null) {
267 System
.err
.println("quitGroup is not yet implemented via dbus");
270 if (!m
.isRegistered()) {
271 System
.err
.println("User is not registered.");
276 m
.sendQuitGroupMessage(decodeGroupId(ns
.getString("group")));
277 } catch (IOException e
) {
278 handleIOException(e
);
279 } catch (EncapsulatedExceptions e
) {
280 handleEncapsulatedExceptions(e
);
281 } catch (AssertionError e
) {
282 handleAssertionError(e
);
283 } catch (GroupNotFoundException e
) {
284 handleGroupNotFoundException(e
);
289 if (dBusConn
!= null) {
290 System
.err
.println("updateGroup is not yet implemented via dbus");
293 if (!m
.isRegistered()) {
294 System
.err
.println("User is not registered.");
299 byte[] groupId
= null;
300 if (ns
.getString("group") != null) {
301 groupId
= decodeGroupId(ns
.getString("group"));
303 byte[] newGroupId
= m
.sendUpdateGroupMessage(groupId
, ns
.getString("name"), ns
.<String
>getList("member"), ns
.getString("avatar"));
304 if (groupId
== null) {
305 System
.out
.println("Creating new group \"" + Base64
.encodeBytes(newGroupId
) + "\" …");
307 } catch (IOException e
) {
308 handleIOException(e
);
309 } catch (AttachmentInvalidException e
) {
310 System
.err
.println("Failed to add avatar attachment for group\": " + e
.getMessage());
311 System
.err
.println("Aborting sending.");
313 } catch (GroupNotFoundException e
) {
314 handleGroupNotFoundException(e
);
315 } catch (EncapsulatedExceptions e
) {
316 handleEncapsulatedExceptions(e
);
321 if (dBusConn
!= null) {
322 System
.err
.println("Stop it.");
325 if (!m
.isRegistered()) {
326 System
.err
.println("User is not registered.");
329 DBusConnection conn
= null;
333 if (ns
.getBoolean("system")) {
334 busType
= DBusConnection
.SYSTEM
;
336 busType
= DBusConnection
.SESSION
;
338 conn
= DBusConnection
.getConnection(busType
);
339 conn
.exportObject(SIGNAL_OBJECTPATH
, m
);
340 conn
.requestBusName(SIGNAL_BUSNAME
);
341 } catch (DBusException e
) {
346 m
.receiveMessages(3600, false, new DbusReceiveMessageHandler(m
, conn
));
347 } catch (IOException e
) {
348 System
.err
.println("Error while receiving messages: " + e
.getMessage());
350 } catch (AssertionError e
) {
351 handleAssertionError(e
);
363 if (dBusConn
!= null) {
364 dBusConn
.disconnect();
369 private static void handleGroupNotFoundException(GroupNotFoundException e
) {
370 System
.err
.println("Failed to send to group: " + e
.getMessage());
371 System
.err
.println("Aborting sending.");
375 private static void handleDBusExecutionException(DBusExecutionException e
) {
376 System
.err
.println("Cannot connect to dbus: " + e
.getMessage());
377 System
.err
.println("Aborting.");
381 private static byte[] decodeGroupId(String groupId
) {
383 return Base64
.decode(groupId
);
384 } catch (IOException e
) {
385 System
.err
.println("Failed to decode groupId (must be base64) \"" + groupId
+ "\": " + e
.getMessage());
386 System
.err
.println("Aborting sending.");
392 private static Namespace
parseArgs(String
[] args
) {
393 ArgumentParser parser
= ArgumentParsers
.newArgumentParser("signal-cli")
395 .description("Commandline interface for Signal.")
396 .version(Manager
.PROJECT_NAME
+ " " + Manager
.PROJECT_VERSION
);
398 parser
.addArgument("-v", "--version")
399 .help("Show package version.")
400 .action(Arguments
.version());
401 parser
.addArgument("--config")
402 .help("Set the path, where to store the config (Default: $HOME/.config/signal-cli).");
404 MutuallyExclusiveGroup mut
= parser
.addMutuallyExclusiveGroup();
405 mut
.addArgument("-u", "--username")
406 .help("Specify your phone number, that will be used for verification.");
407 mut
.addArgument("--dbus")
408 .help("Make request via user dbus.")
409 .action(Arguments
.storeTrue());
410 mut
.addArgument("--dbus-system")
411 .help("Make request via system dbus.")
412 .action(Arguments
.storeTrue());
414 Subparsers subparsers
= parser
.addSubparsers()
415 .title("subcommands")
417 .description("valid subcommands")
418 .help("additional help");
420 Subparser parserRegister
= subparsers
.addParser("register");
421 parserRegister
.addArgument("-v", "--voice")
422 .help("The verification should be done over voice, not sms.")
423 .action(Arguments
.storeTrue());
425 Subparser parserVerify
= subparsers
.addParser("verify");
426 parserVerify
.addArgument("verificationCode")
427 .help("The verification code you received via sms or voice call.");
429 Subparser parserSend
= subparsers
.addParser("send");
430 parserSend
.addArgument("-g", "--group")
431 .help("Specify the recipient group ID.");
432 parserSend
.addArgument("recipient")
433 .help("Specify the recipients' phone number.")
435 parserSend
.addArgument("-m", "--message")
436 .help("Specify the message, if missing standard input is used.");
437 parserSend
.addArgument("-a", "--attachment")
439 .help("Add file as attachment");
440 parserSend
.addArgument("-e", "--endsession")
441 .help("Clear session state and send end session message.")
442 .action(Arguments
.storeTrue());
444 Subparser parserLeaveGroup
= subparsers
.addParser("quitGroup");
445 parserLeaveGroup
.addArgument("-g", "--group")
447 .help("Specify the recipient group ID.");
449 Subparser parserUpdateGroup
= subparsers
.addParser("updateGroup");
450 parserUpdateGroup
.addArgument("-g", "--group")
451 .help("Specify the recipient group ID.");
452 parserUpdateGroup
.addArgument("-n", "--name")
453 .help("Specify the new group name.");
454 parserUpdateGroup
.addArgument("-a", "--avatar")
455 .help("Specify a new group avatar image file");
456 parserUpdateGroup
.addArgument("-m", "--member")
458 .help("Specify one or more members to add to the group");
460 Subparser parserReceive
= subparsers
.addParser("receive");
461 parserReceive
.addArgument("-t", "--timeout")
463 .help("Number of seconds to wait for new messages (negative values disable timeout)");
465 Subparser parserDaemon
= subparsers
.addParser("daemon");
466 parserDaemon
.addArgument("--system")
467 .action(Arguments
.storeTrue())
468 .help("Use DBus system bus instead of user bus.");
471 Namespace ns
= parser
.parseArgs(args
);
472 if (!ns
.getBoolean("dbus") && !ns
.getBoolean("dbus_system")) {
473 if (ns
.getString("username") == null) {
475 System
.err
.println("You need to specify a username (phone number)");
478 if (!PhoneNumberFormatter
.isValidNumber(ns
.getString("username"))) {
479 System
.err
.println("Invalid username (phone number), make sure you include the country code.");
483 if (ns
.getList("recipient") != null && !ns
.getList("recipient").isEmpty() && ns
.getString("group") != null) {
484 System
.err
.println("You cannot specify recipients by phone number and groups a the same time");
488 } catch (ArgumentParserException e
) {
489 parser
.handleError(e
);
494 private static void handleAssertionError(AssertionError e
) {
495 System
.err
.println("Failed to send/receive message (Assertion): " + e
.getMessage());
497 System
.err
.println("If you use an Oracle JRE please check if you have unlimited strength crypto enabled, see README");
501 private static void handleEncapsulatedExceptions(EncapsulatedExceptions e
) {
502 System
.err
.println("Failed to send (some) messages:");
503 for (NetworkFailureException n
: e
.getNetworkExceptions()) {
504 System
.err
.println("Network failure for \"" + n
.getE164number() + "\": " + n
.getMessage());
506 for (UnregisteredUserException n
: e
.getUnregisteredUserExceptions()) {
507 System
.err
.println("Unregistered user \"" + n
.getE164Number() + "\": " + n
.getMessage());
509 for (UntrustedIdentityException n
: e
.getUntrustedIdentityExceptions()) {
510 System
.err
.println("Untrusted Identity for \"" + n
.getE164Number() + "\": " + n
.getMessage());
514 private static void handleIOException(IOException e
) {
515 System
.err
.println("Failed to send message: " + e
.getMessage());
518 private static class ReceiveMessageHandler
implements Manager
.ReceiveMessageHandler
{
521 public ReceiveMessageHandler(Manager m
) {
526 public void handleMessage(SignalServiceEnvelope envelope
, SignalServiceContent content
, GroupInfo group
) {
527 SignalServiceAddress source
= envelope
.getSourceAddress();
528 System
.out
.println(String
.format("Envelope from: %s (device: %d)", source
.getNumber(), envelope
.getSourceDevice()));
529 if (source
.getRelay().isPresent()) {
530 System
.out
.println("Relayed by: " + source
.getRelay().get());
532 System
.out
.println("Timestamp: " + envelope
.getTimestamp());
534 if (envelope
.isReceipt()) {
535 System
.out
.println("Got receipt.");
536 } else if (envelope
.isSignalMessage() | envelope
.isPreKeySignalMessage()) {
537 if (content
== null) {
538 System
.out
.println("Failed to decrypt message.");
540 if (content
.getDataMessage().isPresent()) {
541 SignalServiceDataMessage message
= content
.getDataMessage().get();
542 handleSignalServiceDataMessage(message
, group
);
544 if (content
.getSyncMessage().isPresent()) {
545 SignalServiceSyncMessage syncMessage
= content
.getSyncMessage().get();
547 if (syncMessage
.getContacts().isPresent()) {
548 System
.out
.println("Received sync contacts");
549 printAttachment(syncMessage
.getContacts().get());
551 if (syncMessage
.getGroups().isPresent()) {
552 System
.out
.println("Received sync groups");
553 printAttachment(syncMessage
.getGroups().get());
555 if (syncMessage
.getRead().isPresent()) {
556 System
.out
.println("Received sync read messages list");
557 for (ReadMessage rm
: syncMessage
.getRead().get()) {
558 System
.out
.println("From: " + rm
.getSender() + " Message timestamp: " + rm
.getTimestamp());
561 if (syncMessage
.getRequest().isPresent()) {
562 System
.out
.println("Received sync request");
563 if (syncMessage
.getRequest().get().isContactsRequest()) {
564 System
.out
.println(" - contacts request");
566 if (syncMessage
.getRequest().get().isGroupsRequest()) {
567 System
.out
.println(" - groups request");
570 if (syncMessage
.getSent().isPresent()) {
571 System
.out
.println("Received sync sent message");
572 final SentTranscriptMessage sentTranscriptMessage
= syncMessage
.getSent().get();
573 System
.out
.println("To: " + (sentTranscriptMessage
.getDestination().isPresent() ? sentTranscriptMessage
.getDestination().get() : "Unknown") + " , Message timestamp: " + sentTranscriptMessage
.getTimestamp());
574 SignalServiceDataMessage message
= sentTranscriptMessage
.getMessage();
575 handleSignalServiceDataMessage(message
, null);
580 System
.out
.println("Unknown message received.");
582 System
.out
.println();
585 // TODO remove group parameter
586 private void handleSignalServiceDataMessage(SignalServiceDataMessage message
, GroupInfo group
) {
587 System
.out
.println("Message timestamp: " + message
.getTimestamp());
589 if (message
.getBody().isPresent()) {
590 System
.out
.println("Body: " + message
.getBody().get());
592 if (message
.getGroupInfo().isPresent()) {
593 SignalServiceGroup groupInfo
= message
.getGroupInfo().get();
594 System
.out
.println("Group info:");
595 System
.out
.println(" Id: " + Base64
.encodeBytes(groupInfo
.getGroupId()));
596 if (groupInfo
.getName().isPresent()) {
597 System
.out
.println(" Name: " + groupInfo
.getName().get());
598 } else if (group
!= null) {
599 System
.out
.println(" Name: " + group
.name
);
601 System
.out
.println(" Name: <Unknown group>");
603 System
.out
.println(" Type: " + groupInfo
.getType());
604 if (groupInfo
.getMembers().isPresent()) {
605 for (String member
: groupInfo
.getMembers().get()) {
606 System
.out
.println(" Member: " + member
);
609 if (groupInfo
.getAvatar().isPresent()) {
610 System
.out
.println(" Avatar:");
611 printAttachment(groupInfo
.getAvatar().get());
614 if (message
.isEndSession()) {
615 System
.out
.println("Is end session");
618 if (message
.getAttachments().isPresent()) {
619 System
.out
.println("Attachments: ");
620 for (SignalServiceAttachment attachment
: message
.getAttachments().get()) {
621 printAttachment(attachment
);
626 private void printAttachment(SignalServiceAttachment attachment
) {
627 System
.out
.println("- " + attachment
.getContentType() + " (" + (attachment
.isPointer() ?
"Pointer" : "") + (attachment
.isStream() ?
"Stream" : "") + ")");
628 if (attachment
.isPointer()) {
629 final SignalServiceAttachmentPointer pointer
= attachment
.asPointer();
630 System
.out
.println(" Id: " + pointer
.getId() + " Key length: " + pointer
.getKey().length
+ (pointer
.getRelay().isPresent() ?
" Relay: " + pointer
.getRelay().get() : ""));
631 System
.out
.println(" Size: " + (pointer
.getSize().isPresent() ? pointer
.getSize().get() + " bytes" : "<unavailable>") + (pointer
.getPreview().isPresent() ?
" (Preview is available: " + pointer
.getPreview().get().length
+ " bytes)" : ""));
632 File file
= m
.getAttachmentFile(pointer
.getId());
634 System
.out
.println(" Stored plaintext in: " + file
);
640 private static class DbusReceiveMessageHandler
extends ReceiveMessageHandler
{
641 final DBusConnection conn
;
643 public DbusReceiveMessageHandler(Manager m
, DBusConnection conn
) {
649 public void handleMessage(SignalServiceEnvelope envelope
, SignalServiceContent content
, GroupInfo group
) {
650 super.handleMessage(envelope
, content
, group
);
652 if (!envelope
.isReceipt() && content
!= null && content
.getDataMessage().isPresent()) {
653 SignalServiceDataMessage message
= content
.getDataMessage().get();
655 if (!message
.isEndSession() &&
656 !(message
.getGroupInfo().isPresent() &&
657 message
.getGroupInfo().get().getType() != SignalServiceGroup
.Type
.DELIVER
)) {
658 List
<String
> attachments
= new ArrayList
<>();
659 if (message
.getAttachments().isPresent()) {
660 for (SignalServiceAttachment attachment
: message
.getAttachments().get()) {
661 if (attachment
.isPointer()) {
662 attachments
.add(m
.getAttachmentFile(attachment
.asPointer().getId()).getAbsolutePath());
668 conn
.sendSignal(new Signal
.MessageReceived(
670 message
.getTimestamp(),
671 envelope
.getSource(),
672 message
.getGroupInfo().isPresent() ? message
.getGroupInfo().get().getGroupId() : new byte[0],
673 message
.getBody().isPresent() ? message
.getBody().get() : "",
675 } catch (DBusException e
) {
682 private void printAttachment(SignalServiceAttachment attachment
) {
683 System
.out
.println("- " + attachment
.getContentType() + " (" + (attachment
.isPointer() ?
"Pointer" : "") + (attachment
.isStream() ?
"Stream" : "") + ")");
684 if (attachment
.isPointer()) {
685 final SignalServiceAttachmentPointer pointer
= attachment
.asPointer();
686 System
.out
.println(" Id: " + pointer
.getId() + " Key length: " + pointer
.getKey().length
+ (pointer
.getRelay().isPresent() ?
" Relay: " + pointer
.getRelay().get() : ""));
687 System
.out
.println(" Size: " + (pointer
.getSize().isPresent() ? pointer
.getSize().get() + " bytes" : "<unavailable>") + (pointer
.getPreview().isPresent() ?
" (Preview is available: " + pointer
.getPreview().get().length
+ " bytes)" : ""));
688 File file
= m
.getAttachmentFile(pointer
.getId());
690 System
.out
.println(" Stored plaintext in: " + file
);