Merge branch 'oauth_secure_redirect' into 'develop'

OAuth security improvements (`redirect_uri` listing enforcement)

See merge request pleroma/pleroma!1302
This commit is contained in:
kaniini 2019-06-21 22:31:12 +00:00
commit e3534f5b3c
2 changed files with 153 additions and 43 deletions

View file

@ -64,26 +64,34 @@ defp do_authorize(%Plug.Conn{} = conn, params) do
defp handle_existing_authorization( defp handle_existing_authorization(
%Plug.Conn{assigns: %{token: %Token{} = token}} = conn, %Plug.Conn{assigns: %{token: %Token{} = token}} = conn,
params %{"redirect_uri" => @oob_token_redirect_uri}
) do ) do
token = Repo.preload(token, :app) render(conn, "oob_token_exists.html", %{token: token})
end
defp handle_existing_authorization(
%Plug.Conn{assigns: %{token: %Token{} = token}} = conn,
%{} = params
) do
app = Repo.preload(token, :app).app
redirect_uri = redirect_uri =
if is_binary(params["redirect_uri"]) do if is_binary(params["redirect_uri"]) do
params["redirect_uri"] params["redirect_uri"]
else else
default_redirect_uri(token.app) default_redirect_uri(app)
end end
redirect_uri = redirect_uri(conn, redirect_uri) if redirect_uri in String.split(app.redirect_uris) do
redirect_uri = redirect_uri(conn, redirect_uri)
if redirect_uri == @oob_token_redirect_uri do
render(conn, "oob_token_exists.html", %{token: token})
else
url_params = %{access_token: token.token} url_params = %{access_token: token.token}
url_params = UriHelper.append_param_if_present(url_params, :state, params["state"]) url_params = UriHelper.append_param_if_present(url_params, :state, params["state"])
url = UriHelper.append_uri_params(redirect_uri, url_params) url = UriHelper.append_uri_params(redirect_uri, url_params)
redirect(conn, external: url) redirect(conn, external: url)
else
conn
|> put_flash(:error, "Unlisted redirect_uri.")
|> redirect(external: redirect_uri(conn, redirect_uri))
end end
end end
@ -100,18 +108,28 @@ def create_authorization(
end end
end end
def after_create_authorization(%Plug.Conn{} = conn, %Authorization{} = auth, %{
"authorization" => %{"redirect_uri" => @oob_token_redirect_uri}
}) do
render(conn, "oob_authorization_created.html", %{auth: auth})
end
def after_create_authorization(%Plug.Conn{} = conn, %Authorization{} = auth, %{ def after_create_authorization(%Plug.Conn{} = conn, %Authorization{} = auth, %{
"authorization" => %{"redirect_uri" => redirect_uri} = auth_attrs "authorization" => %{"redirect_uri" => redirect_uri} = auth_attrs
}) do }) do
redirect_uri = redirect_uri(conn, redirect_uri) app = Repo.preload(auth, :app).app
if redirect_uri == @oob_token_redirect_uri do # An extra safety measure before we redirect (also done in `do_create_authorization/2`)
render(conn, "oob_authorization_created.html", %{auth: auth}) if redirect_uri in String.split(app.redirect_uris) do
else redirect_uri = redirect_uri(conn, redirect_uri)
url_params = %{code: auth.token} url_params = %{code: auth.token}
url_params = UriHelper.append_param_if_present(url_params, :state, auth_attrs["state"]) url_params = UriHelper.append_param_if_present(url_params, :state, auth_attrs["state"])
url = UriHelper.append_uri_params(redirect_uri, url_params) url = UriHelper.append_uri_params(redirect_uri, url_params)
redirect(conn, external: url) redirect(conn, external: url)
else
conn
|> put_flash(:error, "Unlisted redirect_uri.")
|> redirect(external: redirect_uri(conn, redirect_uri))
end end
end end
@ -324,7 +342,7 @@ def callback(%Plug.Conn{} = conn, params) do
}) })
conn conn
|> put_session(:registration_id, registration.id) |> put_session_registration_id(registration.id)
|> registration_details(%{"authorization" => registration_params}) |> registration_details(%{"authorization" => registration_params})
end end
else else
@ -445,7 +463,7 @@ defp validate_scopes(app, params) do
|> Scopes.validates(app.scopes) |> Scopes.validates(app.scopes)
end end
defp default_redirect_uri(%App{} = app) do def default_redirect_uri(%App{} = app) do
app.redirect_uris app.redirect_uris
|> String.split() |> String.split()
|> Enum.at(0) |> Enum.at(0)

View file

@ -10,6 +10,7 @@ defmodule Pleroma.Web.OAuth.OAuthControllerTest do
alias Pleroma.Registration alias Pleroma.Registration
alias Pleroma.Repo alias Pleroma.Repo
alias Pleroma.Web.OAuth.Authorization alias Pleroma.Web.OAuth.Authorization
alias Pleroma.Web.OAuth.OAuthController
alias Pleroma.Web.OAuth.Token alias Pleroma.Web.OAuth.Token
@oauth_config_path [:oauth2, :issue_new_refresh_token] @oauth_config_path [:oauth2, :issue_new_refresh_token]
@ -49,7 +50,7 @@ test "GET /oauth/authorize renders auth forms, including OAuth consumer form", %
%{ %{
"response_type" => "code", "response_type" => "code",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"scope" => "read" "scope" => "read"
} }
) )
@ -72,7 +73,7 @@ test "GET /oauth/prepare_request encodes parameters as `state` and redirects", %
"authorization" => %{ "authorization" => %{
"scope" => "read follow", "scope" => "read follow",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"state" => "a_state" "state" => "a_state"
} }
} }
@ -98,11 +99,12 @@ test "GET /oauth/prepare_request encodes parameters as `state` and redirects", %
test "with user-bound registration, GET /oauth/<provider>/callback redirects to `redirect_uri` with `code`", test "with user-bound registration, GET /oauth/<provider>/callback redirects to `redirect_uri` with `code`",
%{app: app, conn: conn} do %{app: app, conn: conn} do
registration = insert(:registration) registration = insert(:registration)
redirect_uri = OAuthController.default_redirect_uri(app)
state_params = %{ state_params = %{
"scope" => Enum.join(app.scopes, " "), "scope" => Enum.join(app.scopes, " "),
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => redirect_uri,
"state" => "" "state" => ""
} }
@ -121,7 +123,7 @@ test "with user-bound registration, GET /oauth/<provider>/callback redirects to
) )
assert response = html_response(conn, 302) assert response = html_response(conn, 302)
assert redirected_to(conn) =~ ~r/#{app.redirect_uris}\?code=.+/ assert redirected_to(conn) =~ ~r/#{redirect_uri}\?code=.+/
end end
end end
@ -132,7 +134,7 @@ test "with user-unbound registration, GET /oauth/<provider>/callback renders reg
state_params = %{ state_params = %{
"scope" => "read write", "scope" => "read write",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"state" => "a_state" "state" => "a_state"
} }
@ -165,7 +167,7 @@ test "on authentication error, GET /oauth/<provider>/callback redirects to `redi
state_params = %{ state_params = %{
"scope" => Enum.join(app.scopes, " "), "scope" => Enum.join(app.scopes, " "),
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"state" => "" "state" => ""
} }
@ -199,7 +201,7 @@ test "GET /oauth/registration_details renders registration details form", %{
"authorization" => %{ "authorization" => %{
"scopes" => app.scopes, "scopes" => app.scopes,
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"state" => "a_state", "state" => "a_state",
"nickname" => nil, "nickname" => nil,
"email" => "john@doe.com" "email" => "john@doe.com"
@ -218,6 +220,7 @@ test "with valid params, POST /oauth/register?op=register redirects to `redirect
conn: conn conn: conn
} do } do
registration = insert(:registration, user: nil, info: %{"nickname" => nil, "email" => nil}) registration = insert(:registration, user: nil, info: %{"nickname" => nil, "email" => nil})
redirect_uri = OAuthController.default_redirect_uri(app)
conn = conn =
conn conn
@ -229,7 +232,7 @@ test "with valid params, POST /oauth/register?op=register redirects to `redirect
"authorization" => %{ "authorization" => %{
"scopes" => app.scopes, "scopes" => app.scopes,
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => redirect_uri,
"state" => "a_state", "state" => "a_state",
"nickname" => "availablenick", "nickname" => "availablenick",
"email" => "available@email.com" "email" => "available@email.com"
@ -238,7 +241,36 @@ test "with valid params, POST /oauth/register?op=register redirects to `redirect
) )
assert response = html_response(conn, 302) assert response = html_response(conn, 302)
assert redirected_to(conn) =~ ~r/#{app.redirect_uris}\?code=.+/ assert redirected_to(conn) =~ ~r/#{redirect_uri}\?code=.+/
end
test "with unlisted `redirect_uri`, POST /oauth/register?op=register results in HTTP 401",
%{
app: app,
conn: conn
} do
registration = insert(:registration, user: nil, info: %{"nickname" => nil, "email" => nil})
unlisted_redirect_uri = "http://cross-site-request.com"
conn =
conn
|> put_session(:registration_id, registration.id)
|> post(
"/oauth/register",
%{
"op" => "register",
"authorization" => %{
"scopes" => app.scopes,
"client_id" => app.client_id,
"redirect_uri" => unlisted_redirect_uri,
"state" => "a_state",
"nickname" => "availablenick",
"email" => "available@email.com"
}
}
)
assert response = html_response(conn, 401)
end end
test "with invalid params, POST /oauth/register?op=register renders registration_details page", test "with invalid params, POST /oauth/register?op=register renders registration_details page",
@ -254,7 +286,7 @@ test "with invalid params, POST /oauth/register?op=register renders registration
"authorization" => %{ "authorization" => %{
"scopes" => app.scopes, "scopes" => app.scopes,
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"state" => "a_state", "state" => "a_state",
"nickname" => "availablenickname", "nickname" => "availablenickname",
"email" => "available@email.com" "email" => "available@email.com"
@ -286,6 +318,7 @@ test "with valid params, POST /oauth/register?op=connect redirects to `redirect_
} do } do
user = insert(:user, password_hash: Comeonin.Pbkdf2.hashpwsalt("testpassword")) user = insert(:user, password_hash: Comeonin.Pbkdf2.hashpwsalt("testpassword"))
registration = insert(:registration, user: nil) registration = insert(:registration, user: nil)
redirect_uri = OAuthController.default_redirect_uri(app)
conn = conn =
conn conn
@ -297,7 +330,7 @@ test "with valid params, POST /oauth/register?op=connect redirects to `redirect_
"authorization" => %{ "authorization" => %{
"scopes" => app.scopes, "scopes" => app.scopes,
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => redirect_uri,
"state" => "a_state", "state" => "a_state",
"name" => user.nickname, "name" => user.nickname,
"password" => "testpassword" "password" => "testpassword"
@ -306,7 +339,37 @@ test "with valid params, POST /oauth/register?op=connect redirects to `redirect_
) )
assert response = html_response(conn, 302) assert response = html_response(conn, 302)
assert redirected_to(conn) =~ ~r/#{app.redirect_uris}\?code=.+/ assert redirected_to(conn) =~ ~r/#{redirect_uri}\?code=.+/
end
test "with unlisted `redirect_uri`, POST /oauth/register?op=connect results in HTTP 401`",
%{
app: app,
conn: conn
} do
user = insert(:user, password_hash: Comeonin.Pbkdf2.hashpwsalt("testpassword"))
registration = insert(:registration, user: nil)
unlisted_redirect_uri = "http://cross-site-request.com"
conn =
conn
|> put_session(:registration_id, registration.id)
|> post(
"/oauth/register",
%{
"op" => "connect",
"authorization" => %{
"scopes" => app.scopes,
"client_id" => app.client_id,
"redirect_uri" => unlisted_redirect_uri,
"state" => "a_state",
"name" => user.nickname,
"password" => "testpassword"
}
}
)
assert response = html_response(conn, 401)
end end
test "with invalid params, POST /oauth/register?op=connect renders registration_details page", test "with invalid params, POST /oauth/register?op=connect renders registration_details page",
@ -322,7 +385,7 @@ test "with invalid params, POST /oauth/register?op=connect renders registration_
"authorization" => %{ "authorization" => %{
"scopes" => app.scopes, "scopes" => app.scopes,
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"state" => "a_state", "state" => "a_state",
"name" => user.nickname, "name" => user.nickname,
"password" => "wrong password" "password" => "wrong password"
@ -358,7 +421,7 @@ test "renders authentication page", %{app: app, conn: conn} do
%{ %{
"response_type" => "code", "response_type" => "code",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"scope" => "read" "scope" => "read"
} }
) )
@ -378,7 +441,7 @@ test "properly handles internal calls with `authorization`-wrapped params", %{
"authorization" => %{ "authorization" => %{
"response_type" => "code", "response_type" => "code",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"scope" => "read" "scope" => "read"
} }
} }
@ -399,7 +462,7 @@ test "renders authentication page if user is already authenticated but `force_lo
%{ %{
"response_type" => "code", "response_type" => "code",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"scope" => "read", "scope" => "read",
"force_login" => "true" "force_login" => "true"
} }
@ -423,7 +486,7 @@ test "with existing authentication and non-OOB `redirect_uri`, redirects to app
%{ %{
"response_type" => "code", "response_type" => "code",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"state" => "specific_client_state", "state" => "specific_client_state",
"scope" => "read" "scope" => "read"
} }
@ -433,6 +496,31 @@ test "with existing authentication and non-OOB `redirect_uri`, redirects to app
"https://redirect.url?access_token=#{token.token}&state=specific_client_state" "https://redirect.url?access_token=#{token.token}&state=specific_client_state"
end end
test "with existing authentication and unlisted non-OOB `redirect_uri`, redirects without credentials",
%{
app: app,
conn: conn
} do
unlisted_redirect_uri = "http://cross-site-request.com"
token = insert(:oauth_token, app_id: app.id)
conn =
conn
|> put_session(:oauth_token, token.token)
|> get(
"/oauth/authorize",
%{
"response_type" => "code",
"client_id" => app.client_id,
"redirect_uri" => unlisted_redirect_uri,
"state" => "specific_client_state",
"scope" => "read"
}
)
assert redirected_to(conn) == unlisted_redirect_uri
end
test "with existing authentication and OOB `redirect_uri`, redirects to app with `token` and `state` params", test "with existing authentication and OOB `redirect_uri`, redirects to app with `token` and `state` params",
%{ %{
app: app, app: app,
@ -461,6 +549,7 @@ test "with existing authentication and OOB `redirect_uri`, redirects to app with
test "redirects with oauth authorization" do test "redirects with oauth authorization" do
user = insert(:user) user = insert(:user)
app = insert(:oauth_app, scopes: ["read", "write", "follow"]) app = insert(:oauth_app, scopes: ["read", "write", "follow"])
redirect_uri = OAuthController.default_redirect_uri(app)
conn = conn =
build_conn() build_conn()
@ -469,14 +558,14 @@ test "redirects with oauth authorization" do
"name" => user.nickname, "name" => user.nickname,
"password" => "test", "password" => "test",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => redirect_uri,
"scope" => "read write", "scope" => "read write",
"state" => "statepassed" "state" => "statepassed"
} }
}) })
target = redirected_to(conn) target = redirected_to(conn)
assert target =~ app.redirect_uris assert target =~ redirect_uri
query = URI.parse(target).query |> URI.query_decoder() |> Map.new() query = URI.parse(target).query |> URI.query_decoder() |> Map.new()
@ -489,6 +578,7 @@ test "redirects with oauth authorization" do
test "returns 401 for wrong credentials", %{conn: conn} do test "returns 401 for wrong credentials", %{conn: conn} do
user = insert(:user) user = insert(:user)
app = insert(:oauth_app) app = insert(:oauth_app)
redirect_uri = OAuthController.default_redirect_uri(app)
result = result =
conn conn
@ -497,7 +587,7 @@ test "returns 401 for wrong credentials", %{conn: conn} do
"name" => user.nickname, "name" => user.nickname,
"password" => "wrong", "password" => "wrong",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => redirect_uri,
"state" => "statepassed", "state" => "statepassed",
"scope" => Enum.join(app.scopes, " ") "scope" => Enum.join(app.scopes, " ")
} }
@ -506,7 +596,7 @@ test "returns 401 for wrong credentials", %{conn: conn} do
# Keep the details # Keep the details
assert result =~ app.client_id assert result =~ app.client_id
assert result =~ app.redirect_uris assert result =~ redirect_uri
# Error message # Error message
assert result =~ "Invalid Username/Password" assert result =~ "Invalid Username/Password"
@ -515,6 +605,7 @@ test "returns 401 for wrong credentials", %{conn: conn} do
test "returns 401 for missing scopes", %{conn: conn} do test "returns 401 for missing scopes", %{conn: conn} do
user = insert(:user) user = insert(:user)
app = insert(:oauth_app) app = insert(:oauth_app)
redirect_uri = OAuthController.default_redirect_uri(app)
result = result =
conn conn
@ -523,7 +614,7 @@ test "returns 401 for missing scopes", %{conn: conn} do
"name" => user.nickname, "name" => user.nickname,
"password" => "test", "password" => "test",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => redirect_uri,
"state" => "statepassed", "state" => "statepassed",
"scope" => "" "scope" => ""
} }
@ -532,7 +623,7 @@ test "returns 401 for missing scopes", %{conn: conn} do
# Keep the details # Keep the details
assert result =~ app.client_id assert result =~ app.client_id
assert result =~ app.redirect_uris assert result =~ redirect_uri
# Error message # Error message
assert result =~ "This action is outside the authorized scopes" assert result =~ "This action is outside the authorized scopes"
@ -541,6 +632,7 @@ test "returns 401 for missing scopes", %{conn: conn} do
test "returns 401 for scopes beyond app scopes", %{conn: conn} do test "returns 401 for scopes beyond app scopes", %{conn: conn} do
user = insert(:user) user = insert(:user)
app = insert(:oauth_app, scopes: ["read", "write"]) app = insert(:oauth_app, scopes: ["read", "write"])
redirect_uri = OAuthController.default_redirect_uri(app)
result = result =
conn conn
@ -549,7 +641,7 @@ test "returns 401 for scopes beyond app scopes", %{conn: conn} do
"name" => user.nickname, "name" => user.nickname,
"password" => "test", "password" => "test",
"client_id" => app.client_id, "client_id" => app.client_id,
"redirect_uri" => app.redirect_uris, "redirect_uri" => redirect_uri,
"state" => "statepassed", "state" => "statepassed",
"scope" => "read write follow" "scope" => "read write follow"
} }
@ -558,7 +650,7 @@ test "returns 401 for scopes beyond app scopes", %{conn: conn} do
# Keep the details # Keep the details
assert result =~ app.client_id assert result =~ app.client_id
assert result =~ app.redirect_uris assert result =~ redirect_uri
# Error message # Error message
assert result =~ "This action is outside the authorized scopes" assert result =~ "This action is outside the authorized scopes"
@ -577,7 +669,7 @@ test "issues a token for an all-body request" do
|> post("/oauth/token", %{ |> post("/oauth/token", %{
"grant_type" => "authorization_code", "grant_type" => "authorization_code",
"code" => auth.token, "code" => auth.token,
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"client_id" => app.client_id, "client_id" => app.client_id,
"client_secret" => app.client_secret "client_secret" => app.client_secret
}) })
@ -631,7 +723,7 @@ test "issues a token for request with HTTP basic auth client credentials" do
|> post("/oauth/token", %{ |> post("/oauth/token", %{
"grant_type" => "authorization_code", "grant_type" => "authorization_code",
"code" => auth.token, "code" => auth.token,
"redirect_uri" => app.redirect_uris "redirect_uri" => OAuthController.default_redirect_uri(app)
}) })
assert %{"access_token" => token, "scope" => scope} = json_response(conn, 200) assert %{"access_token" => token, "scope" => scope} = json_response(conn, 200)
@ -676,7 +768,7 @@ test "rejects token exchange with invalid client credentials" do
|> post("/oauth/token", %{ |> post("/oauth/token", %{
"grant_type" => "authorization_code", "grant_type" => "authorization_code",
"code" => auth.token, "code" => auth.token,
"redirect_uri" => app.redirect_uris "redirect_uri" => OAuthController.default_redirect_uri(app)
}) })
assert resp = json_response(conn, 400) assert resp = json_response(conn, 400)
@ -755,7 +847,7 @@ test "rejects an invalid authorization code" do
|> post("/oauth/token", %{ |> post("/oauth/token", %{
"grant_type" => "authorization_code", "grant_type" => "authorization_code",
"code" => "Imobviouslyinvalid", "code" => "Imobviouslyinvalid",
"redirect_uri" => app.redirect_uris, "redirect_uri" => OAuthController.default_redirect_uri(app),
"client_id" => app.client_id, "client_id" => app.client_id,
"client_secret" => app.client_secret "client_secret" => app.client_secret
}) })