From 9a371b8f91d144589b3b298920b51da6d330f0d6 Mon Sep 17 00:00:00 2001 From: finn Date: Wed, 23 Feb 2022 07:16:27 -0800 Subject: [PATCH 01/37] fix apt publishing --- .gitlab-ci.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 994e572..9c3dc5d 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -142,9 +142,11 @@ publish deb: - aptly repo create signald - aptly mirror create -ignore-signatures backfill-mirror https://updates.signald.org "${DISTRIBUTION}" main - aptly mirror update -ignore-signatures backfill-mirror - - aptly repo import backfill-mirror signald signald signaldctl + - aptly repo import backfill-mirror signald signald 'signaldctl (>= 0.3.0)' - aptly repo add signald *.deb - - aptly publish repo -config=.aptly.conf -batch -gpg-key="${SIGNING_KEY}" -distribution="${DISTRIBUTION}" "signald" "s3:updates.signald.org:" + - gpg1 --import "${SIGNING_KEY_PATH}" + - gpg1 --list-secret-keys + - aptly publish repo -config=.aptly.conf -batch -gpg-key="${SIGNING_KEY_ID}" -distribution="${DISTRIBUTION}" "signald" "s3:updates.signald.org:" variables: DISTRIBUTION: unstable rules: From 17f823064f1944c75bc72b68eb0039689ec251f4 Mon Sep 17 00:00:00 2001 From: finn Date: Tue, 1 Mar 2022 16:00:37 -0800 Subject: [PATCH 02/37] reset the value generator for SERIAL columns after import --- cmd/signaldctl/cmd/db/migrate.go | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 7c57dd8..bad9eb0 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -230,6 +230,12 @@ func moveRecipients(source *sql.DB, dest *sql.DB) error { return err } } + + // start new rowids one above the current max value + _, err = dest.Exec("SELECT setval(pg_get_serial_sequence('signald_recipients', 'rowid', (SELECT MAX(rowid) FROM signald_recipients)+1);") + if err != nil { + return err + } return nil } @@ -494,6 +500,12 @@ func moveGroups(source *sql.DB, dest *sql.DB) error { return err } } + + // start new rowids one above the current max value + _, err = dest.Exec("SELECT setval(pg_get_serial_sequence('signald_groups', 'rowid', (SELECT MAX(rowid) FROM signald_groups)+1);") + if err != nil { + return err + } return nil } From 56cc98de30d8104bda642f9a72ae450ff1a66a74 Mon Sep 17 00:00:00 2001 From: finn Date: Tue, 1 Mar 2022 16:56:56 -0800 Subject: [PATCH 03/37] fix queries --- cmd/signaldctl/cmd/db/migrate.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index bad9eb0..b3ea5e3 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -232,7 +232,7 @@ func moveRecipients(source *sql.DB, dest *sql.DB) error { } // start new rowids one above the current max value - _, err = dest.Exec("SELECT setval(pg_get_serial_sequence('signald_recipients', 'rowid', (SELECT MAX(rowid) FROM signald_recipients)+1);") + _, err = dest.Exec("SELECT setval(pg_get_serial_sequence('signald_recipients', 'rowid'), (SELECT MAX(rowid) FROM signald_recipients)+1)") if err != nil { return err } @@ -502,7 +502,7 @@ func moveGroups(source *sql.DB, dest *sql.DB) error { } // start new rowids one above the current max value - _, err = dest.Exec("SELECT setval(pg_get_serial_sequence('signald_groups', 'rowid', (SELECT MAX(rowid) FROM signald_groups)+1);") + _, err = dest.Exec("SELECT setval(pg_get_serial_sequence('signald_groups', 'rowid'), (SELECT MAX(rowid) FROM signald_groups)+1)") if err != nil { return err } From 21420e0d77d29cc13d6dfa540869954b75f30bc5 Mon Sep 17 00:00:00 2001 From: finn Date: Wed, 2 Mar 2022 13:10:41 -0800 Subject: [PATCH 04/37] pending account data table uses string account identifier not uuid --- cmd/signaldctl/cmd/db/migrate.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index b3ea5e3..6edb49c 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -385,15 +385,15 @@ func movePendingAccountData(source *sql.DB, dest *sql.DB) error { for rows.Next() { var ( - accountUUID uuid.UUID - key string - value []byte + username string + key string + value []byte ) - err = rows.Scan(&accountUUID, &key, &value) + err = rows.Scan(&username, &key, &value) if err != nil { return err } - _, err = dest.Exec("INSERT INTO signald_pending_account_data (username, key, value) VALUES ($1, $2, $3)", accountUUID, key, value) + _, err = dest.Exec("INSERT INTO signald_pending_account_data (username, key, value) VALUES ($1, $2, $3)", username, key, value) if err != nil { return err } From fa1f0765d5b5863dcbedb595fa951c1dd11d7415 Mon Sep 17 00:00:00 2001 From: finn Date: Wed, 2 Mar 2022 13:42:12 -0800 Subject: [PATCH 05/37] allow null recipient UUIDs --- cmd/signaldctl/cmd/db/migrate.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 6edb49c..01e1d4a 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -218,7 +218,7 @@ func moveRecipients(source *sql.DB, dest *sql.DB) error { var ( rowID int64 accountUUID uuid.UUID - recipientUUID uuid.UUID + recipientUUID uuid.NullUUID e164 sql.NullString ) err = rows.Scan(&rowID, &accountUUID, &recipientUUID, &e164) From 8bb40967e5858ee8c93debc65f56c3eb218fe83d Mon Sep 17 00:00:00 2001 From: finn Date: Wed, 2 Mar 2022 15:16:25 -0800 Subject: [PATCH 06/37] forget e164s that don't start with a + --- cmd/signaldctl/cmd/db/migrate.go | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 01e1d4a..0bb6c9b 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -7,6 +7,7 @@ import ( "log" "os" "os/user" + "strings" "time" "github.com/lib/pq" @@ -225,6 +226,13 @@ func moveRecipients(source *sql.DB, dest *sql.DB) error { if err != nil { return err } + + if e164.Valid && !strings.HasPrefix(e164.String, "+") { + log.Println("corrupt e164 found, setting to null") + e164.Valid = false + e164.String = "" + } + _, err = dest.Exec("INSERT INTO signald_recipients (rowid, account_uuid, uuid, e164) VALUES ($1, $2, $3, $4)", rowID, accountUUID, recipientUUID, e164) if err != nil { return err From 689d560eb17da613d057097545b8d205e32c22e4 Mon Sep 17 00:00:00 2001 From: Sumner Evans Date: Mon, 7 Mar 2022 21:03:24 -0700 Subject: [PATCH 07/37] move script: update for new contacts table --- cmd/signaldctl/cmd/db/migrate.go | 67 +++++++++++++++++++++++++++++-- cmd/signaldctl/cmd/db/postgres.go | 12 ++++++ 2 files changed, 75 insertions(+), 4 deletions(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 0bb6c9b..8aa5c43 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -148,6 +148,12 @@ var ( } log.Println("moved group credentials table") + if err := moveContacts(source, dest); err != nil { + log.Println("error migrating group credentials table") + return err + } + log.Println("moved contacts table") + if err := os.Remove(sqlitePath); err != nil { log.Println("error deleting sqlite file") return err @@ -159,14 +165,26 @@ var ( ) func verifyMigration(source *sql.DB) error { - rows, err := source.Query("SELECT * FROM flyway_schema_history WHERE version = 11") + // Lower bound of the database state. + rows, err := source.Query("SELECT * FROM flyway_schema_history WHERE version = 12") if err != nil { return err } defer rows.Close() if !rows.Next() { - return errors.New("source database is not up to date! Please update to signald 0.17.0-16-5101c6ef and start it to move the sqlite database to an acceptable format") + return errors.New("source database is not up to date! Please update signald and start it to move the sqlite database to an acceptable format") + } + + // Upper bound of the database state + rows, err = source.Query("SELECT * FROM flyway_schema_history WHERE version = 13") + if err != nil { + return err + } + defer rows.Close() + + if rows.Next() { + return errors.New("source database is too new! Please update signaldctl to the latest version") } return nil } @@ -177,8 +195,16 @@ func createSchema(dest *sql.DB) error { return err } - _, err = dest.Exec("INSERT INTO flyway_schema_history (installed_rank, version, description, type, script, checksum, installed_by, execution_time, success) VALUES ($1, $2, $3, $4, $5, $6, current_user, $7, $8)", - 1, 1, "create tables", "SQL", "V1__create_tables.sql", -1247750968, 0, true) + _, err = dest.Exec(` + INSERT INTO flyway_schema_history + (installed_rank, version, description, type, script, checksum, installed_by, execution_time, success) + VALUES ($1, $2, $3, $4, $5, $6, current_user, $7, $8), + ($9, $10, $11, $12, $13, $14, current_user, $15, $16) + `, + // Row 1 + 1, 1, "create tables", "SQL", "V1__create_tables.sql", -1247750968, 0, true, + // Row 2 + 2, 12, "create contacts table", "SQL", "V12__create_contacts_table.sql", -852729911, 0, true) return err } @@ -541,3 +567,36 @@ func moveGroupCredentials(source *sql.DB, dest *sql.DB) error { } return nil } + +func moveContacts(source *sql.DB, dest *sql.DB) error { + rows, err := source.Query("SELECT account_uuid, recipient, name, color, profile_key, message_expiration_time, inbox_position FROM contacts") + if err != nil { + return err + } + defer rows.Close() + + for rows.Next() { + var ( + accountUUID uuid.UUID + recipient int64 + name sql.NullString + color sql.NullString + profile_key []byte + message_expiration_time sql.NullInt64 + inbox_position sql.NullInt64 + ) + err = rows.Scan(&accountUUID, &recipient, &name, &color, &profile_key, &message_expiration_time, &inbox_position) + if err != nil { + return err + } + _, err = dest.Exec(` + INSERT INTO signald_contacts + (account_uuid, recipient, name, color, profile_key, message_expiration_time, inbox_position) + VALUES ($1, $2, $3, $4, $5, $6, $7) + `, accountUUID, recipient, name, color, profile_key, message_expiration_time, inbox_position) + if err != nil { + return err + } + } + return nil +} diff --git a/cmd/signaldctl/cmd/db/postgres.go b/cmd/signaldctl/cmd/db/postgres.go index af2776a..47f7388 100644 --- a/cmd/signaldctl/cmd/db/postgres.go +++ b/cmd/signaldctl/cmd/db/postgres.go @@ -215,5 +215,17 @@ var ( execution_time integer NOT NULL, success boolean NOT NULL ); + + CREATE TABLE signald_contacts ( + account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, + recipient INTEGER NOT NULL REFERENCES signald_recipients(rowid) ON DELETE CASCADE, + name TEXT, + color TEXT, + profile_key BYTEA, + message_expiration_time INTEGER, + inbox_position INTEGER, + + PRIMARY KEY (account_uuid, recipient) + ); ` ) From 3ccb424f53061658112c2735ff104352bf20a283 Mon Sep 17 00:00:00 2001 From: finn Date: Tue, 15 Mar 2022 19:04:35 -0700 Subject: [PATCH 08/37] don't push messages with IDs to the channel --- signald/signald.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/signald/signald.go b/signald/signald.go index 5a0f9d8..0cfd740 100644 --- a/signald/signald.go +++ b/signald/signald.go @@ -125,7 +125,7 @@ func (s *Signald) Listen(c chan client_protocol.BasicResponse) { subscribers <- msg } - if c != nil { + if c != nil && msg.ID == "" && msg.Type != "version" { c <- msg } } From 4bc97fb829f6be1a24b5da73bbeab95bdac7f119 Mon Sep 17 00:00:00 2001 From: finn Date: Fri, 18 Mar 2022 19:10:36 -0700 Subject: [PATCH 09/37] add signaldctl subscribe subcommand with initial test at a parsable output format --- cmd/signaldctl/cmd/subscribe.go | 96 +++++++++++++++++++++++++++++ signald/client-protocol/protocol.go | 12 ++-- signald/signald.go | 2 +- 3 files changed, 103 insertions(+), 7 deletions(-) create mode 100644 cmd/signaldctl/cmd/subscribe.go diff --git a/cmd/signaldctl/cmd/subscribe.go b/cmd/signaldctl/cmd/subscribe.go new file mode 100644 index 0000000..dfa0638 --- /dev/null +++ b/cmd/signaldctl/cmd/subscribe.go @@ -0,0 +1,96 @@ +package cmd + +import ( + "encoding/json" + "fmt" + "log" + "os" + + "github.com/spf13/cobra" + + "gitlab.com/signald/signald-go/cmd/signaldctl/common" + "gitlab.com/signald/signald-go/cmd/signaldctl/config" + client_protocol "gitlab.com/signald/signald-go/signald/client-protocol" + v1 "gitlab.com/signald/signald-go/signald/client-protocol/v1" +) + +var ( + accountIdentifier string + subscribeCmd = &cobra.Command{ + Use: "subscribe", + Short: "subscribe to incoming messages from signald", + Long: `subscribe to incoming messages from signald. + + if no default account is set, the -a/--account argument is required. + + the default output format (-o default) is being worked on, subject to change and should not be relied upon. Thoughts? come by the #signald IRC/matrix room + + if you want to future-proof your scripts, use json output (-o json) and parse it.`, + PreRun: func(cmd *cobra.Command, args []string) { + if accountIdentifier == "" { + accountIdentifier = config.Config.DefaultAccount + } + if accountIdentifier == "" { + common.Must(cmd.Help()) + log.Fatal("No account specified. Please specify with --account or set a default") + } + }, + RunE: func(cmd *cobra.Command, args []string) error { + incoming := make(chan client_protocol.BasicResponse) + go common.Signald.Listen(incoming) + + req := v1.SubscribeRequest{Account: accountIdentifier} + err := req.Submit(common.Signald) + if err != nil { + panic(err) + } + + for msg := range incoming { + switch common.OutputFormat { + case common.OutputFormatDefault: + if msg.Type != "IncomingMessage" { + continue + } + var data v1.IncomingMessage + err := json.Unmarshal(msg.Data, &data) + if err != nil { + panic(err) + } + + if data.DataMessage == nil { + continue + } + + group := "-" + if data.DataMessage.GroupV2 != nil { + group = fmt.Sprintf("%s|%d", data.DataMessage.GroupV2.ID, data.DataMessage.GroupV2.Revision) + } + + attachment := "-" + if len(data.DataMessage.Attachments) > 0 { + attachment = data.DataMessage.Attachments[0].StoredFilename + } + + body := "-" + if data.DataMessage.Body != "" { + body = data.DataMessage.Body + } + fmt.Println(data.DataMessage.Timestamp, data.Account, data.Source.UUID, group, attachment, body) + case common.OutputFormatJSON: + err := json.NewEncoder(os.Stdout).Encode(msg) + if err != nil { + panic(err) + } + default: + log.Fatal("unsupported output format") + } + } + return nil + }, + } +) + +func init() { + subscribeCmd.Flags().StringVarP(&accountIdentifier, "account", "a", "", "the signald account to use") + RootCmd.AddCommand(subscribeCmd) +} diff --git a/signald/client-protocol/protocol.go b/signald/client-protocol/protocol.go index 1403b18..c0cb562 100644 --- a/signald/client-protocol/protocol.go +++ b/signald/client-protocol/protocol.go @@ -5,10 +5,10 @@ import ( ) type BasicResponse struct { - ID string - Type string - ErrorType string - Error json.RawMessage - Data json.RawMessage - Account string + ID string `json:"id,omitempty"` + Type string `json:"type,omitempty"` + ErrorType string `json:"error_type,omitempty"` + Error json.RawMessage `json:"error,omitempty"` + Data json.RawMessage `json:"data,omitempty"` + Account string `json:"account,omitempty"` } diff --git a/signald/signald.go b/signald/signald.go index 0cfd740..9f646f0 100644 --- a/signald/signald.go +++ b/signald/signald.go @@ -125,7 +125,7 @@ func (s *Signald) Listen(c chan client_protocol.BasicResponse) { subscribers <- msg } - if c != nil && msg.ID == "" && msg.Type != "version" { + if c != nil && !(msg.ID == "" && msg.Type == "version") { c <- msg } } From 0f3e6dce72d4e61a2450a4271bd6ac434b98b0f6 Mon Sep 17 00:00:00 2001 From: finn Date: Sat, 19 Mar 2022 01:38:25 -0700 Subject: [PATCH 10/37] allow send to accept message from stdin --- .../cmd/message/send/send-message.go | 21 +++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/cmd/signaldctl/cmd/message/send/send-message.go b/cmd/signaldctl/cmd/message/send/send-message.go index e4f705e..81b4f44 100644 --- a/cmd/signaldctl/cmd/message/send/send-message.go +++ b/cmd/signaldctl/cmd/message/send/send-message.go @@ -18,6 +18,7 @@ package send import ( "encoding/json" "fmt" + "io/ioutil" "log" "os" "path/filepath" @@ -37,9 +38,10 @@ var ( toAddress *v1.JsonAddress toGroup string attachments []string + message string SendMessageCmd = &cobra.Command{ - Use: "send ", + Use: "send {group id | phone number} [message]", Short: "send a message", PreRun: func(cmd *cobra.Command, args []string) { if account == "" { @@ -49,9 +51,20 @@ var ( common.Must(cmd.Help()) log.Fatal("No account specified. Please specify with --account or set a default") } - if len(args) < 2 { + if len(args) < 1 { common.Must(cmd.Help()) - log.Fatal("must specify both destination (either group id or phone number) and message") + log.Fatal("must specify both destination (either group id or phone number)") + } + + if len(args) == 1 { + messageBytes, err := ioutil.ReadAll(os.Stdin) + if err != nil { + log.Println("error reading message from stdin, perhaps you meant to include it in the command line arguments?") + panic(err) + } + message = string(messageBytes) + } else { + message = strings.Join(args[1:], " ") } to, err := common.StringToAddress(args[0]) if err != nil { @@ -65,7 +78,7 @@ var ( req := v1.SendRequest{ Username: account, - MessageBody: strings.Join(args[1:], " "), + MessageBody: message, Attachments: []*v1.JsonAttachment{}, RecipientAddress: toAddress, RecipientGroupID: toGroup, From 2b1f0dada7602ce8746d132ec68821fb47bf23d0 Mon Sep 17 00:00:00 2001 From: finn Date: Sat, 19 Mar 2022 16:57:19 -0700 Subject: [PATCH 11/37] don't panic if we can't unmarshal a message from signald --- cmd/signaldctl/cmd/subscribe.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/signaldctl/cmd/subscribe.go b/cmd/signaldctl/cmd/subscribe.go index dfa0638..b649b22 100644 --- a/cmd/signaldctl/cmd/subscribe.go +++ b/cmd/signaldctl/cmd/subscribe.go @@ -54,7 +54,7 @@ var ( var data v1.IncomingMessage err := json.Unmarshal(msg.Data, &data) if err != nil { - panic(err) + continue } if data.DataMessage == nil { From 7ff54921568d266d52e858d23dec353e0dad14ae Mon Sep 17 00:00:00 2001 From: finn Date: Sat, 19 Mar 2022 22:44:31 -0700 Subject: [PATCH 12/37] expose close() option for socket --- signald/signald.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/signald/signald.go b/signald/signald.go index 9f646f0..202ec46 100644 --- a/signald/signald.go +++ b/signald/signald.go @@ -99,6 +99,11 @@ func (s *Signald) connect() error { return nil } + +func (s *Signald) Close() error { + return s.socket.Close() +} + // Listen listens for events from signald func (s *Signald) Listen(c chan client_protocol.BasicResponse) { for { From ec276e54113b360b6e22cc6cb78df038ecb157a1 Mon Sep 17 00:00:00 2001 From: finn Date: Fri, 25 Mar 2022 22:26:47 -0700 Subject: [PATCH 13/37] add group preview subcommand --- cmd/signaldctl/cmd/group/preview/preview.go | 78 +++++++++++++++++++++ cmd/signaldctl/cmd/group/root.go | 2 + 2 files changed, 80 insertions(+) create mode 100644 cmd/signaldctl/cmd/group/preview/preview.go diff --git a/cmd/signaldctl/cmd/group/preview/preview.go b/cmd/signaldctl/cmd/group/preview/preview.go new file mode 100644 index 0000000..43cf888 --- /dev/null +++ b/cmd/signaldctl/cmd/group/preview/preview.go @@ -0,0 +1,78 @@ +// Copyright © 2021 Finn Herzfeld +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +package preview + +import ( + "encoding/json" + "errors" + "log" + "os" + "strings" + + "github.com/spf13/cobra" + + "gitlab.com/signald/signald-go/cmd/signaldctl/common" + "gitlab.com/signald/signald-go/cmd/signaldctl/config" + "gitlab.com/signald/signald-go/signald/client-protocol/v1" +) + +var ( + account string + joinURL string + PreviewGroupCmd = &cobra.Command{ + Use: "preview https://signal.group/...", + Short: "preview information about a group without joining", + PreRunE: func(cmd *cobra.Command, args []string) error { + if account == "" { + account = config.Config.DefaultAccount + } + if account == "" { + common.Must(cmd.Help()) + log.Fatal("No account specified. Please specify with --account or set a default") + } + + if len(args) == 0 { + return errors.New("please specify signald.group URL") + } + joinURL = args[0] + + if !strings.HasPrefix(joinURL, "https://signal.group/#") { + return errors.New("invalid group link (must start with https://signal.group/#") + } + + return nil + }, + RunE: func(_ *cobra.Command, args []string) error { + go common.Signald.Listen(nil) + req := v1.GroupLinkInfoRequest{ + Account: account, + Uri: joinURL, + } + + info, err := req.Submit(common.Signald) + if err != nil { + return err + } + + switch common.OutputFormat { + case common.OutputFormatJSON, common.OutputFormatDefault: + return json.NewEncoder(os.Stdout).Encode(info) + } + + return nil + }, + } +) diff --git a/cmd/signaldctl/cmd/group/root.go b/cmd/signaldctl/cmd/group/root.go index 3f7d0ea..8be78ea 100644 --- a/cmd/signaldctl/cmd/group/root.go +++ b/cmd/signaldctl/cmd/group/root.go @@ -24,6 +24,7 @@ import ( "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/group/join" "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/group/leave" "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/group/list" + "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/group/preview" "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/group/removemember" "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/group/show" "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/group/update" @@ -41,6 +42,7 @@ func init() { GroupCmd.AddCommand(join.JoinGroupCmd) GroupCmd.AddCommand(leave.LeaveGroupCmd) GroupCmd.AddCommand(list.ListGroupCmd) + GroupCmd.AddCommand(preview.PreviewGroupCmd) GroupCmd.AddCommand(removemember.RemoveMemberCmd) GroupCmd.AddCommand(show.ShowGroupCmd) GroupCmd.AddCommand(update.UpdateGroupCmd) From d8fdb8edb00733761e1e2b1087b15309dfc20d56 Mon Sep 17 00:00:00 2001 From: finn Date: Sat, 26 Mar 2022 01:23:26 -0700 Subject: [PATCH 14/37] add table output to preview subcommand --- cmd/signaldctl/cmd/group/preview/preview.go | 26 ++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/cmd/signaldctl/cmd/group/preview/preview.go b/cmd/signaldctl/cmd/group/preview/preview.go index 43cf888..4f51e77 100644 --- a/cmd/signaldctl/cmd/group/preview/preview.go +++ b/cmd/signaldctl/cmd/group/preview/preview.go @@ -22,7 +22,9 @@ import ( "os" "strings" + "github.com/jedib0t/go-pretty/v6/table" "github.com/spf13/cobra" + "gopkg.in/yaml.v2" "gitlab.com/signald/signald-go/cmd/signaldctl/common" "gitlab.com/signald/signald-go/cmd/signaldctl/config" @@ -68,8 +70,30 @@ var ( } switch common.OutputFormat { - case common.OutputFormatJSON, common.OutputFormatDefault: + case common.OutputFormatJSON: return json.NewEncoder(os.Stdout).Encode(info) + case common.OutputFormatYAML: + return yaml.NewEncoder(os.Stdout).Encode(info) + case common.OutputFormatDefault, common.OutputFormatTable: + t := table.NewWriter() + t.SetOutputMirror(os.Stdout) + + joinApproval := "unknown" + switch info.AddFromInviteLink { + case 3: + joinApproval = "yes" + case 1: + joinApproval = "no" + } + + t.AppendRows([]table.Row{ + table.Row{"Title", info.Title}, + table.Row{"Group ID", info.GroupID}, + table.Row{"Member Count", info.MemberCount}, + table.Row{"Membership Approval", joinApproval}, + }) + common.StylizeTable(t) + t.Render() } return nil From 0ff6400ce7a8b4c9a282611ce5233e5a0db98b5f Mon Sep 17 00:00:00 2001 From: finn Date: Mon, 28 Mar 2022 09:42:37 -0700 Subject: [PATCH 15/37] signaldctl: create config directory if missing --- cmd/signaldctl/config/config.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/cmd/signaldctl/config/config.go b/cmd/signaldctl/config/config.go index 319f0a1..41de719 100644 --- a/cmd/signaldctl/config/config.go +++ b/cmd/signaldctl/config/config.go @@ -18,6 +18,7 @@ package config import ( "log" "os" + "path" "gopkg.in/yaml.v2" ) @@ -54,6 +55,9 @@ func Load() error { } func Save() error { + if err := os.MkdirAll(path.Dir(Path), 0660); err != nil { + return err + } f, err := os.Create(Path) if err != nil { return err From e8131dc92864034910703f1125f4011a5f3e6512 Mon Sep 17 00:00:00 2001 From: finn Date: Mon, 28 Mar 2022 10:06:22 -0700 Subject: [PATCH 16/37] fix mode on created directories --- cmd/signaldctl/config/config.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/signaldctl/config/config.go b/cmd/signaldctl/config/config.go index 41de719..ea5c391 100644 --- a/cmd/signaldctl/config/config.go +++ b/cmd/signaldctl/config/config.go @@ -55,7 +55,7 @@ func Load() error { } func Save() error { - if err := os.MkdirAll(path.Dir(Path), 0660); err != nil { + if err := os.MkdirAll(path.Dir(Path), 0770); err != nil { return err } f, err := os.Create(Path) From 4e3feffaad86e72d891a8defa60addda738bb044 Mon Sep 17 00:00:00 2001 From: finn Date: Sun, 10 Apr 2022 15:38:12 -0700 Subject: [PATCH 17/37] force linter job to golang 1.17 as golangci-lint seems to break on 1.18 --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 9c3dc5d..9802ce6 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -3,7 +3,7 @@ stages: - publish lint: - image: golang:latest + image: golang:1.17 stage: build before_script: - apt-get update From 204657b38bf5396132b39bc36f9f22c33138fd17 Mon Sep 17 00:00:00 2001 From: Ben Wiederhake Date: Sun, 10 Apr 2022 01:46:46 +0200 Subject: [PATCH 18/37] avoid races when sending requests --- signald/client-protocol/v1/requests.go | 235 ++++++++++--------------- tools/generator/requests.go.tmpl | 5 +- 2 files changed, 96 insertions(+), 144 deletions(-) diff --git a/signald/client-protocol/v1/requests.go b/signald/client-protocol/v1/requests.go index a59691b..03388b9 100644 --- a/signald/client-protocol/v1/requests.go +++ b/signald/client-protocol/v1/requests.go @@ -16,15 +16,14 @@ func (r *AcceptInvitationRequest) Submit(conn *signald.Signald) (response JsonGr if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -49,15 +48,14 @@ func (r *AddLinkedDeviceRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -75,15 +73,14 @@ func (r *AddServerRequest) Submit(conn *signald.Signald) (response string, err e if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -108,15 +105,14 @@ func (r *ApproveMembershipRequest) Submit(conn *signald.Signald) (response JsonG if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -140,15 +136,14 @@ func (r *CreateGroupRequest) Submit(conn *signald.Signald) (response JsonGroupV2 if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -173,15 +168,14 @@ func (r *DeleteAccountRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -198,15 +192,14 @@ func (r *RemoveServerRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -224,15 +217,14 @@ func (r *FinishLinkRequest) Submit(conn *signald.Signald) (response Account, err if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -257,15 +249,14 @@ func (r *GenerateLinkingURIRequest) Submit(conn *signald.Signald) (response Link if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -290,15 +281,14 @@ func (r *GetAllIdentities) Submit(conn *signald.Signald) (response AllIdentityKe if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -323,15 +313,14 @@ func (r *GetGroupRequest) Submit(conn *signald.Signald) (response JsonGroupV2Inf if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -356,15 +345,14 @@ func (r *GetIdentitiesRequest) Submit(conn *signald.Signald) (response IdentityK if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -389,15 +377,14 @@ func (r *GetLinkedDevicesRequest) Submit(conn *signald.Signald) (response Linked if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -422,15 +409,14 @@ func (r *GetProfileRequest) Submit(conn *signald.Signald) (response Profile, err if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -455,15 +441,14 @@ func (r *RemoteConfigRequest) Submit(conn *signald.Signald) (response RemoteConf if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -487,15 +472,14 @@ func (r *GetServersRequest) Submit(conn *signald.Signald) (response ServerList, if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -520,15 +504,14 @@ func (r *GroupLinkInfoRequest) Submit(conn *signald.Signald) (response JsonGroup if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -553,15 +536,14 @@ func (r *IsIdentifierRegisteredRequest) Submit(conn *signald.Signald) (response if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -586,15 +568,14 @@ func (r *JoinGroupRequest) Submit(conn *signald.Signald) (response JsonGroupJoin if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -618,15 +599,14 @@ func (r *LeaveGroupRequest) Submit(conn *signald.Signald) (response GroupInfo, e if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -651,15 +631,14 @@ func (r *ListAccountsRequest) Submit(conn *signald.Signald) (response AccountLis if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -683,15 +662,14 @@ func (r *ListContactsRequest) Submit(conn *signald.Signald) (response ProfileLis if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -715,15 +693,14 @@ func (r *ListGroupsRequest) Submit(conn *signald.Signald) (response GroupList, e if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -747,15 +724,14 @@ func (r *MarkReadRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -773,15 +749,14 @@ func (r *ReactRequest) Submit(conn *signald.Signald) (response SendResponse, err if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -806,15 +781,14 @@ func (r *RefuseMembershipRequest) Submit(conn *signald.Signald) (response JsonGr if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -839,15 +813,14 @@ func (r *RegisterRequest) Submit(conn *signald.Signald) (response Account, err e if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -872,15 +845,14 @@ func (r *RemoteDeleteRequest) Submit(conn *signald.Signald) (response SendRespon if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -905,15 +877,14 @@ func (r *RemoveLinkedDeviceRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -931,15 +902,14 @@ func (r *RequestSyncRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -957,15 +927,14 @@ func (r *ResetSessionRequest) Submit(conn *signald.Signald) (response SendRespon if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -990,15 +959,14 @@ func (r *ResolveAddressRequest) Submit(conn *signald.Signald) (response JsonAddr if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1022,15 +990,14 @@ func (r *SendRequest) Submit(conn *signald.Signald) (response SendResponse, err if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1055,15 +1022,14 @@ func (r *SendPaymentRequest) Submit(conn *signald.Signald) (response SendRespons if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1088,15 +1054,14 @@ func (r *SetDeviceNameRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1114,15 +1079,14 @@ func (r *SetExpirationRequest) Submit(conn *signald.Signald) (response SendRespo if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1146,15 +1110,14 @@ func (r *SetProfile) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1171,15 +1134,14 @@ func (r *SubmitChallengeRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1197,15 +1159,14 @@ func (r *SubscribeRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1223,15 +1184,14 @@ func (r *TrustRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1249,15 +1209,14 @@ func (r *TypingRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1275,15 +1234,14 @@ func (r *UnsubscribeRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1301,15 +1259,14 @@ func (r *UpdateContactRequest) Submit(conn *signald.Signald) (response Profile, if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1334,15 +1291,14 @@ func (r *UpdateGroupRequest) Submit(conn *signald.Signald) (response GroupInfo, if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1367,15 +1323,14 @@ func (r *VerifyRequest) Submit(conn *signald.Signald) (response Account, err err if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1399,15 +1354,14 @@ func (r *VersionRequest) Submit(conn *signald.Signald) (response JsonVersionMess if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) @@ -1432,15 +1386,14 @@ func (r *WaitForScanRequest) Submit(conn *signald.Signald) (err error) { if r.ID == "" { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <-responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) diff --git a/tools/generator/requests.go.tmpl b/tools/generator/requests.go.tmpl index fe08ac1..6be8d72 100644 --- a/tools/generator/requests.go.tmpl +++ b/tools/generator/requests.go.tmpl @@ -22,15 +22,14 @@ func {{$action.FnName}}(conn *signald.Signald) ({{if ne $action.Response ""}}res if(r.ID == "") { r.ID = signald.GenerateID() } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) err = conn.RawRequest(r) if err != nil { log.Println("signald-go: error submitting request to signald") return } - responseChannel := conn.GetResponseListener(r.ID) - defer conn.CloseResponseListener(r.ID) - rawResponse := <- responseChannel if rawResponse.Error != nil { err = mkerr(rawResponse) From e50f39228854663437d2f7484fcf941c259aef53 Mon Sep 17 00:00:00 2001 From: finn Date: Mon, 25 Apr 2022 17:05:37 -0700 Subject: [PATCH 19/37] add signaldctl account request-sync --- .../cmd/account/requestsync/main.go | 36 +++++++++++++++++++ cmd/signaldctl/cmd/account/root.go | 6 ++-- 2 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 cmd/signaldctl/cmd/account/requestsync/main.go diff --git a/cmd/signaldctl/cmd/account/requestsync/main.go b/cmd/signaldctl/cmd/account/requestsync/main.go new file mode 100644 index 0000000..480a595 --- /dev/null +++ b/cmd/signaldctl/cmd/account/requestsync/main.go @@ -0,0 +1,36 @@ +package requestsync + +import ( + "log" + + "github.com/spf13/cobra" + "gitlab.com/signald/signald-go/cmd/signaldctl/common" + "gitlab.com/signald/signald-go/cmd/signaldctl/config" + v1 "gitlab.com/signald/signald-go/signald/client-protocol/v1" +) + +var ( + account string + RequestSyncCmd = &cobra.Command{ + Use: "request-sync", + Short: "Ask other devices on the account to send sync data. Must subscribe for result", + PreRun: func(cmd *cobra.Command, args []string) { + if account == "" { + account = config.Config.DefaultAccount + } + }, + Run: func(_ *cobra.Command, _ []string) { + go common.Signald.Listen(nil) + req := &v1.RequestSyncRequest{Account: account} + err := req.Submit(common.Signald) + if err != nil { + panic(err) + } + log.Println("sync requested. Must be subscribed to receive response") + }, + } +) + +func init() { + RequestSyncCmd.Flags().StringVarP(&account, "account", "a", "", "the signald account to use") +} diff --git a/cmd/signaldctl/cmd/account/root.go b/cmd/signaldctl/cmd/account/root.go index 2888868..aca722e 100644 --- a/cmd/signaldctl/cmd/account/root.go +++ b/cmd/signaldctl/cmd/account/root.go @@ -23,6 +23,7 @@ import ( "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/account/list" "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/account/register" "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/account/remoteconfig" + "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/account/requestsync" "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/account/setprofile" "gitlab.com/signald/signald-go/cmd/signaldctl/cmd/account/verify" ) @@ -37,7 +38,8 @@ func init() { AccountCmd.AddCommand(link.LinkAccountCmd) AccountCmd.AddCommand(list.ListAccountCmd) AccountCmd.AddCommand(register.RegisterAccountCmd) - AccountCmd.AddCommand(verify.VerifyAccountCmd) - AccountCmd.AddCommand(setprofile.SetProfileCmd) AccountCmd.AddCommand(remoteconfig.RemoteConfigCmd) + AccountCmd.AddCommand(requestsync.RequestSyncCmd) + AccountCmd.AddCommand(setprofile.SetProfileCmd) + AccountCmd.AddCommand(verify.VerifyAccountCmd) } From 8458f63316a68be3277f4c1ddd6a503c49b133b6 Mon Sep 17 00:00:00 2001 From: finn Date: Mon, 25 Apr 2022 17:21:52 -0700 Subject: [PATCH 20/37] update db-move to support migration version 14 --- cmd/signaldctl/cmd/db/migrate.go | 23 ++++++++------ cmd/signaldctl/cmd/db/postgres.go | 53 ++++++++++++++++--------------- 2 files changed, 40 insertions(+), 36 deletions(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 8aa5c43..ecc8cc6 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -17,6 +17,8 @@ import ( "gitlab.com/signald/signald-go/cmd/signaldctl/common" ) +const expectedMigrationVersion = "14" + var ( sqlitePath string postgresURL string @@ -25,7 +27,7 @@ var ( Short: "move a signald database from sqlite to postgres", Long: `move a signald sqlite database into a postgres database. If sqlite-path is not specified, the default (~/.config/signald/signald.db) will be used. - + Please note that signald must NOT be running while this command runs. After the data is moved, the sqlite file will be deleted`, @@ -166,7 +168,7 @@ var ( func verifyMigration(source *sql.DB) error { // Lower bound of the database state. - rows, err := source.Query("SELECT * FROM flyway_schema_history WHERE version = 12") + rows, err := source.Query("SELECT version FROM flyway_schema_history ORDER BY installed_rank DESC LIMIT 1") if err != nil { return err } @@ -176,16 +178,16 @@ func verifyMigration(source *sql.DB) error { return errors.New("source database is not up to date! Please update signald and start it to move the sqlite database to an acceptable format") } - // Upper bound of the database state - rows, err = source.Query("SELECT * FROM flyway_schema_history WHERE version = 13") + var version string + err = rows.Scan(&version) if err != nil { return err } - defer rows.Close() - if rows.Next() { - return errors.New("source database is too new! Please update signaldctl to the latest version") + if version != expectedMigrationVersion { + return fmt.Errorf("source database must be on migration %s (found %s instead)", expectedMigrationVersion, version) } + return nil } @@ -235,7 +237,7 @@ func moveAccounts(source *sql.DB, dest *sql.DB) error { } func moveRecipients(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT rowid, account_uuid, uuid, e164 FROM recipients") + rows, err := source.Query("SELECT rowid, account_uuid, uuid, e164, registered FROM recipients") if err != nil { return err } @@ -247,8 +249,9 @@ func moveRecipients(source *sql.DB, dest *sql.DB) error { accountUUID uuid.UUID recipientUUID uuid.NullUUID e164 sql.NullString + registered bool ) - err = rows.Scan(&rowID, &accountUUID, &recipientUUID, &e164) + err = rows.Scan(&rowID, &accountUUID, &recipientUUID, &e164, ®istered) if err != nil { return err } @@ -259,7 +262,7 @@ func moveRecipients(source *sql.DB, dest *sql.DB) error { e164.String = "" } - _, err = dest.Exec("INSERT INTO signald_recipients (rowid, account_uuid, uuid, e164) VALUES ($1, $2, $3, $4)", rowID, accountUUID, recipientUUID, e164) + _, err = dest.Exec("INSERT INTO signald_recipients (rowid, account_uuid, uuid, e164, registered) VALUES ($1, $2, $3, $4, $5)", rowID, accountUUID, recipientUUID, e164, registered) if err != nil { return err } diff --git a/cmd/signaldctl/cmd/db/postgres.go b/cmd/signaldctl/cmd/db/postgres.go index 47f7388..50952d1 100644 --- a/cmd/signaldctl/cmd/db/postgres.go +++ b/cmd/signaldctl/cmd/db/postgres.go @@ -17,7 +17,7 @@ var ( server_delivered_timestamp BIGINT, server_uuid UUID ); - + CREATE TABLE signald_servers ( server_uuid UUID PRIMARY KEY, service_url TEXT NOT NULL, @@ -35,7 +35,7 @@ var ( cds_mrenclave VARCHAR(64), ias_ca BYTEA ); - + INSERT INTO signald_servers VALUES ( '6e2eb5a8-5706-45d0-8377-127a816411a4', -- server_uuid @@ -89,79 +89,80 @@ var ( -- ias_ca E'\\x00000002000000141e139877c131235200356d48d741b9e8538d4a290000078101000369617300000164adeb7976000000000005582e3530390000054f3082054b308203b3a003020102020900d107765d32a3b094300d06092a864886f70d01010b0500307e310b3009060355040613025553310b300906035504080c0243413114301206035504070c0b53616e746120436c617261311a3018060355040a0c11496e74656c20436f72706f726174696f6e3130302e06035504030c27496e74656c20534758204174746573746174696f6e205265706f7274205369676e696e672043413020170d3136313131343135333733315a180f32303439313233313233353935395a307e310b3009060355040613025553310b300906035504080c0243413114301206035504070c0b53616e746120436c617261311a3018060355040a0c11496e74656c20436f72706f726174696f6e3130302e06035504030c27496e74656c20534758204174746573746174696f6e205265706f7274205369676e696e67204341308201a2300d06092a864886f70d01010105000382018f003082018a02820181009f3c647eb5773cbb512d2732c0d7415ebb55a0fa9ede2e649199e6821db910d53177370977466a6a5e4786ccd2ddebd4149d6a2f6325529dd10cc98737b0779c1a07e29c47a1ae004948476c489f45a5a15d7ac8ecc6acc645adb43d87679df59c093bc5a2e9696c5478541b979e754b573914be55d32ff4c09ddf27219934cd990527b3f92ed78fbf29246abecb71240ef39c2d7107b447545a7ffb10eb060a68a98580219e36910952683892d6a5e2a80803193e407531404e36b315623799aa825074409754a2dfe8f5afd5fe631e1fc2af3808906f28a790d9dd9fe060939b125790c5805d037df56a99531b96de69de33ed226cc1207d1042b5c9ab7f404fc711c0fe4769fb9578b1dc0ec469ea1a25e0ff9914886ef2699b235bb4847dd6ff40b606e6170793c2fb98b314587f9cfd257362dfeab10b3bd2d97673a1a4bd44c453aaf47fc1f2d3d0f384f74a06f89c089f0da6cdb7fceee8c9821a8e54f25c0416d18c46839a5f8012fbdd3dc74d256279adc2c0d55aff6f0622425d1b0203010001a381c93081c630600603551d1f045930573055a053a051864f687474703a2f2f7472757374656473657276696365732e696e74656c2e636f6d2f636f6e74656e742f43524c2f5347582f4174746573746174696f6e5265706f72745369676e696e6743412e63726c301d0603551d0e0416041478437b76a67ebcd0af7e4237eb357c3b8701513c301f0603551d2304183016801478437b76a67ebcd0af7e4237eb357c3b8701513c300e0603551d0f0101ff04040302010630120603551d130101ff040830060101ff020100300d06092a864886f70d01010b05000382018100785f2d60c5c80af42a797610213915da82c9b29e89e0902a25a6c75b16091c68ab204aae711889492c7e1e320911455a8fc13442312e77a63994d99795c8ea4576823cea8ad1e191cfa862fab8a932d3d9b0535a0702d0555f74e520e30330f33480e7adc9d7c81e20703142bf00c528a80b463381fd602a82c7035281aae59562ccb5334ea8903e650b010681f5ce8eb62eac9c414988243aec92f25bf13cdff7ebcc298ee51bba5a3538b66b26cbc45a51de003cad306531ad7cf5d4ef0f8805d1b9133d24135ab3c4641a2f8808349d7333295e0e76ee4bc5227232628efa80d79d92ab4e3d1120f3fb5ad119cd8d544aa1d4a6865e6b57beac5771307e2e3cb9070da47b4bfc8869e01413ea093541de8a792811b74636c5e91452cf0cee59f2fb404acd0bc584cb9c835404734c0e7ec6605cdfcf2ff439b6d4719f702f0e0c3fa04fdb12a6cb2ad1ab1c9af1f8f4c3a08edd72a32b0bb5d0ad256ffd159a683b2a5a1f1d11fa62532f03d754caef0da5735a1e5a884c7e89d91218c9d7008515e5f5992ccc471f3b1bc1aaec24a2997e6ad3' ); - + CREATE TABLE signald_accounts ( uuid UUID NOT NULL, e164 TEXT NOT NULL, filename TEXT NOT NULL, server UUID NOT NULL REFERENCES signald_servers(server_uuid) ON DELETE CASCADE, - + PRIMARY KEY (uuid, e164, filename, server), UNIQUE (e164), UNIQUE (filename), UNIQUE (uuid) ); - + CREATE TABLE signald_recipients ( rowid SERIAL PRIMARY KEY, account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, uuid UUID, e164 TEXT, - + registered BOOLEAN DEFAULT true, + UNIQUE (account_uuid, e164, uuid) ); - + CREATE TABLE signald_prekeys ( account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, id INTEGER NOT NULL, record BYTEA NOT NULL, - + PRIMARY KEY (account_uuid, id) ); - + CREATE TABLE signald_sessions ( account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, recipient INTEGER NOT NULL REFERENCES signald_recipients(rowid) ON DELETE CASCADE, device_id INTEGER, record BYTEA NOT NULL, - + PRIMARY KEY (account_uuid, recipient, device_id) ); - + CREATE TABLE signald_signed_prekeys ( account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, id INTEGER NOT NULL, record BYTEA NOT NULL, - + PRIMARY KEY (account_uuid, id) ); - + CREATE TABLE signald_identity_keys ( account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, recipient INTEGER NOT NULL, identity_key BYTEA NOT NULL, trust_level TEXT NOT NULL, added TIMESTAMP WITHOUT TIME ZONE DEFAULT CURRENT_TIMESTAMP, - + PRIMARY KEY (account_uuid, recipient, identity_key) ); - + CREATE TABLE signald_account_data ( account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, key TEXT NOT NULL, value BYTEA NOT NULL, - + PRIMARY KEY (account_uuid, key) ); - + CREATE TABLE signald_pending_account_data ( username TEXT, key TEXT NOT NULL, value BYTEA NOT NULL, - + PRIMARY KEY (username, key) ); - + CREATE TABLE signald_sender_keys ( account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, address TEXT NOT NULL, @@ -169,19 +170,19 @@ var ( distribution_id UUID NOT NULL, record BYTEA NOT NULL, created_at TIMESTAMP WITHOUT TIME ZONE NOT NULL, - + PRIMARY KEY (account_uuid, address, device, distribution_id) ); - + CREATE TABLE signald_sender_key_shared ( account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, distribution_id UUID NOT NULL, address TEXT NOT NULL, device INTEGER NOT NULL, - + PRIMARY KEY (account_uuid, address, device) ); - + CREATE TABLE signald_groups ( rowid SERIAL PRIMARY KEY, account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, @@ -191,15 +192,15 @@ var ( last_avatar_fetch INTEGER, distribution_id UUID, group_info BYTEA, - + UNIQUE (account_uuid, group_id) ); - + CREATE TABLE signald_group_credentials ( account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, date BIGINT NOT NULL, credential BYTEA NOT NULL, - + PRIMARY KEY (account_uuid, date) ); From 890417af5ddb490131a8f67626af46b17bdc0375 Mon Sep 17 00:00:00 2001 From: schubisu Date: Thu, 12 May 2022 14:42:09 +0200 Subject: [PATCH 21/37] remove incorrect alias --- cmd/signaldctl/cmd/device/root.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/signaldctl/cmd/device/root.go b/cmd/signaldctl/cmd/device/root.go index f3169bd..408e559 100644 --- a/cmd/signaldctl/cmd/device/root.go +++ b/cmd/signaldctl/cmd/device/root.go @@ -25,7 +25,7 @@ import ( var DeviceCmd = &cobra.Command{ Use: "device", - Aliases: []string{"msg", "devices"}, + Aliases: []string{"devices"}, } func init() { From b343c02f77c562c01d3141dd9fc4b31ee09bc2fd Mon Sep 17 00:00:00 2001 From: finn Date: Mon, 16 May 2022 18:55:46 -0700 Subject: [PATCH 22/37] captcha helper support for send feedback appriciated, I can't get captchas reliably --- .../cmd/message/send/send-message.go | 109 +++++++++++++++++- 1 file changed, 103 insertions(+), 6 deletions(-) diff --git a/cmd/signaldctl/cmd/message/send/send-message.go b/cmd/signaldctl/cmd/message/send/send-message.go index 81b4f44..4e99598 100644 --- a/cmd/signaldctl/cmd/message/send/send-message.go +++ b/cmd/signaldctl/cmd/message/send/send-message.go @@ -18,9 +18,11 @@ package send import ( "encoding/json" "fmt" + "io" "io/ioutil" "log" "os" + "os/exec" "path/filepath" "strings" @@ -30,15 +32,20 @@ import ( "gitlab.com/signald/signald-go/cmd/signaldctl/common" "gitlab.com/signald/signald-go/cmd/signaldctl/config" - "gitlab.com/signald/signald-go/signald/client-protocol/v1" + v1 "gitlab.com/signald/signald-go/signald/client-protocol/v1" +) + +const ( + CAPTCHA_HELPER = "signal-captcha-helper" ) var ( - account string - toAddress *v1.JsonAddress - toGroup string - attachments []string - message string + account string + toAddress *v1.JsonAddress + toGroup string + attachments []string + message string + captchaHelper bool SendMessageCmd = &cobra.Command{ Use: "send {group id | phone number} [message]", @@ -97,6 +104,48 @@ var ( if err != nil { log.Fatal("error sending request to signald: ", err) } + + resends := []*v1.JsonAddress{} + + for _, result := range resp.Results { + if result.ProofRequiredFailure != nil { + if captchaHelper { + err = runCaptchaHelper(result.ProofRequiredFailure.Token) + if err != nil { + log.Println("error running captcha helper: ", err) + } + resends = append(resends, result.Address) + } + } + } + + if len(resends) > 0 { + resendReq := v1.SendRequest{ + Username: req.Username, + MessageBody: req.MessageBody, + Attachments: req.Attachments, + RecipientGroupID: req.RecipientGroupID, + Members: resends, + Timestamp: resp.Timestamp, + } + resendResponse, err := resendReq.Submit(common.Signald) + if err != nil { + log.Println("error resending messages: ", err) + } else { + for i, originalResult := range resp.Results { + if originalResult.ProofRequiredFailure == nil { + continue + } + + for _, result := range resendResponse.Results { + if result.Address.UUID == originalResult.Address.UUID { + resp.Results[i] = result + } + } + } + } + } + switch common.OutputFormat { case common.OutputFormatJSON: err := json.NewEncoder(os.Stdout).Encode(resp) @@ -148,7 +197,55 @@ var ( } ) +func runCaptchaHelper(challenge string) error { + if !captchaHelper { + return nil + } + + _, err := exec.LookPath(CAPTCHA_HELPER) + if err != nil { + return err + } + + cmd := exec.Command(CAPTCHA_HELPER, "--challenge") + + stdout, err := cmd.StdoutPipe() + if err != nil { + return err + } + + err = cmd.Start() + if err != nil { + return err + } + + captchaToken := new(strings.Builder) + _, err = io.Copy(captchaToken, stdout) + if err != nil { + return err + } + + err = cmd.Wait() + if err != nil { + return err + } + + req := v1.SubmitChallengeRequest{ + Account: account, + CaptchaToken: captchaToken.String(), + Challenge: challenge, + } + + err = req.Submit(common.Signald) + if err != nil { + return err + } + + return nil +} + func init() { SendMessageCmd.Flags().StringVarP(&account, "account", "a", "", "local account to use") + SendMessageCmd.Flags().BoolVarP(&captchaHelper, "captcha-helper", "c", false, "Invoke signal-captcha-helper and process the response when a push challenge response appears. After completing the challenge, the message will be redelivered to the failed recipient") SendMessageCmd.Flags().StringSliceVarP(&attachments, "attachment", "A", []string{}, "attach a file to your outbound message. may be specified multiple times.") } From 7ace3647c7b28d329197f8b3f1ee97f0c6f75658 Mon Sep 17 00:00:00 2001 From: finn Date: Tue, 17 May 2022 16:45:21 -0700 Subject: [PATCH 23/37] add new db migration code, add sqlite to postgres migration test in CI hopefully this will keep migrations in sync --- .gitlab-ci.yml | 27 +++- cmd/signaldctl/cmd/db/migrate.go | 230 ++++++++++++++++++++++++++---- cmd/signaldctl/cmd/db/postgres.go | 89 +++++++++--- 3 files changed, 298 insertions(+), 48 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 9802ce6..b9cba03 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,10 +1,11 @@ stages: - build + - test - publish lint: image: golang:1.17 - stage: build + stage: test before_script: - apt-get update - apt-get install -y wget golang-go @@ -17,6 +18,30 @@ lint: - diff --color=always go.sum "${CI_PROJECT_DIR}/go.sum" rules: - when: on_success + needs: [] + +test sqlite to postgres: + image: + name: registry.gitlab.com/signald/signald:unstable + entrypoint: [""] + stage: test + needs: + - "build:x86" + before_script: + - apt-get update && apt-get install -y postgresql-client + script: + - cd / + - signald --migrate-data + - echo 'CREATE DATABASE signald' | psql -h postgres -U postgres -a + - "${CI_PROJECT_DIR}/signaldctl db-move postgresql://postgres@postgres/signald?sslmode=disable" + - SIGNALD_DATABASE=postgresql://postgres@postgres/signald?sslmode=disable signald --migrate-data + variables: + SIGNALD_VERBOSE_LOGGING: "true" + services: + - name: postgres:latest + alias: postgres + variables: + POSTGRES_HOST_AUTH_METHOD: trust .build: stage: build diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index ecc8cc6..5bac893 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -17,9 +17,23 @@ import ( "gitlab.com/signald/signald-go/cmd/signaldctl/common" ) -const expectedMigrationVersion = "14" +type Migration struct { + InstalledRank int + Version string + Description string + Script string + Checksum int +} var ( + migrations = []Migration{ + {InstalledRank: 1, Version: "1", Description: "create tables", Script: "V1__create_tables.sql", Checksum: -1247750968}, + {InstalledRank: 2, Version: "12", Description: "create contacts table", Script: "V12__create_contacts_table.sql", Checksum: -852729911}, + {InstalledRank: 3, Version: "13", Description: "recipient registration status", Script: "V13__recipient_registration_status.sql", Checksum: 405376321}, + {InstalledRank: 4, Version: "14", Description: "multiple identity keys per account", Script: "V14__multiple_identity_keys_per_account.sql", Checksum: -1635788950}, + {InstalledRank: 5, Version: "15", Description: "profiles tables", Script: "V15__profiles_tables.sql", Checksum: 809686180}, + } + sqlitePath string postgresURL string MoveCmd = &cobra.Command{ @@ -79,83 +93,107 @@ var ( log.Println("created schema") if err := moveAccounts(source, dest); err != nil { - log.Println("error migrating accounts table") + log.Println("error moving accounts table") return err } log.Println("moved accounts table") if err := moveRecipients(source, dest); err != nil { - log.Println("error migrating recipients table") + log.Println("error moving recipients table") return err } log.Println("moved recipients table") if err := movePrekeys(source, dest); err != nil { - log.Println("error migrating prekeys table") + log.Println("error moving prekeys table") return err } log.Println("moved prekeys table") if err := moveSessions(source, dest); err != nil { - log.Println("error migrating sessions table") + log.Println("error moving sessions table") return err } log.Println("moved sessions table") if err := moveSignedPrekeys(source, dest); err != nil { - log.Println("error migrating signed prekeys table") + log.Println("error moving signed prekeys table") return err } log.Println("moved signed prekeys table") if err := moveIdentityKeys(source, dest); err != nil { - log.Println("error migrating identity keys table") + log.Println("error moving identity keys table") return err } log.Println("moved identity keys table") if err := moveAccountData(source, dest); err != nil { - log.Println("error migrating account data") + log.Println("error moving account data") return err } log.Println("moved account data table") if err := movePendingAccountData(source, dest); err != nil { - log.Println("error migrating pending account data tabe") + log.Println("error moving pending account data tabe") return err } log.Println("moved pending account data table") if err := moveSenderKeys(source, dest); err != nil { - log.Println("error migrating sender keys table") + log.Println("error moving sender keys table") return err } log.Println("moved sender keys table") if err := moveSenderKeyShared(source, dest); err != nil { - log.Println("error migrating sender key shared table") + log.Println("error moving sender key shared table") return err } log.Println("moved sender key shared table") if err := moveGroups(source, dest); err != nil { - log.Println("error migrating groups table") + log.Println("error moving groups table") return err } log.Println("moved groups table") if err := moveGroupCredentials(source, dest); err != nil { - log.Println("error migrating group credentials table") + log.Println("error moving group credentials table") return err } log.Println("moved group credentials table") if err := moveContacts(source, dest); err != nil { - log.Println("error migrating group credentials table") + log.Println("error moving group credentials table") return err } log.Println("moved contacts table") + if err := moveProfileKeys(source, dest); err != nil { + log.Println("error moving profile keys table") + return err + } + log.Println("moved profile keys table") + + if err := moveProfiles(source, dest); err != nil { + log.Println("error moving profiles tables") + return err + } + log.Println("moved profiles tables") + + if err := moveProfileCapabilities(source, dest); err != nil { + log.Println("error moving profile capabilities tables") + return err + } + log.Println("moved profile capabilities tables") + + if err := moveProfileBadges(source, dest); err != nil { + log.Println("error moving profile badges tables") + return err + } + log.Println("moved profile badges tables") + if err := os.Remove(sqlitePath); err != nil { log.Println("error deleting sqlite file") return err @@ -175,7 +213,7 @@ func verifyMigration(source *sql.DB) error { defer rows.Close() if !rows.Next() { - return errors.New("source database is not up to date! Please update signald and start it to move the sqlite database to an acceptable format") + return errors.New("source database is not up to date! Please update signald and start it to move all data into sqlite before moving data to postgres") } var version string @@ -184,8 +222,9 @@ func verifyMigration(source *sql.DB) error { return err } + expectedMigrationVersion := migrations[len(migrations)-1].Version if version != expectedMigrationVersion { - return fmt.Errorf("source database must be on migration %s (found %s instead)", expectedMigrationVersion, version) + return fmt.Errorf("source database must be on migration %s (found %s instead). Please update signald, or file an issue if the migrations are out of date", expectedMigrationVersion, version) } return nil @@ -197,21 +236,24 @@ func createSchema(dest *sql.DB) error { return err } - _, err = dest.Exec(` + for _, migration := range migrations { + _, err = dest.Exec(` INSERT INTO flyway_schema_history (installed_rank, version, description, type, script, checksum, installed_by, execution_time, success) - VALUES ($1, $2, $3, $4, $5, $6, current_user, $7, $8), - ($9, $10, $11, $12, $13, $14, current_user, $15, $16) + VALUES ($1, $2, $3, 'SQL', $4, $5, current_user, 0, true) `, - // Row 1 - 1, 1, "create tables", "SQL", "V1__create_tables.sql", -1247750968, 0, true, - // Row 2 - 2, 12, "create contacts table", "SQL", "V12__create_contacts_table.sql", -852729911, 0, true) - return err + migration.InstalledRank, migration.Version, migration.Description, migration.Script, migration.Checksum, + ) + if err != nil { + return err + } + } + + return nil } func moveAccounts(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT uuid, e164, filename, server FROM accounts") + rows, err := source.Query("SELECT uuid, e164, server FROM accounts") if err != nil { return err } @@ -221,14 +263,13 @@ func moveAccounts(source *sql.DB, dest *sql.DB) error { var ( accountUUID uuid.UUID e164 string - filename string server uuid.UUID ) - err = rows.Scan(&accountUUID, &e164, &filename, &server) + err = rows.Scan(&accountUUID, &e164, &server) if err != nil { return err } - _, err = dest.Exec("INSERT INTO signald_accounts (uuid, e164, filename, server) VALUES ($1, $2, $3, $4)", accountUUID, e164, filename, server) + _, err = dest.Exec("INSERT INTO signald_accounts (uuid, e164, server) VALUES ($1, $2, $3, $4)", accountUUID, e164, server) if err != nil { return err } @@ -603,3 +644,136 @@ func moveContacts(source *sql.DB, dest *sql.DB) error { } return nil } + +func moveProfileKeys(source *sql.DB, dest *sql.DB) error { + rows, err := source.Query("SELECT account_uuid, recipient, profile_key, profile_key_credential, request_pending, unidentified_access_mode FROM profile_keys") + if err != nil { + return err + } + defer rows.Close() + + for rows.Next() { + var ( + accountUUID uuid.UUID + recipient int64 + profile_key []byte + profile_key_credential []byte + request_pending bool + unidentified_access_mode int + ) + err = rows.Scan(&accountUUID, &recipient, &profile_key, &profile_key_credential, &request_pending, &unidentified_access_mode) + if err != nil { + return err + } + _, err = dest.Exec(` + INSERT INTO signald_profile_keys + (account_uuid, recipient, profile_key, profile_key_credential, request_pending, unidentified_access_mode) + VALUES ($1, $2, $3, $4, $5, $6, $7) + `, accountUUID, recipient, profile_key, profile_key_credential, request_pending, unidentified_access_mode) + if err != nil { + return err + } + } + return nil +} + +func moveProfiles(source *sql.DB, dest *sql.DB) error { + rows, err := source.Query("SELECT account_uuid, recipient, last_update, given_name, family_name, about, emoji, payment_address, badges FROM profiles") + if err != nil { + return err + } + defer rows.Close() + + for rows.Next() { + var ( + accountUUID uuid.UUID + recipient int64 + last_update int64 + given_name string + family_name string + about string + emoji string + payment_address []byte + badges string + ) + err = rows.Scan(&accountUUID, &recipient, &last_update, &given_name, &family_name, &about, &emoji, &payment_address, &badges) + if err != nil { + return err + } + _, err = dest.Exec(` + INSERT INTO signald_profiles + (account_uuid, recipient, last_update, given_name, family_name, about, emoji, payment_address, badges) + VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9) + `, accountUUID, recipient, last_update, given_name, family_name, about, emoji, payment_address, badges) + if err != nil { + return err + } + } + return nil +} + +func moveProfileCapabilities(source *sql.DB, dest *sql.DB) error { + rows, err := source.Query("SELECT account_uuid, recipient, storage, gv1_migration, sender_key, announcement_group, change_number, stories FROM profile_capabilities") + if err != nil { + return err + } + defer rows.Close() + + for rows.Next() { + var ( + accountUUID uuid.UUID + recipient int64 + storage bool + gv1_migration bool + sender_key bool + announcement_group bool + change_number bool + stories bool + ) + err = rows.Scan(&accountUUID, &recipient, &storage, &gv1_migration, &sender_key, &announcement_group, &change_number, &stories) + if err != nil { + return err + } + _, err = dest.Exec(` + INSERT INTO signald_profile_capabilities + (account_uuid, recipient, storage, gv1_migration, sender_key, announcement_group, change_number, stories) + VALUES ($1, $2, $3, $4, $5, $6, $7, $8) + `, accountUUID, recipient, storage, gv1_migration, sender_key, announcement_group, change_number, stories) + if err != nil { + return err + } + } + return nil +} + +func moveProfileBadges(source *sql.DB, dest *sql.DB) error { + rows, err := source.Query("SELECT account_uuid, id, category, name, description, sprite6 FROM profile_badges") + if err != nil { + return err + } + defer rows.Close() + + for rows.Next() { + var ( + accountUUID uuid.UUID + id string + category string + name string + description string + sprite6 string + ) + err = rows.Scan(&accountUUID, &id, &category, &name, &description, &sprite6) + if err != nil { + return err + } + _, err = dest.Exec(` + INSERT INTO signald_profile_badges + (account_uuid, id, category, name, description, sprite6) + VALUES ($1, $2, $3, $4, $5, $6) + `, accountUUID, id, category, name, description, sprite6) + if err != nil { + return err + } + } + return nil +} diff --git a/cmd/signaldctl/cmd/db/postgres.go b/cmd/signaldctl/cmd/db/postgres.go index 50952d1..5f7c2b3 100644 --- a/cmd/signaldctl/cmd/db/postgres.go +++ b/cmd/signaldctl/cmd/db/postgres.go @@ -1,8 +1,22 @@ package db var ( - // from signald in src/main/resources/db/migration/postgresql/V1__create_tables.sql - pgScheme = `CREATE TABLE signald_message_queue ( + pgScheme = ` + CREATE TABLE public.flyway_schema_history ( + installed_rank integer NOT NULL, + version character varying(50), + description character varying(200) NOT NULL, + type character varying(20) NOT NULL, + script character varying(1000) NOT NULL, + checksum integer, + installed_by character varying(100) NOT NULL, + installed_on timestamp without time zone DEFAULT now() NOT NULL, + execution_time integer NOT NULL, + success boolean NOT NULL + ); + + -- from signald in src/main/resources/db/migration/postgresql/V1__create_tables.sql + CREATE TABLE signald_message_queue ( id SERIAL PRIMARY KEY, account UUID NOT NULL, version INTEGER NOT NULL, @@ -93,12 +107,10 @@ var ( CREATE TABLE signald_accounts ( uuid UUID NOT NULL, e164 TEXT NOT NULL, - filename TEXT NOT NULL, server UUID NOT NULL REFERENCES signald_servers(server_uuid) ON DELETE CASCADE, - PRIMARY KEY (uuid, e164, filename, server), + PRIMARY KEY (uuid, e164, server), UNIQUE (e164), - UNIQUE (filename), UNIQUE (uuid) ); @@ -107,7 +119,7 @@ var ( account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, uuid UUID, e164 TEXT, - registered BOOLEAN DEFAULT true, + registered BOOLEAN DEFAULT true, -- from signald in src/main/resources/db/migration/postgresql/V13__recipient_registration_status.sql UNIQUE (account_uuid, e164, uuid) ); @@ -204,19 +216,7 @@ var ( PRIMARY KEY (account_uuid, date) ); - CREATE TABLE public.flyway_schema_history ( - installed_rank integer NOT NULL, - version character varying(50), - description character varying(200) NOT NULL, - type character varying(20) NOT NULL, - script character varying(1000) NOT NULL, - checksum integer, - installed_by character varying(100) NOT NULL, - installed_on timestamp without time zone DEFAULT now() NOT NULL, - execution_time integer NOT NULL, - success boolean NOT NULL - ); - + -- from signald in src/main/resources/db/migration/postgresql/V12__create_contacts_table.sql CREATE TABLE signald_contacts ( account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, recipient INTEGER NOT NULL REFERENCES signald_recipients(rowid) ON DELETE CASCADE, @@ -228,5 +228,56 @@ var ( PRIMARY KEY (account_uuid, recipient) ); + + -- from signald in src/main/resources/db/migration/postgresql/V15__profiles_tables.sql + + CREATE TABLE signald_profile_keys ( + account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, + recipient INTEGER NOT NULL REFERENCES signald_recipients(rowid) ON DELETE CASCADE, + profile_key BYTEA DEFAULT NULL, + profile_key_credential BYTEA DEFAULT NULL, + request_pending boolean DEFAULT FALSE, + unidentified_access_mode int DEFAULT 0, + + PRIMARY KEY (account_uuid, recipient) + ); + + CREATE TABLE signald_profiles ( + account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, + recipient INTEGER NOT NULL REFERENCES signald_recipients(rowid) ON DELETE CASCADE, + last_update BIGINT, + given_name TEXT, + family_name TEXT, + about TEXT, + emoji TEXT, + payment_address BYTEA, + badges TEXT, + + PRIMARY KEY (account_uuid, recipient) + ); + + CREATE TABLE signald_profile_capabilities ( + account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, + recipient INTEGER NOT NULL REFERENCES signald_recipients(rowid) ON DELETE CASCADE, + storage BOOLEAN, + gv1_migration BOOLEAN, + sender_key BOOLEAN, + announcement_group BOOLEAN, + change_number BOOLEAN, + stories BOOLEAN, + + PRIMARY KEY (account_uuid, recipient) + ); + + CREATE TABLE signald_profile_badges ( + account_uuid UUID NOT NULL REFERENCES signald_accounts(uuid) ON DELETE CASCADE, + id TEXT NOT NULL, + category TEXT NOT NULL, + name TEXT NOT NULL, + description TEXT NOT NULL, + sprite6 TEXT NOT NULL, + + PRIMARY KEY (account_uuid, id) + ); ` ) From b5af9d176b18a1a1abbc2c7831402457de40d84c Mon Sep 17 00:00:00 2001 From: finn Date: Tue, 17 May 2022 18:14:09 -0700 Subject: [PATCH 24/37] bump protocol --- protocol.json | 1306 +++++++++++++++++++----- signald/client-protocol/v0/structs.go | 1 + signald/client-protocol/v1/errors.go | 73 +- signald/client-protocol/v1/requests.go | 128 +++ signald/client-protocol/v1/structs.go | 225 +++- 5 files changed, 1400 insertions(+), 333 deletions(-) diff --git a/protocol.json b/protocol.json index a0ded3f..edf0bcb 100644 --- a/protocol.json +++ b/protocol.json @@ -2,9 +2,9 @@ "doc_version": "v1", "version": { "name": "signald", - "version": "0.17.0", + "version": "0.18.3", "branch": "main", - "commit": "3d482a6060b7235a18cdb8a4dc60aba61f99da74" + "commit": "2d898baa70a20c44ae918d2ce6e1f108579ee271" }, "info": "This document describes objects that may be used when communicating with signald.", "types": { @@ -487,7 +487,7 @@ "text": { "type": "String", "doc": "the body of the message being quoted", - "example": "\"hey ? what's up?\"" + "example": "\"hey  what's up?\"" }, "attachments": { "list": true, @@ -577,7 +577,7 @@ "emoji": { "type": "String", "doc": "the emoji to react with", - "example": "\"?\"" + "example": "\"👍\"" }, "remove": { "type": "boolean", @@ -916,6 +916,9 @@ }, "Optional": { "fields": { + "empty": { + "type": "boolean" + }, "present": { "type": "boolean" } @@ -926,13 +929,125 @@ } }, "v1": { - "ListenerState": { + "ClientMessageWrapper": { "fields": { - "connected": { - "type": "boolean" + "type": { + "type": "String", + "doc": "the type of object to expect in the `data` field" + }, + "version": { + "type": "String", + "doc": "the version of the object in the `data` field" + }, + "data": { + "type": "Object", + "doc": "the incoming object. The structure will vary from message to message, see `type` and `version` fields" + }, + "error": { + "type": "Boolean", + "doc": "true if the incoming message represents an error" + }, + "account": { + "type": "String", + "doc": "the account this message is from" } }, - "doc": "prior attempt to indicate signald connectivity state. WebSocketConnectionState messages will be delivered at the same time as well as in other parts of the websocket lifecycle." + "doc": "Wraps all incoming messages sent to the client after a v1 subscribe request is issued" + }, + "ProtocolInvalidMessageError": { + "fields": { + "sender": { + "type": "String" + }, + "timestamp": { + "type": "long" + }, + "message": { + "type": "String" + }, + "sender_device": { + "type": "int" + }, + "content_hint": { + "type": "int" + }, + "group_id": { + "type": "String" + } + }, + "error": true + }, + "UntrustedIdentityError": { + "fields": { + "identifier": { + "type": "String" + }, + "message": { + "type": "String" + }, + "identity_key": { + "type": "IdentityKey", + "version": "v1" + } + }, + "error": true + }, + "ProtocolNoSessionError": { + "fields": { + "sender": { + "type": "String" + }, + "timestamp": { + "type": "long" + }, + "message": { + "type": "String" + }, + "sender_device": { + "type": "int" + }, + "content_hint": { + "type": "int" + }, + "group_id": { + "type": "String" + } + }, + "error": true + }, + "ProtocolInvalidKeyIdError": { + "fields": { + "sender": { + "type": "String" + }, + "timestamp": { + "type": "long" + }, + "message": { + "type": "String" + }, + "sender_device": { + "type": "int" + }, + "content_hint": { + "type": "int" + }, + "group_id": { + "type": "String" + } + }, + "error": true + }, + "DuplicateMessageError": { + "fields": { + "timestamp": { + "type": "long" + }, + "message": { + "type": "String" + } + }, + "error": true }, "IncomingMessage": { "fields": { @@ -991,11 +1106,23 @@ "type": "TypingMessage", "version": "v1" }, + "story_message": { + "type": "StoryMessage", + "version": "v1" + }, "server_guid": { "type": "String" } } }, + "ListenerState": { + "fields": { + "connected": { + "type": "boolean" + } + }, + "doc": "prior attempt to indicate signald connectivity state. WebSocketConnectionState messages will be delivered at the same time as well as in other parts of the websocket lifecycle." + }, "WebSocketConnectionState": { "fields": { "state": { @@ -1009,154 +1136,24 @@ }, "doc": "indicates when the websocket connection state to the signal server has changed" }, - "JsonMessageEnvelope": { + "StorageChange": { "fields": { - "username": { - "type": "String", - "example": "\"+12024561414\"" - }, - "uuid": { - "type": "String", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"" - }, - "source": { - "type": "JsonAddress", - "version": "v1" - }, - "sourceDevice": { - "type": "int" - }, - "type": { - "type": "String" - }, - "relay": { - "type": "String" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - }, - "timestampISO": { - "type": "String" - }, - "serverTimestamp": { - "type": "long" - }, - "serverDeliveredTimestamp": { - "type": "long", - "example": "161557644247580" - }, - "hasLegacyMessage": { - "type": "boolean" - }, - "hasContent": { - "type": "boolean" - }, - "isUnidentifiedSender": { - "type": "boolean" - }, - "dataMessage": { - "type": "JsonDataMessage", - "version": "v1" - }, - "syncMessage": { - "type": "JsonSyncMessage", - "version": "v1" - }, - "callMessage": { - "type": "JsonCallMessage", - "version": "v0" - }, - "receipt": { - "type": "JsonReceiptMessage", - "version": "v0" - }, - "typing": { - "type": "JsonTypingMessage", - "version": "v0" - } - } - }, - "ClientMessageWrapper": { - "fields": { - "type": { - "type": "String", - "doc": "the type of object to expect in the `data` field" - }, "version": { - "type": "String", - "doc": "the version of the object in the `data` field" - }, - "data": { - "type": "Object", - "doc": "the incoming object. The structure will vary from message to message, see `type` and `version` fields" - }, - "error": { - "type": "Boolean", - "doc": "true if the incoming message represents an error" - }, - "account": { - "type": "String", - "doc": "the account this message is from" + "type": "long", + "doc": "Seems to behave like the group version numbers and increments every time the state changes" } }, - "doc": "Wraps all incoming messages sent to the client after a v1 subscribe request is issued" - }, - "UntrustedIdentityError": { - "fields": { - "identifier": { - "type": "String" - }, - "message": { - "type": "String" - }, - "identity_key": { - "type": "IdentityKey", - "version": "v1" - } - }, - "error": true - }, - "ProtocolInvalidMessageError": { - "fields": { - "sender": { - "type": "String" - }, - "timestamp": { - "type": "long" - }, - "message": { - "type": "String" - }, - "sender_device": { - "type": "int" - }, - "content_hint": { - "type": "int" - }, - "group_id": { - "type": "String" - } - }, - "error": true - }, - "DuplicateMessageError": { - "fields": { - "timestamp": { - "type": "long" - }, - "message": { - "type": "String" - } - }, - "error": true + "doc": "Broadcast to subscribed clients when there is a state change from the storage service" }, "SendRequest": { "fields": { "username": { "type": "String", - "example": "\"+12024561414\"", - "required": true + "example": "\"+12024561414\"" + }, + "account": { + "type": "String", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"" }, "recipientAddress": { "type": "JsonAddress", @@ -1318,6 +1315,23 @@ }, "error": true }, + "AuthorizationFailedError": { + "fields": { + "message": { + "type": "String" + } + }, + "doc": "Indicates the server rejected our credentials or a failed group update. Typically means the linked device was removed by the primary device, or that the account was re-registered. For group updates, this can indicate that we lack permissions.", + "error": true + }, + "SQLError": { + "fields": { + "message": { + "type": "String" + } + }, + "error": true + }, "ReactRequest": { "fields": { "username": { @@ -1372,7 +1386,7 @@ }, "version": { "type": "String", - "example": "\"0.17.0\"" + "example": "\"0.18.3\"" }, "branch": { "type": "String", @@ -1380,7 +1394,7 @@ }, "commit": { "type": "String", - "example": "\"3d482a6060b7235a18cdb8a4dc60aba61f99da74\"" + "example": "\"2d898baa70a20c44ae918d2ce6e1f108579ee271\"" } } }, @@ -1389,7 +1403,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "groupID": { @@ -1469,6 +1483,16 @@ "removed": { "type": "boolean", "doc": "will be set to true for incoming messages to indicate the user has been removed from the group" + }, + "banned_members": { + "list": true, + "type": "BannedGroupMember", + "version": "v1" + }, + "group_change": { + "type": "GroupChange", + "version": "v1", + "doc": "Represents a peer-to-peer group change done by a user. Will not be set if the group change signature fails verification. This is usually only set inside of incoming messages." } }, "doc": "Information about a Signal group" @@ -1481,13 +1505,13 @@ }, "error": true }, - "AuthorizationFailedError": { + "GroupPatchNotAcceptedError": { "fields": { "message": { "type": "String" } }, - "doc": "indicates the server rejected our credentials. Typically means the linked device was removed by the primary device, or that the account was re-registered", + "doc": "Indicates the server rejected our group update. This can be due to errors such as trying to add a user that's already in the group.", "error": true }, "ApproveMembershipRequest": { @@ -1495,7 +1519,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "groupID": { @@ -1526,7 +1550,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "groupID": { @@ -1554,7 +1578,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true } }, @@ -1574,7 +1598,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "uri": { @@ -1657,7 +1681,7 @@ "account": { "type": "String", "doc": "The identifier of the account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "groupID": { @@ -1776,7 +1800,7 @@ "account": { "type": "String", "doc": "The signal account to use", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "partial": { @@ -1809,7 +1833,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "to": { @@ -1835,6 +1859,7 @@ "account": { "type": "String", "doc": "the signald account to use", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "async": { @@ -1912,6 +1937,7 @@ "fields": { "account": { "type": "String", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true } } @@ -1934,6 +1960,7 @@ "fields": { "account": { "type": "String", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "async": { @@ -1956,7 +1983,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "title": { @@ -1998,7 +2025,7 @@ "account": { "type": "String", "doc": "The account to use", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "groupID": { @@ -2030,6 +2057,10 @@ }, "FinishLinkRequest": { "fields": { + "overwrite": { + "type": "boolean", + "doc": "overwrite existing account data if the phone number conflicts. false by default" + }, "device_name": { "type": "String" }, @@ -2050,6 +2081,9 @@ "type": "Boolean", "doc": "indicates the account has not completed registration" }, + "pni": { + "type": "String" + }, "device_id": { "type": "int", "doc": "The Signal device ID. Official Signal mobile clients (iPhone and Android) have device ID = 1, while linked devices such as Signal Desktop or Signal iPad have higher device IDs." @@ -2093,7 +2127,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "uri": { @@ -2188,7 +2222,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "address": { @@ -2219,7 +2253,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "address": { @@ -2274,7 +2308,7 @@ "account": { "type": "String", "doc": "The account to delete", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "server": { @@ -2289,7 +2323,7 @@ "account": { "type": "String", "doc": "The account to use", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "address": { @@ -2324,7 +2358,7 @@ "account": { "type": "String", "doc": "The account to use", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "address": { @@ -2364,7 +2398,7 @@ "account": { "type": "String", "doc": "The account to use", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true } }, @@ -2388,7 +2422,7 @@ "account": { "type": "String", "doc": "The account to use", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "uri": { @@ -2412,6 +2446,7 @@ "fields": { "account": { "type": "String", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "address": { @@ -2436,7 +2471,7 @@ "account": { "type": "String", "doc": "The account to use", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "address": { @@ -2460,7 +2495,7 @@ "account": { "type": "String", "doc": "The account to set the device name of", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "device_name": { @@ -2495,7 +2530,7 @@ "account": { "type": "String", "doc": "The account to subscribe to incoming message for", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true } }, @@ -2506,7 +2541,7 @@ "account": { "type": "String", "doc": "The account to unsubscribe from", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true } }, @@ -2517,7 +2552,7 @@ "account": { "type": "String", "doc": "the account to use", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "address": { @@ -2577,7 +2612,7 @@ "account": { "type": "String", "doc": "the account to use", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "address": { @@ -2602,7 +2637,7 @@ "account": { "type": "String", "doc": "The account to use to retrieve the remote config", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true } }, @@ -2622,7 +2657,7 @@ "account": { "type": "String", "doc": "The account to interact with", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "members": { @@ -2636,6 +2671,9 @@ "type": "String", "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", "required": true + }, + "also_ban": { + "type": "boolean" } }, "doc": "deny a request to join a group" @@ -2644,6 +2682,7 @@ "fields": { "account": { "type": "String", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "challenge": { @@ -2660,7 +2699,7 @@ "account": { "type": "String", "doc": "The account to use to use", - "example": "\"+12024561414\"", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", "required": true }, "identifier": { @@ -2688,6 +2727,158 @@ }, "doc": "An optional part of the linking process. Intended to be called after displaying the QR code, will return quickly after the user scans the QR code. finish_link must be called after wait_for_scan returns a non-error" }, + "GetGroupRevisionPagesRequest": { + "fields": { + "account": { + "type": "String", + "doc": "The account to interact with", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", + "required": true + }, + "group_id": { + "type": "String", + "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", + "required": true + }, + "from_revision": { + "type": "int", + "doc": "The revision to start the pages from. Note that if this is lower than the revision you joined the group, an AuthorizationFailedError is returned.", + "required": true + }, + "include_first_revision": { + "type": "boolean", + "doc": "Whether to include the first state in the returned pages (default false)" + } + }, + "doc": "Query the server for group revision history. The history contains information about the changes between each revision and the user that made the change." + }, + "GroupHistoryPage": { + "fields": { + "results": { + "list": true, + "type": "GroupHistoryEntry", + "version": "v1" + }, + "paging_data": { + "type": "PagingData", + "version": "v1" + } + }, + "doc": "The result of fetching a group's history along with paging data." + }, + "SendSyncMessageRequest": { + "fields": { + "account": { + "type": "String", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", + "required": true + }, + "view_once_open_message": { + "type": "JsonViewOnceOpenMessage", + "version": "v1", + "doc": "This can be set to indicate to other devices about having viewed a view-once message." + }, + "message_request_response": { + "type": "JsonMessageRequestResponseMessage", + "version": "v1", + "doc": "This can be set to indicate to other devices about a response to an incoming message request from an unknown user or group. Warning: Using the BLOCK and BLOCK_AND_DELETE options relies on other devices to do the blocking, and it does not make you leave the group!" + } + }, + "doc": "Sends a sync message to the account's devices" + }, + "JsonSendMessageResult": { + "fields": { + "address": { + "type": "JsonAddress", + "version": "v1" + }, + "success": { + "type": "SendSuccess", + "version": "v1" + }, + "networkFailure": { + "type": "boolean", + "example": "false" + }, + "unregisteredFailure": { + "type": "boolean", + "example": "false" + }, + "identityFailure": { + "type": "String" + }, + "proof_required_failure": { + "type": "ProofRequiredError", + "version": "v1" + } + } + }, + "BanUserRequest": { + "fields": { + "account": { + "type": "String", + "doc": "The account to interact with", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", + "required": true + }, + "group_id": { + "type": "String", + "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", + "required": true + }, + "users": { + "list": true, + "type": "JsonAddress", + "version": "v1", + "doc": "List of users to ban", + "required": true + } + }, + "doc": "Bans users from a group. This works even if the users aren't in the group. If they are currently in the group, they will also be removed." + }, + "UnbanUserRequest": { + "fields": { + "account": { + "type": "String", + "doc": "The account to interact with", + "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", + "required": true + }, + "group_id": { + "type": "String", + "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", + "required": true + }, + "users": { + "list": true, + "type": "JsonAddress", + "version": "v1", + "doc": "List of users to unban", + "required": true + } + }, + "doc": "Unbans users from a group." + }, + "IdentityKey": { + "fields": { + "added": { + "type": "long", + "doc": "the first time this identity key was seen" + }, + "safety_number": { + "type": "String", + "example": "\"373453558586758076680580548714989751943247272727416091564451\"" + }, + "qr_code_data": { + "type": "String", + "doc": "base64-encoded QR code data" + }, + "trust_level": { + "type": "String", + "doc": "One of TRUSTED_UNVERIFIED, TRUSTED_VERIFIED or UNTRUSTED" + } + } + }, "JsonDataMessage": { "fields": { "timestamp": { @@ -2773,9 +2964,17 @@ "version": "v1", "doc": "details about the MobileCoin payment attached to the message, if present" }, + "is_expiration_update": { + "type": "boolean", + "doc": "whether or not this message changes the expiresInSeconds value for the whole chat. Some messages (remote deletes, reactions, etc) will have expiresInSeconds=0 even though the chat has disappearing messages enabled." + }, "group_call_update": { "type": "String", "doc": "the eraId string from a group call message update" + }, + "story_context": { + "type": "StoryContext", + "version": "v1" } } }, @@ -2893,23 +3092,22 @@ } } }, - "IdentityKey": { + "StoryMessage": { "fields": { - "added": { - "type": "long", - "doc": "the first time this identity key was seen" + "group": { + "type": "JsonGroupV2Info", + "version": "v1" }, - "safety_number": { - "type": "String", - "example": "\"373453558586758076680580548714989751943247272727416091564451\"" + "file": { + "type": "JsonAttachment", + "version": "v1" }, - "qr_code_data": { - "type": "String", - "doc": "base64-encoded QR code data" + "text": { + "type": "TextAttachment", + "version": "v1" }, - "trust_level": { - "type": "String", - "doc": "One of TRUSTED_UNVERIFIED, TRUSTED_VERIFIED or UNTRUSTED" + "allow_replies": { + "type": "Boolean" } } }, @@ -2975,7 +3173,7 @@ "text": { "type": "String", "doc": "the body of the message being quoted", - "example": "\"hey ? what's up?\"" + "example": "\"hey  what's up?\"" }, "attachments": { "list": true, @@ -3033,39 +3231,12 @@ }, "doc": "metadata about one of the links in a message" }, - "JsonSendMessageResult": { - "fields": { - "address": { - "type": "JsonAddress", - "version": "v1" - }, - "success": { - "type": "SendSuccess", - "version": "v1" - }, - "networkFailure": { - "type": "boolean", - "example": "false" - }, - "unregisteredFailure": { - "type": "boolean", - "example": "false" - }, - "identityFailure": { - "type": "String" - }, - "proof_required_failure": { - "type": "ProofRequiredError", - "version": "v1" - } - } - }, "JsonReaction": { "fields": { "emoji": { "type": "String", "doc": "the emoji to react with", - "example": "\"?\"" + "example": "\"👍\"" }, "remove": { "type": "boolean", @@ -3117,6 +3288,125 @@ } } }, + "BannedGroupMember": { + "fields": { + "uuid": { + "type": "String", + "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" + }, + "timestamp": { + "type": "long", + "doc": "Timestamp as milliseconds since Unix epoch of when the user was banned. This field is set by the server." + } + } + }, + "GroupChange": { + "fields": { + "editor": { + "type": "JsonAddress", + "version": "v1", + "doc": "The user that made the change." + }, + "revision": { + "type": "Integer", + "doc": "The group revision that this change brings the group to." + }, + "new_members": { + "list": true, + "type": "GroupMember", + "version": "v1", + "doc": "Represents users have been added to the group. This can be from group members adding users, or a users joining via a group link that required no approval." + }, + "delete_members": { + "list": true, + "type": "JsonAddress", + "version": "v1", + "doc": "Represents users that have been removed from the group. This can be from admins removing users, or users choosing to leave the group" + }, + "modify_member_roles": { + "list": true, + "type": "GroupMember", + "version": "v1", + "doc": "Represents users with their new, modified role." + }, + "modified_profile_keys": { + "list": true, + "type": "GroupMember", + "version": "v1", + "doc": "Represents users that have rotated their profile key. Note that signald currently does not expose profile keys to clients. The joined revision property will always be 0 in this list." + }, + "new_pending_members": { + "list": true, + "type": "GroupPendingMember", + "version": "v1", + "doc": "Represents a user that has been invited to the group by another user." + }, + "delete_pending_members": { + "list": true, + "type": "JsonAddress", + "version": "v1" + }, + "promote_pending_members": { + "list": true, + "type": "GroupMember", + "version": "v1" + }, + "new_banned_members": { + "list": true, + "type": "BannedGroupMember", + "version": "v1" + }, + "new_unbanned_members": { + "list": true, + "type": "BannedGroupMember", + "version": "v1" + }, + "new_title": { + "type": "String" + }, + "new_avatar": { + "type": "Boolean", + "doc": "Whether this group change changed the avatar." + }, + "new_timer": { + "type": "Integer", + "doc": "New disappearing messages timer value." + }, + "new_access_control": { + "type": "GroupAccessControl", + "version": "v1", + "doc": "If not null, then this group change modified one of the access controls. Some of the properties in here will be null." + }, + "new_requesting_members": { + "list": true, + "type": "GroupRequestingMember", + "version": "v1", + "doc": "Represents users that have requested to join the group via the group link. Note that members requesting to join might not necessarily have the list of users in the group, so they won't be able to send a peer-to-peer group update message to inform users of their request to join. Other users in the group may inform us that the revision has increased, but the members requesting access will have to be obtained from the server instead (which signald will handle). For now, a get_group request has to be made to get the users that have requested to join the group." + }, + "delete_requesting_members": { + "list": true, + "type": "JsonAddress", + "version": "v1" + }, + "promote_requesting_members": { + "list": true, + "type": "GroupMember", + "version": "v1" + }, + "new_invite_link_password": { + "type": "Boolean", + "doc": "Whether this group change involved resetting the group invite link." + }, + "new_description": { + "type": "String" + }, + "new_is_announcement_group": { + "type": "String", + "doc": "Whether this change affected the announcement group setting. Possible values are UNKNOWN, ENABLED or DISABLED" + } + }, + "doc": "Represents a group change made by a user. This can also represent request link invites. Only the fields relevant to the group change performed will be set. Note that in signald, group changes are currently only received from incoming messages from a message subscription." + }, "DeviceInfo": { "fields": { "id": { @@ -3158,11 +3448,15 @@ "Capabilities": { "fields": { "gv2": { - "type": "boolean" + "type": "boolean", + "doc": "this capability is deprecated and will always be true" }, "storage": { "type": "boolean" }, + "stories": { + "type": "boolean" + }, "gv1-migration": { "type": "boolean" }, @@ -3263,6 +3557,93 @@ }, "doc": "A remote config (feature flag) entry." }, + "GroupHistoryEntry": { + "fields": { + "group": { + "type": "JsonGroupV2Info", + "version": "v1" + }, + "change": { + "type": "GroupChange", + "version": "v1" + } + } + }, + "PagingData": { + "fields": { + "has_more_pages": { + "type": "boolean" + }, + "next_page_revision": { + "type": "int" + } + } + }, + "JsonViewOnceOpenMessage": { + "fields": { + "sender": { + "type": "JsonAddress", + "version": "v1" + }, + "timestamp": { + "type": "long", + "example": "1615576442475" + } + } + }, + "JsonMessageRequestResponseMessage": { + "fields": { + "person": { + "type": "JsonAddress", + "version": "v1" + }, + "groupId": { + "type": "String" + }, + "type": { + "type": "String", + "doc": "One of UNKNOWN, ACCEPT, DELETE, BLOCK, BLOCK_AND_DELETE, UNBLOCK_AND_ACCEPT" + } + }, + "doc": "Responses to message requests from unknown users or groups" + }, + "SendSuccess": { + "fields": { + "unidentified": { + "type": "boolean" + }, + "needsSync": { + "type": "boolean" + }, + "duration": { + "type": "long" + }, + "devices": { + "list": true, + "type": "Integer" + } + } + }, + "ProofRequiredError": { + "fields": { + "token": { + "type": "String" + }, + "options": { + "list": true, + "type": "String", + "doc": "possible list values are RECAPTCHA and PUSH_CHALLENGE" + }, + "message": { + "type": "String" + }, + "retry_after": { + "type": "long", + "doc": "value in seconds" + } + }, + "error": true + }, "SharedContact": { "fields": { "name": { @@ -3306,6 +3687,16 @@ } } }, + "StoryContext": { + "fields": { + "author": { + "type": "String" + }, + "sent_timestamp": { + "type": "long" + } + } + }, "JsonSentTranscriptMessage": { "fields": { "destination": { @@ -3356,18 +3747,6 @@ } } }, - "JsonViewOnceOpenMessage": { - "fields": { - "sender": { - "type": "JsonAddress", - "version": "v1" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - } - } - }, "JsonVerifiedMessage": { "fields": { "destination": { @@ -3385,20 +3764,6 @@ } } }, - "JsonMessageRequestResponseMessage": { - "fields": { - "person": { - "type": "JsonAddress", - "version": "v1" - }, - "groupId": { - "type": "String" - }, - "type": { - "type": "String" - } - } - }, "OfferMessage": { "fields": { "id": { @@ -3464,42 +3829,63 @@ } } }, - "SendSuccess": { + "TextAttachment": { "fields": { - "unidentified": { - "type": "boolean" + "text": { + "type": "String" }, - "needsSync": { - "type": "boolean" + "style": { + "type": "String" }, - "duration": { - "type": "long" + "preview": { + "type": "JsonPreview", + "version": "v1" }, - "devices": { - "list": true, - "type": "Integer" + "text_foreground_color": { + "type": "String" + }, + "text_background_color": { + "type": "String" + }, + "background_gradient": { + "type": "Gradient", + "version": "v1" + }, + "background_color": { + "type": "String" } } }, - "ProofRequiredError": { + "GroupPendingMember": { "fields": { - "token": { - "type": "String" - }, - "options": { - "list": true, + "uuid": { "type": "String", - "doc": "possible list values are RECAPTCHA and PUSH_CHALLENGE" + "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" }, - "message": { - "type": "String" + "role": { + "type": "String", + "doc": "possible values are: UNKNOWN, DEFAULT, ADMINISTRATOR and UNRECOGNIZED", + "example": "\"DEFAULT\"" }, - "retry_after": { - "type": "long", - "doc": "value in seconds" + "timestamp": { + "type": "long" + }, + "added_by_uuid": { + "type": "String", + "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" } - }, - "error": true + } + }, + "GroupRequestingMember": { + "fields": { + "uuid": { + "type": "String", + "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" + }, + "timestamp": { + "type": "long" + } + } }, "ServerCDN": { "fields": { @@ -3611,6 +3997,16 @@ "type": "boolean" } } + }, + "Gradient": { + "fields": { + "start_color": { + "type": "String" + }, + "end_color": { + "type": "String" + } + } } } }, @@ -3652,6 +4048,12 @@ }, { "name": "AttachmentTooLargeError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -3689,6 +4091,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -3723,7 +4131,15 @@ "name": "InvalidRequestError" }, { - "name": "AuthorizationFailedError" + "name": "AuthorizationFailedError", + "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." + }, + { + "name": "SQLError" + }, + { + "name": "GroupPatchNotAcceptedError", + "doc": "Caused when server rejects the group update." } ] }, @@ -3754,7 +4170,15 @@ "name": "InvalidRequestError" }, { - "name": "AuthorizationFailedError" + "name": "AuthorizationFailedError", + "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." + }, + { + "name": "SQLError" + }, + { + "name": "GroupPatchNotAcceptedError", + "doc": "Caused when server rejects the group update." } ] }, @@ -3789,6 +4213,9 @@ }, { "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -3811,6 +4238,12 @@ }, { "name": "InvalidRequestError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -3851,6 +4284,12 @@ }, { "name": "InvalidGroupStateError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -3875,6 +4314,9 @@ }, { "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -3905,10 +4347,18 @@ "name": "InvalidRequestError" }, { - "name": "AuthorizationFailedError" + "name": "AuthorizationFailedError", + "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." }, { "name": "UnregisteredUserError" + }, + { + "name": "SQLError" + }, + { + "name": "GroupPatchNotAcceptedError", + "doc": "Caused when server rejects the group update, e.g. trying to add a user that's already in the group" } ] }, @@ -3932,6 +4382,12 @@ }, { "name": "InvalidRequestError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -3948,6 +4404,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -3971,6 +4433,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -3996,6 +4464,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4017,6 +4491,12 @@ }, { "name": "InvalidRequestError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4035,6 +4515,12 @@ }, { "name": "NoSuchAccountError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4074,6 +4560,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4104,6 +4596,9 @@ }, { "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4167,6 +4662,12 @@ }, { "name": "InternalError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4233,6 +4734,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4269,6 +4776,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4287,6 +4800,12 @@ }, { "name": "NoSuchAccountError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4323,6 +4842,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4360,6 +4885,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4384,6 +4915,12 @@ }, { "name": "InvalidRequestError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4425,6 +4962,9 @@ }, { "name": "GroupVerificationError" + }, + { + "name": "SQLError" } ] }, @@ -4444,6 +4984,12 @@ }, { "name": "InternalError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4474,10 +5020,18 @@ "name": "InvalidRequestError" }, { - "name": "AuthorizationFailedError" + "name": "AuthorizationFailedError", + "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." }, { "name": "UnregisteredUserError" + }, + { + "name": "SQLError" + }, + { + "name": "GroupPatchNotAcceptedError", + "doc": "If updating a group, caused when server rejects the group update." } ] }, @@ -4496,6 +5050,12 @@ }, { "name": "NoSuchAccountError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4515,6 +5075,12 @@ }, { "name": "InternalError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4536,6 +5102,9 @@ }, { "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4548,6 +5117,9 @@ }, { "name": "InternalError" + }, + { + "name": "SQLError" } ] }, @@ -4585,6 +5157,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4655,6 +5233,12 @@ }, { "name": "UnregisteredUserError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" } ] }, @@ -4674,6 +5258,9 @@ }, { "name": "NoSuchAccountError" + }, + { + "name": "SQLError" } ] }, @@ -4704,10 +5291,18 @@ "name": "InvalidRequestError" }, { - "name": "AuthorizationFailedError" + "name": "AuthorizationFailedError", + "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." }, { "name": "UnregisteredUserError" + }, + { + "name": "SQLError" + }, + { + "name": "GroupPatchNotAcceptedError", + "doc": "Caused when server rejects the group update." } ] }, @@ -4728,6 +5323,9 @@ }, { "name": "InternalError" + }, + { + "name": "SQLError" } ] }, @@ -4747,6 +5345,9 @@ }, { "name": "NoSuchAccountError" + }, + { + "name": "SQLError" } ] }, @@ -4764,6 +5365,159 @@ "name": "InternalError" } ] + }, + "get_group_revision_pages": { + "request": "GetGroupRevisionPagesRequest", + "response": "GroupHistoryPage", + "doc": "Query the server for group revision history. The history contains information about the changes between each revision and the user that made the change.", + "errors": [ + { + "name": "NoSuchAccountError" + }, + { + "name": "UnknownGroupError" + }, + { + "name": "ServerNotFoundError" + }, + { + "name": "InvalidProxyError" + }, + { + "name": "InternalError" + }, + { + "name": "GroupVerificationError" + }, + { + "name": "InvalidGroupStateError" + }, + { + "name": "InvalidRequestError" + }, + { + "name": "AuthorizationFailedError", + "doc": "caused when not a member of the group, when requesting logs from a revision lower than your joinedAtVersion, etc." + }, + { + "name": "RateLimitError" + }, + { + "name": "SQLError" + } + ] + }, + "send_sync_message": { + "request": "SendSyncMessageRequest", + "response": "JsonSendMessageResult", + "doc": "Sends a sync message to the account's devices", + "errors": [ + { + "name": "InvalidRequestError" + }, + { + "name": "RateLimitError" + }, + { + "name": "InternalError" + }, + { + "name": "UnregisteredUserError" + }, + { + "name": "NoSuchAccountError" + }, + { + "name": "ServerNotFoundError" + }, + { + "name": "InvalidProxyError" + }, + { + "name": "AuthorizationFailedError" + }, + { + "name": "SQLError" + } + ] + }, + "ban_user": { + "request": "BanUserRequest", + "response": "JsonGroupV2Info", + "doc": "Bans users from a group. This works even if the users aren't in the group. If they are currently in the group, they will also be removed.", + "errors": [ + { + "name": "NoSuchAccountError" + }, + { + "name": "ServerNotFoundError" + }, + { + "name": "InvalidProxyError" + }, + { + "name": "UnknownGroupError" + }, + { + "name": "GroupVerificationError" + }, + { + "name": "InternalError" + }, + { + "name": "InvalidRequestError" + }, + { + "name": "AuthorizationFailedError", + "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." + }, + { + "name": "SQLError" + }, + { + "name": "GroupPatchNotAcceptedError", + "doc": "Caused when server rejects the group update." + } + ] + }, + "unban_user": { + "request": "UnbanUserRequest", + "response": "JsonGroupV2Info", + "doc": "Unbans users from a group.", + "errors": [ + { + "name": "NoSuchAccountError" + }, + { + "name": "ServerNotFoundError" + }, + { + "name": "InvalidProxyError" + }, + { + "name": "UnknownGroupError" + }, + { + "name": "GroupVerificationError" + }, + { + "name": "InternalError" + }, + { + "name": "InvalidRequestError" + }, + { + "name": "AuthorizationFailedError", + "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." + }, + { + "name": "SQLError" + }, + { + "name": "GroupPatchNotAcceptedError", + "doc": "Caused when server rejects the group update." + } + ] } } } diff --git a/signald/client-protocol/v0/structs.go b/signald/client-protocol/v0/structs.go index 92de9ec..1afd428 100644 --- a/signald/client-protocol/v0/structs.go +++ b/signald/client-protocol/v0/structs.go @@ -291,6 +291,7 @@ type OfferMessage struct { } type Optional struct { + Empty bool `json:"empty,omitempty" yaml:"empty,omitempty"` Present bool `json:"present,omitempty" yaml:"present,omitempty"` } diff --git a/signald/client-protocol/v1/errors.go b/signald/client-protocol/v1/errors.go index 0b3662c..c7a4841 100644 --- a/signald/client-protocol/v1/errors.go +++ b/signald/client-protocol/v1/errors.go @@ -81,6 +81,13 @@ func mkerr(response client_protocol.BasicResponse) error { return err } return result + case "GroupPatchNotAcceptedError": + result := GroupPatchNotAcceptedError{} + err := json.Unmarshal(response.Error, &result) + if err != nil { + return err + } + return result case "GroupVerificationError": result := GroupVerificationError{} err := json.Unmarshal(response.Error, &result) @@ -207,6 +214,13 @@ func mkerr(response client_protocol.BasicResponse) error { return err } return result + case "ProtocolInvalidKeyIdError": + result := ProtocolInvalidKeyIdError{} + err := json.Unmarshal(response.Error, &result) + if err != nil { + return err + } + return result case "ProtocolInvalidMessageError": result := ProtocolInvalidMessageError{} err := json.Unmarshal(response.Error, &result) @@ -214,6 +228,13 @@ func mkerr(response client_protocol.BasicResponse) error { return err } return result + case "ProtocolNoSessionError": + result := ProtocolNoSessionError{} + err := json.Unmarshal(response.Error, &result) + if err != nil { + return err + } + return result case "RateLimitError": result := RateLimitError{} err := json.Unmarshal(response.Error, &result) @@ -221,6 +242,13 @@ func mkerr(response client_protocol.BasicResponse) error { return err } return result + case "SQLError": + result := SQLError{} + err := json.Unmarshal(response.Error, &result) + if err != nil { + return err + } + return result case "ScanTimeoutError": result := ScanTimeoutError{} err := json.Unmarshal(response.Error, &result) @@ -309,7 +337,7 @@ func (e AttachmentTooLargeError) Error() string { return e.Message } -// AuthorizationFailedError: indicates the server rejected our credentials. Typically means the linked device was removed by the primary device, or that the account was re-registered +// AuthorizationFailedError: Indicates the server rejected our credentials or a failed group update. Typically means the linked device was removed by the primary device, or that the account was re-registered. For group updates, this can indicate that we lack permissions. type AuthorizationFailedError struct { Message string `json:"message,omitempty" yaml:"message,omitempty"` } @@ -360,6 +388,15 @@ func (e GroupNotActiveError) Error() string { return e.Message } +// GroupPatchNotAcceptedError: Indicates the server rejected our group update. This can be due to errors such as trying to add a user that's already in the group. +type GroupPatchNotAcceptedError struct { + Message string `json:"message,omitempty" yaml:"message,omitempty"` +} + +func (e GroupPatchNotAcceptedError) Error() string { + return e.Message +} + type GroupVerificationError struct { Message string `json:"message,omitempty" yaml:"message,omitempty"` } @@ -511,6 +548,19 @@ func (e ProofRequiredError) Error() string { return e.Message } +type ProtocolInvalidKeyIdError struct { + ContentHint int32 `json:"content_hint,omitempty" yaml:"content_hint,omitempty"` + GroupId string `json:"group_id,omitempty" yaml:"group_id,omitempty"` + Message string `json:"message,omitempty" yaml:"message,omitempty"` + Sender string `json:"sender,omitempty" yaml:"sender,omitempty"` + SenderDevice int32 `json:"sender_device,omitempty" yaml:"sender_device,omitempty"` + Timestamp int64 `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` +} + +func (e ProtocolInvalidKeyIdError) Error() string { + return e.Message +} + type ProtocolInvalidMessageError struct { ContentHint int32 `json:"content_hint,omitempty" yaml:"content_hint,omitempty"` GroupId string `json:"group_id,omitempty" yaml:"group_id,omitempty"` @@ -524,6 +574,19 @@ func (e ProtocolInvalidMessageError) Error() string { return e.Message } +type ProtocolNoSessionError struct { + ContentHint int32 `json:"content_hint,omitempty" yaml:"content_hint,omitempty"` + GroupId string `json:"group_id,omitempty" yaml:"group_id,omitempty"` + Message string `json:"message,omitempty" yaml:"message,omitempty"` + Sender string `json:"sender,omitempty" yaml:"sender,omitempty"` + SenderDevice int32 `json:"sender_device,omitempty" yaml:"sender_device,omitempty"` + Timestamp int64 `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` +} + +func (e ProtocolNoSessionError) Error() string { + return e.Message +} + type RateLimitError struct { Message string `json:"message,omitempty" yaml:"message,omitempty"` } @@ -532,6 +595,14 @@ func (e RateLimitError) Error() string { return e.Message } +type SQLError struct { + Message string `json:"message,omitempty" yaml:"message,omitempty"` +} + +func (e SQLError) Error() string { + return e.Message +} + type ScanTimeoutError struct { Message string `json:"message,omitempty" yaml:"message,omitempty"` } diff --git a/signald/client-protocol/v1/requests.go b/signald/client-protocol/v1/requests.go index 03388b9..ac5d93b 100644 --- a/signald/client-protocol/v1/requests.go +++ b/signald/client-protocol/v1/requests.go @@ -130,6 +130,38 @@ func (r *ApproveMembershipRequest) Submit(conn *signald.Signald) (response JsonG } +// Submit: Bans users from a group. This works even if the users aren't in the group. If they are currently in the group, they will also be removed. +func (r *BanUserRequest) Submit(conn *signald.Signald) (response JsonGroupV2Info, err error) { + r.Version = "v1" + r.Type = "ban_user" + if r.ID == "" { + r.ID = signald.GenerateID() + } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) + err = conn.RawRequest(r) + if err != nil { + log.Println("signald-go: error submitting request to signald") + return + } + + rawResponse := <-responseChannel + if rawResponse.Error != nil { + err = mkerr(rawResponse) + return + } + + err = json.Unmarshal(rawResponse.Data, &response) + if err != nil { + rawResponseJson, _ := rawResponse.Data.MarshalJSON() + log.Println("signald-go: error unmarshalling response from signald of type", rawResponse.Type, string(rawResponseJson)) + return + } + + return response, nil + +} + func (r *CreateGroupRequest) Submit(conn *signald.Signald) (response JsonGroupV2Info, err error) { r.Version = "v1" r.Type = "create_group" @@ -338,6 +370,38 @@ func (r *GetGroupRequest) Submit(conn *signald.Signald) (response JsonGroupV2Inf } +// Submit: Query the server for group revision history. The history contains information about the changes between each revision and the user that made the change. +func (r *GetGroupRevisionPagesRequest) Submit(conn *signald.Signald) (response GroupHistoryPage, err error) { + r.Version = "v1" + r.Type = "get_group_revision_pages" + if r.ID == "" { + r.ID = signald.GenerateID() + } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) + err = conn.RawRequest(r) + if err != nil { + log.Println("signald-go: error submitting request to signald") + return + } + + rawResponse := <-responseChannel + if rawResponse.Error != nil { + err = mkerr(rawResponse) + return + } + + err = json.Unmarshal(rawResponse.Data, &response) + if err != nil { + rawResponseJson, _ := rawResponse.Data.MarshalJSON() + log.Println("signald-go: error unmarshalling response from signald of type", rawResponse.Type, string(rawResponseJson)) + return + } + + return response, nil + +} + // Submit: Get information about a known keys for a particular address func (r *GetIdentitiesRequest) Submit(conn *signald.Signald) (response IdentityKeyList, err error) { r.Version = "v1" @@ -1047,6 +1111,38 @@ func (r *SendPaymentRequest) Submit(conn *signald.Signald) (response SendRespons } +// Submit: Sends a sync message to the account's devices +func (r *SendSyncMessageRequest) Submit(conn *signald.Signald) (response JsonSendMessageResult, err error) { + r.Version = "v1" + r.Type = "send_sync_message" + if r.ID == "" { + r.ID = signald.GenerateID() + } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) + err = conn.RawRequest(r) + if err != nil { + log.Println("signald-go: error submitting request to signald") + return + } + + rawResponse := <-responseChannel + if rawResponse.Error != nil { + err = mkerr(rawResponse) + return + } + + err = json.Unmarshal(rawResponse.Data, &response) + if err != nil { + rawResponseJson, _ := rawResponse.Data.MarshalJSON() + log.Println("signald-go: error unmarshalling response from signald of type", rawResponse.Type, string(rawResponseJson)) + return + } + + return response, nil + +} + // Submit: set this device's name. This will show up on the mobile device on the same account under settings -> linked devices func (r *SetDeviceNameRequest) Submit(conn *signald.Signald) (err error) { r.Version = "v1" @@ -1227,6 +1323,38 @@ func (r *TypingRequest) Submit(conn *signald.Signald) (err error) { } +// Submit: Unbans users from a group. +func (r *UnbanUserRequest) Submit(conn *signald.Signald) (response JsonGroupV2Info, err error) { + r.Version = "v1" + r.Type = "unban_user" + if r.ID == "" { + r.ID = signald.GenerateID() + } + responseChannel := conn.GetResponseListener(r.ID) + defer conn.CloseResponseListener(r.ID) + err = conn.RawRequest(r) + if err != nil { + log.Println("signald-go: error submitting request to signald") + return + } + + rawResponse := <-responseChannel + if rawResponse.Error != nil { + err = mkerr(rawResponse) + return + } + + err = json.Unmarshal(rawResponse.Data, &response) + if err != nil { + rawResponseJson, _ := rawResponse.Data.MarshalJSON() + log.Println("signald-go: error unmarshalling response from signald of type", rawResponse.Type, string(rawResponseJson)) + return + } + + return response, nil + +} + // Submit: See subscribe for more info func (r *UnsubscribeRequest) Submit(conn *signald.Signald) (err error) { r.Version = "v1" diff --git a/signald/client-protocol/v1/structs.go b/signald/client-protocol/v1/structs.go index e589b8e..cf4845f 100644 --- a/signald/client-protocol/v1/structs.go +++ b/signald/client-protocol/v1/structs.go @@ -25,6 +25,7 @@ type Account struct { Address *JsonAddress `json:"address,omitempty" yaml:"address,omitempty"` // The address of this account DeviceId int32 `json:"device_id,omitempty" yaml:"device_id,omitempty"` // The Signal device ID. Official Signal mobile clients (iPhone and Android) have device ID = 1, while linked devices such as Signal Desktop or Signal iPad have higher device IDs. Pending bool `json:"pending,omitempty" yaml:"pending,omitempty"` // indicates the account has not completed registration + Pni string `json:"pni,omitempty" yaml:"pni,omitempty"` } type AccountList struct { @@ -62,6 +63,19 @@ type ApproveMembershipRequest struct { Members []*JsonAddress `json:"members,omitempty" yaml:"members,omitempty"` // list of requesting members to approve } +// BanUserRequest: Bans users from a group. This works even if the users aren't in the group. If they are currently in the group, they will also be removed. +type BanUserRequest struct { + Request + Account string `json:"account,omitempty" yaml:"account,omitempty"` // The account to interact with + GroupId string `json:"group_id,omitempty" yaml:"group_id,omitempty"` + Users []*JsonAddress `json:"users,omitempty" yaml:"users,omitempty"` // List of users to ban +} + +type BannedGroupMember struct { + Timestamp int64 `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` // Timestamp as milliseconds since Unix epoch of when the user was banned. This field is set by the server. + UUID string `json:"uuid,omitempty" yaml:"uuid,omitempty"` +} + // BooleanMessage: A message containing a single boolean, usually as a response type BooleanMessage struct { Value bool `json:"value,omitempty" yaml:"value,omitempty"` @@ -85,9 +99,10 @@ type Capabilities struct { AnnouncementGroup bool `json:"announcement_group,omitempty" yaml:"announcement_group,omitempty"` ChangeNumber bool `json:"change_number,omitempty" yaml:"change_number,omitempty"` Gv1Migration bool `json:"gv1-migration,omitempty" yaml:"gv1-migration,omitempty"` - Gv2 bool `json:"gv2,omitempty" yaml:"gv2,omitempty"` + Gv2 bool `json:"gv2,omitempty" yaml:"gv2,omitempty"` // this capability is deprecated and will always be true SenderKey bool `json:"sender_key,omitempty" yaml:"sender_key,omitempty"` Storage bool `json:"storage,omitempty" yaml:"storage,omitempty"` + Stories bool `json:"stories,omitempty" yaml:"stories,omitempty"` } // ClientMessageWrapper: Wraps all incoming messages sent to the client after a v1 subscribe request is issued @@ -127,6 +142,7 @@ type DeviceInfo struct { type FinishLinkRequest struct { Request DeviceName string `json:"device_name,omitempty" yaml:"device_name,omitempty"` + Overwrite bool `json:"overwrite,omitempty" yaml:"overwrite,omitempty"` // overwrite existing account data if the phone number conflicts. false by default SessionId string `json:"session_id,omitempty" yaml:"session_id,omitempty"` } @@ -150,6 +166,15 @@ type GetGroupRequest struct { Revision int32 `json:"revision,omitempty" yaml:"revision,omitempty"` // the latest known revision, default value (-1) forces fetch from server } +// GetGroupRevisionPagesRequest: Query the server for group revision history. The history contains information about the changes between each revision and the user that made the change. +type GetGroupRevisionPagesRequest struct { + Request + Account string `json:"account,omitempty" yaml:"account,omitempty"` // The account to interact with + FromRevision int32 `json:"from_revision,omitempty" yaml:"from_revision,omitempty"` // The revision to start the pages from. Note that if this is lower than the revision you joined the group, an AuthorizationFailedError is returned. + GroupId string `json:"group_id,omitempty" yaml:"group_id,omitempty"` + IncludeFirstRevision bool `json:"include_first_revision,omitempty" yaml:"include_first_revision,omitempty"` // Whether to include the first state in the returned pages (default false) +} + // GetIdentitiesRequest: Get information about a known keys for a particular address type GetIdentitiesRequest struct { Request @@ -175,6 +200,11 @@ type GetServersRequest struct { Request } +type Gradient struct { + EndColor string `json:"end_color,omitempty" yaml:"end_color,omitempty"` + StartColor string `json:"start_color,omitempty" yaml:"start_color,omitempty"` +} + // GroupAccessControl: group access control settings. Options for each controlled action are: UNKNOWN, ANY, MEMBER, ADMINISTRATOR, UNSATISFIABLE and UNRECOGNIZED type GroupAccessControl struct { Attributes string `json:"attributes,omitempty" yaml:"attributes,omitempty"` // who can edit group info @@ -182,6 +212,42 @@ type GroupAccessControl struct { Members string `json:"members,omitempty" yaml:"members,omitempty"` // who can add members } +// GroupChange: Represents a group change made by a user. This can also represent request link invites. Only the fields relevant to the group change performed will be set. Note that in signald, group changes are currently only received from incoming messages from a message subscription. +type GroupChange struct { + DeleteMembers []*JsonAddress `json:"delete_members,omitempty" yaml:"delete_members,omitempty"` // Represents users that have been removed from the group. This can be from admins removing users, or users choosing to leave the group + DeletePendingMembers []*JsonAddress `json:"delete_pending_members,omitempty" yaml:"delete_pending_members,omitempty"` + DeleteRequestingMembers []*JsonAddress `json:"delete_requesting_members,omitempty" yaml:"delete_requesting_members,omitempty"` + Editor *JsonAddress `json:"editor,omitempty" yaml:"editor,omitempty"` // The user that made the change. + ModifiedProfileKeys []*GroupMember `json:"modified_profile_keys,omitempty" yaml:"modified_profile_keys,omitempty"` // Represents users that have rotated their profile key. Note that signald currently does not expose profile keys to clients. The joined revision property will always be 0 in this list. + ModifyMemberRoles []*GroupMember `json:"modify_member_roles,omitempty" yaml:"modify_member_roles,omitempty"` // Represents users with their new, modified role. + NewAccessControl *GroupAccessControl `json:"new_access_control,omitempty" yaml:"new_access_control,omitempty"` // If not null, then this group change modified one of the access controls. Some of the properties in here will be null. + NewAvatar bool `json:"new_avatar,omitempty" yaml:"new_avatar,omitempty"` // Whether this group change changed the avatar. + NewBannedMembers []*BannedGroupMember `json:"new_banned_members,omitempty" yaml:"new_banned_members,omitempty"` + NewDescription string `json:"new_description,omitempty" yaml:"new_description,omitempty"` + NewInviteLinkPassword bool `json:"new_invite_link_password,omitempty" yaml:"new_invite_link_password,omitempty"` // Whether this group change involved resetting the group invite link. + NewIsAnnouncementGroup string `json:"new_is_announcement_group,omitempty" yaml:"new_is_announcement_group,omitempty"` // Whether this change affected the announcement group setting. Possible values are UNKNOWN, ENABLED or DISABLED + NewMembers []*GroupMember `json:"new_members,omitempty" yaml:"new_members,omitempty"` // Represents users have been added to the group. This can be from group members adding users, or a users joining via a group link that required no approval. + NewPendingMembers []*GroupPendingMember `json:"new_pending_members,omitempty" yaml:"new_pending_members,omitempty"` // Represents a user that has been invited to the group by another user. + NewRequestingMembers []*GroupRequestingMember `json:"new_requesting_members,omitempty" yaml:"new_requesting_members,omitempty"` // Represents users that have requested to join the group via the group link. Note that members requesting to join might not necessarily have the list of users in the group, so they won't be able to send a peer-to-peer group update message to inform users of their request to join. Other users in the group may inform us that the revision has increased, but the members requesting access will have to be obtained from the server instead (which signald will handle). For now, a get_group request has to be made to get the users that have requested to join the group. + NewTimer int32 `json:"new_timer,omitempty" yaml:"new_timer,omitempty"` // New disappearing messages timer value. + NewTitle string `json:"new_title,omitempty" yaml:"new_title,omitempty"` + NewUnbannedMembers []*BannedGroupMember `json:"new_unbanned_members,omitempty" yaml:"new_unbanned_members,omitempty"` + PromotePendingMembers []*GroupMember `json:"promote_pending_members,omitempty" yaml:"promote_pending_members,omitempty"` + PromoteRequestingMembers []*GroupMember `json:"promote_requesting_members,omitempty" yaml:"promote_requesting_members,omitempty"` + Revision int32 `json:"revision,omitempty" yaml:"revision,omitempty"` // The group revision that this change brings the group to. +} + +type GroupHistoryEntry struct { + Change *GroupChange `json:"change,omitempty" yaml:"change,omitempty"` + Group *JsonGroupV2Info `json:"group,omitempty" yaml:"group,omitempty"` +} + +// GroupHistoryPage: The result of fetching a group's history along with paging data. +type GroupHistoryPage struct { + PagingData *PagingData `json:"paging_data,omitempty" yaml:"paging_data,omitempty"` + Results []*GroupHistoryEntry `json:"results,omitempty" yaml:"results,omitempty"` +} + // GroupInfo: A generic type that is used when the group version is not known type GroupInfo struct { V1 *JsonGroupInfo `json:"v1,omitempty" yaml:"v1,omitempty"` @@ -206,6 +272,18 @@ type GroupMember struct { UUID string `json:"uuid,omitempty" yaml:"uuid,omitempty"` } +type GroupPendingMember struct { + AddedByUuid string `json:"added_by_uuid,omitempty" yaml:"added_by_uuid,omitempty"` + Role string `json:"role,omitempty" yaml:"role,omitempty"` // possible values are: UNKNOWN, DEFAULT, ADMINISTRATOR and UNRECOGNIZED + Timestamp int64 `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` + UUID string `json:"uuid,omitempty" yaml:"uuid,omitempty"` +} + +type GroupRequestingMember struct { + Timestamp int64 `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` + UUID string `json:"uuid,omitempty" yaml:"uuid,omitempty"` +} + type HangupMessage struct { DeviceId int32 `json:"device_id,omitempty" yaml:"device_id,omitempty"` ID int64 `json:"id,omitempty" yaml:"id,omitempty"` @@ -244,6 +322,7 @@ type IncomingMessage struct { ServerReceiverTimestamp int64 `json:"server_receiver_timestamp,omitempty" yaml:"server_receiver_timestamp,omitempty"` Source *JsonAddress `json:"source,omitempty" yaml:"source,omitempty"` SourceDevice int32 `json:"source_device,omitempty" yaml:"source_device,omitempty"` + StoryMessage *StoryMessage `json:"story_message,omitempty" yaml:"story_message,omitempty"` SyncMessage *JsonSyncMessage `json:"sync_message,omitempty" yaml:"sync_message,omitempty"` Timestamp int64 `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` Type string `json:"type,omitempty" yaml:"type,omitempty"` @@ -294,24 +373,26 @@ type JsonBlockedListMessage struct { } type JsonDataMessage struct { - Attachments []*JsonAttachment `json:"attachments,omitempty" yaml:"attachments,omitempty"` // files attached to the incoming message - Body string `json:"body,omitempty" yaml:"body,omitempty"` // the text body of the incoming message. - Contacts []*SharedContact `json:"contacts,omitempty" yaml:"contacts,omitempty"` // if the incoming message has a shared contact, the contact's information will be here - EndSession bool `json:"endSession,omitempty" yaml:"endSession,omitempty"` - ExpiresInSeconds int32 `json:"expiresInSeconds,omitempty" yaml:"expiresInSeconds,omitempty"` // the expiry timer on the incoming message. Clients should delete records of the message within this number of seconds - Group *JsonGroupInfo `json:"group,omitempty" yaml:"group,omitempty"` // if the incoming message was sent to a v1 group, information about that group will be here - GroupV2 *JsonGroupV2Info `json:"groupV2,omitempty" yaml:"groupV2,omitempty"` // if the incoming message was sent to a v2 group, basic identifying information about that group will be here. If group information changes, JsonGroupV2Info.revision is incremented. If the group revision is higher than previously seen, a client can retrieve the group information by calling get_group. - GroupCallUpdate string `json:"group_call_update,omitempty" yaml:"group_call_update,omitempty"` // the eraId string from a group call message update - Mentions []*JsonMention `json:"mentions,omitempty" yaml:"mentions,omitempty"` // list of mentions in the message - Payment *Payment `json:"payment,omitempty" yaml:"payment,omitempty"` // details about the MobileCoin payment attached to the message, if present - Previews []*JsonPreview `json:"previews,omitempty" yaml:"previews,omitempty"` // if the incoming message has a link preview, information about that preview will be here - ProfileKeyUpdate bool `json:"profileKeyUpdate,omitempty" yaml:"profileKeyUpdate,omitempty"` - Quote *JsonQuote `json:"quote,omitempty" yaml:"quote,omitempty"` // if the incoming message is a quote or reply to another message, this will contain information about that message - Reaction *JsonReaction `json:"reaction,omitempty" yaml:"reaction,omitempty"` // if the message adds or removes a reaction to another message, this will indicate what change is being made - RemoteDelete *RemoteDelete `json:"remoteDelete,omitempty" yaml:"remoteDelete,omitempty"` // if the inbound message is deleting a previously sent message, indicates which message should be deleted - Sticker *v0.JsonSticker `json:"sticker,omitempty" yaml:"sticker,omitempty"` // if the incoming message is a sticker, information about the sicker will be here - Timestamp int64 `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` // the timestamp that the message was sent at, according to the sender's device. This is used to uniquely identify this message for things like reactions and quotes. - ViewOnce bool `json:"viewOnce,omitempty" yaml:"viewOnce,omitempty"` // indicates the message is a view once message. View once messages typically include no body and a single image attachment. Official Signal clients will prevent the user from saving the image, and once the user has viewed the image once they will destroy the image. + Attachments []*JsonAttachment `json:"attachments,omitempty" yaml:"attachments,omitempty"` // files attached to the incoming message + Body string `json:"body,omitempty" yaml:"body,omitempty"` // the text body of the incoming message. + Contacts []*SharedContact `json:"contacts,omitempty" yaml:"contacts,omitempty"` // if the incoming message has a shared contact, the contact's information will be here + EndSession bool `json:"endSession,omitempty" yaml:"endSession,omitempty"` + ExpiresInSeconds int32 `json:"expiresInSeconds,omitempty" yaml:"expiresInSeconds,omitempty"` // the expiry timer on the incoming message. Clients should delete records of the message within this number of seconds + Group *JsonGroupInfo `json:"group,omitempty" yaml:"group,omitempty"` // if the incoming message was sent to a v1 group, information about that group will be here + GroupV2 *JsonGroupV2Info `json:"groupV2,omitempty" yaml:"groupV2,omitempty"` // if the incoming message was sent to a v2 group, basic identifying information about that group will be here. If group information changes, JsonGroupV2Info.revision is incremented. If the group revision is higher than previously seen, a client can retrieve the group information by calling get_group. + GroupCallUpdate string `json:"group_call_update,omitempty" yaml:"group_call_update,omitempty"` // the eraId string from a group call message update + IsExpirationUpdate bool `json:"is_expiration_update,omitempty" yaml:"is_expiration_update,omitempty"` // whether or not this message changes the expiresInSeconds value for the whole chat. Some messages (remote deletes, reactions, etc) will have expiresInSeconds=0 even though the chat has disappearing messages enabled. + Mentions []*JsonMention `json:"mentions,omitempty" yaml:"mentions,omitempty"` // list of mentions in the message + Payment *Payment `json:"payment,omitempty" yaml:"payment,omitempty"` // details about the MobileCoin payment attached to the message, if present + Previews []*JsonPreview `json:"previews,omitempty" yaml:"previews,omitempty"` // if the incoming message has a link preview, information about that preview will be here + ProfileKeyUpdate bool `json:"profileKeyUpdate,omitempty" yaml:"profileKeyUpdate,omitempty"` + Quote *JsonQuote `json:"quote,omitempty" yaml:"quote,omitempty"` // if the incoming message is a quote or reply to another message, this will contain information about that message + Reaction *JsonReaction `json:"reaction,omitempty" yaml:"reaction,omitempty"` // if the message adds or removes a reaction to another message, this will indicate what change is being made + RemoteDelete *RemoteDelete `json:"remoteDelete,omitempty" yaml:"remoteDelete,omitempty"` // if the inbound message is deleting a previously sent message, indicates which message should be deleted + Sticker *v0.JsonSticker `json:"sticker,omitempty" yaml:"sticker,omitempty"` // if the incoming message is a sticker, information about the sicker will be here + StoryContext *StoryContext `json:"story_context,omitempty" yaml:"story_context,omitempty"` + Timestamp int64 `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` // the timestamp that the message was sent at, according to the sender's device. This is used to uniquely identify this message for things like reactions and quotes. + ViewOnce bool `json:"viewOnce,omitempty" yaml:"viewOnce,omitempty"` // indicates the message is a view once message. View once messages typically include no body and a single image attachment. Official Signal clients will prevent the user from saving the image, and once the user has viewed the image once they will destroy the image. } // JsonGroupInfo: information about a legacy group @@ -335,21 +416,23 @@ type JsonGroupJoinInfo struct { // JsonGroupV2Info: Information about a Signal group type JsonGroupV2Info struct { - AccessControl *GroupAccessControl `json:"accessControl,omitempty" yaml:"accessControl,omitempty"` // current access control settings for this group - Announcements string `json:"announcements,omitempty" yaml:"announcements,omitempty"` // indicates if the group is an announcements group. Only admins are allowed to send messages to announcements groups. Options are UNKNOWN, ENABLED or DISABLED - Avatar string `json:"avatar,omitempty" yaml:"avatar,omitempty"` // path to the group's avatar on local disk, if available - Description string `json:"description,omitempty" yaml:"description,omitempty"` - ID string `json:"id,omitempty" yaml:"id,omitempty"` - InviteLink string `json:"inviteLink,omitempty" yaml:"inviteLink,omitempty"` // the signal.group link, if applicable - MemberDetail []*GroupMember `json:"memberDetail,omitempty" yaml:"memberDetail,omitempty"` // detailed member list - Members []*JsonAddress `json:"members,omitempty" yaml:"members,omitempty"` - PendingMemberDetail []*GroupMember `json:"pendingMemberDetail,omitempty" yaml:"pendingMemberDetail,omitempty"` // detailed pending member list - PendingMembers []*JsonAddress `json:"pendingMembers,omitempty" yaml:"pendingMembers,omitempty"` - Removed bool `json:"removed,omitempty" yaml:"removed,omitempty"` // will be set to true for incoming messages to indicate the user has been removed from the group - RequestingMembers []*JsonAddress `json:"requestingMembers,omitempty" yaml:"requestingMembers,omitempty"` - Revision int32 `json:"revision,omitempty" yaml:"revision,omitempty"` - Timer int32 `json:"timer,omitempty" yaml:"timer,omitempty"` - Title string `json:"title,omitempty" yaml:"title,omitempty"` + AccessControl *GroupAccessControl `json:"accessControl,omitempty" yaml:"accessControl,omitempty"` // current access control settings for this group + Announcements string `json:"announcements,omitempty" yaml:"announcements,omitempty"` // indicates if the group is an announcements group. Only admins are allowed to send messages to announcements groups. Options are UNKNOWN, ENABLED or DISABLED + Avatar string `json:"avatar,omitempty" yaml:"avatar,omitempty"` // path to the group's avatar on local disk, if available + BannedMembers []*BannedGroupMember `json:"banned_members,omitempty" yaml:"banned_members,omitempty"` + Description string `json:"description,omitempty" yaml:"description,omitempty"` + GroupChange *GroupChange `json:"group_change,omitempty" yaml:"group_change,omitempty"` // Represents a peer-to-peer group change done by a user. Will not be set if the group change signature fails verification. This is usually only set inside of incoming messages. + ID string `json:"id,omitempty" yaml:"id,omitempty"` + InviteLink string `json:"inviteLink,omitempty" yaml:"inviteLink,omitempty"` // the signal.group link, if applicable + MemberDetail []*GroupMember `json:"memberDetail,omitempty" yaml:"memberDetail,omitempty"` // detailed member list + Members []*JsonAddress `json:"members,omitempty" yaml:"members,omitempty"` + PendingMemberDetail []*GroupMember `json:"pendingMemberDetail,omitempty" yaml:"pendingMemberDetail,omitempty"` // detailed pending member list + PendingMembers []*JsonAddress `json:"pendingMembers,omitempty" yaml:"pendingMembers,omitempty"` + Removed bool `json:"removed,omitempty" yaml:"removed,omitempty"` // will be set to true for incoming messages to indicate the user has been removed from the group + RequestingMembers []*JsonAddress `json:"requestingMembers,omitempty" yaml:"requestingMembers,omitempty"` + Revision int32 `json:"revision,omitempty" yaml:"revision,omitempty"` + Timer int32 `json:"timer,omitempty" yaml:"timer,omitempty"` + Title string `json:"title,omitempty" yaml:"title,omitempty"` } type JsonMention struct { @@ -358,31 +441,11 @@ type JsonMention struct { UUID string `json:"uuid,omitempty" yaml:"uuid,omitempty"` // The UUID of the account being mentioned } -type JsonMessageEnvelope struct { - CallMessage *v0.JsonCallMessage `json:"callMessage,omitempty" yaml:"callMessage,omitempty"` - DataMessage *JsonDataMessage `json:"dataMessage,omitempty" yaml:"dataMessage,omitempty"` - HasContent bool `json:"hasContent,omitempty" yaml:"hasContent,omitempty"` - HasLegacyMessage bool `json:"hasLegacyMessage,omitempty" yaml:"hasLegacyMessage,omitempty"` - IsUnidentifiedSender bool `json:"isUnidentifiedSender,omitempty" yaml:"isUnidentifiedSender,omitempty"` - Receipt *v0.JsonReceiptMessage `json:"receipt,omitempty" yaml:"receipt,omitempty"` - Relay string `json:"relay,omitempty" yaml:"relay,omitempty"` - ServerDeliveredTimestamp int64 `json:"serverDeliveredTimestamp,omitempty" yaml:"serverDeliveredTimestamp,omitempty"` - ServerTimestamp int64 `json:"serverTimestamp,omitempty" yaml:"serverTimestamp,omitempty"` - Source *JsonAddress `json:"source,omitempty" yaml:"source,omitempty"` - SourceDevice int32 `json:"sourceDevice,omitempty" yaml:"sourceDevice,omitempty"` - SyncMessage *JsonSyncMessage `json:"syncMessage,omitempty" yaml:"syncMessage,omitempty"` - Timestamp int64 `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` - TimestampISO string `json:"timestampISO,omitempty" yaml:"timestampISO,omitempty"` - Type string `json:"type,omitempty" yaml:"type,omitempty"` - Typing *v0.JsonTypingMessage `json:"typing,omitempty" yaml:"typing,omitempty"` - Username string `json:"username,omitempty" yaml:"username,omitempty"` - UUID string `json:"uuid,omitempty" yaml:"uuid,omitempty"` -} - +// JsonMessageRequestResponseMessage: Responses to message requests from unknown users or groups type JsonMessageRequestResponseMessage struct { GroupId string `json:"groupId,omitempty" yaml:"groupId,omitempty"` Person *JsonAddress `json:"person,omitempty" yaml:"person,omitempty"` - Type string `json:"type,omitempty" yaml:"type,omitempty"` + Type string `json:"type,omitempty" yaml:"type,omitempty"` // One of UNKNOWN, ACCEPT, DELETE, BLOCK, BLOCK_AND_DELETE, UNBLOCK_AND_ACCEPT } // JsonPreview: metadata about one of the links in a message @@ -519,6 +582,11 @@ type OfferMessage struct { Type string `json:"type,omitempty" yaml:"type,omitempty"` } +type PagingData struct { + HasMorePages bool `json:"has_more_pages,omitempty" yaml:"has_more_pages,omitempty"` + NextPageRevision int32 `json:"next_page_revision,omitempty" yaml:"next_page_revision,omitempty"` +} + // Payment: details about a MobileCoin payment type Payment struct { Note string `json:"note,omitempty" yaml:"note,omitempty"` // note attached to the payment @@ -566,6 +634,7 @@ type ReceiptMessage struct { type RefuseMembershipRequest struct { Request Account string `json:"account,omitempty" yaml:"account,omitempty"` // The account to interact with + AlsoBan bool `json:"also_ban,omitempty" yaml:"also_ban,omitempty"` GroupId string `json:"group_id,omitempty" yaml:"group_id,omitempty"` Members []*JsonAddress `json:"members,omitempty" yaml:"members,omitempty"` // list of requesting members to refuse } @@ -658,6 +727,7 @@ type SendPaymentRequest struct { type SendRequest struct { Request + Account string `json:"account,omitempty" yaml:"account,omitempty"` Attachments []*JsonAttachment `json:"attachments,omitempty" yaml:"attachments,omitempty"` Members []*JsonAddress `json:"members,omitempty" yaml:"members,omitempty"` // Optionally set to a sub-set of group members. Ignored if recipientGroupId isn't specified Mentions []*JsonMention `json:"mentions,omitempty" yaml:"mentions,omitempty"` @@ -682,6 +752,14 @@ type SendSuccess struct { Unidentified bool `json:"unidentified,omitempty" yaml:"unidentified,omitempty"` } +// SendSyncMessageRequest: Sends a sync message to the account's devices +type SendSyncMessageRequest struct { + Request + Account string `json:"account,omitempty" yaml:"account,omitempty"` + MessageRequestResponse *JsonMessageRequestResponseMessage `json:"message_request_response,omitempty" yaml:"message_request_response,omitempty"` // This can be set to indicate to other devices about a response to an incoming message request from an unknown user or group. Warning: Using the BLOCK and BLOCK_AND_DELETE options relies on other devices to do the blocking, and it does not make you leave the group! + ViewOnceOpenMessage *JsonViewOnceOpenMessage `json:"view_once_open_message,omitempty" yaml:"view_once_open_message,omitempty"` // This can be set to indicate to other devices about having viewed a view-once message. +} + // Server: a Signal server type Server struct { Ca string `json:"ca,omitempty" yaml:"ca,omitempty"` // base64 encoded trust store, password must be 'whisper' @@ -784,6 +862,23 @@ type SharedContactPhone struct { Value string `json:"value,omitempty" yaml:"value,omitempty"` // the phone number } +// StorageChange: Broadcast to subscribed clients when there is a state change from the storage service +type StorageChange struct { + Version int64 `json:"version,omitempty" yaml:"version,omitempty"` // Seems to behave like the group version numbers and increments every time the state changes +} + +type StoryContext struct { + Author string `json:"author,omitempty" yaml:"author,omitempty"` + SentTimestamp int64 `json:"sent_timestamp,omitempty" yaml:"sent_timestamp,omitempty"` +} + +type StoryMessage struct { + AllowReplies bool `json:"allow_replies,omitempty" yaml:"allow_replies,omitempty"` + File *JsonAttachment `json:"file,omitempty" yaml:"file,omitempty"` + Group *JsonGroupV2Info `json:"group,omitempty" yaml:"group,omitempty"` + Text *TextAttachment `json:"text,omitempty" yaml:"text,omitempty"` +} + type SubmitChallengeRequest struct { Request Account string `json:"account,omitempty" yaml:"account,omitempty"` @@ -797,6 +892,16 @@ type SubscribeRequest struct { Account string `json:"account,omitempty" yaml:"account,omitempty"` // The account to subscribe to incoming message for } +type TextAttachment struct { + BackgroundColor string `json:"background_color,omitempty" yaml:"background_color,omitempty"` + BackgroundGradient *Gradient `json:"background_gradient,omitempty" yaml:"background_gradient,omitempty"` + Preview *JsonPreview `json:"preview,omitempty" yaml:"preview,omitempty"` + Style string `json:"style,omitempty" yaml:"style,omitempty"` + Text string `json:"text,omitempty" yaml:"text,omitempty"` + TextBackgroundColor string `json:"text_background_color,omitempty" yaml:"text_background_color,omitempty"` + TextForegroundColor string `json:"text_foreground_color,omitempty" yaml:"text_foreground_color,omitempty"` +} + // TrustRequest: Trust another user's safety number using either the QR code data or the safety number text type TrustRequest struct { Request @@ -823,6 +928,14 @@ type TypingRequest struct { When int64 `json:"when,omitempty" yaml:"when,omitempty"` } +// UnbanUserRequest: Unbans users from a group. +type UnbanUserRequest struct { + Request + Account string `json:"account,omitempty" yaml:"account,omitempty"` // The account to interact with + GroupId string `json:"group_id,omitempty" yaml:"group_id,omitempty"` + Users []*JsonAddress `json:"users,omitempty" yaml:"users,omitempty"` // List of users to unban +} + // UnsubscribeRequest: See subscribe for more info type UnsubscribeRequest struct { Request From 12874dd6dcdff2e667383601016ec85ff6f50b34 Mon Sep 17 00:00:00 2001 From: finn Date: Mon, 27 Jun 2022 10:00:11 -0700 Subject: [PATCH 25/37] fix migrations, closes !10 --- cmd/signaldctl/cmd/db/migrate.go | 7 ++++--- cmd/signaldctl/cmd/db/postgres.go | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 5bac893..7d92f2d 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -32,6 +32,7 @@ var ( {InstalledRank: 3, Version: "13", Description: "recipient registration status", Script: "V13__recipient_registration_status.sql", Checksum: 405376321}, {InstalledRank: 4, Version: "14", Description: "multiple identity keys per account", Script: "V14__multiple_identity_keys_per_account.sql", Checksum: -1635788950}, {InstalledRank: 5, Version: "15", Description: "profiles tables", Script: "V15__profiles_tables.sql", Checksum: 809686180}, + {InstalledRank: 6, Version: "16", Description: "destination uuid in envelope", Script: "V16__destination_uuid_in_envelope.sql", Checksum: -566452172}, } sqlitePath string @@ -269,7 +270,7 @@ func moveAccounts(source *sql.DB, dest *sql.DB) error { if err != nil { return err } - _, err = dest.Exec("INSERT INTO signald_accounts (uuid, e164, server) VALUES ($1, $2, $3, $4)", accountUUID, e164, server) + _, err = dest.Exec("INSERT INTO signald_accounts (uuid, e164, server) VALUES ($1, $2, $3)", accountUUID, e164, server) if err != nil { return err } @@ -668,7 +669,7 @@ func moveProfileKeys(source *sql.DB, dest *sql.DB) error { _, err = dest.Exec(` INSERT INTO signald_profile_keys (account_uuid, recipient, profile_key, profile_key_credential, request_pending, unidentified_access_mode) - VALUES ($1, $2, $3, $4, $5, $6, $7) + VALUES ($1, $2, $3, $4, $5, $6) `, accountUUID, recipient, profile_key, profile_key_credential, request_pending, unidentified_access_mode) if err != nil { return err @@ -694,7 +695,7 @@ func moveProfiles(source *sql.DB, dest *sql.DB) error { about string emoji string payment_address []byte - badges string + badges sql.NullString ) err = rows.Scan(&accountUUID, &recipient, &last_update, &given_name, &family_name, &about, &emoji, &payment_address, &badges) if err != nil { diff --git a/cmd/signaldctl/cmd/db/postgres.go b/cmd/signaldctl/cmd/db/postgres.go index 5f7c2b3..abc8594 100644 --- a/cmd/signaldctl/cmd/db/postgres.go +++ b/cmd/signaldctl/cmd/db/postgres.go @@ -29,7 +29,8 @@ var ( legacy_message BYTEA, server_received_timestamp BIGINT, server_delivered_timestamp BIGINT, - server_uuid UUID + server_uuid UUID, + destination_uuid TEXT ); CREATE TABLE signald_servers ( From 9928e5ffc2caafb41fe8d81f531e70076f0b35a5 Mon Sep 17 00:00:00 2001 From: finn Date: Mon, 27 Jun 2022 11:46:58 -0700 Subject: [PATCH 26/37] fix migration 16 checksum --- cmd/signaldctl/cmd/db/migrate.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 7d92f2d..122e499 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -32,7 +32,7 @@ var ( {InstalledRank: 3, Version: "13", Description: "recipient registration status", Script: "V13__recipient_registration_status.sql", Checksum: 405376321}, {InstalledRank: 4, Version: "14", Description: "multiple identity keys per account", Script: "V14__multiple_identity_keys_per_account.sql", Checksum: -1635788950}, {InstalledRank: 5, Version: "15", Description: "profiles tables", Script: "V15__profiles_tables.sql", Checksum: 809686180}, - {InstalledRank: 6, Version: "16", Description: "destination uuid in envelope", Script: "V16__destination_uuid_in_envelope.sql", Checksum: -566452172}, + {InstalledRank: 6, Version: "16", Description: "destination uuid in envelope", Script: "V16__destination_uuid_in_envelope.sql", Checksum: 357656854}, } sqlitePath string From dd208b6e82003235c68db13ee3e13995a3462abe Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Thu, 11 Aug 2022 10:44:37 -0400 Subject: [PATCH 27/37] Exclude missing accounts from contact migration Otherwise, moveContacts fails with a foreign key constraint violation. --- cmd/signaldctl/cmd/db/migrate.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 122e499..86858e9 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -614,7 +614,9 @@ func moveGroupCredentials(source *sql.DB, dest *sql.DB) error { } func moveContacts(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, recipient, name, color, profile_key, message_expiration_time, inbox_position FROM contacts") + rows, err := source.Query("SELECT account_uuid, recipient, name, color, profile_key, message_expiration_time, inbox_position FROM contacts" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + ) if err != nil { return err } From 67a7576e24cb9b7a0854d6699207786b104ac6c2 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Thu, 11 Aug 2022 10:42:43 -0400 Subject: [PATCH 28/37] Refactor migration functions & messages Ensure that success & error migration logs use the same description text for the migration step that they refer to. --- cmd/signaldctl/cmd/db/migrate.go | 102 ++++++++----------------------- 1 file changed, 26 insertions(+), 76 deletions(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 86858e9..197a651 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -60,7 +60,7 @@ var ( } return nil }, - RunE: func(cmd *cobra.Command, args []string) error { + RunE: func(cmd *cobra.Command, args []string) (err error) { source, err := sql.Open("sqlite3", sqlitePath) if err != nil { return err @@ -93,83 +93,33 @@ var ( } log.Println("created schema") - if err := moveAccounts(source, dest); err != nil { - log.Println("error moving accounts table") - return err + migrate := func(fn func(*sql.DB, *sql.DB) error, targetName string) { + if err = fn(source, dest); err != nil { + log.Println("error moving", targetName) + panic(err) + } + log.Println("moved", targetName) } - log.Println("moved accounts table") + defer func() { + if r := recover(); r != nil && r != err { + // If r is something other than the error returned via the named return, re-panic it + panic(r) + } + }() - if err := moveRecipients(source, dest); err != nil { - log.Println("error moving recipients table") - return err - } - log.Println("moved recipients table") - - if err := movePrekeys(source, dest); err != nil { - log.Println("error moving prekeys table") - return err - } - log.Println("moved prekeys table") - - if err := moveSessions(source, dest); err != nil { - log.Println("error moving sessions table") - return err - } - log.Println("moved sessions table") - - if err := moveSignedPrekeys(source, dest); err != nil { - log.Println("error moving signed prekeys table") - return err - } - log.Println("moved signed prekeys table") - - if err := moveIdentityKeys(source, dest); err != nil { - log.Println("error moving identity keys table") - return err - } - log.Println("moved identity keys table") - - if err := moveAccountData(source, dest); err != nil { - log.Println("error moving account data") - return err - } - log.Println("moved account data table") - - if err := movePendingAccountData(source, dest); err != nil { - log.Println("error moving pending account data tabe") - return err - } - log.Println("moved pending account data table") - - if err := moveSenderKeys(source, dest); err != nil { - log.Println("error moving sender keys table") - return err - } - log.Println("moved sender keys table") - - if err := moveSenderKeyShared(source, dest); err != nil { - log.Println("error moving sender key shared table") - return err - } - log.Println("moved sender key shared table") - - if err := moveGroups(source, dest); err != nil { - log.Println("error moving groups table") - return err - } - log.Println("moved groups table") - - if err := moveGroupCredentials(source, dest); err != nil { - log.Println("error moving group credentials table") - return err - } - log.Println("moved group credentials table") - - if err := moveContacts(source, dest); err != nil { - log.Println("error moving group credentials table") - return err - } - log.Println("moved contacts table") + migrate(moveAccounts, "accounts table") + migrate(moveRecipients, "recipients table") + migrate(movePrekeys, "prekeys table") + migrate(moveSessions, "sessions table") + migrate(moveSignedPrekeys, "signed prekeys table") + migrate(moveIdentityKeys, "identity keys table") + migrate(moveAccountData, "account data") + migrate(movePendingAccountData, "pending account data table") + migrate(moveSenderKeys, "sender keys table") + migrate(moveSenderKeyShared, "sender key shared table") + migrate(moveGroups, "groups table") + migrate(moveGroupCredentials, "group credentials table") + migrate(moveContacts, "contacts table") if err := moveProfileKeys(source, dest); err != nil { log.Println("error moving profile keys table") From 4178a582e898898ccd7934391a21edb176490219 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Mon, 15 Aug 2022 17:36:01 -0400 Subject: [PATCH 29/37] Refactor more migration functions --- cmd/signaldctl/cmd/db/migrate.go | 28 ++++------------------------ 1 file changed, 4 insertions(+), 24 deletions(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 197a651..56e54e9 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -120,30 +120,10 @@ var ( migrate(moveGroups, "groups table") migrate(moveGroupCredentials, "group credentials table") migrate(moveContacts, "contacts table") - - if err := moveProfileKeys(source, dest); err != nil { - log.Println("error moving profile keys table") - return err - } - log.Println("moved profile keys table") - - if err := moveProfiles(source, dest); err != nil { - log.Println("error moving profiles tables") - return err - } - log.Println("moved profiles tables") - - if err := moveProfileCapabilities(source, dest); err != nil { - log.Println("error moving profile capabilities tables") - return err - } - log.Println("moved profile capabilities tables") - - if err := moveProfileBadges(source, dest); err != nil { - log.Println("error moving profile badges tables") - return err - } - log.Println("moved profile badges tables") + migrate(moveProfileKeys, "profile keys table") + migrate(moveProfiles, "profiles tables") + migrate(moveProfileCapabilities, "profile capabilities tables") + migrate(moveProfileBadges, "profile badges tables") if err := os.Remove(sqlitePath); err != nil { log.Println("error deleting sqlite file") From 5e52e5f3bd8e062a6bc6fcf3618144a6023b1915 Mon Sep 17 00:00:00 2001 From: finn Date: Tue, 16 Aug 2022 09:32:36 -0700 Subject: [PATCH 30/37] deb build cut first character (v) out of version string --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b9cba03..14a803a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -71,7 +71,7 @@ test sqlite to postgres: - go run ./cmd/signaldctl doc -o man - go run ./cmd/signaldctl completion bash > debian/package.bash-completion - ls *.1 > debian/manpages - - gbp dch --ignore-branch --debian-tag="%(version)s" --git-author --new-version="$(./version.sh)" + - gbp dch --ignore-branch --debian-tag="%(version)s" --git-author --new-version="$(./version.sh | cut -c2-)" - dpkg-buildpackage -us -uc -b - mv ../*.deb . needs: From 1ced8e01b2a462ca0e137fa3598c715593d38943 Mon Sep 17 00:00:00 2001 From: finn Date: Tue, 16 Aug 2022 09:57:10 -0700 Subject: [PATCH 31/37] bump protocol --- protocol.json | 5525 +------------------------ signald/client-protocol/v1/errors.go | 16 + signald/client-protocol/v1/structs.go | 6 +- 3 files changed, 21 insertions(+), 5526 deletions(-) diff --git a/protocol.json b/protocol.json index edf0bcb..807e84d 100644 --- a/protocol.json +++ b/protocol.json @@ -1,5524 +1 @@ -{ - "doc_version": "v1", - "version": { - "name": "signald", - "version": "0.18.3", - "branch": "main", - "commit": "2d898baa70a20c44ae918d2ce6e1f108579ee271" - }, - "info": "This document describes objects that may be used when communicating with signald.", - "types": { - "v0": { - "JsonAccountList": { - "fields": { - "accounts": { - "list": true, - "type": "JsonAccount", - "version": "v0" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonMessageEnvelope": { - "fields": { - "username": { - "type": "String", - "example": "\"+12024561414\"" - }, - "uuid": { - "type": "String", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"" - }, - "source": { - "type": "JsonAddress", - "version": "v0" - }, - "sourceDevice": { - "type": "int" - }, - "type": { - "type": "String" - }, - "relay": { - "type": "String", - "doc": "this field is no longer available and will never be populated" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - }, - "timestampISO": { - "type": "String" - }, - "serverTimestamp": { - "type": "long" - }, - "serverDeliveredTimestamp": { - "type": "long", - "example": "161557644247580" - }, - "hasLegacyMessage": { - "type": "boolean" - }, - "hasContent": { - "type": "boolean" - }, - "isUnidentifiedSender": { - "type": "boolean" - }, - "dataMessage": { - "type": "JsonDataMessage", - "version": "v0" - }, - "syncMessage": { - "type": "JsonSyncMessage", - "version": "v0" - }, - "callMessage": { - "type": "JsonCallMessage", - "version": "v0" - }, - "receipt": { - "type": "JsonReceiptMessage", - "version": "v0" - }, - "typing": { - "type": "JsonTypingMessage", - "version": "v0" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonAccount": { - "fields": { - "deviceId": { - "type": "int" - }, - "username": { - "type": "String" - }, - "filename": { - "type": "String" - }, - "uuid": { - "type": "String" - }, - "registered": { - "type": "boolean" - }, - "has_keys": { - "type": "boolean" - }, - "subscribed": { - "type": "boolean" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonAddress": { - "fields": { - "number": { - "type": "String" - }, - "uuid": { - "type": "UUID" - }, - "relay": { - "type": "String" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonDataMessage": { - "fields": { - "timestamp": { - "type": "long", - "doc": "the timestamp that the message was sent at, according to the sender's device. This is used to uniquely identify this message for things like reactions and quotes.", - "example": "1615576442475" - }, - "attachments": { - "list": true, - "type": "JsonAttachment", - "version": "v0", - "doc": "files attached to the incoming message" - }, - "body": { - "type": "String", - "doc": "the text body of the incoming message.", - "example": "\"hello\"" - }, - "group": { - "type": "JsonGroupInfo", - "version": "v0", - "doc": "if the incoming message was sent to a v1 group, information about that group will be here" - }, - "groupV2": { - "type": "JsonGroupV2Info", - "version": "v0", - "doc": "is the incoming message was sent to a v2 group, basic identifying information about that group will be here. For full information, use list_groups" - }, - "endSession": { - "type": "boolean" - }, - "expiresInSeconds": { - "type": "int", - "doc": "the expiry timer on the incoming message. Clients should delete records of the message within this number of seconds" - }, - "profileKeyUpdate": { - "type": "boolean" - }, - "quote": { - "type": "JsonQuote", - "version": "v0", - "doc": "if the incoming message is a quote or reply to another message, this will contain information about that message" - }, - "contacts": { - "list": true, - "type": "SharedContact", - "version": "v0", - "doc": "if the incoming message has a shared contact, the contact's information will be here" - }, - "previews": { - "list": true, - "type": "JsonPreview", - "version": "v0", - "doc": "if the incoming message has a link preview, information about that preview will be here" - }, - "sticker": { - "type": "JsonSticker", - "version": "v0", - "doc": "if the incoming message is a sticker, information about the sicker will be here" - }, - "viewOnce": { - "type": "boolean", - "doc": "indicates the message is a view once message. View once messages typically include no body and a single image attachment. Official Signal clients will prevent the user from saving the image, and once the user has viewed the image once they will destroy the image." - }, - "reaction": { - "type": "JsonReaction", - "version": "v0", - "doc": "if the message adds or removes a reaction to another message, this will indicate what change is being made" - }, - "remoteDelete": { - "type": "RemoteDelete", - "version": "v0", - "doc": "if the inbound message is deleting a previously sent message, indicates which message should be deleted" - }, - "mentions": { - "list": true, - "type": "JsonMention", - "version": "v0", - "doc": "list of mentions in the message" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonSyncMessage": { - "fields": { - "sent": { - "type": "JsonSentTranscriptMessage", - "version": "v0" - }, - "contacts": { - "type": "JsonAttachment", - "version": "v0" - }, - "contactsComplete": { - "type": "boolean" - }, - "groups": { - "type": "JsonAttachment", - "version": "v0" - }, - "blockedList": { - "type": "JsonBlockedListMessage", - "version": "v0" - }, - "request": { - "type": "String" - }, - "readMessages": { - "list": true, - "type": "JsonReadMessage", - "version": "v0" - }, - "viewOnceOpen": { - "type": "JsonViewOnceOpenMessage", - "version": "v0" - }, - "verified": { - "type": "JsonVerifiedMessage", - "version": "v0" - }, - "configuration": { - "type": "ConfigurationMessage", - "version": "v0" - }, - "stickerPackOperations": { - "list": true, - "type": "JsonStickerPackOperationMessage", - "version": "v0" - }, - "fetchType": { - "type": "String" - }, - "messageRequestResponse": { - "type": "JsonMessageRequestResponseMessage", - "version": "v0" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonCallMessage": { - "fields": { - "offerMessage": { - "type": "OfferMessage", - "version": "v0" - }, - "answerMessage": { - "type": "AnswerMessage", - "version": "v0" - }, - "busyMessage": { - "type": "BusyMessage", - "version": "v0" - }, - "hangupMessage": { - "type": "HangupMessage", - "version": "v0" - }, - "iceUpdateMessages": { - "list": true, - "type": "IceUpdateMessage", - "version": "v0" - }, - "destinationDeviceId": { - "type": "int" - }, - "isMultiRing": { - "type": "boolean" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonReceiptMessage": { - "fields": { - "type": { - "type": "String" - }, - "timestamps": { - "list": true, - "type": "Long" - }, - "when": { - "type": "long" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonTypingMessage": { - "fields": { - "action": { - "type": "String" - }, - "timestamp": { - "type": "long" - }, - "groupId": { - "type": "String" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonAttachment": { - "fields": { - "contentType": { - "type": "String" - }, - "id": { - "type": "String" - }, - "size": { - "type": "int" - }, - "storedFilename": { - "type": "String" - }, - "filename": { - "type": "String" - }, - "customFilename": { - "type": "String" - }, - "caption": { - "type": "String" - }, - "width": { - "type": "int" - }, - "height": { - "type": "int" - }, - "voiceNote": { - "type": "boolean" - }, - "key": { - "type": "String" - }, - "digest": { - "type": "String" - }, - "blurhash": { - "type": "String" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonGroupInfo": { - "fields": { - "groupId": { - "type": "String" - }, - "members": { - "list": true, - "type": "JsonAddress", - "version": "v0" - }, - "name": { - "type": "String" - }, - "type": { - "type": "String" - }, - "avatarId": { - "type": "long" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonGroupV2Info": { - "fields": { - "id": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"" - }, - "revision": { - "type": "int", - "example": "5" - }, - "title": { - "type": "String", - "example": "\"Parkdale Run Club\"" - }, - "description": { - "type": "String" - }, - "avatar": { - "type": "String", - "doc": "path to the group's avatar on local disk, if available", - "example": "\"/var/lib/signald/avatars/group-EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"" - }, - "timer": { - "type": "int", - "example": "604800" - }, - "members": { - "list": true, - "type": "JsonAddress", - "version": "v0" - }, - "pendingMembers": { - "list": true, - "type": "JsonAddress", - "version": "v0" - }, - "requestingMembers": { - "list": true, - "type": "JsonAddress", - "version": "v0" - }, - "inviteLink": { - "type": "String", - "doc": "the signal.group link, if applicable" - }, - "accessControl": { - "type": "GroupAccessControl", - "version": "v0", - "doc": "current access control settings for this group" - }, - "memberDetail": { - "list": true, - "type": "GroupMember", - "version": "v0", - "doc": "detailed member list" - }, - "pendingMemberDetail": { - "list": true, - "type": "GroupMember", - "version": "v0", - "doc": "detailed pending member list" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonQuote": { - "fields": { - "id": { - "type": "long", - "doc": "the client timestamp of the message being quoted", - "example": "1615576442475" - }, - "author": { - "type": "JsonAddress", - "version": "v0", - "doc": "the author of the message being quoted" - }, - "text": { - "type": "String", - "doc": "the body of the message being quoted", - "example": "\"hey  what's up?\"" - }, - "attachments": { - "list": true, - "type": "JsonQuotedAttachment", - "version": "v0", - "doc": "list of files attached to the quoted message" - }, - "mentions": { - "list": true, - "type": "JsonMention", - "version": "v0", - "doc": "list of mentions in the quoted message" - } - }, - "doc": "A quote is a reply to a previous message. ID is the sent time of the message being replied to", - "deprecated": true, - "removal_date": 1641027661 - }, - "SharedContact": { - "fields": { - "name": { - "type": "Name", - "version": "v0" - }, - "avatar": { - "type": "Optional", - "version": "v0" - }, - "phone": { - "type": "Optional", - "version": "v0" - }, - "email": { - "type": "Optional", - "version": "v0" - }, - "address": { - "type": "Optional", - "version": "v0" - }, - "organization": { - "type": "Optional", - "version": "v0" - } - } - }, - "JsonPreview": { - "fields": { - "url": { - "type": "String" - }, - "title": { - "type": "String" - }, - "attachment": { - "type": "JsonAttachment", - "version": "v0" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonSticker": { - "fields": { - "packID": { - "type": "String" - }, - "packKey": { - "type": "String" - }, - "stickerID": { - "type": "int" - }, - "attachment": { - "type": "JsonAttachment", - "version": "v0" - }, - "image": { - "type": "String" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonReaction": { - "fields": { - "emoji": { - "type": "String", - "doc": "the emoji to react with", - "example": "\"👍\"" - }, - "remove": { - "type": "boolean", - "doc": "set to true to remove the reaction. requires emoji be set to previously reacted emoji" - }, - "targetAuthor": { - "type": "JsonAddress", - "version": "v0", - "doc": "the author of the message being reacted to" - }, - "targetSentTimestamp": { - "type": "long", - "doc": "the client timestamp of the message being reacted to", - "example": "1615576442475" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "RemoteDelete": { - "fields": { - "targetSentTimestamp": { - "type": "long" - } - } - }, - "JsonMention": { - "fields": { - "uuid": { - "type": "String", - "doc": "The UUID of the account being mentioned", - "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" - }, - "start": { - "type": "int", - "doc": "The number of characters in that the mention starts at. Note that due to a quirk of how signald encodes JSON, if this value is 0 (for example if the first character in the message is the mention) the field won't show up.", - "example": "4" - }, - "length": { - "type": "int", - "doc": "The length of the mention represented in the message. Seems to always be 1 but included here in case that changes.", - "example": "1" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonSentTranscriptMessage": { - "fields": { - "destination": { - "type": "JsonAddress", - "version": "v0" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - }, - "expirationStartTimestamp": { - "type": "long" - }, - "message": { - "type": "JsonDataMessage", - "version": "v0" - }, - "unidentifiedStatus": { - "type": "Map" - }, - "isRecipientUpdate": { - "type": "boolean" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonBlockedListMessage": { - "fields": { - "addresses": { - "list": true, - "type": "JsonAddress", - "version": "v0" - }, - "groupIds": { - "list": true, - "type": "String" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonReadMessage": { - "fields": { - "sender": { - "type": "JsonAddress", - "version": "v0" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonViewOnceOpenMessage": { - "fields": { - "sender": { - "type": "JsonAddress", - "version": "v0" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonVerifiedMessage": { - "fields": { - "destination": { - "type": "JsonAddress", - "version": "v0" - }, - "identityKey": { - "type": "String" - }, - "verified": { - "type": "String" - }, - "timestamp": { - "type": "long" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "ConfigurationMessage": { - "fields": { - "readReceipts": { - "type": "Optional", - "version": "v0" - }, - "unidentifiedDeliveryIndicators": { - "type": "Optional", - "version": "v0" - }, - "typingIndicators": { - "type": "Optional", - "version": "v0" - }, - "linkPreviews": { - "type": "Optional", - "version": "v0" - } - } - }, - "JsonStickerPackOperationMessage": { - "fields": { - "packID": { - "type": "String" - }, - "packKey": { - "type": "String" - }, - "type": { - "type": "String" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "JsonMessageRequestResponseMessage": { - "fields": { - "person": { - "type": "JsonAddress", - "version": "v0" - }, - "groupId": { - "type": "String" - }, - "type": { - "type": "String" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "OfferMessage": { - "fields": { - "id": { - "type": "long" - }, - "sdp": { - "type": "String" - }, - "type": { - "type": "Type", - "version": "v0" - }, - "opaque": { - "type": "String" - } - } - }, - "AnswerMessage": { - "fields": { - "id": { - "type": "long" - }, - "sdp": { - "type": "String" - }, - "opaque": { - "type": "String" - } - } - }, - "BusyMessage": { - "fields": { - "id": { - "type": "long" - } - } - }, - "HangupMessage": { - "fields": { - "id": { - "type": "long" - }, - "type": { - "type": "Type", - "version": "v0" - }, - "deviceId": { - "type": "int" - }, - "legacy": { - "type": "boolean" - } - } - }, - "IceUpdateMessage": { - "fields": { - "id": { - "type": "long" - }, - "opaque": { - "type": "String" - }, - "sdp": { - "type": "String" - } - } - }, - "JsonQuotedAttachment": { - "fields": { - "contentType": { - "type": "String" - }, - "fileName": { - "type": "String" - }, - "thumbnail": { - "type": "JsonAttachment", - "version": "v0" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "GroupAccessControl": { - "fields": { - "link": { - "type": "String", - "doc": "UNSATISFIABLE when the group link is disabled, ADMINISTRATOR when the group link is enabled but an administrator must approve new members, ANY when the group link is enabled and no approval is required", - "example": "\"ANY\"" - }, - "attributes": { - "type": "String", - "doc": "who can edit group info" - }, - "members": { - "type": "String", - "doc": "who can add members" - } - }, - "doc": "group access control settings. Options for each controlled action are: UNKNOWN, ANY, MEMBER, ADMINISTRATOR, UNSATISFIABLE and UNRECOGNIZED", - "deprecated": true, - "removal_date": 1641027661 - }, - "GroupMember": { - "fields": { - "uuid": { - "type": "String", - "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" - }, - "role": { - "type": "String", - "doc": "possible values are: UNKNOWN, DEFAULT, ADMINISTRATOR and UNRECOGNIZED", - "example": "\"DEFAULT\"" - }, - "joined_revision": { - "type": "int" - } - }, - "deprecated": true, - "removal_date": 1641027661 - }, - "Name": { - "fields": { - "display": { - "type": "Optional", - "version": "v0" - }, - "given": { - "type": "Optional", - "version": "v0" - }, - "family": { - "type": "Optional", - "version": "v0" - }, - "prefix": { - "type": "Optional", - "version": "v0" - }, - "suffix": { - "type": "Optional", - "version": "v0" - }, - "middle": { - "type": "Optional", - "version": "v0" - } - } - }, - "Optional": { - "fields": { - "empty": { - "type": "boolean" - }, - "present": { - "type": "boolean" - } - } - }, - "Type": { - "fields": {} - } - }, - "v1": { - "ClientMessageWrapper": { - "fields": { - "type": { - "type": "String", - "doc": "the type of object to expect in the `data` field" - }, - "version": { - "type": "String", - "doc": "the version of the object in the `data` field" - }, - "data": { - "type": "Object", - "doc": "the incoming object. The structure will vary from message to message, see `type` and `version` fields" - }, - "error": { - "type": "Boolean", - "doc": "true if the incoming message represents an error" - }, - "account": { - "type": "String", - "doc": "the account this message is from" - } - }, - "doc": "Wraps all incoming messages sent to the client after a v1 subscribe request is issued" - }, - "ProtocolInvalidMessageError": { - "fields": { - "sender": { - "type": "String" - }, - "timestamp": { - "type": "long" - }, - "message": { - "type": "String" - }, - "sender_device": { - "type": "int" - }, - "content_hint": { - "type": "int" - }, - "group_id": { - "type": "String" - } - }, - "error": true - }, - "UntrustedIdentityError": { - "fields": { - "identifier": { - "type": "String" - }, - "message": { - "type": "String" - }, - "identity_key": { - "type": "IdentityKey", - "version": "v1" - } - }, - "error": true - }, - "ProtocolNoSessionError": { - "fields": { - "sender": { - "type": "String" - }, - "timestamp": { - "type": "long" - }, - "message": { - "type": "String" - }, - "sender_device": { - "type": "int" - }, - "content_hint": { - "type": "int" - }, - "group_id": { - "type": "String" - } - }, - "error": true - }, - "ProtocolInvalidKeyIdError": { - "fields": { - "sender": { - "type": "String" - }, - "timestamp": { - "type": "long" - }, - "message": { - "type": "String" - }, - "sender_device": { - "type": "int" - }, - "content_hint": { - "type": "int" - }, - "group_id": { - "type": "String" - } - }, - "error": true - }, - "DuplicateMessageError": { - "fields": { - "timestamp": { - "type": "long" - }, - "message": { - "type": "String" - } - }, - "error": true - }, - "IncomingMessage": { - "fields": { - "account": { - "type": "String", - "example": "\"+12024561414\"" - }, - "source": { - "type": "JsonAddress", - "version": "v1" - }, - "type": { - "type": "String" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - }, - "source_device": { - "type": "int" - }, - "server_receiver_timestamp": { - "type": "long", - "example": "1615576442475" - }, - "server_deliver_timestamp": { - "type": "long", - "example": "1615576442475" - }, - "has_legacy_message": { - "type": "boolean" - }, - "has_content": { - "type": "boolean" - }, - "unidentified_sender": { - "type": "boolean" - }, - "data_message": { - "type": "JsonDataMessage", - "version": "v1" - }, - "sync_message": { - "type": "JsonSyncMessage", - "version": "v1" - }, - "call_message": { - "type": "CallMessage", - "version": "v1" - }, - "receipt_message": { - "type": "ReceiptMessage", - "version": "v1" - }, - "typing_message": { - "type": "TypingMessage", - "version": "v1" - }, - "story_message": { - "type": "StoryMessage", - "version": "v1" - }, - "server_guid": { - "type": "String" - } - } - }, - "ListenerState": { - "fields": { - "connected": { - "type": "boolean" - } - }, - "doc": "prior attempt to indicate signald connectivity state. WebSocketConnectionState messages will be delivered at the same time as well as in other parts of the websocket lifecycle." - }, - "WebSocketConnectionState": { - "fields": { - "state": { - "type": "String", - "doc": "One of: DISCONNECTED, CONNECTING, CONNECTED, RECONNECTING, DISCONNECTING, AUTHENTICATION_FAILED, FAILED" - }, - "socket": { - "type": "String", - "doc": "One of: UNIDENTIFIED, IDENTIFIED" - } - }, - "doc": "indicates when the websocket connection state to the signal server has changed" - }, - "StorageChange": { - "fields": { - "version": { - "type": "long", - "doc": "Seems to behave like the group version numbers and increments every time the state changes" - } - }, - "doc": "Broadcast to subscribed clients when there is a state change from the storage service" - }, - "SendRequest": { - "fields": { - "username": { - "type": "String", - "example": "\"+12024561414\"" - }, - "account": { - "type": "String", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"" - }, - "recipientAddress": { - "type": "JsonAddress", - "version": "v1" - }, - "recipientGroupId": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"" - }, - "messageBody": { - "type": "String", - "example": "\"hello\"" - }, - "attachments": { - "list": true, - "type": "JsonAttachment", - "version": "v1" - }, - "quote": { - "type": "JsonQuote", - "version": "v1" - }, - "timestamp": { - "type": "Long" - }, - "mentions": { - "list": true, - "type": "JsonMention", - "version": "v1" - }, - "previews": { - "list": true, - "type": "JsonPreview", - "version": "v1" - }, - "members": { - "list": true, - "type": "JsonAddress", - "version": "v1", - "doc": "Optionally set to a sub-set of group members. Ignored if recipientGroupId isn't specified" - } - } - }, - "SendResponse": { - "fields": { - "results": { - "list": true, - "type": "JsonSendMessageResult", - "version": "v1" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - } - } - }, - "NoSuchAccountError": { - "fields": { - "account": { - "type": "String" - }, - "message": { - "type": "String" - } - }, - "error": true - }, - "ServerNotFoundError": { - "fields": { - "uuid": { - "type": "String" - }, - "message": { - "type": "String" - } - }, - "error": true - }, - "InvalidProxyError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "NoSendPermissionError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "InvalidAttachmentError": { - "fields": { - "filename": { - "type": "String" - }, - "message": { - "type": "String" - } - }, - "error": true - }, - "InternalError": { - "fields": { - "exceptions": { - "list": true, - "type": "String" - }, - "message": { - "type": "String" - } - }, - "doc": "an internal error in signald has occurred. typically these are things that \"should never happen\" such as issues saving to the local disk, but it is also the default error type and may catch some things that should have their own error type. If you find tht your code is depending on the exception list for any particular behavior, please file an issue so we can pull those errors out to a separate error type: https://gitlab.com/signald/signald/-/issues/new", - "error": true - }, - "InvalidRequestError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "UnknownGroupError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "RateLimitError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "InvalidRecipientError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "AttachmentTooLargeError": { - "fields": { - "filename": { - "type": "String" - }, - "message": { - "type": "String" - } - }, - "error": true - }, - "AuthorizationFailedError": { - "fields": { - "message": { - "type": "String" - } - }, - "doc": "Indicates the server rejected our credentials or a failed group update. Typically means the linked device was removed by the primary device, or that the account was re-registered. For group updates, this can indicate that we lack permissions.", - "error": true - }, - "SQLError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "ReactRequest": { - "fields": { - "username": { - "type": "String", - "example": "\"+12024561414\"", - "required": true - }, - "recipientAddress": { - "type": "JsonAddress", - "version": "v1" - }, - "recipientGroupId": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"" - }, - "reaction": { - "type": "JsonReaction", - "version": "v1", - "required": true - }, - "timestamp": { - "type": "long" - }, - "members": { - "list": true, - "type": "JsonAddress", - "version": "v1", - "doc": "Optionally set to a sub-set of group members. Ignored if recipientGroupId isn't specified" - } - }, - "doc": "react to a previous message" - }, - "UnregisteredUserError": { - "fields": { - "message": { - "type": "String" - }, - "e164_number": { - "type": "String" - } - }, - "error": true - }, - "VersionRequest": { - "fields": {} - }, - "JsonVersionMessage": { - "fields": { - "name": { - "type": "String", - "example": "\"signald\"" - }, - "version": { - "type": "String", - "example": "\"0.18.3\"" - }, - "branch": { - "type": "String", - "example": "\"main\"" - }, - "commit": { - "type": "String", - "example": "\"2d898baa70a20c44ae918d2ce6e1f108579ee271\"" - } - } - }, - "AcceptInvitationRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "groupID": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", - "required": true - } - }, - "doc": "Accept a v2 group invitation. Note that you must have a profile name set to join groups." - }, - "JsonGroupV2Info": { - "fields": { - "id": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"" - }, - "revision": { - "type": "int", - "example": "5" - }, - "title": { - "type": "String", - "example": "\"Parkdale Run Club\"" - }, - "description": { - "type": "String" - }, - "avatar": { - "type": "String", - "doc": "path to the group's avatar on local disk, if available", - "example": "\"/var/lib/signald/avatars/group-EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"" - }, - "timer": { - "type": "int", - "example": "604800" - }, - "members": { - "list": true, - "type": "JsonAddress", - "version": "v1" - }, - "pendingMembers": { - "list": true, - "type": "JsonAddress", - "version": "v1" - }, - "requestingMembers": { - "list": true, - "type": "JsonAddress", - "version": "v1" - }, - "inviteLink": { - "type": "String", - "doc": "the signal.group link, if applicable" - }, - "accessControl": { - "type": "GroupAccessControl", - "version": "v1", - "doc": "current access control settings for this group" - }, - "memberDetail": { - "list": true, - "type": "GroupMember", - "version": "v1", - "doc": "detailed member list" - }, - "pendingMemberDetail": { - "list": true, - "type": "GroupMember", - "version": "v1", - "doc": "detailed pending member list" - }, - "announcements": { - "type": "String", - "doc": "indicates if the group is an announcements group. Only admins are allowed to send messages to announcements groups. Options are UNKNOWN, ENABLED or DISABLED" - }, - "removed": { - "type": "boolean", - "doc": "will be set to true for incoming messages to indicate the user has been removed from the group" - }, - "banned_members": { - "list": true, - "type": "BannedGroupMember", - "version": "v1" - }, - "group_change": { - "type": "GroupChange", - "version": "v1", - "doc": "Represents a peer-to-peer group change done by a user. Will not be set if the group change signature fails verification. This is usually only set inside of incoming messages." - } - }, - "doc": "Information about a Signal group" - }, - "OwnProfileKeyDoesNotExistError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "GroupPatchNotAcceptedError": { - "fields": { - "message": { - "type": "String" - } - }, - "doc": "Indicates the server rejected our group update. This can be due to errors such as trying to add a user that's already in the group.", - "error": true - }, - "ApproveMembershipRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "groupID": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", - "required": true - }, - "members": { - "list": true, - "type": "JsonAddress", - "version": "v1", - "doc": "list of requesting members to approve", - "required": true - } - }, - "doc": "approve a request to join a group" - }, - "GroupVerificationError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "GetGroupRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "groupID": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", - "required": true - }, - "revision": { - "type": "int", - "doc": "the latest known revision, default value (-1) forces fetch from server" - } - }, - "doc": "Query the server for the latest state of a known group. If the account is not a member of the group, an UnknownGroupError is returned." - }, - "InvalidGroupStateError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "GetLinkedDevicesRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - } - }, - "doc": "list all linked devices on a Signal account" - }, - "LinkedDevices": { - "fields": { - "devices": { - "list": true, - "type": "DeviceInfo", - "version": "v1" - } - } - }, - "JoinGroupRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "uri": { - "type": "String", - "doc": "The signal.group URL", - "example": "\"https://signal.group/#CjQKINH_GZhXhfifTcnBkaKTNRxW-hHKnGSq-cJNyPVqHRp8EhDUB7zjKNEl0NaULhsqJCX3\"", - "required": true - } - }, - "doc": "Join a group using the a signal.group URL. Note that you must have a profile name set to join groups." - }, - "JsonGroupJoinInfo": { - "fields": { - "groupID": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"" - }, - "title": { - "type": "String", - "example": "\"Parkdale Run Club\"" - }, - "description": { - "type": "String", - "example": "\"A club for running in Parkdale\"" - }, - "memberCount": { - "type": "int", - "example": "3" - }, - "addFromInviteLink": { - "type": "int", - "doc": "The access level required in order to join the group from the invite link, as an AccessControl.AccessRequired enum from the upstream Signal groups.proto file. This is UNSATISFIABLE (4) when the group link is disabled; ADMINISTRATOR (3) when the group link is enabled, but an administrator must approve new members; and ANY (1) when the group link is enabled and no approval is required. See theGroupAccessControl structure and the upstream enum ordinals." - }, - "revision": { - "type": "int", - "doc": "The Group V2 revision. This is incremented by clients whenever they update group information, and it is often used by clients to determine if the local group state is out-of-date with the server's revision.", - "example": "5" - }, - "pendingAdminApproval": { - "type": "boolean", - "doc": "Whether the account is waiting for admin approval in order to be added to the group." - } - } - }, - "InvalidInviteURIError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "GroupNotActiveError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "RemoveLinkedDeviceRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"+12024561414\"", - "required": true - }, - "deviceId": { - "type": "long", - "doc": "the ID of the device to unlink", - "example": "3", - "required": true - } - }, - "doc": "Remove a linked device from the Signal account. Only allowed when the local device id is 1" - }, - "UpdateGroupRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The identifier of the account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "groupID": { - "type": "String", - "doc": "the ID of the group to update", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", - "required": true - }, - "title": { - "type": "String", - "example": "\"Parkdale Run Club\"" - }, - "description": { - "type": "String", - "doc": "A new group description. Set to empty string to remove an existing description.", - "example": "\"A club for running in Parkdale\"" - }, - "avatar": { - "type": "String", - "example": "\"/tmp/image.jpg\"" - }, - "updateTimer": { - "type": "int", - "doc": "update the group timer." - }, - "addMembers": { - "list": true, - "type": "JsonAddress", - "version": "v1" - }, - "removeMembers": { - "list": true, - "type": "JsonAddress", - "version": "v1" - }, - "updateRole": { - "type": "GroupMember", - "version": "v1" - }, - "updateAccessControl": { - "type": "GroupAccessControl", - "version": "v1", - "doc": "note that only one of the access controls may be updated per request" - }, - "resetLink": { - "type": "boolean", - "doc": "regenerate the group link password, invalidating the old one" - }, - "announcements": { - "type": "String", - "doc": "ENABLED to only allow admins to post messages, DISABLED to allow anyone to post" - } - }, - "doc": "modify a group. Note that only one modification action may be performed at once" - }, - "GroupInfo": { - "fields": { - "v1": { - "type": "JsonGroupInfo", - "version": "v1" - }, - "v2": { - "type": "JsonGroupV2Info", - "version": "v1" - } - }, - "doc": "A generic type that is used when the group version is not known" - }, - "SetProfile": { - "fields": { - "account": { - "type": "String", - "doc": "The phone number of the account to use", - "example": "\"+12024561414\"", - "required": true - }, - "name": { - "type": "String", - "doc": "Change the profile name", - "example": "\"signald user\"" - }, - "avatarFile": { - "type": "String", - "doc": "Path to new profile avatar file. If unset or null, unset the profile avatar", - "example": "\"/tmp/image.jpg\"" - }, - "about": { - "type": "String", - "doc": "Change the 'about' profile field" - }, - "emoji": { - "type": "String", - "doc": "Change the profile emoji" - }, - "mobilecoin_address": { - "type": "String", - "doc": "Change the profile payment address. Payment address must be a *base64-encoded* MobileCoin address. Note that this is not the traditional MobileCoin address encoding, which is custom. Clients are responsible for converting between MobileCoin's custom base58 on the user-facing side and base64 encoding on the signald side." - }, - "visible_badge_ids": { - "list": true, - "type": "String", - "doc": "configure visible badge IDs" - } - } - }, - "InvalidBase64Error": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "ResolveAddressRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The signal account to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "partial": { - "type": "JsonAddress", - "version": "v1", - "doc": "The partial address, missing fields", - "required": true - } - }, - "doc": "Resolve a partial JsonAddress with only a number or UUID to one with both. Anywhere that signald accepts a JsonAddress will except a partial, this is a convenience function for client authors, mostly because signald doesn't resolve all the partials it returns." - }, - "JsonAddress": { - "fields": { - "number": { - "type": "String", - "doc": "An e164 phone number, starting with +. Currently the only available user-facing Signal identifier.", - "example": "\"+13215551234\"" - }, - "uuid": { - "type": "UUID", - "doc": "A UUID, the unique identifier for a particular Signal account." - }, - "relay": { - "type": "String" - } - } - }, - "MarkReadRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "to": { - "type": "JsonAddress", - "version": "v1", - "doc": "The address that sent the message being marked as read", - "required": true - }, - "timestamps": { - "list": true, - "type": "Long", - "doc": "List of messages to mark as read", - "example": "1615576442475", - "required": true - }, - "when": { - "type": "Long" - } - } - }, - "GetProfileRequest": { - "fields": { - "account": { - "type": "String", - "doc": "the signald account to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "async": { - "type": "boolean", - "doc": "if true, return results from local store immediately, refreshing from server in the background if needed. if false (default), block until profile can be retrieved from server" - }, - "address": { - "type": "JsonAddress", - "version": "v1", - "doc": "the address to look up", - "required": true - } - }, - "doc": "Get all information available about a user" - }, - "Profile": { - "fields": { - "name": { - "type": "String", - "doc": "The user's name from local contact names if available, or if not in contact list their Signal profile name" - }, - "avatar": { - "type": "String", - "doc": "path to avatar on local disk" - }, - "address": { - "type": "JsonAddress", - "version": "v1" - }, - "capabilities": { - "type": "Capabilities", - "version": "v1" - }, - "color": { - "type": "String", - "doc": "color of the chat with this user" - }, - "about": { - "type": "String" - }, - "emoji": { - "type": "String" - }, - "profile_name": { - "type": "String", - "doc": "The user's Signal profile name" - }, - "inbox_position": { - "type": "Integer" - }, - "expiration_time": { - "type": "int" - }, - "mobilecoin_address": { - "type": "String", - "doc": "*base64-encoded* mobilecoin address. Note that this is not the traditional MobileCoin address encoding. Clients are responsible for converting between MobileCoin's custom base58 on the user-facing side and base64 encoding on the signald side. If unset, null or an empty string, will empty the profile payment address" - }, - "visible_badge_ids": { - "list": true, - "type": "String", - "doc": "currently unclear how these work, as they are not available in the production Signal apps" - } - }, - "doc": "Information about a Signal user" - }, - "ProfileUnavailableError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "ListGroupsRequest": { - "fields": { - "account": { - "type": "String", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - } - } - }, - "GroupList": { - "fields": { - "groups": { - "list": true, - "type": "JsonGroupV2Info", - "version": "v1" - }, - "legacyGroups": { - "list": true, - "type": "JsonGroupInfo", - "version": "v1" - } - } - }, - "ListContactsRequest": { - "fields": { - "account": { - "type": "String", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "async": { - "type": "boolean", - "doc": "return results from local store immediately, refreshing from server afterward if needed. If false (default), block until all pending profiles have been retrieved." - } - } - }, - "ProfileList": { - "fields": { - "profiles": { - "list": true, - "type": "Profile", - "version": "v1" - } - } - }, - "CreateGroupRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "title": { - "type": "String", - "example": "\"Parkdale Run Club\"", - "required": true - }, - "avatar": { - "type": "String", - "example": "\"/tmp/image.jpg\"" - }, - "members": { - "list": true, - "type": "JsonAddress", - "version": "v1", - "required": true - }, - "timer": { - "type": "int", - "doc": "the message expiration timer" - }, - "member_role": { - "type": "String", - "doc": "The role of all members other than the group creator. Options are ADMINISTRATOR or DEFAULT (case insensitive)", - "example": "\"ADMINISTRATOR\"" - } - } - }, - "NoKnownUUIDError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "LeaveGroupRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "groupID": { - "type": "String", - "doc": "The group to leave", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", - "required": true - } - } - }, - "GenerateLinkingURIRequest": { - "fields": { - "server": { - "type": "String", - "doc": "The identifier of the server to use. Leave blank for default (usually Signal production servers but configurable at build time)" - } - }, - "doc": "Generate a linking URI. Typically this is QR encoded and scanned by the primary device. Submit the returned session_id with a finish_link request." - }, - "LinkingURI": { - "fields": { - "uri": { - "type": "String" - }, - "session_id": { - "type": "String" - } - } - }, - "FinishLinkRequest": { - "fields": { - "overwrite": { - "type": "boolean", - "doc": "overwrite existing account data if the phone number conflicts. false by default" - }, - "device_name": { - "type": "String" - }, - "session_id": { - "type": "String" - } - }, - "doc": "After a linking URI has been requested, finish_link must be called with the session_id provided with the URI. it will return information about the new account once the linking process is completed by the other device and the new account is setup. Note that the account setup process can sometimes take some time, if rapid userfeedback is required after scanning, use wait_for_scan first, then finish setup with finish_link." - }, - "Account": { - "fields": { - "address": { - "type": "JsonAddress", - "version": "v1", - "doc": "The address of this account" - }, - "pending": { - "type": "Boolean", - "doc": "indicates the account has not completed registration" - }, - "pni": { - "type": "String" - }, - "device_id": { - "type": "int", - "doc": "The Signal device ID. Official Signal mobile clients (iPhone and Android) have device ID = 1, while linked devices such as Signal Desktop or Signal iPad have higher device IDs." - }, - "account_id": { - "type": "String", - "doc": "The primary identifier on the account, included with all requests to signald for this account. Previously called 'username'" - } - }, - "doc": "A local account in signald" - }, - "NoSuchSessionError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "UserAlreadyExistsError": { - "fields": { - "uuid": { - "type": "UUID" - }, - "message": { - "type": "String" - } - }, - "error": true - }, - "ScanTimeoutError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "AddLinkedDeviceRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "uri": { - "type": "String", - "doc": "the sgnl://linkdevice uri provided (typically in qr code form) by the new device", - "example": "\"sgnl://linkdevice?uuid=jAaZ5lxLfh7zVw5WELd6-Q&pub_key=BfFbjSwmAgpVJBXUdfmSgf61eX3a%2Bq9AoxAVpl1HUap9\"", - "required": true - } - }, - "doc": "Link a new device to a local Signal account" - }, - "RegisterRequest": { - "fields": { - "account": { - "type": "String", - "doc": "the e164 phone number to register with", - "example": "\"+12024561414\"", - "required": true - }, - "voice": { - "type": "boolean", - "doc": "set to true to request a voice call instead of an SMS for verification" - }, - "captcha": { - "type": "String", - "doc": "See https://signald.org/articles/captcha/" - }, - "server": { - "type": "String", - "doc": "The identifier of the server to use. Leave blank for default (usually Signal production servers but configurable at build time)" - } - }, - "doc": "begin the account registration process by requesting a phone number verification code. when the code is received, submit it with a verify request" - }, - "CaptchaRequiredError": { - "fields": { - "more": { - "type": "String" - }, - "message": { - "type": "String" - } - }, - "error": true - }, - "VerifyRequest": { - "fields": { - "account": { - "type": "String", - "doc": "the e164 phone number being verified", - "example": "\"+12024561414\"", - "required": true - }, - "code": { - "type": "String", - "doc": "the verification code, dash (-) optional", - "example": "\"555555\"", - "required": true - } - }, - "doc": "verify an account's phone number with a code after registering, completing the account creation process" - }, - "AccountHasNoKeysError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "AccountAlreadyVerifiedError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "AccountLockedError": { - "fields": { - "more": { - "type": "String" - }, - "message": { - "type": "String" - } - }, - "error": true - }, - "GetIdentitiesRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "address": { - "type": "JsonAddress", - "version": "v1", - "doc": "address to get keys for", - "required": true - } - }, - "doc": "Get information about a known keys for a particular address" - }, - "IdentityKeyList": { - "fields": { - "address": { - "type": "JsonAddress", - "version": "v1" - }, - "identities": { - "list": true, - "type": "IdentityKey", - "version": "v1" - } - }, - "doc": "a list of identity keys associated with a particular address" - }, - "TrustRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "address": { - "type": "JsonAddress", - "version": "v1", - "doc": "The user to query identity keys for", - "required": true - }, - "safety_number": { - "type": "String", - "doc": "required if qr_code_data is absent", - "example": "\"373453558586758076680580548714989751943247272727416091564451\"" - }, - "qr_code_data": { - "type": "String", - "doc": "base64-encoded QR code data. required if safety_number is absent" - }, - "trust_level": { - "type": "String", - "doc": "One of TRUSTED_UNVERIFIED, TRUSTED_VERIFIED or UNTRUSTED. Default is TRUSTED_VERIFIED", - "example": "\"TRUSTED_VERIFIED\"" - } - }, - "doc": "Trust another user's safety number using either the QR code data or the safety number text" - }, - "FingerprintVersionMismatchError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "UnknownIdentityKeyError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "InvalidFingerprintError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "DeleteAccountRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to delete", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "server": { - "type": "boolean", - "doc": "delete account information from the server as well (default false)" - } - }, - "doc": "delete all account data signald has on disk, and optionally delete the account from the server as well. Note that this is not \"unlink\" and will delete the entire account, even from a linked device." - }, - "TypingRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "address": { - "type": "JsonAddress", - "version": "v1" - }, - "group": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"" - }, - "typing": { - "type": "boolean", - "example": "true", - "required": true - }, - "when": { - "type": "long" - } - }, - "doc": "send a typing started or stopped message" - }, - "InvalidGroupError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "ResetSessionRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "address": { - "type": "JsonAddress", - "version": "v1", - "doc": "the user to reset session with", - "required": true - }, - "timestamp": { - "type": "Long" - } - }, - "doc": "reset a session with a particular user" - }, - "RequestSyncRequest": { - "fields": { - "groups": { - "type": "boolean", - "doc": "request group sync (default true)" - }, - "configuration": { - "type": "boolean", - "doc": "request configuration sync (default true)" - }, - "contacts": { - "type": "boolean", - "doc": "request contact sync (default true)" - }, - "blocked": { - "type": "boolean", - "doc": "request block list sync (default true)" - }, - "keys": { - "type": "boolean", - "doc": "request storage service keys" - }, - "account": { - "type": "String", - "doc": "The account to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - } - }, - "doc": "Request other devices on the account send us their group list, syncable config and contact list." - }, - "ListAccountsRequest": { - "fields": {}, - "doc": "return all local accounts" - }, - "AccountList": { - "fields": { - "accounts": { - "list": true, - "type": "Account", - "version": "v1" - } - } - }, - "GroupLinkInfoRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "uri": { - "type": "String", - "doc": "the signald.group link", - "example": "\"https://signal.group/#CjQKINH_GZhXhfifTcnBkaKTNRxW-hHKnGSq-cJNyPVqHRp8EhDUB7zjKNEl0NaULhsqJCX3\"", - "required": true - } - }, - "doc": "Get information about a group from a signal.group link" - }, - "GroupLinkNotActiveError": { - "fields": { - "message": { - "type": "String" - } - }, - "error": true - }, - "UpdateContactRequest": { - "fields": { - "account": { - "type": "String", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "address": { - "type": "JsonAddress", - "version": "v1", - "required": true - }, - "name": { - "type": "String" - }, - "color": { - "type": "String" - }, - "inbox_position": { - "type": "Integer" - } - }, - "doc": "update information about a local contact" - }, - "SetExpirationRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "address": { - "type": "JsonAddress", - "version": "v1" - }, - "group": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"" - }, - "expiration": { - "type": "int", - "example": "604800", - "required": true - } - }, - "doc": "Set the message expiration timer for a thread. Expiration must be specified in seconds, set to 0 to disable timer" - }, - "SetDeviceNameRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to set the device name of", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "device_name": { - "type": "String", - "doc": "The device name" - } - }, - "doc": "set this device's name. This will show up on the mobile device on the same account under settings -> linked devices" - }, - "GetAllIdentities": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"+12024561414\"", - "required": true - } - }, - "doc": "get all known identity keys" - }, - "AllIdentityKeyList": { - "fields": { - "identity_keys": { - "list": true, - "type": "IdentityKeyList", - "version": "v1" - } - } - }, - "SubscribeRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to subscribe to incoming message for", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - } - }, - "doc": "receive incoming messages. After making a subscribe request, incoming messages will be sent to the client encoded as ClientMessageWrapper. Send an unsubscribe request or disconnect from the socket to stop receiving messages." - }, - "UnsubscribeRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to unsubscribe from", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - } - }, - "doc": "See subscribe for more info" - }, - "RemoteDeleteRequest": { - "fields": { - "account": { - "type": "String", - "doc": "the account to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "address": { - "type": "JsonAddress", - "version": "v1", - "doc": "the address to send the delete message to. should match address the message to be deleted was sent to. required if group is not set." - }, - "group": { - "type": "String", - "doc": "the group to send the delete message to. should match group the message to be deleted was sent to. required if address is not set.", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"" - }, - "timestamp": { - "type": "long", - "required": true - }, - "members": { - "list": true, - "type": "JsonAddress", - "version": "v1", - "doc": "Optionally set to a sub-set of group members. Ignored if group isn't specified" - } - }, - "doc": "delete a message previously sent" - }, - "AddServerRequest": { - "fields": { - "server": { - "type": "Server", - "version": "v1", - "required": true - } - }, - "doc": "add a new server to connect to. Returns the new server's UUID." - }, - "GetServersRequest": { - "fields": {} - }, - "ServerList": { - "fields": { - "servers": { - "list": true, - "type": "Server", - "version": "v1" - } - } - }, - "RemoveServerRequest": { - "fields": { - "uuid": { - "type": "String" - } - } - }, - "SendPaymentRequest": { - "fields": { - "account": { - "type": "String", - "doc": "the account to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "address": { - "type": "JsonAddress", - "version": "v1", - "doc": "the address to send the payment message to", - "required": true - }, - "payment": { - "type": "Payment", - "version": "v1", - "required": true - }, - "when": { - "type": "Long" - } - }, - "doc": "send a mobilecoin payment" - }, - "RemoteConfigRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to use to retrieve the remote config", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - } - }, - "doc": "Retrieves the remote config (feature flags) from the server." - }, - "RemoteConfigList": { - "fields": { - "config": { - "list": true, - "type": "RemoteConfig", - "version": "v1" - } - } - }, - "RefuseMembershipRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "members": { - "list": true, - "type": "JsonAddress", - "version": "v1", - "doc": "list of requesting members to refuse", - "required": true - }, - "group_id": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", - "required": true - }, - "also_ban": { - "type": "boolean" - } - }, - "doc": "deny a request to join a group" - }, - "SubmitChallengeRequest": { - "fields": { - "account": { - "type": "String", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "challenge": { - "type": "String", - "required": true - }, - "captcha_token": { - "type": "String" - } - } - }, - "IsIdentifierRegisteredRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to use to use", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "identifier": { - "type": "String", - "doc": "The UUID of an identifier to check if it is registered on Signal. This UUID is either a Phone Number Identity (PNI) or an Account Identity (ACI).", - "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"", - "required": true - } - }, - "doc": "Determine whether an account identifier is registered on the Signal service." - }, - "BooleanMessage": { - "fields": { - "value": { - "type": "boolean" - } - }, - "doc": "A message containing a single boolean, usually as a response" - }, - "WaitForScanRequest": { - "fields": { - "session_id": { - "type": "String" - } - }, - "doc": "An optional part of the linking process. Intended to be called after displaying the QR code, will return quickly after the user scans the QR code. finish_link must be called after wait_for_scan returns a non-error" - }, - "GetGroupRevisionPagesRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "group_id": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", - "required": true - }, - "from_revision": { - "type": "int", - "doc": "The revision to start the pages from. Note that if this is lower than the revision you joined the group, an AuthorizationFailedError is returned.", - "required": true - }, - "include_first_revision": { - "type": "boolean", - "doc": "Whether to include the first state in the returned pages (default false)" - } - }, - "doc": "Query the server for group revision history. The history contains information about the changes between each revision and the user that made the change." - }, - "GroupHistoryPage": { - "fields": { - "results": { - "list": true, - "type": "GroupHistoryEntry", - "version": "v1" - }, - "paging_data": { - "type": "PagingData", - "version": "v1" - } - }, - "doc": "The result of fetching a group's history along with paging data." - }, - "SendSyncMessageRequest": { - "fields": { - "account": { - "type": "String", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "view_once_open_message": { - "type": "JsonViewOnceOpenMessage", - "version": "v1", - "doc": "This can be set to indicate to other devices about having viewed a view-once message." - }, - "message_request_response": { - "type": "JsonMessageRequestResponseMessage", - "version": "v1", - "doc": "This can be set to indicate to other devices about a response to an incoming message request from an unknown user or group. Warning: Using the BLOCK and BLOCK_AND_DELETE options relies on other devices to do the blocking, and it does not make you leave the group!" - } - }, - "doc": "Sends a sync message to the account's devices" - }, - "JsonSendMessageResult": { - "fields": { - "address": { - "type": "JsonAddress", - "version": "v1" - }, - "success": { - "type": "SendSuccess", - "version": "v1" - }, - "networkFailure": { - "type": "boolean", - "example": "false" - }, - "unregisteredFailure": { - "type": "boolean", - "example": "false" - }, - "identityFailure": { - "type": "String" - }, - "proof_required_failure": { - "type": "ProofRequiredError", - "version": "v1" - } - } - }, - "BanUserRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "group_id": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", - "required": true - }, - "users": { - "list": true, - "type": "JsonAddress", - "version": "v1", - "doc": "List of users to ban", - "required": true - } - }, - "doc": "Bans users from a group. This works even if the users aren't in the group. If they are currently in the group, they will also be removed." - }, - "UnbanUserRequest": { - "fields": { - "account": { - "type": "String", - "doc": "The account to interact with", - "example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"", - "required": true - }, - "group_id": { - "type": "String", - "example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"", - "required": true - }, - "users": { - "list": true, - "type": "JsonAddress", - "version": "v1", - "doc": "List of users to unban", - "required": true - } - }, - "doc": "Unbans users from a group." - }, - "IdentityKey": { - "fields": { - "added": { - "type": "long", - "doc": "the first time this identity key was seen" - }, - "safety_number": { - "type": "String", - "example": "\"373453558586758076680580548714989751943247272727416091564451\"" - }, - "qr_code_data": { - "type": "String", - "doc": "base64-encoded QR code data" - }, - "trust_level": { - "type": "String", - "doc": "One of TRUSTED_UNVERIFIED, TRUSTED_VERIFIED or UNTRUSTED" - } - } - }, - "JsonDataMessage": { - "fields": { - "timestamp": { - "type": "long", - "doc": "the timestamp that the message was sent at, according to the sender's device. This is used to uniquely identify this message for things like reactions and quotes.", - "example": "1615576442475" - }, - "attachments": { - "list": true, - "type": "JsonAttachment", - "version": "v1", - "doc": "files attached to the incoming message" - }, - "body": { - "type": "String", - "doc": "the text body of the incoming message.", - "example": "\"hello\"" - }, - "group": { - "type": "JsonGroupInfo", - "version": "v1", - "doc": "if the incoming message was sent to a v1 group, information about that group will be here" - }, - "groupV2": { - "type": "JsonGroupV2Info", - "version": "v1", - "doc": "if the incoming message was sent to a v2 group, basic identifying information about that group will be here. If group information changes, JsonGroupV2Info.revision is incremented. If the group revision is higher than previously seen, a client can retrieve the group information by calling get_group." - }, - "endSession": { - "type": "boolean" - }, - "expiresInSeconds": { - "type": "int", - "doc": "the expiry timer on the incoming message. Clients should delete records of the message within this number of seconds" - }, - "profileKeyUpdate": { - "type": "boolean" - }, - "quote": { - "type": "JsonQuote", - "version": "v1", - "doc": "if the incoming message is a quote or reply to another message, this will contain information about that message" - }, - "contacts": { - "list": true, - "type": "SharedContact", - "version": "v1", - "doc": "if the incoming message has a shared contact, the contact's information will be here" - }, - "previews": { - "list": true, - "type": "JsonPreview", - "version": "v1", - "doc": "if the incoming message has a link preview, information about that preview will be here" - }, - "sticker": { - "type": "JsonSticker", - "version": "v0", - "doc": "if the incoming message is a sticker, information about the sicker will be here" - }, - "viewOnce": { - "type": "boolean", - "doc": "indicates the message is a view once message. View once messages typically include no body and a single image attachment. Official Signal clients will prevent the user from saving the image, and once the user has viewed the image once they will destroy the image." - }, - "reaction": { - "type": "JsonReaction", - "version": "v1", - "doc": "if the message adds or removes a reaction to another message, this will indicate what change is being made" - }, - "remoteDelete": { - "type": "RemoteDelete", - "version": "v1", - "doc": "if the inbound message is deleting a previously sent message, indicates which message should be deleted" - }, - "mentions": { - "list": true, - "type": "JsonMention", - "version": "v1", - "doc": "list of mentions in the message" - }, - "payment": { - "type": "Payment", - "version": "v1", - "doc": "details about the MobileCoin payment attached to the message, if present" - }, - "is_expiration_update": { - "type": "boolean", - "doc": "whether or not this message changes the expiresInSeconds value for the whole chat. Some messages (remote deletes, reactions, etc) will have expiresInSeconds=0 even though the chat has disappearing messages enabled." - }, - "group_call_update": { - "type": "String", - "doc": "the eraId string from a group call message update" - }, - "story_context": { - "type": "StoryContext", - "version": "v1" - } - } - }, - "JsonSyncMessage": { - "fields": { - "sent": { - "type": "JsonSentTranscriptMessage", - "version": "v1" - }, - "contacts": { - "type": "JsonAttachment", - "version": "v1" - }, - "contactsComplete": { - "type": "boolean" - }, - "groups": { - "type": "JsonAttachment", - "version": "v1" - }, - "blockedList": { - "type": "JsonBlockedListMessage", - "version": "v1" - }, - "request": { - "type": "String" - }, - "readMessages": { - "list": true, - "type": "JsonReadMessage", - "version": "v1" - }, - "viewOnceOpen": { - "type": "JsonViewOnceOpenMessage", - "version": "v1" - }, - "verified": { - "type": "JsonVerifiedMessage", - "version": "v1" - }, - "configuration": { - "type": "ConfigurationMessage", - "version": "v0" - }, - "stickerPackOperations": { - "list": true, - "type": "JsonStickerPackOperationMessage", - "version": "v0" - }, - "fetchType": { - "type": "String" - }, - "messageRequestResponse": { - "type": "JsonMessageRequestResponseMessage", - "version": "v1" - } - } - }, - "CallMessage": { - "fields": { - "offer_message": { - "type": "OfferMessage", - "version": "v1" - }, - "answer_message": { - "type": "AnswerMessage", - "version": "v1" - }, - "busy_message": { - "type": "BusyMessage", - "version": "v1" - }, - "hangup_message": { - "type": "HangupMessage", - "version": "v1" - }, - "ice_update_message": { - "list": true, - "type": "IceUpdateMessage", - "version": "v1" - }, - "destination_device_id": { - "type": "Integer" - }, - "multi_ring": { - "type": "boolean" - } - } - }, - "ReceiptMessage": { - "fields": { - "type": { - "type": "String", - "doc": "options: UNKNOWN, DELIVERY, READ, VIEWED" - }, - "timestamps": { - "list": true, - "type": "Long" - }, - "when": { - "type": "long" - } - } - }, - "TypingMessage": { - "fields": { - "action": { - "type": "String" - }, - "timestamp": { - "type": "long" - }, - "group_id": { - "type": "String" - } - } - }, - "StoryMessage": { - "fields": { - "group": { - "type": "JsonGroupV2Info", - "version": "v1" - }, - "file": { - "type": "JsonAttachment", - "version": "v1" - }, - "text": { - "type": "TextAttachment", - "version": "v1" - }, - "allow_replies": { - "type": "Boolean" - } - } - }, - "JsonAttachment": { - "fields": { - "contentType": { - "type": "String" - }, - "id": { - "type": "String" - }, - "size": { - "type": "int" - }, - "storedFilename": { - "type": "String", - "doc": "when receiving, the path that file has been downloaded to" - }, - "filename": { - "type": "String", - "doc": "when sending, the path to the local file to upload" - }, - "customFilename": { - "type": "String", - "doc": "the original name of the file" - }, - "caption": { - "type": "String" - }, - "width": { - "type": "int" - }, - "height": { - "type": "int" - }, - "voiceNote": { - "type": "boolean" - }, - "key": { - "type": "String" - }, - "digest": { - "type": "String" - }, - "blurhash": { - "type": "String" - } - }, - "doc": "represents a file attached to a message. When sending, only `filename` is required." - }, - "JsonQuote": { - "fields": { - "id": { - "type": "long", - "doc": "the client timestamp of the message being quoted", - "example": "1615576442475" - }, - "author": { - "type": "JsonAddress", - "version": "v1", - "doc": "the author of the message being quoted" - }, - "text": { - "type": "String", - "doc": "the body of the message being quoted", - "example": "\"hey  what's up?\"" - }, - "attachments": { - "list": true, - "type": "JsonQuotedAttachment", - "version": "v0", - "doc": "list of files attached to the quoted message" - }, - "mentions": { - "list": true, - "type": "JsonMention", - "version": "v1", - "doc": "list of mentions in the quoted message" - } - }, - "doc": "A quote is a reply to a previous message. ID is the sent time of the message being replied to" - }, - "JsonMention": { - "fields": { - "uuid": { - "type": "String", - "doc": "The UUID of the account being mentioned", - "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" - }, - "start": { - "type": "int", - "doc": "The number of characters in that the mention starts at. Note that due to a quirk of how signald encodes JSON, if this value is 0 (for example if the first character in the message is the mention) the field won't show up.", - "example": "4" - }, - "length": { - "type": "int", - "doc": "The length of the mention represented in the message. Seems to always be 1 but included here in case that changes.", - "example": "1" - } - } - }, - "JsonPreview": { - "fields": { - "url": { - "type": "String" - }, - "title": { - "type": "String" - }, - "description": { - "type": "String" - }, - "date": { - "type": "long" - }, - "attachment": { - "type": "JsonAttachment", - "version": "v1", - "doc": "an optional image file attached to the preview" - } - }, - "doc": "metadata about one of the links in a message" - }, - "JsonReaction": { - "fields": { - "emoji": { - "type": "String", - "doc": "the emoji to react with", - "example": "\"👍\"" - }, - "remove": { - "type": "boolean", - "doc": "set to true to remove the reaction. requires emoji be set to previously reacted emoji" - }, - "targetAuthor": { - "type": "JsonAddress", - "version": "v1", - "doc": "the author of the message being reacted to" - }, - "targetSentTimestamp": { - "type": "long", - "doc": "the client timestamp of the message being reacted to", - "example": "1615576442475" - } - } - }, - "GroupAccessControl": { - "fields": { - "link": { - "type": "String", - "doc": "UNSATISFIABLE when the group link is disabled, ADMINISTRATOR when the group link is enabled but an administrator must approve new members, ANY when the group link is enabled and no approval is required", - "example": "\"ANY\"" - }, - "attributes": { - "type": "String", - "doc": "who can edit group info" - }, - "members": { - "type": "String", - "doc": "who can add members" - } - }, - "doc": "group access control settings. Options for each controlled action are: UNKNOWN, ANY, MEMBER, ADMINISTRATOR, UNSATISFIABLE and UNRECOGNIZED" - }, - "GroupMember": { - "fields": { - "uuid": { - "type": "String", - "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" - }, - "role": { - "type": "String", - "doc": "possible values are: UNKNOWN, DEFAULT, ADMINISTRATOR and UNRECOGNIZED", - "example": "\"DEFAULT\"" - }, - "joined_revision": { - "type": "int" - } - } - }, - "BannedGroupMember": { - "fields": { - "uuid": { - "type": "String", - "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" - }, - "timestamp": { - "type": "long", - "doc": "Timestamp as milliseconds since Unix epoch of when the user was banned. This field is set by the server." - } - } - }, - "GroupChange": { - "fields": { - "editor": { - "type": "JsonAddress", - "version": "v1", - "doc": "The user that made the change." - }, - "revision": { - "type": "Integer", - "doc": "The group revision that this change brings the group to." - }, - "new_members": { - "list": true, - "type": "GroupMember", - "version": "v1", - "doc": "Represents users have been added to the group. This can be from group members adding users, or a users joining via a group link that required no approval." - }, - "delete_members": { - "list": true, - "type": "JsonAddress", - "version": "v1", - "doc": "Represents users that have been removed from the group. This can be from admins removing users, or users choosing to leave the group" - }, - "modify_member_roles": { - "list": true, - "type": "GroupMember", - "version": "v1", - "doc": "Represents users with their new, modified role." - }, - "modified_profile_keys": { - "list": true, - "type": "GroupMember", - "version": "v1", - "doc": "Represents users that have rotated their profile key. Note that signald currently does not expose profile keys to clients. The joined revision property will always be 0 in this list." - }, - "new_pending_members": { - "list": true, - "type": "GroupPendingMember", - "version": "v1", - "doc": "Represents a user that has been invited to the group by another user." - }, - "delete_pending_members": { - "list": true, - "type": "JsonAddress", - "version": "v1" - }, - "promote_pending_members": { - "list": true, - "type": "GroupMember", - "version": "v1" - }, - "new_banned_members": { - "list": true, - "type": "BannedGroupMember", - "version": "v1" - }, - "new_unbanned_members": { - "list": true, - "type": "BannedGroupMember", - "version": "v1" - }, - "new_title": { - "type": "String" - }, - "new_avatar": { - "type": "Boolean", - "doc": "Whether this group change changed the avatar." - }, - "new_timer": { - "type": "Integer", - "doc": "New disappearing messages timer value." - }, - "new_access_control": { - "type": "GroupAccessControl", - "version": "v1", - "doc": "If not null, then this group change modified one of the access controls. Some of the properties in here will be null." - }, - "new_requesting_members": { - "list": true, - "type": "GroupRequestingMember", - "version": "v1", - "doc": "Represents users that have requested to join the group via the group link. Note that members requesting to join might not necessarily have the list of users in the group, so they won't be able to send a peer-to-peer group update message to inform users of their request to join. Other users in the group may inform us that the revision has increased, but the members requesting access will have to be obtained from the server instead (which signald will handle). For now, a get_group request has to be made to get the users that have requested to join the group." - }, - "delete_requesting_members": { - "list": true, - "type": "JsonAddress", - "version": "v1" - }, - "promote_requesting_members": { - "list": true, - "type": "GroupMember", - "version": "v1" - }, - "new_invite_link_password": { - "type": "Boolean", - "doc": "Whether this group change involved resetting the group invite link." - }, - "new_description": { - "type": "String" - }, - "new_is_announcement_group": { - "type": "String", - "doc": "Whether this change affected the announcement group setting. Possible values are UNKNOWN, ENABLED or DISABLED" - } - }, - "doc": "Represents a group change made by a user. This can also represent request link invites. Only the fields relevant to the group change performed will be set. Note that in signald, group changes are currently only received from incoming messages from a message subscription." - }, - "DeviceInfo": { - "fields": { - "id": { - "type": "long" - }, - "name": { - "type": "String" - }, - "created": { - "type": "long" - }, - "lastSeen": { - "type": "long" - } - } - }, - "JsonGroupInfo": { - "fields": { - "groupId": { - "type": "String" - }, - "members": { - "list": true, - "type": "JsonAddress", - "version": "v1" - }, - "name": { - "type": "String" - }, - "type": { - "type": "String" - }, - "avatarId": { - "type": "long" - } - }, - "doc": "information about a legacy group" - }, - "Capabilities": { - "fields": { - "gv2": { - "type": "boolean", - "doc": "this capability is deprecated and will always be true" - }, - "storage": { - "type": "boolean" - }, - "stories": { - "type": "boolean" - }, - "gv1-migration": { - "type": "boolean" - }, - "sender_key": { - "type": "boolean" - }, - "announcement_group": { - "type": "boolean" - }, - "change_number": { - "type": "boolean" - } - } - }, - "Server": { - "fields": { - "uuid": { - "type": "UUID", - "doc": "A unique identifier for the server, referenced when adding accounts. Must be a valid UUID. Will be generated if not specified when creating." - }, - "proxy": { - "type": "String" - }, - "ca": { - "type": "String", - "doc": "base64 encoded trust store, password must be 'whisper'" - }, - "service_url": { - "type": "String" - }, - "cdn_urls": { - "list": true, - "type": "ServerCDN", - "version": "v1" - }, - "contact_discovery_url": { - "type": "String" - }, - "key_backup_url": { - "type": "String" - }, - "storage_url": { - "type": "String" - }, - "zk_param": { - "type": "String", - "doc": "base64 encoded ZKGROUP_SERVER_PUBLIC_PARAMS value" - }, - "unidentified_sender_root": { - "type": "String", - "doc": "base64 encoded" - }, - "key_backup_service_name": { - "type": "String" - }, - "key_backup_service_id": { - "type": "String", - "doc": "base64 encoded" - }, - "key_backup_mrenclave": { - "type": "String" - }, - "cds_mrenclave": { - "type": "String" - }, - "ias_ca": { - "type": "String", - "doc": "base64 encoded trust store, password must be 'whisper'" - } - }, - "doc": "a Signal server" - }, - "Payment": { - "fields": { - "receipt": { - "type": "String", - "doc": "base64 encoded payment receipt data. This is a protobuf value which can be decoded as the Receipt object described in https://github.com/mobilecoinfoundation/mobilecoin/blob/master/api/proto/external.proto" - }, - "note": { - "type": "String", - "doc": "note attached to the payment" - } - }, - "doc": "details about a MobileCoin payment" - }, - "RemoteConfig": { - "fields": { - "name": { - "type": "String", - "doc": "The name of this remote config entry. These names may be prefixed with the platform type (\"android.\", \"ios.\", \"desktop.\", etc.) Typically, clients only handle the relevant configs for its platform, hardcoding the names it cares about handling and ignoring the rest.", - "example": "desktop.mediaQuality.levels" - }, - "value": { - "type": "String", - "doc": "The value for this remote config entry. Even though this is a string, it could be a boolean as a string, an integer/long value, a comma-delimited list, etc. Clients usually consume this by hardcoding the feature flagsit should track in the app and assuming that the server will send the type that the client expects. If an unexpected type occurs, it falls back to a default value.", - "example": "1:2,61:2,81:2,82:2,65:2,31:2,47:2,41:2,32:2,385:2,971:2,974:2,49:2,33:2,*:1" - } - }, - "doc": "A remote config (feature flag) entry." - }, - "GroupHistoryEntry": { - "fields": { - "group": { - "type": "JsonGroupV2Info", - "version": "v1" - }, - "change": { - "type": "GroupChange", - "version": "v1" - } - } - }, - "PagingData": { - "fields": { - "has_more_pages": { - "type": "boolean" - }, - "next_page_revision": { - "type": "int" - } - } - }, - "JsonViewOnceOpenMessage": { - "fields": { - "sender": { - "type": "JsonAddress", - "version": "v1" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - } - } - }, - "JsonMessageRequestResponseMessage": { - "fields": { - "person": { - "type": "JsonAddress", - "version": "v1" - }, - "groupId": { - "type": "String" - }, - "type": { - "type": "String", - "doc": "One of UNKNOWN, ACCEPT, DELETE, BLOCK, BLOCK_AND_DELETE, UNBLOCK_AND_ACCEPT" - } - }, - "doc": "Responses to message requests from unknown users or groups" - }, - "SendSuccess": { - "fields": { - "unidentified": { - "type": "boolean" - }, - "needsSync": { - "type": "boolean" - }, - "duration": { - "type": "long" - }, - "devices": { - "list": true, - "type": "Integer" - } - } - }, - "ProofRequiredError": { - "fields": { - "token": { - "type": "String" - }, - "options": { - "list": true, - "type": "String", - "doc": "possible list values are RECAPTCHA and PUSH_CHALLENGE" - }, - "message": { - "type": "String" - }, - "retry_after": { - "type": "long", - "doc": "value in seconds" - } - }, - "error": true - }, - "SharedContact": { - "fields": { - "name": { - "type": "SharedContactName", - "version": "v1", - "doc": "the name of the shared contact" - }, - "email": { - "list": true, - "type": "SharedContactEmail", - "version": "v1", - "doc": "the email addresses of the shared contact" - }, - "phone": { - "list": true, - "type": "SharedContactPhone", - "version": "v1", - "doc": "the phone numbers of the shared contact" - }, - "address": { - "list": true, - "type": "SharedContactAddress", - "version": "v1", - "doc": "the physical addresses of the shared contact" - }, - "avatar": { - "type": "SharedContactAvatar", - "version": "v1", - "doc": "the profile picture/avatar of the shared contact" - }, - "organization": { - "type": "String", - "doc": "the organization (e.g. workplace) of the shared contact" - } - } - }, - "RemoteDelete": { - "fields": { - "target_sent_timestamp": { - "type": "long" - } - } - }, - "StoryContext": { - "fields": { - "author": { - "type": "String" - }, - "sent_timestamp": { - "type": "long" - } - } - }, - "JsonSentTranscriptMessage": { - "fields": { - "destination": { - "type": "JsonAddress", - "version": "v1" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - }, - "expirationStartTimestamp": { - "type": "long" - }, - "message": { - "type": "JsonDataMessage", - "version": "v1" - }, - "unidentifiedStatus": { - "type": "Map" - }, - "isRecipientUpdate": { - "type": "boolean" - } - } - }, - "JsonBlockedListMessage": { - "fields": { - "addresses": { - "list": true, - "type": "JsonAddress", - "version": "v1" - }, - "groupIds": { - "list": true, - "type": "String" - } - } - }, - "JsonReadMessage": { - "fields": { - "sender": { - "type": "JsonAddress", - "version": "v1" - }, - "timestamp": { - "type": "long", - "example": "1615576442475" - } - } - }, - "JsonVerifiedMessage": { - "fields": { - "destination": { - "type": "JsonAddress", - "version": "v1" - }, - "identityKey": { - "type": "String" - }, - "verified": { - "type": "String" - }, - "timestamp": { - "type": "long" - } - } - }, - "OfferMessage": { - "fields": { - "id": { - "type": "long" - }, - "sdp": { - "type": "String" - }, - "type": { - "type": "String" - }, - "opaque": { - "type": "String" - } - } - }, - "AnswerMessage": { - "fields": { - "id": { - "type": "long" - }, - "sdp": { - "type": "String" - }, - "opaque": { - "type": "String" - } - } - }, - "BusyMessage": { - "fields": { - "id": { - "type": "long" - } - } - }, - "HangupMessage": { - "fields": { - "id": { - "type": "long" - }, - "type": { - "type": "String" - }, - "legacy": { - "type": "boolean" - }, - "device_id": { - "type": "int" - } - } - }, - "IceUpdateMessage": { - "fields": { - "id": { - "type": "long" - }, - "opaque": { - "type": "String" - }, - "sdp": { - "type": "String" - } - } - }, - "TextAttachment": { - "fields": { - "text": { - "type": "String" - }, - "style": { - "type": "String" - }, - "preview": { - "type": "JsonPreview", - "version": "v1" - }, - "text_foreground_color": { - "type": "String" - }, - "text_background_color": { - "type": "String" - }, - "background_gradient": { - "type": "Gradient", - "version": "v1" - }, - "background_color": { - "type": "String" - } - } - }, - "GroupPendingMember": { - "fields": { - "uuid": { - "type": "String", - "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" - }, - "role": { - "type": "String", - "doc": "possible values are: UNKNOWN, DEFAULT, ADMINISTRATOR and UNRECOGNIZED", - "example": "\"DEFAULT\"" - }, - "timestamp": { - "type": "long" - }, - "added_by_uuid": { - "type": "String", - "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" - } - } - }, - "GroupRequestingMember": { - "fields": { - "uuid": { - "type": "String", - "example": "\"aeed01f0-a234-478e-8cf7-261c283151e7\"" - }, - "timestamp": { - "type": "long" - } - } - }, - "ServerCDN": { - "fields": { - "number": { - "type": "int" - }, - "url": { - "type": "String" - } - } - }, - "SharedContactName": { - "fields": { - "display": { - "type": "String", - "doc": "the full name that should be displayed" - }, - "given": { - "type": "String", - "doc": "given name" - }, - "middle": { - "type": "String", - "doc": "middle name" - }, - "family": { - "type": "String", - "doc": "family name (surname)" - }, - "prefix": { - "type": "String" - }, - "suffix": { - "type": "String" - } - } - }, - "SharedContactEmail": { - "fields": { - "type": { - "type": "String", - "doc": "the type of email (options: HOME, WORK, MOBILE, CUSTOM)" - }, - "value": { - "type": "String", - "doc": "the email address" - }, - "label": { - "type": "String", - "doc": "the type label when type is CUSTOM" - } - } - }, - "SharedContactPhone": { - "fields": { - "type": { - "type": "String", - "doc": "the type of phone (options: HOME, WORK, MOBILE, CUSTOM)" - }, - "value": { - "type": "String", - "doc": "the phone number" - }, - "label": { - "type": "String", - "doc": "the type label when type is CUSTOM" - } - } - }, - "SharedContactAddress": { - "fields": { - "type": { - "type": "String", - "doc": "the type of address (options: HOME, WORK, CUSTOM)" - }, - "label": { - "type": "String" - }, - "street": { - "type": "String" - }, - "pobox": { - "type": "String" - }, - "neighborhood": { - "type": "String" - }, - "city": { - "type": "String" - }, - "region": { - "type": "String" - }, - "postcode": { - "type": "String" - }, - "country": { - "type": "String" - } - } - }, - "SharedContactAvatar": { - "fields": { - "attachment": { - "type": "JsonAttachment", - "version": "v1" - }, - "is_profile": { - "type": "boolean" - } - } - }, - "Gradient": { - "fields": { - "start_color": { - "type": "String" - }, - "end_color": { - "type": "String" - } - } - } - } - }, - "actions": { - "v1": { - "send": { - "request": "SendRequest", - "response": "SendResponse", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "NoSendPermissionError" - }, - { - "name": "InvalidAttachmentError" - }, - { - "name": "InternalError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "RateLimitError" - }, - { - "name": "InvalidRecipientError" - }, - { - "name": "AttachmentTooLargeError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "react": { - "request": "ReactRequest", - "response": "SendResponse", - "doc": "react to a previous message", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "NoSendPermissionError" - }, - { - "name": "InternalError" - }, - { - "name": "InvalidRecipientError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "RateLimitError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "version": { - "request": "VersionRequest", - "response": "JsonVersionMessage" - }, - "accept_invitation": { - "request": "AcceptInvitationRequest", - "response": "JsonGroupV2Info", - "doc": "Accept a v2 group invitation. Note that you must have a profile name set to join groups.", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "OwnProfileKeyDoesNotExistError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "InternalError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError", - "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." - }, - { - "name": "SQLError" - }, - { - "name": "GroupPatchNotAcceptedError", - "doc": "Caused when server rejects the group update." - } - ] - }, - "approve_membership": { - "request": "ApproveMembershipRequest", - "response": "JsonGroupV2Info", - "doc": "approve a request to join a group", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "InternalError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError", - "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." - }, - { - "name": "SQLError" - }, - { - "name": "GroupPatchNotAcceptedError", - "doc": "Caused when server rejects the group update." - } - ] - }, - "get_group": { - "request": "GetGroupRequest", - "response": "JsonGroupV2Info", - "doc": "Query the server for the latest state of a known group. If the account is not a member of the group, an UnknownGroupError is returned.", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "InternalError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "InvalidGroupStateError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "get_linked_devices": { - "request": "GetLinkedDevicesRequest", - "response": "LinkedDevices", - "doc": "list all linked devices on a Signal account", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "join_group": { - "request": "JoinGroupRequest", - "response": "JsonGroupJoinInfo", - "doc": "Join a group using the a signal.group URL. Note that you must have a profile name set to join groups.", - "errors": [ - { - "name": "InvalidRequestError" - }, - { - "name": "InvalidInviteURIError" - }, - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "OwnProfileKeyDoesNotExistError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "GroupNotActiveError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "InvalidGroupStateError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "remove_linked_device": { - "request": "RemoveLinkedDeviceRequest", - "doc": "Remove a linked device from the Signal account. Only allowed when the local device id is 1", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "update_group": { - "request": "UpdateGroupRequest", - "response": "GroupInfo", - "doc": "modify a group. Note that only one modification action may be performed at once", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError", - "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "SQLError" - }, - { - "name": "GroupPatchNotAcceptedError", - "doc": "Caused when server rejects the group update, e.g. trying to add a user that's already in the group" - } - ] - }, - "set_profile": { - "request": "SetProfile", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "InvalidBase64Error" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "resolve_address": { - "request": "ResolveAddressRequest", - "response": "JsonAddress", - "doc": "Resolve a partial JsonAddress with only a number or UUID to one with both. Anywhere that signald accepts a JsonAddress will except a partial, this is a convenience function for client authors, mostly because signald doesn't resolve all the partials it returns.", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "mark_read": { - "request": "MarkReadRequest", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "InternalError" - }, - { - "name": "UntrustedIdentityError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "get_profile": { - "request": "GetProfileRequest", - "response": "Profile", - "doc": "Get all information available about a user", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "ProfileUnavailableError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "list_groups": { - "request": "ListGroupsRequest", - "response": "GroupList", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "list_contacts": { - "request": "ListContactsRequest", - "response": "ProfileList", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "create_group": { - "request": "CreateGroupRequest", - "response": "JsonGroupV2Info", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "OwnProfileKeyDoesNotExistError" - }, - { - "name": "NoKnownUUIDError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "InvalidGroupStateError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "leave_group": { - "request": "LeaveGroupRequest", - "response": "GroupInfo", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "InternalError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "generate_linking_uri": { - "request": "GenerateLinkingURIRequest", - "response": "LinkingURI", - "doc": "Generate a linking URI. Typically this is QR encoded and scanned by the primary device. Submit the returned session_id with a finish_link request.", - "errors": [ - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - } - ] - }, - "finish_link": { - "request": "FinishLinkRequest", - "response": "Account", - "doc": "After a linking URI has been requested, finish_link must be called with the session_id provided with the URI. it will return information about the new account once the linking process is completed by the other device and the new account is setup. Note that the account setup process can sometimes take some time, if rapid userfeedback is required after scanning, use wait_for_scan first, then finish setup with finish_link.", - "errors": [ - { - "name": "NoSuchSessionError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "InternalError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "UserAlreadyExistsError" - }, - { - "name": "ScanTimeoutError" - } - ] - }, - "add_device": { - "request": "AddLinkedDeviceRequest", - "doc": "Link a new device to a local Signal account", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "InvalidRequestError", - "doc": "caused by syntax errors with the provided linking URI" - }, - { - "name": "InternalError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "register": { - "request": "RegisterRequest", - "response": "Account", - "doc": "begin the account registration process by requesting a phone number verification code. when the code is received, submit it with a verify request", - "errors": [ - { - "name": "CaptchaRequiredError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - } - ] - }, - "verify": { - "request": "VerifyRequest", - "response": "Account", - "doc": "verify an account's phone number with a code after registering, completing the account creation process", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "AccountHasNoKeysError" - }, - { - "name": "AccountAlreadyVerifiedError" - }, - { - "name": "AccountLockedError" - }, - { - "name": "NoSuchAccountError" - } - ] - }, - "get_identities": { - "request": "GetIdentitiesRequest", - "response": "IdentityKeyList", - "doc": "Get information about a known keys for a particular address", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "trust": { - "request": "TrustRequest", - "doc": "Trust another user's safety number using either the QR code data or the safety number text", - "errors": [ - { - "name": "InvalidRequestError" - }, - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "FingerprintVersionMismatchError" - }, - { - "name": "InvalidBase64Error" - }, - { - "name": "UnknownIdentityKeyError" - }, - { - "name": "InvalidFingerprintError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "delete_account": { - "request": "DeleteAccountRequest", - "doc": "delete all account data signald has on disk, and optionally delete the account from the server as well. Note that this is not \"unlink\" and will delete the entire account, even from a linked device.", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "typing": { - "request": "TypingRequest", - "doc": "send a typing started or stopped message", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "InvalidRecipientError" - }, - { - "name": "InvalidGroupError" - }, - { - "name": "UntrustedIdentityError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "reset_session": { - "request": "ResetSessionRequest", - "response": "SendResponse", - "doc": "reset a session with a particular user", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "NoSendPermissionError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "RateLimitError" - }, - { - "name": "InvalidRecipientError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "request_sync": { - "request": "RequestSyncRequest", - "doc": "Request other devices on the account send us their group list, syncable config and contact list.", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "UntrustedIdentityError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "list_accounts": { - "request": "ListAccountsRequest", - "response": "AccountList", - "doc": "return all local accounts", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "InternalError" - } - ] - }, - "group_link_info": { - "request": "GroupLinkInfoRequest", - "response": "JsonGroupJoinInfo", - "doc": "Get information about a group from a signal.group link", - "errors": [ - { - "name": "GroupLinkNotActiveError" - }, - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "SQLError" - } - ] - }, - "update_contact": { - "request": "UpdateContactRequest", - "response": "Profile", - "doc": "update information about a local contact", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "InternalError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "set_expiration": { - "request": "SetExpirationRequest", - "response": "SendResponse", - "doc": "Set the message expiration timer for a thread. Expiration must be specified in seconds, set to 0 to disable timer", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError", - "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "SQLError" - }, - { - "name": "GroupPatchNotAcceptedError", - "doc": "If updating a group, caused when server rejects the group update." - } - ] - }, - "set_device_name": { - "request": "SetDeviceNameRequest", - "doc": "set this device's name. This will show up on the mobile device on the same account under settings -> linked devices", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "get_all_identities": { - "request": "GetAllIdentities", - "response": "AllIdentityKeyList", - "doc": "get all known identity keys", - "errors": [ - { - "name": "InvalidProxyError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InternalError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "subscribe": { - "request": "SubscribeRequest", - "doc": "receive incoming messages. After making a subscribe request, incoming messages will be sent to the client encoded as ClientMessageWrapper. Send an unsubscribe request or disconnect from the socket to stop receiving messages.", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "InternalError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "unsubscribe": { - "request": "UnsubscribeRequest", - "doc": "See subscribe for more info", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "InternalError" - }, - { - "name": "SQLError" - } - ] - }, - "remote_delete": { - "request": "RemoteDeleteRequest", - "response": "SendResponse", - "doc": "delete a message previously sent", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "InvalidRecipientError" - }, - { - "name": "NoSendPermissionError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "RateLimitError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "add_server": { - "request": "AddServerRequest", - "response": "String", - "doc": "add a new server to connect to. Returns the new server's UUID.", - "errors": [ - { - "name": "InvalidProxyError" - }, - { - "name": "InternalError" - } - ] - }, - "get_servers": { - "request": "GetServersRequest", - "response": "ServerList", - "errors": [ - { - "name": "InternalError" - } - ] - }, - "delete_server": { - "request": "RemoveServerRequest", - "errors": [ - { - "name": "InternalError" - } - ] - }, - "send_payment": { - "request": "SendPaymentRequest", - "response": "SendResponse", - "doc": "send a mobilecoin payment", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "InvalidBase64Error" - }, - { - "name": "InvalidRecipientError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "NoSendPermissionError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "RateLimitError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "get_remote_config": { - "request": "RemoteConfigRequest", - "response": "RemoteConfigList", - "doc": "Retrieves the remote config (feature flags) from the server.", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "SQLError" - } - ] - }, - "refuse_membership": { - "request": "RefuseMembershipRequest", - "response": "JsonGroupV2Info", - "doc": "deny a request to join a group", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "InternalError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError", - "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "SQLError" - }, - { - "name": "GroupPatchNotAcceptedError", - "doc": "Caused when server rejects the group update." - } - ] - }, - "submit_challenge": { - "request": "SubmitChallengeRequest", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "InternalError" - }, - { - "name": "SQLError" - } - ] - }, - "is_identifier_registered": { - "request": "IsIdentifierRegisteredRequest", - "response": "BooleanMessage", - "doc": "Determine whether an account identifier is registered on the Signal service.", - "errors": [ - { - "name": "InternalError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "SQLError" - } - ] - }, - "wait_for_scan": { - "request": "WaitForScanRequest", - "doc": "An optional part of the linking process. Intended to be called after displaying the QR code, will return quickly after the user scans the QR code. finish_link must be called after wait_for_scan returns a non-error", - "errors": [ - { - "name": "NoSuchSessionError" - }, - { - "name": "ScanTimeoutError" - }, - { - "name": "InternalError" - } - ] - }, - "get_group_revision_pages": { - "request": "GetGroupRevisionPagesRequest", - "response": "GroupHistoryPage", - "doc": "Query the server for group revision history. The history contains information about the changes between each revision and the user that made the change.", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "InternalError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "InvalidGroupStateError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError", - "doc": "caused when not a member of the group, when requesting logs from a revision lower than your joinedAtVersion, etc." - }, - { - "name": "RateLimitError" - }, - { - "name": "SQLError" - } - ] - }, - "send_sync_message": { - "request": "SendSyncMessageRequest", - "response": "JsonSendMessageResult", - "doc": "Sends a sync message to the account's devices", - "errors": [ - { - "name": "InvalidRequestError" - }, - { - "name": "RateLimitError" - }, - { - "name": "InternalError" - }, - { - "name": "UnregisteredUserError" - }, - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "AuthorizationFailedError" - }, - { - "name": "SQLError" - } - ] - }, - "ban_user": { - "request": "BanUserRequest", - "response": "JsonGroupV2Info", - "doc": "Bans users from a group. This works even if the users aren't in the group. If they are currently in the group, they will also be removed.", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "InternalError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError", - "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." - }, - { - "name": "SQLError" - }, - { - "name": "GroupPatchNotAcceptedError", - "doc": "Caused when server rejects the group update." - } - ] - }, - "unban_user": { - "request": "UnbanUserRequest", - "response": "JsonGroupV2Info", - "doc": "Unbans users from a group.", - "errors": [ - { - "name": "NoSuchAccountError" - }, - { - "name": "ServerNotFoundError" - }, - { - "name": "InvalidProxyError" - }, - { - "name": "UnknownGroupError" - }, - { - "name": "GroupVerificationError" - }, - { - "name": "InternalError" - }, - { - "name": "InvalidRequestError" - }, - { - "name": "AuthorizationFailedError", - "doc": "Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)." - }, - { - "name": "SQLError" - }, - { - "name": "GroupPatchNotAcceptedError", - "doc": "Caused when server rejects the group update." - } - ] - } - } - } -} +{"doc_version":"v1","version":{"name":"signald","version":"unversioned","branch":"","commit":""},"info":"This document describes objects that may be used when communicating with signald.","types":{"v0":{"JsonAccountList":{"fields":{"accounts":{"list":true,"type":"JsonAccount","version":"v0"}},"deprecated":true,"removal_date":1641027661},"JsonMessageEnvelope":{"fields":{"username":{"type":"String","example":"\"+12024561414\""},"uuid":{"type":"String","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\""},"source":{"type":"JsonAddress","version":"v0"},"sourceDevice":{"type":"int"},"type":{"type":"String"},"relay":{"type":"String","doc":"this field is no longer available and will never be populated"},"timestamp":{"type":"long","example":"1615576442475"},"timestampISO":{"type":"String"},"serverTimestamp":{"type":"long"},"serverDeliveredTimestamp":{"type":"long","example":"161557644247580"},"hasLegacyMessage":{"type":"boolean"},"hasContent":{"type":"boolean"},"isUnidentifiedSender":{"type":"boolean"},"dataMessage":{"type":"JsonDataMessage","version":"v0"},"syncMessage":{"type":"JsonSyncMessage","version":"v0"},"callMessage":{"type":"JsonCallMessage","version":"v0"},"receipt":{"type":"JsonReceiptMessage","version":"v0"},"typing":{"type":"JsonTypingMessage","version":"v0"}},"deprecated":true,"removal_date":1641027661},"JsonAccount":{"fields":{"deviceId":{"type":"int"},"username":{"type":"String"},"filename":{"type":"String"},"uuid":{"type":"String"},"registered":{"type":"boolean"},"has_keys":{"type":"boolean"},"subscribed":{"type":"boolean"}},"deprecated":true,"removal_date":1641027661},"JsonAddress":{"fields":{"number":{"type":"String"},"uuid":{"type":"UUID"},"relay":{"type":"String"}},"deprecated":true,"removal_date":1641027661},"JsonDataMessage":{"fields":{"timestamp":{"type":"long","doc":"the timestamp that the message was sent at, according to the sender's device. This is used to uniquely identify this message for things like reactions and quotes.","example":"1615576442475"},"attachments":{"list":true,"type":"JsonAttachment","version":"v0","doc":"files attached to the incoming message"},"body":{"type":"String","doc":"the text body of the incoming message.","example":"\"hello\""},"group":{"type":"JsonGroupInfo","version":"v0","doc":"if the incoming message was sent to a v1 group, information about that group will be here"},"groupV2":{"type":"JsonGroupV2Info","version":"v0","doc":"is the incoming message was sent to a v2 group, basic identifying information about that group will be here. For full information, use list_groups"},"endSession":{"type":"boolean"},"expiresInSeconds":{"type":"int","doc":"the expiry timer on the incoming message. Clients should delete records of the message within this number of seconds"},"profileKeyUpdate":{"type":"boolean"},"quote":{"type":"JsonQuote","version":"v0","doc":"if the incoming message is a quote or reply to another message, this will contain information about that message"},"contacts":{"list":true,"type":"SharedContact","version":"v0","doc":"if the incoming message has a shared contact, the contact's information will be here"},"previews":{"list":true,"type":"JsonPreview","version":"v0","doc":"if the incoming message has a link preview, information about that preview will be here"},"sticker":{"type":"JsonSticker","version":"v0","doc":"if the incoming message is a sticker, information about the sicker will be here"},"viewOnce":{"type":"boolean","doc":"indicates the message is a view once message. View once messages typically include no body and a single image attachment. Official Signal clients will prevent the user from saving the image, and once the user has viewed the image once they will destroy the image."},"reaction":{"type":"JsonReaction","version":"v0","doc":"if the message adds or removes a reaction to another message, this will indicate what change is being made"},"remoteDelete":{"type":"RemoteDelete","version":"v0","doc":"if the inbound message is deleting a previously sent message, indicates which message should be deleted"},"mentions":{"list":true,"type":"JsonMention","version":"v0","doc":"list of mentions in the message"}},"deprecated":true,"removal_date":1641027661},"JsonSyncMessage":{"fields":{"sent":{"type":"JsonSentTranscriptMessage","version":"v0"},"contacts":{"type":"JsonAttachment","version":"v0"},"contactsComplete":{"type":"boolean"},"groups":{"type":"JsonAttachment","version":"v0"},"blockedList":{"type":"JsonBlockedListMessage","version":"v0"},"request":{"type":"String"},"readMessages":{"list":true,"type":"JsonReadMessage","version":"v0"},"viewOnceOpen":{"type":"JsonViewOnceOpenMessage","version":"v0"},"verified":{"type":"JsonVerifiedMessage","version":"v0"},"configuration":{"type":"ConfigurationMessage","version":"v0"},"stickerPackOperations":{"list":true,"type":"JsonStickerPackOperationMessage","version":"v0"},"fetchType":{"type":"String"},"messageRequestResponse":{"type":"JsonMessageRequestResponseMessage","version":"v0"}},"deprecated":true,"removal_date":1641027661},"JsonCallMessage":{"fields":{"offerMessage":{"type":"OfferMessage","version":"v0"},"answerMessage":{"type":"AnswerMessage","version":"v0"},"busyMessage":{"type":"BusyMessage","version":"v0"},"hangupMessage":{"type":"HangupMessage","version":"v0"},"iceUpdateMessages":{"list":true,"type":"IceUpdateMessage","version":"v0"},"destinationDeviceId":{"type":"int"},"isMultiRing":{"type":"boolean"}},"deprecated":true,"removal_date":1641027661},"JsonReceiptMessage":{"fields":{"type":{"type":"String"},"timestamps":{"list":true,"type":"Long"},"when":{"type":"long"}},"deprecated":true,"removal_date":1641027661},"JsonTypingMessage":{"fields":{"action":{"type":"String"},"timestamp":{"type":"long"},"groupId":{"type":"String"}},"deprecated":true,"removal_date":1641027661},"JsonAttachment":{"fields":{"contentType":{"type":"String"},"id":{"type":"String"},"size":{"type":"int"},"storedFilename":{"type":"String"},"filename":{"type":"String"},"customFilename":{"type":"String"},"caption":{"type":"String"},"width":{"type":"int"},"height":{"type":"int"},"voiceNote":{"type":"boolean"},"key":{"type":"String"},"digest":{"type":"String"},"blurhash":{"type":"String"}},"deprecated":true,"removal_date":1641027661},"JsonGroupInfo":{"fields":{"groupId":{"type":"String"},"members":{"list":true,"type":"JsonAddress","version":"v0"},"name":{"type":"String"},"type":{"type":"String"},"avatarId":{"type":"long"}},"deprecated":true,"removal_date":1641027661},"JsonGroupV2Info":{"fields":{"id":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""},"revision":{"type":"int","example":"5"},"title":{"type":"String","example":"\"Parkdale Run Club\""},"description":{"type":"String"},"avatar":{"type":"String","doc":"path to the group's avatar on local disk, if available","example":"\"/var/lib/signald/avatars/group-EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""},"timer":{"type":"int","example":"604800"},"members":{"list":true,"type":"JsonAddress","version":"v0"},"pendingMembers":{"list":true,"type":"JsonAddress","version":"v0"},"requestingMembers":{"list":true,"type":"JsonAddress","version":"v0"},"inviteLink":{"type":"String","doc":"the signal.group link, if applicable"},"accessControl":{"type":"GroupAccessControl","version":"v0","doc":"current access control settings for this group"},"memberDetail":{"list":true,"type":"GroupMember","version":"v0","doc":"detailed member list"},"pendingMemberDetail":{"list":true,"type":"GroupMember","version":"v0","doc":"detailed pending member list"}},"deprecated":true,"removal_date":1641027661},"JsonQuote":{"fields":{"id":{"type":"long","doc":"the client timestamp of the message being quoted","example":"1615576442475"},"author":{"type":"JsonAddress","version":"v0","doc":"the author of the message being quoted"},"text":{"type":"String","doc":"the body of the message being quoted","example":"\"hey  what's up?\""},"attachments":{"list":true,"type":"JsonQuotedAttachment","version":"v0","doc":"list of files attached to the quoted message"},"mentions":{"list":true,"type":"JsonMention","version":"v0","doc":"list of mentions in the quoted message"}},"doc":"A quote is a reply to a previous message. ID is the sent time of the message being replied to","deprecated":true,"removal_date":1641027661},"SharedContact":{"fields":{"name":{"type":"Name","version":"v0"},"avatar":{"type":"Optional","version":"v0"},"phone":{"type":"Optional","version":"v0"},"email":{"type":"Optional","version":"v0"},"address":{"type":"Optional","version":"v0"},"organization":{"type":"Optional","version":"v0"}}},"JsonPreview":{"fields":{"url":{"type":"String"},"title":{"type":"String"},"attachment":{"type":"JsonAttachment","version":"v0"}},"deprecated":true,"removal_date":1641027661},"JsonSticker":{"fields":{"packID":{"type":"String"},"packKey":{"type":"String"},"stickerID":{"type":"int"},"attachment":{"type":"JsonAttachment","version":"v0"},"image":{"type":"String"}},"deprecated":true,"removal_date":1641027661},"JsonReaction":{"fields":{"emoji":{"type":"String","doc":"the emoji to react with","example":"\"👍\""},"remove":{"type":"boolean","doc":"set to true to remove the reaction. requires emoji be set to previously reacted emoji"},"targetAuthor":{"type":"JsonAddress","version":"v0","doc":"the author of the message being reacted to"},"targetSentTimestamp":{"type":"long","doc":"the client timestamp of the message being reacted to","example":"1615576442475"}},"deprecated":true,"removal_date":1641027661},"RemoteDelete":{"fields":{"targetSentTimestamp":{"type":"long"}}},"JsonMention":{"fields":{"uuid":{"type":"String","doc":"The UUID of the account being mentioned","example":"\"aeed01f0-a234-478e-8cf7-261c283151e7\""},"start":{"type":"int","doc":"The number of characters in that the mention starts at. Note that due to a quirk of how signald encodes JSON, if this value is 0 (for example if the first character in the message is the mention) the field won't show up.","example":"4"},"length":{"type":"int","doc":"The length of the mention represented in the message. Seems to always be 1 but included here in case that changes.","example":"1"}},"deprecated":true,"removal_date":1641027661},"JsonSentTranscriptMessage":{"fields":{"destination":{"type":"JsonAddress","version":"v0"},"timestamp":{"type":"long","example":"1615576442475"},"expirationStartTimestamp":{"type":"long"},"message":{"type":"JsonDataMessage","version":"v0"},"unidentifiedStatus":{"type":"Map"},"isRecipientUpdate":{"type":"boolean"}},"deprecated":true,"removal_date":1641027661},"JsonBlockedListMessage":{"fields":{"addresses":{"list":true,"type":"JsonAddress","version":"v0"},"groupIds":{"list":true,"type":"String"}},"deprecated":true,"removal_date":1641027661},"JsonReadMessage":{"fields":{"sender":{"type":"JsonAddress","version":"v0"},"timestamp":{"type":"long","example":"1615576442475"}},"deprecated":true,"removal_date":1641027661},"JsonViewOnceOpenMessage":{"fields":{"sender":{"type":"JsonAddress","version":"v0"},"timestamp":{"type":"long","example":"1615576442475"}},"deprecated":true,"removal_date":1641027661},"JsonVerifiedMessage":{"fields":{"destination":{"type":"JsonAddress","version":"v0"},"identityKey":{"type":"String"},"verified":{"type":"String"},"timestamp":{"type":"long"}},"deprecated":true,"removal_date":1641027661},"ConfigurationMessage":{"fields":{"readReceipts":{"type":"Optional","version":"v0"},"unidentifiedDeliveryIndicators":{"type":"Optional","version":"v0"},"typingIndicators":{"type":"Optional","version":"v0"},"linkPreviews":{"type":"Optional","version":"v0"}}},"JsonStickerPackOperationMessage":{"fields":{"packID":{"type":"String"},"packKey":{"type":"String"},"type":{"type":"String"}},"deprecated":true,"removal_date":1641027661},"JsonMessageRequestResponseMessage":{"fields":{"person":{"type":"JsonAddress","version":"v0"},"groupId":{"type":"String"},"type":{"type":"String"}},"deprecated":true,"removal_date":1641027661},"OfferMessage":{"fields":{"id":{"type":"long"},"sdp":{"type":"String"},"type":{"type":"Type","version":"v0"},"opaque":{"type":"String"}}},"AnswerMessage":{"fields":{"id":{"type":"long"},"sdp":{"type":"String"},"opaque":{"type":"String"}}},"BusyMessage":{"fields":{"id":{"type":"long"}}},"HangupMessage":{"fields":{"id":{"type":"long"},"type":{"type":"Type","version":"v0"},"deviceId":{"type":"int"},"legacy":{"type":"boolean"}}},"IceUpdateMessage":{"fields":{"id":{"type":"long"},"opaque":{"type":"String"},"sdp":{"type":"String"}}},"JsonQuotedAttachment":{"fields":{"contentType":{"type":"String"},"fileName":{"type":"String"},"thumbnail":{"type":"JsonAttachment","version":"v0"}},"deprecated":true,"removal_date":1641027661},"GroupAccessControl":{"fields":{"link":{"type":"String","doc":"UNSATISFIABLE when the group link is disabled, ADMINISTRATOR when the group link is enabled but an administrator must approve new members, ANY when the group link is enabled and no approval is required","example":"\"ANY\""},"attributes":{"type":"String","doc":"who can edit group info"},"members":{"type":"String","doc":"who can add members"}},"doc":"group access control settings. Options for each controlled action are: UNKNOWN, ANY, MEMBER, ADMINISTRATOR, UNSATISFIABLE and UNRECOGNIZED","deprecated":true,"removal_date":1641027661},"GroupMember":{"fields":{"uuid":{"type":"String","example":"\"aeed01f0-a234-478e-8cf7-261c283151e7\""},"role":{"type":"String","doc":"possible values are: UNKNOWN, DEFAULT, ADMINISTRATOR and UNRECOGNIZED","example":"\"DEFAULT\""},"joined_revision":{"type":"int"}},"deprecated":true,"removal_date":1641027661},"Name":{"fields":{"display":{"type":"Optional","version":"v0"},"given":{"type":"Optional","version":"v0"},"family":{"type":"Optional","version":"v0"},"prefix":{"type":"Optional","version":"v0"},"suffix":{"type":"Optional","version":"v0"},"middle":{"type":"Optional","version":"v0"}}},"Optional":{"fields":{"empty":{"type":"boolean"},"present":{"type":"boolean"}}},"Type":{"fields":{}}},"v1":{"ClientMessageWrapper":{"fields":{"type":{"type":"String","doc":"the type of object to expect in the `data` field"},"version":{"type":"String","doc":"the version of the object in the `data` field"},"data":{"type":"Object","doc":"the incoming object. The structure will vary from message to message, see `type` and `version` fields"},"error":{"type":"Boolean","doc":"true if the incoming message represents an error"},"account":{"type":"String","doc":"the account this message is from"}},"doc":"Wraps all incoming messages sent to the client after a v1 subscribe request is issued"},"DuplicateMessageError":{"fields":{"timestamp":{"type":"long"},"message":{"type":"String"}},"error":true},"UntrustedIdentityError":{"fields":{"identifier":{"type":"String"},"message":{"type":"String"},"identity_key":{"type":"IdentityKey","version":"v1"}},"error":true},"ProtocolNoSessionError":{"fields":{"sender":{"type":"String"},"timestamp":{"type":"long"},"message":{"type":"String"},"sender_device":{"type":"int"},"content_hint":{"type":"int"},"group_id":{"type":"String"}},"error":true},"ProtocolInvalidKeyIdError":{"fields":{"sender":{"type":"String"},"timestamp":{"type":"long"},"message":{"type":"String"},"sender_device":{"type":"int"},"content_hint":{"type":"int"},"group_id":{"type":"String"}},"error":true},"ProtocolInvalidMessageError":{"fields":{"sender":{"type":"String"},"timestamp":{"type":"long"},"message":{"type":"String"},"sender_device":{"type":"int"},"content_hint":{"type":"int"},"group_id":{"type":"String"}},"error":true},"IncomingMessage":{"fields":{"account":{"type":"String","example":"\"+12024561414\""},"source":{"type":"JsonAddress","version":"v1"},"type":{"type":"String"},"timestamp":{"type":"long","example":"1615576442475"},"source_device":{"type":"int"},"server_receiver_timestamp":{"type":"long","example":"1615576442475"},"server_deliver_timestamp":{"type":"long","example":"1615576442475"},"has_legacy_message":{"type":"boolean"},"has_content":{"type":"boolean"},"unidentified_sender":{"type":"boolean"},"data_message":{"type":"JsonDataMessage","version":"v1"},"sync_message":{"type":"JsonSyncMessage","version":"v1"},"call_message":{"type":"CallMessage","version":"v1"},"receipt_message":{"type":"ReceiptMessage","version":"v1"},"typing_message":{"type":"TypingMessage","version":"v1"},"story_message":{"type":"StoryMessage","version":"v1"},"server_guid":{"type":"String"}}},"ListenerState":{"fields":{"connected":{"type":"boolean"}},"doc":"prior attempt to indicate signald connectivity state. WebSocketConnectionState messages will be delivered at the same time as well as in other parts of the websocket lifecycle."},"WebSocketConnectionState":{"fields":{"state":{"type":"String","doc":"One of: DISCONNECTED, CONNECTING, CONNECTED, RECONNECTING, DISCONNECTING, AUTHENTICATION_FAILED, FAILED"},"socket":{"type":"String","doc":"One of: UNIDENTIFIED, IDENTIFIED"}},"doc":"indicates when the websocket connection state to the signal server has changed"},"StorageChange":{"fields":{"version":{"type":"long","doc":"Seems to behave like the group version numbers and increments every time the state changes"}},"doc":"Broadcast to subscribed clients when there is a state change from the storage service"},"SendRequest":{"fields":{"username":{"type":"String","example":"\"+12024561414\""},"account":{"type":"String","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\""},"recipientAddress":{"type":"JsonAddress","version":"v1"},"recipientGroupId":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""},"messageBody":{"type":"String","example":"\"hello\""},"attachments":{"list":true,"type":"JsonAttachment","version":"v1"},"quote":{"type":"JsonQuote","version":"v1"},"timestamp":{"type":"Long"},"mentions":{"list":true,"type":"JsonMention","version":"v1"},"previews":{"list":true,"type":"JsonPreview","version":"v1"},"members":{"list":true,"type":"JsonAddress","version":"v1","doc":"Optionally set to a sub-set of group members. Ignored if recipientGroupId isn't specified"}}},"SendResponse":{"fields":{"results":{"list":true,"type":"JsonSendMessageResult","version":"v1"},"timestamp":{"type":"long","example":"1615576442475"}}},"NoSuchAccountError":{"fields":{"account":{"type":"String"},"message":{"type":"String"}},"error":true},"ServerNotFoundError":{"fields":{"uuid":{"type":"String"},"message":{"type":"String"}},"error":true},"InvalidProxyError":{"fields":{"message":{"type":"String"}},"error":true},"NoSendPermissionError":{"fields":{"message":{"type":"String"}},"error":true},"InvalidAttachmentError":{"fields":{"filename":{"type":"String"},"message":{"type":"String"}},"error":true},"InternalError":{"fields":{"exceptions":{"list":true,"type":"String"},"message":{"type":"String"}},"doc":"an internal error in signald has occurred. typically these are things that \"should never happen\" such as issues saving to the local disk, but it is also the default error type and may catch some things that should have their own error type. If you find tht your code is depending on the exception list for any particular behavior, please file an issue so we can pull those errors out to a separate error type: https://gitlab.com/signald/signald/-/issues/new","error":true},"InvalidRequestError":{"fields":{"message":{"type":"String"}},"error":true},"UnknownGroupError":{"fields":{"message":{"type":"String"}},"error":true},"RateLimitError":{"fields":{"message":{"type":"String"}},"error":true},"InvalidRecipientError":{"fields":{"message":{"type":"String"}},"error":true},"AttachmentTooLargeError":{"fields":{"filename":{"type":"String"},"message":{"type":"String"}},"error":true},"AuthorizationFailedError":{"fields":{"message":{"type":"String"}},"doc":"Indicates the server rejected our credentials or a failed group update. Typically means the linked device was removed by the primary device, or that the account was re-registered. For group updates, this can indicate that we lack permissions.","error":true},"SQLError":{"fields":{"message":{"type":"String"}},"error":true},"ReactRequest":{"fields":{"username":{"type":"String","example":"\"+12024561414\"","required":true},"recipientAddress":{"type":"JsonAddress","version":"v1"},"recipientGroupId":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""},"reaction":{"type":"JsonReaction","version":"v1","required":true},"timestamp":{"type":"long"},"members":{"list":true,"type":"JsonAddress","version":"v1","doc":"Optionally set to a sub-set of group members. Ignored if recipientGroupId isn't specified"}},"doc":"react to a previous message"},"UnregisteredUserError":{"fields":{"message":{"type":"String"},"e164_number":{"type":"String"}},"error":true},"VersionRequest":{"fields":{}},"JsonVersionMessage":{"fields":{"name":{"type":"String","example":"\"signald\""},"version":{"type":"String","example":"\"unversioned\""},"branch":{"type":"String","example":"\"\""},"commit":{"type":"String","example":"\"\""}}},"AcceptInvitationRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"groupID":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"","required":true}},"doc":"Accept a v2 group invitation. Note that you must have a profile name set to join groups."},"JsonGroupV2Info":{"fields":{"id":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""},"revision":{"type":"int","example":"5"},"title":{"type":"String","example":"\"Parkdale Run Club\""},"description":{"type":"String"},"avatar":{"type":"String","doc":"path to the group's avatar on local disk, if available","example":"\"/var/lib/signald/avatars/group-EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""},"timer":{"type":"int","example":"604800"},"members":{"list":true,"type":"JsonAddress","version":"v1"},"pendingMembers":{"list":true,"type":"JsonAddress","version":"v1"},"requestingMembers":{"list":true,"type":"JsonAddress","version":"v1"},"inviteLink":{"type":"String","doc":"the signal.group link, if applicable"},"accessControl":{"type":"GroupAccessControl","version":"v1","doc":"current access control settings for this group"},"memberDetail":{"list":true,"type":"GroupMember","version":"v1","doc":"detailed member list"},"pendingMemberDetail":{"list":true,"type":"GroupMember","version":"v1","doc":"detailed pending member list"},"announcements":{"type":"String","doc":"indicates if the group is an announcements group. Only admins are allowed to send messages to announcements groups. Options are UNKNOWN, ENABLED or DISABLED"},"removed":{"type":"boolean","doc":"will be set to true for incoming messages to indicate the user has been removed from the group"},"banned_members":{"list":true,"type":"BannedGroupMember","version":"v1"},"group_change":{"type":"GroupChange","version":"v1","doc":"Represents a peer-to-peer group change done by a user. Will not be set if the group change signature fails verification. This is usually only set inside of incoming messages."}},"doc":"Information about a Signal group"},"OwnProfileKeyDoesNotExistError":{"fields":{"message":{"type":"String"}},"error":true},"GroupPatchNotAcceptedError":{"fields":{"message":{"type":"String"}},"doc":"Indicates the server rejected our group update. This can be due to errors such as trying to add a user that's already in the group.","error":true},"ApproveMembershipRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"groupID":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"","required":true},"members":{"list":true,"type":"JsonAddress","version":"v1","doc":"list of requesting members to approve","required":true}},"doc":"approve a request to join a group"},"GroupVerificationError":{"fields":{"message":{"type":"String"}},"error":true},"GetGroupRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"groupID":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"","required":true},"revision":{"type":"int","doc":"the latest known revision, default value (-1) forces fetch from server"}},"doc":"Query the server for the latest state of a known group. If the account is not a member of the group, an UnknownGroupError is returned."},"InvalidGroupStateError":{"fields":{"message":{"type":"String"}},"error":true},"GetLinkedDevicesRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true}},"doc":"list all linked devices on a Signal account"},"LinkedDevices":{"fields":{"devices":{"list":true,"type":"DeviceInfo","version":"v1"}}},"JoinGroupRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"uri":{"type":"String","doc":"The signal.group URL","example":"\"https://signal.group/#CjQKINH_GZhXhfifTcnBkaKTNRxW-hHKnGSq-cJNyPVqHRp8EhDUB7zjKNEl0NaULhsqJCX3\"","required":true}},"doc":"Join a group using the a signal.group URL. Note that you must have a profile name set to join groups."},"JsonGroupJoinInfo":{"fields":{"groupID":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""},"title":{"type":"String","example":"\"Parkdale Run Club\""},"description":{"type":"String","example":"\"A club for running in Parkdale\""},"memberCount":{"type":"int","example":"3"},"addFromInviteLink":{"type":"int","doc":"The access level required in order to join the group from the invite link, as an AccessControl.AccessRequired enum from the upstream Signal groups.proto file. This is UNSATISFIABLE (4) when the group link is disabled; ADMINISTRATOR (3) when the group link is enabled, but an administrator must approve new members; and ANY (1) when the group link is enabled and no approval is required. See theGroupAccessControl structure and the upstream enum ordinals."},"revision":{"type":"int","doc":"The Group V2 revision. This is incremented by clients whenever they update group information, and it is often used by clients to determine if the local group state is out-of-date with the server's revision.","example":"5"},"pendingAdminApproval":{"type":"boolean","doc":"Whether the account is waiting for admin approval in order to be added to the group."}}},"InvalidInviteURIError":{"fields":{"message":{"type":"String"}},"error":true},"GroupNotActiveError":{"fields":{"message":{"type":"String"}},"error":true},"RemoveLinkedDeviceRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"+12024561414\"","required":true},"deviceId":{"type":"long","doc":"the ID of the device to unlink","example":"3","required":true}},"doc":"Remove a linked device from the Signal account. Only allowed when the local device id is 1"},"UpdateGroupRequest":{"fields":{"account":{"type":"String","doc":"The identifier of the account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"groupID":{"type":"String","doc":"the ID of the group to update","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"","required":true},"title":{"type":"String","example":"\"Parkdale Run Club\""},"description":{"type":"String","doc":"A new group description. Set to empty string to remove an existing description.","example":"\"A club for running in Parkdale\""},"avatar":{"type":"String","example":"\"/tmp/image.jpg\""},"updateTimer":{"type":"int","doc":"update the group timer."},"addMembers":{"list":true,"type":"JsonAddress","version":"v1"},"removeMembers":{"list":true,"type":"JsonAddress","version":"v1"},"updateRole":{"type":"GroupMember","version":"v1"},"updateAccessControl":{"type":"GroupAccessControl","version":"v1","doc":"note that only one of the access controls may be updated per request"},"resetLink":{"type":"boolean","doc":"regenerate the group link password, invalidating the old one"},"announcements":{"type":"String","doc":"ENABLED to only allow admins to post messages, DISABLED to allow anyone to post"}},"doc":"modify a group. Note that only one modification action may be performed at once"},"GroupInfo":{"fields":{"v1":{"type":"JsonGroupInfo","version":"v1"},"v2":{"type":"JsonGroupV2Info","version":"v1"}},"doc":"A generic type that is used when the group version is not known"},"UnsupportedGroupError":{"fields":{"message":{"type":"String"}},"doc":"returned in response to use v1 groups, which are no longer supported","error":true},"SetProfile":{"fields":{"account":{"type":"String","doc":"The phone number of the account to use","example":"\"+12024561414\"","required":true},"name":{"type":"String","doc":"Change the profile name","example":"\"signald user\""},"avatarFile":{"type":"String","doc":"Path to new profile avatar file. If unset or null, unset the profile avatar","example":"\"/tmp/image.jpg\""},"about":{"type":"String","doc":"Change the 'about' profile field"},"emoji":{"type":"String","doc":"Change the profile emoji"},"mobilecoin_address":{"type":"String","doc":"Change the profile payment address. Payment address must be a *base64-encoded* MobileCoin address. Note that this is not the traditional MobileCoin address encoding, which is custom. Clients are responsible for converting between MobileCoin's custom base58 on the user-facing side and base64 encoding on the signald side."},"visible_badge_ids":{"list":true,"type":"String","doc":"configure visible badge IDs"}}},"InvalidBase64Error":{"fields":{"message":{"type":"String"}},"error":true},"ResolveAddressRequest":{"fields":{"account":{"type":"String","doc":"The signal account to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"partial":{"type":"JsonAddress","version":"v1","doc":"The partial address, missing fields","required":true}},"doc":"Resolve a partial JsonAddress with only a number or UUID to one with both. Anywhere that signald accepts a JsonAddress will except a partial, this is a convenience function for client authors, mostly because signald doesn't resolve all the partials it returns."},"JsonAddress":{"fields":{"number":{"type":"String","doc":"An e164 phone number, starting with +. Currently the only available user-facing Signal identifier.","example":"\"+13215551234\""},"uuid":{"type":"UUID","doc":"A UUID, the unique identifier for a particular Signal account."},"relay":{"type":"String"}}},"MarkReadRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"to":{"type":"JsonAddress","version":"v1","doc":"The address that sent the message being marked as read","required":true},"timestamps":{"list":true,"type":"Long","doc":"List of messages to mark as read","example":"1615576442475","required":true},"when":{"type":"Long"}}},"ProofRequiredError":{"fields":{"token":{"type":"String"},"options":{"list":true,"type":"String","doc":"possible list values are RECAPTCHA and PUSH_CHALLENGE"},"message":{"type":"String"},"retry_after":{"type":"long","doc":"value in seconds"}},"error":true},"GetProfileRequest":{"fields":{"account":{"type":"String","doc":"the signald account to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"async":{"type":"boolean","doc":"if true, return results from local store immediately, refreshing from server in the background if needed. if false (default), block until profile can be retrieved from server"},"address":{"type":"JsonAddress","version":"v1","doc":"the address to look up","required":true}},"doc":"Get all information available about a user"},"Profile":{"fields":{"name":{"type":"String","doc":"The user's name from local contact names if available, or if not in contact list their Signal profile name"},"avatar":{"type":"String","doc":"path to avatar on local disk"},"address":{"type":"JsonAddress","version":"v1"},"capabilities":{"type":"Capabilities","version":"v1"},"color":{"type":"String","doc":"color of the chat with this user"},"about":{"type":"String"},"emoji":{"type":"String"},"contact_name":{"type":"String","doc":"The user's name from local contact names"},"profile_name":{"type":"String","doc":"The user's Signal profile name"},"inbox_position":{"type":"int"},"expiration_time":{"type":"int"},"mobilecoin_address":{"type":"String","doc":"*base64-encoded* mobilecoin address. Note that this is not the traditional MobileCoin address encoding. Clients are responsible for converting between MobileCoin's custom base58 on the user-facing side and base64 encoding on the signald side. If unset, null or an empty string, will empty the profile payment address"},"visible_badge_ids":{"list":true,"type":"String","doc":"currently unclear how these work, as they are not available in the production Signal apps"}},"doc":"Information about a Signal user"},"ProfileUnavailableError":{"fields":{"message":{"type":"String"}},"error":true},"ListGroupsRequest":{"fields":{"account":{"type":"String","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true}}},"GroupList":{"fields":{"groups":{"list":true,"type":"JsonGroupV2Info","version":"v1"},"legacyGroups":{"list":true,"type":"JsonGroupInfo","version":"v1","doc":"list of legacy (v1) groups, no longer supported (will always be empty)"}}},"ListContactsRequest":{"fields":{"account":{"type":"String","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"async":{"type":"boolean","doc":"return results from local store immediately, refreshing from server afterward if needed. If false (default), block until all pending profiles have been retrieved."}}},"ProfileList":{"fields":{"profiles":{"list":true,"type":"Profile","version":"v1"}}},"CreateGroupRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"title":{"type":"String","example":"\"Parkdale Run Club\"","required":true},"avatar":{"type":"String","example":"\"/tmp/image.jpg\""},"members":{"list":true,"type":"JsonAddress","version":"v1","required":true},"timer":{"type":"int","doc":"the message expiration timer"},"member_role":{"type":"String","doc":"The role of all members other than the group creator. Options are ADMINISTRATOR or DEFAULT (case insensitive)","example":"\"ADMINISTRATOR\""}}},"NoKnownUUIDError":{"fields":{"message":{"type":"String"}},"error":true},"LeaveGroupRequest":{"fields":{"account":{"type":"String","doc":"The account to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"groupID":{"type":"String","doc":"The group to leave","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"","required":true}}},"GenerateLinkingURIRequest":{"fields":{"server":{"type":"String","doc":"The identifier of the server to use. Leave blank for default (usually Signal production servers but configurable at build time)"}},"doc":"Generate a linking URI. Typically this is QR encoded and scanned by the primary device. Submit the returned session_id with a finish_link request."},"LinkingURI":{"fields":{"uri":{"type":"String"},"session_id":{"type":"String"}}},"FinishLinkRequest":{"fields":{"overwrite":{"type":"boolean","doc":"overwrite existing account data if the phone number conflicts. false by default"},"device_name":{"type":"String"},"session_id":{"type":"String"}},"doc":"After a linking URI has been requested, finish_link must be called with the session_id provided with the URI. it will return information about the new account once the linking process is completed by the other device and the new account is setup. Note that the account setup process can sometimes take some time, if rapid userfeedback is required after scanning, use wait_for_scan first, then finish setup with finish_link."},"Account":{"fields":{"address":{"type":"JsonAddress","version":"v1","doc":"The address of this account"},"pending":{"type":"Boolean","doc":"indicates the account has not completed registration"},"pni":{"type":"String"},"device_id":{"type":"int","doc":"The Signal device ID. Official Signal mobile clients (iPhone and Android) have device ID = 1, while linked devices such as Signal Desktop or Signal iPad have higher device IDs."},"account_id":{"type":"String","doc":"The primary identifier on the account, included with all requests to signald for this account. Previously called 'username'"}},"doc":"A local account in signald"},"NoSuchSessionError":{"fields":{"message":{"type":"String"}},"error":true},"UserAlreadyExistsError":{"fields":{"uuid":{"type":"UUID"},"message":{"type":"String"}},"error":true},"ScanTimeoutError":{"fields":{"message":{"type":"String"}},"error":true},"AddLinkedDeviceRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"uri":{"type":"String","doc":"the sgnl://linkdevice uri provided (typically in qr code form) by the new device","example":"\"sgnl://linkdevice?uuid=jAaZ5lxLfh7zVw5WELd6-Q&pub_key=BfFbjSwmAgpVJBXUdfmSgf61eX3a%2Bq9AoxAVpl1HUap9\"","required":true}},"doc":"Link a new device to a local Signal account"},"RegisterRequest":{"fields":{"account":{"type":"String","doc":"the e164 phone number to register with","example":"\"+12024561414\"","required":true},"voice":{"type":"boolean","doc":"set to true to request a voice call instead of an SMS for verification"},"captcha":{"type":"String","doc":"See https://signald.org/articles/captcha/"},"server":{"type":"String","doc":"The identifier of the server to use. Leave blank for default (usually Signal production servers but configurable at build time)"}},"doc":"begin the account registration process by requesting a phone number verification code. when the code is received, submit it with a verify request"},"CaptchaRequiredError":{"fields":{"more":{"type":"String"},"message":{"type":"String"}},"error":true},"VerifyRequest":{"fields":{"account":{"type":"String","doc":"the e164 phone number being verified","example":"\"+12024561414\"","required":true},"code":{"type":"String","doc":"the verification code, dash (-) optional","example":"\"555555\"","required":true}},"doc":"verify an account's phone number with a code after registering, completing the account creation process"},"AccountHasNoKeysError":{"fields":{"message":{"type":"String"}},"error":true},"AccountAlreadyVerifiedError":{"fields":{"message":{"type":"String"}},"error":true},"AccountLockedError":{"fields":{"more":{"type":"String"},"message":{"type":"String"}},"error":true},"GetIdentitiesRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"address":{"type":"JsonAddress","version":"v1","doc":"address to get keys for","required":true}},"doc":"Get information about a known keys for a particular address"},"IdentityKeyList":{"fields":{"address":{"type":"JsonAddress","version":"v1"},"identities":{"list":true,"type":"IdentityKey","version":"v1"}},"doc":"a list of identity keys associated with a particular address"},"TrustRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"address":{"type":"JsonAddress","version":"v1","doc":"The user to query identity keys for","required":true},"safety_number":{"type":"String","doc":"required if qr_code_data is absent","example":"\"373453558586758076680580548714989751943247272727416091564451\""},"qr_code_data":{"type":"String","doc":"base64-encoded QR code data. required if safety_number is absent"},"trust_level":{"type":"String","doc":"One of TRUSTED_UNVERIFIED, TRUSTED_VERIFIED or UNTRUSTED. Default is TRUSTED_VERIFIED","example":"\"TRUSTED_VERIFIED\""}},"doc":"Trust another user's safety number using either the QR code data or the safety number text"},"FingerprintVersionMismatchError":{"fields":{"message":{"type":"String"}},"error":true},"UnknownIdentityKeyError":{"fields":{"message":{"type":"String"}},"error":true},"InvalidFingerprintError":{"fields":{"message":{"type":"String"}},"error":true},"DeleteAccountRequest":{"fields":{"account":{"type":"String","doc":"The account to delete","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"server":{"type":"boolean","doc":"delete account information from the server as well (default false)"}},"doc":"delete all account data signald has on disk, and optionally delete the account from the server as well. Note that this is not \"unlink\" and will delete the entire account, even from a linked device."},"TypingRequest":{"fields":{"account":{"type":"String","doc":"The account to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"address":{"type":"JsonAddress","version":"v1"},"group":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""},"typing":{"type":"boolean","example":"true","required":true},"when":{"type":"long"}},"doc":"send a typing started or stopped message"},"InvalidGroupError":{"fields":{"message":{"type":"String"}},"error":true},"ResetSessionRequest":{"fields":{"account":{"type":"String","doc":"The account to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"address":{"type":"JsonAddress","version":"v1","doc":"the user to reset session with","required":true},"timestamp":{"type":"Long"}},"doc":"reset a session with a particular user"},"RequestSyncRequest":{"fields":{"groups":{"type":"boolean","doc":"request group sync (default true)"},"configuration":{"type":"boolean","doc":"request configuration sync (default true)"},"contacts":{"type":"boolean","doc":"request contact sync (default true)"},"blocked":{"type":"boolean","doc":"request block list sync (default true)"},"keys":{"type":"boolean","doc":"request storage service keys"},"account":{"type":"String","doc":"The account to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true}},"doc":"Request other devices on the account send us their group list, syncable config and contact list."},"ListAccountsRequest":{"fields":{},"doc":"return all local accounts"},"AccountList":{"fields":{"accounts":{"list":true,"type":"Account","version":"v1"}}},"GroupLinkInfoRequest":{"fields":{"account":{"type":"String","doc":"The account to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"uri":{"type":"String","doc":"the signald.group link","example":"\"https://signal.group/#CjQKINH_GZhXhfifTcnBkaKTNRxW-hHKnGSq-cJNyPVqHRp8EhDUB7zjKNEl0NaULhsqJCX3\"","required":true}},"doc":"Get information about a group from a signal.group link"},"GroupLinkNotActiveError":{"fields":{"message":{"type":"String"}},"error":true},"UpdateContactRequest":{"fields":{"account":{"type":"String","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"address":{"type":"JsonAddress","version":"v1","required":true},"name":{"type":"String"},"color":{"type":"String"},"inbox_position":{"type":"int"}},"doc":"update information about a local contact"},"SetExpirationRequest":{"fields":{"account":{"type":"String","doc":"The account to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"address":{"type":"JsonAddress","version":"v1"},"group":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""},"expiration":{"type":"int","example":"604800","required":true}},"doc":"Set the message expiration timer for a thread. Expiration must be specified in seconds, set to 0 to disable timer"},"SetDeviceNameRequest":{"fields":{"account":{"type":"String","doc":"The account to set the device name of","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"device_name":{"type":"String","doc":"The device name"}},"doc":"set this device's name. This will show up on the mobile device on the same account under settings -> linked devices"},"GetAllIdentities":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"+12024561414\"","required":true}},"doc":"get all known identity keys"},"AllIdentityKeyList":{"fields":{"identity_keys":{"list":true,"type":"IdentityKeyList","version":"v1"}}},"SubscribeRequest":{"fields":{"account":{"type":"String","doc":"The account to subscribe to incoming message for","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true}},"doc":"receive incoming messages. After making a subscribe request, incoming messages will be sent to the client encoded as ClientMessageWrapper. Send an unsubscribe request or disconnect from the socket to stop receiving messages."},"UnsubscribeRequest":{"fields":{"account":{"type":"String","doc":"The account to unsubscribe from","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true}},"doc":"See subscribe for more info"},"RemoteDeleteRequest":{"fields":{"account":{"type":"String","doc":"the account to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"address":{"type":"JsonAddress","version":"v1","doc":"the address to send the delete message to. should match address the message to be deleted was sent to. required if group is not set."},"group":{"type":"String","doc":"the group to send the delete message to. should match group the message to be deleted was sent to. required if address is not set.","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""},"timestamp":{"type":"long","required":true},"members":{"list":true,"type":"JsonAddress","version":"v1","doc":"Optionally set to a sub-set of group members. Ignored if group isn't specified"}},"doc":"delete a message previously sent"},"AddServerRequest":{"fields":{"server":{"type":"Server","version":"v1","required":true}},"doc":"add a new server to connect to. Returns the new server's UUID."},"GetServersRequest":{"fields":{}},"ServerList":{"fields":{"servers":{"list":true,"type":"Server","version":"v1"}}},"RemoveServerRequest":{"fields":{"uuid":{"type":"String"}}},"SendPaymentRequest":{"fields":{"account":{"type":"String","doc":"the account to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"address":{"type":"JsonAddress","version":"v1","doc":"the address to send the payment message to","required":true},"payment":{"type":"Payment","version":"v1","required":true},"when":{"type":"Long"}},"doc":"send a mobilecoin payment"},"RemoteConfigRequest":{"fields":{"account":{"type":"String","doc":"The account to use to retrieve the remote config","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true}},"doc":"Retrieves the remote config (feature flags) from the server."},"RemoteConfigList":{"fields":{"config":{"list":true,"type":"RemoteConfig","version":"v1"}}},"RefuseMembershipRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"members":{"list":true,"type":"JsonAddress","version":"v1","doc":"list of requesting members to refuse","required":true},"group_id":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"","required":true},"also_ban":{"type":"boolean"}},"doc":"deny a request to join a group"},"SubmitChallengeRequest":{"fields":{"account":{"type":"String","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"challenge":{"type":"String","required":true},"captcha_token":{"type":"String"}}},"IsIdentifierRegisteredRequest":{"fields":{"account":{"type":"String","doc":"The account to use to use","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"identifier":{"type":"String","doc":"The UUID of an identifier to check if it is registered on Signal. This UUID is either a Phone Number Identity (PNI) or an Account Identity (ACI).","example":"\"aeed01f0-a234-478e-8cf7-261c283151e7\"","required":true}},"doc":"Determine whether an account identifier is registered on the Signal service."},"BooleanMessage":{"fields":{"value":{"type":"boolean"}},"doc":"A message containing a single boolean, usually as a response"},"WaitForScanRequest":{"fields":{"session_id":{"type":"String"}},"doc":"An optional part of the linking process. Intended to be called after displaying the QR code, will return quickly after the user scans the QR code. finish_link must be called after wait_for_scan returns a non-error"},"GetGroupRevisionPagesRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"group_id":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"","required":true},"from_revision":{"type":"int","doc":"The revision to start the pages from. Note that if this is lower than the revision you joined the group, an AuthorizationFailedError is returned.","required":true},"include_first_revision":{"type":"boolean","doc":"Whether to include the first state in the returned pages (default false)"}},"doc":"Query the server for group revision history. The history contains information about the changes between each revision and the user that made the change."},"GroupHistoryPage":{"fields":{"results":{"list":true,"type":"GroupHistoryEntry","version":"v1"},"paging_data":{"type":"PagingData","version":"v1"}},"doc":"The result of fetching a group's history along with paging data."},"SendSyncMessageRequest":{"fields":{"account":{"type":"String","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"view_once_open_message":{"type":"JsonViewOnceOpenMessage","version":"v1","doc":"This can be set to indicate to other devices about having viewed a view-once message."},"message_request_response":{"type":"JsonMessageRequestResponseMessage","version":"v1","doc":"This can be set to indicate to other devices about a response to an incoming message request from an unknown user or group. Warning: Using the BLOCK and BLOCK_AND_DELETE options relies on other devices to do the blocking, and it does not make you leave the group!"}},"doc":"Sends a sync message to the account's devices"},"JsonSendMessageResult":{"fields":{"address":{"type":"JsonAddress","version":"v1"},"success":{"type":"SendSuccess","version":"v1"},"networkFailure":{"type":"boolean","example":"false"},"unregisteredFailure":{"type":"boolean","example":"false"},"identityFailure":{"type":"String"},"proof_required_failure":{"type":"ProofRequiredError","version":"v1"}}},"BanUserRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"group_id":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"","required":true},"users":{"list":true,"type":"JsonAddress","version":"v1","doc":"List of users to ban","required":true}},"doc":"Bans users from a group. This works even if the users aren't in the group. If they are currently in the group, they will also be removed."},"UnbanUserRequest":{"fields":{"account":{"type":"String","doc":"The account to interact with","example":"\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\"","required":true},"group_id":{"type":"String","example":"\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"","required":true},"users":{"list":true,"type":"JsonAddress","version":"v1","doc":"List of users to unban","required":true}},"doc":"Unbans users from a group."},"IdentityKey":{"fields":{"added":{"type":"long","doc":"the first time this identity key was seen"},"safety_number":{"type":"String","example":"\"373453558586758076680580548714989751943247272727416091564451\""},"qr_code_data":{"type":"String","doc":"base64-encoded QR code data"},"trust_level":{"type":"String","doc":"One of TRUSTED_UNVERIFIED, TRUSTED_VERIFIED or UNTRUSTED"}}},"JsonDataMessage":{"fields":{"timestamp":{"type":"long","doc":"the timestamp that the message was sent at, according to the sender's device. This is used to uniquely identify this message for things like reactions and quotes.","example":"1615576442475"},"attachments":{"list":true,"type":"JsonAttachment","version":"v1","doc":"files attached to the incoming message"},"body":{"type":"String","doc":"the text body of the incoming message.","example":"\"hello\""},"group":{"type":"JsonGroupInfo","version":"v1","doc":"if the incoming message was sent to a v1 group, information about that group will be here"},"groupV2":{"type":"JsonGroupV2Info","version":"v1","doc":"if the incoming message was sent to a v2 group, basic identifying information about that group will be here. If group information changes, JsonGroupV2Info.revision is incremented. If the group revision is higher than previously seen, a client can retrieve the group information by calling get_group."},"endSession":{"type":"boolean"},"expiresInSeconds":{"type":"int","doc":"the expiry timer on the incoming message. Clients should delete records of the message within this number of seconds"},"profileKeyUpdate":{"type":"boolean"},"quote":{"type":"JsonQuote","version":"v1","doc":"if the incoming message is a quote or reply to another message, this will contain information about that message"},"contacts":{"list":true,"type":"SharedContact","version":"v1","doc":"if the incoming message has a shared contact, the contact's information will be here"},"previews":{"list":true,"type":"JsonPreview","version":"v1","doc":"if the incoming message has a link preview, information about that preview will be here"},"sticker":{"type":"JsonSticker","version":"v0","doc":"if the incoming message is a sticker, information about the sicker will be here"},"viewOnce":{"type":"boolean","doc":"indicates the message is a view once message. View once messages typically include no body and a single image attachment. Official Signal clients will prevent the user from saving the image, and once the user has viewed the image once they will destroy the image."},"reaction":{"type":"JsonReaction","version":"v1","doc":"if the message adds or removes a reaction to another message, this will indicate what change is being made"},"remoteDelete":{"type":"RemoteDelete","version":"v1","doc":"if the inbound message is deleting a previously sent message, indicates which message should be deleted"},"mentions":{"list":true,"type":"JsonMention","version":"v1","doc":"list of mentions in the message"},"payment":{"type":"Payment","version":"v1","doc":"details about the MobileCoin payment attached to the message, if present"},"is_expiration_update":{"type":"boolean","doc":"whether or not this message changes the expiresInSeconds value for the whole chat. Some messages (remote deletes, reactions, etc) will have expiresInSeconds=0 even though the chat has disappearing messages enabled."},"group_call_update":{"type":"String","doc":"the eraId string from a group call message update"},"story_context":{"type":"StoryContext","version":"v1"}}},"JsonSyncMessage":{"fields":{"sent":{"type":"JsonSentTranscriptMessage","version":"v1"},"contacts":{"type":"JsonAttachment","version":"v1"},"contactsComplete":{"type":"boolean"},"groups":{"type":"JsonAttachment","version":"v1"},"blockedList":{"type":"JsonBlockedListMessage","version":"v1"},"request":{"type":"String"},"readMessages":{"list":true,"type":"JsonReadMessage","version":"v1"},"viewOnceOpen":{"type":"JsonViewOnceOpenMessage","version":"v1"},"verified":{"type":"JsonVerifiedMessage","version":"v1"},"configuration":{"type":"ConfigurationMessage","version":"v0"},"stickerPackOperations":{"list":true,"type":"JsonStickerPackOperationMessage","version":"v0"},"fetchType":{"type":"String"},"messageRequestResponse":{"type":"JsonMessageRequestResponseMessage","version":"v1"}}},"CallMessage":{"fields":{"offer_message":{"type":"OfferMessage","version":"v1"},"answer_message":{"type":"AnswerMessage","version":"v1"},"busy_message":{"type":"BusyMessage","version":"v1"},"hangup_message":{"type":"HangupMessage","version":"v1"},"ice_update_message":{"list":true,"type":"IceUpdateMessage","version":"v1"},"destination_device_id":{"type":"int"},"multi_ring":{"type":"boolean"}}},"ReceiptMessage":{"fields":{"type":{"type":"String","doc":"options: UNKNOWN, DELIVERY, READ, VIEWED"},"timestamps":{"list":true,"type":"Long"},"when":{"type":"long"}}},"TypingMessage":{"fields":{"action":{"type":"String"},"timestamp":{"type":"long"},"group_id":{"type":"String"}}},"StoryMessage":{"fields":{"group":{"type":"JsonGroupV2Info","version":"v1"},"file":{"type":"JsonAttachment","version":"v1"},"text":{"type":"TextAttachment","version":"v1"},"allow_replies":{"type":"Boolean"}}},"JsonAttachment":{"fields":{"contentType":{"type":"String"},"id":{"type":"String"},"size":{"type":"int"},"storedFilename":{"type":"String","doc":"when receiving, the path that file has been downloaded to"},"filename":{"type":"String","doc":"when sending, the path to the local file to upload"},"customFilename":{"type":"String","doc":"the original name of the file"},"caption":{"type":"String"},"width":{"type":"int"},"height":{"type":"int"},"voiceNote":{"type":"boolean"},"key":{"type":"String"},"digest":{"type":"String"},"blurhash":{"type":"String"}},"doc":"represents a file attached to a message. When sending, only `filename` is required."},"JsonQuote":{"fields":{"id":{"type":"long","doc":"the client timestamp of the message being quoted","example":"1615576442475"},"author":{"type":"JsonAddress","version":"v1","doc":"the author of the message being quoted"},"text":{"type":"String","doc":"the body of the message being quoted","example":"\"hey  what's up?\""},"attachments":{"list":true,"type":"JsonQuotedAttachment","version":"v0","doc":"list of files attached to the quoted message"},"mentions":{"list":true,"type":"JsonMention","version":"v1","doc":"list of mentions in the quoted message"}},"doc":"A quote is a reply to a previous message. ID is the sent time of the message being replied to"},"JsonMention":{"fields":{"uuid":{"type":"String","doc":"The UUID of the account being mentioned","example":"\"aeed01f0-a234-478e-8cf7-261c283151e7\""},"start":{"type":"int","doc":"The number of characters in that the mention starts at. Note that due to a quirk of how signald encodes JSON, if this value is 0 (for example if the first character in the message is the mention) the field won't show up.","example":"4"},"length":{"type":"int","doc":"The length of the mention represented in the message. Seems to always be 1 but included here in case that changes.","example":"1"}}},"JsonPreview":{"fields":{"url":{"type":"String"},"title":{"type":"String"},"description":{"type":"String"},"date":{"type":"long"},"attachment":{"type":"JsonAttachment","version":"v1","doc":"an optional image file attached to the preview"}},"doc":"metadata about one of the links in a message"},"JsonReaction":{"fields":{"emoji":{"type":"String","doc":"the emoji to react with","example":"\"👍\""},"remove":{"type":"boolean","doc":"set to true to remove the reaction. requires emoji be set to previously reacted emoji"},"targetAuthor":{"type":"JsonAddress","version":"v1","doc":"the author of the message being reacted to"},"targetSentTimestamp":{"type":"long","doc":"the client timestamp of the message being reacted to","example":"1615576442475"}}},"GroupAccessControl":{"fields":{"link":{"type":"String","doc":"UNSATISFIABLE when the group link is disabled, ADMINISTRATOR when the group link is enabled but an administrator must approve new members, ANY when the group link is enabled and no approval is required","example":"\"ANY\""},"attributes":{"type":"String","doc":"who can edit group info"},"members":{"type":"String","doc":"who can add members"}},"doc":"group access control settings. Options for each controlled action are: UNKNOWN, ANY, MEMBER, ADMINISTRATOR, UNSATISFIABLE and UNRECOGNIZED"},"GroupMember":{"fields":{"uuid":{"type":"String","example":"\"aeed01f0-a234-478e-8cf7-261c283151e7\""},"role":{"type":"String","doc":"possible values are: UNKNOWN, DEFAULT, ADMINISTRATOR and UNRECOGNIZED","example":"\"DEFAULT\""},"joined_revision":{"type":"int"}}},"BannedGroupMember":{"fields":{"uuid":{"type":"String","example":"\"aeed01f0-a234-478e-8cf7-261c283151e7\""},"timestamp":{"type":"long","doc":"Timestamp as milliseconds since Unix epoch of when the user was banned. This field is set by the server."}}},"GroupChange":{"fields":{"editor":{"type":"JsonAddress","version":"v1","doc":"The user that made the change."},"revision":{"type":"int","doc":"The group revision that this change brings the group to."},"new_members":{"list":true,"type":"GroupMember","version":"v1","doc":"Represents users have been added to the group. This can be from group members adding users, or a users joining via a group link that required no approval."},"delete_members":{"list":true,"type":"JsonAddress","version":"v1","doc":"Represents users that have been removed from the group. This can be from admins removing users, or users choosing to leave the group"},"modify_member_roles":{"list":true,"type":"GroupMember","version":"v1","doc":"Represents users with their new, modified role."},"modified_profile_keys":{"list":true,"type":"GroupMember","version":"v1","doc":"Represents users that have rotated their profile key. Note that signald currently does not expose profile keys to clients. The joined revision property will always be 0 in this list."},"new_pending_members":{"list":true,"type":"GroupPendingMember","version":"v1","doc":"Represents a user that has been invited to the group by another user."},"delete_pending_members":{"list":true,"type":"JsonAddress","version":"v1"},"promote_pending_members":{"list":true,"type":"GroupMember","version":"v1"},"new_banned_members":{"list":true,"type":"BannedGroupMember","version":"v1"},"new_unbanned_members":{"list":true,"type":"BannedGroupMember","version":"v1"},"new_title":{"type":"String"},"new_avatar":{"type":"Boolean","doc":"Whether this group change changed the avatar."},"new_timer":{"type":"int","doc":"New disappearing messages timer value."},"new_access_control":{"type":"GroupAccessControl","version":"v1","doc":"If not null, then this group change modified one of the access controls. Some of the properties in here will be null."},"new_requesting_members":{"list":true,"type":"GroupRequestingMember","version":"v1","doc":"Represents users that have requested to join the group via the group link. Note that members requesting to join might not necessarily have the list of users in the group, so they won't be able to send a peer-to-peer group update message to inform users of their request to join. Other users in the group may inform us that the revision has increased, but the members requesting access will have to be obtained from the server instead (which signald will handle). For now, a get_group request has to be made to get the users that have requested to join the group."},"delete_requesting_members":{"list":true,"type":"JsonAddress","version":"v1"},"promote_requesting_members":{"list":true,"type":"GroupMember","version":"v1"},"new_invite_link_password":{"type":"Boolean","doc":"Whether this group change involved resetting the group invite link."},"new_description":{"type":"String"},"new_is_announcement_group":{"type":"String","doc":"Whether this change affected the announcement group setting. Possible values are UNKNOWN, ENABLED or DISABLED"}},"doc":"Represents a group change made by a user. This can also represent request link invites. Only the fields relevant to the group change performed will be set. Note that in signald, group changes are currently only received from incoming messages from a message subscription."},"DeviceInfo":{"fields":{"id":{"type":"long"},"name":{"type":"String"},"created":{"type":"long"},"lastSeen":{"type":"long"}}},"JsonGroupInfo":{"fields":{"groupId":{"type":"String"},"members":{"list":true,"type":"JsonAddress","version":"v1"},"name":{"type":"String"},"type":{"type":"String"},"avatarId":{"type":"long"}},"doc":"information about a legacy group"},"Capabilities":{"fields":{"gv2":{"type":"boolean","doc":"this capability is deprecated and will always be true"},"storage":{"type":"boolean"},"stories":{"type":"boolean"},"gv1-migration":{"type":"boolean"},"sender_key":{"type":"boolean"},"announcement_group":{"type":"boolean"},"change_number":{"type":"boolean"}}},"Server":{"fields":{"uuid":{"type":"UUID","doc":"A unique identifier for the server, referenced when adding accounts. Must be a valid UUID. Will be generated if not specified when creating."},"proxy":{"type":"String"},"ca":{"type":"String","doc":"base64 encoded trust store, password must be 'whisper'"},"service_url":{"type":"String"},"cdn_urls":{"list":true,"type":"ServerCDN","version":"v1"},"contact_discovery_url":{"type":"String"},"key_backup_url":{"type":"String"},"storage_url":{"type":"String"},"zk_param":{"type":"String","doc":"base64 encoded ZKGROUP_SERVER_PUBLIC_PARAMS value"},"unidentified_sender_root":{"type":"String","doc":"base64 encoded"},"key_backup_service_name":{"type":"String"},"key_backup_service_id":{"type":"String","doc":"base64 encoded"},"key_backup_mrenclave":{"type":"String"},"cds_mrenclave":{"type":"String"},"ias_ca":{"type":"String","doc":"base64 encoded trust store, password must be 'whisper'"}},"doc":"a Signal server"},"Payment":{"fields":{"receipt":{"type":"String","doc":"base64 encoded payment receipt data. This is a protobuf value which can be decoded as the Receipt object described in https://github.com/mobilecoinfoundation/mobilecoin/blob/master/api/proto/external.proto"},"note":{"type":"String","doc":"note attached to the payment"}},"doc":"details about a MobileCoin payment"},"RemoteConfig":{"fields":{"name":{"type":"String","doc":"The name of this remote config entry. These names may be prefixed with the platform type (\"android.\", \"ios.\", \"desktop.\", etc.) Typically, clients only handle the relevant configs for its platform, hardcoding the names it cares about handling and ignoring the rest.","example":"desktop.mediaQuality.levels"},"value":{"type":"String","doc":"The value for this remote config entry. Even though this is a string, it could be a boolean as a string, an integer/long value, a comma-delimited list, etc. Clients usually consume this by hardcoding the feature flagsit should track in the app and assuming that the server will send the type that the client expects. If an unexpected type occurs, it falls back to a default value.","example":"1:2,61:2,81:2,82:2,65:2,31:2,47:2,41:2,32:2,385:2,971:2,974:2,49:2,33:2,*:1"}},"doc":"A remote config (feature flag) entry."},"GroupHistoryEntry":{"fields":{"group":{"type":"JsonGroupV2Info","version":"v1"},"change":{"type":"GroupChange","version":"v1"}}},"PagingData":{"fields":{"has_more_pages":{"type":"boolean"},"next_page_revision":{"type":"int"}}},"JsonViewOnceOpenMessage":{"fields":{"sender":{"type":"JsonAddress","version":"v1"},"timestamp":{"type":"long","example":"1615576442475"}}},"JsonMessageRequestResponseMessage":{"fields":{"person":{"type":"JsonAddress","version":"v1"},"groupId":{"type":"String"},"type":{"type":"String","doc":"One of UNKNOWN, ACCEPT, DELETE, BLOCK, BLOCK_AND_DELETE, UNBLOCK_AND_ACCEPT"}},"doc":"Responses to message requests from unknown users or groups"},"SendSuccess":{"fields":{"unidentified":{"type":"boolean"},"needsSync":{"type":"boolean"},"duration":{"type":"long"},"devices":{"list":true,"type":"int"}}},"SharedContact":{"fields":{"name":{"type":"SharedContactName","version":"v1","doc":"the name of the shared contact"},"email":{"list":true,"type":"SharedContactEmail","version":"v1","doc":"the email addresses of the shared contact"},"phone":{"list":true,"type":"SharedContactPhone","version":"v1","doc":"the phone numbers of the shared contact"},"address":{"list":true,"type":"SharedContactAddress","version":"v1","doc":"the physical addresses of the shared contact"},"avatar":{"type":"SharedContactAvatar","version":"v1","doc":"the profile picture/avatar of the shared contact"},"organization":{"type":"String","doc":"the organization (e.g. workplace) of the shared contact"}}},"RemoteDelete":{"fields":{"target_sent_timestamp":{"type":"long"}}},"StoryContext":{"fields":{"author":{"type":"String"},"sent_timestamp":{"type":"long"}}},"JsonSentTranscriptMessage":{"fields":{"destination":{"type":"JsonAddress","version":"v1"},"timestamp":{"type":"long","example":"1615576442475"},"expirationStartTimestamp":{"type":"long"},"message":{"type":"JsonDataMessage","version":"v1"},"story":{"type":"StoryMessage","version":"v1"},"unidentifiedStatus":{"type":"Map"},"isRecipientUpdate":{"type":"boolean"}}},"JsonBlockedListMessage":{"fields":{"addresses":{"list":true,"type":"JsonAddress","version":"v1"},"groupIds":{"list":true,"type":"String"}}},"JsonReadMessage":{"fields":{"sender":{"type":"JsonAddress","version":"v1"},"timestamp":{"type":"long","example":"1615576442475"}}},"JsonVerifiedMessage":{"fields":{"destination":{"type":"JsonAddress","version":"v1"},"identityKey":{"type":"String"},"verified":{"type":"String"},"timestamp":{"type":"long"}}},"OfferMessage":{"fields":{"id":{"type":"long"},"sdp":{"type":"String"},"type":{"type":"String"},"opaque":{"type":"String"}}},"AnswerMessage":{"fields":{"id":{"type":"long"},"sdp":{"type":"String"},"opaque":{"type":"String"}}},"BusyMessage":{"fields":{"id":{"type":"long"}}},"HangupMessage":{"fields":{"id":{"type":"long"},"type":{"type":"String"},"legacy":{"type":"boolean"},"device_id":{"type":"int"}}},"IceUpdateMessage":{"fields":{"id":{"type":"long"},"opaque":{"type":"String"},"sdp":{"type":"String"}}},"TextAttachment":{"fields":{"text":{"type":"String"},"style":{"type":"String"},"preview":{"type":"JsonPreview","version":"v1"},"text_foreground_color":{"type":"String"},"text_background_color":{"type":"String"},"background_gradient":{"type":"Gradient","version":"v1"},"background_color":{"type":"String"}}},"GroupPendingMember":{"fields":{"uuid":{"type":"String","example":"\"aeed01f0-a234-478e-8cf7-261c283151e7\""},"role":{"type":"String","doc":"possible values are: UNKNOWN, DEFAULT, ADMINISTRATOR and UNRECOGNIZED","example":"\"DEFAULT\""},"timestamp":{"type":"long"},"added_by_uuid":{"type":"String","example":"\"aeed01f0-a234-478e-8cf7-261c283151e7\""}}},"GroupRequestingMember":{"fields":{"uuid":{"type":"String","example":"\"aeed01f0-a234-478e-8cf7-261c283151e7\""},"timestamp":{"type":"long"}}},"ServerCDN":{"fields":{"number":{"type":"int"},"url":{"type":"String"}}},"SharedContactName":{"fields":{"display":{"type":"String","doc":"the full name that should be displayed"},"given":{"type":"String","doc":"given name"},"middle":{"type":"String","doc":"middle name"},"family":{"type":"String","doc":"family name (surname)"},"prefix":{"type":"String"},"suffix":{"type":"String"}}},"SharedContactEmail":{"fields":{"type":{"type":"String","doc":"the type of email (options: HOME, WORK, MOBILE, CUSTOM)"},"value":{"type":"String","doc":"the email address"},"label":{"type":"String","doc":"the type label when type is CUSTOM"}}},"SharedContactPhone":{"fields":{"type":{"type":"String","doc":"the type of phone (options: HOME, WORK, MOBILE, CUSTOM)"},"value":{"type":"String","doc":"the phone number"},"label":{"type":"String","doc":"the type label when type is CUSTOM"}}},"SharedContactAddress":{"fields":{"type":{"type":"String","doc":"the type of address (options: HOME, WORK, CUSTOM)"},"label":{"type":"String"},"street":{"type":"String"},"pobox":{"type":"String"},"neighborhood":{"type":"String"},"city":{"type":"String"},"region":{"type":"String"},"postcode":{"type":"String"},"country":{"type":"String"}}},"SharedContactAvatar":{"fields":{"attachment":{"type":"JsonAttachment","version":"v1"},"is_profile":{"type":"boolean"}}},"Gradient":{"fields":{"start_color":{"type":"String"},"end_color":{"type":"String"}}}}},"actions":{"v1":{"send":{"request":"SendRequest","response":"SendResponse","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"NoSendPermissionError"},{"name":"InvalidAttachmentError"},{"name":"InternalError"},{"name":"InvalidRequestError"},{"name":"UnknownGroupError"},{"name":"RateLimitError"},{"name":"InvalidRecipientError"},{"name":"AttachmentTooLargeError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"react":{"request":"ReactRequest","response":"SendResponse","doc":"react to a previous message","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"InternalError"},{"name":"InvalidRecipientError"},{"name":"UnknownGroupError"},{"name":"InvalidRequestError"},{"name":"RateLimitError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"version":{"request":"VersionRequest","response":"JsonVersionMessage"},"accept_invitation":{"request":"AcceptInvitationRequest","response":"JsonGroupV2Info","doc":"Accept a v2 group invitation. Note that you must have a profile name set to join groups.","errors":[{"name":"NoSuchAccountError"},{"name":"OwnProfileKeyDoesNotExistError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"UnknownGroupError"},{"name":"InternalError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError","doc":"Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)."},{"name":"SQLError"},{"name":"GroupPatchNotAcceptedError","doc":"Caused when server rejects the group update."}]},"approve_membership":{"request":"ApproveMembershipRequest","response":"JsonGroupV2Info","doc":"approve a request to join a group","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"UnknownGroupError"},{"name":"InternalError"},{"name":"GroupVerificationError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError","doc":"Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)."},{"name":"SQLError"},{"name":"GroupPatchNotAcceptedError","doc":"Caused when server rejects the group update."}]},"get_group":{"request":"GetGroupRequest","response":"JsonGroupV2Info","doc":"Query the server for the latest state of a known group. If the account is not a member of the group, an UnknownGroupError is returned.","errors":[{"name":"NoSuchAccountError"},{"name":"UnknownGroupError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"InternalError"},{"name":"GroupVerificationError"},{"name":"InvalidGroupStateError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"get_linked_devices":{"request":"GetLinkedDevicesRequest","response":"LinkedDevices","doc":"list all linked devices on a Signal account","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"join_group":{"request":"JoinGroupRequest","response":"JsonGroupJoinInfo","doc":"Join a group using the a signal.group URL. Note that you must have a profile name set to join groups.","errors":[{"name":"InvalidRequestError"},{"name":"InvalidInviteURIError"},{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"OwnProfileKeyDoesNotExistError"},{"name":"GroupVerificationError"},{"name":"GroupNotActiveError"},{"name":"UnknownGroupError"},{"name":"InvalidGroupStateError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"remove_linked_device":{"request":"RemoveLinkedDeviceRequest","doc":"Remove a linked device from the Signal account. Only allowed when the local device id is 1","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"update_group":{"request":"UpdateGroupRequest","response":"GroupInfo","doc":"modify a group. Note that only one modification action may be performed at once","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"UnknownGroupError"},{"name":"GroupVerificationError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError","doc":"Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)."},{"name":"UnregisteredUserError"},{"name":"SQLError"},{"name":"GroupPatchNotAcceptedError","doc":"Caused when server rejects the group update, e.g. trying to add a user that's already in the group"},{"name":"UnsupportedGroupError"}]},"set_profile":{"request":"SetProfile","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"InvalidBase64Error"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"resolve_address":{"request":"ResolveAddressRequest","response":"JsonAddress","doc":"Resolve a partial JsonAddress with only a number or UUID to one with both. Anywhere that signald accepts a JsonAddress will except a partial, this is a convenience function for client authors, mostly because signald doesn't resolve all the partials it returns.","errors":[{"name":"InternalError"},{"name":"NoSuchAccountError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"mark_read":{"request":"MarkReadRequest","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"InternalError"},{"name":"UntrustedIdentityError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"},{"name":"InvalidRequestError"},{"name":"ProofRequiredError"}]},"get_profile":{"request":"GetProfileRequest","response":"Profile","doc":"Get all information available about a user","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"ProfileUnavailableError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"},{"name":"InvalidRequestError"}]},"list_groups":{"request":"ListGroupsRequest","response":"GroupList","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"list_contacts":{"request":"ListContactsRequest","response":"ProfileList","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"},{"name":"InvalidRequestError"}]},"create_group":{"request":"CreateGroupRequest","response":"JsonGroupV2Info","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"OwnProfileKeyDoesNotExistError"},{"name":"NoKnownUUIDError"},{"name":"InvalidRequestError"},{"name":"GroupVerificationError"},{"name":"InvalidGroupStateError"},{"name":"UnknownGroupError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"leave_group":{"request":"LeaveGroupRequest","response":"GroupInfo","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"InternalError"},{"name":"UnknownGroupError"},{"name":"GroupVerificationError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"generate_linking_uri":{"request":"GenerateLinkingURIRequest","response":"LinkingURI","doc":"Generate a linking URI. Typically this is QR encoded and scanned by the primary device. Submit the returned session_id with a finish_link request.","errors":[{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"}]},"finish_link":{"request":"FinishLinkRequest","response":"Account","doc":"After a linking URI has been requested, finish_link must be called with the session_id provided with the URI. it will return information about the new account once the linking process is completed by the other device and the new account is setup. Note that the account setup process can sometimes take some time, if rapid userfeedback is required after scanning, use wait_for_scan first, then finish setup with finish_link.","errors":[{"name":"NoSuchSessionError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"InternalError"},{"name":"NoSuchAccountError"},{"name":"UserAlreadyExistsError"},{"name":"ScanTimeoutError"}]},"add_device":{"request":"AddLinkedDeviceRequest","doc":"Link a new device to a local Signal account","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"InvalidRequestError","doc":"caused by syntax errors with the provided linking URI"},{"name":"InternalError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"register":{"request":"RegisterRequest","response":"Account","doc":"begin the account registration process by requesting a phone number verification code. when the code is received, submit it with a verify request","errors":[{"name":"CaptchaRequiredError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"}]},"verify":{"request":"VerifyRequest","response":"Account","doc":"verify an account's phone number with a code after registering, completing the account creation process","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"AccountHasNoKeysError"},{"name":"AccountAlreadyVerifiedError"},{"name":"AccountLockedError"},{"name":"NoSuchAccountError"}]},"get_identities":{"request":"GetIdentitiesRequest","response":"IdentityKeyList","doc":"Get information about a known keys for a particular address","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"trust":{"request":"TrustRequest","doc":"Trust another user's safety number using either the QR code data or the safety number text","errors":[{"name":"InvalidRequestError"},{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"FingerprintVersionMismatchError"},{"name":"InvalidBase64Error"},{"name":"UnknownIdentityKeyError"},{"name":"InvalidFingerprintError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"delete_account":{"request":"DeleteAccountRequest","doc":"delete all account data signald has on disk, and optionally delete the account from the server as well. Note that this is not \"unlink\" and will delete the entire account, even from a linked device.","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"SQLError"}]},"typing":{"request":"TypingRequest","doc":"send a typing started or stopped message","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"InvalidRecipientError"},{"name":"InvalidGroupError"},{"name":"UntrustedIdentityError"},{"name":"UnknownGroupError"},{"name":"InvalidRequestError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"reset_session":{"request":"ResetSessionRequest","response":"SendResponse","doc":"reset a session with a particular user","errors":[{"name":"InternalError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"NoSuchAccountError"},{"name":"InvalidRequestError"},{"name":"UnknownGroupError"},{"name":"RateLimitError"},{"name":"InvalidRecipientError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"request_sync":{"request":"RequestSyncRequest","doc":"Request other devices on the account send us their group list, syncable config and contact list.","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"UntrustedIdentityError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"list_accounts":{"request":"ListAccountsRequest","response":"AccountList","doc":"return all local accounts","errors":[{"name":"NoSuchAccountError"},{"name":"InternalError"}]},"group_link_info":{"request":"GroupLinkInfoRequest","response":"JsonGroupJoinInfo","doc":"Get information about a group from a signal.group link","errors":[{"name":"GroupLinkNotActiveError"},{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"InvalidRequestError"},{"name":"GroupVerificationError"},{"name":"SQLError"}]},"update_contact":{"request":"UpdateContactRequest","response":"Profile","doc":"update information about a local contact","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"InternalError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"set_expiration":{"request":"SetExpirationRequest","response":"SendResponse","doc":"Set the message expiration timer for a thread. Expiration must be specified in seconds, set to 0 to disable timer","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"UnknownGroupError"},{"name":"GroupVerificationError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError","doc":"Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)."},{"name":"UnregisteredUserError"},{"name":"SQLError"},{"name":"GroupPatchNotAcceptedError","doc":"If updating a group, caused when server rejects the group update."},{"name":"UnsupportedGroupError"}]},"set_device_name":{"request":"SetDeviceNameRequest","doc":"set this device's name. This will show up on the mobile device on the same account under settings -> linked devices","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"},{"name":"InvalidRequestError"}]},"get_all_identities":{"request":"GetAllIdentities","response":"AllIdentityKeyList","doc":"get all known identity keys","errors":[{"name":"InvalidProxyError"},{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InternalError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"subscribe":{"request":"SubscribeRequest","doc":"receive incoming messages. After making a subscribe request, incoming messages will be sent to the client encoded as ClientMessageWrapper. Send an unsubscribe request or disconnect from the socket to stop receiving messages.","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"InternalError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"unsubscribe":{"request":"UnsubscribeRequest","doc":"See subscribe for more info","errors":[{"name":"NoSuchAccountError"},{"name":"InternalError"},{"name":"SQLError"}]},"remote_delete":{"request":"RemoteDeleteRequest","response":"SendResponse","doc":"delete a message previously sent","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"InvalidRecipientError"},{"name":"UnknownGroupError"},{"name":"InvalidRequestError"},{"name":"RateLimitError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"add_server":{"request":"AddServerRequest","response":"String","doc":"add a new server to connect to. Returns the new server's UUID.","errors":[{"name":"InvalidProxyError"},{"name":"InternalError"}]},"get_servers":{"request":"GetServersRequest","response":"ServerList","errors":[{"name":"InternalError"}]},"delete_server":{"request":"RemoveServerRequest","errors":[{"name":"InternalError"}]},"send_payment":{"request":"SendPaymentRequest","response":"SendResponse","doc":"send a mobilecoin payment","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"InvalidBase64Error"},{"name":"InvalidRecipientError"},{"name":"UnknownGroupError"},{"name":"InvalidRequestError"},{"name":"RateLimitError"},{"name":"UnregisteredUserError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"get_remote_config":{"request":"RemoteConfigRequest","response":"RemoteConfigList","doc":"Retrieves the remote config (feature flags) from the server.","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"SQLError"}]},"refuse_membership":{"request":"RefuseMembershipRequest","response":"JsonGroupV2Info","doc":"deny a request to join a group","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"UnknownGroupError"},{"name":"GroupVerificationError"},{"name":"InternalError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError","doc":"Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)."},{"name":"UnregisteredUserError"},{"name":"SQLError"},{"name":"GroupPatchNotAcceptedError","doc":"Caused when server rejects the group update."}]},"submit_challenge":{"request":"SubmitChallengeRequest","errors":[{"name":"NoSuchAccountError"},{"name":"InvalidRequestError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"InternalError"},{"name":"SQLError"}]},"is_identifier_registered":{"request":"IsIdentifierRegisteredRequest","response":"BooleanMessage","doc":"Determine whether an account identifier is registered on the Signal service.","errors":[{"name":"InternalError"},{"name":"InvalidProxyError"},{"name":"ServerNotFoundError"},{"name":"NoSuchAccountError"},{"name":"SQLError"}]},"wait_for_scan":{"request":"WaitForScanRequest","doc":"An optional part of the linking process. Intended to be called after displaying the QR code, will return quickly after the user scans the QR code. finish_link must be called after wait_for_scan returns a non-error","errors":[{"name":"NoSuchSessionError"},{"name":"ScanTimeoutError"},{"name":"InternalError"}]},"get_group_revision_pages":{"request":"GetGroupRevisionPagesRequest","response":"GroupHistoryPage","doc":"Query the server for group revision history. The history contains information about the changes between each revision and the user that made the change.","errors":[{"name":"NoSuchAccountError"},{"name":"UnknownGroupError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"InternalError"},{"name":"GroupVerificationError"},{"name":"InvalidGroupStateError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError","doc":"caused when not a member of the group, when requesting logs from a revision lower than your joinedAtVersion, etc."},{"name":"RateLimitError"},{"name":"SQLError"}]},"send_sync_message":{"request":"SendSyncMessageRequest","response":"JsonSendMessageResult","doc":"Sends a sync message to the account's devices","errors":[{"name":"InvalidRequestError"},{"name":"RateLimitError"},{"name":"InternalError"},{"name":"UnregisteredUserError"},{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"AuthorizationFailedError"},{"name":"SQLError"}]},"ban_user":{"request":"BanUserRequest","response":"JsonGroupV2Info","doc":"Bans users from a group. This works even if the users aren't in the group. If they are currently in the group, they will also be removed.","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"UnknownGroupError"},{"name":"GroupVerificationError"},{"name":"InternalError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError","doc":"Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)."},{"name":"SQLError"},{"name":"GroupPatchNotAcceptedError","doc":"Caused when server rejects the group update."}]},"unban_user":{"request":"UnbanUserRequest","response":"JsonGroupV2Info","doc":"Unbans users from a group.","errors":[{"name":"NoSuchAccountError"},{"name":"ServerNotFoundError"},{"name":"InvalidProxyError"},{"name":"UnknownGroupError"},{"name":"GroupVerificationError"},{"name":"InternalError"},{"name":"InvalidRequestError"},{"name":"AuthorizationFailedError","doc":"Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don't allow the update (e.g. current role insufficient or not a member)."},{"name":"SQLError"},{"name":"GroupPatchNotAcceptedError","doc":"Caused when server rejects the group update."}]}}}} \ No newline at end of file diff --git a/signald/client-protocol/v1/errors.go b/signald/client-protocol/v1/errors.go index c7a4841..0ddb670 100644 --- a/signald/client-protocol/v1/errors.go +++ b/signald/client-protocol/v1/errors.go @@ -284,6 +284,13 @@ func mkerr(response client_protocol.BasicResponse) error { return err } return result + case "UnsupportedGroupError": + result := UnsupportedGroupError{} + err := json.Unmarshal(response.Error, &result) + if err != nil { + return err + } + return result case "UntrustedIdentityError": result := UntrustedIdentityError{} err := json.Unmarshal(response.Error, &result) @@ -645,6 +652,15 @@ func (e UnregisteredUserError) Error() string { return e.Message } +// UnsupportedGroupError: returned in response to use v1 groups, which are no longer supported +type UnsupportedGroupError struct { + Message string `json:"message,omitempty" yaml:"message,omitempty"` +} + +func (e UnsupportedGroupError) Error() string { + return e.Message +} + type UntrustedIdentityError struct { Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"` IdentityKey **IdentityKey `json:"identity_key,omitempty" yaml:"identity_key,omitempty"` diff --git a/signald/client-protocol/v1/structs.go b/signald/client-protocol/v1/structs.go index cf4845f..8cfcd97 100644 --- a/signald/client-protocol/v1/structs.go +++ b/signald/client-protocol/v1/structs.go @@ -263,7 +263,7 @@ type GroupLinkInfoRequest struct { type GroupList struct { Groups []*JsonGroupV2Info `json:"groups,omitempty" yaml:"groups,omitempty"` - LegacyGroups []*JsonGroupInfo `json:"legacyGroups,omitempty" yaml:"legacyGroups,omitempty"` + LegacyGroups []*JsonGroupInfo `json:"legacyGroups,omitempty" yaml:"legacyGroups,omitempty"` // list of legacy (v1) groups, no longer supported (will always be empty) } type GroupMember struct { @@ -492,6 +492,7 @@ type JsonSentTranscriptMessage struct { ExpirationStartTimestamp int64 `json:"expirationStartTimestamp,omitempty" yaml:"expirationStartTimestamp,omitempty"` IsRecipientUpdate bool `json:"isRecipientUpdate,omitempty" yaml:"isRecipientUpdate,omitempty"` Message *JsonDataMessage `json:"message,omitempty" yaml:"message,omitempty"` + Story *StoryMessage `json:"story,omitempty" yaml:"story,omitempty"` Timestamp int64 `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` UnidentifiedStatus map[string]string `json:"unidentifiedStatus,omitempty" yaml:"unidentifiedStatus,omitempty"` } @@ -599,7 +600,8 @@ type Profile struct { Address *JsonAddress `json:"address,omitempty" yaml:"address,omitempty"` Avatar string `json:"avatar,omitempty" yaml:"avatar,omitempty"` // path to avatar on local disk Capabilities *Capabilities `json:"capabilities,omitempty" yaml:"capabilities,omitempty"` - Color string `json:"color,omitempty" yaml:"color,omitempty"` // color of the chat with this user + Color string `json:"color,omitempty" yaml:"color,omitempty"` // color of the chat with this user + ContactName string `json:"contact_name,omitempty" yaml:"contact_name,omitempty"` // The user's name from local contact names Emoji string `json:"emoji,omitempty" yaml:"emoji,omitempty"` ExpirationTime int32 `json:"expiration_time,omitempty" yaml:"expiration_time,omitempty"` InboxPosition int32 `json:"inbox_position,omitempty" yaml:"inbox_position,omitempty"` From 5470eb90d9517e79bbda8ba44425d96de540eee5 Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Mon, 15 Aug 2022 17:33:06 -0400 Subject: [PATCH 32/37] Avoid more constraint violations during `db-move` --- cmd/signaldctl/cmd/db/migrate.go | 64 ++++++++++++++++++++++++-------- 1 file changed, 49 insertions(+), 15 deletions(-) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index 56e54e9..df67e26 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -209,7 +209,9 @@ func moveAccounts(source *sql.DB, dest *sql.DB) error { } func moveRecipients(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT rowid, account_uuid, uuid, e164, registered FROM recipients") + rows, err := source.Query("SELECT rowid, account_uuid, uuid, e164, registered FROM recipients" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + ) if err != nil { return err } @@ -249,7 +251,9 @@ func moveRecipients(source *sql.DB, dest *sql.DB) error { } func movePrekeys(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, id, record FROM prekeys") + rows, err := source.Query("SELECT account_uuid, id, record FROM prekeys" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + ) if err != nil { return err } @@ -274,7 +278,10 @@ func movePrekeys(source *sql.DB, dest *sql.DB) error { } func moveSessions(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, recipient, device_id, record FROM sessions") + rows, err := source.Query("SELECT account_uuid, recipient, device_id, record FROM sessions" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)" + + " AND recipient IN (SELECT DISTINCT rowid FROM recipients)", + ) if err != nil { return err } @@ -309,7 +316,9 @@ func moveSessions(source *sql.DB, dest *sql.DB) error { } func moveSignedPrekeys(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, id, record FROM signed_prekeys") + rows, err := source.Query("SELECT account_uuid, id, record FROM signed_prekeys" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + ) if err != nil { return err } @@ -334,7 +343,9 @@ func moveSignedPrekeys(source *sql.DB, dest *sql.DB) error { } func moveIdentityKeys(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, recipient, identity_key, trust_level, added FROM identity_keys") + rows, err := source.Query("SELECT account_uuid, recipient, identity_key, trust_level, added FROM identity_keys" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + ) if err != nil { return err } @@ -361,7 +372,9 @@ func moveIdentityKeys(source *sql.DB, dest *sql.DB) error { } func moveAccountData(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, key, value FROM account_data") + rows, err := source.Query("SELECT account_uuid, key, value FROM account_data" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + ) if err != nil { return err } @@ -411,7 +424,9 @@ func movePendingAccountData(source *sql.DB, dest *sql.DB) error { } func moveSenderKeys(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, address, device, distribution_id, record, created_at FROM sender_keys") + rows, err := source.Query("SELECT account_uuid, address, device, distribution_id, record, created_at FROM sender_keys" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + ) if err != nil { return err } @@ -447,7 +462,9 @@ func moveSenderKeys(source *sql.DB, dest *sql.DB) error { } func moveSenderKeyShared(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, distribution_id, address, device FROM sender_key_shared") + rows, err := source.Query("SELECT account_uuid, distribution_id, address, device FROM sender_key_shared" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + ) if err != nil { return err } @@ -483,7 +500,9 @@ func moveSenderKeyShared(source *sql.DB, dest *sql.DB) error { } func moveGroups(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT rowid, account_uuid, group_id, master_key, revision, last_avatar_fetch, distribution_id, group_info FROM groups") + rows, err := source.Query("SELECT rowid, account_uuid, group_id, master_key, revision, last_avatar_fetch, distribution_id, group_info FROM groups" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + ) if err != nil { return err } @@ -519,7 +538,10 @@ func moveGroups(source *sql.DB, dest *sql.DB) error { } func moveGroupCredentials(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, date, credential FROM group_credentials") + rows, err := source.Query("SELECT account_uuid, date, max(credential) FROM group_credentials" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)" + + " GROUP BY account_uuid, date", + ) if err != nil { return err } @@ -545,7 +567,8 @@ func moveGroupCredentials(source *sql.DB, dest *sql.DB) error { func moveContacts(source *sql.DB, dest *sql.DB) error { rows, err := source.Query("SELECT account_uuid, recipient, name, color, profile_key, message_expiration_time, inbox_position FROM contacts" + - " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)" + + " AND recipient IN (SELECT DISTINCT rowid FROM recipients)", ) if err != nil { return err @@ -579,7 +602,10 @@ func moveContacts(source *sql.DB, dest *sql.DB) error { } func moveProfileKeys(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, recipient, profile_key, profile_key_credential, request_pending, unidentified_access_mode FROM profile_keys") + rows, err := source.Query("SELECT account_uuid, recipient, profile_key, profile_key_credential, request_pending, unidentified_access_mode FROM profile_keys" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)" + + " AND recipient IN (SELECT DISTINCT rowid FROM recipients)", + ) if err != nil { return err } @@ -611,7 +637,10 @@ func moveProfileKeys(source *sql.DB, dest *sql.DB) error { } func moveProfiles(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, recipient, last_update, given_name, family_name, about, emoji, payment_address, badges FROM profiles") + rows, err := source.Query("SELECT account_uuid, recipient, last_update, given_name, family_name, about, emoji, payment_address, badges FROM profiles" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)" + + " AND recipient IN (SELECT DISTINCT rowid FROM recipients)", + ) if err != nil { return err } @@ -646,7 +675,10 @@ func moveProfiles(source *sql.DB, dest *sql.DB) error { } func moveProfileCapabilities(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, recipient, storage, gv1_migration, sender_key, announcement_group, change_number, stories FROM profile_capabilities") + rows, err := source.Query("SELECT account_uuid, recipient, storage, gv1_migration, sender_key, announcement_group, change_number, stories FROM profile_capabilities" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)" + + " AND recipient IN (SELECT DISTINCT rowid FROM recipients)", + ) if err != nil { return err } @@ -680,7 +712,9 @@ func moveProfileCapabilities(source *sql.DB, dest *sql.DB) error { } func moveProfileBadges(source *sql.DB, dest *sql.DB) error { - rows, err := source.Query("SELECT account_uuid, id, category, name, description, sprite6 FROM profile_badges") + rows, err := source.Query("SELECT account_uuid, id, category, name, description, sprite6 FROM profile_badges" + + " WHERE account_uuid IN (SELECT DISTINCT uuid FROM accounts)", + ) if err != nil { return err } From 3e33f0a3f7ee932f991b9faa1a02f29a4f5e4bdf Mon Sep 17 00:00:00 2001 From: finn Date: Mon, 29 Aug 2022 11:57:38 -0700 Subject: [PATCH 33/37] add --overwrite option to signaldctl account link --- cmd/signaldctl/cmd/account/link/link-account.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/cmd/signaldctl/cmd/account/link/link-account.go b/cmd/signaldctl/cmd/account/link/link-account.go index 899815d..9cb3fa3 100644 --- a/cmd/signaldctl/cmd/account/link/link-account.go +++ b/cmd/signaldctl/cmd/account/link/link-account.go @@ -34,6 +34,7 @@ import ( var ( testing bool deviceName string + overwrite bool LinkAccountCmd = &cobra.Command{ Use: "link", @@ -80,6 +81,7 @@ var ( finishReq := v1.FinishLinkRequest{ DeviceName: deviceName, SessionId: response.SessionId, + Overwrite: overwrite, } _, err = finishReq.Submit(common.Signald) @@ -99,4 +101,5 @@ func init() { } LinkAccountCmd.Flags().BoolVarP(&testing, "testing", "t", false, "use the Signal testing server") LinkAccountCmd.Flags().StringVarP(&deviceName, "device-name", "n", name, "the name of this device. shown to other devices on the signal account") + LinkAccountCmd.Flags().BoolVar(&overwrite, "overwrite", false, "if an account with the same id already exists in signald's database, delete it before linking") } From 10dab5a5c94ac49d6e0ef984911744d370d07e38 Mon Sep 17 00:00:00 2001 From: finn Date: Tue, 25 Oct 2022 16:17:44 -0700 Subject: [PATCH 34/37] allow updating more of the profile --- .../cmd/account/setprofile/set-profile.go | 26 +++++++++++++------ cmd/signaldctl/cmd/session/root.go | 1 - signald/signald.go | 1 - 3 files changed, 18 insertions(+), 10 deletions(-) diff --git a/cmd/signaldctl/cmd/account/setprofile/set-profile.go b/cmd/signaldctl/cmd/account/setprofile/set-profile.go index a1c646a..1d99673 100644 --- a/cmd/signaldctl/cmd/account/setprofile/set-profile.go +++ b/cmd/signaldctl/cmd/account/setprofile/set-profile.go @@ -27,10 +27,14 @@ import ( var ( account string + name string + avatar string + emoji string + about string SetProfileCmd = &cobra.Command{ - Use: "set-profile name", - Short: "updates the profile data with a new name", + Use: "set-profile [name]", + Short: "update an account's profile data", PreRun: func(cmd *cobra.Command, args []string) { if account == "" { account = config.Config.DefaultAccount @@ -39,16 +43,19 @@ var ( common.Must(cmd.Help()) log.Fatal("No account specified. Please specify with --account or set a default") } - if len(args) != 1 { - common.Must(cmd.Help()) - log.Fatal("must specify a name") + + if len(args) > 0 { + name = args[0] } }, - Run: func(_ *cobra.Command, args []string) { + Run: func(_ *cobra.Command, _ []string) { go common.Signald.Listen(nil) req := v1.SetProfile{ - Account: account, - Name: args[0], + Account: account, + Name: name, + AvatarFile: avatar, + Emoji: emoji, + About: about, } err := req.Submit(common.Signald) if err != nil { @@ -61,4 +68,7 @@ var ( func init() { SetProfileCmd.Flags().StringVarP(&account, "account", "a", "", "the signald account to use") + SetProfileCmd.Flags().StringVarP(&avatar, "avatar", "A", "", "path to avatar file") + SetProfileCmd.Flags().StringVar(&emoji, "emoji", "", "an emoji to be shown next to the about section") + SetProfileCmd.Flags().StringVar(&about, "about", "", "profile about section") } diff --git a/cmd/signaldctl/cmd/session/root.go b/cmd/signaldctl/cmd/session/root.go index 29673b5..614b827 100644 --- a/cmd/signaldctl/cmd/session/root.go +++ b/cmd/signaldctl/cmd/session/root.go @@ -15,7 +15,6 @@ package session - import ( "github.com/spf13/cobra" ) diff --git a/signald/signald.go b/signald/signald.go index 202ec46..f790d0c 100644 --- a/signald/signald.go +++ b/signald/signald.go @@ -99,7 +99,6 @@ func (s *Signald) connect() error { return nil } - func (s *Signald) Close() error { return s.socket.Close() } From fc7a556b5d31fda2e752bcaaf18afe36d9612953 Mon Sep 17 00:00:00 2001 From: finn Date: Tue, 25 Oct 2022 16:57:09 -0700 Subject: [PATCH 35/37] download dependant artifacts via the gitlab API since inter-project dependencies are now a premium feature --- .gitlab-ci.yml | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 14a803a..99cae85 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -62,11 +62,15 @@ test sqlite to postgres: .build-deb: stage: build image: debian:buster - script: + before_script: - echo deb http://deb.debian.org/debian buster-backports main > /etc/apt/sources.list.d/backports.list - apt-get update - - apt-get install -y -t buster-backports git-buildpackage dh-golang bash-completion golang-any golang-github-spf13-cobra-dev golang-github-spf13-viper-dev golang-github-google-uuid-dev golang-github-mattn-go-sqlite3-dev golang-github-lib-pq-dev golang-github-satori-go.uuid-dev + - apt-get install -y -t buster-backports git-buildpackage dh-golang bash-completion golang-any golang-github-spf13-cobra-dev golang-github-spf13-viper-dev golang-github-google-uuid-dev golang-github-mattn-go-sqlite3-dev golang-github-lib-pq-dev golang-github-satori-go.uuid-dev wget unzip + - wget -O golang-github-mdp-qrterminal.zip --quiet "https://gitlab.com/api/v4/projects/signald%2Flibraries%2Fgolang-github-mdp-qrterminal/jobs/artifacts/master/download?job=build" + - wget -O golang-github-jedib0t-go-pretty.zip --quiet "https://gitlab.com/api/v4/projects/signald%2Flibraries%2Fgolang-github-jedib0t-go-pretty/jobs/artifacts/master/download?job=build" + - for z in *.zip; do unzip $z; done - apt-get install -y ./*.deb && rm -vf *.deb + script: - 'sed -i "s/^Architecture:.*/Architecture: ${ARCH}/g" debian/control' - go run ./cmd/signaldctl doc -o man - go run ./cmd/signaldctl completion bash > debian/package.bash-completion @@ -74,15 +78,6 @@ test sqlite to postgres: - gbp dch --ignore-branch --debian-tag="%(version)s" --git-author --new-version="$(./version.sh | cut -c2-)" - dpkg-buildpackage -us -uc -b - mv ../*.deb . - needs: - - project: signald/libraries/golang-github-mdp-qrterminal - job: build - ref: master - artifacts: true - - project: signald/libraries/golang-github-jedib0t-go-pretty - job: build - ref: master - artifacts: true variables: SIGNALDCTL_PUBLIC_DOC_MODE: "on" artifacts: From 097e95bdb11dd3244b684d31300c1632dbb5d242 Mon Sep 17 00:00:00 2001 From: finn Date: Sun, 18 Dec 2022 22:00:58 -0800 Subject: [PATCH 36/37] Add version 17 migration Fixes #15 --- cmd/signaldctl/cmd/db/migrate.go | 1 + 1 file changed, 1 insertion(+) diff --git a/cmd/signaldctl/cmd/db/migrate.go b/cmd/signaldctl/cmd/db/migrate.go index df67e26..2241838 100644 --- a/cmd/signaldctl/cmd/db/migrate.go +++ b/cmd/signaldctl/cmd/db/migrate.go @@ -33,6 +33,7 @@ var ( {InstalledRank: 4, Version: "14", Description: "multiple identity keys per account", Script: "V14__multiple_identity_keys_per_account.sql", Checksum: -1635788950}, {InstalledRank: 5, Version: "15", Description: "profiles tables", Script: "V15__profiles_tables.sql", Checksum: 809686180}, {InstalledRank: 6, Version: "16", Description: "destination uuid in envelope", Script: "V16__destination_uuid_in_envelope.sql", Checksum: 357656854}, + {InstalledRank: 7, Version: "17", Description: "update server ca", Script: "V17__update_server_ca.sql", Checksum: 1647934070}, } sqlitePath string From d983bfb9a384752f8937e2df4327add293c96daa Mon Sep 17 00:00:00 2001 From: finn Date: Thu, 29 Dec 2022 17:45:22 -0800 Subject: [PATCH 37/37] improve error handling for listen --- signald/signald.go | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/signald/signald.go b/signald/signald.go index f790d0c..e82ccca 100644 --- a/signald/signald.go +++ b/signald/signald.go @@ -104,7 +104,7 @@ func (s *Signald) Close() error { } // Listen listens for events from signald -func (s *Signald) Listen(c chan client_protocol.BasicResponse) { +func (s *Signald) Listen(c chan client_protocol.BasicResponse) error { for { msg, err := s.readNext() if err == io.EOF { @@ -112,7 +112,11 @@ func (s *Signald) Listen(c chan client_protocol.BasicResponse) { if c != nil { close(c) } - return + return nil + } + + if err != nil { + return err } if msg.Type == "unexpected_error" { @@ -174,9 +178,6 @@ func (s *Signald) readNext() (b client_protocol.BasicResponse, err error) { } else { err = json.NewDecoder(s.socket).Decode(&b) } - if err != nil { - log.Println("signald-go: error decoding message from signald:", err) - return - } + return }