4cbe1cf89e9bd09ab5a29b48912bf360f23d5d56
[akkoma] / lib / pleroma / web / media_proxy / media_proxy.ex
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.MediaProxy do
6 alias Pleroma.Config
7 alias Pleroma.Helpers.UriHelper
8 alias Pleroma.Upload
9 alias Pleroma.Web
10 alias Pleroma.Web.MediaProxy.Invalidation
11
12 @base64_opts [padding: false]
13 @cache_table :banned_urls_cache
14
15 def cache_table, do: @cache_table
16
17 @spec in_banned_urls(String.t()) :: boolean()
18 def in_banned_urls(url), do: elem(Cachex.exists?(@cache_table, url(url)), 1)
19
20 def remove_from_banned_urls(urls) when is_list(urls) do
21 Cachex.execute!(@cache_table, fn cache ->
22 Enum.each(Invalidation.prepare_urls(urls), &Cachex.del(cache, &1))
23 end)
24 end
25
26 def remove_from_banned_urls(url) when is_binary(url) do
27 Cachex.del(@cache_table, url(url))
28 end
29
30 def put_in_banned_urls(urls) when is_list(urls) do
31 Cachex.execute!(@cache_table, fn cache ->
32 Enum.each(Invalidation.prepare_urls(urls), &Cachex.put(cache, &1, true))
33 end)
34 end
35
36 def put_in_banned_urls(url) when is_binary(url) do
37 Cachex.put(@cache_table, url(url), true)
38 end
39
40 def url(url) when is_nil(url) or url == "", do: nil
41 def url("/" <> _ = url), do: url
42
43 def url(url) do
44 if not enabled?() or not url_proxiable?(url) do
45 url
46 else
47 encode_url(url)
48 end
49 end
50
51 @spec url_proxiable?(String.t()) :: boolean()
52 def url_proxiable?(url) do
53 if local?(url) or whitelisted?(url) do
54 false
55 else
56 true
57 end
58 end
59
60 # Note: routing all URLs to preview handler (even local and whitelisted).
61 # Preview handler will call url/1 on decoded URLs, and applicable ones will detour media proxy.
62 def preview_url(url, preview_params \\ []) do
63 if preview_enabled?() do
64 encode_preview_url(url, preview_params)
65 else
66 url
67 end
68 end
69
70 def enabled?, do: Config.get([:media_proxy, :enabled], false)
71
72 # Note: media proxy must be enabled for media preview proxy in order to load all
73 # non-local non-whitelisted URLs through it and be sure that body size constraint is preserved.
74 def preview_enabled?, do: enabled?() and Config.get([:media_preview_proxy, :enabled], false)
75
76 def local?(url), do: String.starts_with?(url, Pleroma.Web.base_url())
77
78 def whitelisted?(url) do
79 %{host: domain} = URI.parse(url)
80
81 mediaproxy_whitelist_domains =
82 [:media_proxy, :whitelist]
83 |> Config.get()
84 |> Enum.map(&maybe_get_domain_from_url/1)
85
86 whitelist_domains =
87 if base_url = Config.get([Upload, :base_url]) do
88 %{host: base_domain} = URI.parse(base_url)
89 [base_domain | mediaproxy_whitelist_domains]
90 else
91 mediaproxy_whitelist_domains
92 end
93
94 domain in whitelist_domains
95 end
96
97 defp maybe_get_domain_from_url("http" <> _ = url) do
98 URI.parse(url).host
99 end
100
101 defp maybe_get_domain_from_url(domain), do: domain
102
103 defp base64_sig64(url) do
104 base64 = Base.url_encode64(url, @base64_opts)
105
106 sig64 =
107 base64
108 |> signed_url()
109 |> Base.url_encode64(@base64_opts)
110
111 {base64, sig64}
112 end
113
114 def encode_url(url) do
115 {base64, sig64} = base64_sig64(url)
116
117 build_url(sig64, base64, filename(url))
118 end
119
120 def encode_preview_url(url, preview_params \\ []) do
121 {base64, sig64} = base64_sig64(url)
122
123 build_preview_url(sig64, base64, filename(url), preview_params)
124 end
125
126 def decode_url(sig, url) do
127 with {:ok, sig} <- Base.url_decode64(sig, @base64_opts),
128 signature when signature == sig <- signed_url(url) do
129 {:ok, Base.url_decode64!(url, @base64_opts)}
130 else
131 _ -> {:error, :invalid_signature}
132 end
133 end
134
135 defp signed_url(url) do
136 :crypto.hmac(:sha, Config.get([Web.Endpoint, :secret_key_base]), url)
137 end
138
139 def filename(url_or_path) do
140 if path = URI.parse(url_or_path).path, do: Path.basename(path)
141 end
142
143 defp proxy_url(path, sig_base64, url_base64, filename) do
144 [
145 Config.get([:media_proxy, :base_url], Web.base_url()),
146 path,
147 sig_base64,
148 url_base64,
149 filename
150 ]
151 |> Enum.filter(& &1)
152 |> Path.join()
153 end
154
155 def build_url(sig_base64, url_base64, filename \\ nil) do
156 proxy_url("proxy", sig_base64, url_base64, filename)
157 end
158
159 def build_preview_url(sig_base64, url_base64, filename \\ nil, preview_params \\ []) do
160 uri = proxy_url("proxy/preview", sig_base64, url_base64, filename)
161
162 UriHelper.append_uri_params(uri, preview_params)
163 end
164
165 def verify_request_path_and_url(
166 %Plug.Conn{params: %{"filename" => _}, request_path: request_path},
167 url
168 ) do
169 verify_request_path_and_url(request_path, url)
170 end
171
172 def verify_request_path_and_url(request_path, url) when is_binary(request_path) do
173 filename = filename(url)
174
175 if filename && not basename_matches?(request_path, filename) do
176 {:wrong_filename, filename}
177 else
178 :ok
179 end
180 end
181
182 def verify_request_path_and_url(_, _), do: :ok
183
184 defp basename_matches?(path, filename) do
185 basename = Path.basename(path)
186 basename == filename or URI.decode(basename) == filename or URI.encode(basename) == filename
187 end
188 end