Merge remote-tracking branch 'upstream/develop' into feature/openldap-support
[akkoma] / 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.Repo
9 alias Pleroma.User
10 alias Pleroma.Web.Auth.Authenticator
11 alias Pleroma.Web.OAuth.App
12 alias Pleroma.Web.OAuth.Authorization
13 alias Pleroma.Web.OAuth.Token
14
15 import Pleroma.Web.ControllerHelper, only: [oauth_scopes: 2]
16
17 plug(:fetch_session)
18 plug(:fetch_flash)
19
20 action_fallback(Pleroma.Web.OAuth.FallbackController)
21
22 def authorize(conn, params) do
23 app = Repo.get_by(App, client_id: params["client_id"])
24 available_scopes = (app && app.scopes) || []
25 scopes = oauth_scopes(params, nil) || available_scopes
26
27 render(conn, Authenticator.auth_template(), %{
28 response_type: params["response_type"],
29 client_id: params["client_id"],
30 available_scopes: available_scopes,
31 scopes: scopes,
32 redirect_uri: params["redirect_uri"],
33 state: params["state"],
34 params: params
35 })
36 end
37
38 def create_authorization(conn, %{
39 "authorization" =>
40 %{
41 "client_id" => client_id,
42 "redirect_uri" => redirect_uri
43 } = auth_params
44 }) do
45 with {_, {:ok, %User{} = user}} <- {:get_user, Authenticator.get_user(conn)},
46 %App{} = app <- Repo.get_by(App, client_id: client_id),
47 true <- redirect_uri in String.split(app.redirect_uris),
48 scopes <- oauth_scopes(auth_params, []),
49 {:unsupported_scopes, []} <- {:unsupported_scopes, scopes -- app.scopes},
50 # Note: `scope` param is intentionally not optional in this context
51 {:missing_scopes, false} <- {:missing_scopes, scopes == []},
52 {:auth_active, true} <- {:auth_active, User.auth_active?(user)},
53 {:ok, auth} <- Authorization.create_authorization(app, user, scopes) do
54 redirect_uri =
55 if redirect_uri == "." do
56 # Special case: Local MastodonFE
57 mastodon_api_url(conn, :login)
58 else
59 redirect_uri
60 end
61
62 cond do
63 redirect_uri == "urn:ietf:wg:oauth:2.0:oob" ->
64 render(conn, "results.html", %{
65 auth: auth
66 })
67
68 true ->
69 connector = if String.contains?(redirect_uri, "?"), do: "&", else: "?"
70 url = "#{redirect_uri}#{connector}"
71 url_params = %{:code => auth.token}
72
73 url_params =
74 if auth_params["state"] do
75 Map.put(url_params, :state, auth_params["state"])
76 else
77 url_params
78 end
79
80 url = "#{url}#{Plug.Conn.Query.encode(url_params)}"
81
82 redirect(conn, external: url)
83 end
84 else
85 {scopes_issue, _} when scopes_issue in [:unsupported_scopes, :missing_scopes] ->
86 conn
87 |> put_flash(:error, "Permissions not specified.")
88 |> put_status(:unauthorized)
89 |> authorize(auth_params)
90
91 {:auth_active, false} ->
92 conn
93 |> put_flash(:error, "Account confirmation pending.")
94 |> put_status(:forbidden)
95 |> authorize(auth_params)
96
97 error ->
98 Authenticator.handle_error(conn, error)
99 end
100 end
101
102 def token_exchange(conn, %{"grant_type" => "authorization_code"} = params) do
103 with %App{} = app <- get_app_from_request(conn, params),
104 fixed_token = fix_padding(params["code"]),
105 %Authorization{} = auth <-
106 Repo.get_by(Authorization, token: fixed_token, app_id: app.id),
107 {:ok, token} <- Token.exchange_token(app, auth),
108 {:ok, inserted_at} <- DateTime.from_naive(token.inserted_at, "Etc/UTC") do
109 response = %{
110 token_type: "Bearer",
111 access_token: token.token,
112 refresh_token: token.refresh_token,
113 created_at: DateTime.to_unix(inserted_at),
114 expires_in: 60 * 10,
115 scope: Enum.join(token.scopes, " ")
116 }
117
118 json(conn, response)
119 else
120 _error ->
121 put_status(conn, 400)
122 |> json(%{error: "Invalid credentials"})
123 end
124 end
125
126 def token_exchange(
127 conn,
128 %{"grant_type" => "password"} = params
129 ) do
130 with {_, {:ok, %User{} = user}} <- {:get_user, Authenticator.get_user(conn)},
131 %App{} = app <- get_app_from_request(conn, params),
132 {:auth_active, true} <- {:auth_active, User.auth_active?(user)},
133 scopes <- oauth_scopes(params, app.scopes),
134 [] <- scopes -- app.scopes,
135 true <- Enum.any?(scopes),
136 {:ok, auth} <- Authorization.create_authorization(app, user, scopes),
137 {:ok, token} <- Token.exchange_token(app, auth) do
138 response = %{
139 token_type: "Bearer",
140 access_token: token.token,
141 refresh_token: token.refresh_token,
142 expires_in: 60 * 10,
143 scope: Enum.join(token.scopes, " ")
144 }
145
146 json(conn, response)
147 else
148 {:auth_active, false} ->
149 conn
150 |> put_status(:forbidden)
151 |> json(%{error: "Account confirmation pending"})
152
153 _error ->
154 put_status(conn, 400)
155 |> json(%{error: "Invalid credentials"})
156 end
157 end
158
159 def token_exchange(
160 conn,
161 %{"grant_type" => "password", "name" => name, "password" => _password} = params
162 ) do
163 params =
164 params
165 |> Map.delete("name")
166 |> Map.put("username", name)
167
168 token_exchange(conn, params)
169 end
170
171 def token_revoke(conn, %{"token" => token} = params) do
172 with %App{} = app <- get_app_from_request(conn, params),
173 %Token{} = token <- Repo.get_by(Token, token: token, app_id: app.id),
174 {:ok, %Token{}} <- Repo.delete(token) do
175 json(conn, %{})
176 else
177 _error ->
178 # RFC 7009: invalid tokens [in the request] do not cause an error response
179 json(conn, %{})
180 end
181 end
182
183 # XXX - for whatever reason our token arrives urlencoded, but Plug.Conn should be
184 # decoding it. Investigate sometime.
185 defp fix_padding(token) do
186 token
187 |> URI.decode()
188 |> Base.url_decode64!(padding: false)
189 |> Base.url_encode64(padding: false)
190 end
191
192 defp get_app_from_request(conn, params) do
193 # Per RFC 6749, HTTP Basic is preferred to body params
194 {client_id, client_secret} =
195 with ["Basic " <> encoded] <- get_req_header(conn, "authorization"),
196 {:ok, decoded} <- Base.decode64(encoded),
197 [id, secret] <-
198 String.split(decoded, ":")
199 |> Enum.map(fn s -> URI.decode_www_form(s) end) do
200 {id, secret}
201 else
202 _ -> {params["client_id"], params["client_secret"]}
203 end
204
205 if client_id && client_secret do
206 Repo.get_by(
207 App,
208 client_id: client_id,
209 client_secret: client_secret
210 )
211 else
212 nil
213 end
214 end
215 end