aljaz/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/signal-cli-rest-api.git synced 2025-12-21 08:34:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

added more sanity checks + restructured code a bit

Browse Source
This commit is contained in:
Bernhard B
2021-09-11 23:03:01 +02:00
parent 79fa00fdf1
commit 2a0347eea2
5 changed files with 67 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -25,7 +25,7 @@ services:
signal-cli-rest-api: signal-cli-rest-api:
image: bbernhard/signal-cli-rest-api:latest image: bbernhard/signal-cli-rest-api:latest
environment: environment:
- USE_NATIVE=0 - MODE=normal #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.

2
entrypoint.sh
View File

@@ -19,9 +19,11 @@ cap_prefix="-cap_"
caps="$cap_prefix$(seq -s ",$cap_prefix" 0 $(cat /proc/sys/kernel/cap_last_cap))" caps="$cap_prefix$(seq -s ",$cap_prefix" 0 $(cat /proc/sys/kernel/cap_last_cap))"
# TODO: check mode # TODO: check mode
if [ "$MODE" == "json-rpc" ]
/usr/bin/jsonrpc2-helper /usr/bin/jsonrpc2-helper
service supervisor start service supervisor start
supervisorctl start all supervisorctl start all
fi
# Start API as signal-api user # Start API as signal-api user
exec setpriv --reuid=1000 --regid=1000 --init-groups --inh-caps=$caps signal-cli-rest-api -signal-cli-config=${SIGNAL_CLI_CONFIG_DIR} exec setpriv --reuid=1000 --regid=1000 --init-groups --inh-caps=$caps signal-cli-rest-api -signal-cli-config=${SIGNAL_CLI_CONFIG_DIR}

49
src/client/client.go
View File

@@ -180,7 +180,7 @@ func getContainerId() (string, error) {
} }
func send(attachmentTmpDir string, signalCliConfig string, number string, message string, func send(attachmentTmpDir string, signalCliConfig string, number string, message string,
recipients []string, base64Attachments []string, isGroup bool) (string, error) { recipients []string, base64Attachments []string, isGroup bool, signalCliMode SignalCliMode) (string, error) {
cmd := []string{"--config", signalCliConfig, "-u", number, "send"} cmd := []string{"--config", signalCliConfig, "-u", number, "send"}
@@ -243,7 +243,7 @@ func send(attachmentTmpDir string, signalCliConfig string, number string, messag
cmd = append(cmd, attachmentTmpPaths...) cmd = append(cmd, attachmentTmpPaths...)
} }
resp, err := runSignalCli(true, cmd, message) resp, err := runSignalCli(true, cmd, message, signalCliMode)
if err != nil { if err != nil {
cleanupTmpFiles(attachmentTmpPaths) cleanupTmpFiles(attachmentTmpPaths)
if strings.Contains(err.Error(), signalCliV2GroupError) { if strings.Contains(err.Error(), signalCliV2GroupError) {
@@ -257,7 +257,7 @@ func send(attachmentTmpDir string, signalCliConfig string, number string, messag
return strings.TrimSuffix(resp, "\n"), nil return strings.TrimSuffix(resp, "\n"), nil
} }
func runSignalCli(wait bool, args []string, stdin string) (string, error) { func runSignalCli(wait bool, args []string, stdin string, signalCliMode SignalCliMode) (string, error) {
containerId, err := getContainerId() containerId, err := getContainerId()
log.Debug("If you want to run this command manually, run the following steps on your host system:") log.Debug("If you want to run this command manually, run the following steps on your host system:")
@@ -267,14 +267,13 @@ func runSignalCli(wait bool, args []string, stdin string) (string, error) {
log.Debug("*) docker exec -it <container id> /bin/bash") log.Debug("*) docker exec -it <container id> /bin/bash")
} }
signalCliBinary := "signal-cli" signalCliBinary := ""
if utils.GetEnv("USE_NATIVE", "0") == "1" { if signalCliMode == Normal {
if utils.GetEnv("SUPPORTS_NATIVE", "0") == "1" { signalCliBinary = "signal-cli"
} else if signalCliMode == Native {
signalCliBinary = "signal-cli-native" signalCliBinary = "signal-cli-native"
} else { } else {
log.Error("signal-cli-native is not support on this system...falling back to signal-cli") return "", errors.New("Invalid signal-cli mode")
signalCliBinary = "signal-cli"
}
} }
fullCmd := "" fullCmd := ""
@@ -406,7 +405,7 @@ func (s *SignalClient) RegisterNumber(number string, useVoice bool, captcha stri
command = append(command, []string{"--captcha", captcha}...) command = append(command, []string{"--captcha", captcha}...)
} }
_, err := runSignalCli(true, command, "") _, err := runSignalCli(true, command, "", s.signalCliMode)
return err return err
} }
@@ -417,12 +416,12 @@ func (s *SignalClient) VerifyRegisteredNumber(number string, token string, pin s
cmd = append(cmd, pin) cmd = append(cmd, pin)
} }
_, err := runSignalCli(true, cmd, "") _, err := runSignalCli(true, cmd, "", s.signalCliMode)
return err return err
} }
func (s *SignalClient) SendV1(number string, message string, recipients []string, base64Attachments []string, isGroup bool) (string, error) { func (s *SignalClient) SendV1(number string, message string, recipients []string, base64Attachments []string, isGroup bool) (string, error) {
timestamp, err := send(s.attachmentTmpDir, s.signalCliConfig, number, message, recipients, base64Attachments, isGroup) timestamp, err := send(s.attachmentTmpDir, s.signalCliConfig, number, message, recipients, base64Attachments, isGroup, s.signalCliMode)
return timestamp, err return timestamp, err
} }
@@ -463,7 +462,7 @@ func (s *SignalClient) SendV2(number string, message string, recps []string, bas
timestamps := []string{} timestamps := []string{}
for _, group := range groups { for _, group := range groups {
timestamp, err := send(s.attachmentTmpDir, s.signalCliConfig, number, message, []string{group}, base64Attachments, true) timestamp, err := send(s.attachmentTmpDir, s.signalCliConfig, number, message, []string{group}, base64Attachments, true, s.signalCliMode)
if err != nil { if err != nil {
return timestamps, err return timestamps, err
} }
@@ -471,7 +470,7 @@ func (s *SignalClient) SendV2(number string, message string, recps []string, bas
} }
if len(recipients) > 0 { if len(recipients) > 0 {
timestamp, err := send(s.attachmentTmpDir, s.signalCliConfig, number, message, recipients, base64Attachments, false) timestamp, err := send(s.attachmentTmpDir, s.signalCliConfig, number, message, recipients, base64Attachments, false, s.signalCliMode)
if err != nil { if err != nil {
return timestamps, err return timestamps, err
} }
@@ -484,7 +483,7 @@ func (s *SignalClient) SendV2(number string, message string, recps []string, bas
func (s *SignalClient) Receive(number string, timeout int64) (string, error) { func (s *SignalClient) Receive(number string, timeout int64) (string, error) {
command := []string{"--config", s.signalCliConfig, "--output", "json", "-u", number, "receive", "-t", strconv.FormatInt(timeout, 10)} command := []string{"--config", s.signalCliConfig, "--output", "json", "-u", number, "receive", "-t", strconv.FormatInt(timeout, 10)}
out, err := runSignalCli(true, command, "") out, err := runSignalCli(true, command, "", s.signalCliMode)
if err != nil { if err != nil {
return "", err return "", err
} }
@@ -542,7 +541,7 @@ func (s *SignalClient) CreateGroup(number string, name string, members []string,
cmd = append(cmd, []string{"--description", description}...) cmd = append(cmd, []string{"--description", description}...)
} }
rawData, err = runSignalCli(true, cmd, "") rawData, err = runSignalCli(true, cmd, "", s.signalCliMode)
if err != nil { if err != nil {
if strings.Contains(err.Error(), signalCliV2GroupError) { if strings.Contains(err.Error(), signalCliV2GroupError) {
return "", errors.New("Cannot create group - please first update your profile.") return "", errors.New("Cannot create group - please first update your profile.")
@@ -573,7 +572,7 @@ func (s *SignalClient) GetGroups(number string) ([]GroupEntry, error) {
return groupEntries, err return groupEntries, err
} }
} else { } else {
rawData, err = runSignalCli(true, []string{"--config", s.signalCliConfig, "--output", "json", "-u", number, "listGroups", "-d"}, "") rawData, err = runSignalCli(true, []string{"--config", s.signalCliConfig, "--output", "json", "-u", number, "listGroups", "-d"}, "", s.signalCliMode)
if err != nil { if err != nil {
return groupEntries, err return groupEntries, err
} }
@@ -625,14 +624,14 @@ func (s *SignalClient) GetGroup(number string, groupId string) (*GroupEntry, err
} }
func (s *SignalClient) DeleteGroup(number string, groupId string) error { func (s *SignalClient) DeleteGroup(number string, groupId string) error {
_, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "quitGroup", "-g", string(groupId)}, "") _, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "quitGroup", "-g", string(groupId)}, "", s.signalCliMode)
return err return err
} }
func (s *SignalClient) GetQrCodeLink(deviceName string) ([]byte, error) { func (s *SignalClient) GetQrCodeLink(deviceName string) ([]byte, error) {
command := []string{"--config", s.signalCliConfig, "link", "-n", deviceName} command := []string{"--config", s.signalCliConfig, "link", "-n", deviceName}
tsdeviceLink, err := runSignalCli(false, command, "") tsdeviceLink, err := runSignalCli(false, command, "", s.signalCliMode)
if err != nil { if err != nil {
return []byte{}, errors.New("Couldn't create QR code: " + err.Error()) return []byte{}, errors.New("Couldn't create QR code: " + err.Error())
} }
@@ -764,7 +763,7 @@ func (s *SignalClient) UpdateProfile(number string, profileName string, base64Av
cmd = append(cmd, []string{"--avatar", avatarTmpPath}...) cmd = append(cmd, []string{"--avatar", avatarTmpPath}...)
} }
_, err = runSignalCli(true, cmd, "") _, err = runSignalCli(true, cmd, "", s.signalCliMode)
} }
cleanupTmpFiles([]string{avatarTmpPath}) cleanupTmpFiles([]string{avatarTmpPath})
@@ -795,7 +794,7 @@ func (s *SignalClient) ListIdentities(number string) (*[]IdentityEntry, error) {
identityEntries = append(identityEntries, identityEntry) identityEntries = append(identityEntries, identityEntry)
} }
} else { } else {
rawData, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "listIdentities"}, "") rawData, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "listIdentities"}, "", s.signalCliMode)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -833,13 +832,13 @@ func (s *SignalClient) TrustIdentity(number string, numberToTrust string, verifi
_, err = jsonRpc2Client.getRaw("trust", request) _, err = jsonRpc2Client.getRaw("trust", request)
} else { } else {
cmd := []string{"--config", s.signalCliConfig, "-u", number, "trust", numberToTrust, "--verified-safety-number", verifiedSafetyNumber} cmd := []string{"--config", s.signalCliConfig, "-u", number, "trust", numberToTrust, "--verified-safety-number", verifiedSafetyNumber}
_, err = runSignalCli(true, cmd, "") _, err = runSignalCli(true, cmd, "", s.signalCliMode)
} }
return err return err
} }
func (s *SignalClient) BlockGroup(number string, groupId string) error { func (s *SignalClient) BlockGroup(number string, groupId string) error {
_, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "block", "-g", groupId}, "") _, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "block", "-g", groupId}, "", s.signalCliMode)
return err return err
} }
@@ -856,7 +855,7 @@ func (s *SignalClient) JoinGroup(number string, groupId string) error {
} }
_, err = jsonRpc2Client.getRaw("updateGroup", request) _, err = jsonRpc2Client.getRaw("updateGroup", request)
} else { } else {
_, err = runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "updateGroup", "-g", groupId}, "") _, err = runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "updateGroup", "-g", groupId}, "", s.signalCliMode)
} }
return err return err
} }
@@ -874,7 +873,7 @@ func (s *SignalClient) QuitGroup(number string, groupId string) error {
} }
_, err = jsonRpc2Client.getRaw("quitGroup", request) _, err = jsonRpc2Client.getRaw("quitGroup", request)
} else { } else {
_, err = runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "quitGroup", "-g", groupId}, "") _, err = runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "quitGroup", "-g", groupId}, "", s.signalCliMode)
} }
return err return err
} }

39
src/main.go
View File

@@ -73,8 +73,45 @@ func main() {
log.Fatal("Couldn't set env variable: ", err.Error()) log.Fatal("Couldn't set env variable: ", err.Error())
} }
useNative := utils.GetEnv("USE_NATIVE", "")
if useNative != "" {
log.Warning("The env variable USE_NATIVE is deprecated. Please use the env variable MODE instead")
}
signalCliMode := client.Normal
mode := utils.GetEnv("MODE", "normal")
if mode == "normal" {
signalCliMode = client.Normal
} else if mode == "json-rpc" {
signalCliMode = client.JsonRpc
} else if mode == "native" {
signalCliMode = client.Native
}
if useNative != "" {
_, modeEnvVariableSet := os.LookupEnv("MODE")
if modeEnvVariableSet {
log.Fatal("You have both the USE_NATIVE and the MODE env variable set. Please remove the deprecated env variable USE_NATIVE!")
}
}
if useNative == "1" || signalCliMode == client.Native {
if supportsSignalCliNative == "0" {
log.Error("signal-cli-native is not support on this system...falling back to signal-cli")
signalCliMode = client.Normal
}
}
if signalCliMode == client.JsonRpc {
_, autoReceiveScheduleEnvVariableSet := os.LookupEnv("AUTO_RECEIVE_SCHEDULE")
if autoReceiveScheduleEnvVariableSet {
log.Fatal("Env variable AUTO_RECEIVE_SCHEDULE can't be used with mode json-rpc")
}
}
jsonRpc2ClientConfigPathPath := *signalCliConfig + "/jsonrpc2.yml" jsonRpc2ClientConfigPathPath := *signalCliConfig + "/jsonrpc2.yml"
signalClient := client.NewSignalClient(*signalCliConfig, *attachmentTmpDir, *avatarTmpDir, client.JsonRpc, jsonRpc2ClientConfigPathPath) signalClient := client.NewSignalClient(*signalCliConfig, *attachmentTmpDir, *avatarTmpDir, signalCliMode, jsonRpc2ClientConfigPathPath)
err = signalClient.Init() err = signalClient.Init()
if err != nil { if err != nil {
log.Fatal("Couldn't init Signal Client: ", err.Error()) log.Fatal("Couldn't init Signal Client: ", err.Error())

1
src/scripts/jsonrpc2-helper.go
View File

@@ -68,7 +68,6 @@ func main() {
supervisorctlConfigFilename := "/etc/supervisor/conf.d/" + "signal-cli-json-rpc-" + strconv.FormatInt(ctr, 10) + ".conf" supervisorctlConfigFilename := "/etc/supervisor/conf.d/" + "signal-cli-json-rpc-" + strconv.FormatInt(ctr, 10) + ".conf"
supervisorctlConfig := fmt.Sprintf(supervisorctlConfigTemplate, supervisorctlProgramName, supervisorctlProgramName, supervisorctlConfig := fmt.Sprintf(supervisorctlConfigTemplate, supervisorctlProgramName, supervisorctlProgramName,
tcpPort, fifoPathname, filename, fifoPathname, supervisorctlProgramName, supervisorctlProgramName) tcpPort, fifoPathname, filename, fifoPathname, supervisorctlProgramName, supervisorctlProgramName)
log.Info(supervisorctlConfig)
err = ioutil.WriteFile(supervisorctlConfigFilename, []byte(supervisorctlConfig), 0644) err = ioutil.WriteFile(supervisorctlConfigFilename, []byte(supervisorctlConfig), 0644)
if err != nil { if err != nil {
log.Fatal("Couldn't write ", supervisorctlConfigFilename, ": ", err.Error()) log.Fatal("Couldn't write ", supervisorctlConfigFilename, ": ", err.Error())