rudamentary support for signald #1433

petermolnar · 2021-03-23T09:25:54Z

Signald https://gitlab.com/signald/signald is a standalone Signal client written in Java that can be interacted with via Unix socket and newline separated JSON strings.

These commits establish a crude and basic interaction with the signald daemon where by giving a group ID, one can relay messages from and to a Signal group.

Anything beyond this functionality - including, but not limited to registration, device linking, joining a group, etc. - is missing.

To test the functionality one has to set up signald with linking or registration in advance.

can receive from signald groupv2, but nothing else

I relied on learning from https://gitlab.com/signald/signald-go but because that project is under GPL and there are no plans on re-licensing (see <https://gitlab.com/signald/signald-go/-/issues/7>) it can't be directly used in matterbridge, which is Apache 2.0 Anyway: as it currently is, this module is crude, probably extremely prone to errors, and nowhere remotely close to stable or production use. Regardless of that, any help with it would be welcome.

- try to re-subscribe on fail - list contacts - use nice contact names instead of phone numbers

42wim · 2021-04-03T20:58:23Z

@petermolnar thank you!
Could you fix the linting errors? If anything is not clear, let me know

codeclimate · 2021-04-04T08:25:37Z

Code Climate has analyzed commit 6dc84ca and detected 0 issues on this pull request.

View more on Code Climate.

halms

First: I very much look forward to this getting merged. I have a specific use case where bridging a WhatsApp with a Signal group is really useful.

It seems your latest changes fixed the linting errors.

When trying this out though, I run into some very weird behavior (my Signal groups got mixed up, ...) and I think I tracked it with the suggested changes.

Let me know, what you think (this is my first time touching Go code...).

halms · 2021-04-15T16:57:01Z

bridge/signald/signald.go

+	socket     net.Conn
+	subscribed bool
+	reader     *bufio.Scanner
+	groupid    string


Making this a single string leads to the problem that the bridge can only work with one Signal group.
(And has weird side effects when configuring more than one group)

I think a map-as-hashset construct could work here.

Suggested change

groupid string

groupids map[string]bool

halms · 2021-04-15T17:08:55Z

bridge/signald/signald.go

+}
+
+func (b *Bsignald) JoinChannel(channel config.ChannelInfo) error {
+	b.groupid = channel.Name


Add the groupid to the bridge

Suggested change

b.groupid = channel.Name

b.groupids[channel.Name] = true

halms · 2021-04-15T17:28:30Z

bridge/signald/signald.go

+		socketpath: socketpath,
+		subscribed: false,
+		contacts:   make(map[string]signaldContact),
+	}


Suggested change

}

groupids: make(map[string]bool),

}

halms · 2021-04-15T17:36:54Z

bridge/signald/signald.go

+	groupMatched := false
+	if response.Data.DataMessage.GroupV2 != nil {
+		if b.groupid == response.Data.DataMessage.GroupV2.ID {
+			groupMatched = true
+		}
+	} else if response.Data.DataMessage.Group != nil {
+		if b.groupid == response.Data.DataMessage.Group.ID {
+			groupMatched = true
+		}
+	}
+
+	if !groupMatched {
+		b.Log.Debugln("skipping non-group message")
+		return
+	}


Checking can be done against the hashset.
Additionally, we now need the current groupid, because b.groupid is not unique anymore.

Suggested change

groupMatched := false

if response.Data.DataMessage.GroupV2 != nil {

if b.groupid == response.Data.DataMessage.GroupV2.ID {

groupMatched = true

}

} else if response.Data.DataMessage.Group != nil {

if b.groupid == response.Data.DataMessage.Group.ID {

groupMatched = true

}

}

if !groupMatched {

b.Log.Debugln("skipping non-group message")

return

}

groupid := ""

if response.Data.DataMessage.GroupV2 != nil {

groupid = response.Data.DataMessage.GroupV2.ID

} else if response.Data.DataMessage.Group != nil {

groupid = response.Data.DataMessage.Group.ID

}

groupMatched := b.groupids[groupid]

if !groupMatched {

b.Log.Debugln("skipping not addressed to one of the configured groups")

return

}

halms · 2021-04-15T17:38:00Z

bridge/signald/signald.go

+
+	username := b.GetUsername(response.Data.Source.UUID)
+	if username == "" {
+		username = response.Data.Source.Number


As in the WhatsApp-Bridge, I would suggest not putting the Number in the username.

Suggested change

username = response.Data.Source.Number

username = "Someone"

halms · 2021-04-15T17:39:34Z

bridge/signald/signald.go

+	}
+
+	rmsg := config.Message{
+		UserID:   response.Data.Source.UUID,


I would prefer the Users Number as ID instead of the UUID, because this for me seems like a more usable identifier (and I have a specific use case that works better this way).

Suggested change

UserID: response.Data.Source.UUID,

UserID: response.Data.Source.Number,

halms · 2021-04-15T17:40:13Z

bridge/signald/signald.go

+		UserID:   response.Data.Source.UUID,
+		Username: username,
+		Text:     response.Data.DataMessage.Body,
+		Channel:  b.groupid,


Here we need the current groupid

Suggested change

Channel: b.groupid,

Channel: groupid,

halms · 2021-04-15T17:43:52Z

bridge/signald/signald.go

+	msgJSON := signaldSendMessage{
+		Type:             "send",
+		Username:         b.GetString(cfgNumber),
+		RecipientGroupID: b.groupid,


The groupid to send to now depends on the channel of the message, not the bridge configuration.

Suggested change

RecipientGroupID: b.groupid,

RecipientGroupID: msg.Channel,

halms · 2021-05-12T08:21:39Z

Is there any update on the status of this PR?
It seems to need a rebase now.

I have a version of this (with my described changes) running since a month or so on a local instance and have not run into any big issues.

micw · 2021-06-08T08:44:06Z

@42wim What changes (besides a rebase) are required to bring this in a state that you'd merge?
Kind regards,
Michael.

42wim · 2021-07-31T17:01:14Z

@petermolnar looks like @halms suggestions are useful, are you willing to rebase with his proposed changes?

To merge this I need someone who wants to take ownership of this specific bridge as I don't use signal/can't test it.

halms · 2022-04-27T21:42:45Z

Since there has not been any further activity by @petermolnar, I might take another look at this and use it as a chance to get up to speed in Go.

For this, I would be thinking, though, to use the quasi-official [signald-go](https://gitlab.com/signald/signald-go library. As this is GPLv3, it would be a situation like with the whatsappmulti bridge, where it cannot be distributed as a binary.

I have been using a version based on my proposed changes for quite some time now in production, and it has been working rather okay. For my specific use case, I will probably switch away from Matterbridge at some point and use whatsmeow (or Baileys) and signald directly, but I would very much like to see Matterbridge support Signal anyway.

Once I have something working, I will open a new pull request.

42wim · 2022-05-01T19:55:26Z

@halms sounds good, thanks!

z8512 · 2022-05-23T20:01:54Z

@halms waiting

Peter Molnar added 5 commits March 23, 2021 09:24

signald <https://gitlab.com/signald/signald> proof of concent

952af5c

can receive from signald groupv2, but nothing else

- check subscribe

7dd6a62

- try to re-subscribe on fail - list contacts - use nice contact names instead of phone numbers

making the matterbridge go linter happier

9663721

go lint is a bloody picky little bastard

14a83e0

Peter Molnar and others added 2 commits April 4, 2021 09:17

golint happifying, round 2

db453a1

Merge branch 'master' into signald

6dc84ca

halms suggested changes Apr 15, 2021

View reviewed changes

JsBergbau mentioned this pull request Nov 5, 2022

Plugin API documentation? #1910

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rudamentary support for signald #1433

rudamentary support for signald #1433

petermolnar commented Mar 23, 2021

42wim commented Apr 3, 2021

codeclimate bot commented Apr 4, 2021

halms left a comment

halms Apr 15, 2021

halms Apr 15, 2021

halms Apr 15, 2021

halms Apr 15, 2021

halms Apr 15, 2021

halms Apr 15, 2021

halms Apr 15, 2021

halms Apr 15, 2021

halms commented May 12, 2021

micw commented Jun 8, 2021

42wim commented Jul 31, 2021

halms commented Apr 27, 2022

42wim commented May 1, 2022

z8512 commented May 23, 2022

	UserID: response.Data.Source.UUID,
	UserID: response.Data.Source.Number,

rudamentary support for signald #1433

Are you sure you want to change the base?

rudamentary support for signald #1433

Conversation

petermolnar commented Mar 23, 2021

42wim commented Apr 3, 2021

codeclimate bot commented Apr 4, 2021

halms left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

halms commented May 12, 2021

micw commented Jun 8, 2021

42wim commented Jul 31, 2021

halms commented Apr 27, 2022

42wim commented May 1, 2022

z8512 commented May 23, 2022