1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.ActivityPub.MRF.SimplePolicy do
6 @moduledoc "Filter activities depending on their origin instance"
7 @behaviour Pleroma.Web.ActivityPub.MRF
10 alias Pleroma.FollowingRelationship
12 alias Pleroma.Web.ActivityPub.MRF
14 require Pleroma.Constants
16 defp check_accept(%{host: actor_host} = _actor_info, object) do
18 Config.get([:mrf_simple, :accept])
19 |> MRF.subdomains_regex()
22 accepts == [] -> {:ok, object}
23 actor_host == Config.get([Pleroma.Web.Endpoint, :url, :host]) -> {:ok, object}
24 MRF.subdomain_match?(accepts, actor_host) -> {:ok, object}
25 true -> {:reject, "[SimplePolicy] host not in accept list"}
29 defp check_reject(%{host: actor_host} = _actor_info, object) do
31 Config.get([:mrf_simple, :reject])
32 |> MRF.subdomains_regex()
34 if MRF.subdomain_match?(rejects, actor_host) do
35 {:reject, "[SimplePolicy] host in reject list"}
41 defp check_media_removal(
42 %{host: actor_host} = _actor_info,
43 %{"type" => "Create", "object" => %{"attachment" => child_attachment}} = object
45 when length(child_attachment) > 0 do
47 Config.get([:mrf_simple, :media_removal])
48 |> MRF.subdomains_regex()
51 if MRF.subdomain_match?(media_removal, actor_host) do
52 child_object = Map.delete(object["object"], "attachment")
53 Map.put(object, "object", child_object)
61 defp check_media_removal(_actor_info, object), do: {:ok, object}
63 defp check_media_nsfw(
64 %{host: actor_host} = _actor_info,
67 "object" => %{} = _child_object
71 Config.get([:mrf_simple, :media_nsfw])
72 |> MRF.subdomains_regex()
75 if MRF.subdomain_match?(media_nsfw, actor_host) do
76 Kernel.put_in(object, ["object", "sensitive"], true)
84 defp check_media_nsfw(_actor_info, object), do: {:ok, object}
86 defp check_ftl_removal(%{host: actor_host} = _actor_info, object) do
88 Config.get([:mrf_simple, :federated_timeline_removal])
89 |> MRF.subdomains_regex()
92 with true <- MRF.subdomain_match?(timeline_removal, actor_host),
93 user <- User.get_cached_by_ap_id(object["actor"]),
94 true <- Pleroma.Constants.as_public() in object["to"] do
95 to = List.delete(object["to"], Pleroma.Constants.as_public()) ++ [user.follower_address]
97 cc = List.delete(object["cc"], user.follower_address) ++ [Pleroma.Constants.as_public()]
109 defp intersection(list1, list2) do
110 list1 -- list1 -- list2
113 defp check_followers_only(%{host: actor_host} = _actor_info, object) do
115 Config.get([:mrf_simple, :followers_only])
116 |> MRF.subdomains_regex()
119 with true <- MRF.subdomain_match?(followers_only, actor_host),
120 user <- User.get_cached_by_ap_id(object["actor"]) do
121 # Don't use Map.get/3 intentionally, these must not be nil
122 fixed_to = object["to"] || []
123 fixed_cc = object["cc"] || []
125 to = FollowingRelationship.followers_ap_ids(user, fixed_to)
126 cc = FollowingRelationship.followers_ap_ids(user, fixed_cc)
129 |> Map.put("to", intersection([user.follower_address | to], fixed_to))
130 |> Map.put("cc", intersection([user.follower_address | cc], fixed_cc))
138 defp check_report_removal(%{host: actor_host} = _actor_info, %{"type" => "Flag"} = object) do
140 Config.get([:mrf_simple, :report_removal])
141 |> MRF.subdomains_regex()
143 if MRF.subdomain_match?(report_removal, actor_host) do
144 {:reject, "[SimplePolicy] host in report_removal list"}
150 defp check_report_removal(_actor_info, object), do: {:ok, object}
152 defp check_avatar_removal(%{host: actor_host} = _actor_info, %{"icon" => _icon} = object) do
154 Config.get([:mrf_simple, :avatar_removal])
155 |> MRF.subdomains_regex()
157 if MRF.subdomain_match?(avatar_removal, actor_host) do
158 {:ok, Map.delete(object, "icon")}
164 defp check_avatar_removal(_actor_info, object), do: {:ok, object}
166 defp check_banner_removal(%{host: actor_host} = _actor_info, %{"image" => _image} = object) do
168 Config.get([:mrf_simple, :banner_removal])
169 |> MRF.subdomains_regex()
171 if MRF.subdomain_match?(banner_removal, actor_host) do
172 {:ok, Map.delete(object, "image")}
178 defp check_banner_removal(_actor_info, object), do: {:ok, object}
180 defp check_object(%{"object" => object} = activity) do
181 with {:ok, _object} <- filter(object) do
186 defp check_object(object), do: {:ok, object}
189 def filter(%{"type" => "Delete", "actor" => actor} = object) do
190 %{host: actor_host} = URI.parse(actor)
193 Config.get([:mrf_simple, :reject_deletes])
194 |> MRF.subdomains_regex()
196 if MRF.subdomain_match?(reject_deletes, actor_host) do
197 {:reject, "[SimplePolicy] host in reject_deletes list"}
204 def filter(%{"actor" => actor} = object) do
205 actor_info = URI.parse(actor)
207 with {:ok, object} <- check_accept(actor_info, object),
208 {:ok, object} <- check_reject(actor_info, object),
209 {:ok, object} <- check_media_removal(actor_info, object),
210 {:ok, object} <- check_media_nsfw(actor_info, object),
211 {:ok, object} <- check_ftl_removal(actor_info, object),
212 {:ok, object} <- check_followers_only(actor_info, object),
213 {:ok, object} <- check_report_removal(actor_info, object),
214 {:ok, object} <- check_object(object) do
217 {:reject, nil} -> {:reject, "[SimplePolicy]"}
218 {:reject, _} = e -> e
219 _ -> {:reject, "[SimplePolicy]"}
223 def filter(%{"id" => actor, "type" => obj_type} = object)
224 when obj_type in ["Application", "Group", "Organization", "Person", "Service"] do
225 actor_info = URI.parse(actor)
227 with {:ok, object} <- check_accept(actor_info, object),
228 {:ok, object} <- check_reject(actor_info, object),
229 {:ok, object} <- check_avatar_removal(actor_info, object),
230 {:ok, object} <- check_banner_removal(actor_info, object) do
233 {:reject, nil} -> {:reject, "[SimplePolicy]"}
234 {:reject, _} = e -> e
235 _ -> {:reject, "[SimplePolicy]"}
239 def filter(object) when is_binary(object) do
240 uri = URI.parse(object)
242 with {:ok, object} <- check_accept(uri, object),
243 {:ok, object} <- check_reject(uri, object) do
246 {:reject, nil} -> {:reject, "[SimplePolicy]"}
247 {:reject, _} = e -> e
248 _ -> {:reject, "[SimplePolicy]"}
252 def filter(object), do: {:ok, object}
256 exclusions = Config.get([:mrf, :transparency_exclusions])
259 Config.get(:mrf_simple)
260 |> Enum.map(fn {k, v} -> {k, Enum.reject(v, fn v -> v in exclusions end)} end)
263 {:ok, %{mrf_simple: mrf_simple}}
267 def config_description do
270 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
272 description: "Simple ingress policies",
276 type: {:list, :string},
277 description: "List of instances to strip media attachments from",
278 suggestions: ["example.com", "*.example.com"]
283 type: {:list, :string},
284 description: "List of instances to tag all media as NSFW (sensitive) from",
285 suggestions: ["example.com", "*.example.com"]
288 key: :federated_timeline_removal,
289 type: {:list, :string},
291 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
292 suggestions: ["example.com", "*.example.com"]
296 type: {:list, :string},
297 description: "List of instances to reject activities from (except deletes)",
298 suggestions: ["example.com", "*.example.com"]
302 type: {:list, :string},
303 description: "List of instances to only accept activities from (except deletes)",
304 suggestions: ["example.com", "*.example.com"]
307 key: :followers_only,
308 type: {:list, :string},
309 description: "Force posts from the given instances to be visible by followers only",
310 suggestions: ["example.com", "*.example.com"]
313 key: :report_removal,
314 type: {:list, :string},
315 description: "List of instances to reject reports from",
316 suggestions: ["example.com", "*.example.com"]
319 key: :avatar_removal,
320 type: {:list, :string},
321 description: "List of instances to strip avatars from",
322 suggestions: ["example.com", "*.example.com"]
325 key: :banner_removal,
326 type: {:list, :string},
327 description: "List of instances to strip banners from",
328 suggestions: ["example.com", "*.example.com"]
331 key: :reject_deletes,
332 type: {:list, :string},
333 description: "List of instances to reject deletions from",
334 suggestions: ["example.com", "*.example.com"]