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
.SignalServiceSyncMessage
;
32 import org
.whispersystems
.signalservice
.api
.push
.SignalServiceAddress
;
33 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.EncapsulatedExceptions
;
34 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.NetworkFailureException
;
35 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UnregisteredUserException
;
36 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
39 import java
.io
.IOException
;
40 import java
.security
.Security
;
41 import java
.util
.ArrayList
;
42 import java
.util
.List
;
46 public static final String SIGNAL_BUSNAME
= "org.asamk.Signal";
47 public static final String SIGNAL_OBJECTPATH
= "/org/asamk/Signal";
49 public static void main(String
[] args
) {
50 // Workaround for BKS truststore
51 Security
.insertProviderAt(new org
.spongycastle
.jce
.provider
.BouncyCastleProvider(), 1);
53 Namespace ns
= parseArgs(args
);
58 final String username
= ns
.getString("username");
61 DBusConnection dBusConn
= null;
63 if (ns
.getBoolean("dbus") || ns
.getBoolean("dbus_system")) {
67 if (ns
.getBoolean("dbus_system")) {
68 busType
= DBusConnection
.SYSTEM
;
70 busType
= DBusConnection
.SESSION
;
72 dBusConn
= DBusConnection
.getConnection(busType
);
73 ts
= (Signal
) dBusConn
.getRemoteObject(
74 SIGNAL_BUSNAME
, SIGNAL_OBJECTPATH
,
76 } catch (DBusException e
) {
78 if (dBusConn
!= null) {
79 dBusConn
.disconnect();
85 String settingsPath
= ns
.getString("config");
86 if (TextUtils
.isEmpty(settingsPath
)) {
87 settingsPath
= System
.getProperty("user.home") + "/.config/signal";
88 if (!new File(settingsPath
).exists()) {
89 String legacySettingsPath
= System
.getProperty("user.home") + "/.config/textsecure";
90 if (new File(legacySettingsPath
).exists()) {
91 settingsPath
= legacySettingsPath
;
96 m
= new Manager(username
, settingsPath
);
101 } catch (Exception e
) {
102 System
.err
.println("Error loading state file \"" + m
.getFileName() + "\": " + e
.getMessage());
109 switch (ns
.getString("command")) {
111 if (dBusConn
!= null) {
112 System
.err
.println("register is not yet implementd via dbus");
115 if (!m
.userHasKeys()) {
116 m
.createNewIdentity();
119 m
.register(ns
.getBoolean("voice"));
120 } catch (IOException e
) {
121 System
.err
.println("Request verify error: " + e
.getMessage());
126 if (dBusConn
!= null) {
127 System
.err
.println("verify is not yet implementd via dbus");
130 if (!m
.userHasKeys()) {
131 System
.err
.println("User has no keys, first call register.");
134 if (m
.isRegistered()) {
135 System
.err
.println("User registration is already verified");
139 m
.verifyAccount(ns
.getString("verificationCode"));
140 } catch (IOException e
) {
141 System
.err
.println("Verify error: " + e
.getMessage());
146 if (dBusConn
== null && !m
.isRegistered()) {
147 System
.err
.println("User is not registered.");
151 if (ns
.getBoolean("endsession")) {
152 if (ns
.getList("recipient") == null) {
153 System
.err
.println("No recipients given");
154 System
.err
.println("Aborting sending.");
158 ts
.sendEndSessionMessage(ns
.<String
>getList("recipient"));
159 } catch (IOException e
) {
160 handleIOException(e
);
161 } catch (EncapsulatedExceptions e
) {
162 handleEncapsulatedExceptions(e
);
163 } catch (AssertionError e
) {
164 handleAssertionError(e
);
165 } catch (DBusExecutionException e
) {
166 handleDBusExecutionException(e
);
169 String messageText
= ns
.getString("message");
170 if (messageText
== null) {
172 messageText
= IOUtils
.toString(System
.in);
173 } catch (IOException e
) {
174 System
.err
.println("Failed to read message from stdin: " + e
.getMessage());
175 System
.err
.println("Aborting sending.");
181 List
<String
> attachments
= ns
.getList("attachment");
182 if (attachments
== null) {
183 attachments
= new ArrayList
<>();
185 if (ns
.getString("group") != null) {
186 byte[] groupId
= decodeGroupId(ns
.getString("group"));
187 ts
.sendGroupMessage(messageText
, attachments
, groupId
);
189 ts
.sendMessage(messageText
, attachments
, ns
.<String
>getList("recipient"));
191 } catch (IOException e
) {
192 handleIOException(e
);
193 } catch (EncapsulatedExceptions e
) {
194 handleEncapsulatedExceptions(e
);
195 } catch (AssertionError e
) {
196 handleAssertionError(e
);
197 } catch (GroupNotFoundException e
) {
198 handleGroupNotFoundException(e
);
199 } catch (AttachmentInvalidException e
) {
200 System
.err
.println("Failed to add attachment: " + e
.getMessage());
201 System
.err
.println("Aborting sending.");
203 } catch (DBusExecutionException e
) {
204 handleDBusExecutionException(e
);
210 if (dBusConn
!= null) {
212 dBusConn
.addSigHandler(Signal
.MessageReceived
.class, new DBusSigHandler
<Signal
.MessageReceived
>() {
214 public void handle(Signal
.MessageReceived s
) {
215 System
.out
.print(String
.format("Envelope from: %s\nTimestamp: %d\nBody: %s\n",
216 s
.getSender(), s
.getTimestamp(), s
.getMessage()));
217 if (s
.getGroupId().length
> 0) {
218 System
.out
.println("Group info:");
219 System
.out
.println(" Id: " + Base64
.encodeBytes(s
.getGroupId()));
221 if (s
.getAttachments().size() > 0) {
222 System
.out
.println("Attachments: ");
223 for (String attachment
: s
.getAttachments()) {
224 System
.out
.println("- Stored plaintext in: " + attachment
);
227 System
.out
.println();
230 } catch (DBusException e
) {
236 } catch (InterruptedException e
) {
241 if (!m
.isRegistered()) {
242 System
.err
.println("User is not registered.");
246 if (ns
.getInt("timeout") != null) {
247 timeout
= ns
.getInt("timeout");
249 boolean returnOnTimeout
= true;
251 returnOnTimeout
= false;
255 m
.receiveMessages(timeout
, returnOnTimeout
, new ReceiveMessageHandler(m
));
256 } catch (IOException e
) {
257 System
.err
.println("Error while receiving messages: " + e
.getMessage());
259 } catch (AssertionError e
) {
260 handleAssertionError(e
);
264 if (dBusConn
!= null) {
265 System
.err
.println("quitGroup is not yet implementd via dbus");
268 if (!m
.isRegistered()) {
269 System
.err
.println("User is not registered.");
274 m
.sendQuitGroupMessage(decodeGroupId(ns
.getString("group")));
275 } catch (IOException e
) {
276 handleIOException(e
);
277 } catch (EncapsulatedExceptions e
) {
278 handleEncapsulatedExceptions(e
);
279 } catch (AssertionError e
) {
280 handleAssertionError(e
);
281 } catch (GroupNotFoundException e
) {
282 handleGroupNotFoundException(e
);
287 if (dBusConn
!= null) {
288 System
.err
.println("updateGroup is not yet implementd via dbus");
291 if (!m
.isRegistered()) {
292 System
.err
.println("User is not registered.");
297 byte[] groupId
= null;
298 if (ns
.getString("group") != null) {
299 groupId
= decodeGroupId(ns
.getString("group"));
301 byte[] newGroupId
= m
.sendUpdateGroupMessage(groupId
, ns
.getString("name"), ns
.<String
>getList("member"), ns
.getString("avatar"));
302 if (groupId
== null) {
303 System
.out
.println("Creating new group \"" + Base64
.encodeBytes(newGroupId
) + "\" …");
305 } catch (IOException e
) {
306 handleIOException(e
);
307 } catch (AttachmentInvalidException e
) {
308 System
.err
.println("Failed to add avatar attachment for group\": " + e
.getMessage());
309 System
.err
.println("Aborting sending.");
311 } catch (GroupNotFoundException e
) {
312 handleGroupNotFoundException(e
);
313 } catch (EncapsulatedExceptions e
) {
314 handleEncapsulatedExceptions(e
);
319 if (dBusConn
!= null) {
320 System
.err
.println("Stop it.");
323 if (!m
.isRegistered()) {
324 System
.err
.println("User is not registered.");
327 DBusConnection conn
= null;
331 if (ns
.getBoolean("system")) {
332 busType
= DBusConnection
.SYSTEM
;
334 busType
= DBusConnection
.SESSION
;
336 conn
= DBusConnection
.getConnection(busType
);
337 conn
.exportObject(SIGNAL_OBJECTPATH
, m
);
338 conn
.requestBusName(SIGNAL_BUSNAME
);
339 } catch (DBusException e
) {
344 m
.receiveMessages(3600, false, new DbusReceiveMessageHandler(m
, conn
));
345 } catch (IOException e
) {
346 System
.err
.println("Error while receiving messages: " + e
.getMessage());
348 } catch (AssertionError e
) {
349 handleAssertionError(e
);
361 if (dBusConn
!= null) {
362 dBusConn
.disconnect();
367 private static void handleGroupNotFoundException(GroupNotFoundException e
) {
368 System
.err
.println("Failed to send to group: " + e
.getMessage());
369 System
.err
.println("Aborting sending.");
373 private static void handleDBusExecutionException(DBusExecutionException e
) {
374 System
.err
.println("Cannot connect to dbus: " + e
.getMessage());
375 System
.err
.println("Aborting.");
379 private static byte[] decodeGroupId(String groupId
) {
381 return Base64
.decode(groupId
);
382 } catch (IOException e
) {
383 System
.err
.println("Failed to decode groupId (must be base64) \"" + groupId
+ "\": " + e
.getMessage());
384 System
.err
.println("Aborting sending.");
390 private static Namespace
parseArgs(String
[] args
) {
391 ArgumentParser parser
= ArgumentParsers
.newArgumentParser("signal-cli")
393 .description("Commandline interface for Signal.")
394 .version(Manager
.PROJECT_NAME
+ " " + Manager
.PROJECT_VERSION
);
396 parser
.addArgument("-v", "--version")
397 .help("Show package version.")
398 .action(Arguments
.version());
399 parser
.addArgument("--config")
400 .help("Set the path, where to store the config (Default: $HOME/.config/signal-cli).");
402 MutuallyExclusiveGroup mut
= parser
.addMutuallyExclusiveGroup();
403 mut
.addArgument("-u", "--username")
404 .help("Specify your phone number, that will be used for verification.");
405 mut
.addArgument("--dbus")
406 .help("Make request via user dbus.")
407 .action(Arguments
.storeTrue());
408 mut
.addArgument("--dbus-system")
409 .help("Make request via system dbus.")
410 .action(Arguments
.storeTrue());
412 Subparsers subparsers
= parser
.addSubparsers()
413 .title("subcommands")
415 .description("valid subcommands")
416 .help("additional help");
418 Subparser parserRegister
= subparsers
.addParser("register");
419 parserRegister
.addArgument("-v", "--voice")
420 .help("The verification should be done over voice, not sms.")
421 .action(Arguments
.storeTrue());
423 Subparser parserVerify
= subparsers
.addParser("verify");
424 parserVerify
.addArgument("verificationCode")
425 .help("The verification code you received via sms or voice call.");
427 Subparser parserSend
= subparsers
.addParser("send");
428 parserSend
.addArgument("-g", "--group")
429 .help("Specify the recipient group ID.");
430 parserSend
.addArgument("recipient")
431 .help("Specify the recipients' phone number.")
433 parserSend
.addArgument("-m", "--message")
434 .help("Specify the message, if missing standard input is used.");
435 parserSend
.addArgument("-a", "--attachment")
437 .help("Add file as attachment");
438 parserSend
.addArgument("-e", "--endsession")
439 .help("Clear session state and send end session message.")
440 .action(Arguments
.storeTrue());
442 Subparser parserLeaveGroup
= subparsers
.addParser("quitGroup");
443 parserLeaveGroup
.addArgument("-g", "--group")
445 .help("Specify the recipient group ID.");
447 Subparser parserUpdateGroup
= subparsers
.addParser("updateGroup");
448 parserUpdateGroup
.addArgument("-g", "--group")
449 .help("Specify the recipient group ID.");
450 parserUpdateGroup
.addArgument("-n", "--name")
451 .help("Specify the new group name.");
452 parserUpdateGroup
.addArgument("-a", "--avatar")
453 .help("Specify a new group avatar image file");
454 parserUpdateGroup
.addArgument("-m", "--member")
456 .help("Specify one or more members to add to the group");
458 Subparser parserReceive
= subparsers
.addParser("receive");
459 parserReceive
.addArgument("-t", "--timeout")
461 .help("Number of seconds to wait for new messages (negative values disable timeout)");
463 Subparser parserDaemon
= subparsers
.addParser("daemon");
464 parserDaemon
.addArgument("--system")
465 .action(Arguments
.storeTrue())
466 .help("Use DBus system bus instead of user bus.");
469 Namespace ns
= parser
.parseArgs(args
);
470 if (!ns
.getBoolean("dbus") && !ns
.getBoolean("dbus_system")) {
471 if (ns
.getString("username") == null) {
473 System
.err
.println("You need to specify a username (phone number)");
476 if (!PhoneNumberFormatter
.isValidNumber(ns
.getString("username"))) {
477 System
.err
.println("Invalid username (phone number), make sure you include the country code.");
481 if (ns
.getList("recipient") != null && !ns
.getList("recipient").isEmpty() && ns
.getString("group") != null) {
482 System
.err
.println("You cannot specify recipients by phone number and groups a the same time");
486 } catch (ArgumentParserException e
) {
487 parser
.handleError(e
);
492 private static void handleAssertionError(AssertionError e
) {
493 System
.err
.println("Failed to send/receive message (Assertion): " + e
.getMessage());
495 System
.err
.println("If you use an Oracle JRE please check if you have unlimited strength crypto enabled, see README");
499 private static void handleEncapsulatedExceptions(EncapsulatedExceptions e
) {
500 System
.err
.println("Failed to send (some) messages:");
501 for (NetworkFailureException n
: e
.getNetworkExceptions()) {
502 System
.err
.println("Network failure for \"" + n
.getE164number() + "\": " + n
.getMessage());
504 for (UnregisteredUserException n
: e
.getUnregisteredUserExceptions()) {
505 System
.err
.println("Unregistered user \"" + n
.getE164Number() + "\": " + n
.getMessage());
507 for (UntrustedIdentityException n
: e
.getUntrustedIdentityExceptions()) {
508 System
.err
.println("Untrusted Identity for \"" + n
.getE164Number() + "\": " + n
.getMessage());
512 private static void handleIOException(IOException e
) {
513 System
.err
.println("Failed to send message: " + e
.getMessage());
516 private static class ReceiveMessageHandler
implements Manager
.ReceiveMessageHandler
{
519 public ReceiveMessageHandler(Manager m
) {
524 public void handleMessage(SignalServiceEnvelope envelope
, SignalServiceContent content
, GroupInfo group
) {
525 SignalServiceAddress source
= envelope
.getSourceAddress();
526 System
.out
.println(String
.format("Envelope from: %s (device: %d)", source
.getNumber(), envelope
.getSourceDevice()));
527 if (source
.getRelay().isPresent()) {
528 System
.out
.println("Relayed by: " + source
.getRelay().get());
530 System
.out
.println("Timestamp: " + envelope
.getTimestamp());
532 if (envelope
.isReceipt()) {
533 System
.out
.println("Got receipt.");
534 } else if (envelope
.isSignalMessage() | envelope
.isPreKeySignalMessage()) {
535 if (content
== null) {
536 System
.out
.println("Failed to decrypt message.");
538 if (content
.getDataMessage().isPresent()) {
539 SignalServiceDataMessage message
= content
.getDataMessage().get();
541 System
.out
.println("Message timestamp: " + message
.getTimestamp());
543 if (message
.getBody().isPresent()) {
544 System
.out
.println("Body: " + message
.getBody().get());
546 if (message
.getGroupInfo().isPresent()) {
547 SignalServiceGroup groupInfo
= message
.getGroupInfo().get();
548 System
.out
.println("Group info:");
549 System
.out
.println(" Id: " + Base64
.encodeBytes(groupInfo
.getGroupId()));
550 if (groupInfo
.getName().isPresent()) {
551 System
.out
.println(" Name: " + groupInfo
.getName().get());
552 } else if (group
!= null) {
553 System
.out
.println(" Name: " + group
.name
);
555 System
.out
.println(" Name: <Unknown group>");
557 System
.out
.println(" Type: " + groupInfo
.getType());
558 if (groupInfo
.getMembers().isPresent()) {
559 for (String member
: groupInfo
.getMembers().get()) {
560 System
.out
.println(" Member: " + member
);
563 if (groupInfo
.getAvatar().isPresent()) {
564 System
.out
.println(" Avatar:");
565 printAttachment(groupInfo
.getAvatar().get());
568 if (message
.isEndSession()) {
569 System
.out
.println("Is end session");
572 if (message
.getAttachments().isPresent()) {
573 System
.out
.println("Attachments: ");
574 for (SignalServiceAttachment attachment
: message
.getAttachments().get()) {
575 printAttachment(attachment
);
579 if (content
.getSyncMessage().isPresent()) {
580 SignalServiceSyncMessage syncMessage
= content
.getSyncMessage().get();
581 System
.out
.println("Received sync message");
585 System
.out
.println("Unknown message received.");
587 System
.out
.println();
590 private void printAttachment(SignalServiceAttachment attachment
) {
591 System
.out
.println("- " + attachment
.getContentType() + " (" + (attachment
.isPointer() ?
"Pointer" : "") + (attachment
.isStream() ?
"Stream" : "") + ")");
592 if (attachment
.isPointer()) {
593 final SignalServiceAttachmentPointer pointer
= attachment
.asPointer();
594 System
.out
.println(" Id: " + pointer
.getId() + " Key length: " + pointer
.getKey().length
+ (pointer
.getRelay().isPresent() ?
" Relay: " + pointer
.getRelay().get() : ""));
595 System
.out
.println(" Size: " + (pointer
.getSize().isPresent() ? pointer
.getSize().get() + " bytes" : "<unavailable>") + (pointer
.getPreview().isPresent() ?
" (Preview is available: " + pointer
.getPreview().get().length
+ " bytes)" : ""));
596 File file
= m
.getAttachmentFile(pointer
.getId());
598 System
.out
.println(" Stored plaintext in: " + file
);
604 private static class DbusReceiveMessageHandler
extends ReceiveMessageHandler
{
605 final DBusConnection conn
;
607 public DbusReceiveMessageHandler(Manager m
, DBusConnection conn
) {
613 public void handleMessage(SignalServiceEnvelope envelope
, SignalServiceContent content
, GroupInfo group
) {
614 super.handleMessage(envelope
, content
, group
);
616 if (!envelope
.isReceipt() && content
!= null && content
.getDataMessage().isPresent()) {
617 SignalServiceDataMessage message
= content
.getDataMessage().get();
619 if (!message
.isEndSession() &&
620 !(message
.getGroupInfo().isPresent() &&
621 message
.getGroupInfo().get().getType() != SignalServiceGroup
.Type
.DELIVER
)) {
622 List
<String
> attachments
= new ArrayList
<>();
623 if (message
.getAttachments().isPresent()) {
624 for (SignalServiceAttachment attachment
: message
.getAttachments().get()) {
625 if (attachment
.isPointer()) {
626 attachments
.add(m
.getAttachmentFile(attachment
.asPointer().getId()).getAbsolutePath());
632 conn
.sendSignal(new Signal
.MessageReceived(
634 message
.getTimestamp(),
635 envelope
.getSource(),
636 message
.getGroupInfo().isPresent() ? message
.getGroupInfo().get().getGroupId() : new byte[0],
637 message
.getBody().isPresent() ? message
.getBody().get() : "",
639 } catch (DBusException e
) {
646 private void printAttachment(SignalServiceAttachment attachment
) {
647 System
.out
.println("- " + attachment
.getContentType() + " (" + (attachment
.isPointer() ?
"Pointer" : "") + (attachment
.isStream() ?
"Stream" : "") + ")");
648 if (attachment
.isPointer()) {
649 final SignalServiceAttachmentPointer pointer
= attachment
.asPointer();
650 System
.out
.println(" Id: " + pointer
.getId() + " Key length: " + pointer
.getKey().length
+ (pointer
.getRelay().isPresent() ?
" Relay: " + pointer
.getRelay().get() : ""));
651 System
.out
.println(" Size: " + (pointer
.getSize().isPresent() ? pointer
.getSize().get() + " bytes" : "<unavailable>") + (pointer
.getPreview().isPresent() ?
" (Preview is available: " + pointer
.getPreview().get().length
+ " bytes)" : ""));
652 File file
= m
.getAttachmentFile(pointer
.getId());
654 System
.out
.println(" Stored plaintext in: " + file
);