Move /send_leave to GMSL
#387
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,9 +15,11 @@ | |
| package gomatrixserverlib | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/matrix-org/gomatrixserverlib/spec" | ||
| "github.com/matrix-org/util" | ||
| ) | ||
|
|
||
| type HandleMakeLeaveResponse struct { | ||
|
|
@@ -37,6 +39,7 @@ type HandleMakeLeaveInput struct { | |
| BuildEventTemplate func(*ProtoEvent) (PDU, []PDU, error) | ||
| } | ||
|
|
||
| // HandleMakeLeave handles requests to `/make_leave` | ||
| func HandleMakeLeave(input HandleMakeLeaveInput) (*HandleMakeLeaveResponse, error) { | ||
|
|
||
| if input.UserID.Domain() != input.RequestOrigin { | ||
|
|
@@ -98,3 +101,109 @@ func HandleMakeLeave(input HandleMakeLeaveInput) (*HandleMakeLeaveResponse, erro | |
| } | ||
| return &makeLeaveResponse, nil | ||
| } | ||
|
|
||
| type CurrentStateQuerier interface { | ||
| CurrentStateEvent(ctx context.Context, roomID spec.RoomID, eventType string, stateKey string) (PDU, error) | ||
| } | ||
|
|
||
| // handleSendLeave handles requests to `/send_leave | ||
| // Returns the parsed event or an error. | ||
| func handleSendLeave(ctx context.Context, | ||
| event PDU, | ||
|
There was a problem hiding this comment. The proposal I mentioned in #387 (comment) was to keep this function public, and to serve as the entry point for callers, because:
|
||
| origin spec.ServerName, | ||
| eventID, roomID string, | ||
| querier CurrentStateQuerier, | ||
| verifier JSONVerifier, | ||
| ) (PDU, error) { | ||
|
There was a problem hiding this comment. Sidenote: this function and others like it will likely need to be modified to support pseudo IDs, as in many cases we pull out the state key and check that it is a user ID, and then check that the domain is correct on it. I would probably structure this as:
Whilst the caller could call |
||
|
|
||
| rID, err := spec.NewRoomID(roomID) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // Check that the room ID is correct. | ||
| if (event.RoomID()) != roomID { | ||
| return nil, spec.BadJSON("The room ID in the request path must match the room ID in the leave event JSON") | ||
| } | ||
|
|
||
| // Check that the event ID is correct. | ||
| if event.EventID() != eventID { | ||
| return nil, spec.BadJSON("The event ID in the request path must match the event ID in the leave event JSON") | ||
|
|
||
| } | ||
|
|
||
| // Sanity check that we really received a state event | ||
| if event.StateKey() == nil || event.StateKeyEquals("") { | ||
| return nil, spec.BadJSON("No state key was provided in the leave event.") | ||
| } | ||
| if !event.StateKeyEquals(event.Sender()) { | ||
| return nil, spec.BadJSON("Event state key must match the event sender.") | ||
| } | ||
|
|
||
| leavingUser, err := spec.NewUserID(*event.StateKey(), true) | ||
| if err != nil { | ||
| return nil, spec.Forbidden("The leaving user ID is invalid") | ||
| } | ||
|
|
||
| // Check that the sender belongs to the server that is sending us | ||
| // the request. By this point we've already asserted that the sender | ||
| // and the state key are equal so we don't need to check both. | ||
| sender, err := spec.NewUserID(event.Sender(), true) | ||
| if err != nil { | ||
| return nil, spec.Forbidden("The sender of the join is invalid") | ||
| } | ||
| if sender.Domain() != origin { | ||
| return nil, spec.Forbidden("The sender does not match the server that originated the request") | ||
| } | ||
|
|
||
| stateEvent, err := querier.CurrentStateEvent(ctx, *rID, spec.MRoomMember, leavingUser.String()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| // we weren't joined at all | ||
| if stateEvent == nil { | ||
| return nil, nil | ||
| } | ||
| // We are/were joined/invited/banned or something | ||
| if mem, merr := stateEvent.Membership(); merr == nil && mem == spec.Leave { | ||
| return nil, nil | ||
| } | ||
| // we already processed this event | ||
| if event.EventID() == stateEvent.EventID() { | ||
| return nil, nil | ||
| } | ||
|
|
||
| // Check that the event is signed by the server sending the request. | ||
| resultEvent := event | ||
| event.Redact() | ||
| if err != nil { | ||
| util.GetLogger(ctx).WithError(err).Errorf("unable to redact event") | ||
| return nil, spec.BadJSON("The event JSON could not be redacted") | ||
| } | ||
| verifyRequests := []VerifyJSONRequest{{ | ||
| ServerName: sender.Domain(), | ||
| Message: event.JSON(), | ||
| AtTS: event.OriginServerTS(), | ||
| StrictValidityChecking: true, | ||
| }} | ||
| verifyResults, err := verifier.VerifyJSONs(ctx, verifyRequests) | ||
| if err != nil { | ||
| util.GetLogger(ctx).WithError(err).Error("keys.VerifyJSONs failed") | ||
| return nil, spec.InternalServerError{} | ||
| } | ||
| if verifyResults[0].Error != nil { | ||
| return nil, spec.Forbidden("The leave must be signed by the server it originated on") | ||
| } | ||
|
|
||
| // check membership is set to leave | ||
| mem, err := event.Membership() | ||
| if err != nil { | ||
| util.GetLogger(ctx).WithError(err).Error("event.Membership failed") | ||
| return nil, spec.BadJSON("missing content.membership key") | ||
| } | ||
| if mem != spec.Leave { | ||
| return nil, spec.BadJSON("The membership in the event content must be set to leave") | ||
| } | ||
|
|
||
| return resultEvent, nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is problematic if
v != event.Version().