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.OAuthControllerTest do
6 use Pleroma.Web.ConnCase
10 alias Pleroma.Helpers.AuthHelper
12 alias Pleroma.MFA.TOTP
15 alias Pleroma.Web.OAuth.Authorization
16 alias Pleroma.Web.OAuth.OAuthController
17 alias Pleroma.Web.OAuth.Token
22 signing_salt: "cooldude"
25 clear_config([:instance, :account_activation_required])
26 clear_config([:instance, :account_approval_required])
29 describe "in OAuth consumer mode, " do
32 app: insert(:oauth_app),
35 |> Plug.Session.call(Plug.Session.init(@session_opts))
40 setup do: clear_config([:auth, :oauth_consumer_strategies], ~w(twitter facebook))
42 test "GET /oauth/authorize renders auth forms, including OAuth consumer form", %{
51 "response_type" => "code",
52 "client_id" => app.client_id,
53 "redirect_uri" => OAuthController.default_redirect_uri(app),
58 assert response = html_response(conn, 200)
59 assert response =~ "Sign in with Twitter"
60 assert response =~ o_auth_path(conn, :prepare_request)
63 test "GET /oauth/prepare_request encodes parameters as `state` and redirects", %{
70 "/oauth/prepare_request",
72 "provider" => "twitter",
74 "scope" => "read follow",
75 "client_id" => app.client_id,
76 "redirect_uri" => OAuthController.default_redirect_uri(app),
82 assert html_response(conn, 302)
84 redirect_query = URI.parse(redirected_to(conn)).query
85 assert %{"state" => state_param} = URI.decode_query(redirect_query)
86 assert {:ok, state_components} = Jason.decode(state_param)
88 expected_client_id = app.client_id
89 expected_redirect_uri = app.redirect_uris
92 "scope" => "read follow",
93 "client_id" => ^expected_client_id,
94 "redirect_uri" => ^expected_redirect_uri,
99 test "with user-bound registration, GET /oauth/<provider>/callback redirects to `redirect_uri` with `code`",
100 %{app: app, conn: conn} do
101 registration = insert(:registration)
102 redirect_uri = OAuthController.default_redirect_uri(app)
105 "scope" => Enum.join(app.scopes, " "),
106 "client_id" => app.client_id,
107 "redirect_uri" => redirect_uri,
113 |> assign(:ueberauth_auth, %{provider: registration.provider, uid: registration.uid})
115 "/oauth/twitter/callback",
117 "oauth_token" => "G-5a3AAAAAAAwMH9AAABaektfSM",
118 "oauth_verifier" => "QZl8vUqNvXMTKpdmUnGejJxuHG75WWWs",
119 "provider" => "twitter",
120 "state" => Jason.encode!(state_params)
124 assert html_response(conn, 302)
125 assert redirected_to(conn) =~ ~r/#{redirect_uri}\?code=.+/
128 test "with user-unbound registration, GET /oauth/<provider>/callback renders registration_details page",
129 %{app: app, conn: conn} do
133 "scope" => "read write",
134 "client_id" => app.client_id,
135 "redirect_uri" => OAuthController.default_redirect_uri(app),
141 |> assign(:ueberauth_auth, %{
144 info: %{nickname: user.nickname, email: user.email, name: user.name, description: nil}
147 "/oauth/twitter/callback",
149 "oauth_token" => "G-5a3AAAAAAAwMH9AAABaektfSM",
150 "oauth_verifier" => "QZl8vUqNvXMTKpdmUnGejJxuHG75WWWs",
151 "provider" => "twitter",
152 "state" => Jason.encode!(state_params)
156 assert response = html_response(conn, 200)
157 assert response =~ ~r/name="op" type="submit" value="register"/
158 assert response =~ ~r/name="op" type="submit" value="connect"/
159 assert response =~ user.email
160 assert response =~ user.nickname
163 test "on authentication error, GET /oauth/<provider>/callback redirects to `redirect_uri`", %{
168 "scope" => Enum.join(app.scopes, " "),
169 "client_id" => app.client_id,
170 "redirect_uri" => OAuthController.default_redirect_uri(app),
176 |> assign(:ueberauth_failure, %{errors: [%{message: "(error description)"}]})
178 "/oauth/twitter/callback",
180 "oauth_token" => "G-5a3AAAAAAAwMH9AAABaektfSM",
181 "oauth_verifier" => "QZl8vUqNvXMTKpdmUnGejJxuHG75WWWs",
182 "provider" => "twitter",
183 "state" => Jason.encode!(state_params)
187 assert html_response(conn, 302)
188 assert redirected_to(conn) == app.redirect_uris
189 assert get_flash(conn, :error) == "Failed to authenticate: (error description)."
192 test "GET /oauth/registration_details renders registration details form", %{
199 "/oauth/registration_details",
201 "authorization" => %{
202 "scopes" => app.scopes,
203 "client_id" => app.client_id,
204 "redirect_uri" => OAuthController.default_redirect_uri(app),
205 "state" => "a_state",
207 "email" => "john@doe.com"
212 assert response = html_response(conn, 200)
213 assert response =~ ~r/name="op" type="submit" value="register"/
214 assert response =~ ~r/name="op" type="submit" value="connect"/
217 test "with valid params, POST /oauth/register?op=register redirects to `redirect_uri` with `code`",
222 registration = insert(:registration, user: nil, info: %{"nickname" => nil, "email" => nil})
223 redirect_uri = OAuthController.default_redirect_uri(app)
227 |> put_session(:registration_id, registration.id)
232 "authorization" => %{
233 "scopes" => app.scopes,
234 "client_id" => app.client_id,
235 "redirect_uri" => redirect_uri,
236 "state" => "a_state",
237 "nickname" => "availablenick",
238 "email" => "available@email.com"
243 assert html_response(conn, 302)
244 assert redirected_to(conn) =~ ~r/#{redirect_uri}\?code=.+/
247 test "with unlisted `redirect_uri`, POST /oauth/register?op=register results in HTTP 401",
252 registration = insert(:registration, user: nil, info: %{"nickname" => nil, "email" => nil})
253 unlisted_redirect_uri = "http://cross-site-request.com"
257 |> put_session(:registration_id, registration.id)
262 "authorization" => %{
263 "scopes" => app.scopes,
264 "client_id" => app.client_id,
265 "redirect_uri" => unlisted_redirect_uri,
266 "state" => "a_state",
267 "nickname" => "availablenick",
268 "email" => "available@email.com"
273 assert html_response(conn, 401)
276 test "with invalid params, POST /oauth/register?op=register renders registration_details page",
281 another_user = insert(:user)
282 registration = insert(:registration, user: nil, info: %{"nickname" => nil, "email" => nil})
286 "authorization" => %{
287 "scopes" => app.scopes,
288 "client_id" => app.client_id,
289 "redirect_uri" => OAuthController.default_redirect_uri(app),
290 "state" => "a_state",
291 "nickname" => "availablenickname",
292 "email" => "available@email.com"
296 for {bad_param, bad_param_value} <-
297 [{"nickname", another_user.nickname}, {"email", another_user.email}] do
298 bad_registration_attrs = %{
299 "authorization" => Map.put(params["authorization"], bad_param, bad_param_value)
302 bad_params = Map.merge(params, bad_registration_attrs)
306 |> put_session(:registration_id, registration.id)
307 |> post("/oauth/register", bad_params)
309 assert html_response(conn, 403) =~ ~r/name="op" type="submit" value="register"/
310 assert get_flash(conn, :error) == "Error: #{bad_param} has already been taken."
314 test "with valid params, POST /oauth/register?op=connect redirects to `redirect_uri` with `code`",
319 user = insert(:user, password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt("testpassword"))
320 registration = insert(:registration, user: nil)
321 redirect_uri = OAuthController.default_redirect_uri(app)
325 |> put_session(:registration_id, registration.id)
330 "authorization" => %{
331 "scopes" => app.scopes,
332 "client_id" => app.client_id,
333 "redirect_uri" => redirect_uri,
334 "state" => "a_state",
335 "name" => user.nickname,
336 "password" => "testpassword"
341 assert html_response(conn, 302)
342 assert redirected_to(conn) =~ ~r/#{redirect_uri}\?code=.+/
345 test "with unlisted `redirect_uri`, POST /oauth/register?op=connect results in HTTP 401`",
350 user = insert(:user, password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt("testpassword"))
351 registration = insert(:registration, user: nil)
352 unlisted_redirect_uri = "http://cross-site-request.com"
356 |> put_session(:registration_id, registration.id)
361 "authorization" => %{
362 "scopes" => app.scopes,
363 "client_id" => app.client_id,
364 "redirect_uri" => unlisted_redirect_uri,
365 "state" => "a_state",
366 "name" => user.nickname,
367 "password" => "testpassword"
372 assert html_response(conn, 401)
375 test "with invalid params, POST /oauth/register?op=connect renders registration_details page",
381 registration = insert(:registration, user: nil)
385 "authorization" => %{
386 "scopes" => app.scopes,
387 "client_id" => app.client_id,
388 "redirect_uri" => OAuthController.default_redirect_uri(app),
389 "state" => "a_state",
390 "name" => user.nickname,
391 "password" => "wrong password"
397 |> put_session(:registration_id, registration.id)
398 |> post("/oauth/register", params)
400 assert html_response(conn, 401) =~ ~r/name="op" type="submit" value="connect"/
401 assert get_flash(conn, :error) == "Invalid Username/Password"
405 describe "GET /oauth/authorize" do
408 app: insert(:oauth_app, redirect_uris: "https://redirect.url"),
411 |> Plug.Session.call(Plug.Session.init(@session_opts))
416 test "renders authentication page", %{app: app, conn: conn} do
422 "response_type" => "code",
423 "client_id" => app.client_id,
424 "redirect_uri" => OAuthController.default_redirect_uri(app),
429 assert html_response(conn, 200) =~ ~s(type="submit")
432 test "properly handles internal calls with `authorization`-wrapped params", %{
441 "authorization" => %{
442 "response_type" => "code",
443 "client_id" => app.client_id,
444 "redirect_uri" => OAuthController.default_redirect_uri(app),
450 assert html_response(conn, 200) =~ ~s(type="submit")
453 test "renders authentication page if user is already authenticated but `force_login` is tru-ish",
454 %{app: app, conn: conn} do
455 token = insert(:oauth_token, app: app)
459 |> AuthHelper.put_session_token(token.token)
463 "response_type" => "code",
464 "client_id" => app.client_id,
465 "redirect_uri" => OAuthController.default_redirect_uri(app),
467 "force_login" => "true"
471 assert html_response(conn, 200) =~ ~s(type="submit")
474 test "renders authentication page if user is already authenticated but user request with another client",
479 token = insert(:oauth_token, app: app)
483 |> AuthHelper.put_session_token(token.token)
487 "response_type" => "code",
488 "client_id" => "another_client_id",
489 "redirect_uri" => OAuthController.default_redirect_uri(app),
494 assert html_response(conn, 200) =~ ~s(type="submit")
497 test "allows access if the user has a prior authorization but is authenticated with another client",
503 token = insert(:oauth_token, app: app, user: user)
505 other_app = insert(:oauth_app, redirect_uris: "https://other_redirect.url")
506 authorization = insert(:oauth_authorization, user: user, app: other_app)
507 _reusable_token = insert(:oauth_token, app: other_app, user: user)
511 |> AuthHelper.put_session_token(token.token)
512 |> AuthHelper.put_session_user(user.id)
516 "response_type" => "code",
517 "client_id" => other_app.client_id,
518 "redirect_uri" => OAuthController.default_redirect_uri(other_app),
523 assert URI.decode(redirected_to(conn)) ==
524 "https://other_redirect.url?code=#{authorization.token}"
527 test "renders login page if the user has an authorization but no token",
533 token = insert(:oauth_token, app: app, user: user)
535 other_app = insert(:oauth_app, redirect_uris: "https://other_redirect.url")
536 _authorization = insert(:oauth_authorization, user: user, app: other_app)
540 |> AuthHelper.put_session_token(token.token)
541 |> AuthHelper.put_session_user(user.id)
545 "response_type" => "code",
546 "client_id" => other_app.client_id,
547 "redirect_uri" => OAuthController.default_redirect_uri(other_app),
552 assert html_response(conn, 200) =~ ~s(type="submit")
555 test "does not reuse other people's tokens",
561 other_user = insert(:user)
562 token = insert(:oauth_token, app: app, user: user)
564 other_app = insert(:oauth_app, redirect_uris: "https://other_redirect.url")
565 _authorization = insert(:oauth_authorization, user: other_user, app: other_app)
566 _reusable_token = insert(:oauth_token, app: other_app, user: other_user)
570 |> AuthHelper.put_session_token(token.token)
571 |> AuthHelper.put_session_user(user.id)
575 "response_type" => "code",
576 "client_id" => other_app.client_id,
577 "redirect_uri" => OAuthController.default_redirect_uri(other_app),
582 assert html_response(conn, 200) =~ ~s(type="submit")
585 test "does not reuse expired tokens",
591 token = insert(:oauth_token, app: app, user: user)
593 other_app = insert(:oauth_app, redirect_uris: "https://other_redirect.url")
594 _authorization = insert(:oauth_authorization, user: user, app: other_app)
600 valid_until: NaiveDateTime.add(NaiveDateTime.utc_now(), -100)
605 |> AuthHelper.put_session_token(token.token)
606 |> AuthHelper.put_session_user(user.id)
610 "response_type" => "code",
611 "client_id" => other_app.client_id,
612 "redirect_uri" => OAuthController.default_redirect_uri(other_app),
617 assert html_response(conn, 200) =~ ~s(type="submit")
620 test "with existing authentication and non-OOB `redirect_uri`, redirects to app with `token` and `state` params",
625 token = insert(:oauth_token, app: app)
629 |> AuthHelper.put_session_token(token.token)
633 "response_type" => "code",
634 "client_id" => app.client_id,
635 "redirect_uri" => OAuthController.default_redirect_uri(app),
636 "state" => "specific_client_state",
641 assert URI.decode(redirected_to(conn)) ==
642 "https://redirect.url?access_token=#{token.token}&state=specific_client_state"
645 test "with existing authentication and unlisted non-OOB `redirect_uri`, redirects without credentials",
650 unlisted_redirect_uri = "http://cross-site-request.com"
651 token = insert(:oauth_token, app: app)
655 |> AuthHelper.put_session_token(token.token)
659 "response_type" => "code",
660 "client_id" => app.client_id,
661 "redirect_uri" => unlisted_redirect_uri,
662 "state" => "specific_client_state",
667 assert redirected_to(conn) == unlisted_redirect_uri
670 test "with existing authentication and OOB `redirect_uri`, redirects to app with `token` and `state` params",
675 token = insert(:oauth_token, app: app)
679 |> AuthHelper.put_session_token(token.token)
683 "response_type" => "code",
684 "client_id" => app.client_id,
685 "redirect_uri" => "urn:ietf:wg:oauth:2.0:oob",
690 assert html_response(conn, 200) =~ "Authorization exists"
694 describe "POST /oauth/authorize" do
695 test "redirects with oauth authorization, " <>
696 "granting requested app-supported scopes to both admin users" do
697 app_scopes = ["read", "write", "admin", "secret_scope"]
698 app = insert(:oauth_app, scopes: app_scopes)
699 redirect_uri = OAuthController.default_redirect_uri(app)
700 scopes_subset = ["read:subscope", "write", "admin"]
701 admin = insert(:user, is_admin: true)
703 # In case scope param is missing, expecting _all_ app-supported scopes to be granted
709 "authorization" => %{
710 "name" => admin.nickname,
711 "password" => "test",
712 "client_id" => app.client_id,
713 "redirect_uri" => redirect_uri,
714 "scope" => scopes_subset,
715 "state" => "statepassed"
720 target = redirected_to(conn)
721 assert target =~ redirect_uri
723 query = URI.parse(target).query |> URI.query_decoder() |> Map.new()
725 assert %{"state" => "statepassed", "code" => code} = query
726 auth = Repo.get_by(Authorization, token: code)
728 assert auth.scopes == scopes_subset
731 test "redirects with oauth authorization, " <>
732 "granting requested app-supported scopes for non-admin users" do
733 app_scopes = ["read", "write", "secret_scope", "admin"]
734 app = insert(:oauth_app, scopes: app_scopes)
735 redirect_uri = OAuthController.default_redirect_uri(app)
737 non_admin = insert(:user, is_admin: false)
738 scopes_subset = ["read:subscope", "write"]
740 # In case scope param is missing, expecting _all_ app-supported scopes to be granted
746 "authorization" => %{
747 "name" => non_admin.nickname,
748 "password" => "test",
749 "client_id" => app.client_id,
750 "redirect_uri" => redirect_uri,
751 "scope" => scopes_subset,
752 "state" => "statepassed"
757 target = redirected_to(conn)
758 assert target =~ redirect_uri
760 query = URI.parse(target).query |> URI.query_decoder() |> Map.new()
762 assert %{"state" => "statepassed", "code" => code} = query
763 auth = Repo.get_by(Authorization, token: code)
765 assert auth.scopes == scopes_subset
768 test "authorize from cookie" do
770 app = insert(:oauth_app)
771 oauth_token = insert(:oauth_token, user: user, app: app)
772 redirect_uri = OAuthController.default_redirect_uri(app)
777 |> Plug.Session.call(Plug.Session.init(@session_opts))
779 |> AuthHelper.put_session_token(oauth_token.token)
783 "authorization" => %{
784 "name" => user.nickname,
785 "client_id" => app.client_id,
786 "redirect_uri" => redirect_uri,
787 "scope" => app.scopes,
788 "state" => "statepassed"
793 target = redirected_to(conn)
794 assert target =~ redirect_uri
796 query = URI.parse(target).query |> URI.query_decoder() |> Map.new()
798 assert %{"state" => "statepassed", "code" => code} = query
799 auth = Repo.get_by(Authorization, token: code)
801 assert auth.scopes == app.scopes
804 test "redirect to on two-factor auth page" do
805 otp_secret = TOTP.generate_secret()
809 multi_factor_authentication_settings: %MFA.Settings{
811 totp: %MFA.Settings.TOTP{secret: otp_secret, confirmed: true}
815 app = insert(:oauth_app, scopes: ["read", "write", "follow"])
819 |> post("/oauth/authorize", %{
820 "authorization" => %{
821 "name" => user.nickname,
822 "password" => "test",
823 "client_id" => app.client_id,
824 "redirect_uri" => app.redirect_uris,
825 "scope" => "read write",
826 "state" => "statepassed"
830 result = html_response(conn, 200)
832 mfa_token = Repo.get_by(MFA.Token, user_id: user.id)
833 assert result =~ app.redirect_uris
834 assert result =~ "statepassed"
835 assert result =~ mfa_token.token
836 assert result =~ "Two-factor authentication"
839 test "returns 401 for wrong credentials", %{conn: conn} do
841 app = insert(:oauth_app)
842 redirect_uri = OAuthController.default_redirect_uri(app)
846 |> post("/oauth/authorize", %{
847 "authorization" => %{
848 "name" => user.nickname,
849 "password" => "wrong",
850 "client_id" => app.client_id,
851 "redirect_uri" => redirect_uri,
852 "state" => "statepassed",
853 "scope" => Enum.join(app.scopes, " ")
856 |> html_response(:unauthorized)
859 assert result =~ app.client_id
860 assert result =~ redirect_uri
863 assert result =~ "Invalid Username/Password"
866 test "returns 401 when attempting to use an admin scope with a non-admin", %{conn: conn} do
868 app = insert(:oauth_app, scopes: ["admin"])
869 redirect_uri = OAuthController.default_redirect_uri(app)
873 |> post("/oauth/authorize", %{
874 "authorization" => %{
875 "name" => user.nickname,
876 "password" => "test",
877 "client_id" => app.client_id,
878 "redirect_uri" => redirect_uri,
879 "state" => "statepassed",
880 "scope" => Enum.join(app.scopes, " ")
883 |> html_response(:unauthorized)
886 assert result =~ app.client_id
887 assert result =~ redirect_uri
890 assert result =~ "outside of authorized scopes"
893 test "returns 401 for missing scopes" do
894 user = insert(:user, is_admin: false)
895 app = insert(:oauth_app, scopes: ["read", "write", "admin"])
896 redirect_uri = OAuthController.default_redirect_uri(app)
900 |> post("/oauth/authorize", %{
901 "authorization" => %{
902 "name" => user.nickname,
903 "password" => "test",
904 "client_id" => app.client_id,
905 "redirect_uri" => redirect_uri,
906 "state" => "statepassed",
910 |> html_response(:unauthorized)
913 assert result =~ app.client_id
914 assert result =~ redirect_uri
917 assert result =~ "This action is outside of authorized scopes"
920 test "returns 401 for scopes beyond app scopes hierarchy", %{conn: conn} do
922 app = insert(:oauth_app, scopes: ["read", "write"])
923 redirect_uri = OAuthController.default_redirect_uri(app)
927 |> post("/oauth/authorize", %{
928 "authorization" => %{
929 "name" => user.nickname,
930 "password" => "test",
931 "client_id" => app.client_id,
932 "redirect_uri" => redirect_uri,
933 "state" => "statepassed",
934 "scope" => "read write follow"
937 |> html_response(:unauthorized)
940 assert result =~ app.client_id
941 assert result =~ redirect_uri
944 assert result =~ "This action is outside of authorized scopes"
948 describe "POST /oauth/token" do
949 test "issues a token for an all-body request" do
951 app = insert(:oauth_app, scopes: ["read", "write"])
953 {:ok, auth} = Authorization.create_authorization(app, user, ["write"])
957 |> post("/oauth/token", %{
958 "grant_type" => "authorization_code",
959 "code" => auth.token,
960 "redirect_uri" => OAuthController.default_redirect_uri(app),
961 "client_id" => app.client_id,
962 "client_secret" => app.client_secret
965 assert %{"access_token" => token, "me" => ap_id} = json_response(conn, 200)
967 token = Repo.get_by(Token, token: token)
969 assert token.scopes == auth.scopes
970 assert user.ap_id == ap_id
973 test "issues a token for `password` grant_type with valid credentials, with full permissions by default" do
974 password = "testpassword"
975 user = insert(:user, password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt(password))
977 app = insert(:oauth_app, scopes: ["read", "write"])
979 # Note: "scope" param is intentionally omitted
982 |> post("/oauth/token", %{
983 "grant_type" => "password",
984 "username" => user.nickname,
985 "password" => password,
986 "client_id" => app.client_id,
987 "client_secret" => app.client_secret
990 assert %{"id" => id, "access_token" => access_token} = json_response(conn, 200)
992 token = Repo.get_by(Token, token: access_token)
994 assert token.id == id
995 assert token.token == access_token
996 assert token.scopes == app.scopes
999 test "issues a mfa token for `password` grant_type, when MFA enabled" do
1000 password = "testpassword"
1001 otp_secret = TOTP.generate_secret()
1005 password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt(password),
1006 multi_factor_authentication_settings: %MFA.Settings{
1008 totp: %MFA.Settings.TOTP{secret: otp_secret, confirmed: true}
1012 app = insert(:oauth_app, scopes: ["read", "write"])
1016 |> post("/oauth/token", %{
1017 "grant_type" => "password",
1018 "username" => user.nickname,
1019 "password" => password,
1020 "client_id" => app.client_id,
1021 "client_secret" => app.client_secret
1023 |> json_response(403)
1027 "supported_challenge_types" => "totp",
1029 "error" => "mfa_required"
1034 token = Repo.get_by(MFA.Token, token: response["mfa_token"])
1035 assert token.user_id == user.id
1036 assert token.authorization_id
1039 test "issues a token for request with HTTP basic auth client credentials" do
1040 user = insert(:user)
1041 app = insert(:oauth_app, scopes: ["scope1", "scope2", "scope3"])
1043 {:ok, auth} = Authorization.create_authorization(app, user, ["scope1", "scope2"])
1044 assert auth.scopes == ["scope1", "scope2"]
1047 (URI.encode_www_form(app.client_id) <> ":" <> URI.encode_www_form(app.client_secret))
1052 |> put_req_header("authorization", "Basic " <> app_encoded)
1053 |> post("/oauth/token", %{
1054 "grant_type" => "authorization_code",
1055 "code" => auth.token,
1056 "redirect_uri" => OAuthController.default_redirect_uri(app)
1059 assert %{"access_token" => token, "scope" => scope} = json_response(conn, 200)
1061 assert scope == "scope1 scope2"
1063 token = Repo.get_by(Token, token: token)
1065 assert token.scopes == ["scope1", "scope2"]
1068 test "issue a token for client_credentials grant type" do
1069 app = insert(:oauth_app, scopes: ["read", "write"])
1073 |> post("/oauth/token", %{
1074 "grant_type" => "client_credentials",
1075 "client_id" => app.client_id,
1076 "client_secret" => app.client_secret
1079 assert %{"access_token" => token, "refresh_token" => refresh, "scope" => scope} =
1080 json_response(conn, 200)
1083 token_from_db = Repo.get_by(Token, token: token)
1084 assert token_from_db
1086 assert scope == "read write"
1089 test "rejects token exchange with invalid client credentials" do
1090 user = insert(:user)
1091 app = insert(:oauth_app)
1093 {:ok, auth} = Authorization.create_authorization(app, user)
1097 |> put_req_header("authorization", "Basic JTIxOiVGMCU5RiVBNCVCNwo=")
1098 |> post("/oauth/token", %{
1099 "grant_type" => "authorization_code",
1100 "code" => auth.token,
1101 "redirect_uri" => OAuthController.default_redirect_uri(app)
1104 assert resp = json_response(conn, 400)
1105 assert %{"error" => _} = resp
1106 refute Map.has_key?(resp, "access_token")
1109 test "rejects token exchange for valid credentials belonging to unconfirmed user and confirmation is required" do
1110 clear_config([:instance, :account_activation_required], true)
1111 password = "testpassword"
1114 insert(:user, password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt(password))
1115 |> User.confirmation_changeset(set_confirmation: false)
1116 |> User.update_and_set_cache()
1118 refute Pleroma.User.account_status(user) == :active
1120 app = insert(:oauth_app)
1124 |> post("/oauth/token", %{
1125 "grant_type" => "password",
1126 "username" => user.nickname,
1127 "password" => password,
1128 "client_id" => app.client_id,
1129 "client_secret" => app.client_secret
1132 assert resp = json_response(conn, 403)
1133 assert %{"error" => _} = resp
1134 refute Map.has_key?(resp, "access_token")
1137 test "rejects token exchange for valid credentials belonging to deactivated user" do
1138 password = "testpassword"
1142 password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt(password),
1146 app = insert(:oauth_app)
1150 |> post("/oauth/token", %{
1151 "grant_type" => "password",
1152 "username" => user.nickname,
1153 "password" => password,
1154 "client_id" => app.client_id,
1155 "client_secret" => app.client_secret
1157 |> json_response(403)
1160 "error" => "Your account is currently disabled",
1161 "identifier" => "account_is_disabled"
1165 test "rejects token exchange for user with password_reset_pending set to true" do
1166 password = "testpassword"
1170 password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt(password),
1171 password_reset_pending: true
1174 app = insert(:oauth_app, scopes: ["read", "write"])
1178 |> post("/oauth/token", %{
1179 "grant_type" => "password",
1180 "username" => user.nickname,
1181 "password" => password,
1182 "client_id" => app.client_id,
1183 "client_secret" => app.client_secret
1185 |> json_response(403)
1188 "error" => "Password reset is required",
1189 "identifier" => "password_reset_required"
1193 test "rejects token exchange for user with confirmation_pending set to true" do
1194 clear_config([:instance, :account_activation_required], true)
1195 password = "testpassword"
1199 password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt(password),
1203 app = insert(:oauth_app, scopes: ["read", "write"])
1207 |> post("/oauth/token", %{
1208 "grant_type" => "password",
1209 "username" => user.nickname,
1210 "password" => password,
1211 "client_id" => app.client_id,
1212 "client_secret" => app.client_secret
1214 |> json_response(403)
1217 "error" => "Your login is missing a confirmed e-mail address",
1218 "identifier" => "missing_confirmed_email"
1222 test "rejects token exchange for valid credentials belonging to an unapproved user" do
1223 password = "testpassword"
1227 password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt(password),
1231 refute Pleroma.User.account_status(user) == :active
1233 app = insert(:oauth_app)
1237 |> post("/oauth/token", %{
1238 "grant_type" => "password",
1239 "username" => user.nickname,
1240 "password" => password,
1241 "client_id" => app.client_id,
1242 "client_secret" => app.client_secret
1245 assert resp = json_response(conn, 403)
1246 assert %{"error" => _} = resp
1247 refute Map.has_key?(resp, "access_token")
1250 test "rejects an invalid authorization code" do
1251 app = insert(:oauth_app)
1255 |> post("/oauth/token", %{
1256 "grant_type" => "authorization_code",
1257 "code" => "Imobviouslyinvalid",
1258 "redirect_uri" => OAuthController.default_redirect_uri(app),
1259 "client_id" => app.client_id,
1260 "client_secret" => app.client_secret
1263 assert resp = json_response(conn, 400)
1264 assert %{"error" => _} = json_response(conn, 400)
1265 refute Map.has_key?(resp, "access_token")
1269 describe "POST /oauth/token - refresh token" do
1270 setup do: clear_config([:oauth2, :issue_new_refresh_token])
1272 test "issues a new access token with keep fresh token" do
1273 clear_config([:oauth2, :issue_new_refresh_token], true)
1274 user = insert(:user)
1275 app = insert(:oauth_app, scopes: ["read", "write"])
1277 {:ok, auth} = Authorization.create_authorization(app, user, ["write"])
1278 {:ok, token} = Token.exchange_token(app, auth)
1282 |> post("/oauth/token", %{
1283 "grant_type" => "refresh_token",
1284 "refresh_token" => token.refresh_token,
1285 "client_id" => app.client_id,
1286 "client_secret" => app.client_secret
1288 |> json_response(200)
1295 "token_type" => "Bearer",
1296 "access_token" => _,
1297 "refresh_token" => _,
1303 refute Repo.get_by(Token, token: token.token)
1304 new_token = Repo.get_by(Token, token: response["access_token"])
1305 assert new_token.refresh_token == token.refresh_token
1306 assert new_token.scopes == auth.scopes
1307 assert new_token.user_id == user.id
1308 assert new_token.app_id == app.id
1311 test "issues a new access token with new fresh token" do
1312 clear_config([:oauth2, :issue_new_refresh_token], false)
1313 user = insert(:user)
1314 app = insert(:oauth_app, scopes: ["read", "write"])
1316 {:ok, auth} = Authorization.create_authorization(app, user, ["write"])
1317 {:ok, token} = Token.exchange_token(app, auth)
1321 |> post("/oauth/token", %{
1322 "grant_type" => "refresh_token",
1323 "refresh_token" => token.refresh_token,
1324 "client_id" => app.client_id,
1325 "client_secret" => app.client_secret
1327 |> json_response(200)
1334 "token_type" => "Bearer",
1335 "access_token" => _,
1336 "refresh_token" => _,
1342 refute Repo.get_by(Token, token: token.token)
1343 new_token = Repo.get_by(Token, token: response["access_token"])
1344 refute new_token.refresh_token == token.refresh_token
1345 assert new_token.scopes == auth.scopes
1346 assert new_token.user_id == user.id
1347 assert new_token.app_id == app.id
1350 test "returns 400 if we try use access token" do
1351 user = insert(:user)
1352 app = insert(:oauth_app, scopes: ["read", "write"])
1354 {:ok, auth} = Authorization.create_authorization(app, user, ["write"])
1355 {:ok, token} = Token.exchange_token(app, auth)
1359 |> post("/oauth/token", %{
1360 "grant_type" => "refresh_token",
1361 "refresh_token" => token.token,
1362 "client_id" => app.client_id,
1363 "client_secret" => app.client_secret
1365 |> json_response(400)
1367 assert %{"error" => "Invalid credentials"} == response
1370 test "returns 400 if refresh_token invalid" do
1371 app = insert(:oauth_app, scopes: ["read", "write"])
1375 |> post("/oauth/token", %{
1376 "grant_type" => "refresh_token",
1377 "refresh_token" => "token.refresh_token",
1378 "client_id" => app.client_id,
1379 "client_secret" => app.client_secret
1381 |> json_response(400)
1383 assert %{"error" => "Invalid credentials"} == response
1386 test "issues a new token if token expired" do
1387 user = insert(:user)
1388 app = insert(:oauth_app, scopes: ["read", "write"])
1390 {:ok, auth} = Authorization.create_authorization(app, user, ["write"])
1391 {:ok, token} = Token.exchange_token(app, auth)
1394 Ecto.Changeset.change(
1396 %{valid_until: NaiveDateTime.add(NaiveDateTime.utc_now(), -86_400 * 30)}
1399 {:ok, access_token} = Repo.update(change)
1403 |> post("/oauth/token", %{
1404 "grant_type" => "refresh_token",
1405 "refresh_token" => access_token.refresh_token,
1406 "client_id" => app.client_id,
1407 "client_secret" => app.client_secret
1409 |> json_response(200)
1416 "token_type" => "Bearer",
1417 "access_token" => _,
1418 "refresh_token" => _,
1424 refute Repo.get_by(Token, token: token.token)
1425 token = Repo.get_by(Token, token: response["access_token"])
1427 assert token.scopes == auth.scopes
1428 assert token.user_id == user.id
1429 assert token.app_id == app.id
1433 describe "POST /oauth/token - bad request" do
1434 test "returns 500" do
1437 |> post("/oauth/token", %{})
1438 |> json_response(500)
1440 assert %{"error" => "Bad request"} == response
1444 describe "POST /oauth/revoke" do
1445 test "when authenticated with request token, revokes it and clears it from session" do
1446 oauth_token = insert(:oauth_token)
1450 |> Plug.Session.call(Plug.Session.init(@session_opts))
1452 |> AuthHelper.put_session_token(oauth_token.token)
1453 |> post("/oauth/revoke", %{"token" => oauth_token.token})
1455 assert json_response(conn, 200)
1457 refute AuthHelper.get_session_token(conn)
1458 assert Token.get_by_token(oauth_token.token) == {:error, :not_found}
1461 test "if request is authenticated with a different token, " <>
1462 "revokes requested token but keeps session token" do
1463 user = insert(:user)
1464 oauth_token = insert(:oauth_token, user: user)
1465 other_app_oauth_token = insert(:oauth_token, user: user)
1469 |> Plug.Session.call(Plug.Session.init(@session_opts))
1471 |> AuthHelper.put_session_token(oauth_token.token)
1472 |> post("/oauth/revoke", %{"token" => other_app_oauth_token.token})
1474 assert json_response(conn, 200)
1476 assert AuthHelper.get_session_token(conn) == oauth_token.token
1477 assert Token.get_by_token(other_app_oauth_token.token) == {:error, :not_found}
1480 test "returns 500 on bad request" do
1483 |> post("/oauth/revoke", %{})
1484 |> json_response(500)
1486 assert %{"error" => "Bad request"} == response