move signal-cli specific code into own library

* still WIP and APIs might change lateron, but at least it compiles.

see #150
This commit is contained in:
Bernhard B
2021-09-05 18:25:12 +02:00
parent 85dfe199f3
commit 1295fd7452
4 changed files with 830 additions and 579 deletions

View File

@@ -1,45 +1,19 @@
package api package api
import ( import (
"bufio"
"bytes" "bytes"
"encoding/base64"
"encoding/json" "encoding/json"
"errors"
"io/ioutil"
"net/http" "net/http"
"os"
"os/exec"
"path/filepath"
"strconv" "strconv"
"strings"
"time"
"github.com/cyphar/filepath-securejoin"
"github.com/gabriel-vasile/mimetype" "github.com/gabriel-vasile/mimetype"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
uuid "github.com/gofrs/uuid"
"github.com/h2non/filetype"
log "github.com/sirupsen/logrus" log "github.com/sirupsen/logrus"
qrcode "github.com/skip2/go-qrcode"
"github.com/bbernhard/signal-cli-rest-api/client"
utils "github.com/bbernhard/signal-cli-rest-api/utils" utils "github.com/bbernhard/signal-cli-rest-api/utils"
) )
const signalCliV2GroupError = "Cannot create a V2 group as self does not have a versioned profile"
const groupPrefix = "group."
type GroupEntry struct {
Name string `json:"name"`
Id string `json:"id"`
InternalId string `json:"internal_id"`
Members []string `json:"members"`
Blocked bool `json:"blocked"`
PendingInvites []string `json:"pending_invites"`
PendingRequests []string `json:"pending_requests"`
InviteLink string `json:"invite_link"`
}
type GroupPermissions struct { type GroupPermissions struct {
AddMembers string `json:"add_members" enums:"only-admins,every-member"` AddMembers string `json:"add_members" enums:"only-admins,every-member"`
EditGroup string `json:"edit_group" enums:"only-admins,every-member"` EditGroup string `json:"edit_group" enums:"only-admins,every-member"`
@@ -61,25 +35,6 @@ type Configuration struct {
Logging LoggingConfiguration `json:"logging"` Logging LoggingConfiguration `json:"logging"`
} }
type SignalCliGroupEntry struct {
Name string `json:"name"`
Id string `json:"id"`
IsMember bool `json:"isMember"`
IsBlocked bool `json:"isBlocked"`
Members []string `json:"members"`
PendingMembers []string `json:"pendingMembers"`
RequestingMembers []string `json:"requestingMembers"`
GroupInviteLink string `json:"groupInviteLink"`
}
type IdentityEntry struct {
Number string `json:"number"`
Status string `json:"status"`
Fingerprint string `json:"fingerprint"`
Added string `json:"added"`
SafetyNumber string `json:"safety_number"`
}
type RegisterNumberRequest struct { type RegisterNumberRequest struct {
UseVoice bool `json:"use_voice"` UseVoice bool `json:"use_voice"`
Captcha string `json:"captcha"` Captcha string `json:"captcha"`
@@ -108,10 +63,7 @@ type Error struct {
Msg string `json:"error"` Msg string `json:"error"`
} }
type About struct {
SupportedApiVersions []string `json:"versions"`
BuildNr int `json:"build"`
}
type CreateGroupResponse struct { type CreateGroupResponse struct {
Id string `json:"id"` Id string `json:"id"`
@@ -130,293 +82,13 @@ type SendMessageResponse struct {
Timestamp string `json:"timestamp"` Timestamp string `json:"timestamp"`
} }
func convertInternalGroupIdToGroupId(internalId string) string {
return groupPrefix + base64.StdEncoding.EncodeToString([]byte(internalId))
}
func convertGroupIdToInternalGroupId(id string) (string, error) {
groupIdWithoutPrefix := strings.TrimPrefix(id, groupPrefix)
internalGroupId, err := base64.StdEncoding.DecodeString(groupIdWithoutPrefix)
if err != nil {
return "", errors.New("Invalid group id")
}
return string(internalGroupId), err
}
func getStringInBetween(str string, start string, end string) (result string) {
i := strings.Index(str, start)
if i == -1 {
return
}
i += len(start)
j := strings.Index(str[i:], end)
if j == -1 {
return
}
return str[i : i+j]
}
func cleanupTmpFiles(paths []string) {
for _, path := range paths {
os.Remove(path)
}
}
func getContainerId() (string, error) {
data, err := ioutil.ReadFile("/proc/1/cpuset")
if err != nil {
return "", err
}
lines := strings.Split(string(data), "\n")
if len(lines) == 0 {
return "", errors.New("Couldn't get docker container id (empty)")
}
containerId := strings.Replace(lines[0], "/docker/", "", -1)
return containerId, nil
}
func send(c *gin.Context, attachmentTmpDir string, signalCliConfig string, number string, message string,
recipients []string, base64Attachments []string, isGroup bool) {
cmd := []string{"--config", signalCliConfig, "-u", number, "send"}
if len(recipients) == 0 {
c.JSON(400, gin.H{"error": "Please specify at least one recipient"})
return
}
if !isGroup {
cmd = append(cmd, recipients...)
} else {
if len(recipients) > 1 {
c.JSON(400, gin.H{"error": "More than one recipient is currently not allowed"})
return
}
groupId, err := base64.StdEncoding.DecodeString(recipients[0])
if err != nil {
c.JSON(400, gin.H{"error": "Invalid group id"})
return
}
cmd = append(cmd, []string{"-g", string(groupId)}...)
}
attachmentTmpPaths := []string{}
for _, base64Attachment := range base64Attachments {
u, err := uuid.NewV4()
if err != nil {
c.JSON(400, gin.H{"error": err.Error()})
return
}
dec, err := base64.StdEncoding.DecodeString(base64Attachment)
if err != nil {
c.JSON(400, gin.H{"error": err.Error()})
return
}
mimeType := mimetype.Detect(dec)
attachmentTmpPath := attachmentTmpDir + u.String() + mimeType.Extension()
attachmentTmpPaths = append(attachmentTmpPaths, attachmentTmpPath)
f, err := os.Create(attachmentTmpPath)
if err != nil {
c.JSON(400, gin.H{"error": err.Error()})
return
}
defer f.Close()
if _, err := f.Write(dec); err != nil {
cleanupTmpFiles(attachmentTmpPaths)
c.JSON(400, gin.H{"error": err.Error()})
return
}
if err := f.Sync(); err != nil {
cleanupTmpFiles(attachmentTmpPaths)
c.JSON(400, gin.H{"error": err.Error()})
return
}
f.Close()
}
if len(attachmentTmpPaths) > 0 {
cmd = append(cmd, "-a")
cmd = append(cmd, attachmentTmpPaths...)
}
resp, err := runSignalCli(true, cmd, message)
if err != nil {
cleanupTmpFiles(attachmentTmpPaths)
if strings.Contains(err.Error(), signalCliV2GroupError) {
c.JSON(400, Error{Msg: "Cannot send message to group - please first update your profile."})
} else {
c.JSON(400, Error{Msg: err.Error()})
}
return
}
sendMessageResponse := SendMessageResponse{Timestamp: strings.TrimSuffix(resp, "\n")}
cleanupTmpFiles(attachmentTmpPaths)
c.JSON(201, sendMessageResponse)
}
func parseWhitespaceDelimitedKeyValueStringList(in string, keys []string) []map[string]string {
l := []map[string]string{}
lines := strings.Split(in, "\n")
for _, line := range lines {
if line == "" {
continue
}
m := make(map[string]string)
temp := line
for i, key := range keys {
if i == 0 {
continue
}
idx := strings.Index(temp, " "+key+": ")
pair := temp[:idx]
value := strings.TrimPrefix(pair, key+": ")
temp = strings.TrimLeft(temp[idx:], " "+key+": ")
m[keys[i-1]] = value
}
m[keys[len(keys)-1]] = temp
l = append(l, m)
}
return l
}
func getGroups(number string, signalCliConfig string) ([]GroupEntry, error) {
groupEntries := []GroupEntry{}
out, err := runSignalCli(true, []string{"--config", signalCliConfig, "--output", "json", "-u", number, "listGroups", "-d"}, "")
if err != nil {
return groupEntries, err
}
var signalCliGroupEntries []SignalCliGroupEntry
err = json.Unmarshal([]byte(out), &signalCliGroupEntries)
if err != nil {
return groupEntries, err
}
for _, signalCliGroupEntry := range signalCliGroupEntries {
var groupEntry GroupEntry
groupEntry.InternalId = signalCliGroupEntry.Id
groupEntry.Name = signalCliGroupEntry.Name
groupEntry.Id = convertInternalGroupIdToGroupId(signalCliGroupEntry.Id)
groupEntry.Blocked = signalCliGroupEntry.IsBlocked
groupEntry.Members = signalCliGroupEntry.Members
groupEntry.PendingRequests = signalCliGroupEntry.PendingMembers
groupEntry.PendingInvites = signalCliGroupEntry.RequestingMembers
groupEntry.InviteLink = signalCliGroupEntry.GroupInviteLink
groupEntries = append(groupEntries, groupEntry)
}
return groupEntries, nil
}
func runSignalCli(wait bool, args []string, stdin string) (string, error) {
containerId, err := getContainerId()
log.Debug("If you want to run this command manually, run the following steps on your host system:")
if err == nil {
log.Debug("*) docker exec -it ", containerId, " /bin/bash")
} else {
log.Debug("*) docker exec -it <container id> /bin/bash")
}
signalCliBinary := "signal-cli"
if utils.GetEnv("USE_NATIVE", "0") == "1" {
if utils.GetEnv("SUPPORTS_NATIVE", "0") == "1" {
signalCliBinary = "signal-cli-native"
} else {
log.Error("signal-cli-native is not support on this system...falling back to signal-cli")
signalCliBinary = "signal-cli"
}
}
fullCmd := ""
if(stdin != "") {
fullCmd += "echo '" + stdin + "' | "
}
fullCmd += signalCliBinary + " " + strings.Join(args, " ")
log.Debug("*) su signal-api")
log.Debug("*) ", fullCmd)
cmdTimeout, err := utils.GetIntEnv("SIGNAL_CLI_CMD_TIMEOUT", 120)
if err != nil {
log.Error("Env variable 'SIGNAL_CLI_CMD_TIMEOUT' contains an invalid timeout...falling back to default timeout (120 seconds)")
cmdTimeout = 120
}
cmd := exec.Command(signalCliBinary, args...)
if stdin != "" {
cmd.Stdin = strings.NewReader(stdin)
}
if wait {
var errBuffer bytes.Buffer
var outBuffer bytes.Buffer
cmd.Stderr = &errBuffer
cmd.Stdout = &outBuffer
err := cmd.Start()
if err != nil {
return "", err
}
done := make(chan error, 1)
go func() {
done <- cmd.Wait()
}()
select {
case <-time.After(time.Duration(cmdTimeout) * time.Second):
err := cmd.Process.Kill()
if err != nil {
return "", err
}
return "", errors.New("process killed as timeout reached")
case err := <-done:
if err != nil {
return "", errors.New(errBuffer.String())
}
}
return outBuffer.String(), nil
} else {
stdout, err := cmd.StdoutPipe()
if err != nil {
return "", err
}
cmd.Start()
buf := bufio.NewReader(stdout) // Notice that this is not in a loop
line, _, _ := buf.ReadLine()
return string(line), nil
}
}
type Api struct { type Api struct {
signalCliConfig string signalClient *client.SignalClient
attachmentTmpDir string
avatarTmpDir string
} }
func NewApi(signalCliConfig string, attachmentTmpDir string, avatarTmpDir string) *Api { func NewApi(signalClient *client.SignalClient) *Api {
return &Api{ return &Api{
signalCliConfig: signalCliConfig, signalClient: signalClient,
attachmentTmpDir: attachmentTmpDir,
avatarTmpDir: avatarTmpDir,
} }
} }
@@ -427,9 +99,7 @@ func NewApi(signalCliConfig string, attachmentTmpDir string, avatarTmpDir string
// @Success 200 {object} About // @Success 200 {object} About
// @Router /v1/about [get] // @Router /v1/about [get]
func (a *Api) About(c *gin.Context) { func (a *Api) About(c *gin.Context) {
c.JSON(200, a.signalClient.About())
about := About{SupportedApiVersions: []string{"v1", "v2"}, BuildNr: 2}
c.JSON(200, about)
} }
// @Summary Register a phone number. // @Summary Register a phone number.
@@ -466,17 +136,7 @@ func (a *Api) RegisterNumber(c *gin.Context) {
return return
} }
command := []string{"--config", a.signalCliConfig, "-u", number, "register"} err := a.signalClient.RegisterNumber(number, req.UseVoice, req.Captcha)
if req.UseVoice == true {
command = append(command, "--voice")
}
if req.Captcha != "" {
command = append(command, []string{"--captcha", req.Captcha}...)
}
_, err := runSignalCli(true, command, "")
if err != nil { if err != nil {
c.JSON(400, gin.H{"error": err.Error()}) c.JSON(400, gin.H{"error": err.Error()})
return return
@@ -523,13 +183,7 @@ func (a *Api) VerifyRegisteredNumber(c *gin.Context) {
return return
} }
cmd := []string{"--config", a.signalCliConfig, "-u", number, "verify", token} err := a.signalClient.VerifyRegisteredNumber(number, token, pin)
if pin != "" {
cmd = append(cmd, "--pin")
cmd = append(cmd, pin)
}
_, err := runSignalCli(true, cmd, "")
if err != nil { if err != nil {
c.JSON(400, gin.H{"error": err.Error()}) c.JSON(400, gin.H{"error": err.Error()})
return return
@@ -552,7 +206,7 @@ func (a *Api) Send(c *gin.Context) {
var req SendMessageV1 var req SendMessageV1
err := c.BindJSON(&req) err := c.BindJSON(&req)
if err != nil { if err != nil {
c.JSON(400, gin.H{"error": "Couldn't process request - invalid request"}) c.JSON(400, Error{Msg: "Couldn't process request - invalid request"})
return return
} }
@@ -561,7 +215,12 @@ func (a *Api) Send(c *gin.Context) {
base64Attachments = append(base64Attachments, req.Base64Attachment) base64Attachments = append(base64Attachments, req.Base64Attachment)
} }
send(c, a.signalCliConfig, a.signalCliConfig, req.Number, req.Message, req.Recipients, base64Attachments, req.IsGroup) timestamp, err := a.signalClient.SendV1(req.Number, req.Message, req.Recipients, base64Attachments, req.IsGroup)
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
}
c.JSON(201, SendMessageResponse{Timestamp: timestamp})
} }
// @Summary Send a signal message. // @Summary Send a signal message.
@@ -587,34 +246,18 @@ func (a *Api) SendV2(c *gin.Context) {
return return
} }
groups := []string{} if req.Number == "" {
recipients := []string{} c.JSON(400, gin.H{"error": "Couldn't process request - please provide a valid number"})
for _, recipient := range req.Recipients {
if strings.HasPrefix(recipient, groupPrefix) {
groups = append(groups, strings.TrimPrefix(recipient, groupPrefix))
} else {
recipients = append(recipients, recipient)
}
}
if len(recipients) > 0 && len(groups) > 0 {
c.JSON(400, gin.H{"error": "Signal Messenger Groups and phone numbers cannot be specified together in one request! Please split them up into multiple REST API calls."})
return return
} }
if len(groups) > 1 { timestamps, err := a.signalClient.SendV2(req.Number, req.Message, req.Recipients, req.Base64Attachments)
c.JSON(400, gin.H{"error": "A signal message cannot be sent to more than one group at once! Please use multiple REST API calls for that."}) if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return return
} }
for _, group := range groups { c.JSON(201, SendMessageResponse{Timestamp: timestamps[0]})
send(c, a.attachmentTmpDir, a.signalCliConfig, req.Number, req.Message, []string{group}, req.Base64Attachments, true)
}
if len(recipients) > 0 {
send(c, a.attachmentTmpDir, a.signalCliConfig, req.Number, req.Message, recipients, req.Base64Attachments, false)
}
} }
// @Summary Receive Signal Messages. // @Summary Receive Signal Messages.
@@ -631,25 +274,17 @@ func (a *Api) Receive(c *gin.Context) {
number := c.Param("number") number := c.Param("number")
timeout := c.DefaultQuery("timeout", "1") timeout := c.DefaultQuery("timeout", "1")
timeoutInt, err := strconv.ParseInt(timeout, 10, 32)
command := []string{"--config", a.signalCliConfig, "--output", "json", "-u", number, "receive", "-t", timeout}
out, err := runSignalCli(true, command, "")
if err != nil { if err != nil {
c.JSON(400, gin.H{"error": err.Error()}) c.JSON(400, Error{Msg: "Couldn't process request - timeout needs to be numeric!"})
return return
} }
out = strings.Trim(out, "\n") jsonStr, err := a.signalClient.Receive(number, timeoutInt)
lines := strings.Split(out, "\n") if err != nil {
c.JSON(400, Error{Msg: err.Error()})
jsonStr := "[" return
for i, line := range lines {
jsonStr += line
if i != (len(lines) - 1) {
jsonStr += ","
}
} }
jsonStr += "]"
c.String(200, jsonStr) c.String(200, jsonStr)
} }
@@ -670,57 +305,36 @@ func (a *Api) CreateGroup(c *gin.Context) {
var req CreateGroupRequest var req CreateGroupRequest
err := c.BindJSON(&req) err := c.BindJSON(&req)
if err != nil { if err != nil {
c.JSON(400, gin.H{"error": "Couldn't process request - invalid request"}) c.JSON(400, Error{Msg: "Couldn't process request - invalid request"})
log.Error(err.Error())
return return
} }
if req.Permissions.AddMembers != "" && !utils.StringInSlice(req.Permissions.AddMembers, []string{"every-member", "only-admins"}) { if req.Permissions.AddMembers != "" && !utils.StringInSlice(req.Permissions.AddMembers, []string{"every-member", "only-admins"}) {
c.JSON(400, gin.H{"error": "Invalid add members permission provided - only 'every-member' and 'only-admins' allowed!"}) c.JSON(400, Error{Msg: "Invalid add members permission provided - only 'every-member' and 'only-admins' allowed!"})
return return
} }
if req.Permissions.EditGroup != "" && !utils.StringInSlice(req.Permissions.EditGroup, []string{"every-member", "only-admins"}) { if req.Permissions.EditGroup != "" && !utils.StringInSlice(req.Permissions.EditGroup, []string{"every-member", "only-admins"}) {
c.JSON(400, gin.H{"error": "Invalid edit group permissions provided - only 'every-member' and 'only-admins' allowed!"}) c.JSON(400, Error{Msg: "Invalid edit group permissions provided - only 'every-member' and 'only-admins' allowed!"})
return return
} }
if req.GroupLinkState != "" && !utils.StringInSlice(req.GroupLinkState, []string{"enabled", "enabled-with-approval", "disabled"}) { if req.GroupLinkState != "" && !utils.StringInSlice(req.GroupLinkState, []string{"enabled", "enabled-with-approval", "disabled"}) {
c.JSON(400, gin.H{"error": "Invalid group link provided - only 'enabled', 'enabled-with-approval' and 'disabled' allowed!" }) c.JSON(400, Error{Msg: "Invalid group link provided - only 'enabled', 'enabled-with-approval' and 'disabled' allowed!" })
return return
} }
cmd := []string{"--config", a.signalCliConfig, "-u", number, "updateGroup", "-n", req.Name, "-m"} editGroupPermission := client.DefaultGroupPermission
cmd = append(cmd, req.Members...) addMembersPermission := client.DefaultGroupPermission
groupLinkState := client.DefaultGroupLinkState
if req.Permissions.AddMembers != "" { groupId, err := a.signalClient.CreateGroup(number, req.Name, req.Members, req.Description, editGroupPermission, addMembersPermission, groupLinkState)
cmd = append(cmd, []string{"--set-permission-add-member", req.Permissions.AddMembers}...)
}
if req.Permissions.EditGroup != "" {
cmd = append(cmd, []string{"--set-permission-edit-details", req.Permissions.EditGroup}...)
}
if req.GroupLinkState != "" {
cmd = append(cmd, []string{"--link", req.GroupLinkState}...)
}
if req.Description != "" {
cmd = append(cmd, []string{"--description", req.Description}...)
}
out, err := runSignalCli(true, cmd, "")
if err != nil { if err != nil {
if strings.Contains(err.Error(), signalCliV2GroupError) { c.JSON(400, Error{Msg: err.Error()})
c.JSON(400, Error{Msg: "Cannot create group - please first update your profile."})
} else {
c.JSON(400, Error{Msg: err.Error()})
}
return return
} }
internalGroupId := getStringInBetween(out, `"`, `"`) c.JSON(201, CreateGroupResponse{Id: groupId})
c.JSON(201, CreateGroupResponse{Id: convertInternalGroupIdToGroupId(internalGroupId)})
} }
// @Summary List all Signal Groups. // @Summary List all Signal Groups.
@@ -735,9 +349,9 @@ func (a *Api) CreateGroup(c *gin.Context) {
func (a *Api) GetGroups(c *gin.Context) { func (a *Api) GetGroups(c *gin.Context) {
number := c.Param("number") number := c.Param("number")
groups, err := getGroups(number, a.signalCliConfig) groups, err := a.signalClient.GetGroups(number)
if err != nil { if err != nil {
c.JSON(400, gin.H{"error": err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
@@ -758,20 +372,17 @@ func (a *Api) GetGroup(c *gin.Context) {
number := c.Param("number") number := c.Param("number")
groupId := c.Param("groupid") groupId := c.Param("groupid")
groups, err := getGroups(number, a.signalCliConfig) groupEntry, err := a.signalClient.GetGroup(number, groupId)
if err != nil { if err != nil {
c.JSON(400, gin.H{"error": err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
for _, group := range groups { if groupEntry != nil {
if group.Id == groupId { c.JSON(200, groupEntry)
c.JSON(200, group) } else {
return c.JSON(404, Error{Msg: "No group with that id found"})
}
} }
c.JSON(404, Error{Msg: "No group with that id found"})
} }
// @Summary Delete a Signal Group. // @Summary Delete a Signal Group.
@@ -789,19 +400,19 @@ func (a *Api) DeleteGroup(c *gin.Context) {
number := c.Param("number") number := c.Param("number")
if base64EncodedGroupId == "" { if base64EncodedGroupId == "" {
c.JSON(400, gin.H{"error": "Please specify a group id"}) c.JSON(400, Error{Msg: "Please specify a group id"})
return return
} }
groupId, err := base64.StdEncoding.DecodeString(strings.TrimPrefix(base64EncodedGroupId, groupPrefix)) groupId, err := client.ConvertGroupIdToInternalGroupId(base64EncodedGroupId)
if err != nil { if err != nil {
c.JSON(400, gin.H{"error": "Invalid group id"}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
_, err = runSignalCli(true, []string{"--config", a.signalCliConfig, "-u", number, "quitGroup", "-g", string(groupId)}, "") err = a.signalClient.DeleteGroup(number, groupId)
if err != nil { if err != nil {
c.JSON(400, gin.H{"error": err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
} }
@@ -818,32 +429,13 @@ func (a *Api) GetQrCodeLink(c *gin.Context) {
deviceName := c.Query("device_name") deviceName := c.Query("device_name")
if deviceName == "" { if deviceName == "" {
c.JSON(400, gin.H{"error": "Please provide a name for the device"}) c.JSON(400, Error{Msg: "Please provide a name for the device"})
return return
} }
command := []string{"--config", a.signalCliConfig, "link", "-n", deviceName} png, err := a.signalClient.GetQrCodeLink(deviceName)
tsdeviceLink, err := runSignalCli(false, command, "")
if err != nil { if err != nil {
log.Error("Couldn't create QR code: ", err.Error()) c.JSON(400, Error{Msg: err.Error()})
c.JSON(400, Error{Msg: "Couldn't create QR code: " + err.Error()})
return
}
q, err := qrcode.New(string(tsdeviceLink), qrcode.Medium)
if err != nil {
log.Error("Couldn't create QR code: ", err.Error())
c.JSON(400, Error{Msg: "Couldn't create QR code: " + err.Error()})
return
}
q.DisableBorder = false
var png []byte
png, err = q.PNG(256)
if err != nil {
log.Error("Couldn't create QR code: ", err.Error())
c.JSON(400, Error{Msg: "Couldn't create QR code: " + err.Error()})
return return
} }
@@ -858,15 +450,7 @@ func (a *Api) GetQrCodeLink(c *gin.Context) {
// @Failure 400 {object} Error // @Failure 400 {object} Error
// @Router /v1/attachments [get] // @Router /v1/attachments [get]
func (a *Api) GetAttachments(c *gin.Context) { func (a *Api) GetAttachments(c *gin.Context) {
files := []string{} files, err := a.signalClient.GetAttachments()
err := filepath.Walk(a.signalCliConfig+"/attachments/", func(path string, info os.FileInfo, err error) error {
if info.IsDir() {
return nil
}
files = append(files, filepath.Base(path))
return nil
})
if err != nil { if err != nil {
c.JSON(500, Error{Msg: "Couldn't get list of attachments: " + err.Error()}) c.JSON(500, Error{Msg: "Couldn't get list of attachments: " + err.Error()})
return return
@@ -885,21 +469,25 @@ func (a *Api) GetAttachments(c *gin.Context) {
// @Router /v1/attachments/{attachment} [delete] // @Router /v1/attachments/{attachment} [delete]
func (a *Api) RemoveAttachment(c *gin.Context) { func (a *Api) RemoveAttachment(c *gin.Context) {
attachment := c.Param("attachment") attachment := c.Param("attachment")
path, err := securejoin.SecureJoin(a.signalCliConfig+"/attachments/", attachment)
err := a.signalClient.RemoveAttachment(attachment)
if err != nil { if err != nil {
c.JSON(400, Error{Msg: "Please provide a valid attachment name"}) switch err.(type) {
return case *client.InvalidNameError:
c.JSON(400, Error{Msg: err.Error()})
return
case *client.NotFoundError:
c.JSON(404, Error{Msg: err.Error()})
return
case *client.InternalError:
c.JSON(500, Error{Msg: err.Error()})
return
default:
c.JSON(500, Error{Msg: err.Error()})
return
}
} }
if _, err := os.Stat(path); os.IsNotExist(err) {
c.JSON(404, Error{Msg: "No attachment with that name found"})
return
}
err = os.Remove(path)
if err != nil {
c.JSON(500, Error{Msg: "Couldn't delete attachment - please try again later"})
return
}
c.Status(http.StatusNoContent) c.Status(http.StatusNoContent)
} }
@@ -913,32 +501,34 @@ func (a *Api) RemoveAttachment(c *gin.Context) {
// @Router /v1/attachments/{attachment} [get] // @Router /v1/attachments/{attachment} [get]
func (a *Api) ServeAttachment(c *gin.Context) { func (a *Api) ServeAttachment(c *gin.Context) {
attachment := c.Param("attachment") attachment := c.Param("attachment")
path, err := securejoin.SecureJoin(a.signalCliConfig+"/attachments/", attachment)
attachmentBytes, err := a.signalClient.GetAttachment(attachment)
if err != nil { if err != nil {
c.JSON(400, Error{Msg: "Please provide a valid attachment name"}) switch err.(type) {
return case *client.InvalidNameError:
c.JSON(400, Error{Msg: err.Error()})
return
case *client.NotFoundError:
c.JSON(404, Error{Msg: err.Error()})
return
case *client.InternalError:
c.JSON(500, Error{Msg: err.Error()})
return
default:
c.JSON(500, Error{Msg: err.Error()})
return
}
} }
if _, err := os.Stat(path); os.IsNotExist(err) { mime, err := mimetype.DetectReader(bytes.NewReader(attachmentBytes))
c.JSON(404, Error{Msg: "No attachment with that name found"})
return
}
imgBytes, err := ioutil.ReadFile(path)
if err != nil {
c.JSON(500, Error{Msg: "Couldn't read attachment - please try again later"})
return
}
mime, err := mimetype.DetectReader(bytes.NewReader(imgBytes))
if err != nil { if err != nil {
c.JSON(500, Error{Msg: "Couldn't detect MIME type for attachment"}) c.JSON(500, Error{Msg: "Couldn't detect MIME type for attachment"})
return return
} }
c.Writer.Header().Set("Content-Type", mime.String()) c.Writer.Header().Set("Content-Type", mime.String())
c.Writer.Header().Set("Content-Length", strconv.Itoa(len(imgBytes))) c.Writer.Header().Set("Content-Length", strconv.Itoa(len(attachmentBytes)))
_, err = c.Writer.Write(imgBytes) _, err = c.Writer.Write(attachmentBytes)
if err != nil { if err != nil {
c.JSON(500, Error{Msg: "Couldn't serve attachment - please try again later"}) c.JSON(500, Error{Msg: "Couldn't serve attachment - please try again later"})
return return
@@ -974,63 +564,13 @@ func (a *Api) UpdateProfile(c *gin.Context) {
c.JSON(400, Error{Msg: "Couldn't process request - profile name missing"}) c.JSON(400, Error{Msg: "Couldn't process request - profile name missing"})
return return
} }
cmd := []string{"--config", a.signalCliConfig, "-u", number, "updateProfile", "--name", req.Name}
avatarTmpPaths := []string{} err = a.signalClient.UpdateProfile(number, req.Name, req.Base64Avatar)
if req.Base64Avatar == "" {
cmd = append(cmd, "--remove-avatar")
} else {
u, err := uuid.NewV4()
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
}
avatarBytes, err := base64.StdEncoding.DecodeString(req.Base64Avatar)
if err != nil {
c.JSON(400, Error{Msg: "Couldn't decode base64 encoded avatar"})
return
}
fType, err := filetype.Get(avatarBytes)
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
}
avatarTmpPath := a.avatarTmpDir + u.String() + "." + fType.Extension
f, err := os.Create(avatarTmpPath)
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
}
defer f.Close()
if _, err := f.Write(avatarBytes); err != nil {
cleanupTmpFiles(avatarTmpPaths)
c.JSON(400, Error{Msg: err.Error()})
return
}
if err := f.Sync(); err != nil {
cleanupTmpFiles(avatarTmpPaths)
c.JSON(400, Error{Msg: err.Error()})
return
}
f.Close()
cmd = append(cmd, []string{"--avatar", avatarTmpPath}...)
avatarTmpPaths = append(avatarTmpPaths, avatarTmpPath)
}
_, err = runSignalCli(true, cmd, "")
if err != nil { if err != nil {
cleanupTmpFiles(avatarTmpPaths)
c.JSON(400, Error{Msg: err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
cleanupTmpFiles(avatarTmpPaths)
c.Status(http.StatusNoContent) c.Status(http.StatusNoContent)
} }
@@ -1059,27 +599,12 @@ func (a *Api) ListIdentities(c *gin.Context) {
return return
} }
out, err := runSignalCli(true, []string{"--config", a.signalCliConfig, "-u", number, "listIdentities"}, "") identityEntries, err := a.signalClient.ListIdentities(number)
if err != nil { if err != nil {
c.JSON(500, Error{Msg: err.Error()}) c.JSON(500, Error{Msg: err.Error()})
return return
} }
identityEntries := []IdentityEntry{}
keyValuePairs := parseWhitespaceDelimitedKeyValueStringList(out, []string{"NumberAndTrustStatus", "Added", "Fingerprint", "Safety Number"})
for _, keyValuePair := range keyValuePairs {
numberAndTrustStatus := keyValuePair["NumberAndTrustStatus"]
numberAndTrustStatusSplitted := strings.Split(numberAndTrustStatus, ":")
identityEntry := IdentityEntry{Number: strings.Trim(numberAndTrustStatusSplitted[0], " "),
Status: strings.Trim(numberAndTrustStatusSplitted[1], " "),
Added: keyValuePair["Added"],
Fingerprint: strings.Trim(keyValuePair["Fingerprint"], " "),
SafetyNumber: strings.Trim(keyValuePair["Safety Number"], " "),
}
identityEntries = append(identityEntries, identityEntry)
}
c.JSON(200, identityEntries) c.JSON(200, identityEntries)
} }
@@ -1119,12 +644,12 @@ func (a *Api) TrustIdentity(c *gin.Context) {
return return
} }
cmd := []string{"--config", a.signalCliConfig, "-u", number, "trust", numberToTrust, "--verified-safety-number", req.VerifiedSafetyNumber} err = a.signalClient.TrustIdentity(number, numberToTrust, req.VerifiedSafetyNumber)
_, err = runSignalCli(true, cmd, "")
if err != nil { if err != nil {
c.JSON(400, Error{Msg: err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
c.Status(http.StatusNoContent) c.Status(http.StatusNoContent)
} }
@@ -1201,17 +726,18 @@ func (a *Api) BlockGroup(c *gin.Context) {
} }
groupId := c.Param("groupid") groupId := c.Param("groupid")
internalGroupId, err := convertGroupIdToInternalGroupId(groupId) internalGroupId, err := client.ConvertGroupIdToInternalGroupId(groupId)
if err != nil { if err != nil {
c.JSON(400, Error{Msg: err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
_, err = runSignalCli(true, []string{"--config", a.signalCliConfig, "-u", number, "block", "-g", internalGroupId}, "") err = a.signalClient.BlockGroup(number, internalGroupId)
if err != nil { if err != nil {
c.JSON(400, Error{Msg: err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
c.Status(http.StatusNoContent) c.Status(http.StatusNoContent)
} }
@@ -1233,17 +759,18 @@ func (a *Api) JoinGroup(c *gin.Context) {
} }
groupId := c.Param("groupid") groupId := c.Param("groupid")
internalGroupId, err := convertGroupIdToInternalGroupId(groupId) internalGroupId, err := client.ConvertGroupIdToInternalGroupId(groupId)
if err != nil { if err != nil {
c.JSON(400, Error{Msg: err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
_, err = runSignalCli(true, []string{"--config", a.signalCliConfig, "-u", number, "updateGroup", "-g", internalGroupId}, "") err = a.signalClient.JoinGroup(number, internalGroupId)
if err != nil { if err != nil {
c.JSON(400, Error{Msg: err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
c.Status(http.StatusNoContent) c.Status(http.StatusNoContent)
} }
@@ -1265,13 +792,13 @@ func (a *Api) QuitGroup(c *gin.Context) {
} }
groupId := c.Param("groupid") groupId := c.Param("groupid")
internalGroupId, err := convertGroupIdToInternalGroupId(groupId) internalGroupId, err := client.ConvertGroupIdToInternalGroupId(groupId)
if err != nil { if err != nil {
c.JSON(400, Error{Msg: err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return
} }
_, err = runSignalCli(true, []string{"--config", a.signalCliConfig, "-u", number, "quitGroup", "-g", internalGroupId}, "") err = a.signalClient.QuitGroup(number, internalGroupId)
if err != nil { if err != nil {
c.JSON(400, Error{Msg: err.Error()}) c.JSON(400, Error{Msg: err.Error()})
return return

696
src/client/client.go Normal file
View File

@@ -0,0 +1,696 @@
package client
import (
"bufio"
"bytes"
"encoding/base64"
"encoding/json"
"errors"
"io/ioutil"
"os"
"os/exec"
"path/filepath"
"strconv"
"strings"
"time"
"github.com/cyphar/filepath-securejoin"
"github.com/gabriel-vasile/mimetype"
"github.com/h2non/filetype"
log "github.com/sirupsen/logrus"
uuid "github.com/gofrs/uuid"
qrcode "github.com/skip2/go-qrcode"
utils "github.com/bbernhard/signal-cli-rest-api/utils"
)
const groupPrefix = "group."
const signalCliV2GroupError = "Cannot create a V2 group as self does not have a versioned profile"
type GroupPermission int
const (
DefaultGroupPermission GroupPermission = iota + 1
EveryMember
OnlyAdmins
)
type GroupLinkState int
const (
DefaultGroupLinkState GroupLinkState = iota + 1
Enabled
EnabledWithApproval
Disabled
)
func (g GroupPermission) String() string {
return []string{"", "default", "every-member", "only-admins"}[g]
}
func (g GroupLinkState) String() string {
return []string{"", "enabled", "enabled-with-approval", "disabled"}[g]
}
type GroupEntry struct {
Name string `json:"name"`
Id string `json:"id"`
InternalId string `json:"internal_id"`
Members []string `json:"members"`
Blocked bool `json:"blocked"`
PendingInvites []string `json:"pending_invites"`
PendingRequests []string `json:"pending_requests"`
InviteLink string `json:"invite_link"`
}
type IdentityEntry struct {
Number string `json:"number"`
Status string `json:"status"`
Fingerprint string `json:"fingerprint"`
Added string `json:"added"`
SafetyNumber string `json:"safety_number"`
}
type SignalCliGroupEntry struct {
Name string `json:"name"`
Id string `json:"id"`
IsMember bool `json:"isMember"`
IsBlocked bool `json:"isBlocked"`
Members []string `json:"members"`
PendingMembers []string `json:"pendingMembers"`
RequestingMembers []string `json:"requestingMembers"`
GroupInviteLink string `json:"groupInviteLink"`
}
type About struct {
SupportedApiVersions []string `json:"versions"`
BuildNr int `json:"build"`
}
func cleanupTmpFiles(paths []string) {
for _, path := range paths {
os.Remove(path)
}
}
func convertInternalGroupIdToGroupId(internalId string) string {
return groupPrefix + base64.StdEncoding.EncodeToString([]byte(internalId))
}
func getStringInBetween(str string, start string, end string) (result string) {
i := strings.Index(str, start)
if i == -1 {
return
}
i += len(start)
j := strings.Index(str[i:], end)
if j == -1 {
return
}
return str[i : i+j]
}
func parseWhitespaceDelimitedKeyValueStringList(in string, keys []string) []map[string]string {
l := []map[string]string{}
lines := strings.Split(in, "\n")
for _, line := range lines {
if line == "" {
continue
}
m := make(map[string]string)
temp := line
for i, key := range keys {
if i == 0 {
continue
}
idx := strings.Index(temp, " "+key+": ")
pair := temp[:idx]
value := strings.TrimPrefix(pair, key+": ")
temp = strings.TrimLeft(temp[idx:], " "+key+": ")
m[keys[i-1]] = value
}
m[keys[len(keys)-1]] = temp
l = append(l, m)
}
return l
}
func getContainerId() (string, error) {
data, err := ioutil.ReadFile("/proc/1/cpuset")
if err != nil {
return "", err
}
lines := strings.Split(string(data), "\n")
if len(lines) == 0 {
return "", errors.New("Couldn't get docker container id (empty)")
}
containerId := strings.Replace(lines[0], "/docker/", "", -1)
return containerId, nil
}
func send(attachmentTmpDir string, signalCliConfig string, number string, message string,
recipients []string, base64Attachments []string, isGroup bool) (string, error) {
cmd := []string{"--config", signalCliConfig, "-u", number, "send"}
if len(recipients) == 0 {
return "", errors.New("Please specify at least one recipient")
}
if !isGroup {
cmd = append(cmd, recipients...)
} else {
if len(recipients) > 1 {
return "", errors.New("More than one recipient is currently not allowed")
}
groupId, err := base64.StdEncoding.DecodeString(recipients[0])
if err != nil {
return "", errors.New("Invalid group id")
}
cmd = append(cmd, []string{"-g", string(groupId)}...)
}
attachmentTmpPaths := []string{}
for _, base64Attachment := range base64Attachments {
u, err := uuid.NewV4()
if err != nil {
return "", err
}
dec, err := base64.StdEncoding.DecodeString(base64Attachment)
if err != nil {
return "", err
}
mimeType := mimetype.Detect(dec)
attachmentTmpPath := attachmentTmpDir + u.String() + mimeType.Extension()
attachmentTmpPaths = append(attachmentTmpPaths, attachmentTmpPath)
f, err := os.Create(attachmentTmpPath)
if err != nil {
return "", err
}
defer f.Close()
if _, err := f.Write(dec); err != nil {
cleanupTmpFiles(attachmentTmpPaths)
return "", err
}
if err := f.Sync(); err != nil {
cleanupTmpFiles(attachmentTmpPaths)
return "", err
}
f.Close()
}
if len(attachmentTmpPaths) > 0 {
cmd = append(cmd, "-a")
cmd = append(cmd, attachmentTmpPaths...)
}
resp, err := runSignalCli(true, cmd, message)
if err != nil {
cleanupTmpFiles(attachmentTmpPaths)
if strings.Contains(err.Error(), signalCliV2GroupError) {
return "", errors.New("Cannot send message to group - please first update your profile.")
}
return "", err
}
cleanupTmpFiles(attachmentTmpPaths)
return strings.TrimSuffix(resp, "\n"), nil
}
func runSignalCli(wait bool, args []string, stdin string) (string, error) {
containerId, err := getContainerId()
log.Debug("If you want to run this command manually, run the following steps on your host system:")
if err == nil {
log.Debug("*) docker exec -it ", containerId, " /bin/bash")
} else {
log.Debug("*) docker exec -it <container id> /bin/bash")
}
signalCliBinary := "signal-cli"
if utils.GetEnv("USE_NATIVE", "0") == "1" {
if utils.GetEnv("SUPPORTS_NATIVE", "0") == "1" {
signalCliBinary = "signal-cli-native"
} else {
log.Error("signal-cli-native is not support on this system...falling back to signal-cli")
signalCliBinary = "signal-cli"
}
}
fullCmd := ""
if(stdin != "") {
fullCmd += "echo '" + stdin + "' | "
}
fullCmd += signalCliBinary + " " + strings.Join(args, " ")
log.Debug("*) su signal-api")
log.Debug("*) ", fullCmd)
cmdTimeout, err := utils.GetIntEnv("SIGNAL_CLI_CMD_TIMEOUT", 120)
if err != nil {
log.Error("Env variable 'SIGNAL_CLI_CMD_TIMEOUT' contains an invalid timeout...falling back to default timeout (120 seconds)")
cmdTimeout = 120
}
cmd := exec.Command(signalCliBinary, args...)
if stdin != "" {
cmd.Stdin = strings.NewReader(stdin)
}
if wait {
var errBuffer bytes.Buffer
var outBuffer bytes.Buffer
cmd.Stderr = &errBuffer
cmd.Stdout = &outBuffer
err := cmd.Start()
if err != nil {
return "", err
}
done := make(chan error, 1)
go func() {
done <- cmd.Wait()
}()
select {
case <-time.After(time.Duration(cmdTimeout) * time.Second):
err := cmd.Process.Kill()
if err != nil {
return "", err
}
return "", errors.New("process killed as timeout reached")
case err := <-done:
if err != nil {
return "", errors.New(errBuffer.String())
}
}
return outBuffer.String(), nil
} else {
stdout, err := cmd.StdoutPipe()
if err != nil {
return "", err
}
cmd.Start()
buf := bufio.NewReader(stdout) // Notice that this is not in a loop
line, _, _ := buf.ReadLine()
return string(line), nil
}
}
func ConvertGroupIdToInternalGroupId(id string) (string, error) {
groupIdWithoutPrefix := strings.TrimPrefix(id, groupPrefix)
internalGroupId, err := base64.StdEncoding.DecodeString(groupIdWithoutPrefix)
if err != nil {
return "", errors.New("Invalid group id")
}
return string(internalGroupId), err
}
type SignalClient struct {
signalCliConfig string
attachmentTmpDir string
avatarTmpDir string
}
func NewSignalClient(signalCliConfig string, attachmentTmpDir string, avatarTmpDir string) *SignalClient {
return &SignalClient{
signalCliConfig: signalCliConfig,
attachmentTmpDir: attachmentTmpDir,
avatarTmpDir: avatarTmpDir,
}
}
func (s *SignalClient) About() About {
about := About{SupportedApiVersions: []string{"v1", "v2"}, BuildNr: 2}
return about
}
func (s *SignalClient) RegisterNumber(number string, useVoice bool, captcha string) error {
command := []string{"--config", s.signalCliConfig, "-u", number, "register"}
if useVoice {
command = append(command, "--voice")
}
if captcha != "" {
command = append(command, []string{"--captcha", captcha}...)
}
_, err := runSignalCli(true, command, "")
return err
}
func (s *SignalClient) VerifyRegisteredNumber(number string, token string, pin string) error {
cmd := []string{"--config", s.signalCliConfig, "-u", number, "verify", token}
if pin != "" {
cmd = append(cmd, "--pin")
cmd = append(cmd, pin)
}
_, err := runSignalCli(true, cmd, "")
return err
}
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)
return timestamp, err
}
func (s *SignalClient) SendV2(number string, message string, recps []string, base64Attachments []string) ([]string, error) {
if len(recps) == 0 {
return []string{}, errors.New("Please provide at least one recipient")
}
if number == "" {
return []string{}, errors.New("Please provide a valid number")
}
groups := []string{}
recipients := []string{}
for _, recipient := range recps {
if strings.HasPrefix(recipient, groupPrefix) {
groups = append(groups, strings.TrimPrefix(recipient, groupPrefix))
} else {
recipients = append(recipients, recipient)
}
}
if len(recipients) > 0 && len(groups) > 0 {
return []string{}, errors.New("Signal Messenger Groups and phone numbers cannot be specified together in one request! Please split them up into multiple REST API calls.")
}
if len(groups) > 1 {
return []string{}, errors.New("A signal message cannot be sent to more than one group at once! Please use multiple REST API calls for that.")
}
timestamps := []string{}
for _, group := range groups {
timestamp, err := send(s.attachmentTmpDir, s.signalCliConfig, number, message, []string{group}, base64Attachments, true)
if err != nil {
return timestamps, err
}
timestamps = append(timestamps, timestamp)
}
if len(recipients) > 0 {
timestamp, err := send(s.attachmentTmpDir, s.signalCliConfig, number, message, recipients, base64Attachments, false)
if err != nil {
return timestamps, err
}
timestamps = append(timestamps, timestamp)
}
return timestamps, nil
}
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)}
out, err := runSignalCli(true, command, "")
if err != nil {
return "", err
}
out = strings.Trim(out, "\n")
lines := strings.Split(out, "\n")
jsonStr := "["
for i, line := range lines {
jsonStr += line
if i != (len(lines) - 1) {
jsonStr += ","
}
}
jsonStr += "]"
return jsonStr, nil
}
func (s *SignalClient) CreateGroup(number string, name string, members []string, description string, editGroupPermission GroupPermission, addMembersPermission GroupPermission, groupLinkState GroupLinkState) (string, error) {
cmd := []string{"--config", s.signalCliConfig, "-u", number, "updateGroup", "-n", name, "-m"}
cmd = append(cmd, members...)
if addMembersPermission != DefaultGroupPermission {
cmd = append(cmd, []string{"--set-permission-add-member", addMembersPermission.String()}...)
}
if editGroupPermission != DefaultGroupPermission {
cmd = append(cmd, []string{"--set-permission-edit-details", editGroupPermission.String()}...)
}
if groupLinkState != DefaultGroupLinkState {
cmd = append(cmd, []string{"--link", groupLinkState.String()}...)
}
if description != "" {
cmd = append(cmd, []string{"--description", description}...)
}
out, err := runSignalCli(true, cmd, "")
if err != nil {
if strings.Contains(err.Error(), signalCliV2GroupError) {
return "", errors.New("Cannot create group - please first update your profile.")
}
return "", err
}
internalGroupId := getStringInBetween(out, `"`, `"`)
groupId := convertInternalGroupIdToGroupId(internalGroupId)
return groupId, nil
}
func (s *SignalClient) GetGroups(number string) ([]GroupEntry, error) {
groupEntries := []GroupEntry{}
out, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "--output", "json", "-u", number, "listGroups", "-d"}, "")
if err != nil {
return groupEntries, err
}
var signalCliGroupEntries []SignalCliGroupEntry
err = json.Unmarshal([]byte(out), &signalCliGroupEntries)
if err != nil {
return groupEntries, err
}
for _, signalCliGroupEntry := range signalCliGroupEntries {
var groupEntry GroupEntry
groupEntry.InternalId = signalCliGroupEntry.Id
groupEntry.Name = signalCliGroupEntry.Name
groupEntry.Id = convertInternalGroupIdToGroupId(signalCliGroupEntry.Id)
groupEntry.Blocked = signalCliGroupEntry.IsBlocked
groupEntry.Members = signalCliGroupEntry.Members
groupEntry.PendingRequests = signalCliGroupEntry.PendingMembers
groupEntry.PendingInvites = signalCliGroupEntry.RequestingMembers
groupEntry.InviteLink = signalCliGroupEntry.GroupInviteLink
groupEntries = append(groupEntries, groupEntry)
}
return groupEntries, nil
}
func (s *SignalClient) GetGroup(number string, groupId string) (*GroupEntry, error) {
groupEntry := GroupEntry{}
groups, err := s.GetGroups(number)
if err != nil {
return nil, err
}
for _, group := range groups {
if group.Id == groupId {
groupEntry = group
return &groupEntry, nil
}
}
return nil, nil
}
func (s *SignalClient) DeleteGroup(number string, groupId string) error {
_, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "quitGroup", "-g", string(groupId)}, "")
return err
}
func (s *SignalClient) GetQrCodeLink(deviceName string) ([]byte, error) {
command := []string{"--config", s.signalCliConfig, "link", "-n", deviceName}
tsdeviceLink, err := runSignalCli(false, command, "")
if err != nil {
return []byte{}, errors.New("Couldn't create QR code: " + err.Error())
}
q, err := qrcode.New(string(tsdeviceLink), qrcode.Medium)
if err != nil {
return []byte{}, errors.New("Couldn't create QR code: " + err.Error())
}
q.DisableBorder = false
var png []byte
png, err = q.PNG(256)
if err != nil {
return []byte{}, errors.New("Couldn't create QR code: " + err.Error())
}
return png, nil
}
func (s *SignalClient) GetAttachments() ([]string, error) {
files := []string{}
err := filepath.Walk(s.signalCliConfig+"/attachments/", func(path string, info os.FileInfo, err error) error {
if info.IsDir() {
return nil
}
files = append(files, filepath.Base(path))
return nil
})
return files, err
}
func (s *SignalClient) RemoveAttachment(attachment string) error {
path, err := securejoin.SecureJoin(s.signalCliConfig+"/attachments/", attachment)
if err != nil {
return &InvalidNameError{Description: "Please provide a valid attachment name"}
}
if _, err := os.Stat(path); os.IsNotExist(err) {
return &NotFoundError{Description: "No attachment with that name found"}
}
err = os.Remove(path)
if err != nil {
return &InternalError{Description: "Couldn't delete attachment - please try again later"}
}
return nil
}
func (s *SignalClient) GetAttachment(attachment string) ([]byte, error) {
path, err := securejoin.SecureJoin(s.signalCliConfig+"/attachments/", attachment)
if err != nil {
return []byte{}, &InvalidNameError{Description: "Please provide a valid attachment name"}
}
if _, err := os.Stat(path); os.IsNotExist(err) {
return []byte{}, &NotFoundError{Description: "No attachment with that name found"}
}
attachmentBytes, err := ioutil.ReadFile(path)
if err != nil {
return []byte{}, &InternalError{Description: "Couldn't read attachment - please try again later"}
}
return attachmentBytes, nil
}
func (s *SignalClient) UpdateProfile(number string, profileName string, base64Avatar string) error {
cmd := []string{"--config", s.signalCliConfig, "-u", number, "updateProfile", "--name", profileName}
avatarTmpPaths := []string{}
if base64Avatar == "" {
cmd = append(cmd, "--remove-avatar")
} else {
u, err := uuid.NewV4()
if err != nil {
return err
}
avatarBytes, err := base64.StdEncoding.DecodeString(base64Avatar)
if err != nil {
return errors.New("Couldn't decode base64 encoded avatar: " +err.Error())
}
fType, err := filetype.Get(avatarBytes)
if err != nil {
return err
}
avatarTmpPath := s.avatarTmpDir + u.String() + "." + fType.Extension
f, err := os.Create(avatarTmpPath)
if err != nil {
return err
}
defer f.Close()
if _, err := f.Write(avatarBytes); err != nil {
cleanupTmpFiles(avatarTmpPaths)
return err
}
if err := f.Sync(); err != nil {
cleanupTmpFiles(avatarTmpPaths)
return err
}
f.Close()
cmd = append(cmd, []string{"--avatar", avatarTmpPath}...)
avatarTmpPaths = append(avatarTmpPaths, avatarTmpPath)
}
_, err := runSignalCli(true, cmd, "")
cleanupTmpFiles(avatarTmpPaths)
return err
}
func (s *SignalClient) ListIdentities(number string) (*[]IdentityEntry, error) {
out, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "listIdentities"}, "")
if err != nil {
return nil, err
}
identityEntries := []IdentityEntry{}
keyValuePairs := parseWhitespaceDelimitedKeyValueStringList(out, []string{"NumberAndTrustStatus", "Added", "Fingerprint", "Safety Number"})
for _, keyValuePair := range keyValuePairs {
numberAndTrustStatus := keyValuePair["NumberAndTrustStatus"]
numberAndTrustStatusSplitted := strings.Split(numberAndTrustStatus, ":")
identityEntry := IdentityEntry{Number: strings.Trim(numberAndTrustStatusSplitted[0], " "),
Status: strings.Trim(numberAndTrustStatusSplitted[1], " "),
Added: keyValuePair["Added"],
Fingerprint: strings.Trim(keyValuePair["Fingerprint"], " "),
SafetyNumber: strings.Trim(keyValuePair["Safety Number"], " "),
}
identityEntries = append(identityEntries, identityEntry)
}
return &identityEntries, nil
}
func (s *SignalClient) TrustIdentity(number string, numberToTrust string, verifiedSafetyNumber string) error {
cmd := []string{"--config", s.signalCliConfig, "-u", number, "trust", numberToTrust, "--verified-safety-number", verifiedSafetyNumber}
_, err := runSignalCli(true, cmd, "")
return err
}
func (s *SignalClient) BlockGroup(number string, groupId string) error {
_, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "block", "-g", groupId}, "")
return err
}
func (s *SignalClient) JoinGroup(number string, groupId string) error {
_, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "updateGroup", "-g", groupId}, "")
return err
}
func (s *SignalClient) QuitGroup(number string, groupId string) error {
_, err := runSignalCli(true, []string{"--config", s.signalCliConfig, "-u", number, "quitGroup", "-g", groupId}, "")
return err
}

25
src/client/errors.go Normal file
View File

@@ -0,0 +1,25 @@
package client
type InvalidNameError struct {
Description string
}
func (e *InvalidNameError) Error() string {
return e.Description
}
type NotFoundError struct {
Description string
}
func (e *NotFoundError) Error() string {
return e.Description
}
type InternalError struct {
Description string
}
func (e *InternalError) Error() string {
return e.Description
}

View File

@@ -3,13 +3,15 @@ package main
import ( import (
"encoding/json" "encoding/json"
"flag" "flag"
"strings" "io/ioutil"
"strconv"
"net/http" "net/http"
"os" "os"
"path/filepath" "path/filepath"
"io/ioutil" "strconv"
"strings"
"github.com/bbernhard/signal-cli-rest-api/api" "github.com/bbernhard/signal-cli-rest-api/api"
"github.com/bbernhard/signal-cli-rest-api/client"
_ "github.com/bbernhard/signal-cli-rest-api/docs" _ "github.com/bbernhard/signal-cli-rest-api/docs"
"github.com/bbernhard/signal-cli-rest-api/utils" "github.com/bbernhard/signal-cli-rest-api/utils"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
@@ -71,7 +73,8 @@ func main() {
log.Fatal("Couldn't set env variable: ", err.Error()) log.Fatal("Couldn't set env variable: ", err.Error())
} }
api := api.NewApi(*signalCliConfig, *attachmentTmpDir, *avatarTmpDir) signalClient := client.NewSignalClient(*signalCliConfig, *attachmentTmpDir, *avatarTmpDir)
api := api.NewApi(signalClient)
v1 := router.Group("/v1") v1 := router.Group("/v1")
{ {
about := v1.Group("/about") about := v1.Group("/about")