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 receive 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 ## Installation
   7
   8 You can [build signal-cli](#building) yourself, or use the [provided binary files](https://github.com/AsamK/signal-cli/releases/latest), which should work on Linux, macOS and Windows. For Arch Linux there is also a [package in AUR](https://aur.archlinux.org/packages/signal-cli/). You need to have at least JRE 7 installed, to run signal-cli.
   9
  10 ### Install system-wide on Linux
  11 See [latest version](https://github.com/AsamK/signal-cli/releases).
  12 ```sh
  13 export VERSION=<latest version, format "x.y.z">
  14 wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz
  15 sudo tar xf signal-cli-"${VERSION}".tar.gz -C /opt
  16 sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
  17 ```
  18
  19 ## Usage
  20
  21 usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-system] {link,addDevice,listDevices,removeDevice,register,verify,send,quitGroup,updateGroup,listIdentities,trust,receive,daemon} ...
  22
  23 See also: [man page in asciidoc format](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli.1.adoc)
  24
  25 The USERNAME (your phone number) must include the country calling code, i.e. the number must start with a "+" sign. (See [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes) for a list of all country codes.
  26
  27 * Register a number (with SMS verification)
  28
  29         signal-cli -u USERNAME register
  30
  31 * Register a number (with voice verification)
  32
  33         signal-cli -u USERNAME register -v
  34
  35 * Verify the number using the code received via SMS or voice
  36
  37         signal-cli -u USERNAME verify CODE
  38
  39 * Send a message to one or more recipients
  40
  41         signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
  42
  43 * Pipe the message content from another process.
  44
  45         uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
  46
  47 * Receive messages
  48
  49         signal-cli -u USERNAME receive
  50
  51 * Groups
  52
  53  * Create a group
  54
  55           signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
  56
  57  * Update a group
  58
  59           signal-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name" -a "AVATAR_IMAGE_FILE"
  60
  61  * Add member to a group
  62
  63           signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
  64
  65  * Leave a group
  66
  67           signal-cli -u USERNAME quitGroup -g GROUP_ID
  68
  69  * Send a message to a group
  70
  71           signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
  72
  73 * Linking other devices (Provisioning)
  74
  75  * Connect to another device
  76
  77           signal-cli link -n "optional device name"
  78
  79         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.
  80
  81  * Add another device
  82
  83           signal-cli -u USERNAME addDevice --uri "tsdevice:/…"
  84
  85         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.
  86         Only the master device (that was registered directly, not linked) can add new devices.
  87
  88  * Manage linked devices
  89
  90           signal-cli -u USERNAME listDevices
  91
  92           signal-cli -u USERNAME removeDevice -d DEVICE_ID
  93
  94 * Manage trusted keys
  95
  96  * View all known keys
  97
  98           signal-cli -u USERNAME listIdentities
  99
 100  * View known keys of one number
 101
 102           signal-cli -u USERNAME listIdentities -n NUMBER
 103
 104  * Trust new key, after having verified it
 105
 106           signal-cli -u USERNAME trust -v FINGER_PRINT NUMBER
 107
 108  * Trust new key, without having verified it. Only use this if you don't care about security
 109
 110           signal-cli -u USERNAME trust -a NUMBER
 111
 112 * Set configuration directory
 113
 114           signal-cli --config=/home/other_user/.config/signal
 115
 116       This is particularily useful in the case, when you would like to run the signal-cli tool as a different user as the one, that was used to register the account. You should make sure, that the caller has full read/write access to the given directory.
 117
 118 ## DBus service
 119
 120 signal-cli can run in daemon mode and provides an experimental dbus interface.
 121 For dbus support you need jni/unix-java.so installed on your system (Debian: libunixsocket-java ArchLinux: libmatthew-unix-java (AUR)).
 122
 123 * Run in daemon mode (dbus session bus)
 124
 125           signal-cli -u USERNAME daemon
 126
 127 * Send a message via dbus
 128
 129           signal-cli --dbus send -m "Message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 130
 131 ### System bus
 132
 133 To run on the system bus you need to take some additional steps.
 134 It’s advisable to run signal-cli as a separate unix user, the following steps assume you created a user named *signal-cli*.
 135 These steps, executed as root, should work on all distributions using systemd.
 136
 137 Mind the fact that signal.service executes the signal-cli with "--config /var/lib/signal-cli".
 138 If you registered with user signal-cli, remove the config option.
 139
 140 ```bash
 141 cp data/org.asamk.Signal.conf /etc/dbus-1/system.d/
 142 cp data/org.asamk.Signal.service /usr/share/dbus-1/system-services/
 143 cp data/signal.service /etc/systemd/system/
 144 sed -i -e "s|%dir%|<INSERT_INSTALL_PATH>|" -e "s|%number%|<INSERT_YOUR_NUMBER>|" /etc/systemd/system/signal.service
 145 systemctl daemon-reload
 146 systemctl enable signal.service
 147 systemctl reload dbus.service
 148 ```
 149
 150 Make sure to use "--dbus-system" with the send command, the service will be autostarted by dbus the first time it is requested.
 151
 152 ## Storage
 153
 154 The password and cryptographic keys are created when registering and stored in the current users home directory:
 155
 156         $HOME/.config/signal/data/
 157
 158 For legacy users, the old config directory is used as a fallback:
 159
 160         $HOME/.config/textsecure/data/
 161
 162 ## Building
 163
 164 This project uses [Gradle](http://gradle.org) for building and maintaining
 165 dependencies. If you have a recent gradle version installed, you can replace `./gradlew` with `gradle` in the following steps.
 166
 167 1. Checkout the source somewhere on your filesystem with
 168
 169         git clone https://github.com/AsamK/signal-cli.git
 170
 171 2. Execute Gradle:
 172
 173         ./gradlew build
 174
 175 3. Create shell wrapper in *build/install/signal-cli/bin*:
 176
 177         ./gradlew installDist
 178
 179 4. Create tar file in *build/distributions*:
 180
 181         ./gradlew distTar
 182
 183 ## Troubleshooting
 184 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.
 185
 186 ## License
 187
 188 This project uses libsignal-service-java from Open Whisper Systems:
 189
 190 https://github.com/WhisperSystems/libsignal-service-java
 191
 192 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html