// Copyright 2022 The Matrix.org Foundation C.I.C. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package gobind import ( "context" "crypto/ed25519" "crypto/rand" "crypto/tls" "encoding/hex" "fmt" "io" "net" "net/http" "os" "path/filepath" "strings" "sync" "time" "go.uber.org/atomic" "github.com/gorilla/mux" "github.com/matrix-org/dendrite/appservice" "github.com/matrix-org/dendrite/clientapi/userutil" "github.com/matrix-org/dendrite/cmd/dendrite-demo-pinecone/conn" "github.com/matrix-org/dendrite/cmd/dendrite-demo-pinecone/rooms" "github.com/matrix-org/dendrite/cmd/dendrite-demo-pinecone/users" "github.com/matrix-org/dendrite/cmd/dendrite-demo-yggdrasil/signing" "github.com/matrix-org/dendrite/federationapi" "github.com/matrix-org/dendrite/federationapi/api" "github.com/matrix-org/dendrite/federationapi/producers" "github.com/matrix-org/dendrite/internal/httputil" "github.com/matrix-org/dendrite/keyserver" "github.com/matrix-org/dendrite/relayapi" relayServerAPI "github.com/matrix-org/dendrite/relayapi/api" "github.com/matrix-org/dendrite/roomserver" "github.com/matrix-org/dendrite/setup" "github.com/matrix-org/dendrite/setup/base" "github.com/matrix-org/dendrite/setup/config" "github.com/matrix-org/dendrite/setup/jetstream" "github.com/matrix-org/dendrite/test" "github.com/matrix-org/dendrite/userapi" userapiAPI "github.com/matrix-org/dendrite/userapi/api" "github.com/matrix-org/gomatrixserverlib" "github.com/sirupsen/logrus" "golang.org/x/net/http2" "golang.org/x/net/http2/h2c" pineconeConnections "github.com/matrix-org/pinecone/connections" pineconeMulticast "github.com/matrix-org/pinecone/multicast" pineconeRouter "github.com/matrix-org/pinecone/router" pineconeEvents "github.com/matrix-org/pinecone/router/events" pineconeSessions "github.com/matrix-org/pinecone/sessions" "github.com/matrix-org/pinecone/types" _ "golang.org/x/mobile/bind" ) const ( PeerTypeRemote = pineconeRouter.PeerTypeRemote PeerTypeMulticast = pineconeRouter.PeerTypeMulticast PeerTypeBluetooth = pineconeRouter.PeerTypeBluetooth PeerTypeBonjour = pineconeRouter.PeerTypeBonjour relayServerRetryInterval = time.Second * 30 ) type DendriteMonolith struct { logger logrus.Logger baseDendrite *base.BaseDendrite PineconeRouter *pineconeRouter.Router PineconeMulticast *pineconeMulticast.Multicast PineconeQUIC *pineconeSessions.Sessions PineconeManager *pineconeConnections.ConnectionManager StorageDirectory string CacheDirectory string listener net.Listener httpServer *http.Server userAPI userapiAPI.UserInternalAPI federationAPI api.FederationInternalAPI relayServersQueried map[gomatrixserverlib.ServerName]bool } func (m *DendriteMonolith) PublicKey() string { return m.PineconeRouter.PublicKey().String() } func (m *DendriteMonolith) BaseURL() string { return fmt.Sprintf("http://%s", m.listener.Addr().String()) } func (m *DendriteMonolith) PeerCount(peertype int) int { return m.PineconeRouter.PeerCount(peertype) } func (m *DendriteMonolith) SessionCount() int { return len(m.PineconeQUIC.Protocol("matrix").Sessions()) } type InterfaceInfo struct { Name string Index int Mtu int Up bool Broadcast bool Loopback bool PointToPoint bool Multicast bool Addrs string } type InterfaceRetriever interface { CacheCurrentInterfaces() int GetCachedInterface(index int) *InterfaceInfo } func (m *DendriteMonolith) RegisterNetworkCallback(intfCallback InterfaceRetriever) { callback := func() []pineconeMulticast.InterfaceInfo { count := intfCallback.CacheCurrentInterfaces() intfs := []pineconeMulticast.InterfaceInfo{} for i := 0; i < count; i++ { iface := intfCallback.GetCachedInterface(i) if iface != nil { intfs = append(intfs, pineconeMulticast.InterfaceInfo{ Name: iface.Name, Index: iface.Index, Mtu: iface.Mtu, Up: iface.Up, Broadcast: iface.Broadcast, Loopback: iface.Loopback, PointToPoint: iface.PointToPoint, Multicast: iface.Multicast, Addrs: iface.Addrs, }) } } return intfs } m.PineconeMulticast.RegisterNetworkCallback(callback) } func (m *DendriteMonolith) SetMulticastEnabled(enabled bool) { if enabled { m.PineconeMulticast.Start() } else { m.PineconeMulticast.Stop() m.DisconnectType(int(pineconeRouter.PeerTypeMulticast)) } } func (m *DendriteMonolith) SetStaticPeer(uri string) { m.PineconeManager.RemovePeers() for _, uri := range strings.Split(uri, ",") { m.PineconeManager.AddPeer(strings.TrimSpace(uri)) } } func (m *DendriteMonolith) DisconnectType(peertype int) { for _, p := range m.PineconeRouter.Peers() { if int(peertype) == p.PeerType { m.PineconeRouter.Disconnect(types.SwitchPortID(p.Port), nil) } } } func (m *DendriteMonolith) DisconnectZone(zone string) { for _, p := range m.PineconeRouter.Peers() { if zone == p.Zone { m.PineconeRouter.Disconnect(types.SwitchPortID(p.Port), nil) } } } func (m *DendriteMonolith) DisconnectPort(port int) { m.PineconeRouter.Disconnect(types.SwitchPortID(port), nil) } func (m *DendriteMonolith) Conduit(zone string, peertype int) (*Conduit, error) { l, r := net.Pipe() conduit := &Conduit{conn: r, port: 0} go func() { conduit.portMutex.Lock() defer conduit.portMutex.Unlock() logrus.Errorf("Attempting authenticated connect") var err error if conduit.port, err = m.PineconeRouter.Connect( l, pineconeRouter.ConnectionZone(zone), pineconeRouter.ConnectionPeerType(peertype), ); err != nil { logrus.Errorf("Authenticated connect failed: %s", err) _ = l.Close() _ = r.Close() _ = conduit.Close() return } logrus.Infof("Authenticated connect succeeded (port %d)", conduit.port) }() return conduit, nil } func (m *DendriteMonolith) RegisterUser(localpart, password string) (string, error) { pubkey := m.PineconeRouter.PublicKey() userID := userutil.MakeUserID( localpart, gomatrixserverlib.ServerName(hex.EncodeToString(pubkey[:])), ) userReq := &userapiAPI.PerformAccountCreationRequest{ AccountType: userapiAPI.AccountTypeUser, Localpart: localpart, Password: password, } userRes := &userapiAPI.PerformAccountCreationResponse{} if err := m.userAPI.PerformAccountCreation(context.Background(), userReq, userRes); err != nil { return userID, fmt.Errorf("userAPI.PerformAccountCreation: %w", err) } return userID, nil } func (m *DendriteMonolith) RegisterDevice(localpart, deviceID string) (string, error) { accessTokenBytes := make([]byte, 16) n, err := rand.Read(accessTokenBytes) if err != nil { return "", fmt.Errorf("rand.Read: %w", err) } loginReq := &userapiAPI.PerformDeviceCreationRequest{ Localpart: localpart, DeviceID: &deviceID, AccessToken: hex.EncodeToString(accessTokenBytes[:n]), } loginRes := &userapiAPI.PerformDeviceCreationResponse{} if err := m.userAPI.PerformDeviceCreation(context.Background(), loginReq, loginRes); err != nil { return "", fmt.Errorf("userAPI.PerformDeviceCreation: %w", err) } if !loginRes.DeviceCreated { return "", fmt.Errorf("device was not created") } return loginRes.Device.AccessToken, nil } // nolint:gocyclo func (m *DendriteMonolith) Start() { var sk ed25519.PrivateKey var pk ed25519.PublicKey keyfile := filepath.Join(m.StorageDirectory, "p2p.pem") if _, err := os.Stat(keyfile); os.IsNotExist(err) { oldkeyfile := filepath.Join(m.StorageDirectory, "p2p.key") if _, err = os.Stat(oldkeyfile); os.IsNotExist(err) { if err = test.NewMatrixKey(keyfile); err != nil { panic("failed to generate a new PEM key: " + err.Error()) } if _, sk, err = config.LoadMatrixKey(keyfile, os.ReadFile); err != nil { panic("failed to load PEM key: " + err.Error()) } if len(sk) != ed25519.PrivateKeySize { panic("the private key is not long enough") } } else { if sk, err = os.ReadFile(oldkeyfile); err != nil { panic("failed to read the old private key: " + err.Error()) } if len(sk) != ed25519.PrivateKeySize { panic("the private key is not long enough") } if err = test.SaveMatrixKey(keyfile, sk); err != nil { panic("failed to convert the private key to PEM format: " + err.Error()) } } } else { if _, sk, err = config.LoadMatrixKey(keyfile, os.ReadFile); err != nil { panic("failed to load PEM key: " + err.Error()) } if len(sk) != ed25519.PrivateKeySize { panic("the private key is not long enough") } } pk = sk.Public().(ed25519.PublicKey) var err error m.listener, err = net.Listen("tcp", "localhost:65432") if err != nil { panic(err) } m.logger = logrus.Logger{ Out: BindLogger{}, } m.logger.SetOutput(BindLogger{}) logrus.SetOutput(BindLogger{}) pineconeEventChannel := make(chan pineconeEvents.Event) m.PineconeRouter = pineconeRouter.NewRouter(logrus.WithField("pinecone", "router"), sk) m.PineconeRouter.EnableHopLimiting() m.PineconeRouter.EnableWakeupBroadcasts() m.PineconeRouter.Subscribe(pineconeEventChannel) m.PineconeQUIC = pineconeSessions.NewSessions(logrus.WithField("pinecone", "sessions"), m.PineconeRouter, []string{"matrix"}) m.PineconeMulticast = pineconeMulticast.NewMulticast(logrus.WithField("pinecone", "multicast"), m.PineconeRouter) m.PineconeManager = pineconeConnections.NewConnectionManager(m.PineconeRouter, nil) prefix := hex.EncodeToString(pk) cfg := &config.Dendrite{} cfg.Defaults(config.DefaultOpts{ Generate: true, Monolithic: true, }) cfg.Global.ServerName = gomatrixserverlib.ServerName(hex.EncodeToString(pk)) cfg.Global.PrivateKey = sk cfg.Global.KeyID = gomatrixserverlib.KeyID(signing.KeyID) cfg.Global.JetStream.InMemory = false cfg.Global.JetStream.StoragePath = config.Path(filepath.Join(m.CacheDirectory, prefix)) cfg.UserAPI.AccountDatabase.ConnectionString = config.DataSource(fmt.Sprintf("file:%s-account.db", filepath.Join(m.StorageDirectory, prefix))) cfg.MediaAPI.Database.ConnectionString = config.DataSource(fmt.Sprintf("file:%s-mediaapi.db", filepath.Join(m.StorageDirectory, prefix))) cfg.SyncAPI.Database.ConnectionString = config.DataSource(fmt.Sprintf("file:%s-syncapi.db", filepath.Join(m.StorageDirectory, prefix))) cfg.RoomServer.Database.ConnectionString = config.DataSource(fmt.Sprintf("file:%s-roomserver.db", filepath.Join(m.StorageDirectory, prefix))) cfg.KeyServer.Database.ConnectionString = config.DataSource(fmt.Sprintf("file:%s-keyserver.db", filepath.Join(m.StorageDirectory, prefix))) cfg.FederationAPI.Database.ConnectionString = config.DataSource(fmt.Sprintf("file:%s-federationsender.db", filepath.Join(m.StorageDirectory, prefix))) cfg.MediaAPI.BasePath = config.Path(filepath.Join(m.CacheDirectory, "media")) cfg.MediaAPI.AbsBasePath = config.Path(filepath.Join(m.CacheDirectory, "media")) cfg.RelayAPI.Database.ConnectionString = config.DataSource(fmt.Sprintf("file:%s-relayapi.db", filepath.Join(m.StorageDirectory, prefix))) cfg.MSCs.MSCs = []string{"msc2836", "msc2946"} cfg.ClientAPI.RegistrationDisabled = false cfg.ClientAPI.OpenRegistrationWithoutVerificationEnabled = true cfg.SyncAPI.Fulltext.Enabled = true cfg.SyncAPI.Fulltext.IndexPath = config.Path(filepath.Join(m.CacheDirectory, "search")) if err = cfg.Derive(); err != nil { panic(err) } base := base.NewBaseDendrite(cfg, "Monolith", base.DisableMetrics) m.baseDendrite = base base.ConfigureAdminEndpoints() federation := conn.CreateFederationClient(base, m.PineconeQUIC) serverKeyAPI := &signing.YggdrasilKeys{} keyRing := serverKeyAPI.KeyRing() rsAPI := roomserver.NewInternalAPI(base) m.federationAPI = federationapi.NewInternalAPI( base, federation, rsAPI, base.Caches, keyRing, true, ) keyAPI := keyserver.NewInternalAPI(base, &base.Cfg.KeyServer, m.federationAPI, rsAPI) m.userAPI = userapi.NewInternalAPI(base, &cfg.UserAPI, cfg.Derived.ApplicationServices, keyAPI, rsAPI, base.PushGatewayHTTPClient()) keyAPI.SetUserAPI(m.userAPI) asAPI := appservice.NewInternalAPI(base, m.userAPI, rsAPI) // The underlying roomserver implementation needs to be able to call the fedsender. // This is different to rsAPI which can be the http client which doesn't need this dependency rsAPI.SetFederationAPI(m.federationAPI, keyRing) userProvider := users.NewPineconeUserProvider(m.PineconeRouter, m.PineconeQUIC, m.userAPI, federation) roomProvider := rooms.NewPineconeRoomProvider(m.PineconeRouter, m.PineconeQUIC, m.federationAPI, federation) js, _ := base.NATS.Prepare(base.ProcessContext, &base.Cfg.Global.JetStream) producer := &producers.SyncAPIProducer{ JetStream: js, TopicReceiptEvent: base.Cfg.Global.JetStream.Prefixed(jetstream.OutputReceiptEvent), TopicSendToDeviceEvent: base.Cfg.Global.JetStream.Prefixed(jetstream.OutputSendToDeviceEvent), TopicTypingEvent: base.Cfg.Global.JetStream.Prefixed(jetstream.OutputTypingEvent), TopicPresenceEvent: base.Cfg.Global.JetStream.Prefixed(jetstream.OutputPresenceEvent), TopicDeviceListUpdate: base.Cfg.Global.JetStream.Prefixed(jetstream.InputDeviceListUpdate), TopicSigningKeyUpdate: base.Cfg.Global.JetStream.Prefixed(jetstream.InputSigningKeyUpdate), Config: &base.Cfg.FederationAPI, UserAPI: m.userAPI, } relayAPI := relayapi.NewRelayInternalAPI(base, federation, rsAPI, keyRing, producer) monolith := setup.Monolith{ Config: base.Cfg, Client: conn.CreateClient(base, m.PineconeQUIC), FedClient: federation, KeyRing: keyRing, AppserviceAPI: asAPI, FederationAPI: m.federationAPI, RoomserverAPI: rsAPI, UserAPI: m.userAPI, KeyAPI: keyAPI, RelayAPI: relayAPI, ExtPublicRoomsProvider: roomProvider, ExtUserDirectoryProvider: userProvider, } monolith.AddAllPublicRoutes(base) httpRouter := mux.NewRouter().SkipClean(true).UseEncodedPath() httpRouter.PathPrefix(httputil.InternalPathPrefix).Handler(base.InternalAPIMux) httpRouter.PathPrefix(httputil.PublicClientPathPrefix).Handler(base.PublicClientAPIMux) httpRouter.PathPrefix(httputil.PublicMediaPathPrefix).Handler(base.PublicMediaAPIMux) httpRouter.PathPrefix(httputil.DendriteAdminPathPrefix).Handler(base.DendriteAdminMux) httpRouter.PathPrefix(httputil.SynapseAdminPathPrefix).Handler(base.SynapseAdminMux) httpRouter.HandleFunc("/pinecone", m.PineconeRouter.ManholeHandler) pMux := mux.NewRouter().SkipClean(true).UseEncodedPath() pMux.PathPrefix(users.PublicURL).HandlerFunc(userProvider.FederatedUserProfiles) pMux.PathPrefix(httputil.PublicFederationPathPrefix).Handler(base.PublicFederationAPIMux) pMux.PathPrefix(httputil.PublicMediaPathPrefix).Handler(base.PublicMediaAPIMux) pHTTP := m.PineconeQUIC.Protocol("matrix").HTTP() pHTTP.Mux().Handle(users.PublicURL, pMux) pHTTP.Mux().Handle(httputil.PublicFederationPathPrefix, pMux) pHTTP.Mux().Handle(httputil.PublicMediaPathPrefix, pMux) // Build both ends of a HTTP multiplex. h2s := &http2.Server{} m.httpServer = &http.Server{ Addr: ":0", TLSNextProto: map[string]func(*http.Server, *tls.Conn, http.Handler){}, ReadTimeout: 10 * time.Second, WriteTimeout: 10 * time.Second, IdleTimeout: 30 * time.Second, BaseContext: func(_ net.Listener) context.Context { return context.Background() }, Handler: h2c.NewHandler(pMux, h2s), } go func() { m.logger.Info("Listening on ", cfg.Global.ServerName) switch m.httpServer.Serve(m.PineconeQUIC.Protocol("matrix")) { case net.ErrClosed, http.ErrServerClosed: m.logger.Info("Stopped listening on ", cfg.Global.ServerName) default: m.logger.Error("Stopped listening on ", cfg.Global.ServerName) } }() go func() { logrus.Info("Listening on ", m.listener.Addr()) switch http.Serve(m.listener, httpRouter) { case net.ErrClosed, http.ErrServerClosed: m.logger.Info("Stopped listening on ", cfg.Global.ServerName) default: m.logger.Error("Stopped listening on ", cfg.Global.ServerName) } }() go func(ch <-chan pineconeEvents.Event) { eLog := logrus.WithField("pinecone", "events") stopRelayServerSync := make(chan bool) relayRetriever := RelayServerRetriever{ Context: context.Background(), ServerName: gomatrixserverlib.ServerName(m.PineconeRouter.PublicKey().String()), FederationAPI: m.federationAPI, relayServersQueried: make(map[gomatrixserverlib.ServerName]bool), RelayAPI: monolith.RelayAPI, running: *atomic.NewBool(false), } relayRetriever.InitializeRelayServers(eLog) for event := range ch { switch e := event.(type) { case pineconeEvents.PeerAdded: if !relayRetriever.running.Load() { go relayRetriever.SyncRelayServers(stopRelayServerSync) } case pineconeEvents.PeerRemoved: if relayRetriever.running.Load() && m.PineconeRouter.TotalPeerCount() == 0 { stopRelayServerSync <- true } case pineconeEvents.BroadcastReceived: // eLog.Info("Broadcast received from: ", e.PeerID) req := &api.PerformWakeupServersRequest{ ServerNames: []gomatrixserverlib.ServerName{gomatrixserverlib.ServerName(e.PeerID)}, } res := &api.PerformWakeupServersResponse{} if err := m.federationAPI.PerformWakeupServers(base.Context(), req, res); err != nil { eLog.WithError(err).Error("Failed to wakeup destination", e.PeerID) } default: } } }(pineconeEventChannel) } func (m *DendriteMonolith) Stop() { m.baseDendrite.Close() m.baseDendrite.WaitForShutdown() _ = m.listener.Close() m.PineconeMulticast.Stop() _ = m.PineconeQUIC.Close() _ = m.PineconeRouter.Close() } type RelayServerRetriever struct { Context context.Context ServerName gomatrixserverlib.ServerName FederationAPI api.FederationInternalAPI RelayAPI relayServerAPI.RelayInternalAPI relayServersQueried map[gomatrixserverlib.ServerName]bool queriedServersMutex sync.Mutex running atomic.Bool } func (m *RelayServerRetriever) InitializeRelayServers(eLog *logrus.Entry) { request := api.P2PQueryRelayServersRequest{Server: gomatrixserverlib.ServerName(m.ServerName)} response := api.P2PQueryRelayServersResponse{} err := m.FederationAPI.P2PQueryRelayServers(m.Context, &request, &response) if err != nil { eLog.Warnf("Failed obtaining list of this node's relay servers: %s", err.Error()) } for _, server := range response.RelayServers { m.relayServersQueried[server] = false } eLog.Infof("Registered relay servers: %v", response.RelayServers) } func (m *RelayServerRetriever) SyncRelayServers(stop <-chan bool) { defer m.running.Store(false) t := time.NewTimer(relayServerRetryInterval) for { relayServersToQuery := []gomatrixserverlib.ServerName{} func() { m.queriedServersMutex.Lock() defer m.queriedServersMutex.Unlock() for server, complete := range m.relayServersQueried { if !complete { relayServersToQuery = append(relayServersToQuery, server) } } }() if len(relayServersToQuery) == 0 { // All relay servers have been synced. return } m.queryRelayServers(relayServersToQuery) t.Reset(relayServerRetryInterval) select { case <-stop: if !t.Stop() { <-t.C } return case <-t.C: } } } func (m *RelayServerRetriever) GetQueriedServerStatus() map[gomatrixserverlib.ServerName]bool { m.queriedServersMutex.Lock() defer m.queriedServersMutex.Unlock() result := map[gomatrixserverlib.ServerName]bool{} for server, queried := range m.relayServersQueried { result[server] = queried } return result } func (m *RelayServerRetriever) queryRelayServers(relayServers []gomatrixserverlib.ServerName) { logrus.Info("querying relay servers for any available transactions") for _, server := range relayServers { userID, err := gomatrixserverlib.NewUserID("@user:"+string(m.ServerName), false) if err != nil { return } err = m.RelayAPI.PerformRelayServerSync(context.Background(), *userID, server) if err == nil { func() { m.queriedServersMutex.Lock() defer m.queriedServersMutex.Unlock() m.relayServersQueried[server] = true }() // TODO : What happens if your relay receives new messages after this point? // Should you continue to check with them, or should they try and contact you? // They could send a "new_async_events" message your way maybe? // Then you could mark them as needing to be queried again. // What if you miss this message? // Maybe you should try querying them again after a certain period of time as a backup? } else { logrus.Errorf("Failed querying relay server: %s", err.Error()) } } } const MaxFrameSize = types.MaxFrameSize type Conduit struct { closed atomic.Bool conn net.Conn port types.SwitchPortID portMutex sync.Mutex } func (c *Conduit) Port() int { c.portMutex.Lock() defer c.portMutex.Unlock() return int(c.port) } func (c *Conduit) Read(b []byte) (int, error) { if c.closed.Load() { return 0, io.EOF } return c.conn.Read(b) } func (c *Conduit) ReadCopy() ([]byte, error) { if c.closed.Load() { return nil, io.EOF } var buf [65535 * 2]byte n, err := c.conn.Read(buf[:]) if err != nil { return nil, err } return buf[:n], nil } func (c *Conduit) Write(b []byte) (int, error) { if c.closed.Load() { return 0, io.EOF } return c.conn.Write(b) } func (c *Conduit) Close() error { if c.closed.Load() { return io.ErrClosedPipe } c.closed.Store(true) return c.conn.Close() }