1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 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.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(%Pleroma.Web.ApiSpec.Schemas.AppCreateRequest{scopes: scopes}, default) do
21 parse_scopes(scopes, default)
24 def fetch_scopes(params, default) do
25 parse_scopes(params["scope"] || params["scopes"], default)
28 def parse_scopes(scopes, _default) when is_list(scopes) do
29 Enum.filter(scopes, &(&1 not in [nil, ""]))
32 def parse_scopes(scopes, default) when is_binary(scopes) do
35 |> parse_scopes(default)
38 def parse_scopes(_, default) do
43 Convert scopes string to list
45 @spec to_list(binary()) :: [binary()]
46 def to_list(nil), do: []
51 |> String.split(~r/[\s,]+/)
55 Convert scopes list to string
57 @spec to_string(list()) :: binary()
58 def to_string(scopes), do: Enum.join(scopes, " ")
63 @spec validate(list() | nil, list()) ::
64 {:ok, list()} | {:error, :missing_scopes | :unsupported_scopes}
65 def validate(blank_scopes, _app_scopes) when blank_scopes in [nil, []],
66 do: {:error, :missing_scopes}
68 def validate(scopes, app_scopes) do
69 case OAuthScopesPlug.filter_descendants(scopes, app_scopes) do
70 ^scopes -> {:ok, scopes}
71 _ -> {:error, :unsupported_scopes}
75 def contains_admin_scopes?(scopes) do
77 |> OAuthScopesPlug.filter_descendants(["admin"])