mirror of
https://github.com/matrix-org/dendrite
synced 2024-11-13 21:31:08 +01:00
c36e4546c3
* Add GOPATH to PATH in find-lint.sh.
The user doesn't necessarily have it in PATH.
* Refactor LoginTypePassword and Type to support m.login.token and m.login.sso.
For login token:
* m.login.token will require deleting the token after completeAuth has
generated an access token, so a cleanup function is returned by
Type.Login.
* Allowing different login types will require parsing the /login body
twice: first to extract the "type" and then the type-specific parsing.
Thus, we will have to buffer the request JSON in /login, like
UserInteractive already does.
For SSO:
* NewUserInteractive will have to also use GetAccountByLocalpart. It
makes more sense to just pass a (narrowed-down) accountDB interface
to it than adding more function pointers.
Code quality:
* Passing around (and down-casting) interface{} for login request types
has drawbacks in terms of type-safety, and no inherent benefits. We
always decode JSON anyway. Hence renaming to Type.LoginFromJSON. Code
that directly uses LoginTypePassword with parsed data can still use
Login.
* Removed a TODO for SSO. This is already tracked in #1297.
* httputil.UnmarshalJSON is useful because it returns a JSONResponse.
This change is intended to have no functional changes.
* Support login tokens in User API.
This adds full lifecycle functions for login tokens: create, query, delete.
* Support m.login.token in /login.
* Fixes for PR review.
* Set @matrix-org/dendrite-core as repository code owner
* Return event NID from `StoreEvent`, match PSQL vs SQLite behaviour, tweak backfill persistence (#2071)
Co-authored-by: kegsay <kegan@matrix.org>
Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com>
93 lines
3.2 KiB
Go
93 lines
3.2 KiB
Go
// Copyright 2021 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 postgres
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"time"
|
|
|
|
"github.com/matrix-org/dendrite/internal/sqlutil"
|
|
"github.com/matrix-org/dendrite/userapi/api"
|
|
"github.com/matrix-org/util"
|
|
)
|
|
|
|
type loginTokenStatements struct {
|
|
insertStmt *sql.Stmt
|
|
deleteStmt *sql.Stmt
|
|
selectByTokenStmt *sql.Stmt
|
|
}
|
|
|
|
// execSchema ensures tables and indices exist.
|
|
func (s *loginTokenStatements) execSchema(db *sql.DB) error {
|
|
_, err := db.Exec(`
|
|
CREATE TABLE IF NOT EXISTS login_tokens (
|
|
-- The random value of the token issued to a user
|
|
token TEXT NOT NULL PRIMARY KEY,
|
|
-- When the token expires
|
|
token_expires_at TIMESTAMP NOT NULL,
|
|
|
|
-- The mxid for this account
|
|
user_id TEXT NOT NULL
|
|
);
|
|
|
|
-- This index allows efficient garbage collection of expired tokens.
|
|
CREATE INDEX IF NOT EXISTS login_tokens_expiration_idx ON login_tokens(token_expires_at);
|
|
`)
|
|
return err
|
|
}
|
|
|
|
// prepare runs statement preparation.
|
|
func (s *loginTokenStatements) prepare(db *sql.DB) error {
|
|
return sqlutil.StatementList{
|
|
{&s.insertStmt, "INSERT INTO login_tokens(token, token_expires_at, user_id) VALUES ($1, $2, $3)"},
|
|
{&s.deleteStmt, "DELETE FROM login_tokens WHERE token = $1 OR token_expires_at <= $2"},
|
|
{&s.selectByTokenStmt, "SELECT user_id FROM login_tokens WHERE token = $1 AND token_expires_at > $2"},
|
|
}.Prepare(db)
|
|
}
|
|
|
|
// insert adds an already generated token to the database.
|
|
func (s *loginTokenStatements) insert(ctx context.Context, txn *sql.Tx, metadata *api.LoginTokenMetadata, data *api.LoginTokenData) error {
|
|
stmt := sqlutil.TxStmt(txn, s.insertStmt)
|
|
_, err := stmt.ExecContext(ctx, metadata.Token, metadata.Expiration.UTC(), data.UserID)
|
|
return err
|
|
}
|
|
|
|
// deleteByToken removes the named token.
|
|
//
|
|
// As a simple way to garbage-collect stale tokens, we also remove all expired tokens.
|
|
// The login_tokens_expiration_idx index should make that efficient.
|
|
func (s *loginTokenStatements) deleteByToken(ctx context.Context, txn *sql.Tx, token string) error {
|
|
stmt := sqlutil.TxStmt(txn, s.deleteStmt)
|
|
res, err := stmt.ExecContext(ctx, token, time.Now().UTC())
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if n, err := res.RowsAffected(); err == nil && n > 1 {
|
|
util.GetLogger(ctx).WithField("num_deleted", n).Infof("Deleted %d login tokens (%d likely additional expired token)", n, n-1)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// selectByToken returns the data associated with the given token. May return sql.ErrNoRows.
|
|
func (s *loginTokenStatements) selectByToken(ctx context.Context, token string) (*api.LoginTokenData, error) {
|
|
var data api.LoginTokenData
|
|
err := s.selectByTokenStmt.QueryRowContext(ctx, token, time.Now().UTC()).Scan(&data.UserID)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &data, nil
|
|
}
|