From 85c31551b7128bd9a2d466ddf4cdf9ad557274d4 Mon Sep 17 00:00:00 2001 From: Devon Hudson Date: Tue, 23 May 2023 11:42:36 -0600 Subject: [PATCH] Migrate handleInvite over to gmsl --- clientapi/routing/createroom.go | 7 +- federationapi/api/api.go | 6 +- federationapi/routing/invite.go | 197 +----------------- go.mod | 2 +- go.sum | 4 +- roomserver/api/api.go | 3 +- roomserver/api/perform.go | 11 +- roomserver/internal/api.go | 3 +- roomserver/internal/perform/perform_invite.go | 23 +- 9 files changed, 34 insertions(+), 222 deletions(-) diff --git a/clientapi/routing/createroom.go b/clientapi/routing/createroom.go index bc9600060..c71c8fc0c 100644 --- a/clientapi/routing/createroom.go +++ b/clientapi/routing/createroom.go @@ -28,7 +28,6 @@ import ( "github.com/matrix-org/dendrite/roomserver/types" roomserverVersion "github.com/matrix-org/dendrite/roomserver/version" "github.com/matrix-org/dendrite/userapi/api" - "github.com/matrix-org/gomatrixserverlib/fclient" "github.com/matrix-org/gomatrixserverlib/spec" "github.com/matrix-org/dendrite/clientapi/httputil" @@ -557,7 +556,7 @@ func createRoom( // If this is a direct message then we should invite the participants. if len(r.Invite) > 0 { // Build some stripped state for the invite. - var globalStrippedState []fclient.InviteV2StrippedState + var globalStrippedState []gomatrixserverlib.InviteStrippedState for _, event := range builtEvents { // Chosen events from the spec: // https://spec.matrix.org/v1.3/client-server-api/#stripped-state @@ -580,7 +579,7 @@ func createRoom( ev := event.PDU globalStrippedState = append( globalStrippedState, - fclient.NewInviteV2StrippedState(ev), + gomatrixserverlib.NewInviteStrippedState(ev), ) } } @@ -599,7 +598,7 @@ func createRoom( } inviteStrippedState := append( globalStrippedState, - fclient.NewInviteV2StrippedState(inviteEvent.PDU), + gomatrixserverlib.NewInviteStrippedState(inviteEvent.PDU), ) // Send the invite event to the roomserver. event := inviteEvent diff --git a/federationapi/api/api.go b/federationapi/api/api.go index b53ec3dd8..462cff875 100644 --- a/federationapi/api/api.go +++ b/federationapi/api/api.go @@ -190,9 +190,9 @@ type PerformLeaveResponse struct { } type PerformInviteRequest struct { - RoomVersion gomatrixserverlib.RoomVersion `json:"room_version"` - Event *rstypes.HeaderedEvent `json:"event"` - InviteRoomState []fclient.InviteV2StrippedState `json:"invite_room_state"` + RoomVersion gomatrixserverlib.RoomVersion `json:"room_version"` + Event *rstypes.HeaderedEvent `json:"event"` + InviteRoomState []gomatrixserverlib.InviteStrippedState `json:"invite_room_state"` } type PerformInviteResponse struct { diff --git a/federationapi/routing/invite.go b/federationapi/routing/invite.go index dd8e5381f..21113e7b2 100644 --- a/federationapi/routing/invite.go +++ b/federationapi/routing/invite.go @@ -15,8 +15,6 @@ package routing import ( - "context" - "crypto/ed25519" "encoding/json" "fmt" "net/http" @@ -28,7 +26,6 @@ import ( "github.com/matrix-org/gomatrixserverlib/fclient" "github.com/matrix-org/gomatrixserverlib/spec" "github.com/matrix-org/util" - "github.com/sirupsen/logrus" ) // InviteV2 implements /_matrix/federation/v2/invite/{roomID}/{eventID} @@ -78,7 +75,7 @@ func InviteV2( } } - input := HandleInviteInput{ + input := gomatrixserverlib.HandleInviteInput{ Context: httpReq.Context(), RoomVersion: inviteReq.RoomVersion(), RoomID: roomID, @@ -88,7 +85,7 @@ func InviteV2( PrivateKey: cfg.Matrix.PrivateKey, Verifier: keys, InviteQuerier: rsAPI, - MembershipQuerier: MembershipQuerier{roomserver: rsAPI}, + MembershipQuerier: &MembershipQuerier{roomserver: rsAPI}, GenerateStrippedState: rsAPI.GenerateInviteStrippedState, InviteEvent: inviteReq.Event(), StrippedState: inviteReq.InviteRoomState(), @@ -136,7 +133,7 @@ func InviteV1( JSON: spec.NotJSON("The request body could not be decoded into an invite v1 request. " + err.Error()), } } - var strippedState []fclient.InviteV2StrippedState + var strippedState []gomatrixserverlib.InviteStrippedState if err := json.Unmarshal(event.Unsigned(), &strippedState); err != nil { // just warn, they may not have added any. util.GetLogger(httpReq.Context()).Warnf("failed to extract stripped state from invite event") @@ -163,7 +160,7 @@ func InviteV1( } } - input := HandleInviteInput{ + input := gomatrixserverlib.HandleInviteInput{ Context: httpReq.Context(), RoomVersion: roomVer, RoomID: roomID, @@ -173,7 +170,7 @@ func InviteV1( PrivateKey: cfg.Matrix.PrivateKey, Verifier: keys, InviteQuerier: rsAPI, - MembershipQuerier: MembershipQuerier{roomserver: rsAPI}, + MembershipQuerier: &MembershipQuerier{roomserver: rsAPI}, GenerateStrippedState: rsAPI.GenerateInviteStrippedState, InviteEvent: event, StrippedState: strippedState, @@ -188,8 +185,8 @@ func InviteV1( } } -func handleInvite(input HandleInviteInput, rsAPI api.FederationRoomserverAPI) (gomatrixserverlib.PDU, *util.JSONResponse) { - inviteEvent, err := processInvite(input) +func handleInvite(input gomatrixserverlib.HandleInviteInput, rsAPI api.FederationRoomserverAPI) (gomatrixserverlib.PDU, *util.JSONResponse) { + inviteEvent, err := gomatrixserverlib.HandleInvite(input) switch e := err.(type) { case nil: case spec.InternalServerError: @@ -232,183 +229,3 @@ func handleInvite(input HandleInviteInput, rsAPI api.FederationRoomserverAPI) (g } return inviteEvent, nil } - -// TODO: Migrate to GMSL - -type RoomQuerier interface { - IsKnownRoom(ctx context.Context, roomID spec.RoomID) (bool, error) -} - -type HandleInviteInput struct { - Context context.Context - RoomVersion gomatrixserverlib.RoomVersion - RoomID spec.RoomID - EventID string - InvitedUser spec.UserID - KeyID gomatrixserverlib.KeyID - PrivateKey ed25519.PrivateKey - Verifier gomatrixserverlib.JSONVerifier - InviteQuerier RoomQuerier - MembershipQuerier MembershipQuerier - // TODO: get rid of fclient references if possible - GenerateStrippedState func(ctx context.Context, roomID spec.RoomID, stateWanted []gomatrixserverlib.StateKeyTuple, inviteEvent gomatrixserverlib.PDU) ([]fclient.InviteV2StrippedState, error) - - InviteEvent gomatrixserverlib.PDU - StrippedState []fclient.InviteV2StrippedState -} - -func processInvite( - input HandleInviteInput, -) (gomatrixserverlib.PDU, error) { - // Check that we can accept invites for this room version. - verImpl, err := gomatrixserverlib.GetRoomVersion(input.RoomVersion) - if err != nil { - return nil, spec.UnsupportedRoomVersion( - fmt.Sprintf("Room version %q is not supported by this server.", input.RoomVersion), - ) - } - - // Check that the room ID is correct. - if input.InviteEvent.RoomID() != input.RoomID.String() { - return nil, spec.BadJSON("The room ID in the request path must match the room ID in the invite event JSON") - } - - // Check that the event ID is correct. - if input.InviteEvent.EventID() != input.EventID { - return nil, spec.BadJSON("The event ID in the request path must match the event ID in the invite event JSON") - } - - // Check that the event is signed by the server sending the request. - redacted, err := verImpl.RedactEventJSON(input.InviteEvent.JSON()) - if err != nil { - return nil, spec.BadJSON("The event JSON could not be redacted") - } - - sender, err := spec.NewUserID(input.InviteEvent.Sender(), true) - if err != nil { - return nil, spec.BadJSON("The event JSON contains an invalid sender") - } - verifyRequests := []gomatrixserverlib.VerifyJSONRequest{{ - ServerName: sender.Domain(), - Message: redacted, - AtTS: input.InviteEvent.OriginServerTS(), - StrictValidityChecking: true, - }} - verifyResults, err := input.Verifier.VerifyJSONs(input.Context, verifyRequests) - if err != nil { - util.GetLogger(input.Context).WithError(err).Error("keys.VerifyJSONs failed") - return nil, spec.InternalServerError{} - } - if verifyResults[0].Error != nil { - return nil, spec.Forbidden("The invite must be signed by the server it originated on") - } - - // Sign the event so that other servers will know that we have received the invite. - signedEvent := input.InviteEvent.Sign( - string(input.InvitedUser.Domain()), input.KeyID, input.PrivateKey, - ) - - inviteEvent := &types.HeaderedEvent{PDU: signedEvent} - - if inviteEvent.StateKey() == nil { - util.GetLogger(input.Context).Error("invite must be a state event") - return nil, spec.InternalServerError{} - } - - isKnownRoom, err := input.InviteQuerier.IsKnownRoom(input.Context, input.RoomID) - if err != nil { - util.GetLogger(input.Context).WithError(err).Error("failed querying known room") - return nil, spec.InternalServerError{} - } - - inviteState := input.StrippedState - if len(inviteState) == 0 { - // "If they are set on the room, at least the state for m.room.avatar, m.room.canonical_alias, m.room.join_rules, and m.room.name SHOULD be included." - // https://matrix.org/docs/spec/client_server/r0.6.0#m-room-member - stateWanted := []gomatrixserverlib.StateKeyTuple{} - for _, t := range []string{ - spec.MRoomName, spec.MRoomCanonicalAlias, - spec.MRoomJoinRules, spec.MRoomAvatar, - spec.MRoomEncryption, spec.MRoomCreate, - } { - stateWanted = append(stateWanted, gomatrixserverlib.StateKeyTuple{ - EventType: t, - StateKey: "", - }) - } - if is, err := input.GenerateStrippedState(input.Context, input.RoomID, stateWanted, inviteEvent); err == nil { - inviteState = is - } else { - util.GetLogger(input.Context).WithError(err).Error("failed querying known room") - return nil, spec.InternalServerError{} - } - } - - logger := util.GetLogger(input.Context).WithFields(map[string]interface{}{ - "inviter": inviteEvent.Sender(), - "invitee": *inviteEvent.StateKey(), - "room_id": input.RoomID.String(), - "event_id": inviteEvent.EventID(), - }) - logger.WithFields(logrus.Fields{ - "room_version": inviteEvent.Version(), - "room_info_exists": isKnownRoom, - }).Debug("processing incoming federation invite event") - - if len(inviteState) == 0 { - if err = inviteEvent.SetUnsignedField("invite_room_state", struct{}{}); err != nil { - util.GetLogger(input.Context).WithError(err).Error("failed setting unsigned field") - return nil, spec.InternalServerError{} - } - } else { - if err = inviteEvent.SetUnsignedField("invite_room_state", inviteState); err != nil { - util.GetLogger(input.Context).WithError(err).Error("failed setting unsigned field") - return nil, spec.InternalServerError{} - } - } - - if isKnownRoom { - membership, err := input.MembershipQuerier.CurrentMembership(input.Context, input.RoomID, input.InvitedUser) - if err != nil { - util.GetLogger(input.Context).WithError(err).Error("failed getting user membership") - return nil, spec.InternalServerError{} - - } - isAlreadyJoined := (membership == spec.Join) - - if isAlreadyJoined { - // If the user is joined to the room then that takes precedence over this - // invite event. It makes little sense to move a user that is already - // joined to the room into the invite state. - // This could plausibly happen if an invite request raced with a join - // request for a user. For example if a user was invited to a public - // room and they joined the room at the same time as the invite was sent. - // The other way this could plausibly happen is if an invite raced with - // a kick. For example if a user was kicked from a room in error and in - // response someone else in the room re-invited them then it is possible - // for the invite request to race with the leave event so that the - // target receives invite before it learns that it has been kicked. - // There are a few ways this could be plausibly handled in the roomserver. - // 1) Store the invite, but mark it as retired. That will result in the - // permanent rejection of that invite event. So even if the target - // user leaves the room and the invite is retransmitted it will be - // ignored. However a new invite with a new event ID would still be - // accepted. - // 2) Silently discard the invite event. This means that if the event - // was retransmitted at a later date after the target user had left - // the room we would accept the invite. However since we hadn't told - // the sending server that the invite had been discarded it would - // have no reason to attempt to retry. - // 3) Signal the sending server that the user is already joined to the - // room. - // For now we will implement option 2. Since in the abesence of a retry - // mechanism it will be equivalent to option 1, and we don't have a - // signalling mechanism to implement option 3. - logger.Debugf("user already joined") - util.GetLogger(input.Context).Error("user is already joined to room") - return nil, spec.InternalServerError{} - } - } - - return inviteEvent.PDU, nil -} diff --git a/go.mod b/go.mod index e85051777..4e221cb99 100644 --- a/go.mod +++ b/go.mod @@ -22,7 +22,7 @@ require ( github.com/matrix-org/dugong v0.0.0-20210921133753-66e6b1c67e2e github.com/matrix-org/go-sqlite3-js v0.0.0-20220419092513-28aa791a1c91 github.com/matrix-org/gomatrix v0.0.0-20220926102614-ceba4d9f7530 - github.com/matrix-org/gomatrixserverlib v0.0.0-20230519160810-b92e84b02a7c + github.com/matrix-org/gomatrixserverlib v0.0.0-20230523173522-73fee43a3944 github.com/matrix-org/pinecone v0.11.1-0.20230210171230-8c3b24f2649a github.com/matrix-org/util v0.0.0-20221111132719-399730281e66 github.com/mattn/go-sqlite3 v1.14.16 diff --git a/go.sum b/go.sum index 6f034fef6..91facc5f6 100644 --- a/go.sum +++ b/go.sum @@ -323,8 +323,8 @@ github.com/matrix-org/go-sqlite3-js v0.0.0-20220419092513-28aa791a1c91 h1:s7fexw github.com/matrix-org/go-sqlite3-js v0.0.0-20220419092513-28aa791a1c91/go.mod h1:e+cg2q7C7yE5QnAXgzo512tgFh1RbQLC0+jozuegKgo= github.com/matrix-org/gomatrix v0.0.0-20220926102614-ceba4d9f7530 h1:kHKxCOLcHH8r4Fzarl4+Y3K5hjothkVW5z7T1dUM11U= github.com/matrix-org/gomatrix v0.0.0-20220926102614-ceba4d9f7530/go.mod h1:/gBX06Kw0exX1HrwmoBibFA98yBk/jxKpGVeyQbff+s= -github.com/matrix-org/gomatrixserverlib v0.0.0-20230519160810-b92e84b02a7c h1:EF04pmshcDmBQOrBQbzT5htyTivetfyvR70gX2hB9AM= -github.com/matrix-org/gomatrixserverlib v0.0.0-20230519160810-b92e84b02a7c/go.mod h1:H9V9N3Uqn1bBJqYJNGK1noqtgJTaCEhtTdcH/mp50uU= +github.com/matrix-org/gomatrixserverlib v0.0.0-20230523173522-73fee43a3944 h1:Prw7Wxp2KLfIp2mvZBIra61QknKkyLHwvynfB6xeGvQ= +github.com/matrix-org/gomatrixserverlib v0.0.0-20230523173522-73fee43a3944/go.mod h1:H9V9N3Uqn1bBJqYJNGK1noqtgJTaCEhtTdcH/mp50uU= github.com/matrix-org/pinecone v0.11.1-0.20230210171230-8c3b24f2649a h1:awrPDf9LEFySxTLKYBMCiObelNx/cBuv/wzllvCCH3A= github.com/matrix-org/pinecone v0.11.1-0.20230210171230-8c3b24f2649a/go.mod h1:HchJX9oKMXaT2xYFs0Ha/6Zs06mxLU8k6F1ODnrGkeQ= github.com/matrix-org/util v0.0.0-20221111132719-399730281e66 h1:6z4KxomXSIGWqhHcfzExgkH3Z3UkIXry4ibJS4Aqz2Y= diff --git a/roomserver/api/api.go b/roomserver/api/api.go index 617d909bd..b4e3de564 100644 --- a/roomserver/api/api.go +++ b/roomserver/api/api.go @@ -4,7 +4,6 @@ import ( "context" "github.com/matrix-org/gomatrixserverlib" - "github.com/matrix-org/gomatrixserverlib/fclient" "github.com/matrix-org/gomatrixserverlib/spec" asAPI "github.com/matrix-org/dendrite/appservice/api" @@ -237,7 +236,7 @@ type FederationRoomserverAPI interface { LocallyJoinedUsers(ctx context.Context, roomVersion gomatrixserverlib.RoomVersion, roomNID types.RoomNID) ([]gomatrixserverlib.PDU, error) IsKnownRoom(ctx context.Context, roomID spec.RoomID) (bool, error) - GenerateInviteStrippedState(ctx context.Context, roomID spec.RoomID, stateWanted []gomatrixserverlib.StateKeyTuple, inviteEvent gomatrixserverlib.PDU) ([]fclient.InviteV2StrippedState, error) + GenerateInviteStrippedState(ctx context.Context, roomID spec.RoomID, stateWanted []gomatrixserverlib.StateKeyTuple, inviteEvent gomatrixserverlib.PDU) ([]gomatrixserverlib.InviteStrippedState, error) } type KeyserverRoomserverAPI interface { diff --git a/roomserver/api/perform.go b/roomserver/api/perform.go index c6e5f5a1c..43b028bb6 100644 --- a/roomserver/api/perform.go +++ b/roomserver/api/perform.go @@ -3,7 +3,6 @@ package api import ( "github.com/matrix-org/dendrite/roomserver/types" "github.com/matrix-org/gomatrixserverlib" - "github.com/matrix-org/gomatrixserverlib/fclient" "github.com/matrix-org/gomatrixserverlib/spec" "github.com/matrix-org/util" ) @@ -28,11 +27,11 @@ type PerformLeaveResponse struct { } type PerformInviteRequest struct { - RoomVersion gomatrixserverlib.RoomVersion `json:"room_version"` - Event *types.HeaderedEvent `json:"event"` - InviteRoomState []fclient.InviteV2StrippedState `json:"invite_room_state"` - SendAsServer string `json:"send_as_server"` - TransactionID *TransactionID `json:"transaction_id"` + RoomVersion gomatrixserverlib.RoomVersion `json:"room_version"` + Event *types.HeaderedEvent `json:"event"` + InviteRoomState []gomatrixserverlib.InviteStrippedState `json:"invite_room_state"` + SendAsServer string `json:"send_as_server"` + TransactionID *TransactionID `json:"transaction_id"` } type PerformPeekRequest struct { diff --git a/roomserver/internal/api.go b/roomserver/internal/api.go index b9edc470a..f74db752f 100644 --- a/roomserver/internal/api.go +++ b/roomserver/internal/api.go @@ -5,7 +5,6 @@ import ( "github.com/getsentry/sentry-go" "github.com/matrix-org/gomatrixserverlib" - "github.com/matrix-org/gomatrixserverlib/fclient" "github.com/matrix-org/gomatrixserverlib/spec" "github.com/nats-io/nats.go" "github.com/sirupsen/logrus" @@ -215,7 +214,7 @@ func (r *RoomserverInternalAPI) IsKnownRoom(ctx context.Context, roomID spec.Roo func (r *RoomserverInternalAPI) GenerateInviteStrippedState( ctx context.Context, roomID spec.RoomID, stateWanted []gomatrixserverlib.StateKeyTuple, inviteEvent gomatrixserverlib.PDU, -) ([]fclient.InviteV2StrippedState, error) { +) ([]gomatrixserverlib.InviteStrippedState, error) { return r.Inviter.GenerateInviteStrippedState(ctx, roomID, stateWanted, inviteEvent) } diff --git a/roomserver/internal/perform/perform_invite.go b/roomserver/internal/perform/perform_invite.go index b832bc9f3..c69a4b8b9 100644 --- a/roomserver/internal/perform/perform_invite.go +++ b/roomserver/internal/perform/perform_invite.go @@ -28,7 +28,6 @@ import ( "github.com/matrix-org/dendrite/roomserver/types" "github.com/matrix-org/dendrite/setup/config" "github.com/matrix-org/gomatrixserverlib" - "github.com/matrix-org/gomatrixserverlib/fclient" "github.com/matrix-org/gomatrixserverlib/spec" "github.com/matrix-org/util" log "github.com/sirupsen/logrus" @@ -52,7 +51,7 @@ func (r *Inviter) IsKnownRoom(ctx context.Context, roomID spec.RoomID) (bool, er func (r *Inviter) GenerateInviteStrippedState( ctx context.Context, roomID spec.RoomID, stateWanted []gomatrixserverlib.StateKeyTuple, inviteEvent gomatrixserverlib.PDU, -) ([]fclient.InviteV2StrippedState, error) { +) ([]gomatrixserverlib.InviteStrippedState, error) { info, err := r.DB.RoomInfo(ctx, roomID.String()) if err != nil { return nil, fmt.Errorf("failed to load RoomInfo: %w", err) @@ -73,12 +72,12 @@ func (r *Inviter) GenerateInviteStrippedState( if err != nil { return nil, nil } - inviteState := []fclient.InviteV2StrippedState{ - fclient.NewInviteV2StrippedState(inviteEvent), + inviteState := []gomatrixserverlib.InviteStrippedState{ + gomatrixserverlib.NewInviteStrippedState(inviteEvent), } stateEvents = append(stateEvents, types.Event{PDU: inviteEvent}) for _, event := range stateEvents { - inviteState = append(inviteState, fclient.NewInviteV2StrippedState(event.PDU)) + inviteState = append(inviteState, gomatrixserverlib.NewInviteStrippedState(event.PDU)) } return inviteState, nil } @@ -269,15 +268,15 @@ func (r *Inviter) PerformInvite( } func (r *Inviter) generateInviteStrippedState( - ctx context.Context, roomID spec.RoomID, inviteEvent *types.HeaderedEvent, inviteState []fclient.InviteV2StrippedState, -) (*types.RoomInfo, []fclient.InviteV2StrippedState, error) { + ctx context.Context, roomID spec.RoomID, inviteEvent *types.HeaderedEvent, inviteState []gomatrixserverlib.InviteStrippedState, +) (*types.RoomInfo, []gomatrixserverlib.InviteStrippedState, error) { info, err := r.DB.RoomInfo(ctx, roomID.String()) if err != nil { return nil, nil, fmt.Errorf("failed to load RoomInfo: %w", err) } strippedState := inviteState if len(strippedState) == 0 && info != nil { - var is []fclient.InviteV2StrippedState + var is []gomatrixserverlib.InviteStrippedState if is, err = buildInviteStrippedState(ctx, r.DB, info, inviteEvent); err == nil { strippedState = is } @@ -291,7 +290,7 @@ func buildInviteStrippedState( db storage.Database, info *types.RoomInfo, inviteEvent *types.HeaderedEvent, -) ([]fclient.InviteV2StrippedState, error) { +) ([]gomatrixserverlib.InviteStrippedState, error) { stateWanted := []gomatrixserverlib.StateKeyTuple{} // "If they are set on the room, at least the state for m.room.avatar, m.room.canonical_alias, m.room.join_rules, and m.room.name SHOULD be included." // https://matrix.org/docs/spec/client_server/r0.6.0#m-room-member @@ -323,12 +322,12 @@ func buildInviteStrippedState( if err != nil { return nil, err } - inviteState := []fclient.InviteV2StrippedState{ - fclient.NewInviteV2StrippedState(inviteEvent.PDU), + inviteState := []gomatrixserverlib.InviteStrippedState{ + gomatrixserverlib.NewInviteStrippedState(inviteEvent.PDU), } stateEvents = append(stateEvents, types.Event{PDU: inviteEvent.PDU}) for _, event := range stateEvents { - inviteState = append(inviteState, fclient.NewInviteV2StrippedState(event.PDU)) + inviteState = append(inviteState, gomatrixserverlib.NewInviteStrippedState(event.PDU)) } return inviteState, nil }