mirror of
https://github.com/matrix-org/dendrite
synced 2024-12-19 03:43:51 +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>
52 lines
2.7 KiB
Go
52 lines
2.7 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 devices
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/matrix-org/dendrite/userapi/api"
|
|
)
|
|
|
|
type Database interface {
|
|
GetDeviceByAccessToken(ctx context.Context, token string) (*api.Device, error)
|
|
GetDeviceByID(ctx context.Context, localpart, deviceID string) (*api.Device, error)
|
|
GetDevicesByLocalpart(ctx context.Context, localpart string) ([]api.Device, error)
|
|
GetDevicesByID(ctx context.Context, deviceIDs []string) ([]api.Device, error)
|
|
// CreateDevice makes a new device associated with the given user ID localpart.
|
|
// If there is already a device with the same device ID for this user, that access token will be revoked
|
|
// and replaced with the given accessToken. If the given accessToken is already in use for another device,
|
|
// an error will be returned.
|
|
// If no device ID is given one is generated.
|
|
// Returns the device on success.
|
|
CreateDevice(ctx context.Context, localpart string, deviceID *string, accessToken string, displayName *string, ipAddr, userAgent string) (dev *api.Device, returnErr error)
|
|
UpdateDevice(ctx context.Context, localpart, deviceID string, displayName *string) error
|
|
UpdateDeviceLastSeen(ctx context.Context, localpart, deviceID, ipAddr string) error
|
|
RemoveDevice(ctx context.Context, deviceID, localpart string) error
|
|
RemoveDevices(ctx context.Context, localpart string, devices []string) error
|
|
// RemoveAllDevices deleted all devices for this user. Returns the devices deleted.
|
|
RemoveAllDevices(ctx context.Context, localpart, exceptDeviceID string) (devices []api.Device, err error)
|
|
|
|
// CreateLoginToken generates a token, stores and returns it. The lifetime is
|
|
// determined by the loginTokenLifetime given to the Database constructor.
|
|
CreateLoginToken(ctx context.Context, data *api.LoginTokenData) (*api.LoginTokenMetadata, error)
|
|
|
|
// RemoveLoginToken removes the named token (and may clean up other expired tokens).
|
|
RemoveLoginToken(ctx context.Context, token string) error
|
|
|
|
// GetLoginTokenDataByToken returns the data associated with the given token.
|
|
// May return sql.ErrNoRows.
|
|
GetLoginTokenDataByToken(ctx context.Context, token string) (*api.LoginTokenData, error)
|
|
}
|