1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 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: Pleroma.FlakeId)
30 @doc "Gets token for app by access token"
31 @spec get_by_token(App.t(), String.t()) :: {:ok, t()} | {:error, :not_found}
32 def get_by_token(%App{id: app_id} = _app, token) do
33 Query.get_by_app(app_id)
34 |> Query.get_by_token(token)
35 |> Repo.find_resource()
38 @doc "Gets token for app by refresh token"
39 @spec get_by_refresh_token(App.t(), String.t()) :: {:ok, t()} | {:error, :not_found}
40 def get_by_refresh_token(%App{id: app_id} = _app, token) do
41 Query.get_by_app(app_id)
42 |> Query.get_by_refresh_token(token)
43 |> Query.preload([:user])
44 |> Repo.find_resource()
47 @spec exchange_token(App.t(), Authorization.t()) :: {:ok, Token.t()} | {:error, Changeset.t()}
48 def exchange_token(app, auth) do
49 with {:ok, auth} <- Authorization.use_token(auth),
50 true <- auth.app_id == app.id do
51 user = if auth.user_id, do: User.get_cached_by_id(auth.user_id), else: %User{}
56 %{scopes: auth.scopes}
61 defp put_token(changeset) do
63 |> change(%{token: Token.Utils.generate_token()})
64 |> validate_required([:token])
65 |> unique_constraint(:token)
68 defp put_refresh_token(changeset, attrs) do
69 refresh_token = Map.get(attrs, :refresh_token, Token.Utils.generate_token())
72 |> change(%{refresh_token: refresh_token})
73 |> validate_required([:refresh_token])
74 |> unique_constraint(:refresh_token)
77 defp put_valid_until(changeset, attrs) do
79 Map.get(attrs, :valid_until, NaiveDateTime.add(NaiveDateTime.utc_now(), expires_in()))
82 |> change(%{valid_until: expires_in})
83 |> validate_required([:valid_until])
86 @spec create_token(App.t(), User.t(), map()) :: {:ok, Token} | {:error, Changeset.t()}
87 def create_token(%App{} = app, %User{} = user, attrs \\ %{}) do
88 %__MODULE__{user_id: user.id, app_id: app.id}
89 |> cast(%{scopes: attrs[:scopes] || app.scopes}, [:scopes])
90 |> validate_required([:scopes, :app_id])
91 |> put_valid_until(attrs)
93 |> put_refresh_token(attrs)
97 def delete_user_tokens(%User{id: user_id}) do
98 Query.get_by_user(user_id)
102 def delete_user_token(%User{id: user_id}, token_id) do
103 Query.get_by_user(user_id)
104 |> Query.get_by_id(token_id)
108 def delete_expired_tokens do
109 Query.get_expired_tokens()
113 def get_user_tokens(%User{id: user_id}) do
114 Query.get_by_user(user_id)
115 |> Query.preload([:app])
119 def is_expired?(%__MODULE__{valid_until: valid_until}) do
120 NaiveDateTime.diff(NaiveDateTime.utc_now(), valid_until) > 0
123 def is_expired?(_), do: false
125 defp expires_in, do: Pleroma.Config.get([:oauth2, :token_expires_in], 600)