Merge branch 'develop' into 'remove-twitter-api'
[akkoma] / test / plugs / authentication_plug_test.exs
index fd58d6ab470455caf9c1a5b5c1edec44853dad77..c8ede71c036b9de971b8600a96712aaa77755dff 100644 (file)
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
 defmodule Pleroma.Plugs.AuthenticationPlugTest do
   use Pleroma.Web.ConnCase, async: true
 
   alias Pleroma.Plugs.AuthenticationPlug
+  alias Pleroma.Plugs.OAuthScopesPlug
+  alias Pleroma.Plugs.PlugHelper
   alias Pleroma.User
 
-  defp fetch_nil(_name) do
-    {:ok, nil}
-  end
+  import ExUnit.CaptureLog
 
-  @user %User{
-    id: 1,
-    name: "dude",
-    password_hash: Comeonin.Pbkdf2.hashpwsalt("guy")
-  }
-
-  @deactivated %User{
-    id: 1,
-    name: "dude",
-    password_hash: Comeonin.Pbkdf2.hashpwsalt("guy"),
-    info: %{"deactivated" => true}
-  }
-
-  @legacy %User{
-    id: 1,
-    name: "dude",
-    password_hash:
-      "$6$9psBWV8gxkGOZWBz$PmfCycChoxeJ3GgGzwvhlgacb9mUoZ.KUXNCssekER4SJ7bOK53uXrHNb2e4i8yPFgSKyzaW9CcmrDXWIEMtD1"
-  }
-
-  @session_opts [
-    store: :cookie,
-    key: "_test",
-    signing_salt: "cooldude"
-  ]
-
-  defp fetch_user(_name) do
-    {:ok, @user}
-  end
+  setup %{conn: conn} do
+    user = %User{
+      id: 1,
+      name: "dude",
+      password_hash: Pbkdf2.hash_pwd_salt("guy")
+    }
 
-  defp basic_auth_enc(username, password) do
-    "Basic " <> Base.encode64("#{username}:#{password}")
-  end
-
-  describe "without an authorization header" do
-    test "it halts the application" do
-      conn =
-        build_conn()
-        |> Plug.Session.call(Plug.Session.init(@session_opts))
-        |> fetch_session
-        |> AuthenticationPlug.call(%{})
-
-      assert conn.status == 403
-      assert conn.halted == true
-    end
+    conn =
+      conn
+      |> assign(:auth_user, user)
 
-    test "it assigns a nil user if the 'optional' option is used" do
-      conn =
-        build_conn()
-        |> Plug.Session.call(Plug.Session.init(@session_opts))
-        |> fetch_session
-        |> AuthenticationPlug.call(%{optional: true})
-
-      assert %{user: nil} == conn.assigns
-    end
+    %{user: user, conn: conn}
   end
 
-  describe "with an authorization header for a nonexisting user" do
-    test "it halts the application" do
-      conn =
-        build_conn()
-        |> Plug.Session.call(Plug.Session.init(@session_opts))
-        |> fetch_session
-        |> AuthenticationPlug.call(%{fetcher: &fetch_nil/1})
-
-      assert conn.status == 403
-      assert conn.halted == true
-    end
+  test "it does nothing if a user is assigned", %{conn: conn} do
+    conn =
+      conn
+      |> assign(:user, %User{})
 
-    test "it assigns a nil user if the 'optional' option is used" do
-      conn =
-        build_conn()
-        |> Plug.Session.call(Plug.Session.init(@session_opts))
-        |> fetch_session
-        |> AuthenticationPlug.call(%{optional: true, fetcher: &fetch_nil/1})
+    ret_conn =
+      conn
+      |> AuthenticationPlug.call(%{})
 
-      assert %{user: nil} == conn.assigns
-    end
+    assert ret_conn == conn
   end
 
-  describe "with an incorrect authorization header for a enxisting user" do
-    test "it halts the application" do
-      opts = %{
-        fetcher: &fetch_user/1
-      }
-
-      header = basic_auth_enc("dude", "man")
+  test "with a correct password in the credentials, " <>
+         "it assigns the auth_user and marks OAuthScopesPlug as skipped",
+       %{conn: conn} do
+    conn =
+      conn
+      |> assign(:auth_credentials, %{password: "guy"})
+      |> AuthenticationPlug.call(%{})
 
-      conn =
-        build_conn()
-        |> Plug.Session.call(Plug.Session.init(@session_opts))
-        |> fetch_session
-        |> put_req_header("authorization", header)
-        |> AuthenticationPlug.call(opts)
-
-      assert conn.status == 403
-      assert conn.halted == true
-    end
-
-    test "it assigns a nil user if the 'optional' option is used" do
-      opts = %{
-        optional: true,
-        fetcher: &fetch_user/1
-      }
+    assert conn.assigns.user == conn.assigns.auth_user
+    assert PlugHelper.plug_skipped?(conn, OAuthScopesPlug)
+  end
 
-      header = basic_auth_enc("dude", "man")
+  test "with a wrong password in the credentials, it does nothing", %{conn: conn} do
+    conn =
+      conn
+      |> assign(:auth_credentials, %{password: "wrong"})
 
-      conn =
-        build_conn()
-        |> Plug.Session.call(Plug.Session.init(@session_opts))
-        |> fetch_session
-        |> put_req_header("authorization", header)
-        |> AuthenticationPlug.call(opts)
+    ret_conn =
+      conn
+      |> AuthenticationPlug.call(%{})
 
-      assert %{user: nil} == conn.assigns
-    end
+    assert conn == ret_conn
   end
 
-  describe "with a correct authorization header for an existing user" do
-    test "it assigns the user", %{conn: conn} do
-      opts = %{
-        optional: true,
-        fetcher: &fetch_user/1
-      }
-
-      header = basic_auth_enc("dude", "guy")
-
-      conn =
-        conn
-        |> Plug.Session.call(Plug.Session.init(@session_opts))
-        |> fetch_session
-        |> put_req_header("authorization", header)
-        |> AuthenticationPlug.call(opts)
-
-      assert %{user: @user} == conn.assigns
-      assert get_session(conn, :user_id) == @user.id
-      assert conn.halted == false
-    end
+  describe "checkpw/2" do
+    test "check pbkdf2 hash" do
+      hash =
+        "$pbkdf2-sha512$160000$loXqbp8GYls43F0i6lEfIw$AY.Ep.2pGe57j2hAPY635sI/6w7l9Q9u9Bp02PkPmF3OrClDtJAI8bCiivPr53OKMF7ph6iHhN68Rom5nEfC2A"
 
-    test "it assigns legacy user", %{conn: conn} do
-      opts = %{
-        optional: true,
-        fetcher: fn _ -> {:ok, @legacy} end,
-        update_legacy_password: false
-      }
-
-      header = basic_auth_enc("dude", "password")
-
-      conn =
-        conn
-        |> Plug.Session.call(Plug.Session.init(@session_opts))
-        |> fetch_session
-        |> put_req_header("authorization", header)
-        |> AuthenticationPlug.call(opts)
-
-      assert %{user: @legacy} == conn.assigns
-      assert get_session(conn, :user_id) == @legacy.id
-      assert conn.halted == false
+      assert AuthenticationPlug.checkpw("test-password", hash)
+      refute AuthenticationPlug.checkpw("test-password1", hash)
     end
-  end
 
-  describe "with a correct authorization header for an deactiviated user" do
-    test "it halts the appication", %{conn: conn} do
-      opts = %{
-        optional: false,
-        fetcher: fn _ -> @deactivated end
-      }
+    @tag :skip_on_mac
+    test "check sha512-crypt hash" do
+      hash =
+        "$6$9psBWV8gxkGOZWBz$PmfCycChoxeJ3GgGzwvhlgacb9mUoZ.KUXNCssekER4SJ7bOK53uXrHNb2e4i8yPFgSKyzaW9CcmrDXWIEMtD1"
 
-      header = basic_auth_enc("dude", "guy")
-
-      conn =
-        conn
-        |> Plug.Session.call(Plug.Session.init(@session_opts))
-        |> fetch_session
-        |> put_req_header("authorization", header)
-        |> AuthenticationPlug.call(opts)
-
-      assert conn.status == 403
-      assert conn.halted == true
+      assert AuthenticationPlug.checkpw("password", hash)
     end
-  end
 
-  describe "with a user_id in the session for an existing user" do
-    test "it assigns the user", %{conn: conn} do
-      opts = %{
-        optional: true,
-        fetcher: &fetch_user/1
-      }
-
-      header = basic_auth_enc("dude", "THIS IS WRONG")
-
-      conn =
-        conn
-        |> Plug.Session.call(Plug.Session.init(@session_opts))
-        |> fetch_session
-        |> put_session(:user_id, @user.id)
-        |> put_req_header("authorization", header)
-        |> AuthenticationPlug.call(opts)
-
-      assert %{user: @user} == conn.assigns
-      assert get_session(conn, :user_id) == @user.id
-      assert conn.halted == false
-    end
-  end
+    test "check bcrypt hash" do
+      hash = "$2a$10$uyhC/R/zoE1ndwwCtMusK.TLVzkQ/Ugsbqp3uXI.CTTz0gBw.24jS"
 
-  describe "with an assigned user" do
-    test "it does nothing, returning the incoming conn", %{conn: conn} do
-      conn =
-        conn
-        |> assign(:user, @user)
+      assert AuthenticationPlug.checkpw("password", hash)
+      refute AuthenticationPlug.checkpw("password1", hash)
+    end
 
-      conn_result = AuthenticationPlug.call(conn, %{})
+    test "it returns false when hash invalid" do
+      hash =
+        "psBWV8gxkGOZWBz$PmfCycChoxeJ3GgGzwvhlgacb9mUoZ.KUXNCssekER4SJ7bOK53uXrHNb2e4i8yPFgSKyzaW9CcmrDXWIEMtD1"
 
-      assert conn == conn_result
+      assert capture_log(fn ->
+               refute Pleroma.Plugs.AuthenticationPlug.checkpw("password", hash)
+             end) =~ "[error] Password hash not recognized"
     end
   end
 end