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 * Register a number (with SMS verification)
  24
  25         signal-cli -u USERNAME register
  26
  27 * Register a number (with voice verification)
  28
  29         signal-cli -u USERNAME register -v
  30
  31 * Verify the number using the code received via SMS or voice
  32
  33         signal-cli -u USERNAME verify CODE
  34
  35 * Send a message to one or more recipients
  36
  37         signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
  38
  39 * Pipe the message content from another process.
  40
  41         uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
  42
  43 * Receive messages
  44
  45         signal-cli -u USERNAME receive
  46
  47 * Groups
  48
  49  * Create a group
  50
  51           signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
  52
  53  * Update a group
  54
  55           signal-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name" -a "AVATAR_IMAGE_FILE"
  56
  57  * Add member to a group
  58
  59           signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
  60
  61  * Leave a group
  62
  63           signal-cli -u USERNAME quitGroup -g GROUP_ID
  64
  65  * Send a message to a group
  66
  67           signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
  68
  69 * Linking other devices (Provisioning)
  70
  71  * Connect to another device
  72
  73           signal-cli link -n "optional device name"
  74
  75         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.
  76
  77  * Add another device
  78
  79           signal-cli -u USERNAME addDevice --uri "tsdevice:/…"
  80
  81         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.
  82         Only the master device (that was registered directly, not linked) can add new devices.
  83
  84  * Manage linked devices
  85
  86           signal-cli -u USERNAME listDevices
  87
  88           signal-cli -u USERNAME removeDevice -d DEVICE_ID
  89
  90 * Manage trusted keys
  91
  92  * View all known keys
  93
  94           signal-cli -u USERNAME listIdentities
  95
  96  * View known keys of one number
  97
  98           signal-cli -u USERNAME listIdentities -n NUMBER
  99
 100  * Trust new key, after having verified it
 101
 102           signal-cli -u USERNAME trust -v FINGER_PRINT NUMBER
 103
 104  * Trust new key, without having verified it. Only use this if you don't care about security
 105
 106           signal-cli -u USERNAME trust -a NUMBER
 107
 108 * Set configuration directory
 109
 110           signal-cli --config=/home/other_user/.config/signal
 111
 112         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.
 113
 114 ## DBus service
 115
 116 signal-cli can run in daemon mode and provides an experimental dbus interface.
 117 For dbus support you need jni/unix-java.so installed on your system (Debian: libunixsocket-java ArchLinux: libmatthew-unix-java (AUR)).
 118
 119 * Run in daemon mode (dbus session bus)
 120
 121           signal-cli -u USERNAME daemon
 122
 123 * Send a message via dbus
 124
 125           signal-cli --dbus send -m "Message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 126
 127 ### System bus
 128
 129 To run on the system bus you need to take some additional steps.
 130 It’s advisable to run signal-cli as a separate unix user, the following steps assume you created a user named *signal-cli*.
 131 These steps, executed as root, should work on all distributions using systemd.
 132
 133 ```bash
 134 cp data/org.asamk.Signal.conf /etc/dbus-1/system.d/
 135 cp data/org.asamk.Signal.service /usr/share/dbus-1/system-services/
 136 cp data/signal.service /etc/systemd/system/
 137 sed -i -e "s|%dir%|<INSERT_INSTALL_PATH>|" -e "s|%number%|<INSERT_YOUR_NUMBER>|" /etc/systemd/system/signal.service
 138 systemctl daemon-reload
 139 systemctl enable signal.service
 140 systemctl reload dbus.service
 141 ```
 142
 143 Then just execute the send command from above, the service will be autostarted by dbus the first time it is requested.
 144
 145 ## Storage
 146
 147 The password and cryptographic keys are created when registering and stored in the current users home directory:
 148
 149         $HOME/.config/signal/data/
 150
 151 For legacy users, the old config directory is used as a fallback:
 152
 153         $HOME/.config/textsecure/data/
 154
 155 ## Building
 156
 157 This project uses [Gradle](http://gradle.org) for building and maintaining
 158 dependencies. If you have a recent gradle version installed, you can replace `./gradlew` with `gradle` in the following steps.
 159
 160 1. Checkout the source somewhere on your filesystem with
 161
 162         git clone https://github.com/AsamK/signal-cli.git
 163
 164 2. Execute Gradle:
 165
 166         ./gradlew build
 167
 168 3. Create shell wrapper in *build/install/signal-cli/bin*:
 169
 170         ./gradlew installDist
 171
 172 4. Create tar file in *build/distributions*:
 173
 174         ./gradlew distTar
 175
 176 ## Troubleshooting
 177 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.
 178
 179 ## License
 180
 181 This project uses libsignal-service-java from Open Whisper Systems:
 182
 183 https://github.com/WhisperSystems/libsignal-service-java
 184
 185 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html