da4923f2e5
Enforcement of OAuth scopes check for authenticated API endpoints See merge request pleroma/pleroma!2349
83 lines
2.2 KiB
Elixir
83 lines
2.2 KiB
Elixir
# Pleroma: A lightweight social networking server
|
|
# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
defmodule Pleroma.Plugs.OAuthScopesPlug do
|
|
import Plug.Conn
|
|
import Pleroma.Web.Gettext
|
|
|
|
alias Pleroma.Config
|
|
alias Pleroma.Plugs.EnsurePublicOrAuthenticatedPlug
|
|
alias Pleroma.Plugs.PlugHelper
|
|
|
|
use Pleroma.Web, :plug
|
|
|
|
@behaviour Plug
|
|
|
|
def init(%{scopes: _} = options), do: options
|
|
|
|
def perform(%Plug.Conn{assigns: assigns} = conn, %{scopes: scopes} = options) do
|
|
op = options[:op] || :|
|
|
token = assigns[:token]
|
|
|
|
scopes = transform_scopes(scopes, options)
|
|
matched_scopes = (token && filter_descendants(scopes, token.scopes)) || []
|
|
|
|
cond do
|
|
token && op == :| && Enum.any?(matched_scopes) ->
|
|
conn
|
|
|
|
token && op == :& && matched_scopes == scopes ->
|
|
conn
|
|
|
|
options[:fallback] == :proceed_unauthenticated ->
|
|
conn
|
|
|> assign(:user, nil)
|
|
|> assign(:token, nil)
|
|
|> maybe_perform_instance_privacy_check(options)
|
|
|
|
true ->
|
|
missing_scopes = scopes -- matched_scopes
|
|
permissions = Enum.join(missing_scopes, " #{op} ")
|
|
|
|
error_message =
|
|
dgettext("errors", "Insufficient permissions: %{permissions}.", permissions: permissions)
|
|
|
|
conn
|
|
|> put_resp_content_type("application/json")
|
|
|> send_resp(:forbidden, Jason.encode!(%{error: error_message}))
|
|
|> halt()
|
|
end
|
|
end
|
|
|
|
@doc "Filters descendants of supported scopes"
|
|
def filter_descendants(scopes, supported_scopes) do
|
|
Enum.filter(
|
|
scopes,
|
|
fn scope ->
|
|
Enum.find(
|
|
supported_scopes,
|
|
&(scope == &1 || String.starts_with?(scope, &1 <> ":"))
|
|
)
|
|
end
|
|
)
|
|
end
|
|
|
|
@doc "Transforms scopes by applying supported options (e.g. :admin)"
|
|
def transform_scopes(scopes, options) do
|
|
if options[:admin] do
|
|
Config.oauth_admin_scopes(scopes)
|
|
else
|
|
scopes
|
|
end
|
|
end
|
|
|
|
defp maybe_perform_instance_privacy_check(%Plug.Conn{} = conn, options) do
|
|
if options[:skip_instance_privacy_check] do
|
|
conn
|
|
else
|
|
EnsurePublicOrAuthenticatedPlug.call(conn, [])
|
|
end
|
|
end
|
|
end
|