[#1427] Bugfix for `enforce_oauth_admin_scope_usage`. Admin API documentation entry.

diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md
index 2cac317def2df0790ae1ffd04db05ec0fd455c66..b19793150226d8ad0d06013d4b9bac78655cde44 100644 (file)
--- a/docs/API/admin_api.md
+++ b/docs/API/admin_api.md
@@ -2,6 +2,13 @@
 
 Authentication is required and the user must be an admin.
 
+Configuration options:
+ 
+* `[:auth, :enforce_oauth_admin_scope_usage]` — OAuth admin scope requirement toggle.
+    If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token (client app must support admin scopes).
+    If `false` and token doesn't have admin scope(s), `is_admin` user flag grants access to admin-specific actions.
+    Note that client app needs to explicitly support admin scopes and request them when obtaining auth token.
+
 ## `GET /api/pleroma/admin/users`
 
 ### List users

diff --git a/lib/pleroma/plugs/user_is_admin_plug.ex b/lib/pleroma/plugs/user_is_admin_plug.ex
index 8814556f1c6b9a42735cc81e4316a1b15f9d502d..814029dce285c6598742523711da3206463fe278 100644 (file)
--- a/lib/pleroma/plugs/user_is_admin_plug.ex
+++ b/lib/pleroma/plugs/user_is_admin_plug.ex
@@ -6,13 +6,20 @@ defmodule Pleroma.Plugs.UserIsAdminPlug do
   import Pleroma.Web.TranslationHelpers
   import Plug.Conn
 
-  alias Pleroma.User
   alias Pleroma.Web.OAuth
 
   def init(options) do
     options
   end
 
+  unless Pleroma.Config.enforce_oauth_admin_scope_usage?() do
+    # To do: once AdminFE makes use of "admin" scope, disable the following func definition
+    #   (fail on no admin scope(s) in token even if `is_admin` is true)
+    def call(%Plug.Conn{assigns: %{user: %Pleroma.User{is_admin: true}}} = conn, _) do
+      conn
+    end
+  end
+
   def call(%Plug.Conn{assigns: %{token: %OAuth.Token{scopes: oauth_scopes} = _token}} = conn, _) do
     if OAuth.Scopes.contains_admin_scopes?(oauth_scopes) do
       # Note: checking for _any_ admin scope presence, not necessarily fitting requested action.
@@ -23,14 +30,6 @@ defmodule Pleroma.Plugs.UserIsAdminPlug do
     end
   end
 
-  unless Pleroma.Config.enforce_oauth_admin_scope_usage?() do
-    # To do: once AdminFE makes use of "admin" scope, disable the following func definition
-    #   (fail on no admin scope(s) in token even if `is_admin` is true)
-    def call(%Plug.Conn{assigns: %{user: %User{is_admin: true}}} = conn, _) do
-      conn
-    end
-  end
-
   def call(conn, _) do
     fail(conn)
   end