mirror of
https://github.com/hoernschen/dendrite.git
synced 2025-08-01 13:52:46 +00:00
Move pseudoID ClientEvent hotswapping to a common location (#3199)
Fixes a variety of issues where clients were receiving pseudoIDs in places that should be userIDs. This change makes pseudoIDs work with sliding sync & element x. --------- Co-authored-by: Till <2353100+S7evinK@users.noreply.github.com>
This commit is contained in:
devonh
GitHub
parent
8245b24100
commit
db83789654
13 changed files with 426 additions and 333 deletions
|
|
@ -22,6 +22,8 @@ import (
|
|||
"github.com/matrix-org/gomatrixserverlib"
|
||||
"github.com/matrix-org/gomatrixserverlib/spec"
|
||||
"github.com/sirupsen/logrus"
|
||||
"github.com/tidwall/gjson"
|
||||
"github.com/tidwall/sjson"
|
||||
)
|
||||
|
||||
// PrevEventRef represents a reference to a previous event in a state event upgrade
|
||||
|
|
@ -78,59 +80,62 @@ func ToClientEvents(serverEvs []gomatrixserverlib.PDU, format ClientEventFormat,
|
|||
if se == nil {
|
||||
continue // TODO: shouldn't happen?
|
||||
}
|
||||
if format == FormatSyncFederation {
|
||||
evs = append(evs, ToClientEvent(se, format, string(se.SenderID()), se.StateKey(), spec.RawJSON(se.Unsigned())))
|
||||
ev, err := ToClientEvent(se, format, userIDForSender)
|
||||
if err != nil {
|
||||
logrus.WithError(err).Warn("Failed converting event to ClientEvent")
|
||||
continue
|
||||
}
|
||||
|
||||
sender := spec.UserID{}
|
||||
userID, err := userIDForSender(se.RoomID(), se.SenderID())
|
||||
if err == nil && userID != nil {
|
||||
sender = *userID
|
||||
}
|
||||
|
||||
sk := se.StateKey()
|
||||
if sk != nil && *sk != "" {
|
||||
skUserID, err := userIDForSender(se.RoomID(), spec.SenderID(*sk))
|
||||
if err == nil && skUserID != nil {
|
||||
skString := skUserID.String()
|
||||
sk = &skString
|
||||
}
|
||||
}
|
||||
|
||||
unsigned := se.Unsigned()
|
||||
var prev PrevEventRef
|
||||
if err := json.Unmarshal(se.Unsigned(), &prev); err == nil && prev.PrevSenderID != "" {
|
||||
prevUserID, err := userIDForSender(se.RoomID(), spec.SenderID(prev.PrevSenderID))
|
||||
if err == nil && userID != nil {
|
||||
prev.PrevSenderID = prevUserID.String()
|
||||
} else {
|
||||
errString := "userID unknown"
|
||||
if err != nil {
|
||||
errString = err.Error()
|
||||
}
|
||||
logrus.Warnf("Failed to find userID for prev_sender in ClientEvent: %s", errString)
|
||||
// NOTE: Not much can be done here, so leave the previous value in place.
|
||||
}
|
||||
unsigned, err = json.Marshal(prev)
|
||||
if err != nil {
|
||||
logrus.Errorf("Failed to marshal unsigned content for ClientEvent: %s", err.Error())
|
||||
continue
|
||||
}
|
||||
}
|
||||
evs = append(evs, ToClientEvent(se, format, sender.String(), sk, spec.RawJSON(unsigned)))
|
||||
evs = append(evs, *ev)
|
||||
}
|
||||
return evs
|
||||
}
|
||||
|
||||
// ToClientEventDefault converts a single server event to a client event.
|
||||
// It provides default logic for event.SenderID & event.StateKey -> userID conversions.
|
||||
func ToClientEventDefault(userIDQuery spec.UserIDForSender, event gomatrixserverlib.PDU) ClientEvent {
|
||||
ev, err := ToClientEvent(event, FormatAll, userIDQuery)
|
||||
if err != nil {
|
||||
return ClientEvent{}
|
||||
}
|
||||
return *ev
|
||||
}
|
||||
|
||||
// If provided state key is a user ID (state keys beginning with @ are reserved for this purpose)
|
||||
// fetch it's associated sender ID and use that instead. Otherwise returns the same state key back.
|
||||
//
|
||||
// # This function either returns the state key that should be used, or an error
|
||||
//
|
||||
// TODO: handle failure cases better (e.g. no sender ID)
|
||||
func FromClientStateKey(roomID spec.RoomID, stateKey string, senderIDQuery spec.SenderIDForUser) (*string, error) {
|
||||
if len(stateKey) >= 1 && stateKey[0] == '@' {
|
||||
parsedStateKey, err := spec.NewUserID(stateKey, true)
|
||||
if err != nil {
|
||||
// If invalid user ID, then there is no associated state event.
|
||||
return nil, fmt.Errorf("Provided state key begins with @ but is not a valid user ID: %w", err)
|
||||
}
|
||||
senderID, err := senderIDQuery(roomID, *parsedStateKey)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("Failed to query sender ID: %w", err)
|
||||
}
|
||||
if senderID == nil {
|
||||
// If no sender ID, then there is no associated state event.
|
||||
return nil, fmt.Errorf("No associated sender ID found.")
|
||||
}
|
||||
newStateKey := string(*senderID)
|
||||
return &newStateKey, nil
|
||||
} else {
|
||||
return &stateKey, nil
|
||||
}
|
||||
}
|
||||
|
||||
// ToClientEvent converts a single server event to a client event.
|
||||
func ToClientEvent(se gomatrixserverlib.PDU, format ClientEventFormat, sender string, stateKey *string, unsigned spec.RawJSON) ClientEvent {
|
||||
func ToClientEvent(se gomatrixserverlib.PDU, format ClientEventFormat, userIDForSender spec.UserIDForSender) (*ClientEvent, error) {
|
||||
ce := ClientEvent{
|
||||
Content: spec.RawJSON(se.Content()),
|
||||
Sender: sender,
|
||||
Content: se.Content(),
|
||||
Sender: string(se.SenderID()),
|
||||
Type: se.Type(),
|
||||
StateKey: stateKey,
|
||||
Unsigned: unsigned,
|
||||
StateKey: se.StateKey(),
|
||||
Unsigned: se.Unsigned(),
|
||||
OriginServerTS: se.OriginServerTS(),
|
||||
EventID: se.EventID(),
|
||||
Redacts: se.Redacts(),
|
||||
|
|
@ -148,58 +153,268 @@ func ToClientEvent(se gomatrixserverlib.PDU, format ClientEventFormat, sender st
|
|||
// TODO: Set Signatures & Hashes fields
|
||||
}
|
||||
|
||||
if format != FormatSyncFederation {
|
||||
if se.Version() == gomatrixserverlib.RoomVersionPseudoIDs {
|
||||
ce.SenderKey = se.SenderID()
|
||||
if format != FormatSyncFederation && se.Version() == gomatrixserverlib.RoomVersionPseudoIDs {
|
||||
err := updatePseudoIDs(&ce, se, userIDForSender, format)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
return ce
|
||||
|
||||
return &ce, nil
|
||||
}
|
||||
|
||||
// ToClientEvent converts a single server event to a client event.
|
||||
// It provides default logic for event.SenderID & event.StateKey -> userID conversions.
|
||||
func ToClientEventDefault(userIDQuery spec.UserIDForSender, event gomatrixserverlib.PDU) ClientEvent {
|
||||
sender := spec.UserID{}
|
||||
userID, err := userIDQuery(event.RoomID(), event.SenderID())
|
||||
func updatePseudoIDs(ce *ClientEvent, se gomatrixserverlib.PDU, userIDForSender spec.UserIDForSender, format ClientEventFormat) error {
|
||||
ce.SenderKey = se.SenderID()
|
||||
|
||||
userID, err := userIDForSender(se.RoomID(), se.SenderID())
|
||||
if err == nil && userID != nil {
|
||||
sender = *userID
|
||||
ce.Sender = userID.String()
|
||||
}
|
||||
|
||||
sk := event.StateKey()
|
||||
sk := se.StateKey()
|
||||
if sk != nil && *sk != "" {
|
||||
skUserID, err := userIDQuery(event.RoomID(), spec.SenderID(*event.StateKey()))
|
||||
skUserID, err := userIDForSender(se.RoomID(), spec.SenderID(*sk))
|
||||
if err == nil && skUserID != nil {
|
||||
skString := skUserID.String()
|
||||
sk = &skString
|
||||
ce.StateKey = &skString
|
||||
}
|
||||
}
|
||||
return ToClientEvent(event, FormatAll, sender.String(), sk, event.Unsigned())
|
||||
|
||||
var prev PrevEventRef
|
||||
if err := json.Unmarshal(se.Unsigned(), &prev); err == nil && prev.PrevSenderID != "" {
|
||||
prevUserID, err := userIDForSender(se.RoomID(), spec.SenderID(prev.PrevSenderID))
|
||||
if err == nil && userID != nil {
|
||||
prev.PrevSenderID = prevUserID.String()
|
||||
} else {
|
||||
errString := "userID unknown"
|
||||
if err != nil {
|
||||
errString = err.Error()
|
||||
}
|
||||
logrus.Warnf("Failed to find userID for prev_sender in ClientEvent: %s", errString)
|
||||
// NOTE: Not much can be done here, so leave the previous value in place.
|
||||
}
|
||||
ce.Unsigned, err = json.Marshal(prev)
|
||||
if err != nil {
|
||||
err = fmt.Errorf("Failed to marshal unsigned content for ClientEvent: %w", err)
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
switch se.Type() {
|
||||
case spec.MRoomCreate:
|
||||
updatedContent, err := updateCreateEvent(se.Content(), userIDForSender, se.RoomID())
|
||||
if err != nil {
|
||||
err = fmt.Errorf("Failed to update m.room.create event for ClientEvent: %w", err)
|
||||
return err
|
||||
}
|
||||
ce.Content = updatedContent
|
||||
case spec.MRoomMember:
|
||||
updatedEvent, err := updateInviteEvent(userIDForSender, se, format)
|
||||
if err != nil {
|
||||
err = fmt.Errorf("Failed to update m.room.member event for ClientEvent: %w", err)
|
||||
return err
|
||||
}
|
||||
if updatedEvent != nil {
|
||||
ce.Unsigned = updatedEvent.Unsigned()
|
||||
}
|
||||
case spec.MRoomPowerLevels:
|
||||
updatedEvent, err := updatePowerLevelEvent(userIDForSender, se, format)
|
||||
if err != nil {
|
||||
err = fmt.Errorf("Failed update m.room.power_levels event for ClientEvent: %w", err)
|
||||
return err
|
||||
}
|
||||
if updatedEvent != nil {
|
||||
ce.Content = updatedEvent.Content()
|
||||
ce.Unsigned = updatedEvent.Unsigned()
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// If provided state key is a user ID (state keys beginning with @ are reserved for this purpose)
|
||||
// fetch it's associated sender ID and use that instead. Otherwise returns the same state key back.
|
||||
//
|
||||
// # This function either returns the state key that should be used, or an error
|
||||
//
|
||||
// TODO: handle failure cases better (e.g. no sender ID)
|
||||
func FromClientStateKey(roomID spec.RoomID, stateKey string, senderIDQuery spec.SenderIDForUser) (*string, error) {
|
||||
if len(stateKey) >= 1 && stateKey[0] == '@' {
|
||||
parsedStateKey, err := spec.NewUserID(stateKey, true)
|
||||
func updateCreateEvent(content spec.RawJSON, userIDForSender spec.UserIDForSender, roomID spec.RoomID) (spec.RawJSON, error) {
|
||||
if creator := gjson.GetBytes(content, "creator"); creator.Exists() {
|
||||
oldCreator := creator.Str
|
||||
userID, err := userIDForSender(roomID, spec.SenderID(oldCreator))
|
||||
if err != nil {
|
||||
// If invalid user ID, then there is no associated state event.
|
||||
return nil, fmt.Errorf("Provided state key begins with @ but is not a valid user ID: %s", err.Error())
|
||||
err = fmt.Errorf("Failed to find userID for creator in ClientEvent: %w", err)
|
||||
return nil, err
|
||||
}
|
||||
senderID, err := senderIDQuery(roomID, *parsedStateKey)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("Failed to query sender ID: %s", err.Error())
|
||||
|
||||
if userID != nil {
|
||||
var newCreatorBytes, newContent []byte
|
||||
newCreatorBytes, err = json.Marshal(userID.String())
|
||||
if err != nil {
|
||||
err = fmt.Errorf("Failed to marshal new creator for ClientEvent: %w", err)
|
||||
return nil, err
|
||||
}
|
||||
|
||||
newContent, err = sjson.SetRawBytes([]byte(content), "creator", newCreatorBytes)
|
||||
if err != nil {
|
||||
err = fmt.Errorf("Failed to set new creator for ClientEvent: %w", err)
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return newContent, nil
|
||||
}
|
||||
if senderID == nil {
|
||||
// If no sender ID, then there is no associated state event.
|
||||
return nil, fmt.Errorf("No associated sender ID found.")
|
||||
}
|
||||
newStateKey := string(*senderID)
|
||||
return &newStateKey, nil
|
||||
} else {
|
||||
return &stateKey, nil
|
||||
}
|
||||
|
||||
return content, nil
|
||||
}
|
||||
|
||||
func updateInviteEvent(userIDForSender spec.UserIDForSender, ev gomatrixserverlib.PDU, eventFormat ClientEventFormat) (gomatrixserverlib.PDU, error) {
|
||||
if inviteRoomState := gjson.GetBytes(ev.Unsigned(), "invite_room_state"); inviteRoomState.Exists() {
|
||||
userID, err := userIDForSender(ev.RoomID(), ev.SenderID())
|
||||
if err != nil || userID == nil {
|
||||
if err != nil {
|
||||
err = fmt.Errorf("invalid userID found when updating invite_room_state: %w", err)
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
|
||||
newState, err := GetUpdatedInviteRoomState(userIDForSender, inviteRoomState, ev, ev.RoomID(), eventFormat)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var newEv []byte
|
||||
newEv, err = sjson.SetRawBytes(ev.JSON(), "unsigned.invite_room_state", newState)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return gomatrixserverlib.MustGetRoomVersion(ev.Version()).NewEventFromTrustedJSON(newEv, false)
|
||||
}
|
||||
|
||||
return ev, nil
|
||||
}
|
||||
|
||||
type InviteRoomStateEvent struct {
|
||||
Content spec.RawJSON `json:"content"`
|
||||
SenderID string `json:"sender"`
|
||||
StateKey *string `json:"state_key"`
|
||||
Type string `json:"type"`
|
||||
}
|
||||
|
||||
func GetUpdatedInviteRoomState(userIDForSender spec.UserIDForSender, inviteRoomState gjson.Result, event gomatrixserverlib.PDU, roomID spec.RoomID, eventFormat ClientEventFormat) (spec.RawJSON, error) {
|
||||
var res spec.RawJSON
|
||||
inviteStateEvents := []InviteRoomStateEvent{}
|
||||
err := json.Unmarshal([]byte(inviteRoomState.Raw), &inviteStateEvents)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if event.Version() == gomatrixserverlib.RoomVersionPseudoIDs && eventFormat != FormatSyncFederation {
|
||||
for i, ev := range inviteStateEvents {
|
||||
userID, userIDErr := userIDForSender(roomID, spec.SenderID(ev.SenderID))
|
||||
if userIDErr != nil {
|
||||
return nil, userIDErr
|
||||
}
|
||||
if userID != nil {
|
||||
inviteStateEvents[i].SenderID = userID.String()
|
||||
}
|
||||
|
||||
if ev.StateKey != nil && *ev.StateKey != "" {
|
||||
userID, senderErr := userIDForSender(roomID, spec.SenderID(*ev.StateKey))
|
||||
if senderErr != nil {
|
||||
return nil, senderErr
|
||||
}
|
||||
if userID != nil {
|
||||
user := userID.String()
|
||||
inviteStateEvents[i].StateKey = &user
|
||||
}
|
||||
}
|
||||
|
||||
updatedContent, updateErr := updateCreateEvent(ev.Content, userIDForSender, roomID)
|
||||
if updateErr != nil {
|
||||
updateErr = fmt.Errorf("Failed to update m.room.create event for ClientEvent: %w", userIDErr)
|
||||
return nil, updateErr
|
||||
}
|
||||
inviteStateEvents[i].Content = updatedContent
|
||||
}
|
||||
}
|
||||
|
||||
res, err = json.Marshal(inviteStateEvents)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return res, nil
|
||||
}
|
||||
|
||||
func updatePowerLevelEvent(userIDForSender spec.UserIDForSender, se gomatrixserverlib.PDU, eventFormat ClientEventFormat) (gomatrixserverlib.PDU, error) {
|
||||
if !se.StateKeyEquals("") {
|
||||
return se, nil
|
||||
}
|
||||
|
||||
pls, err := gomatrixserverlib.NewPowerLevelContentFromEvent(se)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
newPls := make(map[string]int64)
|
||||
var userID *spec.UserID
|
||||
for user, level := range pls.Users {
|
||||
if eventFormat != FormatSyncFederation {
|
||||
userID, err = userIDForSender(se.RoomID(), spec.SenderID(user))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
user = userID.String()
|
||||
}
|
||||
newPls[user] = level
|
||||
}
|
||||
var newPlBytes, newEv []byte
|
||||
newPlBytes, err = json.Marshal(newPls)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
newEv, err = sjson.SetRawBytes(se.JSON(), "content.users", newPlBytes)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// do the same for prev content
|
||||
prevContent := gjson.GetBytes(se.JSON(), "unsigned.prev_content")
|
||||
if !prevContent.Exists() {
|
||||
var evNew gomatrixserverlib.PDU
|
||||
evNew, err = gomatrixserverlib.MustGetRoomVersion(se.Version()).NewEventFromTrustedJSON(newEv, false)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return evNew, err
|
||||
}
|
||||
pls = gomatrixserverlib.PowerLevelContent{}
|
||||
err = json.Unmarshal([]byte(prevContent.Raw), &pls)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
newPls = make(map[string]int64)
|
||||
for user, level := range pls.Users {
|
||||
if eventFormat != FormatSyncFederation {
|
||||
userID, err = userIDForSender(se.RoomID(), spec.SenderID(user))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
user = userID.String()
|
||||
}
|
||||
newPls[user] = level
|
||||
}
|
||||
newPlBytes, err = json.Marshal(newPls)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
newEv, err = sjson.SetRawBytes(newEv, "unsigned.prev_content.users", newPlBytes)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var evNew gomatrixserverlib.PDU
|
||||
evNew, err = gomatrixserverlib.MustGetRoomVersion(se.Version()).NewEventFromTrustedJSONWithEventID(se.EventID(), newEv, false)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return evNew, err
|
||||
}
|
||||
|
|
|
|||
|
|
@ -26,6 +26,14 @@ import (
|
|||
"github.com/matrix-org/gomatrixserverlib/spec"
|
||||
)
|
||||
|
||||
func queryUserIDForSender(senderID spec.SenderID) (*spec.UserID, error) {
|
||||
if senderID == "" {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
return spec.NewUserID(string(senderID), true)
|
||||
}
|
||||
|
||||
const testSenderID = "testSenderID"
|
||||
const testUserID = "@test:localhost"
|
||||
|
||||
|
|
@ -106,7 +114,12 @@ func TestToClientEvent(t *testing.T) { // nolint: gocyclo
|
|||
t.Fatalf("failed to create userID: %s", err)
|
||||
}
|
||||
sk := ""
|
||||
ce := ToClientEvent(ev, FormatAll, userID.String(), &sk, ev.Unsigned())
|
||||
ce, err := ToClientEvent(ev, FormatAll, func(roomID spec.RoomID, senderID spec.SenderID) (*spec.UserID, error) {
|
||||
return queryUserIDForSender(senderID)
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create ClientEvent: %s", err)
|
||||
}
|
||||
|
||||
verifyEventFields(t,
|
||||
EventFieldsToVerify{
|
||||
|
|
@ -161,12 +174,12 @@ func TestToClientFormatSync(t *testing.T) {
|
|||
if err != nil {
|
||||
t.Fatalf("failed to create Event: %s", err)
|
||||
}
|
||||
userID, err := spec.NewUserID("@test:localhost", true)
|
||||
ce, err := ToClientEvent(ev, FormatSync, func(roomID spec.RoomID, senderID spec.SenderID) (*spec.UserID, error) {
|
||||
return queryUserIDForSender(senderID)
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create userID: %s", err)
|
||||
t.Fatalf("failed to create ClientEvent: %s", err)
|
||||
}
|
||||
sk := ""
|
||||
ce := ToClientEvent(ev, FormatSync, userID.String(), &sk, ev.Unsigned())
|
||||
if ce.RoomID != "" {
|
||||
t.Errorf("ClientEvent.RoomID: wanted '', got %s", ce.RoomID)
|
||||
}
|
||||
|
|
@ -206,7 +219,12 @@ func TestToClientEventFormatSyncFederation(t *testing.T) { // nolint: gocyclo
|
|||
t.Fatalf("failed to create userID: %s", err)
|
||||
}
|
||||
sk := ""
|
||||
ce := ToClientEvent(ev, FormatSyncFederation, userID.String(), &sk, ev.Unsigned())
|
||||
ce, err := ToClientEvent(ev, FormatSyncFederation, func(roomID spec.RoomID, senderID spec.SenderID) (*spec.UserID, error) {
|
||||
return queryUserIDForSender(senderID)
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create ClientEvent: %s", err)
|
||||
}
|
||||
|
||||
verifyEventFields(t,
|
||||
EventFieldsToVerify{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue