nik/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/bbernhard/signal-cli-rest-api.git synced 2026-05-21 13:54:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge 331a3722960309cec101ea7a028d2b3c154f1e53 into e5e21518a5b0a1898e3f47334a76348f11f1a343

Browse Source
This commit is contained in:
jailson-dias 2026-01-19 12:44:08 +00:00 committed by GitHub
commit 0aa1907f55
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 207 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
Dockerfile
View File

@ -55,9 +55,9 @@ ENV LANG en_US.UTF-8
RUN go install github.com/swaggo/swag/cmd/swag@v${SWAG_VERSION} RUN go install github.com/swaggo/swag/cmd/swag@v${SWAG_VERSION}
RUN cd /tmp/ \ # RUN cd /tmp/ \
&& wget -nv https://github.com/AsamK/signal-cli/releases/download/v${SIGNAL_CLI_VERSION}/signal-cli-${SIGNAL_CLI_VERSION}.tar.gz -O /tmp/signal-cli.tar.gz \ # && wget -nv https://github.com/AsamK/signal-cli/releases/download/v${SIGNAL_CLI_VERSION}/signal-cli-${SIGNAL_CLI_VERSION}.tar.gz -O /tmp/signal-cli.tar.gz \
&& tar xf signal-cli.tar.gz # && tar xf signal-cli.tar.gz
# build native image with graalvm # build native image with graalvm
@ -69,23 +69,91 @@ RUN arch="$(uname -m)"; \
*) echo "Invalid architecture" ;; \ *) echo "Invalid architecture" ;; \
esac; esac;
RUN if [ "$(uname -m)" = "x86_64" ]; then \ COPY signal-cli /tmp/signal-cli
cd /tmp \
&& git clone https://github.com/AsamK/signal-cli.git signal-cli-${SIGNAL_CLI_VERSION}-source \ # RUN if [ "$(uname -m)" = "x86_64" ]; then \
&& cd signal-cli-${SIGNAL_CLI_VERSION}-source \ # cd /tmp \
&& git checkout -q v${SIGNAL_CLI_VERSION} \ # && git clone https://github.com/AsamK/signal-cli.git signal-cli-${SIGNAL_CLI_VERSION}-source \
&& cd /tmp && mkdir -p /tmp/graalvm && tar xf gvm.tar.gz -C /tmp/graalvm --strip-components=1 \ # && cd signal-cli-${SIGNAL_CLI_VERSION}-source \
# && git checkout -q v${SIGNAL_CLI_VERSION} \
# && 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 \
# && cd /tmp/signal-cli-${SIGNAL_CLI_VERSION}-source \
# && 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) \
# && cd /tmp \
# && cp signal-cli-${SIGNAL_CLI_VERSION}-source/build/install/signal-cli/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar libsignal-client.jar \
# && zip -qu libsignal-client.jar libsignal_jni.so \
# && cd /tmp/signal-cli-${SIGNAL_CLI_VERSION}-source \
# && git apply /tmp/signal-cli-native.patch \
# && git apply /tmp/signal-cli-native-arch.patch \
# && ./gradlew -q nativeCompile; \
# elif [ "$(uname -m)" = "aarch64" ] ; then \
# echo "Use native image from @morph027 (https://packaging.gitlab.io/signal-cli/) for arm64 - many thanks to @morph027" \
# && curl -fsSL https://packaging.gitlab.io/signal-cli/gpg.key | apt-key add - \
# && echo "deb https://packaging.gitlab.io/signal-cli focal main" > /etc/apt/sources.list.d/morph027-signal-cli.list \
# && mkdir -p /tmp/signal-cli-native \
# && cd /tmp/signal-cli-native \
# #&& wget https://gitlab.com/packaging/signal-cli/-/jobs/3716873649/artifacts/download?file_type=archive -O /tmp/signal-cli-native/archive.zip \
# #&& unzip archive.zip \
# #&& mv signal-cli-native-arm64/*deb . \
# && apt-get -qq update \
# && apt-get -qq download signal-cli-native=${SIGNAL_CLI_NATIVE_PACKAGE_VERSION} < /dev/null > /dev/null \
# && ar x *.deb \
# && tar xf data.tar.gz \
# && mkdir -p /tmp/signal-cli-${SIGNAL_CLI_VERSION}-source/build/native/nativeCompile \
# && cp /tmp/signal-cli-native/usr/bin/signal-cli-native /tmp/signal-cli-${SIGNAL_CLI_VERSION}-source/build/native/nativeCompile/signal-cli; \
# elif [ "$(uname -m)" = "armv7l" ] ; then \
# echo "GRAALVM doesn't support 32bit" \
# && echo "Creating temporary file, otherwise the below copy doesn't work for armv7" \
# && mkdir -p /tmp/signal-cli-${SIGNAL_CLI_VERSION}-source/build/native/nativeCompile \
# && touch /tmp/signal-cli-${SIGNAL_CLI_VERSION}-source/build/native/nativeCompile/signal-cli; \
# else \
# echo "Unknown architecture"; \
# fi;
RUN cd /tmp && mkdir -p /tmp/graalvm && tar xf gvm.tar.gz -C /tmp/graalvm --strip-components=1
RUN cd /tmp/signal-cli \
&& sed -i 's/Signal-Android\/5.22.3/Signal-Android\/5.51.7/g' src/main/java/org/asamk/signal/BaseConfig.java
RUN cd /tmp/signal-cli \
&& export GRAALVM_HOME=/tmp/graalvm \
&& export PATH=/tmp/graalvm/bin:$PATH \
&& ./gradlew build
RUN cd /tmp/signal-cli \
&& export GRAALVM_HOME=/tmp/graalvm \
&& export PATH=/tmp/graalvm/bin:$PATH \
&& ./gradlew installDist
RUN cd /tmp/signal-cli \
&& export GRAALVM_HOME=/tmp/graalvm \
&& export PATH=/tmp/graalvm/bin:$PATH \
&& ./gradlew distTar
RUN cd /tmp/signal-cli \
&& export GRAALVM_HOME=/tmp/graalvm \
&& export PATH=/tmp/graalvm/bin:$PATH \
&& ./gradlew fatJar
RUN cd /tmp/signal-cli \
&& export GRAALVM_HOME=/tmp/graalvm \
&& export PATH=/tmp/graalvm/bin:$PATH \
&& ./gradlew run --args="--help"
RUN cd /tmp/signal-cli \
&& 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)
RUN cd /tmp \
&& cp signal-cli/build/install/signal-cli/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar libsignal-client.jar \
&& zip -qu libsignal-client.jar libsignal_jni.so
RUN cd /tmp/signal-cli \
&& export GRAALVM_HOME=/tmp/graalvm \ && export GRAALVM_HOME=/tmp/graalvm \
&& export PATH=/tmp/graalvm/bin:$PATH \ && export PATH=/tmp/graalvm/bin:$PATH \
&& cd /tmp/signal-cli-${SIGNAL_CLI_VERSION}-source \
&& 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) \
&& cd /tmp \
&& cp signal-cli-${SIGNAL_CLI_VERSION}-source/build/install/signal-cli/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar libsignal-client.jar \
&& zip -qu libsignal-client.jar libsignal_jni.so \
&& cd /tmp/signal-cli-${SIGNAL_CLI_VERSION}-source \
&& git apply /tmp/signal-cli-native.patch \ && git apply /tmp/signal-cli-native.patch \
&& ./gradlew -q nativeCompile; \ && ./gradlew -q nativeCompile; \
elif [ "$(uname -m)" = "aarch64" ] ; then \ elif [ "$(uname -m)" = "aarch64" ] ; then \
@ -114,21 +182,30 @@ RUN if [ "$(uname -m)" = "x86_64" ]; then \
# replace libsignal-client # replace libsignal-client
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) RUN cp /tmp/signal-cli/build/install/signal-cli/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar /tmp/signal-cli/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar
# RUN ls /tmp/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 /tmp/signal-cli/lib/libsignal-client-* && echo "\n\n" && exit 1)
RUN cp /tmp/signal-cli/build/install/signal-cli/lib/signal-cli-*.jar /tmp/signal-cli/lib/
# replace libsignal-client
# 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)
RUN ls /tmp/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 /tmp/signal-cli/lib/libsignal-client-* && echo "\n\n" && exit 1)
# workaround until upstream is fixed # workaround until upstream is fixed
RUN cd /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib \ RUN cd /tmp/signal-cli/lib \
&& unzip signal-cli-${SIGNAL_CLI_VERSION}.jar \ && unzip signal-cli*.jar \
&& sed -i 's/Signal-Android\/5.22.3/Signal-Android\/5.51.7/g' org/asamk/signal/BaseConfig.class \ && 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/ \ && zip -r signal-cli*.jar org/ META-INF/ \
&& rm -rf META-INF \ && rm -rf META-INF \
&& rm -rf org && rm -rf org
RUN cd /tmp/ \ RUN cd /tmp/ \
&& zip -qu /tmp/signal-cli-${SIGNAL_CLI_VERSION}/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar libsignal_jni.so \ && zip -qu /tmp/signal-cli/lib/libsignal-client-${LIBSIGNAL_CLIENT_VERSION}.jar libsignal_jni.so \
&& zip -qr signal-cli-${SIGNAL_CLI_VERSION}.zip signal-cli-${SIGNAL_CLI_VERSION}/* \ && zip -qr signal-cli.zip signal-cli/* \
&& unzip -q /tmp/signal-cli-${SIGNAL_CLI_VERSION}.zip -d /opt \ && unzip -q /tmp/signal-cli.zip -d /opt \
&& rm -f /tmp/signal-cli-${SIGNAL_CLI_VERSION}.zip && rm -f /tmp/signal-cli.zip
COPY src/api /tmp/signal-cli-rest-api-src/api COPY src/api /tmp/signal-cli-rest-api-src/api
COPY src/client /tmp/signal-cli-rest-api-src/client COPY src/client /tmp/signal-cli-rest-api-src/client
@ -176,8 +253,8 @@ RUN dpkg-reconfigure debconf --frontend=noninteractive \
&& rm -rf /var/lib/apt/lists/* && 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 COPY --from=buildcontainer /tmp/signal-cli-rest-api-src/signal-cli-rest-api /usr/bin/signal-cli-rest-api
COPY --from=buildcontainer /opt/signal-cli-${SIGNAL_CLI_VERSION} /opt/signal-cli-${SIGNAL_CLI_VERSION} COPY --from=buildcontainer /tmp/signal-cli/build/install/signal-cli /opt/signal-cli-${SIGNAL_CLI_VERSION}
COPY --from=buildcontainer /tmp/signal-cli-${SIGNAL_CLI_VERSION}-source/build/native/nativeCompile/signal-cli /opt/signal-cli-${SIGNAL_CLI_VERSION}/bin/signal-cli-native COPY --from=buildcontainer /tmp/signal-cli/build/native/nativeCompile/signal-cli /opt/signal-cli-${SIGNAL_CLI_VERSION}/bin/signal-cli-native
COPY --from=buildcontainer /tmp/signal-cli-rest-api-src/scripts/jsonrpc2-helper /usr/bin/jsonrpc2-helper COPY --from=buildcontainer /tmp/signal-cli-rest-api-src/scripts/jsonrpc2-helper /usr/bin/jsonrpc2-helper
COPY --from=buildcontainer /tmp/signal-cli-rest-api-src/signal-cli-rest-api_plugin_loader.so /usr/bin/signal-cli-rest-api_plugin_loader.so COPY --from=buildcontainer /tmp/signal-cli-rest-api-src/signal-cli-rest-api_plugin_loader.so /usr/bin/signal-cli-rest-api_plugin_loader.so
COPY entrypoint.sh /entrypoint.sh COPY entrypoint.sh /entrypoint.sh

12
README.md
View File

@ -157,3 +157,15 @@ There are a bunch of environmental variables that can be set inside the docker c
* `JSON_RPC_IGNORE_ATTACHMENTS`: When set to `true`, attachments are not automatically downloaded in json-rpc mode (default: `false`) * `JSON_RPC_IGNORE_ATTACHMENTS`: When set to `true`, attachments are not automatically downloaded in json-rpc mode (default: `false`)
* `JSON_RPC_IGNORE_STORIES`: When set to `true`, stories are not automatically downloaded in json-rpc mode (default: `false`) * `JSON_RPC_IGNORE_STORIES`: When set to `true`, stories are not automatically downloaded in json-rpc mode (default: `false`)
* `JSON_RPC_TRUST_NEW_IDENTITIES`: Choose how to trust new identities in json-rpc mode. Supported values: `on-first-use`, `always`, `never`. (default: `on-first-use`) * `JSON_RPC_TRUST_NEW_IDENTITIES`: Choose how to trust new identities in json-rpc mode. Supported values: `on-first-use`, `always`, `never`. (default: `on-first-use`)
remove-cache:
docker builder prune --all --force
docker buildx prune --all -f
docker builder prune --all --force
docker buildx build --memory=8g --memory-swap=8g --platform linux/amd64 -f ./Dockerfile -t jailsondias/signal:latest .. --progress=plain

11
docker-compose.yml
View File

@ -1,11 +1,14 @@
version: "3" version: "3"
services: services:
signal-cli-rest-api: signal:
image: bbernhard/signal-cli-rest-api:latest # image: bbernhard/signal-cli-rest-api:latest
build:
context: ../
dockerfile: signal-cli-rest-api/Dockerfile
environment: environment:
- MODE=normal #supported modes: json-rpc, native, normal - MODE=native #supported modes: json-rpc, native, normal
#- AUTO_RECEIVE_SCHEDULE=0 22 * * * #enable this parameter on demand (see description below) #- AUTO_RECEIVE_SCHEDULE=0 22 * * * #enable this parameter on demand (see description below)
ports: ports:
- "8080:8080" #map docker port 8080 to host port 8080. - "8080:8080" #map docker port 8080 to host port 8080.
volumes: 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 - "../tip-crawlers-v2/cf/services/signal/signal:/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

54
src/api/api.go
View File

@ -1546,6 +1546,60 @@ func (a *Api) JoinGroup(c *gin.Context) {
c.Status(http.StatusNoContent) c.Status(http.StatusNoContent)
} }
// @Summary Join a Signal Group by invite link.
// @Tags Groups
// @Description Join the specified Signal Group by invite link.
// @Accept json
// @Produce json
// @Success 204 {string} OK
// @Failure 400 {object} Error
// @Param number path string true "Registered Phone Number"
// @Query invite_link query string true "Invite Link"
// @Router /v1/groups/{number}/join_by_invite_link [post]
func (a *Api) JoinGroupByInviteLink(c *gin.Context) {
number := c.Param("number")
if number == "" {
c.JSON(400, Error{Msg: "Couldn't process request - number missing"})
return
}
inviteLink := c.Query("invite_link")
err := a.signalClient.JoinGroupByInviteLink(number, inviteLink)
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
}
c.Status(http.StatusNoContent)
}
// @Summary Get a Signal Group info by invite link.
// @Tags Groups
// @Description Get the specified Signal Group info by invite link.
// @Accept json
// @Produce json
// @Success 200 {string} OK
// @Failure 400 {object} Error
// @Param number path string true "Registered Phone Number"
// @Query invite_link query string true "Invite Link"
// @Router /v1/groups/{number}/join_info_by_invite_link [get]
func (a *Api) GetJoinGroupInfoByInviteLink(c *gin.Context) {
number := c.Param("number")
if number == "" {
c.JSON(400, Error{Msg: "Couldn't process request - number missing"})
return
}
inviteLink := c.Query("invite_link")
jsonStr, err := a.signalClient.GetJoinGroupInfoByInviteLink(number, inviteLink)
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
}
c.String(200, jsonStr)
}
// @Summary Quit a Signal Group. // @Summary Quit a Signal Group.
// @Tags Groups // @Tags Groups
// @Description Quit the specified Signal Group. // @Description Quit the specified Signal Group.

26
src/client/client.go
View File

@ -1875,6 +1875,32 @@ func (s *SignalClient) JoinGroup(number string, groupId string) error {
return err return err
} }
func (s *SignalClient) JoinGroupByInviteLink(number string, inviteLink string) error {
var err error
if s.signalCliMode == JsonRpc {
type Request struct {
InviteLink string `json:"uri"`
}
request := Request{InviteLink: inviteLink}
jsonRpc2Client, err := s.getJsonRpc2Client()
if err != nil {
return err
}
_, err = jsonRpc2Client.getRaw("joinGroup", &number, request)
} else {
_, err = s.cliClient.Execute(true, []string{"--config", s.signalCliConfig, "-a", number, "joinGroup", "--uri", inviteLink}, "")
}
return err
}
func (s *SignalClient) GetJoinGroupInfoByInviteLink(number string, inviteLink string) (string, error) {
if s.signalCliMode == JsonRpc {
return "", errors.New("Not implemented")
}
return s.cliClient.Execute(true, []string{"--config", s.signalCliConfig, "--output", "json", "-a", number, "getJoinGroupInfo", "--uri", inviteLink}, "")
}
func (s *SignalClient) QuitGroup(number string, groupId string) error { func (s *SignalClient) QuitGroup(number string, groupId string) error {
var err error var err error
if s.signalCliMode == JsonRpc { if s.signalCliMode == JsonRpc {

2
src/main.go
View File

@ -214,6 +214,8 @@ func main() {
{ {
groups.POST(":number", api.CreateGroup) groups.POST(":number", api.CreateGroup)
groups.GET(":number", api.GetGroups) groups.GET(":number", api.GetGroups)
groups.POST(":number/join_by_invite_link", api.JoinGroupByInviteLink)
groups.GET(":number/join_info_by_invite_link", api.GetJoinGroupInfoByInviteLink)
groups.GET(":number/:groupid", api.GetGroup) groups.GET(":number/:groupid", api.GetGroup)
groups.GET(":number/:groupid/avatar", api.GetGroupAvatar) groups.GET(":number/:groupid/avatar", api.GetGroupAvatar)
groups.DELETE(":number/:groupid", api.DeleteGroup) groups.DELETE(":number/:groupid", api.DeleteGroup)