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). 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] [-u USERNAME] [-v] {register,verify,send,quitGroup,updateGroup,receive} ...
   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 * Groups
  31
  32  * Create a group
  33
  34           signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
  35
  36  * Update a group
  37
  38           signal-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name"
  39
  40  * Send a message to a group
  41
  42           signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
  43
  44 ## DBus service
  45
  46 signal-cli can run in daemon mode and provides an experimental dbus interface.
  47 For dbus support you need jni/unix-java.so installed on your system (Debian: libunixsocket-java ArchLinux: libmatthew-unix-java (AUR)).
  48
  49 * Run in daemon mode (dbus session bus)
  50
  51           signal-cli -u USERNAME daemon
  52
  53 * Send a message via dbus
  54
  55           signal-cli --dbus send -m "Message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
  56
  57 ### System bus
  58
  59 To run on the system bus you need to take some additional steps.
  60 It’s advisable to run signal-cli as a separate unix user, the following steps assume you created a user named *signal-cli*.
  61 These steps, executed as root, should work on all distributions using systemd.
  62
  63 ```bash
  64 cp data/org.asamk.Signal.conf /etc/dbus-1/system.d/
  65 cp data/org.asamk.Signal.service /usr/share/dbus-1/system-services/
  66 cp data/signal.service /etc/systemd/system/
  67 sed -i -e "s|%dir%|<INSERT_INSTALL_PATH>|" -e "s|%number%|<INSERT_YOUR_NUMBER>|" /etc/systemd/system/signal.service
  68 systemctl daemon-reload
  69 systemctl enable signal.service
  70 systemctl reload dbus.service
  71 ```
  72
  73 Then just execute the send command from above, the service will be autostarted by dbus the first time it is requested.
  74
  75 ## Storage
  76
  77 The password and cryptographic keys are created when registering and stored in the current users home directory:
  78
  79         $HOME/.config/signal/data/
  80
  81 For legacy users, the old config directory is used as a fallback:
  82
  83         $HOME/.config/textsecure/data/
  84
  85 ## Building
  86
  87 This project uses [Gradle](http://gradle.org) for building and maintaining
  88 dependencies.
  89
  90 1. Checkout the source somewhere on your filesystem with
  91
  92         git clone https://github.com/AsamK/signal-cli.git
  93
  94 2. Execute Gradle:
  95
  96         ./gradlew build
  97
  98 3. Create shell wrapper in *build/install/signal-cli/bin*:
  99
 100         ./gradlew installDist
 101
 102 4. Create tar file in *build/distributions*:
 103
 104         ./gradlew distTar
 105
 106 ## Troubleshooting
 107 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.
 108
 109 ## License
 110
 111 This project uses libsignal-service-java from Open Whisper Systems:
 112
 113 https://github.com/WhisperSystems/libsignal-service-java
 114
 115 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html