1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.MediaProxyTest do
7 use Pleroma.Tests.Helpers
9 alias Pleroma.Web.Endpoint
10 alias Pleroma.Web.MediaProxy
12 describe "when enabled" do
13 setup do: clear_config([:media_proxy, :enabled], true)
15 test "ignores invalid url" do
16 assert MediaProxy.url(nil) == nil
17 assert MediaProxy.url("") == nil
20 test "ignores relative url" do
21 assert MediaProxy.url("/local") == "/local"
22 assert MediaProxy.url("/") == "/"
25 test "ignores local url" do
26 local_url = Endpoint.url() <> "/hello"
27 local_root = Endpoint.url()
28 assert MediaProxy.url(local_url) == local_url
29 assert MediaProxy.url(local_root) == local_root
32 test "encodes and decodes URL" do
33 url = "https://pleroma.soykaf.com/static/logo.png"
34 encoded = MediaProxy.url(url)
36 assert String.starts_with?(
38 Pleroma.Config.get([:media_proxy, :base_url], Pleroma.Web.base_url())
41 assert String.ends_with?(encoded, "/logo.png")
43 assert decode_result(encoded) == url
46 test "encodes and decodes URL without a path" do
47 url = "https://pleroma.soykaf.com"
48 encoded = MediaProxy.url(url)
49 assert decode_result(encoded) == url
52 test "encodes and decodes URL without an extension" do
53 url = "https://pleroma.soykaf.com/path/"
54 encoded = MediaProxy.url(url)
55 assert String.ends_with?(encoded, "/path")
56 assert decode_result(encoded) == url
59 test "encodes and decodes URL and ignores query params for the path" do
60 url = "https://pleroma.soykaf.com/static/logo.png?93939393939&bunny=true"
61 encoded = MediaProxy.url(url)
62 assert String.ends_with?(encoded, "/logo.png")
63 assert decode_result(encoded) == url
66 test "validates signature" do
67 encoded = MediaProxy.url("https://pleroma.social")
70 [Endpoint, :secret_key_base],
71 "00000000000000000000000000000000000000000000000"
74 [_, "proxy", sig, base64 | _] = URI.parse(encoded).path |> String.split("/")
75 assert MediaProxy.decode_url(sig, base64) == {:error, :invalid_signature}
78 test "uses the configured base_url" do
79 base_url = "https://cache.pleroma.social"
80 clear_config([:media_proxy, :base_url], base_url)
82 url = "https://pleroma.soykaf.com/static/logo.png"
83 encoded = MediaProxy.url(url)
85 assert String.starts_with?(encoded, base_url)
88 # Some sites expect ASCII encoded characters in the URL to be preserved even if
90 # Issues: https://git.pleroma.social/pleroma/pleroma/issues/580
91 # https://git.pleroma.social/pleroma/pleroma/issues/1055
92 test "preserve ASCII encoding" do
94 "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"
96 encoded = MediaProxy.url(url)
97 assert decode_result(encoded) == url
100 # This includes unsafe/reserved characters which are not interpreted as part of the URL
101 # and would otherwise have to be ASCII encoded. It is our role to ensure the proxied URL
102 # is unmodified, so we are testing these characters anyway.
103 test "preserve non-unicode characters per RFC3986" do
105 "https://pleroma.com/ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890-._~:/?#[]@!$&'()*+,;=|^`{}"
107 encoded = MediaProxy.url(url)
108 assert decode_result(encoded) == url
111 test "preserve unicode characters" do
112 url = "https://ko.wikipedia.org/wiki/위키백과:대문"
114 encoded = MediaProxy.url(url)
115 assert decode_result(encoded) == url
119 describe "when disabled" do
120 setup do: clear_config([:media_proxy, :enabled], false)
122 test "does not encode remote urls" do
123 assert MediaProxy.url("https://google.fr") == "https://google.fr"
127 defp decode_result(encoded) do
128 [_, "proxy", sig, base64 | _] = URI.parse(encoded).path |> String.split("/")
129 {:ok, decoded} = MediaProxy.decode_url(sig, base64)
133 describe "whitelist" do
134 setup do: clear_config([:media_proxy, :enabled], true)
136 test "mediaproxy whitelist" do
137 clear_config([:media_proxy, :whitelist], ["https://google.com", "https://feld.me"])
138 url = "https://feld.me/foo.png"
140 unencoded = MediaProxy.url(url)
141 assert unencoded == url
144 # TODO: delete after removing support bare domains for media proxy whitelist
145 test "mediaproxy whitelist bare domains whitelist (deprecated)" do
146 clear_config([:media_proxy, :whitelist], ["google.com", "feld.me"])
147 url = "https://feld.me/foo.png"
149 unencoded = MediaProxy.url(url)
150 assert unencoded == url
153 test "does not change whitelisted urls" do
154 clear_config([:media_proxy, :whitelist], ["mycdn.akamai.com"])
155 clear_config([:media_proxy, :base_url], "https://cache.pleroma.social")
157 media_url = "https://mycdn.akamai.com"
159 url = "#{media_url}/static/logo.png"
160 encoded = MediaProxy.url(url)
162 assert String.starts_with?(encoded, media_url)
165 test "ensure Pleroma.Upload base_url is always whitelisted" do
166 media_url = "https://media.pleroma.social"
167 clear_config([Pleroma.Upload, :base_url], media_url)
169 url = "#{media_url}/static/logo.png"
170 encoded = MediaProxy.url(url)
172 assert String.starts_with?(encoded, media_url)