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.Scopes do
7 Functions for dealing with scopes.
10 alias Pleroma.Web.Plugs.OAuthScopesPlug
13 Fetch scopes from request params.
15 Note: `scopes` is used by Mastodon — supporting it but sticking to
16 OAuth's standard `scope` wherever we control it
18 @spec fetch_scopes(map() | struct(), list()) :: list()
20 def fetch_scopes(params, default) do
21 parse_scopes(params["scope"] || params["scopes"] || params[:scopes], default)
24 def parse_scopes(scopes, _default) when is_list(scopes) do
25 Enum.filter(scopes, &(&1 not in [nil, ""]))
28 def parse_scopes(scopes, default) when is_binary(scopes) do
31 |> parse_scopes(default)
34 def parse_scopes(_, default) do
39 Convert scopes string to list
41 @spec to_list(binary()) :: [binary()]
42 def to_list(nil), do: []
47 |> String.split(~r/[\s,]+/)
51 Convert scopes list to string
53 @spec to_string(list()) :: binary()
54 def to_string(scopes), do: Enum.join(scopes, " ")
59 @spec validate(list() | nil, list(), Pleroma.User.t()) ::
60 {:ok, list()} | {:error, :missing_scopes | :unsupported_scopes, :user_is_not_an_admin}
61 def validate(blank_scopes, _app_scopes, _user) when blank_scopes in [nil, []],
62 do: {:error, :missing_scopes}
64 def validate(scopes, app_scopes, _user) do
65 validate_scopes_are_supported(scopes, app_scopes)
68 @spec filter_admin_scopes([String.t()], Pleroma.User.t()) :: [String.t()]
70 Remove admin scopes for non-admins
72 def filter_admin_scopes(scopes, %Pleroma.User{is_admin: true}), do: scopes
74 def filter_admin_scopes(scopes, %Pleroma.User{is_moderator: true}), do: scopes
76 def filter_admin_scopes(scopes, _user) do
77 drop_scopes = OAuthScopesPlug.filter_descendants(scopes, ["admin"])
78 Enum.reject(scopes, fn scope -> Enum.member?(drop_scopes, scope) end)
81 defp validate_scopes_are_supported(scopes, app_scopes) do
82 case OAuthScopesPlug.filter_descendants(scopes, app_scopes) do
83 ^scopes -> {:ok, scopes}
84 _ -> {:error, :unsupported_scopes}
88 def contains_admin_scopes?(scopes) do
90 |> OAuthScopesPlug.filter_descendants(["admin"])