mirror of
https://github.com/bbernhard/signal-cli-rest-api.git
synced 2026-05-02 10:51:17 +00:00
Compare commits
7 Commits
ca794190d1
...
ae5c96c08e
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ae5c96c08e | ||
|
|
9e5d73b5c0 | ||
|
|
d080e8d478 | ||
|
|
a9c367a5b1 | ||
|
|
7e1b98f0c2 | ||
|
|
40dd9a21b2 | ||
|
|
3a36a04b09 |
45
Dockerfile
45
Dockerfile
@ -1,13 +1,13 @@
|
||||
ARG SIGNAL_CLI_VERSION=0.14.0
|
||||
ARG LIBSIGNAL_CLIENT_VERSION=0.87.4
|
||||
ARG SIGNAL_CLI_NATIVE_PACKAGE_VERSION=0.14.0+morph027+2
|
||||
ARG SIGNAL_CLI_NATIVE_PACKAGE_VERSION=0.13.24+morph027+2
|
||||
|
||||
ARG SWAG_VERSION=1.16.4
|
||||
ARG GRAALVM_VERSION=25.0.2
|
||||
|
||||
ARG BUILD_VERSION_ARG=unset
|
||||
|
||||
FROM golang:1.24-bookworm AS buildcontainer
|
||||
FROM golang:1.24 AS buildcontainer
|
||||
|
||||
ARG SIGNAL_CLI_VERSION
|
||||
ARG LIBSIGNAL_CLIENT_VERSION
|
||||
@ -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)"; \
|
||||
@ -31,7 +32,7 @@ RUN arch="$(uname -m)"; \
|
||||
RUN dpkg-reconfigure debconf --frontend=noninteractive \
|
||||
&& apt-get update \
|
||||
&& apt-get -y install --no-install-recommends \
|
||||
wget software-properties-common git locales zip unzip \
|
||||
wget git locales zip unzip \
|
||||
file build-essential libz-dev zlib1g-dev \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
@ -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
|
||||
|
||||
@ -1,11 +1,22 @@
|
||||
version: "3"
|
||||
services:
|
||||
signal-cli-rest-api:
|
||||
image: bbernhard/signal-cli-rest-api:latest
|
||||
#image: bbernhard/signal-cli-rest-api:latest-dev
|
||||
build: "."
|
||||
environment:
|
||||
- MODE=normal #supported modes: json-rpc, native, normal
|
||||
- MODE=normal #supported modes: json-rpc, json-rpc-native, native, normal
|
||||
- ENABLE_PLUGINS=true
|
||||
- DEFAULT_SIGNAL_TEXT_MODE=styled
|
||||
- SWAGGER_IP=127.0.0.1
|
||||
- PODMAN_USERNS=keep-id
|
||||
#- JSON_RPC_IGNORE_ATTACHMENTS=true
|
||||
#- JSON_RPC_IGNORE_STORIES=true
|
||||
#- RECEIVE_WEBHOOK_URL=http://127.0.0.1:8089/webhook
|
||||
#- JSON_RPC_TRUST_NEW_IDENTITIES=always
|
||||
#- RECEIVE_WEBHOOK_URL=http://127.0.0.1:8080/v1/plugins/abc
|
||||
#- AUTO_RECEIVE_SCHEDULE=0 22 * * * #enable this parameter on demand (see description below)
|
||||
#network_mode: host
|
||||
ports:
|
||||
- "8080:8080" #map docker port 8080 to host port 8080.
|
||||
volumes:
|
||||
- "./signal-cli-config:/home/.local/share/signal-cli" #map "signal-cli-config" folder on host system into docker container. the folder contains the password and cryptographic keys when a new number is registered
|
||||
- "./plugins:/plugins"
|
||||
|
||||
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()
|
||||
@ -215,7 +215,7 @@ type RemoteDeleteRequest struct {
|
||||
}
|
||||
|
||||
type DeleteLocalAccountDataRequest struct {
|
||||
IgnoreRegistered bool `json:"ignore_registered" example:"false"`
|
||||
IgnoreRegistered bool `json:"ignore_registered" example:"false"`
|
||||
}
|
||||
|
||||
type DeviceLinkUriResponse struct {
|
||||
@ -364,30 +364,30 @@ func (a *Api) UnregisterNumber(c *gin.Context) {
|
||||
// @Failure 400 {object} Error
|
||||
// @Router /v1/devices/{number}/local-data [delete]
|
||||
func (a *Api) DeleteLocalAccountData(c *gin.Context) {
|
||||
number, err := url.PathUnescape(c.Param("number"))
|
||||
if err != nil {
|
||||
c.JSON(400, Error{Msg: "Couldn't process request - malformed number"})
|
||||
return
|
||||
}
|
||||
if number == "" {
|
||||
c.JSON(400, Error{Msg: "Couldn't process request - number missing"})
|
||||
return
|
||||
}
|
||||
number, err := url.PathUnescape(c.Param("number"))
|
||||
if err != nil {
|
||||
c.JSON(400, Error{Msg: "Couldn't process request - malformed number"})
|
||||
return
|
||||
}
|
||||
if number == "" {
|
||||
c.JSON(400, Error{Msg: "Couldn't process request - number missing"})
|
||||
return
|
||||
}
|
||||
|
||||
req := DeleteLocalAccountDataRequest{}
|
||||
if c.Request.Body != nil && c.Request.ContentLength != 0 {
|
||||
if err := c.BindJSON(&req); err != nil {
|
||||
c.JSON(400, Error{Msg: "Couldn't process request - invalid request"})
|
||||
return
|
||||
}
|
||||
}
|
||||
req := DeleteLocalAccountDataRequest{}
|
||||
if c.Request.Body != nil && c.Request.ContentLength != 0 {
|
||||
if err := c.BindJSON(&req); err != nil {
|
||||
c.JSON(400, Error{Msg: "Couldn't process request - invalid request"})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if err := a.signalClient.DeleteLocalAccountData(number, req.IgnoreRegistered); err != nil {
|
||||
c.JSON(400, Error{Msg: err.Error()})
|
||||
return
|
||||
}
|
||||
if err := a.signalClient.DeleteLocalAccountData(number, req.IgnoreRegistered); err != nil {
|
||||
c.JSON(400, Error{Msg: err.Error()})
|
||||
return
|
||||
}
|
||||
|
||||
c.Status(http.StatusNoContent)
|
||||
c.Status(http.StatusNoContent)
|
||||
}
|
||||
|
||||
// @Summary Verify a registered phone number.
|
||||
@ -843,6 +843,7 @@ func (a *Api) AddMembersToGroup(c *gin.Context) {
|
||||
|
||||
err = a.signalClient.AddMembersToGroup(number, groupId, req.Members)
|
||||
if err != nil {
|
||||
log.Info("ERR NOT NULL")
|
||||
switch err.(type) {
|
||||
case *client.NotFoundError:
|
||||
c.JSON(404, Error{Msg: err.Error()})
|
||||
@ -1174,19 +1175,19 @@ func (a *Api) GetQrCodeLink(c *gin.Context) {
|
||||
// @Failure 400 {object} Error
|
||||
// @Router /v1/qrcodelink/raw [get]
|
||||
func (a *Api) GetQrCodeLinkUri(c *gin.Context) {
|
||||
deviceName := c.Query("device_name")
|
||||
if deviceName == "" {
|
||||
c.JSON(400, Error{Msg: "Please provide a name for the device"})
|
||||
return
|
||||
}
|
||||
deviceName := c.Query("device_name")
|
||||
if deviceName == "" {
|
||||
c.JSON(400, Error{Msg: "Please provide a name for the device"})
|
||||
return
|
||||
}
|
||||
|
||||
deviceLinkUri, err := a.signalClient.GetDeviceLinkUri(deviceName)
|
||||
if err != nil {
|
||||
c.JSON(400, Error{Msg: err.Error()})
|
||||
return
|
||||
}
|
||||
deviceLinkUri, err := a.signalClient.GetDeviceLinkUri(deviceName)
|
||||
if err != nil {
|
||||
c.JSON(400, Error{Msg: err.Error()})
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(200, DeviceLinkUriResponse{DeviceLinkUri: deviceLinkUri})
|
||||
c.JSON(200, DeviceLinkUriResponse{DeviceLinkUri: deviceLinkUri})
|
||||
}
|
||||
|
||||
// @Summary List all accounts
|
||||
@ -2080,7 +2081,7 @@ func (a *Api) RemoveDevice(c *gin.Context) {
|
||||
}
|
||||
|
||||
deviceIdStr := c.Param("deviceId")
|
||||
deviceId, err := strconv.ParseInt(deviceIdStr, 10, 64)
|
||||
deviceId, err := strconv.ParseInt(deviceIdStr, 10, 64)
|
||||
if err != nil {
|
||||
c.JSON(400, Error{Msg: "deviceId must be numeric"})
|
||||
return
|
||||
|
||||
@ -1349,7 +1349,7 @@ func (s *SignalClient) GetGroups(number string) ([]GroupEntry, error) {
|
||||
}
|
||||
pendingMembers = append(pendingMembers, identifier)
|
||||
}
|
||||
groupEntry.PendingRequests = pendingMembers
|
||||
groupEntry.PendingInvites = pendingMembers
|
||||
|
||||
requestingMembers := []string{}
|
||||
for _, val := range signalCliGroupEntry.RequestingMembers {
|
||||
@ -1359,7 +1359,7 @@ func (s *SignalClient) GetGroups(number string) ([]GroupEntry, error) {
|
||||
}
|
||||
requestingMembers = append(requestingMembers, identifier)
|
||||
}
|
||||
groupEntry.PendingInvites = requestingMembers
|
||||
groupEntry.PendingRequests = requestingMembers
|
||||
|
||||
admins := []string{}
|
||||
for _, val := range signalCliGroupEntry.Admins {
|
||||
@ -2634,8 +2634,8 @@ func (s *SignalClient) ListContacts(number string, allRecipients bool, recipient
|
||||
|
||||
if s.signalCliMode == JsonRpc {
|
||||
type Request struct {
|
||||
AllRecipients bool `json:"allRecipients,omitempty"`
|
||||
Recipient string `json:"recipient,omitempty"`
|
||||
AllRecipients bool `json:"allRecipients,omitempty"`
|
||||
Recipient string `json:"recipient,omitempty"`
|
||||
}
|
||||
req := Request{}
|
||||
if allRecipients {
|
||||
@ -2705,7 +2705,6 @@ func (s *SignalClient) ListContacts(number string, allRecipients bool, recipient
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
|
||||
func (s *SignalClient) SetPin(number string, registrationLockPin string) error {
|
||||
if s.signalCliMode == JsonRpc {
|
||||
type Request struct {
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user