git.squeep.com Git - akkoma/blob - test/web/media_proxy/media_proxy_test.exs

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.Web.MediaProxyTest do
   6   use ExUnit.Case
   7   use Pleroma.Tests.Helpers
   8
   9   alias Pleroma.Config
  10   alias Pleroma.Web.Endpoint
  11   alias Pleroma.Web.MediaProxy
  12
  13   defp decode_result(encoded) do
  14     [_, "proxy", sig, base64 | _] = URI.parse(encoded).path |> String.split("/")
  15     {:ok, decoded} = MediaProxy.decode_url(sig, base64)
  16     decoded
  17   end
  18
  19   describe "when enabled" do
  20     setup do: clear_config([:media_proxy, :enabled], true)
  21
  22     test "ignores invalid url" do
  23       assert MediaProxy.url(nil) == nil
  24       assert MediaProxy.url("") == nil
  25     end
  26
  27     test "ignores relative url" do
  28       assert MediaProxy.url("/local") == "/local"
  29       assert MediaProxy.url("/") == "/"
  30     end
  31
  32     test "ignores local url" do
  33       local_url = Endpoint.url() <> "/hello"
  34       local_root = Endpoint.url()
  35       assert MediaProxy.url(local_url) == local_url
  36       assert MediaProxy.url(local_root) == local_root
  37     end
  38
  39     test "encodes and decodes URL" do
  40       url = "https://pleroma.soykaf.com/static/logo.png"
  41       encoded = MediaProxy.url(url)
  42
  43       assert String.starts_with?(
  44                encoded,
  45                Config.get([:media_proxy, :base_url], Pleroma.Web.base_url())
  46              )
  47
  48       assert String.ends_with?(encoded, "/logo.png")
  49
  50       assert decode_result(encoded) == url
  51     end
  52
  53     test "encodes and decodes URL without a path" do
  54       url = "https://pleroma.soykaf.com"
  55       encoded = MediaProxy.url(url)
  56       assert decode_result(encoded) == url
  57     end
  58
  59     test "encodes and decodes URL without an extension" do
  60       url = "https://pleroma.soykaf.com/path/"
  61       encoded = MediaProxy.url(url)
  62       assert String.ends_with?(encoded, "/path")
  63       assert decode_result(encoded) == url
  64     end
  65
  66     test "encodes and decodes URL and ignores query params for the path" do
  67       url = "https://pleroma.soykaf.com/static/logo.png?93939393939&bunny=true"
  68       encoded = MediaProxy.url(url)
  69       assert String.ends_with?(encoded, "/logo.png")
  70       assert decode_result(encoded) == url
  71     end
  72
  73     test "validates signature" do
  74       encoded = MediaProxy.url("https://pleroma.social")
  75
  76       clear_config(
  77         [Endpoint, :secret_key_base],
  78         "00000000000000000000000000000000000000000000000"
  79       )
  80
  81       [_, "proxy", sig, base64 | _] = URI.parse(encoded).path |> String.split("/")
  82       assert MediaProxy.decode_url(sig, base64) == {:error, :invalid_signature}
  83     end
  84
  85     def test_verify_request_path_and_url(request_path, url, expected_result) do
  86       assert MediaProxy.verify_request_path_and_url(request_path, url) == expected_result
  87
  88       assert MediaProxy.verify_request_path_and_url(
  89                %Plug.Conn{
  90                  params: %{"filename" => Path.basename(request_path)},
  91                  request_path: request_path
  92                },
  93                url
  94              ) == expected_result
  95     end
  96
  97     test "if first arg of `verify_request_path_and_url/2` is a Plug.Conn without \"filename\" " <>
  98            "parameter, `verify_request_path_and_url/2` returns :ok " do
  99       assert MediaProxy.verify_request_path_and_url(
 100                %Plug.Conn{params: %{}, request_path: "/some/path"},
 101                "https://instance.com/file.jpg"
 102              ) == :ok
 103
 104       assert MediaProxy.verify_request_path_and_url(
 105                %Plug.Conn{params: %{}, request_path: "/path/to/file.jpg"},
 106                "https://instance.com/file.jpg"
 107              ) == :ok
 108     end
 109
 110     test "`verify_request_path_and_url/2` preserves the encoded or decoded path" do
 111       test_verify_request_path_and_url(
 112         "/Hello world.jpg",
 113         "http://pleroma.social/Hello world.jpg",
 114         :ok
 115       )
 116
 117       test_verify_request_path_and_url(
 118         "/Hello%20world.jpg",
 119         "http://pleroma.social/Hello%20world.jpg",
 120         :ok
 121       )
 122
 123       test_verify_request_path_and_url(
 124         "/my%2Flong%2Furl%2F2019%2F07%2FS.jpg",
 125         "http://pleroma.social/my%2Flong%2Furl%2F2019%2F07%2FS.jpg",
 126         :ok
 127       )
 128
 129       test_verify_request_path_and_url(
 130         "/my%2Flong%2Furl%2F2019%2F07%2FS",
 131         "http://pleroma.social/my%2Flong%2Furl%2F2019%2F07%2FS.jpg",
 132         {:wrong_filename, "my%2Flong%2Furl%2F2019%2F07%2FS.jpg"}
 133       )
 134     end
 135
 136     test "encoded url are tried to match for proxy as `conn.request_path` encodes the url" do
 137       # conn.request_path will return encoded url
 138       request_path = "/ANALYSE-DAI-_-LE-STABLECOIN-100-D%C3%89CENTRALIS%C3%89-BQ.jpg"
 139
 140       assert MediaProxy.verify_request_path_and_url(
 141                request_path,
 142                "https://mydomain.com/uploads/2019/07/ANALYSE-DAI-_-LE-STABLECOIN-100-DÉCENTRALISÉ-BQ.jpg"
 143              ) == :ok
 144       assert MediaProxy.decode_url(sig, base64) == {:error, :invalid_signature}
 145     end
 146
 147     test "uses the configured base_url" do
 148       base_url = "https://cache.pleroma.social"
 149       clear_config([:media_proxy, :base_url], base_url)
 150
 151       url = "https://pleroma.soykaf.com/static/logo.png"
 152       encoded = MediaProxy.url(url)
 153
 154       assert String.starts_with?(encoded, base_url)
 155     end
 156
 157     # Some sites expect ASCII encoded characters in the URL to be preserved even if
 158     # unnecessary.
 159     # Issues: https://git.pleroma.social/pleroma/pleroma/issues/580
 160     #         https://git.pleroma.social/pleroma/pleroma/issues/1055
 161     test "preserve ASCII encoding" do
 162       url =
 163         "https://pleroma.com/%20/%21/%22/%23/%24/%25/%26/%27/%28/%29/%2A/%2B/%2C/%2D/%2E/%2F/%30/%31/%32/%33/%34/%35/%36/%37/%38/%39/%3A/%3B/%3C/%3D/%3E/%3F/%40/%41/%42/%43/%44/%45/%46/%47/%48/%49/%4A/%4B/%4C/%4D/%4E/%4F/%50/%51/%52/%53/%54/%55/%56/%57/%58/%59/%5A/%5B/%5C/%5D/%5E/%5F/%60/%61/%62/%63/%64/%65/%66/%67/%68/%69/%6A/%6B/%6C/%6D/%6E/%6F/%70/%71/%72/%73/%74/%75/%76/%77/%78/%79/%7A/%7B/%7C/%7D/%7E/%7F/%80/%81/%82/%83/%84/%85/%86/%87/%88/%89/%8A/%8B/%8C/%8D/%8E/%8F/%90/%91/%92/%93/%94/%95/%96/%97/%98/%99/%9A/%9B/%9C/%9D/%9E/%9F/%C2%A0/%A1/%A2/%A3/%A4/%A5/%A6/%A7/%A8/%A9/%AA/%AB/%AC/%C2%AD/%AE/%AF/%B0/%B1/%B2/%B3/%B4/%B5/%B6/%B7/%B8/%B9/%BA/%BB/%BC/%BD/%BE/%BF/%C0/%C1/%C2/%C3/%C4/%C5/%C6/%C7/%C8/%C9/%CA/%CB/%CC/%CD/%CE/%CF/%D0/%D1/%D2/%D3/%D4/%D5/%D6/%D7/%D8/%D9/%DA/%DB/%DC/%DD/%DE/%DF/%E0/%E1/%E2/%E3/%E4/%E5/%E6/%E7/%E8/%E9/%EA/%EB/%EC/%ED/%EE/%EF/%F0/%F1/%F2/%F3/%F4/%F5/%F6/%F7/%F8/%F9/%FA/%FB/%FC/%FD/%FE/%FF"
 164
 165       encoded = MediaProxy.url(url)
 166       assert decode_result(encoded) == url
 167     end
 168
 169     # This includes unsafe/reserved characters which are not interpreted as part of the URL
 170     # and would otherwise have to be ASCII encoded. It is our role to ensure the proxied URL
 171     # is unmodified, so we are testing these characters anyway.
 172     test "preserve non-unicode characters per RFC3986" do
 173       url =
 174         "https://pleroma.com/ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890-._~:/?#[]@!$&'()*+,;=|^`{}"
 175
 176       encoded = MediaProxy.url(url)
 177       assert decode_result(encoded) == url
 178     end
 179
 180     test "preserve unicode characters" do
 181       url = "https://ko.wikipedia.org/wiki/위키백과:대문"
 182
 183       encoded = MediaProxy.url(url)
 184       assert decode_result(encoded) == url
 185     end
 186   end
 187
 188   describe "when disabled" do
 189     setup do: clear_config([:media_proxy, :enabled], false)
 190
 191     test "does not encode remote urls" do
 192       assert MediaProxy.url("https://google.fr") == "https://google.fr"
 193     end
 194   end
 195
 196   defp decode_result(encoded) do
 197     [_, "proxy", sig, base64 | _] = URI.parse(encoded).path |> String.split("/")
 198     {:ok, decoded} = MediaProxy.decode_url(sig, base64)
 199     decoded
 200   end
 201
 202   describe "whitelist" do
 203     setup do: clear_config([:media_proxy, :enabled], true)
 204
 205     test "mediaproxy whitelist" do
 206       clear_config([:media_proxy, :whitelist], ["https://google.com", "https://feld.me"])
 207       url = "https://feld.me/foo.png"
 208
 209       unencoded = MediaProxy.url(url)
 210       assert unencoded == url
 211     end
 212
 213     # TODO: delete after removing support bare domains for media proxy whitelist
 214     test "mediaproxy whitelist bare domains whitelist (deprecated)" do
 215       clear_config([:media_proxy, :whitelist], ["google.com", "feld.me"])
 216       url = "https://feld.me/foo.png"
 217
 218       unencoded = MediaProxy.url(url)
 219       assert unencoded == url
 220     end
 221
 222     test "does not change whitelisted urls" do
 223       clear_config([:media_proxy, :whitelist], ["mycdn.akamai.com"])
 224       clear_config([:media_proxy, :base_url], "https://cache.pleroma.social")
 225
 226       media_url = "https://mycdn.akamai.com"
 227
 228       url = "#{media_url}/static/logo.png"
 229       encoded = MediaProxy.url(url)
 230
 231       assert String.starts_with?(encoded, media_url)
 232     end
 233
 234     test "ensure Pleroma.Upload base_url is always whitelisted" do
 235       media_url = "https://media.pleroma.social"
 236       clear_config([Pleroma.Upload, :base_url], media_url)
 237
 238       url = "#{media_url}/static/logo.png"
 239       encoded = MediaProxy.url(url)
 240
 241       assert String.starts_with?(encoded, media_url)
 242     end
 243   end
 244 end