cad0acd306196d079585f674b3de85731987340b
[akkoma] / 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 secret_key_base = Config.get([Endpoint, :secret_key_base])
75 clear_config([Endpoint, :secret_key_base], secret_key_base)
76
77 encoded = MediaProxy.url("https://pleroma.social")
78
79 Config.put(
80 [Endpoint, :secret_key_base],
81 "00000000000000000000000000000000000000000000000"
82 )
83
84 [_, "proxy", sig, base64 | _] = URI.parse(encoded).path |> String.split("/")
85 assert MediaProxy.decode_url(sig, base64) == {:error, :invalid_signature}
86 end
87
88 test "`filename_matches/_` preserves the encoded or decoded path" do
89 assert MediaProxy.filename_matches(
90 %{"filename" => "/Hello world.jpg"},
91 "/Hello world.jpg",
92 "http://pleroma.social/Hello world.jpg"
93 ) == :ok
94
95 assert MediaProxy.filename_matches(
96 %{"filename" => "/Hello%20world.jpg"},
97 "/Hello%20world.jpg",
98 "http://pleroma.social/Hello%20world.jpg"
99 ) == :ok
100
101 assert MediaProxy.filename_matches(
102 %{"filename" => "/my%2Flong%2Furl%2F2019%2F07%2FS.jpg"},
103 "/my%2Flong%2Furl%2F2019%2F07%2FS.jpg",
104 "http://pleroma.social/my%2Flong%2Furl%2F2019%2F07%2FS.jpg"
105 ) == :ok
106
107 assert MediaProxy.filename_matches(
108 %{"filename" => "/my%2Flong%2Furl%2F2019%2F07%2FS.jp"},
109 "/my%2Flong%2Furl%2F2019%2F07%2FS.jp",
110 "http://pleroma.social/my%2Flong%2Furl%2F2019%2F07%2FS.jpg"
111 ) == {:wrong_filename, "my%2Flong%2Furl%2F2019%2F07%2FS.jpg"}
112 end
113
114 test "encoded url are tried to match for proxy as `conn.request_path` encodes the url" do
115 # conn.request_path will return encoded url
116 request_path = "/ANALYSE-DAI-_-LE-STABLECOIN-100-D%C3%89CENTRALIS%C3%89-BQ.jpg"
117
118 assert MediaProxy.filename_matches(
119 true,
120 request_path,
121 "https://mydomain.com/uploads/2019/07/ANALYSE-DAI-_-LE-STABLECOIN-100-DÉCENTRALISÉ-BQ.jpg"
122 ) == :ok
123 end
124
125 test "uses the configured base_url" do
126 clear_config([:media_proxy, :base_url], "https://cache.pleroma.social")
127
128 url = "https://pleroma.soykaf.com/static/logo.png"
129 encoded = MediaProxy.url(url)
130
131 assert String.starts_with?(encoded, Config.get([:media_proxy, :base_url]))
132 end
133
134 # Some sites expect ASCII encoded characters in the URL to be preserved even if
135 # unnecessary.
136 # Issues: https://git.pleroma.social/pleroma/pleroma/issues/580
137 # https://git.pleroma.social/pleroma/pleroma/issues/1055
138 test "preserve ASCII encoding" do
139 url =
140 "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"
141
142 encoded = MediaProxy.url(url)
143 assert decode_result(encoded) == url
144 end
145
146 # This includes unsafe/reserved characters which are not interpreted as part of the URL
147 # and would otherwise have to be ASCII encoded. It is our role to ensure the proxied URL
148 # is unmodified, so we are testing these characters anyway.
149 test "preserve non-unicode characters per RFC3986" do
150 url =
151 "https://pleroma.com/ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890-._~:/?#[]@!$&'()*+,;=|^`{}"
152
153 encoded = MediaProxy.url(url)
154 assert decode_result(encoded) == url
155 end
156
157 test "preserve unicode characters" do
158 url = "https://ko.wikipedia.org/wiki/위키백과:대문"
159
160 encoded = MediaProxy.url(url)
161 assert decode_result(encoded) == url
162 end
163 end
164
165 describe "when disabled" do
166 setup do: clear_config([:media_proxy, :enabled], false)
167
168 test "does not encode remote urls" do
169 assert MediaProxy.url("https://google.fr") == "https://google.fr"
170 end
171 end
172
173 describe "whitelist" do
174 setup do: clear_config([:media_proxy, :enabled], true)
175
176 test "mediaproxy whitelist" do
177 clear_config([:media_proxy, :whitelist], ["google.com", "feld.me"])
178 url = "https://feld.me/foo.png"
179
180 unencoded = MediaProxy.url(url)
181 assert unencoded == url
182 end
183
184 test "does not change whitelisted urls" do
185 clear_config([:media_proxy, :whitelist], ["mycdn.akamai.com"])
186 clear_config([:media_proxy, :base_url], "https://cache.pleroma.social")
187
188 media_url = "https://mycdn.akamai.com"
189
190 url = "#{media_url}/static/logo.png"
191 encoded = MediaProxy.url(url)
192
193 assert String.starts_with?(encoded, media_url)
194 end
195
196 test "ensure Pleroma.Upload base_url is always whitelisted" do
197 media_url = "https://media.pleroma.social"
198 clear_config([Pleroma.Upload, :base_url], media_url)
199
200 url = "#{media_url}/static/logo.png"
201 encoded = MediaProxy.url(url)
202
203 assert String.starts_with?(encoded, media_url)
204 end
205 end
206 end