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.OAuthController do
6 use Pleroma.Web, :controller
8 alias Pleroma.Helpers.UriHelper
9 alias Pleroma.Plugs.RateLimiter
10 alias Pleroma.Registration
13 alias Pleroma.Web.Auth.Authenticator
14 alias Pleroma.Web.ControllerHelper
15 alias Pleroma.Web.OAuth.App
16 alias Pleroma.Web.OAuth.Authorization
17 alias Pleroma.Web.OAuth.Scopes
18 alias Pleroma.Web.OAuth.Token
19 alias Pleroma.Web.OAuth.Token.Strategy.RefreshToken
20 alias Pleroma.Web.OAuth.Token.Strategy.Revoke, as: RevokeToken
24 if Pleroma.Config.oauth_consumer_enabled?(), do: plug(Ueberauth)
28 plug(RateLimiter, [name: :authentication] when action == :create_authorization)
30 action_fallback(Pleroma.Web.OAuth.FallbackController)
32 @oob_token_redirect_uri "urn:ietf:wg:oauth:2.0:oob"
34 # Note: this definition is only called from error-handling methods with `conn.params` as 2nd arg
35 def authorize(%Plug.Conn{} = conn, %{"authorization" => _} = params) do
36 {auth_attrs, params} = Map.pop(params, "authorization")
37 authorize(conn, Map.merge(params, auth_attrs))
40 def authorize(%Plug.Conn{assigns: %{token: %Token{}}} = conn, %{"force_login" => _} = params) do
41 if ControllerHelper.truthy_param?(params["force_login"]) do
42 do_authorize(conn, params)
44 handle_existing_authorization(conn, params)
48 # Note: the token is set in oauth_plug, but the token and client do not always go together.
49 # For example, MastodonFE's token is set if user requests with another client,
50 # after user already authorized to MastodonFE.
51 # So we have to check client and token.
53 %Plug.Conn{assigns: %{token: %Token{} = token}} = conn,
54 %{"client_id" => client_id} = params
56 with %Token{} = t <- Repo.get_by(Token, token: token.token) |> Repo.preload(:app),
57 ^client_id <- t.app.client_id do
58 handle_existing_authorization(conn, params)
60 _ -> do_authorize(conn, params)
64 def authorize(%Plug.Conn{} = conn, params), do: do_authorize(conn, params)
66 defp do_authorize(%Plug.Conn{} = conn, params) do
67 app = Repo.get_by(App, client_id: params["client_id"])
68 available_scopes = (app && app.scopes) || []
69 scopes = Scopes.fetch_scopes(params, available_scopes)
71 # Note: `params` might differ from `conn.params`; use `@params` not `@conn.params` in template
72 render(conn, Authenticator.auth_template(), %{
73 response_type: params["response_type"],
74 client_id: params["client_id"],
75 available_scopes: available_scopes,
77 redirect_uri: params["redirect_uri"],
78 state: params["state"],
83 defp handle_existing_authorization(
84 %Plug.Conn{assigns: %{token: %Token{} = token}} = conn,
85 %{"redirect_uri" => @oob_token_redirect_uri}
87 render(conn, "oob_token_exists.html", %{token: token})
90 defp handle_existing_authorization(
91 %Plug.Conn{assigns: %{token: %Token{} = token}} = conn,
94 app = Repo.preload(token, :app).app
97 if is_binary(params["redirect_uri"]) do
98 params["redirect_uri"]
100 default_redirect_uri(app)
103 if redirect_uri in String.split(app.redirect_uris) do
104 redirect_uri = redirect_uri(conn, redirect_uri)
105 url_params = %{access_token: token.token}
106 url_params = UriHelper.append_param_if_present(url_params, :state, params["state"])
107 url = UriHelper.append_uri_params(redirect_uri, url_params)
108 redirect(conn, external: url)
111 |> put_flash(:error, dgettext("errors", "Unlisted redirect_uri."))
112 |> redirect(external: redirect_uri(conn, redirect_uri))
116 def create_authorization(
118 %{"authorization" => _} = params,
121 with {:ok, auth} <- do_create_authorization(conn, params, opts[:user]) do
122 after_create_authorization(conn, auth, params)
125 handle_create_authorization_error(conn, error, params)
129 def after_create_authorization(%Plug.Conn{} = conn, %Authorization{} = auth, %{
130 "authorization" => %{"redirect_uri" => @oob_token_redirect_uri}
132 render(conn, "oob_authorization_created.html", %{auth: auth})
135 def after_create_authorization(%Plug.Conn{} = conn, %Authorization{} = auth, %{
136 "authorization" => %{"redirect_uri" => redirect_uri} = auth_attrs
138 app = Repo.preload(auth, :app).app
140 # An extra safety measure before we redirect (also done in `do_create_authorization/2`)
141 if redirect_uri in String.split(app.redirect_uris) do
142 redirect_uri = redirect_uri(conn, redirect_uri)
143 url_params = %{code: auth.token}
144 url_params = UriHelper.append_param_if_present(url_params, :state, auth_attrs["state"])
145 url = UriHelper.append_uri_params(redirect_uri, url_params)
146 redirect(conn, external: url)
149 |> put_flash(:error, dgettext("errors", "Unlisted redirect_uri."))
150 |> redirect(external: redirect_uri(conn, redirect_uri))
154 defp handle_create_authorization_error(
156 {:error, scopes_issue},
157 %{"authorization" => _} = params
159 when scopes_issue in [:unsupported_scopes, :missing_scopes] do
160 # Per https://github.com/tootsuite/mastodon/blob/
161 # 51e154f5e87968d6bb115e053689767ab33e80cd/app/controllers/api/base_controller.rb#L39
163 |> put_flash(:error, dgettext("errors", "This action is outside the authorized scopes"))
164 |> put_status(:unauthorized)
168 defp handle_create_authorization_error(
170 {:account_status, :confirmation_pending},
171 %{"authorization" => _} = params
174 |> put_flash(:error, dgettext("errors", "Your login is missing a confirmed e-mail address"))
175 |> put_status(:forbidden)
179 defp handle_create_authorization_error(
181 {:account_status, :password_reset_pending},
182 %{"authorization" => _} = params
185 |> put_flash(:error, dgettext("errors", "Password reset is required"))
186 |> put_status(:forbidden)
190 defp handle_create_authorization_error(
192 {:account_status, :deactivated},
193 %{"authorization" => _} = params
196 |> put_flash(:error, dgettext("errors", "Your account is currently disabled"))
197 |> put_status(:forbidden)
201 defp handle_create_authorization_error(%Plug.Conn{} = conn, error, %{"authorization" => _}) do
202 Authenticator.handle_error(conn, error)
205 @doc "Renew access_token with refresh_token"
208 %{"grant_type" => "refresh_token", "refresh_token" => token} = _params
210 with {:ok, app} <- Token.Utils.fetch_app(conn),
211 {:ok, %{user: user} = token} <- Token.get_by_refresh_token(app, token),
212 {:ok, token} <- RefreshToken.grant(token) do
213 response_attrs = %{created_at: Token.Utils.format_created_at(token)}
215 json(conn, Token.Response.build(user, token, response_attrs))
217 _error -> render_invalid_credentials_error(conn)
221 def token_exchange(%Plug.Conn{} = conn, %{"grant_type" => "authorization_code"} = params) do
222 with {:ok, app} <- Token.Utils.fetch_app(conn),
223 fixed_token = Token.Utils.fix_padding(params["code"]),
224 {:ok, auth} <- Authorization.get_by_token(app, fixed_token),
225 %User{} = user <- User.get_cached_by_id(auth.user_id),
226 {:ok, token} <- Token.exchange_token(app, auth) do
227 response_attrs = %{created_at: Token.Utils.format_created_at(token)}
229 json(conn, Token.Response.build(user, token, response_attrs))
231 _error -> render_invalid_credentials_error(conn)
237 %{"grant_type" => "password"} = params
239 with {:ok, %User{} = user} <- Authenticator.get_user(conn),
240 {:ok, app} <- Token.Utils.fetch_app(conn),
241 {:account_status, :active} <- {:account_status, User.account_status(user)},
242 {:ok, scopes} <- validate_scopes(app, params),
243 {:ok, auth} <- Authorization.create_authorization(app, user, scopes),
244 {:ok, token} <- Token.exchange_token(app, auth) do
245 json(conn, Token.Response.build(user, token))
248 handle_token_exchange_error(conn, error)
254 %{"grant_type" => "password", "name" => name, "password" => _password} = params
258 |> Map.delete("name")
259 |> Map.put("username", name)
261 token_exchange(conn, params)
264 def token_exchange(%Plug.Conn{} = conn, %{"grant_type" => "client_credentials"} = _params) do
265 with {:ok, app} <- Token.Utils.fetch_app(conn),
266 {:ok, auth} <- Authorization.create_authorization(app, %User{}),
267 {:ok, token} <- Token.exchange_token(app, auth) do
268 json(conn, Token.Response.build_for_client_credentials(token))
270 _error -> render_invalid_credentials_error(conn)
275 def token_exchange(%Plug.Conn{} = conn, params), do: bad_request(conn, params)
277 defp handle_token_exchange_error(%Plug.Conn{} = conn, {:account_status, :deactivated}) do
281 "Your account is currently disabled",
283 "account_is_disabled"
287 defp handle_token_exchange_error(
289 {:account_status, :password_reset_pending}
294 "Password reset is required",
296 "password_reset_required"
300 defp handle_token_exchange_error(%Plug.Conn{} = conn, {:account_status, :confirmation_pending}) do
304 "Your login is missing a confirmed e-mail address",
306 "missing_confirmed_email"
310 defp handle_token_exchange_error(%Plug.Conn{} = conn, _error) do
311 render_invalid_credentials_error(conn)
314 def token_revoke(%Plug.Conn{} = conn, %{"token" => _token} = params) do
315 with {:ok, app} <- Token.Utils.fetch_app(conn),
316 {:ok, _token} <- RevokeToken.revoke(app, params) do
320 # RFC 7009: invalid tokens [in the request] do not cause an error response
325 def token_revoke(%Plug.Conn{} = conn, params), do: bad_request(conn, params)
327 # Response for bad request
328 defp bad_request(%Plug.Conn{} = conn, _) do
329 render_error(conn, :internal_server_error, "Bad request")
332 @doc "Prepares OAuth request to provider for Ueberauth"
333 def prepare_request(%Plug.Conn{} = conn, %{
334 "provider" => provider,
335 "authorization" => auth_attrs
339 |> Scopes.fetch_scopes([])
340 |> Scopes.to_string()
344 |> Map.delete("scopes")
345 |> Map.put("scope", scope)
350 |> Map.drop(~w(scope scopes client_id redirect_uri))
351 |> Map.put("state", state)
353 # Handing the request to Ueberauth
354 redirect(conn, to: o_auth_path(conn, :request, provider, params))
357 def request(%Plug.Conn{} = conn, params) do
359 if params["provider"] do
360 dgettext("errors", "Unsupported OAuth provider: %{provider}.",
361 provider: params["provider"]
364 dgettext("errors", "Bad OAuth request.")
368 |> put_flash(:error, message)
372 def callback(%Plug.Conn{assigns: %{ueberauth_failure: failure}} = conn, params) do
373 params = callback_params(params)
374 messages = for e <- Map.get(failure, :errors, []), do: e.message
375 message = Enum.join(messages, "; ")
380 dgettext("errors", "Failed to authenticate: %{message}.", message: message)
382 |> redirect(external: redirect_uri(conn, params["redirect_uri"]))
385 def callback(%Plug.Conn{} = conn, params) do
386 params = callback_params(params)
388 with {:ok, registration} <- Authenticator.get_registration(conn) do
389 auth_attrs = Map.take(params, ~w(client_id redirect_uri scope scopes state))
391 case Repo.get_assoc(registration, :user) do
393 create_authorization(conn, %{"authorization" => auth_attrs}, user: user)
396 registration_params =
397 Map.merge(auth_attrs, %{
398 "nickname" => Registration.nickname(registration),
399 "email" => Registration.email(registration)
403 |> put_session_registration_id(registration.id)
404 |> registration_details(%{"authorization" => registration_params})
408 Logger.debug(inspect(["OAUTH_ERROR", error, conn.assigns]))
411 |> put_flash(:error, dgettext("errors", "Failed to set up user account."))
412 |> redirect(external: redirect_uri(conn, params["redirect_uri"]))
416 defp callback_params(%{"state" => state} = params) do
417 Map.merge(params, Jason.decode!(state))
420 def registration_details(%Plug.Conn{} = conn, %{"authorization" => auth_attrs}) do
421 render(conn, "register.html", %{
422 client_id: auth_attrs["client_id"],
423 redirect_uri: auth_attrs["redirect_uri"],
424 state: auth_attrs["state"],
425 scopes: Scopes.fetch_scopes(auth_attrs, []),
426 nickname: auth_attrs["nickname"],
427 email: auth_attrs["email"]
431 def register(%Plug.Conn{} = conn, %{"authorization" => _, "op" => "connect"} = params) do
432 with registration_id when not is_nil(registration_id) <- get_session_registration_id(conn),
433 %Registration{} = registration <- Repo.get(Registration, registration_id),
434 {_, {:ok, auth}} <- {:create_authorization, do_create_authorization(conn, params)},
435 %User{} = user <- Repo.preload(auth, :user).user,
436 {:ok, _updated_registration} <- Registration.bind_to_user(registration, user) do
438 |> put_session_registration_id(nil)
439 |> after_create_authorization(auth, params)
441 {:create_authorization, error} ->
442 {:register, handle_create_authorization_error(conn, error, params)}
445 {:register, :generic_error}
449 def register(%Plug.Conn{} = conn, %{"authorization" => _, "op" => "register"} = params) do
450 with registration_id when not is_nil(registration_id) <- get_session_registration_id(conn),
451 %Registration{} = registration <- Repo.get(Registration, registration_id),
452 {:ok, user} <- Authenticator.create_from_registration(conn, registration) do
454 |> put_session_registration_id(nil)
455 |> create_authorization(
460 {:error, changeset} ->
462 Enum.map(changeset.errors, fn {field, {error, _}} ->
470 "ap_id has already been taken",
471 "nickname has already been taken"
475 |> put_status(:forbidden)
476 |> put_flash(:error, "Error: #{message}.")
477 |> registration_details(params)
480 {:register, :generic_error}
484 defp do_create_authorization(
489 "client_id" => client_id,
490 "redirect_uri" => redirect_uri
495 with {_, {:ok, %User{} = user}} <-
496 {:get_user, (user && {:ok, user}) || Authenticator.get_user(conn)},
497 %App{} = app <- Repo.get_by(App, client_id: client_id),
498 true <- redirect_uri in String.split(app.redirect_uris),
499 {:ok, scopes} <- validate_scopes(app, auth_attrs),
500 {:account_status, :active} <- {:account_status, User.account_status(user)} do
501 Authorization.create_authorization(app, user, scopes)
505 # Special case: Local MastodonFE
506 defp redirect_uri(%Plug.Conn{} = conn, "."), do: auth_url(conn, :login)
508 defp redirect_uri(%Plug.Conn{}, redirect_uri), do: redirect_uri
510 defp get_session_registration_id(%Plug.Conn{} = conn), do: get_session(conn, :registration_id)
512 defp put_session_registration_id(%Plug.Conn{} = conn, registration_id),
513 do: put_session(conn, :registration_id, registration_id)
515 @spec validate_scopes(App.t(), map()) ::
516 {:ok, list()} | {:error, :missing_scopes | :unsupported_scopes}
517 defp validate_scopes(%App{} = app, params) do
519 |> Scopes.fetch_scopes(app.scopes)
520 |> Scopes.validate(app.scopes)
523 def default_redirect_uri(%App{} = app) do
529 defp render_invalid_credentials_error(conn) do
530 render_error(conn, :bad_request, "Invalid credentials")