1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.OAuth.Token do
12 alias Pleroma.Web.OAuth.App
13 alias Pleroma.Web.OAuth.Authorization
14 alias Pleroma.Web.OAuth.Token
15 alias Pleroma.Web.OAuth.Token.Query
17 @type t :: %__MODULE__{}
19 schema "oauth_tokens" do
20 field(:token, :string)
21 field(:refresh_token, :string)
22 field(:scopes, {:array, :string}, default: [])
23 field(:valid_until, :naive_datetime_usec)
24 belongs_to(:user, User, type: FlakeId.Ecto.CompatType)
31 Pleroma.Config.get!([:oauth2, :token_expires_in])
34 @doc "Gets token by unique access token"
35 @spec get_by_token(String.t()) :: {:ok, t()} | {:error, :not_found}
36 def get_by_token(token) do
38 |> Query.get_by_token()
39 |> Repo.find_resource()
42 def get_by_app(%App{} = app) do
44 |> Query.get_unexpired_by_app()
45 |> Repo.find_resource()
48 @doc "Gets token for app by access token"
49 @spec get_by_token(App.t(), String.t()) :: {:ok, t()} | {:error, :not_found}
50 def get_by_token(%App{id: app_id} = _app, token) do
51 Query.get_by_app(app_id)
52 |> Query.get_by_token(token)
53 |> Repo.find_resource()
56 @doc "Gets token for app by refresh token"
57 @spec get_by_refresh_token(App.t(), String.t()) :: {:ok, t()} | {:error, :not_found}
58 def get_by_refresh_token(%App{id: app_id} = _app, token) do
59 Query.get_by_app(app_id)
60 |> Query.get_by_refresh_token(token)
61 |> Query.preload([:user])
62 |> Repo.find_resource()
65 @spec exchange_token(App.t(), Authorization.t()) :: {:ok, Token.t()} | {:error, Changeset.t()}
66 def exchange_token(app, auth) do
67 with {:ok, auth} <- Authorization.use_token(auth),
68 true <- auth.app_id == app.id do
69 user = if auth.user_id, do: User.get_cached_by_id(auth.user_id), else: %User{}
74 %{scopes: auth.scopes}
79 defp put_token(changeset) do
81 |> change(%{token: Token.Utils.generate_token()})
82 |> validate_required([:token])
83 |> unique_constraint(:token)
86 defp put_refresh_token(changeset, attrs) do
87 refresh_token = Map.get(attrs, :refresh_token, Token.Utils.generate_token())
90 |> change(%{refresh_token: refresh_token})
91 |> validate_required([:refresh_token])
92 |> unique_constraint(:refresh_token)
95 defp put_valid_until(changeset, attrs) do
97 Map.get(attrs, :valid_until, NaiveDateTime.add(NaiveDateTime.utc_now(), lifespan()))
100 |> change(%{valid_until: valid_until})
101 |> validate_required([:valid_until])
104 @spec create(App.t(), User.t(), map()) :: {:ok, Token} | {:error, Changeset.t()}
105 def create(%App{} = app, %User{} = user, attrs \\ %{}) do
106 with {:ok, token} <- do_create(app, user, attrs) do
107 if Pleroma.Config.get([:oauth2, :clean_expired_tokens]) do
108 Pleroma.Workers.PurgeExpiredToken.enqueue(%{
110 valid_until: DateTime.from_naive!(token.valid_until, "Etc/UTC"),
119 defp do_create(app, user, attrs) do
120 %__MODULE__{user_id: user.id, app_id: app.id}
121 |> cast(%{scopes: attrs[:scopes] || app.scopes}, [:scopes])
122 |> validate_required([:scopes, :app_id])
123 |> put_valid_until(attrs)
125 |> put_refresh_token(attrs)
129 def delete_user_tokens(%User{id: user_id}) do
130 Query.get_by_user(user_id)
134 def delete_user_token(%User{id: user_id}, token_id) do
135 Query.get_by_user(user_id)
136 |> Query.get_by_id(token_id)
140 def get_user_tokens(%User{id: user_id}) do
141 Query.get_by_user(user_id)
142 |> Query.preload([:app])
146 def is_expired?(%__MODULE__{valid_until: valid_until}) do
147 NaiveDateTime.diff(NaiveDateTime.utc_now(), valid_until) > 0
150 def is_expired?(_), do: false