mirror of
https://github.com/matrix-org/dendrite
synced 2024-11-16 06:41:06 +01:00
72285b2659
Sister PR to https://github.com/matrix-org/gomatrixserverlib/pull/364 Read this commit by commit to avoid going insane.
350 lines
13 KiB
Go
350 lines
13 KiB
Go
// Copyright 2017 Vector Creations Ltd
|
|
//
|
|
// 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 postgres
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/lib/pq"
|
|
"github.com/matrix-org/dendrite/clientapi/userutil"
|
|
"github.com/matrix-org/dendrite/internal"
|
|
"github.com/matrix-org/dendrite/internal/sqlutil"
|
|
"github.com/matrix-org/dendrite/userapi/api"
|
|
"github.com/matrix-org/dendrite/userapi/storage/postgres/deltas"
|
|
"github.com/matrix-org/dendrite/userapi/storage/tables"
|
|
"github.com/matrix-org/gomatrixserverlib/spec"
|
|
)
|
|
|
|
const devicesSchema = `
|
|
-- This sequence is used for automatic allocation of session_id.
|
|
CREATE SEQUENCE IF NOT EXISTS userapi_device_session_id_seq START 1;
|
|
|
|
-- Stores data about devices.
|
|
CREATE TABLE IF NOT EXISTS userapi_devices (
|
|
-- The access token granted to this device. This has to be the primary key
|
|
-- so we can distinguish which device is making a given request.
|
|
access_token TEXT NOT NULL PRIMARY KEY,
|
|
-- The auto-allocated unique ID of the session identified by the access token.
|
|
-- This can be used as a secure substitution of the access token in situations
|
|
-- where data is associated with access tokens (e.g. transaction storage),
|
|
-- so we don't have to store users' access tokens everywhere.
|
|
session_id BIGINT NOT NULL DEFAULT nextval('userapi_device_session_id_seq'),
|
|
-- The device identifier. This only needs to uniquely identify a device for a given user, not globally.
|
|
-- access_tokens will be clobbered based on the device ID for a user.
|
|
device_id TEXT NOT NULL,
|
|
-- The Matrix user ID localpart for this device. This is preferable to storing the full user_id
|
|
-- as it is smaller, makes it clearer that we only manage devices for our own users, and may make
|
|
-- migration to different domain names easier.
|
|
localpart TEXT NOT NULL,
|
|
server_name TEXT NOT NULL,
|
|
-- When this devices was first recognised on the network, as a unix timestamp (ms resolution).
|
|
created_ts BIGINT NOT NULL,
|
|
-- The display name, human friendlier than device_id and updatable
|
|
display_name TEXT,
|
|
-- The time the device was last used, as a unix timestamp (ms resolution).
|
|
last_seen_ts BIGINT NOT NULL,
|
|
-- The last seen IP address of this device
|
|
ip TEXT,
|
|
-- User agent of this device
|
|
user_agent TEXT
|
|
|
|
-- TODO: device keys, device display names, token restrictions (if 3rd-party OAuth app)
|
|
);
|
|
|
|
-- Device IDs must be unique for a given user.
|
|
CREATE UNIQUE INDEX IF NOT EXISTS userapi_device_localpart_id_idx ON userapi_devices(localpart, server_name, device_id);
|
|
`
|
|
|
|
const insertDeviceSQL = "" +
|
|
"INSERT INTO userapi_devices(device_id, localpart, server_name, access_token, created_ts, display_name, last_seen_ts, ip, user_agent) VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9)" +
|
|
" RETURNING session_id"
|
|
|
|
const selectDeviceByTokenSQL = "" +
|
|
"SELECT session_id, device_id, localpart, server_name FROM userapi_devices WHERE access_token = $1"
|
|
|
|
const selectDeviceByIDSQL = "" +
|
|
"SELECT display_name, last_seen_ts, ip FROM userapi_devices WHERE localpart = $1 AND server_name = $2 AND device_id = $3"
|
|
|
|
const selectDevicesByLocalpartSQL = "" +
|
|
"SELECT device_id, display_name, last_seen_ts, ip, user_agent, session_id FROM userapi_devices WHERE localpart = $1 AND server_name = $2 AND device_id != $3 ORDER BY last_seen_ts DESC"
|
|
|
|
const updateDeviceNameSQL = "" +
|
|
"UPDATE userapi_devices SET display_name = $1 WHERE localpart = $2 AND server_name = $3 AND device_id = $4"
|
|
|
|
const deleteDeviceSQL = "" +
|
|
"DELETE FROM userapi_devices WHERE device_id = $1 AND localpart = $2 AND server_name = $3"
|
|
|
|
const deleteDevicesByLocalpartSQL = "" +
|
|
"DELETE FROM userapi_devices WHERE localpart = $1 AND server_name = $2 AND device_id != $3"
|
|
|
|
const deleteDevicesSQL = "" +
|
|
"DELETE FROM userapi_devices WHERE localpart = $1 AND server_name = $2 AND device_id = ANY($3)"
|
|
|
|
const selectDevicesByIDSQL = "" +
|
|
"SELECT device_id, localpart, server_name, display_name, last_seen_ts, session_id FROM userapi_devices WHERE device_id = ANY($1) ORDER BY last_seen_ts DESC"
|
|
|
|
const updateDeviceLastSeen = "" +
|
|
"UPDATE userapi_devices SET last_seen_ts = $1, ip = $2, user_agent = $3 WHERE localpart = $4 AND server_name = $5 AND device_id = $6"
|
|
|
|
type devicesStatements struct {
|
|
insertDeviceStmt *sql.Stmt
|
|
selectDeviceByTokenStmt *sql.Stmt
|
|
selectDeviceByIDStmt *sql.Stmt
|
|
selectDevicesByLocalpartStmt *sql.Stmt
|
|
selectDevicesByIDStmt *sql.Stmt
|
|
updateDeviceNameStmt *sql.Stmt
|
|
updateDeviceLastSeenStmt *sql.Stmt
|
|
deleteDeviceStmt *sql.Stmt
|
|
deleteDevicesByLocalpartStmt *sql.Stmt
|
|
deleteDevicesStmt *sql.Stmt
|
|
serverName spec.ServerName
|
|
}
|
|
|
|
func NewPostgresDevicesTable(db *sql.DB, serverName spec.ServerName) (tables.DevicesTable, error) {
|
|
s := &devicesStatements{
|
|
serverName: serverName,
|
|
}
|
|
_, err := db.Exec(devicesSchema)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
m := sqlutil.NewMigrator(db)
|
|
m.AddMigrations(sqlutil.Migration{
|
|
Version: "userapi: add last_seen_ts",
|
|
Up: deltas.UpLastSeenTSIP,
|
|
})
|
|
err = m.Up(context.Background())
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return s, sqlutil.StatementList{
|
|
{&s.insertDeviceStmt, insertDeviceSQL},
|
|
{&s.selectDeviceByTokenStmt, selectDeviceByTokenSQL},
|
|
{&s.selectDeviceByIDStmt, selectDeviceByIDSQL},
|
|
{&s.selectDevicesByLocalpartStmt, selectDevicesByLocalpartSQL},
|
|
{&s.updateDeviceNameStmt, updateDeviceNameSQL},
|
|
{&s.deleteDeviceStmt, deleteDeviceSQL},
|
|
{&s.deleteDevicesByLocalpartStmt, deleteDevicesByLocalpartSQL},
|
|
{&s.deleteDevicesStmt, deleteDevicesSQL},
|
|
{&s.selectDevicesByIDStmt, selectDevicesByIDSQL},
|
|
{&s.updateDeviceLastSeenStmt, updateDeviceLastSeen},
|
|
}.Prepare(db)
|
|
}
|
|
|
|
// insertDevice creates a new device. Returns an error if any device with the same access token already exists.
|
|
// Returns an error if the user already has a device with the given device ID.
|
|
// Returns the device on success.
|
|
func (s *devicesStatements) InsertDevice(
|
|
ctx context.Context, txn *sql.Tx, id string,
|
|
localpart string, serverName spec.ServerName,
|
|
accessToken string, displayName *string, ipAddr, userAgent string,
|
|
) (*api.Device, error) {
|
|
createdTimeMS := time.Now().UnixNano() / 1000000
|
|
var sessionID int64
|
|
stmt := sqlutil.TxStmt(txn, s.insertDeviceStmt)
|
|
if err := stmt.QueryRowContext(ctx, id, localpart, serverName, accessToken, createdTimeMS, displayName, createdTimeMS, ipAddr, userAgent).Scan(&sessionID); err != nil {
|
|
return nil, fmt.Errorf("insertDeviceStmt: %w", err)
|
|
}
|
|
dev := &api.Device{
|
|
ID: id,
|
|
UserID: userutil.MakeUserID(localpart, serverName),
|
|
AccessToken: accessToken,
|
|
SessionID: sessionID,
|
|
LastSeenTS: createdTimeMS,
|
|
LastSeenIP: ipAddr,
|
|
UserAgent: userAgent,
|
|
}
|
|
if displayName != nil {
|
|
dev.DisplayName = *displayName
|
|
}
|
|
return dev, nil
|
|
}
|
|
|
|
func (s *devicesStatements) InsertDeviceWithSessionID(ctx context.Context, txn *sql.Tx, id,
|
|
localpart string, serverName spec.ServerName,
|
|
accessToken string, displayName *string, ipAddr, userAgent string,
|
|
sessionID int64,
|
|
) (*api.Device, error) {
|
|
return s.InsertDevice(ctx, txn, id, localpart, serverName, accessToken, displayName, ipAddr, userAgent)
|
|
}
|
|
|
|
// deleteDevice removes a single device by id and user localpart.
|
|
func (s *devicesStatements) DeleteDevice(
|
|
ctx context.Context, txn *sql.Tx, id string,
|
|
localpart string, serverName spec.ServerName,
|
|
) error {
|
|
stmt := sqlutil.TxStmt(txn, s.deleteDeviceStmt)
|
|
_, err := stmt.ExecContext(ctx, id, localpart, serverName)
|
|
return err
|
|
}
|
|
|
|
// deleteDevices removes a single or multiple devices by ids and user localpart.
|
|
// Returns an error if the execution failed.
|
|
func (s *devicesStatements) DeleteDevices(
|
|
ctx context.Context, txn *sql.Tx,
|
|
localpart string, serverName spec.ServerName,
|
|
devices []string,
|
|
) error {
|
|
stmt := sqlutil.TxStmt(txn, s.deleteDevicesStmt)
|
|
_, err := stmt.ExecContext(ctx, localpart, serverName, pq.Array(devices))
|
|
return err
|
|
}
|
|
|
|
// deleteDevicesByLocalpart removes all devices for the
|
|
// given user localpart.
|
|
func (s *devicesStatements) DeleteDevicesByLocalpart(
|
|
ctx context.Context, txn *sql.Tx,
|
|
localpart string, serverName spec.ServerName,
|
|
exceptDeviceID string,
|
|
) error {
|
|
stmt := sqlutil.TxStmt(txn, s.deleteDevicesByLocalpartStmt)
|
|
_, err := stmt.ExecContext(ctx, localpart, serverName, exceptDeviceID)
|
|
return err
|
|
}
|
|
|
|
func (s *devicesStatements) UpdateDeviceName(
|
|
ctx context.Context, txn *sql.Tx,
|
|
localpart string, serverName spec.ServerName,
|
|
deviceID string, displayName *string,
|
|
) error {
|
|
stmt := sqlutil.TxStmt(txn, s.updateDeviceNameStmt)
|
|
_, err := stmt.ExecContext(ctx, displayName, localpart, serverName, deviceID)
|
|
return err
|
|
}
|
|
|
|
func (s *devicesStatements) SelectDeviceByToken(
|
|
ctx context.Context, accessToken string,
|
|
) (*api.Device, error) {
|
|
var dev api.Device
|
|
var localpart string
|
|
var serverName spec.ServerName
|
|
stmt := s.selectDeviceByTokenStmt
|
|
err := stmt.QueryRowContext(ctx, accessToken).Scan(&dev.SessionID, &dev.ID, &localpart, &serverName)
|
|
if err == nil {
|
|
dev.UserID = userutil.MakeUserID(localpart, serverName)
|
|
dev.AccessToken = accessToken
|
|
}
|
|
return &dev, err
|
|
}
|
|
|
|
// selectDeviceByID retrieves a device from the database with the given user
|
|
// localpart and deviceID
|
|
func (s *devicesStatements) SelectDeviceByID(
|
|
ctx context.Context,
|
|
localpart string, serverName spec.ServerName,
|
|
deviceID string,
|
|
) (*api.Device, error) {
|
|
var dev api.Device
|
|
var displayName, ip sql.NullString
|
|
var lastseenTS sql.NullInt64
|
|
stmt := s.selectDeviceByIDStmt
|
|
err := stmt.QueryRowContext(ctx, localpart, serverName, deviceID).Scan(&displayName, &lastseenTS, &ip)
|
|
if err == nil {
|
|
dev.ID = deviceID
|
|
dev.UserID = userutil.MakeUserID(localpart, serverName)
|
|
if displayName.Valid {
|
|
dev.DisplayName = displayName.String
|
|
}
|
|
if lastseenTS.Valid {
|
|
dev.LastSeenTS = lastseenTS.Int64
|
|
}
|
|
if ip.Valid {
|
|
dev.LastSeenIP = ip.String
|
|
}
|
|
}
|
|
return &dev, err
|
|
}
|
|
|
|
func (s *devicesStatements) SelectDevicesByID(ctx context.Context, deviceIDs []string) ([]api.Device, error) {
|
|
rows, err := s.selectDevicesByIDStmt.QueryContext(ctx, pq.StringArray(deviceIDs))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer internal.CloseAndLogIfError(ctx, rows, "selectDevicesByID: rows.close() failed")
|
|
var devices []api.Device
|
|
var dev api.Device
|
|
var localpart string
|
|
var serverName spec.ServerName
|
|
var lastseents sql.NullInt64
|
|
var displayName sql.NullString
|
|
for rows.Next() {
|
|
if err := rows.Scan(&dev.ID, &localpart, &serverName, &displayName, &lastseents, &dev.SessionID); err != nil {
|
|
return nil, err
|
|
}
|
|
if displayName.Valid {
|
|
dev.DisplayName = displayName.String
|
|
}
|
|
if lastseents.Valid {
|
|
dev.LastSeenTS = lastseents.Int64
|
|
}
|
|
dev.UserID = userutil.MakeUserID(localpart, serverName)
|
|
devices = append(devices, dev)
|
|
}
|
|
return devices, rows.Err()
|
|
}
|
|
|
|
func (s *devicesStatements) SelectDevicesByLocalpart(
|
|
ctx context.Context, txn *sql.Tx,
|
|
localpart string, serverName spec.ServerName,
|
|
exceptDeviceID string,
|
|
) ([]api.Device, error) {
|
|
devices := []api.Device{}
|
|
rows, err := sqlutil.TxStmt(txn, s.selectDevicesByLocalpartStmt).QueryContext(ctx, localpart, serverName, exceptDeviceID)
|
|
|
|
if err != nil {
|
|
return devices, err
|
|
}
|
|
defer internal.CloseAndLogIfError(ctx, rows, "selectDevicesByLocalpart: rows.close() failed")
|
|
|
|
var dev api.Device
|
|
var lastseents sql.NullInt64
|
|
var id, displayname, ip, useragent sql.NullString
|
|
for rows.Next() {
|
|
err = rows.Scan(&id, &displayname, &lastseents, &ip, &useragent, &dev.SessionID)
|
|
if err != nil {
|
|
return devices, err
|
|
}
|
|
if id.Valid {
|
|
dev.ID = id.String
|
|
}
|
|
if displayname.Valid {
|
|
dev.DisplayName = displayname.String
|
|
}
|
|
if lastseents.Valid {
|
|
dev.LastSeenTS = lastseents.Int64
|
|
}
|
|
if ip.Valid {
|
|
dev.LastSeenIP = ip.String
|
|
}
|
|
if useragent.Valid {
|
|
dev.UserAgent = useragent.String
|
|
}
|
|
|
|
dev.UserID = userutil.MakeUserID(localpart, serverName)
|
|
devices = append(devices, dev)
|
|
}
|
|
|
|
return devices, rows.Err()
|
|
}
|
|
|
|
func (s *devicesStatements) UpdateDeviceLastSeen(ctx context.Context, txn *sql.Tx, localpart string, serverName spec.ServerName, deviceID, ipAddr, userAgent string) error {
|
|
lastSeenTs := time.Now().UnixNano() / 1000000
|
|
stmt := sqlutil.TxStmt(txn, s.updateDeviceLastSeenStmt)
|
|
_, err := stmt.ExecContext(ctx, lastSeenTs, ipAddr, userAgent, localpart, serverName, deviceID)
|
|
return err
|
|
}
|