Skip to content

Commit b11f5c9

Browse files
Clarify url_preview_url_blacklist is a usability feature (#17356)
1 parent 27756c9 commit b11f5c9

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

changelog.d/17356.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Clarify `url_preview_url_blacklist` is a usability feature.

docs/usage/configuration/config_documentation.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1976,9 +1976,10 @@ This will not prevent the listed domains from accessing media themselves.
19761976
It simply prevents users on this server from downloading media originating
19771977
from the listed servers.
19781978

1979-
This will have no effect on media originating from the local server.
1980-
This only affects media downloaded from other Matrix servers, to
1981-
block domains from URL previews see [`url_preview_url_blacklist`](#url_preview_url_blacklist).
1979+
This will have no effect on media originating from the local server. This only
1980+
affects media downloaded from other Matrix servers, to control URL previews see
1981+
[`url_preview_ip_range_blacklist`](#url_preview_ip_range_blacklist) or
1982+
[`url_preview_url_blacklist`](#url_preview_url_blacklist).
19821983

19831984
Defaults to an empty list (nothing blocked).
19841985

@@ -2130,12 +2131,14 @@ url_preview_ip_range_whitelist:
21302131
---
21312132
### `url_preview_url_blacklist`
21322133

2133-
Optional list of URL matches that the URL preview spider is
2134-
denied from accessing. You should use `url_preview_ip_range_blacklist`
2135-
in preference to this, otherwise someone could define a public DNS
2136-
entry that points to a private IP address and circumvent the blacklist.
2137-
This is more useful if you know there is an entire shape of URL that
2138-
you know that will never want synapse to try to spider.
2134+
Optional list of URL matches that the URL preview spider is denied from
2135+
accessing. This is a usability feature, not a security one. You should use
2136+
`url_preview_ip_range_blacklist` in preference to this, otherwise someone could
2137+
define a public DNS entry that points to a private IP address and circumvent
2138+
the blacklist. Applications that perform redirects or serve different content
2139+
when detecting that Synapse is accessing them can also bypass the blacklist.
2140+
This is more useful if you know there is an entire shape of URL that you know
2141+
that you do not want Synapse to preview.
21392142

21402143
Each list entry is a dictionary of url component attributes as returned
21412144
by urlparse.urlsplit as applied to the absolute form of the URL. See

0 commit comments

Comments
 (0)