mirror of
https://github.com/matrix-org/dendrite.git
synced 2026-01-17 11:03:11 -06:00
416 lines
15 KiB
Go
416 lines
15 KiB
Go
// Copyright 2020 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 shared
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"encoding/json"
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/matrix-org/dendrite/federationapi/storage/tables"
|
|
"github.com/matrix-org/dendrite/federationapi/types"
|
|
"github.com/matrix-org/dendrite/internal/caching"
|
|
"github.com/matrix-org/dendrite/internal/sqlutil"
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
)
|
|
|
|
type Database struct {
|
|
DB *sql.DB
|
|
IsLocalServerName func(gomatrixserverlib.ServerName) bool
|
|
Cache caching.FederationCache
|
|
Writer sqlutil.Writer
|
|
FederationQueuePDUs tables.FederationQueuePDUs
|
|
FederationQueueEDUs tables.FederationQueueEDUs
|
|
FederationQueueJSON tables.FederationQueueJSON
|
|
FederationJoinedHosts tables.FederationJoinedHosts
|
|
FederationBlacklist tables.FederationBlacklist
|
|
FederationAssumedOffline tables.FederationAssumedOffline
|
|
FederationRelayServers tables.FederationRelayServers
|
|
FederationOutboundPeeks tables.FederationOutboundPeeks
|
|
FederationInboundPeeks tables.FederationInboundPeeks
|
|
NotaryServerKeysJSON tables.FederationNotaryServerKeysJSON
|
|
NotaryServerKeysMetadata tables.FederationNotaryServerKeysMetadata
|
|
ServerSigningKeys tables.FederationServerSigningKeys
|
|
FederationQueueTransactions tables.FederationQueueTransactions
|
|
FederationTransactionJSON tables.FederationTransactionJSON
|
|
}
|
|
|
|
// An Receipt contains the NIDs of a call to GetNextTransactionPDUs/EDUs.
|
|
// We don't actually export the NIDs but we need the caller to be able
|
|
// to pass them back so that we can clean up if the transaction sends
|
|
// successfully.
|
|
type Receipt struct {
|
|
nid int64
|
|
}
|
|
|
|
func NewReceipt(nid int64) Receipt {
|
|
return Receipt{nid: nid}
|
|
}
|
|
|
|
func (r *Receipt) String() string {
|
|
return fmt.Sprintf("%d", r.nid)
|
|
}
|
|
|
|
// UpdateRoom updates the joined hosts for a room and returns what the joined
|
|
// hosts were before the update, or nil if this was a duplicate message.
|
|
// This is called when we receive a message from kafka, so we pass in
|
|
// oldEventID and newEventID to check that we haven't missed any messages or
|
|
// this isn't a duplicate message.
|
|
func (d *Database) UpdateRoom(
|
|
ctx context.Context,
|
|
roomID string,
|
|
addHosts []types.JoinedHost,
|
|
removeHosts []string,
|
|
purgeRoomFirst bool,
|
|
) (joinedHosts []types.JoinedHost, err error) {
|
|
err = d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
if purgeRoomFirst {
|
|
if err = d.FederationJoinedHosts.DeleteJoinedHostsForRoom(ctx, txn, roomID); err != nil {
|
|
return fmt.Errorf("d.FederationJoinedHosts.DeleteJoinedHosts: %w", err)
|
|
}
|
|
for _, add := range addHosts {
|
|
if err = d.FederationJoinedHosts.InsertJoinedHosts(ctx, txn, roomID, add.MemberEventID, add.ServerName); err != nil {
|
|
return err
|
|
}
|
|
joinedHosts = append(joinedHosts, add)
|
|
}
|
|
} else {
|
|
if joinedHosts, err = d.FederationJoinedHosts.SelectJoinedHostsWithTx(ctx, txn, roomID); err != nil {
|
|
return err
|
|
}
|
|
for _, add := range addHosts {
|
|
if err = d.FederationJoinedHosts.InsertJoinedHosts(ctx, txn, roomID, add.MemberEventID, add.ServerName); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
if err = d.FederationJoinedHosts.DeleteJoinedHosts(ctx, txn, removeHosts); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
})
|
|
return
|
|
}
|
|
|
|
// GetJoinedHosts returns the currently joined hosts for room,
|
|
// as known to federationserver.
|
|
// Returns an error if something goes wrong.
|
|
func (d *Database) GetJoinedHosts(
|
|
ctx context.Context, roomID string,
|
|
) ([]types.JoinedHost, error) {
|
|
return d.FederationJoinedHosts.SelectJoinedHosts(ctx, roomID)
|
|
}
|
|
|
|
// GetAllJoinedHosts returns the currently joined hosts for
|
|
// all rooms known to the federation sender.
|
|
// Returns an error if something goes wrong.
|
|
func (d *Database) GetAllJoinedHosts(ctx context.Context) ([]gomatrixserverlib.ServerName, error) {
|
|
return d.FederationJoinedHosts.SelectAllJoinedHosts(ctx)
|
|
}
|
|
|
|
func (d *Database) GetJoinedHostsForRooms(ctx context.Context, roomIDs []string, excludeSelf, excludeBlacklisted bool) ([]gomatrixserverlib.ServerName, error) {
|
|
servers, err := d.FederationJoinedHosts.SelectJoinedHostsForRooms(ctx, roomIDs, excludeBlacklisted)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if excludeSelf {
|
|
for i, server := range servers {
|
|
if d.IsLocalServerName(server) {
|
|
copy(servers[i:], servers[i+1:])
|
|
servers = servers[:len(servers)-1]
|
|
break
|
|
}
|
|
}
|
|
}
|
|
return servers, nil
|
|
}
|
|
|
|
// StoreJSON adds a JSON blob into the queue JSON table and returns
|
|
// a NID. The NID will then be used when inserting the per-destination
|
|
// metadata entries.
|
|
func (d *Database) StoreJSON(
|
|
ctx context.Context, js string,
|
|
) (*Receipt, error) {
|
|
var nid int64
|
|
var err error
|
|
_ = d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
nid, err = d.FederationQueueJSON.InsertQueueJSON(ctx, txn, js)
|
|
return err
|
|
})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("d.insertQueueJSON: %w", err)
|
|
}
|
|
return &Receipt{
|
|
nid: nid,
|
|
}, nil
|
|
}
|
|
|
|
func (d *Database) AddServerToBlacklist(serverName gomatrixserverlib.ServerName) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationBlacklist.InsertBlacklist(context.TODO(), txn, serverName)
|
|
})
|
|
}
|
|
|
|
func (d *Database) RemoveServerFromBlacklist(serverName gomatrixserverlib.ServerName) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationBlacklist.DeleteBlacklist(context.TODO(), txn, serverName)
|
|
})
|
|
}
|
|
|
|
func (d *Database) RemoveAllServersFromBlacklist() error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationBlacklist.DeleteAllBlacklist(context.TODO(), txn)
|
|
})
|
|
}
|
|
|
|
func (d *Database) IsServerBlacklisted(serverName gomatrixserverlib.ServerName) (bool, error) {
|
|
return d.FederationBlacklist.SelectBlacklist(context.TODO(), nil, serverName)
|
|
}
|
|
|
|
func (d *Database) SetServerAssumedOffline(serverName gomatrixserverlib.ServerName) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationAssumedOffline.InsertAssumedOffline(context.TODO(), txn, serverName)
|
|
})
|
|
}
|
|
|
|
func (d *Database) RemoveServerAssumedOffline(serverName gomatrixserverlib.ServerName) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationAssumedOffline.DeleteAssumedOffline(context.TODO(), txn, serverName)
|
|
})
|
|
}
|
|
|
|
func (d *Database) RemoveAllServersAssumedOffline() error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationAssumedOffline.DeleteAllAssumedOffline(context.TODO(), txn)
|
|
})
|
|
}
|
|
|
|
func (d *Database) IsServerAssumedOffline(serverName gomatrixserverlib.ServerName) (bool, error) {
|
|
return d.FederationAssumedOffline.SelectAssumedOffline(context.TODO(), nil, serverName)
|
|
}
|
|
|
|
func (d *Database) AddRelayServersForServer(serverName gomatrixserverlib.ServerName, relayServers []gomatrixserverlib.ServerName) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationRelayServers.InsertRelayServers(context.TODO(), txn, serverName, relayServers)
|
|
})
|
|
}
|
|
|
|
func (d *Database) GetRelayServersForServer(serverName gomatrixserverlib.ServerName) ([]gomatrixserverlib.ServerName, error) {
|
|
return d.FederationRelayServers.SelectRelayServers(context.TODO(), nil, serverName)
|
|
}
|
|
|
|
func (d *Database) RemoveRelayServersForServer(serverName gomatrixserverlib.ServerName, relayServers []gomatrixserverlib.ServerName) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationRelayServers.DeleteRelayServers(context.TODO(), txn, serverName, relayServers)
|
|
})
|
|
}
|
|
|
|
func (d *Database) RemoveAllRelayServersForServer(serverName gomatrixserverlib.ServerName) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationRelayServers.DeleteAllRelayServers(context.TODO(), txn, serverName)
|
|
})
|
|
}
|
|
|
|
func (d *Database) AddOutboundPeek(ctx context.Context, serverName gomatrixserverlib.ServerName, roomID, peekID string, renewalInterval int64) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationOutboundPeeks.InsertOutboundPeek(ctx, txn, serverName, roomID, peekID, renewalInterval)
|
|
})
|
|
}
|
|
|
|
func (d *Database) RenewOutboundPeek(ctx context.Context, serverName gomatrixserverlib.ServerName, roomID, peekID string, renewalInterval int64) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationOutboundPeeks.RenewOutboundPeek(ctx, txn, serverName, roomID, peekID, renewalInterval)
|
|
})
|
|
}
|
|
|
|
func (d *Database) GetOutboundPeek(ctx context.Context, serverName gomatrixserverlib.ServerName, roomID, peekID string) (*types.OutboundPeek, error) {
|
|
return d.FederationOutboundPeeks.SelectOutboundPeek(ctx, nil, serverName, roomID, peekID)
|
|
}
|
|
|
|
func (d *Database) GetOutboundPeeks(ctx context.Context, roomID string) ([]types.OutboundPeek, error) {
|
|
return d.FederationOutboundPeeks.SelectOutboundPeeks(ctx, nil, roomID)
|
|
}
|
|
|
|
func (d *Database) AddInboundPeek(ctx context.Context, serverName gomatrixserverlib.ServerName, roomID, peekID string, renewalInterval int64) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationInboundPeeks.InsertInboundPeek(ctx, txn, serverName, roomID, peekID, renewalInterval)
|
|
})
|
|
}
|
|
|
|
func (d *Database) RenewInboundPeek(ctx context.Context, serverName gomatrixserverlib.ServerName, roomID, peekID string, renewalInterval int64) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
return d.FederationInboundPeeks.RenewInboundPeek(ctx, txn, serverName, roomID, peekID, renewalInterval)
|
|
})
|
|
}
|
|
|
|
func (d *Database) GetInboundPeek(ctx context.Context, serverName gomatrixserverlib.ServerName, roomID, peekID string) (*types.InboundPeek, error) {
|
|
return d.FederationInboundPeeks.SelectInboundPeek(ctx, nil, serverName, roomID, peekID)
|
|
}
|
|
|
|
func (d *Database) GetInboundPeeks(ctx context.Context, roomID string) ([]types.InboundPeek, error) {
|
|
return d.FederationInboundPeeks.SelectInboundPeeks(ctx, nil, roomID)
|
|
}
|
|
|
|
func (d *Database) UpdateNotaryKeys(ctx context.Context, serverName gomatrixserverlib.ServerName, serverKeys gomatrixserverlib.ServerKeys) error {
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
validUntil := serverKeys.ValidUntilTS
|
|
// Servers MUST use the lesser of this field and 7 days into the future when determining if a key is valid.
|
|
// This is to avoid a situation where an attacker publishes a key which is valid for a significant amount of
|
|
// time without a way for the homeserver owner to revoke it.
|
|
// https://spec.matrix.org/unstable/server-server-api/#querying-keys-through-another-server
|
|
weekIntoFuture := time.Now().Add(7 * 24 * time.Hour)
|
|
if weekIntoFuture.Before(validUntil.Time()) {
|
|
validUntil = gomatrixserverlib.AsTimestamp(weekIntoFuture)
|
|
}
|
|
notaryID, err := d.NotaryServerKeysJSON.InsertJSONResponse(ctx, txn, serverKeys, serverName, validUntil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
// update the metadata for the keys
|
|
for keyID := range serverKeys.OldVerifyKeys {
|
|
_, err = d.NotaryServerKeysMetadata.UpsertKey(ctx, txn, serverName, keyID, notaryID, validUntil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
for keyID := range serverKeys.VerifyKeys {
|
|
_, err = d.NotaryServerKeysMetadata.UpsertKey(ctx, txn, serverName, keyID, notaryID, validUntil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// clean up old responses
|
|
return d.NotaryServerKeysMetadata.DeleteOldJSONResponses(ctx, txn)
|
|
})
|
|
}
|
|
|
|
func (d *Database) GetNotaryKeys(
|
|
ctx context.Context, serverName gomatrixserverlib.ServerName, optKeyIDs []gomatrixserverlib.KeyID,
|
|
) (sks []gomatrixserverlib.ServerKeys, err error) {
|
|
err = d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
sks, err = d.NotaryServerKeysMetadata.SelectKeys(ctx, txn, serverName, optKeyIDs)
|
|
return err
|
|
})
|
|
return sks, err
|
|
}
|
|
|
|
func (d *Database) StoreAsyncTransaction(
|
|
ctx context.Context, txn gomatrixserverlib.Transaction,
|
|
) (*Receipt, error) {
|
|
var err error
|
|
json, err := json.Marshal(txn)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("d.JSONUnmarshall: %w", err)
|
|
}
|
|
|
|
var nid int64
|
|
_ = d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
nid, err = d.FederationTransactionJSON.InsertTransactionJSON(ctx, txn, string(json))
|
|
return err
|
|
})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("d.insertTransactionJSON: %w", err)
|
|
}
|
|
return &Receipt{
|
|
nid: nid,
|
|
}, nil
|
|
}
|
|
|
|
func (d *Database) AssociateAsyncTransactionWithDestinations(
|
|
ctx context.Context,
|
|
destinations map[gomatrixserverlib.UserID]struct{},
|
|
transactionID gomatrixserverlib.TransactionID,
|
|
receipt *Receipt,
|
|
) error {
|
|
for destination := range destinations {
|
|
err := d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
err := d.FederationQueueTransactions.InsertQueueTransaction(
|
|
ctx, txn, transactionID, destination.Domain(), receipt.nid)
|
|
return err
|
|
})
|
|
if err != nil {
|
|
return fmt.Errorf("d.insertQueueTransaction: %w", err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (d *Database) CleanAsyncTransactions(
|
|
ctx context.Context,
|
|
userID gomatrixserverlib.UserID,
|
|
receipts []*Receipt,
|
|
) error {
|
|
println(len(receipts))
|
|
nids := make([]int64, len(receipts))
|
|
for i, receipt := range receipts {
|
|
nids[i] = receipt.nid
|
|
}
|
|
err := d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
err := d.FederationQueueTransactions.DeleteQueueTransactions(ctx, txn, userID.Domain(), nids)
|
|
return err
|
|
})
|
|
if err != nil {
|
|
return fmt.Errorf("d.insertQueueTransaction: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (d *Database) GetAsyncTransaction(
|
|
ctx context.Context,
|
|
userID gomatrixserverlib.UserID,
|
|
) (*gomatrixserverlib.Transaction, *Receipt, error) {
|
|
nids, err := d.FederationQueueTransactions.SelectQueueTransactions(ctx, nil, userID.Domain(), 1)
|
|
if err != nil {
|
|
return nil, nil, fmt.Errorf("d.SelectQueueTransaction: %w", err)
|
|
}
|
|
if len(nids) == 0 {
|
|
return nil, nil, nil
|
|
}
|
|
|
|
txns := map[int64][]byte{}
|
|
err = d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
|
txns, err = d.FederationTransactionJSON.SelectTransactionJSON(ctx, txn, nids)
|
|
return err
|
|
})
|
|
if err != nil {
|
|
return nil, nil, fmt.Errorf("d.SelectTransactionJSON: %w", err)
|
|
}
|
|
|
|
transaction := &gomatrixserverlib.Transaction{}
|
|
err = json.Unmarshal(txns[nids[0]], transaction)
|
|
if err != nil {
|
|
return nil, nil, fmt.Errorf("Unmarshall transaction: %w", err)
|
|
}
|
|
|
|
receipt := NewReceipt(nids[0])
|
|
return transaction, &receipt, nil
|
|
}
|
|
|
|
func (d *Database) GetAsyncTransactionCount(
|
|
ctx context.Context,
|
|
userID gomatrixserverlib.UserID,
|
|
) (int64, error) {
|
|
count, err := d.FederationQueueTransactions.SelectQueueTransactionCount(ctx, nil, userID.Domain())
|
|
if err != nil {
|
|
return 0, fmt.Errorf("d.SelectQueueTransactionCount: %w", err)
|
|
}
|
|
return count, nil
|
|
}
|