Merge branch 'develop' into feature/new-registrations-digest
[akkoma] / lib / pleroma / plugs / oauth_scopes_plug.ex
index a16adb00439ffa0fdf9e5791862d88e6ae560adf..07c0f7fdb16df5d2a55e9b7ad179ebf7e09c16e9 100644 (file)
@@ -4,26 +4,76 @@
 
 defmodule Pleroma.Plugs.OAuthScopesPlug do
   import Plug.Conn
-  alias Pleroma.Web.OAuth
+  import Pleroma.Web.Gettext
+
+  alias Pleroma.Config
+  alias Pleroma.Plugs.EnsurePublicOrAuthenticatedPlug
 
   @behaviour Plug
 
-  def init(%{required_scopes: _} = options), do: options
+  def init(%{scopes: _} = options), do: options
 
-  def call(%Plug.Conn{assigns: assigns} = conn, %{required_scopes: required_scopes}) do
+  def call(%Plug.Conn{assigns: assigns} = conn, %{scopes: scopes} = options) do
+    op = options[:op] || :|
     token = assigns[:token]
-    granted_scopes = token && OAuth.parse_scopes(token.scope)
 
-    if is_nil(token) || required_scopes -- granted_scopes == [] do
-      conn
+    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
-      missing_scopes = required_scopes -- granted_scopes
-      error_message = "Insufficient permissions: #{Enum.join(missing_scopes, ", ")}."
+      scopes
+    end
+  end
 
+  defp maybe_perform_instance_privacy_check(%Plug.Conn{} = conn, options) do
+    if options[:skip_instance_privacy_check] do
       conn
-      |> put_resp_content_type("application/json")
-      |> send_resp(403, Jason.encode!(%{error: error_message}))
-      |> halt()
+    else
+      EnsurePublicOrAuthenticatedPlug.call(conn, [])
     end
   end
 end