git.squeep.com Git - akkoma/blob - lib/pleroma/web/oauth/oauth_controller.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.Web.OAuth.OAuthController do
   6   use Pleroma.Web, :controller
   7
   8   alias Pleroma.Helpers.UriHelper
   9   alias Pleroma.Registration
  10   alias Pleroma.Repo
  11   alias Pleroma.User
  12   alias Pleroma.Web.Auth.Authenticator
  13   alias Pleroma.Web.ControllerHelper
  14   alias Pleroma.Web.OAuth.App
  15   alias Pleroma.Web.OAuth.Authorization
  16   alias Pleroma.Web.OAuth.Token
  17   alias Pleroma.Web.OAuth.Token.Strategy.RefreshToken
  18   alias Pleroma.Web.OAuth.Token.Strategy.Revoke, as: RevokeToken
  19   alias Pleroma.Web.OAuth.Scopes
  20
  21   require Logger
  22
  23   if Pleroma.Config.oauth_consumer_enabled?(), do: plug(Ueberauth)
  24
  25   plug(:fetch_session)
  26   plug(:fetch_flash)
  27
  28   action_fallback(Pleroma.Web.OAuth.FallbackController)
  29
  30   @oob_token_redirect_uri "urn:ietf:wg:oauth:2.0:oob"
  31
  32   # Note: this definition is only called from error-handling methods with `conn.params` as 2nd arg
  33   def authorize(%Plug.Conn{} = conn, %{"authorization" => _} = params) do
  34     {auth_attrs, params} = Map.pop(params, "authorization")
  35     authorize(conn, Map.merge(params, auth_attrs))
  36   end
  37
  38   def authorize(%Plug.Conn{assigns: %{token: %Token{}}} = conn, params) do
  39     if ControllerHelper.truthy_param?(params["force_login"]) do
  40       do_authorize(conn, params)
  41     else
  42       handle_existing_authorization(conn, params)
  43     end
  44   end
  45
  46   def authorize(%Plug.Conn{} = conn, params), do: do_authorize(conn, params)
  47
  48   defp do_authorize(%Plug.Conn{} = conn, params) do
  49     app = Repo.get_by(App, client_id: params["client_id"])
  50     available_scopes = (app && app.scopes) || []
  51     scopes = Scopes.fetch_scopes(params, available_scopes)
  52
  53     # Note: `params` might differ from `conn.params`; use `@params` not `@conn.params` in template
  54     render(conn, Authenticator.auth_template(), %{
  55       response_type: params["response_type"],
  56       client_id: params["client_id"],
  57       available_scopes: available_scopes,
  58       scopes: scopes,
  59       redirect_uri: params["redirect_uri"],
  60       state: params["state"],
  61       params: params
  62     })
  63   end
  64
  65   defp handle_existing_authorization(
  66          %Plug.Conn{assigns: %{token: %Token{} = token}} = conn,
  67          %{"redirect_uri" => @oob_token_redirect_uri}
  68        ) do
  69     render(conn, "oob_token_exists.html", %{token: token})
  70   end
  71
  72   defp handle_existing_authorization(
  73          %Plug.Conn{assigns: %{token: %Token{} = token}} = conn,
  74          %{} = params
  75        ) do
  76     app = Repo.preload(token, :app).app
  77
  78     redirect_uri =
  79       if is_binary(params["redirect_uri"]) do
  80         params["redirect_uri"]
  81       else
  82         default_redirect_uri(app)
  83       end
  84
  85     if redirect_uri in String.split(app.redirect_uris) do
  86       redirect_uri = redirect_uri(conn, redirect_uri)
  87       url_params = %{access_token: token.token}
  88       url_params = UriHelper.append_param_if_present(url_params, :state, params["state"])
  89       url = UriHelper.append_uri_params(redirect_uri, url_params)
  90       redirect(conn, external: url)
  91     else
  92       conn
  93       |> put_flash(:error, dgettext("errors", "Unlisted redirect_uri."))
  94       |> redirect(external: redirect_uri(conn, redirect_uri))
  95     end
  96   end
  97
  98   def create_authorization(
  99         %Plug.Conn{} = conn,
 100         %{"authorization" => _} = params,
 101         opts \\ []
 102       ) do
 103     with {:ok, auth} <- do_create_authorization(conn, params, opts[:user]) do
 104       after_create_authorization(conn, auth, params)
 105     else
 106       error ->
 107         handle_create_authorization_error(conn, error, params)
 108     end
 109   end
 110
 111   def after_create_authorization(%Plug.Conn{} = conn, %Authorization{} = auth, %{
 112         "authorization" => %{"redirect_uri" => @oob_token_redirect_uri}
 113       }) do
 114     render(conn, "oob_authorization_created.html", %{auth: auth})
 115   end
 116
 117   def after_create_authorization(%Plug.Conn{} = conn, %Authorization{} = auth, %{
 118         "authorization" => %{"redirect_uri" => redirect_uri} = auth_attrs
 119       }) do
 120     app = Repo.preload(auth, :app).app
 121
 122     # An extra safety measure before we redirect (also done in `do_create_authorization/2`)
 123     if redirect_uri in String.split(app.redirect_uris) do
 124       redirect_uri = redirect_uri(conn, redirect_uri)
 125       url_params = %{code: auth.token}
 126       url_params = UriHelper.append_param_if_present(url_params, :state, auth_attrs["state"])
 127       url = UriHelper.append_uri_params(redirect_uri, url_params)
 128       redirect(conn, external: url)
 129     else
 130       conn
 131       |> put_flash(:error, dgettext("errors", "Unlisted redirect_uri."))
 132       |> redirect(external: redirect_uri(conn, redirect_uri))
 133     end
 134   end
 135
 136   defp handle_create_authorization_error(
 137          %Plug.Conn{} = conn,
 138          {:error, scopes_issue},
 139          %{"authorization" => _} = params
 140        )
 141        when scopes_issue in [:unsupported_scopes, :missing_scopes] do
 142     # Per https://github.com/tootsuite/mastodon/blob/
 143     #   51e154f5e87968d6bb115e053689767ab33e80cd/app/controllers/api/base_controller.rb#L39
 144     conn
 145     |> put_flash(:error, dgettext("errors", "This action is outside the authorized scopes"))
 146     |> put_status(:unauthorized)
 147     |> authorize(params)
 148   end
 149
 150   defp handle_create_authorization_error(
 151          %Plug.Conn{} = conn,
 152          {:auth_active, false},
 153          %{"authorization" => _} = params
 154        ) do
 155     # Per https://github.com/tootsuite/mastodon/blob/
 156     #   51e154f5e87968d6bb115e053689767ab33e80cd/app/controllers/api/base_controller.rb#L76
 157     conn
 158     |> put_flash(:error, dgettext("errors", "Your login is missing a confirmed e-mail address"))
 159     |> put_status(:forbidden)
 160     |> authorize(params)
 161   end
 162
 163   defp handle_create_authorization_error(%Plug.Conn{} = conn, error, %{"authorization" => _}) do
 164     Authenticator.handle_error(conn, error)
 165   end
 166
 167   @doc "Renew access_token with refresh_token"
 168   def token_exchange(
 169         %Plug.Conn{} = conn,
 170         %{"grant_type" => "refresh_token", "refresh_token" => token} = _params
 171       ) do
 172     with {:ok, app} <- Token.Utils.fetch_app(conn),
 173          {:ok, %{user: user} = token} <- Token.get_by_refresh_token(app, token),
 174          {:ok, token} <- RefreshToken.grant(token) do
 175       response_attrs = %{created_at: Token.Utils.format_created_at(token)}
 176
 177       json(conn, Token.Response.build(user, token, response_attrs))
 178     else
 179       _error -> render_invalid_credentials_error(conn)
 180     end
 181   end
 182
 183   def token_exchange(%Plug.Conn{} = conn, %{"grant_type" => "authorization_code"} = params) do
 184     with {:ok, app} <- Token.Utils.fetch_app(conn),
 185          fixed_token = Token.Utils.fix_padding(params["code"]),
 186          {:ok, auth} <- Authorization.get_by_token(app, fixed_token),
 187          %User{} = user <- User.get_cached_by_id(auth.user_id),
 188          {:ok, token} <- Token.exchange_token(app, auth) do
 189       response_attrs = %{created_at: Token.Utils.format_created_at(token)}
 190
 191       json(conn, Token.Response.build(user, token, response_attrs))
 192     else
 193       _error -> render_invalid_credentials_error(conn)
 194     end
 195   end
 196
 197   def token_exchange(
 198         %Plug.Conn{} = conn,
 199         %{"grant_type" => "password"} = params
 200       ) do
 201     with {:ok, %User{} = user} <- Authenticator.get_user(conn),
 202          {:ok, app} <- Token.Utils.fetch_app(conn),
 203          {:auth_active, true} <- {:auth_active, User.auth_active?(user)},
 204          {:user_active, true} <- {:user_active, !user.info.deactivated},
 205          {:ok, scopes} <- validate_scopes(app, params),
 206          {:ok, auth} <- Authorization.create_authorization(app, user, scopes),
 207          {:ok, token} <- Token.exchange_token(app, auth) do
 208       json(conn, Token.Response.build(user, token))
 209     else
 210       {:auth_active, false} ->
 211         # Per https://github.com/tootsuite/mastodon/blob/
 212         #   51e154f5e87968d6bb115e053689767ab33e80cd/app/controllers/api/base_controller.rb#L76
 213         render_error(conn, :forbidden, "Your login is missing a confirmed e-mail address")
 214
 215       {:user_active, false} ->
 216         render_error(conn, :forbidden, "Your account is currently disabled")
 217
 218       _error ->
 219         render_invalid_credentials_error(conn)
 220     end
 221   end
 222
 223   def token_exchange(
 224         %Plug.Conn{} = conn,
 225         %{"grant_type" => "password", "name" => name, "password" => _password} = params
 226       ) do
 227     params =
 228       params
 229       |> Map.delete("name")
 230       |> Map.put("username", name)
 231
 232     token_exchange(conn, params)
 233   end
 234
 235   def token_exchange(%Plug.Conn{} = conn, %{"grant_type" => "client_credentials"} = _params) do
 236     with {:ok, app} <- Token.Utils.fetch_app(conn),
 237          {:ok, auth} <- Authorization.create_authorization(app, %User{}),
 238          {:ok, token} <- Token.exchange_token(app, auth) do
 239       json(conn, Token.Response.build_for_client_credentials(token))
 240     else
 241       _error -> render_invalid_credentials_error(conn)
 242     end
 243   end
 244
 245   # Bad request
 246   def token_exchange(%Plug.Conn{} = conn, params), do: bad_request(conn, params)
 247
 248   def token_revoke(%Plug.Conn{} = conn, %{"token" => _token} = params) do
 249     with {:ok, app} <- Token.Utils.fetch_app(conn),
 250          {:ok, _token} <- RevokeToken.revoke(app, params) do
 251       json(conn, %{})
 252     else
 253       _error ->
 254         # RFC 7009: invalid tokens [in the request] do not cause an error response
 255         json(conn, %{})
 256     end
 257   end
 258
 259   def token_revoke(%Plug.Conn{} = conn, params), do: bad_request(conn, params)
 260
 261   # Response for bad request
 262   defp bad_request(%Plug.Conn{} = conn, _) do
 263     render_error(conn, :internal_server_error, "Bad request")
 264   end
 265
 266   @doc "Prepares OAuth request to provider for Ueberauth"
 267   def prepare_request(%Plug.Conn{} = conn, %{
 268         "provider" => provider,
 269         "authorization" => auth_attrs
 270       }) do
 271     scope =
 272       auth_attrs
 273       |> Scopes.fetch_scopes([])
 274       |> Scopes.to_string()
 275
 276     state =
 277       auth_attrs
 278       |> Map.delete("scopes")
 279       |> Map.put("scope", scope)
 280       |> Jason.encode!()
 281
 282     params =
 283       auth_attrs
 284       |> Map.drop(~w(scope scopes client_id redirect_uri))
 285       |> Map.put("state", state)
 286
 287     # Handing the request to Ueberauth
 288     redirect(conn, to: o_auth_path(conn, :request, provider, params))
 289   end
 290
 291   def request(%Plug.Conn{} = conn, params) do
 292     message =
 293       if params["provider"] do
 294         dgettext("errors", "Unsupported OAuth provider: %{provider}.",
 295           provider: params["provider"]
 296         )
 297       else
 298         dgettext("errors", "Bad OAuth request.")
 299       end
 300
 301     conn
 302     |> put_flash(:error, message)
 303     |> redirect(to: "/")
 304   end
 305
 306   def callback(%Plug.Conn{assigns: %{ueberauth_failure: failure}} = conn, params) do
 307     params = callback_params(params)
 308     messages = for e <- Map.get(failure, :errors, []), do: e.message
 309     message = Enum.join(messages, "; ")
 310
 311     conn
 312     |> put_flash(
 313       :error,
 314       dgettext("errors", "Failed to authenticate: %{message}.", message: message)
 315     )
 316     |> redirect(external: redirect_uri(conn, params["redirect_uri"]))
 317   end
 318
 319   def callback(%Plug.Conn{} = conn, params) do
 320     params = callback_params(params)
 321
 322     with {:ok, registration} <- Authenticator.get_registration(conn) do
 323       auth_attrs = Map.take(params, ~w(client_id redirect_uri scope scopes state))
 324
 325       case Repo.get_assoc(registration, :user) do
 326         {:ok, user} ->
 327           create_authorization(conn, %{"authorization" => auth_attrs}, user: user)
 328
 329         _ ->
 330           registration_params =
 331             Map.merge(auth_attrs, %{
 332               "nickname" => Registration.nickname(registration),
 333               "email" => Registration.email(registration)
 334             })
 335
 336           conn
 337           |> put_session_registration_id(registration.id)
 338           |> registration_details(%{"authorization" => registration_params})
 339       end
 340     else
 341       error ->
 342         Logger.debug(inspect(["OAUTH_ERROR", error, conn.assigns]))
 343
 344         conn
 345         |> put_flash(:error, dgettext("errors", "Failed to set up user account."))
 346         |> redirect(external: redirect_uri(conn, params["redirect_uri"]))
 347     end
 348   end
 349
 350   defp callback_params(%{"state" => state} = params) do
 351     Map.merge(params, Jason.decode!(state))
 352   end
 353
 354   def registration_details(%Plug.Conn{} = conn, %{"authorization" => auth_attrs}) do
 355     render(conn, "register.html", %{
 356       client_id: auth_attrs["client_id"],
 357       redirect_uri: auth_attrs["redirect_uri"],
 358       state: auth_attrs["state"],
 359       scopes: Scopes.fetch_scopes(auth_attrs, []),
 360       nickname: auth_attrs["nickname"],
 361       email: auth_attrs["email"]
 362     })
 363   end
 364
 365   def register(%Plug.Conn{} = conn, %{"authorization" => _, "op" => "connect"} = params) do
 366     with registration_id when not is_nil(registration_id) <- get_session_registration_id(conn),
 367          %Registration{} = registration <- Repo.get(Registration, registration_id),
 368          {_, {:ok, auth}} <- {:create_authorization, do_create_authorization(conn, params)},
 369          %User{} = user <- Repo.preload(auth, :user).user,
 370          {:ok, _updated_registration} <- Registration.bind_to_user(registration, user) do
 371       conn
 372       |> put_session_registration_id(nil)
 373       |> after_create_authorization(auth, params)
 374     else
 375       {:create_authorization, error} ->
 376         {:register, handle_create_authorization_error(conn, error, params)}
 377
 378       _ ->
 379         {:register, :generic_error}
 380     end
 381   end
 382
 383   def register(%Plug.Conn{} = conn, %{"authorization" => _, "op" => "register"} = params) do
 384     with registration_id when not is_nil(registration_id) <- get_session_registration_id(conn),
 385          %Registration{} = registration <- Repo.get(Registration, registration_id),
 386          {:ok, user} <- Authenticator.create_from_registration(conn, registration) do
 387       conn
 388       |> put_session_registration_id(nil)
 389       |> create_authorization(
 390         params,
 391         user: user
 392       )
 393     else
 394       {:error, changeset} ->
 395         message =
 396           Enum.map(changeset.errors, fn {field, {error, _}} ->
 397             "#{field} #{error}"
 398           end)
 399           |> Enum.join("; ")
 400
 401         message =
 402           String.replace(
 403             message,
 404             "ap_id has already been taken",
 405             "nickname has already been taken"
 406           )
 407
 408         conn
 409         |> put_status(:forbidden)
 410         |> put_flash(:error, "Error: #{message}.")
 411         |> registration_details(params)
 412
 413       _ ->
 414         {:register, :generic_error}
 415     end
 416   end
 417
 418   defp do_create_authorization(
 419          %Plug.Conn{} = conn,
 420          %{
 421            "authorization" =>
 422              %{
 423                "client_id" => client_id,
 424                "redirect_uri" => redirect_uri
 425              } = auth_attrs
 426          },
 427          user \\ nil
 428        ) do
 429     with {_, {:ok, %User{} = user}} <-
 430            {:get_user, (user && {:ok, user}) || Authenticator.get_user(conn)},
 431          %App{} = app <- Repo.get_by(App, client_id: client_id),
 432          true <- redirect_uri in String.split(app.redirect_uris),
 433          {:ok, scopes} <- validate_scopes(app, auth_attrs),
 434          {:auth_active, true} <- {:auth_active, User.auth_active?(user)} do
 435       Authorization.create_authorization(app, user, scopes)
 436     end
 437   end
 438
 439   # Special case: Local MastodonFE
 440   defp redirect_uri(%Plug.Conn{} = conn, "."), do: mastodon_api_url(conn, :login)
 441
 442   defp redirect_uri(%Plug.Conn{}, redirect_uri), do: redirect_uri
 443
 444   defp get_session_registration_id(%Plug.Conn{} = conn), do: get_session(conn, :registration_id)
 445
 446   defp put_session_registration_id(%Plug.Conn{} = conn, registration_id),
 447     do: put_session(conn, :registration_id, registration_id)
 448
 449   @spec validate_scopes(App.t(), map()) ::
 450           {:ok, list()} | {:error, :missing_scopes | :unsupported_scopes}
 451   defp validate_scopes(app, params) do
 452     params
 453     |> Scopes.fetch_scopes(app.scopes)
 454     |> Scopes.validates(app.scopes)
 455   end
 456
 457   def default_redirect_uri(%App{} = app) do
 458     app.redirect_uris
 459     |> String.split()
 460     |> Enum.at(0)
 461   end
 462
 463   defp render_invalid_credentials_error(conn) do
 464     render_error(conn, :bad_request, "Invalid credentials")
 465   end
 466 end