nmode's Git Repositories - signal-cli/blob - README.md

   1 # signal-cli
   2
   3 signal-cli is a commandline interface for [libsignal-service-java](https://github.com/WhisperSystems/libsignal-service-java). It supports registering, verifying, sending and receiving messages. To be able to receiving messages signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because libsignal-service-java [does not yet support registering for the websocket support](https://github.com/WhisperSystems/libsignal-service-java/pull/5) nor [provisioning as a slave device](https://github.com/WhisperSystems/libsignal-service-java/pull/21). For registering you need a phone number where you can receive SMS or incoming calls.
   4 It is primarily intended to be used on servers to notify admins of important events. For this use-case, it has a dbus interface, that can be used to send messages from any programming language that has dbus bindings.
   5
   6 ## Usage
   7
   8 usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-system] {link,addDevice,listDevices,removeDevice,register,verify,send,quitGroup,updateGroup,receive,daemon} ...
   9
  10 * Register a number (with SMS verification)
  11
  12         signal-cli -u USERNAME register
  13
  14 * Register a number (with voice verification)
  15
  16         signal-cli -u USERNAME register -v
  17
  18 * Verify the number using the code received via SMS or voice
  19
  20         signal-cli -u USERNAME verify CODE
  21
  22 * Send a message to one or more recipients
  23
  24         signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
  25
  26 * Pipe the message content from another process.
  27
  28         uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
  29
  30 * Receive messages
  31
  32         signal-cli -u USERNAME receive
  33
  34 * Groups
  35
  36  * Create a group
  37
  38           signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
  39
  40  * Update a group
  41
  42           signal-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name"
  43
  44  * Send a message to a group
  45
  46           signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
  47
  48 * Linking other devices (Provisioning)
  49
  50  * Connect to another device
  51
  52           signal-cli link -n "optional device name"
  53
  54         This shows a "tsdevice:/…" link, if you want to connect to another signal-cli instance, you can just use this link. If you want to link to and Android device, create a QR code with the link (e.g. with [qrencode](https://fukuchi.org/works/qrencode/)) and scan that in the Signal Android app.
  55
  56  * Add another device
  57
  58           signal-cli -u USERNAME addDevice --uri "tsdevice:/…"
  59
  60         The "tsdevice:/…" link is the one shown by the new signal-cli instance or contained in the QR code shown in Signal-Desktop or similar apps.
  61         Only the master device (that was registered directly, not linked) can add new devices.
  62
  63  * Manage linked devices
  64
  65           signal-cli -u USERNAME listDevices
  66
  67           signal-cli -u USERNAME removeDevice -d DEVICE_ID
  68
  69 ## DBus service
  70
  71 signal-cli can run in daemon mode and provides an experimental dbus interface.
  72 For dbus support you need jni/unix-java.so installed on your system (Debian: libunixsocket-java ArchLinux: libmatthew-unix-java (AUR)).
  73
  74 * Run in daemon mode (dbus session bus)
  75
  76           signal-cli -u USERNAME daemon
  77
  78 * Send a message via dbus
  79
  80           signal-cli --dbus send -m "Message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
  81
  82 ### System bus
  83
  84 To run on the system bus you need to take some additional steps.
  85 It’s advisable to run signal-cli as a separate unix user, the following steps assume you created a user named *signal-cli*.
  86 These steps, executed as root, should work on all distributions using systemd.
  87
  88 ```bash
  89 cp data/org.asamk.Signal.conf /etc/dbus-1/system.d/
  90 cp data/org.asamk.Signal.service /usr/share/dbus-1/system-services/
  91 cp data/signal.service /etc/systemd/system/
  92 sed -i -e "s|%dir%|<INSERT_INSTALL_PATH>|" -e "s|%number%|<INSERT_YOUR_NUMBER>|" /etc/systemd/system/signal.service
  93 systemctl daemon-reload
  94 systemctl enable signal.service
  95 systemctl reload dbus.service
  96 ```
  97
  98 Then just execute the send command from above, the service will be autostarted by dbus the first time it is requested.
  99
 100 ## Storage
 101
 102 The password and cryptographic keys are created when registering and stored in the current users home directory:
 103
 104         $HOME/.config/signal/data/
 105
 106 For legacy users, the old config directory is used as a fallback:
 107
 108         $HOME/.config/textsecure/data/
 109
 110 ## Building
 111
 112 This project uses [Gradle](http://gradle.org) for building and maintaining
 113 dependencies.
 114
 115 1. Checkout the source somewhere on your filesystem with
 116
 117         git clone https://github.com/AsamK/signal-cli.git
 118
 119 2. Execute Gradle:
 120
 121         ./gradlew build
 122
 123 3. Create shell wrapper in *build/install/signal-cli/bin*:
 124
 125         ./gradlew installDist
 126
 127 4. Create tar file in *build/distributions*:
 128
 129         ./gradlew distTar
 130
 131 ## Troubleshooting
 132 If you use a version of the Oracle JRE and get an InvalidKeyException you need to enable unlimited strength crypto. See https://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters for instructions.
 133
 134 ## License
 135
 136 This project uses libsignal-service-java from Open Whisper Systems:
 137
 138 https://github.com/WhisperSystems/libsignal-service-java
 139
 140 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html