2018-12-23 20:04:54 +00:00
|
|
|
# Pleroma: A lightweight social networking server
|
2021-01-13 06:49:20 +00:00
|
|
|
# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
|
2018-12-23 20:04:54 +00:00
|
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
|
2017-09-06 17:06:25 +00:00
|
|
|
defmodule Pleroma.Web.OAuth.Token do
|
|
|
|
use Ecto.Schema
|
|
|
|
|
2019-05-06 17:51:03 +00:00
|
|
|
import Ecto.Changeset
|
2018-10-13 23:45:11 +00:00
|
|
|
|
2019-02-09 15:16:26 +00:00
|
|
|
alias Pleroma.Repo
|
2019-03-05 02:52:23 +00:00
|
|
|
alias Pleroma.User
|
2019-02-09 15:16:26 +00:00
|
|
|
alias Pleroma.Web.OAuth.App
|
|
|
|
alias Pleroma.Web.OAuth.Authorization
|
2019-03-05 02:52:23 +00:00
|
|
|
alias Pleroma.Web.OAuth.Token
|
2019-05-22 15:44:50 +00:00
|
|
|
alias Pleroma.Web.OAuth.Token.Query
|
2017-09-06 17:06:25 +00:00
|
|
|
|
2019-05-06 17:51:03 +00:00
|
|
|
@type t :: %__MODULE__{}
|
|
|
|
|
2017-09-06 17:06:25 +00:00
|
|
|
schema "oauth_tokens" do
|
2018-03-30 13:01:53 +00:00
|
|
|
field(:token, :string)
|
|
|
|
field(:refresh_token, :string)
|
2019-02-13 21:29:29 +00:00
|
|
|
field(:scopes, {:array, :string}, default: [])
|
2019-03-20 12:59:27 +00:00
|
|
|
field(:valid_until, :naive_datetime_usec)
|
2019-09-18 14:54:31 +00:00
|
|
|
belongs_to(:user, User, type: FlakeId.Ecto.CompatType)
|
2018-05-07 16:11:37 +00:00
|
|
|
belongs_to(:app, App)
|
2017-09-06 17:06:25 +00:00
|
|
|
|
|
|
|
timestamps()
|
|
|
|
end
|
|
|
|
|
2020-12-09 18:14:39 +00:00
|
|
|
def lifespan do
|
|
|
|
Pleroma.Config.get!([:oauth2, :token_expires_in])
|
|
|
|
end
|
|
|
|
|
2020-11-21 16:47:25 +00:00
|
|
|
@doc "Gets token by unique access token"
|
|
|
|
@spec get_by_token(String.t()) :: {:ok, t()} | {:error, :not_found}
|
|
|
|
def get_by_token(token) do
|
|
|
|
token
|
|
|
|
|> Query.get_by_token()
|
|
|
|
|> Repo.find_resource()
|
|
|
|
end
|
|
|
|
|
2022-08-21 14:46:52 +00:00
|
|
|
def get_by_app(%App{} = app) do
|
|
|
|
app.id
|
|
|
|
|> Query.get_unexpired_by_app()
|
|
|
|
|> Repo.find_resource()
|
|
|
|
end
|
|
|
|
|
2019-05-06 17:51:03 +00:00
|
|
|
@doc "Gets token for app by access token"
|
|
|
|
@spec get_by_token(App.t(), String.t()) :: {:ok, t()} | {:error, :not_found}
|
|
|
|
def get_by_token(%App{id: app_id} = _app, token) do
|
2019-05-22 15:44:50 +00:00
|
|
|
Query.get_by_app(app_id)
|
|
|
|
|> Query.get_by_token(token)
|
2019-05-06 17:51:03 +00:00
|
|
|
|> Repo.find_resource()
|
|
|
|
end
|
|
|
|
|
|
|
|
@doc "Gets token for app by refresh token"
|
|
|
|
@spec get_by_refresh_token(App.t(), String.t()) :: {:ok, t()} | {:error, :not_found}
|
|
|
|
def get_by_refresh_token(%App{id: app_id} = _app, token) do
|
2019-05-22 15:44:50 +00:00
|
|
|
Query.get_by_app(app_id)
|
|
|
|
|> Query.get_by_refresh_token(token)
|
|
|
|
|> Query.preload([:user])
|
2019-05-06 17:51:03 +00:00
|
|
|
|> Repo.find_resource()
|
|
|
|
end
|
|
|
|
|
2019-07-29 02:43:19 +00:00
|
|
|
@spec exchange_token(App.t(), Authorization.t()) :: {:ok, Token.t()} | {:error, Changeset.t()}
|
2017-09-09 10:02:59 +00:00
|
|
|
def exchange_token(app, auth) do
|
|
|
|
with {:ok, auth} <- Authorization.use_token(auth),
|
|
|
|
true <- auth.app_id == app.id do
|
2019-05-13 18:35:45 +00:00
|
|
|
user = if auth.user_id, do: User.get_cached_by_id(auth.user_id), else: %User{}
|
|
|
|
|
2020-08-25 16:17:51 +00:00
|
|
|
create(
|
2019-05-06 17:51:03 +00:00
|
|
|
app,
|
2019-05-13 18:35:45 +00:00
|
|
|
user,
|
2019-05-06 17:51:03 +00:00
|
|
|
%{scopes: auth.scopes}
|
|
|
|
)
|
2017-09-09 10:02:59 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2019-05-06 17:51:03 +00:00
|
|
|
defp put_token(changeset) do
|
|
|
|
changeset
|
|
|
|
|> change(%{token: Token.Utils.generate_token()})
|
|
|
|
|> validate_required([:token])
|
|
|
|
|> unique_constraint(:token)
|
|
|
|
end
|
|
|
|
|
|
|
|
defp put_refresh_token(changeset, attrs) do
|
|
|
|
refresh_token = Map.get(attrs, :refresh_token, Token.Utils.generate_token())
|
|
|
|
|
|
|
|
changeset
|
|
|
|
|> change(%{refresh_token: refresh_token})
|
|
|
|
|> validate_required([:refresh_token])
|
|
|
|
|> unique_constraint(:refresh_token)
|
|
|
|
end
|
|
|
|
|
|
|
|
defp put_valid_until(changeset, attrs) do
|
2020-12-09 18:14:39 +00:00
|
|
|
valid_until =
|
|
|
|
Map.get(attrs, :valid_until, NaiveDateTime.add(NaiveDateTime.utc_now(), lifespan()))
|
2019-05-06 17:51:03 +00:00
|
|
|
|
|
|
|
changeset
|
2020-12-09 18:14:39 +00:00
|
|
|
|> change(%{valid_until: valid_until})
|
2019-05-06 17:51:03 +00:00
|
|
|
|> validate_required([:valid_until])
|
|
|
|
end
|
|
|
|
|
2020-08-25 16:17:51 +00:00
|
|
|
@spec create(App.t(), User.t(), map()) :: {:ok, Token} | {:error, Changeset.t()}
|
|
|
|
def create(%App{} = app, %User{} = user, attrs \\ %{}) do
|
|
|
|
with {:ok, token} <- do_create(app, user, attrs) do
|
|
|
|
if Pleroma.Config.get([:oauth2, :clean_expired_tokens]) do
|
2020-09-05 15:35:01 +00:00
|
|
|
Pleroma.Workers.PurgeExpiredToken.enqueue(%{
|
2020-08-25 16:17:51 +00:00
|
|
|
token_id: token.id,
|
2020-09-05 15:35:01 +00:00
|
|
|
valid_until: DateTime.from_naive!(token.valid_until, "Etc/UTC"),
|
|
|
|
mod: __MODULE__
|
2020-08-25 16:17:51 +00:00
|
|
|
})
|
|
|
|
end
|
|
|
|
|
|
|
|
{:ok, token}
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defp do_create(app, user, attrs) do
|
2019-05-06 17:51:03 +00:00
|
|
|
%__MODULE__{user_id: user.id, app_id: app.id}
|
|
|
|
|> cast(%{scopes: attrs[:scopes] || app.scopes}, [:scopes])
|
2019-05-13 18:35:45 +00:00
|
|
|
|> validate_required([:scopes, :app_id])
|
2019-05-06 17:51:03 +00:00
|
|
|
|> put_valid_until(attrs)
|
2019-05-13 18:35:45 +00:00
|
|
|
|> put_token()
|
2019-05-06 17:51:03 +00:00
|
|
|
|> put_refresh_token(attrs)
|
|
|
|
|> Repo.insert()
|
2017-09-06 17:06:25 +00:00
|
|
|
end
|
2018-10-13 23:45:11 +00:00
|
|
|
|
|
|
|
def delete_user_tokens(%User{id: user_id}) do
|
2019-05-22 15:44:50 +00:00
|
|
|
Query.get_by_user(user_id)
|
2018-10-13 23:45:11 +00:00
|
|
|
|> Repo.delete_all()
|
|
|
|
end
|
2019-02-10 19:41:06 +00:00
|
|
|
|
2019-02-10 21:49:56 +00:00
|
|
|
def delete_user_token(%User{id: user_id}, token_id) do
|
2019-05-22 15:44:50 +00:00
|
|
|
Query.get_by_user(user_id)
|
|
|
|
|> Query.get_by_id(token_id)
|
|
|
|
|> Repo.delete_all()
|
|
|
|
end
|
|
|
|
|
2019-02-10 21:49:56 +00:00
|
|
|
def get_user_tokens(%User{id: user_id}) do
|
2019-05-22 15:44:50 +00:00
|
|
|
Query.get_by_user(user_id)
|
|
|
|
|> Query.preload([:app])
|
2019-02-10 19:41:06 +00:00
|
|
|
|> Repo.all()
|
|
|
|
end
|
2019-05-06 17:51:03 +00:00
|
|
|
|
|
|
|
def is_expired?(%__MODULE__{valid_until: valid_until}) do
|
|
|
|
NaiveDateTime.diff(NaiveDateTime.utc_now(), valid_until) > 0
|
|
|
|
end
|
|
|
|
|
|
|
|
def is_expired?(_), do: false
|
2017-09-06 17:06:25 +00:00
|
|
|
end
|