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
70 when is_map(child_object) do
72 Config.get([:mrf_simple, :media_nsfw])
73 |> MRF.subdomains_regex()
76 if MRF.subdomain_match?(media_nsfw, actor_host) do
79 |> Map.put("tag", (child_object["tag"] || []) ++ ["nsfw"])
80 |> Map.put("sensitive", true)
82 Map.put(object, "object", child_object)
90 defp check_media_nsfw(_actor_info, object), do: {:ok, object}
92 defp check_ftl_removal(%{host: actor_host} = _actor_info, object) do
94 Config.get([:mrf_simple, :federated_timeline_removal])
95 |> MRF.subdomains_regex()
98 with true <- MRF.subdomain_match?(timeline_removal, actor_host),
99 user <- User.get_cached_by_ap_id(object["actor"]),
100 true <- Pleroma.Constants.as_public() in object["to"] do
101 to = List.delete(object["to"], Pleroma.Constants.as_public()) ++ [user.follower_address]
103 cc = List.delete(object["cc"], user.follower_address) ++ [Pleroma.Constants.as_public()]
115 defp intersection(list1, list2) do
116 list1 -- list1 -- list2
119 defp check_followers_only(%{host: actor_host} = _actor_info, object) do
121 Config.get([:mrf_simple, :followers_only])
122 |> MRF.subdomains_regex()
125 with true <- MRF.subdomain_match?(followers_only, actor_host),
126 user <- User.get_cached_by_ap_id(object["actor"]) do
127 # Don't use Map.get/3 intentionally, these must not be nil
128 fixed_to = object["to"] || []
129 fixed_cc = object["cc"] || []
131 to = FollowingRelationship.followers_ap_ids(user, fixed_to)
132 cc = FollowingRelationship.followers_ap_ids(user, fixed_cc)
135 |> Map.put("to", intersection([user.follower_address | to], fixed_to))
136 |> Map.put("cc", intersection([user.follower_address | cc], fixed_cc))
144 defp check_report_removal(%{host: actor_host} = _actor_info, %{"type" => "Flag"} = object) do
146 Config.get([:mrf_simple, :report_removal])
147 |> MRF.subdomains_regex()
149 if MRF.subdomain_match?(report_removal, actor_host) do
150 {:reject, "[SimplePolicy] host in report_removal list"}
156 defp check_report_removal(_actor_info, object), do: {:ok, object}
158 defp check_avatar_removal(%{host: actor_host} = _actor_info, %{"icon" => _icon} = object) do
160 Config.get([:mrf_simple, :avatar_removal])
161 |> MRF.subdomains_regex()
163 if MRF.subdomain_match?(avatar_removal, actor_host) do
164 {:ok, Map.delete(object, "icon")}
170 defp check_avatar_removal(_actor_info, object), do: {:ok, object}
172 defp check_banner_removal(%{host: actor_host} = _actor_info, %{"image" => _image} = object) do
174 Config.get([:mrf_simple, :banner_removal])
175 |> MRF.subdomains_regex()
177 if MRF.subdomain_match?(banner_removal, actor_host) do
178 {:ok, Map.delete(object, "image")}
184 defp check_banner_removal(_actor_info, object), do: {:ok, object}
187 def filter(%{"type" => "Delete", "actor" => actor} = object) do
188 %{host: actor_host} = URI.parse(actor)
191 Config.get([:mrf_simple, :reject_deletes])
192 |> MRF.subdomains_regex()
194 if MRF.subdomain_match?(reject_deletes, actor_host) do
195 {:reject, "[SimplePolicy] host in reject_deletes list"}
202 def filter(%{"actor" => actor} = object) do
203 actor_info = URI.parse(actor)
205 with {:ok, object} <- check_accept(actor_info, object),
206 {:ok, object} <- check_reject(actor_info, object),
207 {:ok, object} <- check_media_removal(actor_info, object),
208 {:ok, object} <- check_media_nsfw(actor_info, object),
209 {:ok, object} <- check_ftl_removal(actor_info, object),
210 {:ok, object} <- check_followers_only(actor_info, object),
211 {:ok, object} <- check_report_removal(actor_info, object) do
214 {:reject, nil} -> {:reject, "[SimplePolicy]"}
215 {:reject, _} = e -> e
216 _ -> {:reject, "[SimplePolicy]"}
220 def filter(%{"id" => actor, "type" => obj_type} = object)
221 when obj_type in ["Application", "Group", "Organization", "Person", "Service"] do
222 actor_info = URI.parse(actor)
224 with {:ok, object} <- check_accept(actor_info, object),
225 {:ok, object} <- check_reject(actor_info, object),
226 {:ok, object} <- check_avatar_removal(actor_info, object),
227 {:ok, object} <- check_banner_removal(actor_info, object) do
230 {:reject, nil} -> {:reject, "[SimplePolicy]"}
231 {:reject, _} = e -> e
232 _ -> {:reject, "[SimplePolicy]"}
236 def filter(object), do: {:ok, object}
240 exclusions = Config.get([:mrf, :transparency_exclusions])
243 Config.get(:mrf_simple)
244 |> Enum.map(fn {k, v} -> {k, Enum.reject(v, fn v -> v in exclusions end)} end)
247 {:ok, %{mrf_simple: mrf_simple}}
251 def config_description do
254 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
256 description: "Simple ingress policies",
260 type: {:list, :string},
261 description: "List of instances to strip media attachments from",
262 suggestions: ["example.com", "*.example.com"]
267 type: {:list, :string},
268 description: "List of instances to tag all media as NSFW (sensitive) from",
269 suggestions: ["example.com", "*.example.com"]
272 key: :federated_timeline_removal,
273 type: {:list, :string},
275 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
276 suggestions: ["example.com", "*.example.com"]
280 type: {:list, :string},
281 description: "List of instances to reject activities from (except deletes)",
282 suggestions: ["example.com", "*.example.com"]
286 type: {:list, :string},
287 description: "List of instances to only accept activities from (except deletes)",
288 suggestions: ["example.com", "*.example.com"]
291 key: :followers_only,
292 type: {:list, :string},
293 description: "Force posts from the given instances to be visible by followers only",
294 suggestions: ["example.com", "*.example.com"]
297 key: :report_removal,
298 type: {:list, :string},
299 description: "List of instances to reject reports from",
300 suggestions: ["example.com", "*.example.com"]
303 key: :avatar_removal,
304 type: {:list, :string},
305 description: "List of instances to strip avatars from",
306 suggestions: ["example.com", "*.example.com"]
309 key: :banner_removal,
310 type: {:list, :string},
311 description: "List of instances to strip banners from",
312 suggestions: ["example.com", "*.example.com"]
315 key: :reject_deletes,
316 type: {:list, :string},
317 description: "List of instances to reject deletions from",
318 suggestions: ["example.com", "*.example.com"]