mirror of
https://github.com/bbernhard/signal-cli-rest-api.git
synced 2026-05-18 13:24:15 +00:00
Compare commits
10 Commits
25bd1c0d51
...
fa17535a90
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fa17535a90 | ||
|
|
ddc5aa55df | ||
|
|
00bbfca878 | ||
|
|
884582a71e | ||
|
|
e3d503c746 | ||
|
|
af34a0881c | ||
|
|
c7cb9ab13e | ||
|
|
af18c7aea8 | ||
|
|
7e1b98f0c2 | ||
|
|
40dd9a21b2 |
43
Dockerfile
43
Dockerfile
@ -1,6 +1,6 @@
|
||||
ARG SIGNAL_CLI_VERSION=0.14.0
|
||||
ARG LIBSIGNAL_CLIENT_VERSION=0.87.4
|
||||
ARG SIGNAL_CLI_NATIVE_PACKAGE_VERSION=0.14.0+morph027+3
|
||||
ARG SIGNAL_CLI_NATIVE_PACKAGE_VERSION=0.14.0+morph027+5
|
||||
|
||||
ARG SWAG_VERSION=1.16.4
|
||||
ARG GRAALVM_VERSION=25.0.2
|
||||
@ -18,6 +18,7 @@ ARG SIGNAL_CLI_NATIVE_PACKAGE_VERSION
|
||||
|
||||
COPY ext/libraries/libsignal-client/v${LIBSIGNAL_CLIENT_VERSION} /tmp/libsignal-client-libraries
|
||||
COPY ext/libraries/libsignal-client/signal-cli-native.patch /tmp/signal-cli-native.patch
|
||||
COPY ext/patches/fix-binary-aci.patch /tmp/fix-binary-aci.patch
|
||||
|
||||
# use architecture specific libsignal_jni.so
|
||||
RUN arch="$(uname -m)"; \
|
||||
@ -74,6 +75,7 @@ RUN if [ "$(uname -m)" = "x86_64" ]; then \
|
||||
&& git clone https://github.com/AsamK/signal-cli.git signal-cli-${SIGNAL_CLI_VERSION}-source \
|
||||
&& cd signal-cli-${SIGNAL_CLI_VERSION}-source \
|
||||
&& git checkout -q v${SIGNAL_CLI_VERSION} \
|
||||
&& git apply /tmp/fix-binary-aci.patch \
|
||||
&& cd /tmp && mkdir -p /tmp/graalvm && tar xf gvm.tar.gz -C /tmp/graalvm --strip-components=1 \
|
||||
&& export GRAALVM_HOME=/tmp/graalvm \
|
||||
&& export PATH=/tmp/graalvm/bin:$PATH \
|
||||
@ -81,10 +83,14 @@ RUN if [ "$(uname -m)" = "x86_64" ]; then \
|
||||
&& sed -i 's/Signal-Android\/5.22.3/Signal-Android\/5.51.7/g' src/main/java/org/asamk/signal/BaseConfig.java \
|
||||
&& ./gradlew build \
|
||||
&& ./gradlew installDist \
|
||||
&& ls build/install/signal-cli/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar || (echo "\n\nsignal-client jar file with version ${LIBSIGNAL_CLIENT_VERSION} not found. Maybe the version needs to be bumped in the signal-cli-rest-api Dockerfile?\n\n" && echo "Available version: \n" && ls build/install/signal-cli/lib/libsignal-client-* && echo "\n\n" && exit 1) \
|
||||
&& BUILT_LIBSIGNAL_JAR_NAME=$(ls build/install/signal-cli/lib/ | grep 'libsignal-client-.*\.jar' | head -1) \
|
||||
&& echo "Built libsignal-client jar: ${BUILT_LIBSIGNAL_JAR_NAME}" \
|
||||
&& rm -rf /tmp/signal-cli-${SIGNAL_CLI_VERSION} \
|
||||
&& cp -a build/install/signal-cli /tmp/signal-cli-${SIGNAL_CLI_VERSION} \
|
||||
&& cd /tmp \
|
||||
&& cp signal-cli-${SIGNAL_CLI_VERSION}-source/build/install/signal-cli/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar libsignal-client.jar \
|
||||
&& cp /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib/${BUILT_LIBSIGNAL_JAR_NAME} libsignal-client.jar \
|
||||
&& zip -qu libsignal-client.jar libsignal_jni.so \
|
||||
&& cp libsignal-client.jar /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib/${BUILT_LIBSIGNAL_JAR_NAME} \
|
||||
&& cd /tmp/signal-cli-${SIGNAL_CLI_VERSION}-source \
|
||||
&& git apply /tmp/signal-cli-native.patch \
|
||||
&& ./gradlew -q nativeCompile; \
|
||||
@ -112,20 +118,27 @@ RUN if [ "$(uname -m)" = "x86_64" ]; then \
|
||||
echo "Unknown architecture"; \
|
||||
fi;
|
||||
|
||||
# replace libsignal-client
|
||||
# Post-processing: inject native libsignal_jni.so and apply BaseConfig workaround.
|
||||
# On x86_64 the source build (above) already produced a patched installDist with
|
||||
# the native lib injected, so we only need to package it. On other architectures
|
||||
# the release tarball is still unpatched — apply the BaseConfig sed workaround and
|
||||
# inject the native lib there.
|
||||
|
||||
RUN ls /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar || (echo "\n\nsignal-client jar file with version ${LIBSIGNAL_CLIENT_VERSION} not found. Maybe the version needs to be bumped in the signal-cli-rest-api Dockerfile?\n\n" && echo "Available version: \n" && ls /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib/libsignal-client-* && echo "\n\n" && exit 1)
|
||||
|
||||
# workaround until upstream is fixed
|
||||
RUN cd /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib \
|
||||
&& unzip signal-cli-${SIGNAL_CLI_VERSION}.jar \
|
||||
&& sed -i 's/Signal-Android\/5.22.3/Signal-Android\/5.51.7/g' org/asamk/signal/BaseConfig.class \
|
||||
&& zip -r signal-cli-${SIGNAL_CLI_VERSION}.jar org/ META-INF/ \
|
||||
&& rm -rf META-INF \
|
||||
&& rm -rf org
|
||||
RUN if [ "$(uname -m)" != "x86_64" ]; then \
|
||||
ls /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar \
|
||||
|| (echo "\n\nsignal-client jar file with version ${LIBSIGNAL_CLIENT_VERSION} not found.\n\n" \
|
||||
&& ls /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib/libsignal-client-* && exit 1) \
|
||||
&& cd /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib \
|
||||
&& unzip signal-cli-${SIGNAL_CLI_VERSION}.jar \
|
||||
&& sed -i 's/Signal-Android\/5.22.3/Signal-Android\/5.51.7/g' org/asamk/signal/BaseConfig.class \
|
||||
&& zip -r signal-cli-${SIGNAL_CLI_VERSION}.jar org/ META-INF/ \
|
||||
&& rm -rf META-INF \
|
||||
&& rm -rf org \
|
||||
&& cd /tmp/ \
|
||||
&& zip -qu /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar libsignal_jni.so; \
|
||||
fi
|
||||
|
||||
RUN cd /tmp/ \
|
||||
&& zip -qu /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar libsignal_jni.so \
|
||||
&& zip -qr signal-cli-${SIGNAL_CLI_VERSION}.zip signal-cli-${SIGNAL_CLI_VERSION}/* \
|
||||
&& unzip -q /tmp/signal-cli-${SIGNAL_CLI_VERSION}.zip -d /opt \
|
||||
&& rm -f /tmp/signal-cli-${SIGNAL_CLI_VERSION}.zip
|
||||
@ -172,7 +185,7 @@ ENV SIGNAL_CLI_REST_API_PLUGIN_SHARED_OBJ_DIR=/usr/bin/
|
||||
|
||||
RUN dpkg-reconfigure debconf --frontend=noninteractive \
|
||||
&& apt-get update \
|
||||
&& apt-get install -y --no-install-recommends util-linux supervisor netcat-openbsd openjdk-25-jre curl locales \
|
||||
&& apt-get install -y --no-install-recommends util-linux supervisor openjdk-25-jre curl locales \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
COPY --from=buildcontainer /tmp/signal-cli-rest-api-src/signal-cli-rest-api /usr/bin/signal-cli-rest-api
|
||||
|
||||
@ -4,6 +4,8 @@ This can be done by putting the docker container into debug mode with the follow
|
||||
|
||||
```curl -X POST -H "Content-Type: application/json" -d '{"logging": {"level": "debug"}}' 'http://127.0.0.1:8080/v1/configuration'```
|
||||
|
||||
Alternatively, you can set the `LOG_LEVEL` environment variable.
|
||||
|
||||
Once the docker container is in debug mode, execute the REST API command you want to debug.
|
||||
|
||||
e.g Let's assume we are experiencing some problems with sending messages. So, let's send a Signal message with
|
||||
|
||||
89
ext/patches/fix-binary-aci.patch
Normal file
89
ext/patches/fix-binary-aci.patch
Normal file
@ -0,0 +1,89 @@
|
||||
Fix Signal Desktop v8.0.0 binary ACI encoding compatibility.
|
||||
|
||||
Signal Desktop v8.0.0 switched from string ACI fields to binary ACI encoding
|
||||
in protobuf messages. This causes null ServiceId values when the library
|
||||
cannot parse the new format, breaking reactions, mentions, quotes, and other
|
||||
message features.
|
||||
|
||||
Two-part fix:
|
||||
1. Bump signal-service-java from unofficial_137 to unofficial_138 which adds
|
||||
dual-format ACI parsing (string + binary fallback).
|
||||
2. Add defensive null guards in MessageEnvelope.java for cases where ServiceId
|
||||
resolution still fails (e.g. ACI.UNKNOWN), preserving message content with
|
||||
UNKNOWN_UUID fallback rather than dropping entire message components.
|
||||
|
||||
See: https://github.com/AsamK/signal-cli/pull/1944
|
||||
|
||||
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
|
||||
index 9b1bd5f4..0000001 100644
|
||||
--- a/gradle/libs.versions.toml
|
||||
+++ b/gradle/libs.versions.toml
|
||||
@@ -11,7 +11,7 @@ slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" }
|
||||
slf4j-jul = { module = "org.slf4j:jul-to-slf4j", version.ref = "slf4j" }
|
||||
logback = "ch.qos.logback:logback-classic:1.5.25"
|
||||
|
||||
-signalservice = "com.github.turasa:signal-service-java:2.15.3_unofficial_137"
|
||||
+signalservice = "com.github.turasa:signal-service-java:2.15.3_unofficial_138"
|
||||
sqlite = "org.xerial:sqlite-jdbc:3.51.1.0"
|
||||
hikari = "com.zaxxer:HikariCP:7.0.2"
|
||||
junit-jupiter-bom = { module = "org.junit:junit-bom", version.ref = "junit" }
|
||||
diff --git a/lib/src/main/java/org/asamk/signal/manager/api/MessageEnvelope.java b/lib/src/main/java/org/asamk/signal/manager/api/MessageEnvelope.java
|
||||
index 37946057..57a5a0f4 100644
|
||||
--- a/lib/src/main/java/org/asamk/signal/manager/api/MessageEnvelope.java
|
||||
+++ b/lib/src/main/java/org/asamk/signal/manager/api/MessageEnvelope.java
|
||||
@@ -132,6 +132,7 @@ public record MessageEnvelope(
|
||||
return new Data(dataMessage.getTimestamp(),
|
||||
dataMessage.getGroupContext().map(GroupContext::from),
|
||||
dataMessage.getStoryContext()
|
||||
+ .filter(s -> s.getAuthorServiceId() != null)
|
||||
.map((SignalServiceDataMessage.StoryContext storyContext) -> StoryContext.from(storyContext,
|
||||
recipientResolver,
|
||||
addressResolver)),
|
||||
@@ -143,9 +144,10 @@ public record MessageEnvelope(
|
||||
dataMessage.isEndSession(),
|
||||
dataMessage.isProfileKeyUpdate(),
|
||||
dataMessage.getProfileKey().isPresent(),
|
||||
- dataMessage.getReaction().map(r -> Reaction.from(r, recipientResolver, addressResolver)),
|
||||
+ dataMessage.getReaction()
|
||||
+ .filter(r -> r.getTargetAuthor() != null)
|
||||
+ .map(r -> Reaction.from(r, recipientResolver, addressResolver)),
|
||||
dataMessage.getQuote()
|
||||
- .filter(q -> q.getAuthor() != null && q.getAuthor().isValid())
|
||||
.map(q -> Quote.from(q, recipientResolver, addressResolver, fileProvider)),
|
||||
dataMessage.getPayment().map(p -> p.getPaymentNotification().isPresent() ? Payment.from(p) : null),
|
||||
dataMessage.getAttachments()
|
||||
@@ -159,10 +161,15 @@ public record MessageEnvelope(
|
||||
.toList())
|
||||
.orElse(List.of()),
|
||||
dataMessage.getPollCreate().map(PollCreate::from),
|
||||
- dataMessage.getPollVote().map(p -> PollVote.from(p, recipientResolver, addressResolver)),
|
||||
+ dataMessage.getPollVote()
|
||||
+ .filter(p -> p.getTargetAuthor() != null)
|
||||
+ .map(p -> PollVote.from(p, recipientResolver, addressResolver)),
|
||||
dataMessage.getPollTerminate().map(PollTerminate::from),
|
||||
dataMessage.getMentions()
|
||||
- .map(a -> a.stream().map(m -> Mention.from(m, recipientResolver, addressResolver)).toList())
|
||||
+ .map(a -> a.stream()
|
||||
+ .filter(m -> m.getServiceId() != null)
|
||||
+ .map(m -> Mention.from(m, recipientResolver, addressResolver))
|
||||
+ .toList())
|
||||
.orElse(List.of()),
|
||||
dataMessage.getPreviews()
|
||||
.map(a -> a.stream().map(preview -> Preview.from(preview, fileProvider)).toList())
|
||||
@@ -241,10 +248,13 @@ public record MessageEnvelope(
|
||||
RecipientAddressResolver addressResolver,
|
||||
final AttachmentFileProvider fileProvider
|
||||
) {
|
||||
+ final var author = quote.getAuthor() != null && quote.getAuthor().isValid()
|
||||
+ ? addressResolver.resolveRecipientAddress(recipientResolver.resolveRecipient(quote.getAuthor()))
|
||||
+ .toApiRecipientAddress()
|
||||
+ : new RecipientAddress(RecipientAddress.UNKNOWN_UUID);
|
||||
return new Quote(quote.getId(),
|
||||
- addressResolver.resolveRecipientAddress(recipientResolver.resolveRecipient(quote.getAuthor()))
|
||||
- .toApiRecipientAddress(),
|
||||
- Optional.of(quote.getText()),
|
||||
+ author,
|
||||
+ Optional.ofNullable(quote.getText()),
|
||||
quote.getMentions() == null
|
||||
? List.of()
|
||||
: quote.getMentions()
|
||||
@ -410,7 +410,7 @@ func (s *SignalClient) GetSignalCliMode() SignalCliMode {
|
||||
return s.signalCliMode
|
||||
}
|
||||
|
||||
func (s *SignalClient) Init() error {
|
||||
func (s *SignalClient) Init(maxRetries int) error {
|
||||
s.signalCliApiConfig = utils.NewSignalCliApiConfig()
|
||||
err := s.signalCliApiConfig.Load(s.signalCliApiConfigPath)
|
||||
if err != nil {
|
||||
@ -427,7 +427,7 @@ func (s *SignalClient) Init() error {
|
||||
tcpPortsNumberMapping := s.jsonRpc2ClientConfig.GetTcpPortsForNumbers()
|
||||
for number, tcpPort := range tcpPortsNumberMapping {
|
||||
s.jsonRpc2Clients[number] = NewJsonRpc2Client(s.signalCliApiConfig, number)
|
||||
err := s.jsonRpc2Clients[number].Dial("127.0.0.1:" + strconv.FormatInt(tcpPort, 10))
|
||||
err := s.jsonRpc2Clients[number].Dial("127.0.0.1:"+strconv.FormatInt(tcpPort, 10), maxRetries)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
@ -2,14 +2,14 @@ package client
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"net"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"sync"
|
||||
"time"
|
||||
"net/http"
|
||||
"bytes"
|
||||
"strconv"
|
||||
|
||||
"github.com/bbernhard/signal-cli-rest-api/utils"
|
||||
uuid "github.com/gofrs/uuid"
|
||||
@ -60,11 +60,11 @@ type JsonRpc2Client struct {
|
||||
conn net.Conn
|
||||
receivedResponsesById map[string]chan JsonRpc2MessageResponse
|
||||
receivedMessagesChannels map[string]chan JsonRpc2ReceivedMessage
|
||||
lastTimeErrorMessageSent time.Time
|
||||
signalCliApiConfig *utils.SignalCliApiConfig
|
||||
number string
|
||||
receivedMessagesMutex sync.Mutex
|
||||
receivedResponsesMutex sync.Mutex
|
||||
address string
|
||||
}
|
||||
|
||||
func NewJsonRpc2Client(signalCliApiConfig *utils.SignalCliApiConfig, number string) *JsonRpc2Client {
|
||||
@ -76,10 +76,24 @@ func NewJsonRpc2Client(signalCliApiConfig *utils.SignalCliApiConfig, number stri
|
||||
}
|
||||
}
|
||||
|
||||
func (r *JsonRpc2Client) Dial(address string) error {
|
||||
func (r *JsonRpc2Client) Dial(address string, maxRetries int) error {
|
||||
var err error
|
||||
r.conn, err = net.Dial("tcp", address)
|
||||
if err != nil {
|
||||
r.address = address
|
||||
connected := false
|
||||
for i := 0; i < maxRetries; i++ {
|
||||
r.conn, err = net.Dial("tcp", address)
|
||||
if err != nil {
|
||||
log.Info("Waiting for signal-cli to start up in daemon mode...")
|
||||
time.Sleep(2 * time.Second)
|
||||
continue
|
||||
}
|
||||
|
||||
connected = true
|
||||
log.Info("Successfully connected to signal-cli in daemon mode")
|
||||
break
|
||||
}
|
||||
|
||||
if !connected {
|
||||
return err
|
||||
}
|
||||
|
||||
@ -207,11 +221,14 @@ func (r *JsonRpc2Client) ReceiveData(number string, receiveWebhookUrl string) {
|
||||
for {
|
||||
str, err := connbuf.ReadString('\n')
|
||||
if err != nil {
|
||||
elapsed := time.Since(r.lastTimeErrorMessageSent)
|
||||
if (elapsed) > time.Duration(5*time.Minute) { //avoid spamming the log file and only log the message at max every 5 minutes
|
||||
log.Error("Couldn't read data for number ", number, ": ", err.Error(), ". Is the number properly registered?")
|
||||
r.lastTimeErrorMessageSent = time.Now()
|
||||
log.Error("Lost connection to signal-cli...attempting to reconnect (", err.Error(), ")")
|
||||
r.conn.Close()
|
||||
err = r.Dial(r.address, 15)
|
||||
if err != nil {
|
||||
log.Fatal("Unable to reconnect to signal-cli: ", err.Error(), "...aborting")
|
||||
}
|
||||
connbuf = bufio.NewReader(r.conn)
|
||||
log.Info("Successfully reconnected to signal-cli")
|
||||
continue
|
||||
}
|
||||
log.Debug("json-rpc received data: ", str)
|
||||
@ -248,7 +265,7 @@ func (r *JsonRpc2Client) ReceiveData(number string, receiveWebhookUrl string) {
|
||||
}
|
||||
}
|
||||
} else {
|
||||
log.Error("Received unparsable message: ", str)
|
||||
log.Warn("Received unparsable message: ", str)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -163,7 +163,7 @@ func main() {
|
||||
jsonRpc2ClientConfigPathPath := *signalCliConfig + "/jsonrpc2.yml"
|
||||
signalCliApiConfigPath := *signalCliConfig + "/api-config.yml"
|
||||
signalClient := client.NewSignalClient(*signalCliConfig, *attachmentTmpDir, *avatarTmpDir, signalCliMode, jsonRpc2ClientConfigPathPath, signalCliApiConfigPath, webhookUrl)
|
||||
err = signalClient.Init()
|
||||
err = signalClient.Init(15)
|
||||
if err != nil {
|
||||
log.Fatal("Couldn't init Signal Client: ", err.Error())
|
||||
}
|
||||
|
||||
@ -14,7 +14,7 @@ import (
|
||||
const supervisorctlConfigTemplate = `
|
||||
[program:%s]
|
||||
process_name=%s
|
||||
command=bash -c "nc -l -p %d <%s | signal-cli --output=json --config %s%s jsonRpc%s%s >%s"
|
||||
command=signal-cli --output=json --config %s%s daemon %s%s --tcp 127.0.0.1:%d
|
||||
autostart=true
|
||||
autorestart=true
|
||||
startretries=10
|
||||
@ -96,7 +96,7 @@ func main() {
|
||||
supervisorctlConfigFilename := "/etc/supervisor/conf.d/" + "signal-cli-json-rpc-1.conf"
|
||||
|
||||
supervisorctlConfig := fmt.Sprintf(supervisorctlConfigTemplate, supervisorctlProgramName, supervisorctlProgramName,
|
||||
tcpPort, fifoPathname, signalCliConfigDir, trustNewIdentities, signalCliIgnoreAttachments, signalCliIgnoreStories, fifoPathname,
|
||||
signalCliConfigDir, trustNewIdentities, signalCliIgnoreAttachments, signalCliIgnoreStories, tcpPort,
|
||||
supervisorctlProgramName, supervisorctlProgramName)
|
||||
|
||||
err = ioutil.WriteFile(supervisorctlConfigFilename, []byte(supervisorctlConfig), 0644)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user