added tests for Web.MediaProxy
This commit is contained in:
parent
4b78622bba
commit
fa17879c20
|
@ -3,68 +3,71 @@
|
||||||
# SPDX-License-Identifier: AGPL-3.0-only
|
# SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
|
||||||
defmodule Pleroma.Web.MediaProxy do
|
defmodule Pleroma.Web.MediaProxy do
|
||||||
|
alias Pleroma.Config
|
||||||
|
alias Pleroma.Web
|
||||||
|
|
||||||
@base64_opts [padding: false]
|
@base64_opts [padding: false]
|
||||||
|
|
||||||
def url(nil), do: nil
|
def url(url) when is_nil(url) or url == "", do: nil
|
||||||
|
|
||||||
def url(""), do: nil
|
|
||||||
|
|
||||||
def url("/" <> _ = url), do: url
|
def url("/" <> _ = url), do: url
|
||||||
|
|
||||||
def url(url) do
|
def url(url) do
|
||||||
if !enabled?() or local?(url) or whitelisted?(url) do
|
if disabled?() or local?(url) or whitelisted?(url) do
|
||||||
url
|
url
|
||||||
else
|
else
|
||||||
encode_url(url)
|
encode_url(url)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp enabled?, do: Pleroma.Config.get([:media_proxy, :enabled], false)
|
defp disabled?, do: !Config.get([:media_proxy, :enabled], false)
|
||||||
|
|
||||||
defp local?(url), do: String.starts_with?(url, Pleroma.Web.base_url())
|
defp local?(url), do: String.starts_with?(url, Pleroma.Web.base_url())
|
||||||
|
|
||||||
defp whitelisted?(url) do
|
defp whitelisted?(url) do
|
||||||
%{host: domain} = URI.parse(url)
|
%{host: domain} = URI.parse(url)
|
||||||
|
|
||||||
Enum.any?(Pleroma.Config.get([:media_proxy, :whitelist]), fn pattern ->
|
Enum.any?(Config.get([:media_proxy, :whitelist]), fn pattern ->
|
||||||
String.equivalent?(domain, pattern)
|
String.equivalent?(domain, pattern)
|
||||||
end)
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
def encode_url(url) do
|
def encode_url(url) do
|
||||||
secret = Pleroma.Config.get([Pleroma.Web.Endpoint, :secret_key_base])
|
|
||||||
base64 = Base.url_encode64(url, @base64_opts)
|
base64 = Base.url_encode64(url, @base64_opts)
|
||||||
sig = :crypto.hmac(:sha, secret, base64)
|
|
||||||
sig64 = sig |> Base.url_encode64(@base64_opts)
|
sig64 =
|
||||||
|
base64
|
||||||
|
|> signed_url
|
||||||
|
|> Base.url_encode64(@base64_opts)
|
||||||
|
|
||||||
build_url(sig64, base64, filename(url))
|
build_url(sig64, base64, filename(url))
|
||||||
end
|
end
|
||||||
|
|
||||||
def decode_url(sig, url) do
|
def decode_url(sig, url) do
|
||||||
secret = Pleroma.Config.get([Pleroma.Web.Endpoint, :secret_key_base])
|
with {:ok, sig} <- Base.url_decode64(sig, @base64_opts),
|
||||||
sig = Base.url_decode64!(sig, @base64_opts)
|
signature when signature == sig <- signed_url(url) do
|
||||||
local_sig = :crypto.hmac(:sha, secret, url)
|
|
||||||
|
|
||||||
if local_sig == sig do
|
|
||||||
{:ok, Base.url_decode64!(url, @base64_opts)}
|
{:ok, Base.url_decode64!(url, @base64_opts)}
|
||||||
else
|
else
|
||||||
{:error, :invalid_signature}
|
_ -> {:error, :invalid_signature}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp signed_url(url) do
|
||||||
|
:crypto.hmac(:sha, Config.get([Web.Endpoint, :secret_key_base]), url)
|
||||||
|
end
|
||||||
|
|
||||||
def filename(url_or_path) do
|
def filename(url_or_path) do
|
||||||
if path = URI.parse(url_or_path).path, do: Path.basename(path)
|
if path = URI.parse(url_or_path).path, do: Path.basename(path)
|
||||||
end
|
end
|
||||||
|
|
||||||
def build_url(sig_base64, url_base64, filename \\ nil) do
|
def build_url(sig_base64, url_base64, filename \\ nil) do
|
||||||
[
|
[
|
||||||
Pleroma.Config.get([:media_proxy, :base_url], Pleroma.Web.base_url()),
|
Pleroma.Config.get([:media_proxy, :base_url], Web.base_url()),
|
||||||
"proxy",
|
"proxy",
|
||||||
sig_base64,
|
sig_base64,
|
||||||
url_base64,
|
url_base64,
|
||||||
filename
|
filename
|
||||||
]
|
]
|
||||||
|> Enum.filter(fn value -> value end)
|
|> Enum.filter(& &1)
|
||||||
|> Path.join()
|
|> Path.join()
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
@ -13,7 +13,7 @@ def remote(conn, %{"sig" => sig64, "url" => url64} = params) do
|
||||||
with config <- Pleroma.Config.get([:media_proxy], []),
|
with config <- Pleroma.Config.get([:media_proxy], []),
|
||||||
true <- Keyword.get(config, :enabled, false),
|
true <- Keyword.get(config, :enabled, false),
|
||||||
{:ok, url} <- MediaProxy.decode_url(sig64, url64),
|
{:ok, url} <- MediaProxy.decode_url(sig64, url64),
|
||||||
:ok <- filename_matches(Map.has_key?(params, "filename"), conn.request_path, url) do
|
:ok <- filename_matches(params, conn.request_path, url) do
|
||||||
ReverseProxy.call(conn, url, Keyword.get(config, :proxy_opts, @default_proxy_opts))
|
ReverseProxy.call(conn, url, Keyword.get(config, :proxy_opts, @default_proxy_opts))
|
||||||
else
|
else
|
||||||
false ->
|
false ->
|
||||||
|
@ -27,13 +27,15 @@ def remote(conn, %{"sig" => sig64, "url" => url64} = params) do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def filename_matches(has_filename, path, url) do
|
def filename_matches(%{"filename" => _} = _, path, url) do
|
||||||
filename = url |> MediaProxy.filename()
|
filename = MediaProxy.filename(url)
|
||||||
|
|
||||||
if has_filename && filename && Path.basename(path) != filename do
|
if filename && Path.basename(path) != filename do
|
||||||
{:wrong_filename, filename}
|
{:wrong_filename, filename}
|
||||||
else
|
else
|
||||||
:ok
|
:ok
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def filename_matches(_, _, _), do: :ok
|
||||||
end
|
end
|
2
mix.exs
2
mix.exs
|
@ -14,7 +14,7 @@ def project do
|
||||||
aliases: aliases(),
|
aliases: aliases(),
|
||||||
deps: deps(),
|
deps: deps(),
|
||||||
test_coverage: [tool: ExCoveralls],
|
test_coverage: [tool: ExCoveralls],
|
||||||
|
preferred_cli_env: ["coveralls.html": :test],
|
||||||
# Docs
|
# Docs
|
||||||
name: "Pleroma",
|
name: "Pleroma",
|
||||||
homepage_url: "https://pleroma.social/",
|
homepage_url: "https://pleroma.social/",
|
||||||
|
|
73
test/web/media_proxy/media_proxy_controller_test.exs
Normal file
73
test/web/media_proxy/media_proxy_controller_test.exs
Normal file
|
@ -0,0 +1,73 @@
|
||||||
|
# Pleroma: A lightweight social networking server
|
||||||
|
# Copyright © 2017-2018 Pleroma Authors <https://pleroma.social/>
|
||||||
|
# SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
|
||||||
|
defmodule Pleroma.Web.MediaProxy.MediaProxyControllerTest do
|
||||||
|
use Pleroma.Web.ConnCase
|
||||||
|
import Mock
|
||||||
|
alias Pleroma.Config
|
||||||
|
|
||||||
|
setup do
|
||||||
|
media_proxy_config = Config.get([:media_proxy]) || []
|
||||||
|
on_exit(fn -> Config.put([:media_proxy], media_proxy_config) end)
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
|
||||||
|
test "it returns 404 when MediaProxy disabled", %{conn: conn} do
|
||||||
|
Config.put([:media_proxy, :enabled], false)
|
||||||
|
|
||||||
|
assert %Plug.Conn{
|
||||||
|
status: 404,
|
||||||
|
resp_body: "Not Found"
|
||||||
|
} = get(conn, "/proxy/hhgfh/eeeee")
|
||||||
|
|
||||||
|
assert %Plug.Conn{
|
||||||
|
status: 404,
|
||||||
|
resp_body: "Not Found"
|
||||||
|
} = get(conn, "/proxy/hhgfh/eeee/fff")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "it returns 403 when signature invalidated", %{conn: conn} do
|
||||||
|
Config.put([:media_proxy, :enabled], true)
|
||||||
|
Config.put([Pleroma.Web.Endpoint, :secret_key_base], "00000000000")
|
||||||
|
path = URI.parse(Pleroma.Web.MediaProxy.encode_url("https://google.fn")).path
|
||||||
|
Config.put([Pleroma.Web.Endpoint, :secret_key_base], "000")
|
||||||
|
|
||||||
|
assert %Plug.Conn{
|
||||||
|
status: 403,
|
||||||
|
resp_body: "Forbidden"
|
||||||
|
} = get(conn, path)
|
||||||
|
|
||||||
|
assert %Plug.Conn{
|
||||||
|
status: 403,
|
||||||
|
resp_body: "Forbidden"
|
||||||
|
} = get(conn, "/proxy/hhgfh/eeee")
|
||||||
|
|
||||||
|
assert %Plug.Conn{
|
||||||
|
status: 403,
|
||||||
|
resp_body: "Forbidden"
|
||||||
|
} = get(conn, "/proxy/hhgfh/eeee/fff")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "redirects on valid url when filename invalidated", %{conn: conn} do
|
||||||
|
Config.put([:media_proxy, :enabled], true)
|
||||||
|
Config.put([Pleroma.Web.Endpoint, :secret_key_base], "00000000000")
|
||||||
|
url = Pleroma.Web.MediaProxy.encode_url("https://google.fn/test.png")
|
||||||
|
invalid_url = String.replace(url, "test.png", "test-file.png")
|
||||||
|
response = get(conn, invalid_url)
|
||||||
|
html = "<html><body>You are being <a href=\"#{url}\">redirected</a>.</body></html>"
|
||||||
|
assert response.status == 302
|
||||||
|
assert response.resp_body == html
|
||||||
|
end
|
||||||
|
|
||||||
|
test "it performs ReverseProxy.call when signature valid", %{conn: conn} do
|
||||||
|
Config.put([:media_proxy, :enabled], true)
|
||||||
|
Config.put([Pleroma.Web.Endpoint, :secret_key_base], "00000000000")
|
||||||
|
url = Pleroma.Web.MediaProxy.encode_url("https://google.fn/test.png")
|
||||||
|
|
||||||
|
with_mock Pleroma.ReverseProxy,
|
||||||
|
call: fn _conn, _url, _opts -> %Plug.Conn{status: :success} end do
|
||||||
|
assert %Plug.Conn{status: :success} = get(conn, url)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
|
@ -2,7 +2,7 @@
|
||||||
# Copyright © 2017-2018 Pleroma Authors <https://pleroma.social/>
|
# Copyright © 2017-2018 Pleroma Authors <https://pleroma.social/>
|
||||||
# SPDX-License-Identifier: AGPL-3.0-only
|
# SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
|
||||||
defmodule Pleroma.MediaProxyTest do
|
defmodule Pleroma.Web.MediaProxyTest do
|
||||||
use ExUnit.Case
|
use ExUnit.Case
|
||||||
import Pleroma.Web.MediaProxy
|
import Pleroma.Web.MediaProxy
|
||||||
alias Pleroma.Web.MediaProxy.MediaProxyController
|
alias Pleroma.Web.MediaProxy.MediaProxyController
|
||||||
|
@ -90,22 +90,28 @@ test "validates signature" do
|
||||||
|
|
||||||
test "filename_matches preserves the encoded or decoded path" do
|
test "filename_matches preserves the encoded or decoded path" do
|
||||||
assert MediaProxyController.filename_matches(
|
assert MediaProxyController.filename_matches(
|
||||||
true,
|
%{"filename" => "/Hello world.jpg"},
|
||||||
"/Hello world.jpg",
|
"/Hello world.jpg",
|
||||||
"http://pleroma.social/Hello world.jpg"
|
"http://pleroma.social/Hello world.jpg"
|
||||||
) == :ok
|
) == :ok
|
||||||
|
|
||||||
assert MediaProxyController.filename_matches(
|
assert MediaProxyController.filename_matches(
|
||||||
true,
|
%{"filename" => "/Hello%20world.jpg"},
|
||||||
"/Hello%20world.jpg",
|
"/Hello%20world.jpg",
|
||||||
"http://pleroma.social/Hello%20world.jpg"
|
"http://pleroma.social/Hello%20world.jpg"
|
||||||
) == :ok
|
) == :ok
|
||||||
|
|
||||||
assert MediaProxyController.filename_matches(
|
assert MediaProxyController.filename_matches(
|
||||||
true,
|
%{"filename" => "/my%2Flong%2Furl%2F2019%2F07%2FS.jpg"},
|
||||||
"/my%2Flong%2Furl%2F2019%2F07%2FS.jpg",
|
"/my%2Flong%2Furl%2F2019%2F07%2FS.jpg",
|
||||||
"http://pleroma.social/my%2Flong%2Furl%2F2019%2F07%2FS.jpg"
|
"http://pleroma.social/my%2Flong%2Furl%2F2019%2F07%2FS.jpg"
|
||||||
) == :ok
|
) == :ok
|
||||||
|
|
||||||
|
assert MediaProxyController.filename_matches(
|
||||||
|
%{"filename" => "/my%2Flong%2Furl%2F2019%2F07%2FS.jp"},
|
||||||
|
"/my%2Flong%2Furl%2F2019%2F07%2FS.jp",
|
||||||
|
"http://pleroma.social/my%2Flong%2Furl%2F2019%2F07%2FS.jpg"
|
||||||
|
) == {:wrong_filename, "my%2Flong%2Furl%2F2019%2F07%2FS.jpg"}
|
||||||
end
|
end
|
||||||
|
|
||||||
test "uses the configured base_url" do
|
test "uses the configured base_url" do
|
Loading…
Reference in a new issue