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.OAuthController do
6 use Pleroma.Web, :controller
8 alias Pleroma.Helpers.AuthHelper
9 alias Pleroma.Helpers.UriHelper
12 alias Pleroma.Registration
15 alias Pleroma.Web.Auth.WrapperAuthenticator, as: Authenticator
16 alias Pleroma.Web.OAuth.App
17 alias Pleroma.Web.OAuth.Authorization
18 alias Pleroma.Web.OAuth.MFAController
19 alias Pleroma.Web.OAuth.MFAView
20 alias Pleroma.Web.OAuth.OAuthView
21 alias Pleroma.Web.OAuth.Scopes
22 alias Pleroma.Web.OAuth.Token
23 alias Pleroma.Web.OAuth.Token.Strategy.RefreshToken
24 alias Pleroma.Web.OAuth.Token.Strategy.Revoke, as: RevokeToken
25 alias Pleroma.Web.Plugs.RateLimiter
26 alias Pleroma.Web.Utils.Params
30 if Pleroma.Config.oauth_consumer_enabled?(), do: plug(Ueberauth)
37 plug(RateLimiter, [name: :authentication] when action == :create_authorization)
39 action_fallback(Pleroma.Web.OAuth.FallbackController)
41 @oob_token_redirect_uri "urn:ietf:wg:oauth:2.0:oob"
43 # Note: this definition is only called from error-handling methods with `conn.params` as 2nd arg
44 def authorize(%Plug.Conn{} = conn, %{"authorization" => _} = params) do
45 {auth_attrs, params} = Map.pop(params, "authorization")
46 authorize(conn, Map.merge(params, auth_attrs))
49 def authorize(%Plug.Conn{assigns: %{token: %Token{}}} = conn, %{"force_login" => _} = params) do
50 if Params.truthy_param?(params["force_login"]) do
51 do_authorize(conn, params)
53 handle_existing_authorization(conn, params)
57 # Note: the token is set in oauth_plug, but the token and client do not always go together.
58 # For example, MastodonFE's token is set if user requests with another client,
59 # after user already authorized to MastodonFE.
60 # So we have to check client and token.
62 %Plug.Conn{assigns: %{token: %Token{} = token}} = conn,
63 %{"client_id" => client_id} = params
65 with %Token{} = t <- Repo.get_by(Token, token: token.token) |> Repo.preload(:app),
66 ^client_id <- t.app.client_id do
67 handle_existing_authorization(conn, params)
69 _ -> do_authorize(conn, params)
73 def authorize(%Plug.Conn{} = conn, params), do: do_authorize(conn, params)
75 defp do_authorize(%Plug.Conn{} = conn, params) do
76 app = Repo.get_by(App, client_id: params["client_id"])
77 available_scopes = (app && app.scopes) || []
78 scopes = Scopes.fetch_scopes(params, available_scopes)
81 with %{assigns: %{user: %User{} = user}} <- conn do
94 # Note: `params` might differ from `conn.params`; use `@params` not `@conn.params` in template
95 render(conn, Authenticator.auth_template(), %{
97 app: app && Map.delete(app, :client_secret),
98 response_type: params["response_type"],
99 client_id: params["client_id"],
100 available_scopes: available_scopes,
102 redirect_uri: params["redirect_uri"],
103 state: params["state"],
105 view_module: OAuthView
109 defp handle_existing_authorization(
110 %Plug.Conn{assigns: %{token: %Token{} = token}} = conn,
111 %{"redirect_uri" => @oob_token_redirect_uri}
113 render(conn, "oob_token_exists.html", %{token: token})
116 defp handle_existing_authorization(
117 %Plug.Conn{assigns: %{token: %Token{} = token}} = conn,
120 app = Repo.preload(token, :app).app
123 if is_binary(params["redirect_uri"]) do
124 params["redirect_uri"]
126 default_redirect_uri(app)
129 if redirect_uri in String.split(app.redirect_uris) do
130 redirect_uri = redirect_uri(conn, redirect_uri)
131 url_params = %{access_token: token.token}
132 url_params = Maps.put_if_present(url_params, :state, params["state"])
133 url = UriHelper.modify_uri_params(redirect_uri, url_params)
134 redirect(conn, external: url)
137 |> put_flash(:error, dgettext("errors", "Unlisted redirect_uri."))
138 |> redirect(external: redirect_uri(conn, redirect_uri))
142 def create_authorization(_, _, opts \\ [])
144 def create_authorization(%Plug.Conn{assigns: %{user: %User{} = user}} = conn, params, []) do
145 create_authorization(conn, params, user: user)
148 def create_authorization(%Plug.Conn{} = conn, %{"authorization" => _} = params, opts) do
149 with {:ok, auth, user} <- do_create_authorization(conn, params, opts[:user]),
150 {:mfa_required, _, _, false} <- {:mfa_required, user, auth, MFA.require?(user)} do
151 after_create_authorization(conn, auth, params)
154 handle_create_authorization_error(conn, error, params)
158 def after_create_authorization(%Plug.Conn{} = conn, %Authorization{} = auth, %{
159 "authorization" => %{"redirect_uri" => @oob_token_redirect_uri}
161 # Enforcing the view to reuse the template when calling from other controllers
163 |> put_view(OAuthView)
164 |> render("oob_authorization_created.html", %{auth: auth, view_module: OAuthView})
167 def after_create_authorization(%Plug.Conn{} = conn, %Authorization{} = auth, %{
168 "authorization" => %{"redirect_uri" => redirect_uri} = auth_attrs
170 app = Repo.preload(auth, :app).app
172 # An extra safety measure before we redirect (also done in `do_create_authorization/2`)
173 if redirect_uri in String.split(app.redirect_uris) do
174 redirect_uri = redirect_uri(conn, redirect_uri)
175 url_params = %{code: auth.token}
176 url_params = Maps.put_if_present(url_params, :state, auth_attrs["state"])
177 url = UriHelper.modify_uri_params(redirect_uri, url_params)
178 redirect(conn, external: url)
181 |> put_flash(:error, dgettext("errors", "Unlisted redirect_uri."))
182 |> redirect(external: redirect_uri(conn, redirect_uri))
186 defp handle_create_authorization_error(
188 {:error, scopes_issue},
189 %{"authorization" => _} = params
191 when scopes_issue in [:unsupported_scopes, :missing_scopes] do
192 # Per https://github.com/tootsuite/mastodon/blob/
193 # 51e154f5e87968d6bb115e053689767ab33e80cd/app/controllers/api/base_controller.rb#L39
195 |> put_flash(:error, dgettext("errors", "This action is outside the authorized scopes"))
196 |> put_status(:unauthorized)
200 defp handle_create_authorization_error(
202 {:account_status, :confirmation_pending},
203 %{"authorization" => _} = params
206 |> put_flash(:error, dgettext("errors", "Your login is missing a confirmed e-mail address"))
207 |> put_status(:forbidden)
211 defp handle_create_authorization_error(
213 {:mfa_required, user, auth, _},
216 {:ok, token} = MFA.Token.create(user, auth)
219 "mfa_token" => token.token,
220 "redirect_uri" => params["authorization"]["redirect_uri"],
221 "state" => params["authorization"]["state"]
224 MFAController.show(conn, data)
227 defp handle_create_authorization_error(
229 {:account_status, :password_reset_pending},
230 %{"authorization" => _} = params
233 |> put_flash(:error, dgettext("errors", "Password reset is required"))
234 |> put_status(:forbidden)
238 defp handle_create_authorization_error(
240 {:account_status, :deactivated},
241 %{"authorization" => _} = params
244 |> put_flash(:error, dgettext("errors", "Your account is currently disabled"))
245 |> put_status(:forbidden)
249 defp handle_create_authorization_error(%Plug.Conn{} = conn, error, %{"authorization" => _}) do
250 Authenticator.handle_error(conn, error)
253 @doc "Renew access_token with refresh_token"
256 %{"grant_type" => "refresh_token", "refresh_token" => token} = _params
258 with {:ok, app} <- Token.Utils.fetch_app(conn),
259 {:ok, %{user: user} = token} <- Token.get_by_refresh_token(app, token),
260 {:ok, token} <- RefreshToken.grant(token) do
261 after_token_exchange(conn, %{user: user, token: token})
263 _error -> render_invalid_credentials_error(conn)
267 def token_exchange(%Plug.Conn{} = conn, %{"grant_type" => "authorization_code"} = params) do
268 with {:ok, app} <- Token.Utils.fetch_app(conn),
269 fixed_token = Token.Utils.fix_padding(params["code"]),
270 {:ok, auth} <- Authorization.get_by_token(app, fixed_token),
271 %User{} = user <- User.get_cached_by_id(auth.user_id),
272 {:ok, token} <- Token.exchange_token(app, auth) do
273 after_token_exchange(conn, %{user: user, token: token})
276 handle_token_exchange_error(conn, error)
282 %{"grant_type" => "password"} = params
284 with {:ok, %User{} = user} <- Authenticator.get_user(conn),
285 {:ok, app} <- Token.Utils.fetch_app(conn),
286 requested_scopes <- Scopes.fetch_scopes(params, app.scopes),
287 {:ok, token} <- login(user, app, requested_scopes) do
288 after_token_exchange(conn, %{user: user, token: token})
291 handle_token_exchange_error(conn, error)
297 %{"grant_type" => "password", "name" => name, "password" => _password} = params
301 |> Map.delete("name")
302 |> Map.put("username", name)
304 token_exchange(conn, params)
307 def token_exchange(%Plug.Conn{} = conn, %{"grant_type" => "client_credentials"} = _params) do
308 with {:ok, app} <- Token.Utils.fetch_app(conn),
309 {:ok, auth} <- Authorization.create_authorization(app, %User{}),
310 {:ok, token} <- Token.exchange_token(app, auth) do
311 after_token_exchange(conn, %{token: token})
314 handle_token_exchange_error(conn, :invalid_credentails)
319 def token_exchange(%Plug.Conn{} = conn, params), do: bad_request(conn, params)
321 def after_token_exchange(%Plug.Conn{} = conn, %{token: token} = view_params) do
323 |> AuthHelper.put_session_token(token.token)
324 |> json(OAuthView.render("token.json", view_params))
327 defp handle_token_exchange_error(%Plug.Conn{} = conn, {:mfa_required, user, auth, _}) do
329 |> put_status(:forbidden)
330 |> json(build_and_response_mfa_token(user, auth))
333 defp handle_token_exchange_error(%Plug.Conn{} = conn, {:account_status, :deactivated}) do
337 "Your account is currently disabled",
339 "account_is_disabled"
343 defp handle_token_exchange_error(
345 {:account_status, :password_reset_pending}
350 "Password reset is required",
352 "password_reset_required"
356 defp handle_token_exchange_error(%Plug.Conn{} = conn, {:account_status, :confirmation_pending}) do
360 "Your login is missing a confirmed e-mail address",
362 "missing_confirmed_email"
366 defp handle_token_exchange_error(%Plug.Conn{} = conn, {:account_status, :approval_pending}) do
370 "Your account is awaiting approval.",
376 defp handle_token_exchange_error(%Plug.Conn{} = conn, _error) do
377 render_invalid_credentials_error(conn)
380 def token_revoke(%Plug.Conn{} = conn, %{"token" => token}) do
381 with {:ok, %Token{} = oauth_token} <- Token.get_by_token(token),
382 {:ok, oauth_token} <- RevokeToken.revoke(oauth_token) do
384 with session_token = AuthHelper.get_session_token(conn),
385 %Token{token: ^session_token} <- oauth_token do
386 AuthHelper.delete_session_token(conn)
394 # RFC 7009: invalid tokens [in the request] do not cause an error response
399 def token_revoke(%Plug.Conn{} = conn, params), do: bad_request(conn, params)
401 # Response for bad request
402 defp bad_request(%Plug.Conn{} = conn, _) do
403 render_error(conn, :internal_server_error, "Bad request")
406 @doc "Prepares OAuth request to provider for Ueberauth"
407 def prepare_request(%Plug.Conn{} = conn, %{
408 "provider" => provider,
409 "authorization" => auth_attrs
413 |> Scopes.fetch_scopes([])
414 |> Scopes.to_string()
418 |> Map.delete("scopes")
419 |> Map.put("scope", scope)
424 |> Map.drop(~w(scope scopes client_id redirect_uri))
425 |> Map.put("state", state)
427 # Handing the request to Ueberauth
428 redirect(conn, to: Routes.o_auth_path(conn, :request, provider, params))
431 def request(%Plug.Conn{} = conn, params) do
433 if params["provider"] do
434 dgettext("errors", "Unsupported OAuth provider: %{provider}.",
435 provider: params["provider"]
438 dgettext("errors", "Bad OAuth request.")
442 |> put_flash(:error, message)
446 def callback(%Plug.Conn{assigns: %{ueberauth_failure: failure}} = conn, params) do
447 params = callback_params(params)
448 messages = for e <- Map.get(failure, :errors, []), do: e.message
449 message = Enum.join(messages, "; ")
454 dgettext("errors", "Failed to authenticate: %{message}.", message: message)
456 |> redirect(external: redirect_uri(conn, params["redirect_uri"]))
459 def callback(%Plug.Conn{} = conn, params) do
460 params = callback_params(params)
462 with {:ok, registration} <- Authenticator.get_registration(conn) do
463 auth_attrs = Map.take(params, ~w(client_id redirect_uri scope scopes state))
465 case Repo.get_assoc(registration, :user) do
467 create_authorization(conn, %{"authorization" => auth_attrs}, user: user)
470 registration_params =
471 Map.merge(auth_attrs, %{
472 "nickname" => Registration.nickname(registration),
473 "email" => Registration.email(registration)
477 |> put_session_registration_id(registration.id)
478 |> registration_details(%{"authorization" => registration_params})
482 Logger.debug(inspect(["OAUTH_ERROR", error, conn.assigns]))
485 |> put_flash(:error, dgettext("errors", "Failed to set up user account."))
486 |> redirect(external: redirect_uri(conn, params["redirect_uri"]))
490 defp callback_params(%{"state" => state} = params) do
491 Map.merge(params, Jason.decode!(state))
494 def registration_details(%Plug.Conn{} = conn, %{"authorization" => auth_attrs}) do
495 render(conn, "register.html", %{
496 client_id: auth_attrs["client_id"],
497 redirect_uri: auth_attrs["redirect_uri"],
498 state: auth_attrs["state"],
499 scopes: Scopes.fetch_scopes(auth_attrs, []),
500 nickname: auth_attrs["nickname"],
501 email: auth_attrs["email"]
505 def register(%Plug.Conn{} = conn, %{"authorization" => _, "op" => "connect"} = params) do
506 with registration_id when not is_nil(registration_id) <- get_session_registration_id(conn),
507 %Registration{} = registration <- Repo.get(Registration, registration_id),
508 {_, {:ok, auth, _user}} <-
509 {:create_authorization, do_create_authorization(conn, params)},
510 %User{} = user <- Repo.preload(auth, :user).user,
511 {:ok, _updated_registration} <- Registration.bind_to_user(registration, user) do
513 |> put_session_registration_id(nil)
514 |> after_create_authorization(auth, params)
516 {:create_authorization, error} ->
517 {:register, handle_create_authorization_error(conn, error, params)}
520 {:register, :generic_error}
524 def register(%Plug.Conn{} = conn, %{"authorization" => _, "op" => "register"} = params) do
525 with registration_id when not is_nil(registration_id) <- get_session_registration_id(conn),
526 %Registration{} = registration <- Repo.get(Registration, registration_id),
527 {:ok, user} <- Authenticator.create_from_registration(conn, registration) do
529 |> put_session_registration_id(nil)
530 |> create_authorization(
535 {:error, changeset} ->
537 Enum.map(changeset.errors, fn {field, {error, _}} ->
545 "ap_id has already been taken",
546 "nickname has already been taken"
550 |> put_status(:forbidden)
551 |> put_flash(:error, "Error: #{message}.")
552 |> registration_details(params)
555 {:register, :generic_error}
559 defp do_create_authorization(conn, auth_attrs, user \\ nil)
561 defp do_create_authorization(
566 "client_id" => client_id,
567 "redirect_uri" => redirect_uri
572 with {_, {:ok, %User{} = user}} <-
573 {:get_user, (user && {:ok, user}) || Authenticator.get_user(conn)},
574 %App{} = app <- Repo.get_by(App, client_id: client_id),
575 true <- redirect_uri in String.split(app.redirect_uris),
576 requested_scopes <- Scopes.fetch_scopes(auth_attrs, app.scopes),
577 {:ok, auth} <- do_create_authorization(user, app, requested_scopes) do
582 defp do_create_authorization(%User{} = user, %App{} = app, requested_scopes)
583 when is_list(requested_scopes) do
584 with {:account_status, :active} <- {:account_status, User.account_status(user)},
585 {:ok, scopes} <- validate_scopes(app, requested_scopes),
586 {:ok, auth} <- Authorization.create_authorization(app, user, scopes) do
591 # Note: intended to be a private function but opened for AccountController that logs in on signup
592 @doc "If checks pass, creates authorization and token for given user, app and requested scopes."
593 def login(%User{} = user, %App{} = app, requested_scopes) when is_list(requested_scopes) do
594 with {:ok, auth} <- do_create_authorization(user, app, requested_scopes),
595 {:mfa_required, _, _, false} <- {:mfa_required, user, auth, MFA.require?(user)},
596 {:ok, token} <- Token.exchange_token(app, auth) do
601 # Special case: Local MastodonFE
602 defp redirect_uri(%Plug.Conn{} = conn, "."), do: Routes.auth_url(conn, :login)
604 defp redirect_uri(%Plug.Conn{}, redirect_uri), do: redirect_uri
606 defp get_session_registration_id(%Plug.Conn{} = conn), do: get_session(conn, :registration_id)
608 defp put_session_registration_id(%Plug.Conn{} = conn, registration_id),
609 do: put_session(conn, :registration_id, registration_id)
611 defp build_and_response_mfa_token(user, auth) do
612 with {:ok, token} <- MFA.Token.create(user, auth) do
613 MFAView.render("mfa_response.json", %{token: token, user: user})
617 @spec validate_scopes(App.t(), map() | list()) ::
618 {:ok, list()} | {:error, :missing_scopes | :unsupported_scopes}
619 defp validate_scopes(%App{} = app, params) when is_map(params) do
620 requested_scopes = Scopes.fetch_scopes(params, app.scopes)
621 validate_scopes(app, requested_scopes)
624 defp validate_scopes(%App{} = app, requested_scopes) when is_list(requested_scopes) do
625 Scopes.validate(requested_scopes, app.scopes)
628 def default_redirect_uri(%App{} = app) do
634 defp render_invalid_credentials_error(conn) do
635 render_error(conn, :bad_request, "Invalid credentials")