# Pleroma: A lightweight social networking server # Copyright © 2017-2021 Pleroma Authors # SPDX-License-Identifier: AGPL-3.0-only defmodule Pleroma.Web.OAuth.Token do use Ecto.Schema import Ecto.Changeset alias Pleroma.Repo alias Pleroma.User alias Pleroma.Web.OAuth.App alias Pleroma.Web.OAuth.Authorization alias Pleroma.Web.OAuth.Token alias Pleroma.Web.OAuth.Token.Query @type t :: %__MODULE__{} schema "oauth_tokens" do field(:token, :string) field(:refresh_token, :string) field(:scopes, {:array, :string}, default: []) field(:valid_until, :naive_datetime_usec) belongs_to(:user, User, type: FlakeId.Ecto.CompatType) belongs_to(:app, App) timestamps() end def lifespan do Pleroma.Config.get!([:oauth2, :token_expires_in]) end @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 @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 Query.get_by_app(app_id) |> Query.get_by_token(token) |> 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 Query.get_by_app(app_id) |> Query.get_by_refresh_token(token) |> Query.preload([:user]) |> Repo.find_resource() end @spec exchange_token(App.t(), Authorization.t()) :: {:ok, Token.t()} | {:error, Changeset.t()} def exchange_token(app, auth) do with {:ok, auth} <- Authorization.use_token(auth), true <- auth.app_id == app.id do user = if auth.user_id, do: User.get_cached_by_id(auth.user_id), else: %User{} create( app, user, %{scopes: auth.scopes} ) end end def get_preeexisting_by_app_and_user(app, user) do Query.get_by_app(app.id) |> Query.get_by_user(user.id) |> Query.get_unexpired() |> Query.preload([:user]) |> Query.sort_by_inserted_at() |> Query.limit(1) |> Repo.find_resource() end 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 def get_or_exchange_token(%Authorization{} = auth, %App{} = app, %User{} = user) do if auth.used do get_preeexisting_by_app_and_user(app, user) else exchange_token(app, auth) end end defp put_valid_until(changeset, attrs) do valid_until = Map.get(attrs, :valid_until, NaiveDateTime.add(NaiveDateTime.utc_now(), lifespan())) changeset |> change(%{valid_until: valid_until}) |> validate_required([:valid_until]) end @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 Pleroma.Workers.PurgeExpiredToken.schedule(%{ token_id: token.id, valid_until: DateTime.from_naive!(token.valid_until, "Etc/UTC"), mod: __MODULE__ }) end {:ok, token} end end defp do_create(app, user, attrs) do %__MODULE__{user_id: user.id, app_id: app.id} |> cast(%{scopes: attrs[:scopes] || app.scopes}, [:scopes]) |> validate_required([:scopes, :app_id]) |> put_valid_until(attrs) |> put_token() |> put_refresh_token(attrs) |> Repo.insert() end def delete_user_tokens(%User{id: user_id}) do Query.get_by_user(user_id) |> Repo.delete_all() end def delete_user_token(%User{id: user_id}, token_id) do Query.get_by_user(user_id) |> Query.get_by_id(token_id) |> Repo.delete_all() end def get_user_tokens(%User{id: user_id}) do Query.get_by_user(user_id) |> Query.preload([:app]) |> Repo.all() end def is_expired?(%__MODULE__{valid_until: valid_until}) do NaiveDateTime.diff(NaiveDateTime.utc_now(), valid_until) > 0 end def is_expired?(_), do: false end