Bring high level room joining logic into GMSL #372
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,238 @@ | ||
| package fclient | ||
devonh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| import ( | ||
| "context" | ||
| "crypto/ed25519" | ||
| "encoding/json" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/matrix-org/gomatrixserverlib" | ||
| "github.com/matrix-org/gomatrixserverlib/spec" | ||
| "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| type PerformJoinInput struct { | ||
| UserID *spec.UserID | ||
| RoomID string | ||
| ServerName spec.ServerName | ||
| Content map[string]interface{} | ||
| Unsigned map[string]interface{} | ||
|
|
||
| PrivateKey ed25519.PrivateKey | ||
| KeyID gomatrixserverlib.KeyID | ||
| KeyRing *gomatrixserverlib.KeyRing | ||
|
|
||
| EventProvider func( | ||
| ctx context.Context, fedClient FederationClient, | ||
| keyRing gomatrixserverlib.JSONVerifier, origin, server spec.ServerName, | ||
| ) gomatrixserverlib.EventProvider | ||
| } | ||
|
|
||
| type PerformJoinCallbacks struct { | ||
| FederationFailure func(serverName spec.ServerName) | ||
| FederationSuccess func(serverName spec.ServerName) | ||
| } | ||
|
|
||
| func PerformJoin( | ||
| ctx context.Context, | ||
| fedClient FederationClient, | ||
| input PerformJoinInput, | ||
| callbacks PerformJoinCallbacks, | ||
| ) (*gomatrixserverlib.HeaderedEvent, gomatrixserverlib.StateResponse, error) { | ||
devonh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| origin := input.UserID.Domain() | ||
|
|
||
| // Try to perform a make_join using the information supplied in the | ||
| // request. | ||
| respMakeJoin, err := fedClient.MakeJoin( | ||
| ctx, | ||
| origin, | ||
| input.ServerName, | ||
| input.RoomID, | ||
| input.UserID.Raw(), | ||
| ) | ||
| if err != nil { | ||
| // TODO: Check if the user was not allowed to join the room. | ||
| callbacks.FederationFailure(input.ServerName) | ||
| return nil, nil, fmt.Errorf("r.federation.MakeJoin: %w", err) | ||
devonh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| callbacks.FederationSuccess(input.ServerName) | ||
devonh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // Set all the fields to be what they should be, this should be a no-op | ||
| // but it's possible that the remote server returned us something "odd" | ||
| stateKey := input.UserID.Raw() | ||
| respMakeJoin.JoinEvent.Type = spec.MRoomMember | ||
| respMakeJoin.JoinEvent.Sender = input.UserID.Raw() | ||
| respMakeJoin.JoinEvent.StateKey = &stateKey | ||
| respMakeJoin.JoinEvent.RoomID = input.RoomID | ||
| respMakeJoin.JoinEvent.Redacts = "" | ||
| if input.Content == nil { | ||
| input.Content = map[string]interface{}{} | ||
| } | ||
| _ = json.Unmarshal(respMakeJoin.JoinEvent.Content, &input.Content) | ||
| input.Content["membership"] = spec.Join | ||
| if err = respMakeJoin.JoinEvent.SetContent(input.Content); err != nil { | ||
| return nil, nil, fmt.Errorf("respMakeJoin.JoinEvent.SetContent: %w", err) | ||
| } | ||
| if err = respMakeJoin.JoinEvent.SetUnsigned(struct{}{}); err != nil { | ||
| return nil, nil, fmt.Errorf("respMakeJoin.JoinEvent.SetUnsigned: %w", err) | ||
| } | ||
|
|
||
| // Work out if we support the room version that has been supplied in | ||
| // the make_join response. | ||
| // "If not provided, the room version is assumed to be either "1" or "2"." | ||
| // https://matrix.org/docs/spec/server_server/unstable#get-matrix-federation-v1-make-join-roomid-userid | ||
| if respMakeJoin.RoomVersion == "" { | ||
| respMakeJoin.RoomVersion = setDefaultRoomVersionFromJoinEvent(respMakeJoin.JoinEvent) | ||
| } | ||
| verImpl, err := gomatrixserverlib.GetRoomVersion(respMakeJoin.RoomVersion) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| // Build the join event. | ||
| event, err := respMakeJoin.JoinEvent.Build( | ||
| time.Now(), | ||
| origin, | ||
| input.KeyID, | ||
| input.PrivateKey, | ||
| respMakeJoin.RoomVersion, | ||
| ) | ||
| if err != nil { | ||
| return nil, nil, fmt.Errorf("respMakeJoin.JoinEvent.Build: %w", err) | ||
| } | ||
|
|
||
| var respState gomatrixserverlib.StateResponse | ||
| // Try to perform a send_join using the newly built event. | ||
| respSendJoin, err := fedClient.SendJoin( | ||
| context.Background(), | ||
| origin, | ||
| input.ServerName, | ||
| event, | ||
| ) | ||
| if err != nil { | ||
| callbacks.FederationFailure(input.ServerName) | ||
| return nil, nil, fmt.Errorf("r.federation.SendJoin: %w", err) | ||
| } | ||
| callbacks.FederationSuccess(input.ServerName) | ||
|
|
||
| // If the remote server returned an event in the "event" key of | ||
| // the send_join request then we should use that instead. It may | ||
| // contain signatures that we don't know about. | ||
| if len(respSendJoin.Event) > 0 { | ||
| var remoteEvent *gomatrixserverlib.Event | ||
| remoteEvent, err = verImpl.NewEventFromUntrustedJSON(respSendJoin.Event) | ||
| if err == nil && isWellFormedMembershipEvent( | ||
| remoteEvent, input.RoomID, input.UserID, | ||
| ) { | ||
| event = remoteEvent | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. We seemingly continue blindly if the event is invalid? There was a problem hiding this comment. I don't know what the logic should be if you receive a bad event inside a send_join response. At this point in the join dance, the resident server has already accepted that event into it's room graph and propagated it out to the other servers in the room. So for us to reject it leaves us in an awkward situation. |
||
|
|
||
| // Sanity-check the join response to ensure that it has a create | ||
| // event, that the room version is known, etc. | ||
| authEvents := respSendJoin.AuthEvents.UntrustedEvents(respMakeJoin.RoomVersion) | ||
| if err = checkEventsContainCreateEvent(authEvents); err != nil { | ||
| return nil, nil, fmt.Errorf("sanityCheckAuthChain: %w", err) | ||
| } | ||
|
|
||
| // Process the join response in a goroutine. The idea here is | ||
devonh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // that we'll try and wait for as long as possible for the work | ||
| // to complete, but if the client does give up waiting, we'll | ||
| // still continue to process the join anyway so that we don't | ||
| // waste the effort. | ||
devonh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // TODO: Can we expand Check here to return a list of missing auth | ||
| // events rather than failing one at a time? | ||
| respState, err = gomatrixserverlib.CheckSendJoinResponse( | ||
| context.Background(), | ||
| respMakeJoin.RoomVersion, &respSendJoin, | ||
| input.KeyRing, | ||
| event, | ||
| input.EventProvider(ctx, fedClient, input.KeyRing, origin, input.ServerName), | ||
| ) | ||
| if err != nil { | ||
| return nil, nil, fmt.Errorf("respSendJoin.Check: %w", err) | ||
| } | ||
|
|
||
| // If we successfully performed a send_join above then the other | ||
| // server now thinks we're a part of the room. Send the newly | ||
| // returned state to the roomserver to update our local view. | ||
| if input.Unsigned != nil { | ||
| event, err = event.SetUnsigned(input.Unsigned) | ||
| if err != nil { | ||
| // non-fatal, log and continue | ||
| logrus.WithError(err).Errorf("Failed to set unsigned content") | ||
| } | ||
| } | ||
|
|
||
| return event.Headered(respMakeJoin.RoomVersion), respState, nil | ||
| } | ||
|
|
||
| func setDefaultRoomVersionFromJoinEvent( | ||
| joinEvent gomatrixserverlib.EventBuilder, | ||
| ) gomatrixserverlib.RoomVersion { | ||
| // if auth events are not event references we know it must be v3+ | ||
| // we have to do these shenanigans to satisfy sytest, specifically for: | ||
| // "Outbound federation rejects m.room.create events with an unknown room version" | ||
| hasEventRefs := true | ||
| authEvents, ok := joinEvent.AuthEvents.([]interface{}) | ||
| if ok { | ||
| if len(authEvents) > 0 { | ||
| _, ok = authEvents[0].(string) | ||
| if ok { | ||
| // event refs are objects, not strings, so we know we must be dealing with a v3+ room. | ||
| hasEventRefs = false | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if hasEventRefs { | ||
| return gomatrixserverlib.RoomVersionV1 | ||
| } | ||
| return gomatrixserverlib.RoomVersionV4 | ||
| } | ||
|
|
||
| // isWellFormedMembershipEvent returns true if the event looks like a legitimate | ||
| // membership event. | ||
| func isWellFormedMembershipEvent(event *gomatrixserverlib.Event, roomID string, userID *spec.UserID) bool { | ||
| if membership, err := event.Membership(); err != nil { | ||
| return false | ||
| } else if membership != spec.Join { | ||
| return false | ||
devonh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| if event.RoomID() != roomID { | ||
| return false | ||
| } | ||
| if !event.StateKeyEquals(userID.Raw()) { | ||
| return false | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func checkEventsContainCreateEvent(events []*gomatrixserverlib.Event) error { | ||
| // sanity check we have a create event and it has a known room version | ||
| for _, ev := range events { | ||
| if ev.Type() == spec.MRoomCreate && ev.StateKeyEquals("") { | ||
| // make sure the room version is known | ||
| content := ev.Content() | ||
| verBody := struct { | ||
| Version string `json:"room_version"` | ||
| }{} | ||
| err := json.Unmarshal(content, &verBody) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if verBody.Version == "" { | ||
| // https://matrix.org/docs/spec/client_server/r0.6.0#m-room-create | ||
| // The version of the room. Defaults to "1" if the key does not exist. | ||
| verBody.Version = "1" | ||
| } | ||
| knownVersions := gomatrixserverlib.RoomVersions() | ||
| if _, ok := knownVersions[gomatrixserverlib.RoomVersion(verBody.Version)]; !ok { | ||
| return fmt.Errorf("m.room.create event has an unknown room version: %s", verBody.Version) | ||
| } | ||
| return nil | ||
| } | ||
| } | ||
| return fmt.Errorf("response is missing m.room.create event") | ||
| } | ||
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.