No description
Find a file
2020-11-10 00:38:13 -05:00
.github/workflows Use java 14 for CI builds 2020-09-10 10:16:24 +02:00
.idea/codeStyles Reformat project 2020-03-23 14:49:21 +01:00
data Update systemd service files 2016-05-19 18:22:52 +02:00
gradle/wrapper Update gradle wrapper 2020-09-10 16:02:41 +02:00
man Update dependencies 2020-08-09 13:00:29 +02:00
src/main tweaked output and added script softlink 2020-11-10 00:26:53 -05:00
.gitignore Update dependencies 2018-02-02 22:27:43 +01:00
build.gradle Bump version 2020-10-14 18:39:18 +02:00
gradlew Update gradle wrapper 2020-09-10 16:02:41 +02:00
gradlew.bat Update gradle wrapper 2020-09-10 16:02:41 +02:00
LICENSE Add README and LICENCE 2015-05-11 12:55:26 +02:00
README.md explained this fork 2020-11-10 00:38:13 -05:00
settings.gradle Rename to signal-cli 2016-03-27 16:17:42 +02:00
signal-cli-script tweaked output and added script softlink 2020-11-10 00:26:53 -05:00

this is patched such that the daemon command reads recipient:message pairs from stdin instead of exporting an object to dbus while outputing json as normal (though it currently also outputs "sent $msg to $recipient" in response to input as well). it also includes reactions in output, and will include quotes.

note that currently sending multiline messages does not work, lines after the first are ignored.

expect the wiki and builds to be broken for now.

signal-cli

signal-cli is a commandline interface for libsignal-service-java. It supports registering, verifying, sending and receiving messages. To be able to link to an existing Signal-Android/signal-cli instance, signal-cli uses a patched libsignal-service-java, because libsignal-service-java does not yet support provisioning as a slave device. For registering you need a phone number where you can receive SMS or incoming calls. signal-cli 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.

Installation

You can build signal-cli yourself, or use the provided binary files, which should work on Linux, macOS and Windows. For Arch Linux there is also a package in AUR and there is a FreeBSD port available as well. You need to have at least JRE 11 installed, to run signal-cli.

Install system-wide on Linux

See latest version.

export VERSION=<latest version, format "x.y.z">
wget https://github.com/technillogue/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz
sudo tar xf signal-cli-"${VERSION}".tar.gz -C /opt
sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/

You can find further instructions on the Wiki:

Usage

Important: The USERNAME (your phone number) must include the country calling code, i.e. the number must start with a "+" sign. (See Wikipedia for a list of all country codes.)

  • Register a number (with SMS verification)

      signal-cli -u USERNAME register
    

    You can register Signal using a land line number. In this case you can skip SMS verification process and jump directly to the voice call verification by adding the --voice switch at the end of above register command.

  • Verify the number using the code received via SMS or voice, optionally add --pin PIN_CODE if you've added a pin code to your account

      signal-cli -u USERNAME verify CODE
    
  • Send a message

      signal-cli -u USERNAME send -m "This is a message" RECIPIENT
    
  • Pipe the message content from another process.

      uname -a | signal-cli -u USERNAME send RECIPIENT
    
  • Receive messages

      signal-cli -u USERNAME receive
    

For more information read the man page and the wiki.

Storage

The password and cryptographic keys are created when registering and stored in the current users home directory:

$XDG_DATA_HOME/signal-cli/data/ ($HOME/.local/share/signal-cli/data/)

For legacy users, the old config directories are used as a fallback:

    $HOME/.config/signal/data/

    $HOME/.config/textsecure/data/

Building

This project uses Gradle for building and maintaining dependencies. If you have a recent gradle version installed, you can replace ./gradlew with gradle in the following steps.

  1. Checkout the source somewhere on your filesystem with

     git clone https://github.com/technillogue/signal-cli.git
    
  2. Execute Gradle:

     ./gradlew build
    
  3. Create shell wrapper in build/install/signal-cli/bin:

     ./gradlew installDist
    
  4. Create tar file in build/distributions:

     ./gradlew distTar
    

Troubleshooting

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.

License

This project uses libsignal-service-java from Open Whisper Systems:

https://github.com/WhisperSystems/libsignal-service-java

Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html