httpUtil.php 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  1. <?php
  2. declare(strict_types=1);
  3. final class FreshRSS_http_Util {
  4. private const RETRY_AFTER_PATH = DATA_PATH . '/Retry-After/';
  5. private const PRIVATE_SUBNETS = [
  6. '127.0.0.0/8', // RFC1700 (Loopback)
  7. '10.0.0.0/8', // RFC1918
  8. '192.168.0.0/16', // RFC1918
  9. '172.16.0.0/12', // RFC1918
  10. '169.254.0.0/16', // RFC3927
  11. '0.0.0.0/8', // RFC5735
  12. '240.0.0.0/4', // RFC1112
  13. '100.64.0.0/10', // RFC6598 (Shared Address Space of Carrier-Grade NAT)
  14. '::1/128', // Loopback
  15. 'fc00::/7', // Unique Local Address
  16. 'fe80::/10', // Link Local Address
  17. '::ffff:0:0/96', // IPv4 translations
  18. '64:ff9b::/96', // RFC6052 (IPv6 Addressing of IPv4/IPv6 Translators, NAT64)
  19. '::/128', // Unspecified address
  20. ];
  21. /** @var array<string, string[]> $resolve_ok */
  22. private static array $resolve_ok = [];
  23. private static function getRetryAfterFile(string $url, string $proxy): string {
  24. $domain = parse_url($url, PHP_URL_HOST);
  25. if (!is_string($domain) || $domain === '') {
  26. return '';
  27. }
  28. $domainWide = Minz_Request::serverIsPublic($domain);
  29. $port = parse_url($url, PHP_URL_PORT);
  30. if (is_int($port)) {
  31. $domain .= ':' . $port;
  32. }
  33. return self::RETRY_AFTER_PATH . urlencode($domain) .
  34. ($domainWide ? '' : '_' . hash('sha256', $url)) .
  35. (empty($proxy) ? '' : '_' . urlencode($proxy)) . '.txt';
  36. }
  37. /**
  38. * Clean up old Retry-After files
  39. */
  40. private static function cleanRetryAfters(): void {
  41. if (!is_dir(self::RETRY_AFTER_PATH)) {
  42. return;
  43. }
  44. $files = glob(self::RETRY_AFTER_PATH . '*.txt', GLOB_NOSORT);
  45. if ($files === false) {
  46. return;
  47. }
  48. foreach ($files as $file) {
  49. if (@filemtime($file) < time()) {
  50. @unlink($file);
  51. }
  52. }
  53. }
  54. /**
  55. * Check whether the URL needs to wait for a Retry-After period.
  56. * @return int The timestamp of when the Retry-After expires, or 0 if not set.
  57. */
  58. public static function getRetryAfter(string $url, string $proxy): int {
  59. if (rand(0, 30) === 1) { // Remove old files once in a while
  60. self::cleanRetryAfters();
  61. }
  62. $txt = self::getRetryAfterFile($url, $proxy);
  63. if ($txt === '') {
  64. return 0;
  65. }
  66. $retryAfter = @filemtime($txt) ?: 0;
  67. if ($retryAfter <= 0) {
  68. return 0;
  69. }
  70. if ($retryAfter < time()) {
  71. @unlink($txt);
  72. return 0;
  73. }
  74. return $retryAfter;
  75. }
  76. /**
  77. * Store the HTTP Retry-After header value of an HTTP `429 Too Many Requests` or `503 Service Unavailable` response.
  78. */
  79. public static function setRetryAfter(string $url, string $proxy, string $retryAfter): int {
  80. $txt = self::getRetryAfterFile($url, $proxy);
  81. if ($txt === '') {
  82. return 0;
  83. }
  84. $limits = FreshRSS_Context::systemConf()->limits;
  85. if (ctype_digit($retryAfter)) {
  86. $retryAfter = time() + (int)$retryAfter;
  87. } else {
  88. $retryAfter = \SimplePie\Misc::parse_date($retryAfter) ?:
  89. (time() + max(600, $limits['retry_after_default'] ?? 0));
  90. }
  91. $retryAfter = min($retryAfter, time() + max(3600, $limits['retry_after_max'] ?? 0));
  92. @mkdir(self::RETRY_AFTER_PATH);
  93. if (!touch($txt, $retryAfter)) {
  94. Minz_Log::error('Failed to set Retry-After for ' . $url);
  95. return 0;
  96. }
  97. return $retryAfter;
  98. }
  99. /**
  100. * @param array<mixed> $curl_params
  101. * @return array<mixed>
  102. */
  103. public static function sanitizeCurlParams(array $curl_params): array {
  104. $safe_params = [
  105. CURLOPT_COOKIE,
  106. CURLOPT_COOKIEFILE,
  107. CURLOPT_FOLLOWLOCATION, // We filter this value later, only allowing `false`
  108. CURLOPT_HTTPHEADER,
  109. CURLOPT_MAXREDIRS,
  110. CURLOPT_POST,
  111. CURLOPT_POSTFIELDS,
  112. CURLOPT_PROXY,
  113. CURLOPT_PROXYTYPE,
  114. CURLOPT_USERAGENT,
  115. ];
  116. foreach ($curl_params as $k => $_) {
  117. if (!in_array($k, $safe_params, true)) {
  118. unset($curl_params[$k]);
  119. continue;
  120. }
  121. // Allow only an empty value just to enable the libcurl cookie engine
  122. if ($k === CURLOPT_COOKIEFILE) {
  123. $curl_params[$k] = '';
  124. }
  125. // Remove HTTP authentication headers problematic for security
  126. if ($k === CURLOPT_HTTPHEADER && is_array($curl_params[$k])) {
  127. $curl_params[$k] = array_filter($curl_params[$k],
  128. fn($header) => is_string($header) && !preg_match('/^(Remote[-_\s]*User|X[-_\s]*WebAuth[-_\s]*User)\\s*:/i', $header));
  129. }
  130. }
  131. return $curl_params;
  132. }
  133. private static function idn_to_puny(string $url): string {
  134. if (function_exists('idn_to_ascii')) {
  135. $idn = parse_url($url, PHP_URL_HOST);
  136. if (is_string($idn) && $idn != '') {
  137. $puny = idn_to_ascii($idn);
  138. $pos = strpos($url, $idn);
  139. if ($puny != false && $pos !== false) {
  140. $url = substr_replace($url, $puny, $pos, strlen($idn));
  141. }
  142. }
  143. }
  144. return $url;
  145. }
  146. public static function checkUrl(string $url, bool $fixScheme = true): string|false {
  147. $url = trim($url);
  148. if ($url == '') {
  149. return '';
  150. }
  151. if ($fixScheme && preg_match('#^https?://#i', $url) !== 1) {
  152. $url = 'https://' . ltrim($url, '/');
  153. }
  154. $url = self::idn_to_puny($url); // https://bugs.php.net/bug.php?id=53474
  155. $urlRelaxed = str_replace('_', 'z', $url); //PHP discussion #64948 Underscore
  156. if (is_string(filter_var($urlRelaxed, FILTER_VALIDATE_URL))) {
  157. return $url;
  158. } else {
  159. return false;
  160. }
  161. }
  162. /**
  163. * Remove the charset meta information of an HTML document, e.g.:
  164. * `<meta charset="..." />`
  165. * `<meta http-equiv="Content-Type" content="text/html; charset=...">`
  166. */
  167. private static function stripHtmlMetaCharset(string $html): string {
  168. return preg_replace('/<meta\s[^>]*charset\s*=\s*[^>]+>/i', '', $html, 1) ?? '';
  169. }
  170. /**
  171. * Set an XML preamble to enforce the HTML content type charset received by HTTP.
  172. * @param string $html the raw downloaded HTML content
  173. * @param string $contentType an HTTP Content-Type such as 'text/html; charset=utf-8'
  174. * @return string an HTML string with XML encoding information for DOMDocument::loadHTML()
  175. */
  176. private static function enforceHttpEncoding(string $html, string $contentType = ''): string {
  177. $httpCharset = preg_match('/\bcharset=([0-9a-z_-]{2,12})$/i', $contentType, $matches) === 1 ? $matches[1] : '';
  178. if ($httpCharset == '') {
  179. // No charset defined by HTTP
  180. if (preg_match('/<meta\s[^>]*charset\s*=[\s\'"]*UTF-?8\b/i', substr($html, 0, 2048))) {
  181. // Detect UTF-8 even if declared too deep in HTML for DOMDocument
  182. $httpCharset = 'UTF-8';
  183. } else {
  184. // Do nothing
  185. return $html;
  186. }
  187. }
  188. $httpCharsetNormalized = \SimplePie\Misc::encoding($httpCharset);
  189. if (in_array($httpCharsetNormalized, ['windows-1252', 'US-ASCII'], true)) {
  190. // Default charset for HTTP, do nothing
  191. return $html;
  192. }
  193. if (substr($html, 0, 3) === "\xEF\xBB\xBF" || // UTF-8 BOM
  194. substr($html, 0, 2) === "\xFF\xFE" || // UTF-16 Little Endian BOM
  195. substr($html, 0, 2) === "\xFE\xFF" || // UTF-16 Big Endian BOM
  196. substr($html, 0, 4) === "\xFF\xFE\x00\x00" || // UTF-32 Little Endian BOM
  197. substr($html, 0, 4) === "\x00\x00\xFE\xFF") { // UTF-32 Big Endian BOM
  198. // Existing byte order mark, do nothing
  199. return $html;
  200. }
  201. if (preg_match('/^<[?]xml[^>]+encoding\b/', substr($html, 0, 64))) {
  202. // Existing XML declaration, do nothing
  203. return $html;
  204. }
  205. if ($httpCharsetNormalized !== 'UTF-8') {
  206. // Try to change encoding to UTF-8 using mbstring or iconv or intl
  207. $utf8 = \SimplePie\Misc::change_encoding($html, $httpCharsetNormalized, 'UTF-8');
  208. if (is_string($utf8)) {
  209. $html = self::stripHtmlMetaCharset($utf8);
  210. $httpCharsetNormalized = 'UTF-8';
  211. }
  212. }
  213. if ($httpCharsetNormalized === 'UTF-8') {
  214. // Save encoding information as Unicode BOM
  215. return "\xEF\xBB\xBF" . $html;
  216. }
  217. // Give up
  218. return $html;
  219. }
  220. /**
  221. * Set an HTML base URL to the HTML content if there is none.
  222. * @param string $html the raw downloaded HTML content
  223. * @param string $href the HTML base URL
  224. * @return string an HTML string
  225. */
  226. private static function enforceHtmlBase(string $html, string $href): string {
  227. $doc = new DOMDocument();
  228. $doc->loadHTML($html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING);
  229. if ($doc->documentElement === null) {
  230. return '';
  231. }
  232. $xpath = new DOMXPath($doc);
  233. $bases = $xpath->evaluate('//base');
  234. if (!($bases instanceof DOMNodeList) || $bases->length === 0) {
  235. $base = $doc->createElement('base');
  236. if ($base === false) {
  237. return $html;
  238. }
  239. $base->setAttribute('href', $href);
  240. $head = null;
  241. $heads = $xpath->evaluate('//head');
  242. if ($heads instanceof DOMNodeList && $heads->length > 0) {
  243. $head = $heads->item(0);
  244. }
  245. if ($head instanceof DOMElement) {
  246. $head->insertBefore($base, $head->firstChild);
  247. } else {
  248. $doc->documentElement->insertBefore($base, $doc->documentElement->firstChild);
  249. }
  250. }
  251. // Save the start of HTML because libxml2 saveHTML() risks scrambling it
  252. $htmlPos = stripos($html, '<html');
  253. $htmlStart = $htmlPos === false || $htmlPos > 512 ? '' : substr($html, 0, $htmlPos);
  254. $html = $doc->saveHTML() ?: $html;
  255. if ($htmlStart !== '' && !str_starts_with($html, $htmlStart)) {
  256. // libxml2 saveHTML() risks removing Unicode BOM and XML declaration,
  257. // which affects future detection of charset encoding, so manually restore it
  258. $htmlPos = stripos($html, '<html');
  259. $html = $htmlPos === false || $htmlPos > 512 ? $html : $htmlStart . substr($html, $htmlPos);
  260. }
  261. return $html;
  262. }
  263. public static function compareURLOrigins(string $url1, string $url2): bool {
  264. $url1 = parse_url(strtolower($url1));
  265. $url2 = parse_url(strtolower($url2));
  266. if ($url1 === false || $url2 === false) {
  267. return false;
  268. }
  269. foreach ([&$url1, &$url2] as &$url) {
  270. $url['port'] ??= match ($url['scheme']) {
  271. 'http' => 80,
  272. 'https' => 443,
  273. default => 0,
  274. };
  275. }
  276. return ($url1['scheme'] ?? '') === ($url2['scheme'] ?? '') &&
  277. ($url1['host'] ?? '') === ($url2['host'] ?? '') &&
  278. ($url1['port'] ?? '') === ($url2['port'] ?? '');
  279. }
  280. /**
  281. * Return 0 if values on either side are equal ignoring the HTTP vs HTTPS differences, or 1/-1 if they differ.
  282. */
  283. public static function compareUrlIgnoringHttps(string $url1, string $url2): int {
  284. $normalizeScheme = static fn(string $url): string => preg_replace('#^https?://#i', '//', trim($url)) ?? $url;
  285. return $normalizeScheme($url1) <=> $normalizeScheme($url2);
  286. }
  287. /**
  288. * Returns a value for CURLOPT_RESOLVE as an array, null if no allowed IPs were found, false if the domain failed to resolve.
  289. *
  290. * Can also be used for checking if the CURLOPT_PROXY value is allowed, by providing a proxy URL with the `for_proxy` parameter set to `true`.
  291. * In that case, a string value will be returned with the hostname resolved to an IP if allowed.
  292. *
  293. * @return array<string>|string|null|false
  294. */
  295. public static function getCurlResolveInfo(string $url, bool $for_proxy = false): array|string|null|false {
  296. // Parse the original URL first so that credentials keep their original case (only the host is case-insensitive).
  297. $parsedOriginal = parse_url($url);
  298. $url = strtolower($url);
  299. $parsed = parse_url($url);
  300. if ($parsed === false || $parsedOriginal === false) {
  301. return false;
  302. }
  303. $host = $parsed['host'] ?? null;
  304. $scheme = $parsed['scheme'] ?? null;
  305. if ($host === null || $scheme === null) {
  306. return false;
  307. }
  308. $credentials = '';
  309. $user = $parsedOriginal['user'] ?? null;
  310. $pass = $parsedOriginal['pass'] ?? null;
  311. if (is_string($user) && is_string($pass)) {
  312. $credentials = "$user:$pass@";
  313. }
  314. if (str_starts_with($host, '[') && str_ends_with($host, ']')) {
  315. if (strlen($host) === 2) {
  316. return false;
  317. }
  318. $host = substr($host, 1, strlen($host) - 2);
  319. }
  320. $internal_host_allowlist = getenv('INTERNAL_HOST_ALLOWLIST');
  321. if (is_string($internal_host_allowlist) && $internal_host_allowlist !== '') {
  322. $internal_host_allowlist = preg_split('/\s+/', $internal_host_allowlist, -1, PREG_SPLIT_NO_EMPTY);
  323. }
  324. if (!is_array($internal_host_allowlist) || empty($internal_host_allowlist)) {
  325. $internal_host_allowlist = FreshRSS_Context::systemConf()->internal_host_allowlist;
  326. }
  327. $port = parse_url($url)['port'] ?? match ($scheme) {
  328. 'http' => 80,
  329. 'https' => 443,
  330. 'socks4' => 1080,
  331. 'socks4a' => 1080,
  332. 'socks5' => 1080,
  333. 'socks5h' => 1080,
  334. default => 0,
  335. };
  336. if (in_array('*', $internal_host_allowlist, true)) {
  337. if ($for_proxy) {
  338. if (filter_var($host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false) {
  339. return $credentials . "[$host]:$port";
  340. }
  341. return $credentials . "$host:$port";
  342. }
  343. return []; // Disables SSRF checks entirely (unsafe)
  344. }
  345. $resolve_str = "$host:$port:";
  346. $ips_ok = [];
  347. $ips = [];
  348. $records = [];
  349. if (filter_var($host, FILTER_VALIDATE_IP) !== false) {
  350. $ips[] = $host;
  351. } elseif (isset(self::$resolve_ok[$host])) {
  352. $ips = self::$resolve_ok[$host];
  353. } else {
  354. $records = @dns_get_record($host, DNS_A + DNS_AAAA);
  355. if ($records === false) {
  356. return false;
  357. }
  358. foreach ($records as $record) {
  359. $ip = $record['ip'] ?? $record['ipv6'];
  360. if (is_string($ip)) {
  361. $ips[] = $ip;
  362. }
  363. }
  364. self::$resolve_ok[$host] = $ips;
  365. }
  366. $cidr_allowlist = array_filter($internal_host_allowlist, fn($v, $_) => str_contains($v, '/'), ARRAY_FILTER_USE_BOTH);
  367. foreach ($ips as $ip) {
  368. $allowlist_str = "$ip:$port";
  369. $add_ip = $ip;
  370. if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false) {
  371. $allowlist_str = "[$ip]:$port";
  372. $add_ip = "[$ip]";
  373. }
  374. foreach ($cidr_allowlist as $cidr) {
  375. if (self::checkCIDR($ip, $cidr)) {
  376. $ips_ok[] = $add_ip;
  377. continue 2;
  378. }
  379. }
  380. if (in_array($allowlist_str, $internal_host_allowlist, true) ||
  381. in_array("$host:$port", $internal_host_allowlist, true)) {
  382. $ips_ok[] = $add_ip;
  383. continue;
  384. }
  385. if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE) === false) {
  386. continue;
  387. }
  388. // Extra check because the above one might not be enough: https://github.com/php/php-src/issues/16944
  389. // Workaround is available by using `FILTER_FLAG_GLOBAL_RANGE` instead, but that was only added in PHP 8.2, and we need to support PHP 8.1+
  390. foreach (self::PRIVATE_SUBNETS as $cidr) {
  391. if (self::checkCIDR($ip, $cidr)) {
  392. continue 2;
  393. }
  394. }
  395. $ips_ok[] = $add_ip;
  396. }
  397. if (count($ips_ok) > 0) {
  398. if (count($records) > 0 || isset(self::$resolve_ok[$host])) {
  399. if ($for_proxy) {
  400. // $ips_ok[0] is already bracketed when it is an IPv6 address
  401. return $credentials . "$ips_ok[0]:$port";
  402. }
  403. $resolve_str .= implode(',', $ips_ok);
  404. return [$resolve_str];
  405. }
  406. if (filter_var($host, FILTER_VALIDATE_IP) !== false) {
  407. if ($for_proxy) {
  408. if (filter_var($host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false) {
  409. return $credentials . "[$host]:$port";
  410. }
  411. return $credentials . "$host:$port";
  412. }
  413. // No resolve overrides since the URL only contained an IP, not a domain
  414. return [];
  415. }
  416. }
  417. if (count($ips) === 0) {
  418. return false;
  419. }
  420. return null;
  421. }
  422. /**
  423. * @param non-empty-string $url
  424. * @param string|null $cachePath path to cache file, or `null` to disable caching
  425. * @param string $type {html,ico,json,opml,xml}
  426. * @param array<string,mixed> $attributes May contain user-defined cURL options in `$attributes['curl_params']`
  427. * @param array<int,mixed> $curl_options Internal overrides of cURL options
  428. * @return array{body:string,effective_url:string,redirect_count:int,fail:bool,status:int,error:string}
  429. * `status` is the HTTP response code (e.g. 200, 404), or a custom negative value:
  430. * * `-200` served from local cache;
  431. * * `-429` blocked by active `Retry-After` period;
  432. * * `-500` `curl_init()` failure.
  433. */
  434. public static function httpGet(string $url, ?string $cachePath = null, string $type = 'html', array $attributes = [], array $curl_options = []): array {
  435. $limits = FreshRSS_Context::systemConf()->limits;
  436. $feed_timeout = empty($attributes['timeout']) || !is_numeric($attributes['timeout']) ? 0 : intval($attributes['timeout']);
  437. if ($cachePath !== null) {
  438. $cacheMtime = @filemtime($cachePath);
  439. if ($cacheMtime !== false && $cacheMtime > time() - intval($limits['cache_duration'])) {
  440. $body = @file_get_contents($cachePath);
  441. if ($body != false) {
  442. if (FreshRSS_Context::systemConf()->simplepie_syslog_enabled) {
  443. syslog(LOG_DEBUG, 'FreshRSS uses cache for ' . \SimplePie\Misc::url_remove_credentials($url));
  444. }
  445. return ['body' => $body, 'effective_url' => $url, 'redirect_count' => 0, 'fail' => false, 'status' => -200, 'error' => ''];
  446. }
  447. }
  448. }
  449. if (rand(0, 30) === 1) { // Remove old cache once in a while
  450. cleanCache(CLEANCACHE_HOURS);
  451. }
  452. $accept = '';
  453. $proxy = is_string(FreshRSS_Context::systemConf()->curl_options[CURLOPT_PROXY] ?? null) ? FreshRSS_Context::systemConf()->curl_options[CURLOPT_PROXY] : '';
  454. $proxy_type = is_int(FreshRSS_Context::systemConf()->curl_options[CURLOPT_PROXYTYPE] ?? null) ?
  455. FreshRSS_Context::systemConf()->curl_options[CURLOPT_PROXYTYPE] : 0;
  456. $options = []; // User-defined cURL options
  457. if (is_array($attributes['curl_params'] ?? null)) {
  458. $options = self::sanitizeCurlParams($attributes['curl_params']);
  459. $proxy = is_string($options[CURLOPT_PROXY] ?? null) ? $options[CURLOPT_PROXY] : $proxy;
  460. $proxy_type = is_int($options[CURLOPT_PROXYTYPE] ?? null) ? $options[CURLOPT_PROXYTYPE] : $proxy_type;
  461. if (is_array($options[CURLOPT_HTTPHEADER] ?? null)) {
  462. // Add Accept header if it is not set
  463. if (preg_grep('/^Accept\\s*:/i', $options[CURLOPT_HTTPHEADER]) === false) {
  464. $options[CURLOPT_HTTPHEADER][] = 'Accept: ' . $accept;
  465. }
  466. }
  467. }
  468. $proxy = is_string($curl_options[CURLOPT_PROXY] ?? null) ? $curl_options[CURLOPT_PROXY] : $proxy;
  469. $proxy_type = is_int($curl_options[CURLOPT_PROXYTYPE] ?? null) ? $curl_options[CURLOPT_PROXYTYPE] : $proxy_type;
  470. if (($retryAfter = FreshRSS_http_Util::getRetryAfter($url, $proxy)) > 0) {
  471. Minz_Log::warning('For that domain, will first retry after ' . date('c', $retryAfter) . '. ' . \SimplePie\Misc::url_remove_credentials($url));
  472. return ['body' => '', 'effective_url' => $url, 'redirect_count' => 0, 'fail' => true, 'status' => -429, 'error' => ''];
  473. }
  474. if (FreshRSS_Context::systemConf()->simplepie_syslog_enabled) {
  475. syslog(LOG_INFO, 'FreshRSS GET ' . $type . ' ' . \SimplePie\Misc::url_remove_credentials($url));
  476. }
  477. switch ($type) {
  478. case 'json':
  479. $accept = 'application/json,application/feed+json,application/javascript;q=0.9,text/javascript;q=0.8,*/*;q=0.7';
  480. break;
  481. case 'opml':
  482. $accept = 'text/x-opml,text/xml;q=0.9,application/xml;q=0.9,*/*;q=0.8';
  483. break;
  484. case 'xml':
  485. $accept = 'application/xml,application/xhtml+xml,text/xml;q=0.9,*/*;q=0.8';
  486. break;
  487. case 'ico':
  488. $accept = 'image/x-icon,image/vnd.microsoft.icon,image/ico,image/png,image/svg+xml,image/*;q=0.8,*/*;q=0.1';
  489. break;
  490. case 'html':
  491. default:
  492. $accept = 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8';
  493. break;
  494. }
  495. $original_url = $url;
  496. $fail = false;
  497. $redirs = 0;
  498. $max_redirs = $curl_options[CURLOPT_MAXREDIRS] ?? $options[CURLOPT_MAXREDIRS] ?? FreshRSS_Context::systemConf()->curl_options[CURLOPT_MAXREDIRS] ?? null;
  499. if (!is_int($max_redirs)) {
  500. $max_redirs = 4;
  501. }
  502. while (true) {
  503. $url = is_string($url) ? $url : '';
  504. $resolve = [];
  505. if ($proxy === '') {
  506. $resolve = self::getCurlResolveInfo($url);
  507. if ($resolve === null) {
  508. Minz_Log::warning('Fetching this URL is not allowed, because the host’s IP is not in the allowlist [' .
  509. \SimplePie\Misc::url_remove_credentials($url) . ']');
  510. return ['body' => '', 'effective_url' => '', 'redirect_count' => 0, 'fail' => true, 'status' => -500, 'error' => ''];
  511. } elseif ($resolve === false) {
  512. return ['body' => '', 'effective_url' => '', 'redirect_count' => 0, 'fail' => true, 'status' => -500, 'error' => ''];
  513. }
  514. if (!empty($resolve)) {
  515. $curl_options[CURLOPT_RESOLVE] = $resolve; // Prevent DNS rebinding
  516. }
  517. } else {
  518. defined('CURLPROXY_HTTPS') or define('CURLPROXY_HTTPS', 2); // Compatibility cURL 7.51
  519. $proxy_scheme = match ($proxy_type) {
  520. CURLPROXY_HTTP => 'http',
  521. CURLPROXY_HTTPS => 'https',
  522. CURLPROXY_SOCKS4 => 'socks4',
  523. CURLPROXY_SOCKS4A => 'socks4a',
  524. CURLPROXY_SOCKS5 => 'socks5',
  525. CURLPROXY_SOCKS5_HOSTNAME => 'socks5h',
  526. default => null,
  527. };
  528. if ($proxy_scheme === null) {
  529. // Unsupported proxy type
  530. return ['body' => '', 'effective_url' => '', 'redirect_count' => 0, 'fail' => true, 'status' => -500, 'error' => ''];
  531. }
  532. $proxy_url = "$proxy_scheme://$proxy"; // CURLOPT_PROXY ($proxy) is formatted as user:pass@hostname:port, with the part before @ being optional
  533. $resolve = self::getCurlResolveInfo($proxy_url, for_proxy: true);
  534. if ($resolve === null) {
  535. Minz_Log::warning('Failed to fetch this URL, because the proxy’s IP is not in the allowlist [' .
  536. \SimplePie\Misc::url_remove_credentials($url) . '] [' .
  537. \SimplePie\Misc::url_remove_credentials($proxy_url) . ']');
  538. return ['body' => '', 'effective_url' => '', 'redirect_count' => 0, 'fail' => true, 'status' => -500, 'error' => ''];
  539. } elseif ($resolve === false) {
  540. return ['body' => '', 'effective_url' => '', 'redirect_count' => 0, 'fail' => true, 'status' => -500, 'error' => ''];
  541. }
  542. // Translate from a hostname:port value to ip:port, in order to avoid DNS rebinding
  543. $curl_options[CURLOPT_PROXY] = $resolve;
  544. if (defined('CURLOPT_PROXY_SSL_VERIFYHOST')) {
  545. // Skip verifying the hostname (a bit unsafe, but needed since
  546. // there is no CURLOPT_RESOLVE equivalent for proxy hostnames)
  547. $curl_options[CURLOPT_PROXY_SSL_VERIFYHOST] = 0;
  548. }
  549. }
  550. // TODO: Implement HTTP 1.1 conditional GET If-Modified-Since
  551. $ch = curl_init();
  552. if ($ch === false || $url === '') {
  553. return ['body' => '', 'effective_url' => '', 'redirect_count' => 0, 'fail' => true, 'status' => -500, 'error' => ''];
  554. }
  555. curl_setopt_array($ch, [
  556. CURLOPT_URL => $url,
  557. CURLOPT_HTTPHEADER => ['Accept: ' . $accept],
  558. CURLOPT_USERAGENT => FRESHRSS_USERAGENT,
  559. CURLOPT_CONNECTTIMEOUT => $feed_timeout > 0 ? $feed_timeout : $limits['timeout'],
  560. CURLOPT_TIMEOUT => $feed_timeout > 0 ? $feed_timeout : $limits['timeout'],
  561. CURLOPT_RETURNTRANSFER => true,
  562. CURLOPT_ACCEPT_ENCODING => '', //Enable all encodings
  563. //CURLOPT_VERBOSE => 1, // To debug sent HTTP headers
  564. ]);
  565. curl_setopt_array($ch, $options);
  566. curl_setopt_array($ch, FreshRSS_Context::systemConf()->curl_options);
  567. $responseHeaders = '';
  568. curl_setopt($ch, CURLOPT_HEADERFUNCTION, function (\CurlHandle $ch, string $header) use (&$responseHeaders) {
  569. if (trim($header) !== '') { // Skip e.g. separation with trailer headers
  570. $responseHeaders .= $header;
  571. }
  572. return strlen($header);
  573. });
  574. if (isset($attributes['ssl_verify'])) {
  575. curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, empty($attributes['ssl_verify']) ? 0 : 2);
  576. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, (bool)$attributes['ssl_verify']);
  577. if (empty($attributes['ssl_verify'])) {
  578. curl_setopt($ch, CURLOPT_SSL_CIPHER_LIST, 'DEFAULT@SECLEVEL=1');
  579. }
  580. }
  581. if (defined('CURLOPT_PROTOCOLS_STR') && is_int(CURLOPT_PROTOCOLS_STR)) {
  582. $curl_options[CURLOPT_PROTOCOLS_STR] = 'http,https';
  583. if (defined('CURLOPT_REDIR_PROTOCOLS_STR') && is_int(CURLOPT_REDIR_PROTOCOLS_STR)) {
  584. $curl_options[CURLOPT_REDIR_PROTOCOLS_STR] = 'http,https';
  585. }
  586. } elseif (defined('CURLPROTO_HTTP') && defined('CURLPROTO_HTTPS')) {
  587. // Legacy PHP 8.2-
  588. if (defined('CURLOPT_PROTOCOLS')) {
  589. $curl_options[CURLOPT_PROTOCOLS] = CURLPROTO_HTTP | CURLPROTO_HTTPS;
  590. }
  591. if (defined('CURLOPT_REDIR_PROTOCOLS')) {
  592. $curl_options[CURLOPT_REDIR_PROTOCOLS] = CURLPROTO_HTTP | CURLPROTO_HTTPS;
  593. }
  594. }
  595. curl_setopt_array($ch, $curl_options);
  596. curl_setopt($ch, CURLOPT_FOLLOWLOCATION, false); // We handle HTTP redirections manually for security
  597. $body = curl_exec($ch);
  598. $c_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  599. $c_content_type = '' . curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
  600. $c_effective_url = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
  601. $c_error = curl_error($ch);
  602. $headers = [];
  603. if ($body !== false) {
  604. $responseHeaders .= "\r\n";
  605. $responseHeaders = \SimplePie\HTTP\Parser::prepareHeaders($responseHeaders);
  606. $parser = new \SimplePie\HTTP\Parser($responseHeaders);
  607. if ($parser->parse()) {
  608. $headers = $parser->headers;
  609. }
  610. }
  611. if (in_array($c_status, [301, 302, 303, 307, 308], true)) {
  612. // Handle the redirect by making another request
  613. $location = \SimplePie\Misc::absolutize_url($headers['location'] ?? $url, $url);
  614. if ($location === false) {
  615. $location = $url;
  616. }
  617. if (!self::compareURLOrigins($url, $location)) {
  618. unset($curl_options[CURLOPT_COOKIE]);
  619. unset($curl_options[CURLOPT_USERPWD]);
  620. unset($options[CURLOPT_COOKIE]);
  621. unset($options[CURLOPT_USERPWD]);
  622. if (is_array($options[CURLOPT_HTTPHEADER] ?? null)) {
  623. $options[CURLOPT_HTTPHEADER] = array_filter($options[CURLOPT_HTTPHEADER], fn(mixed $header): bool =>
  624. is_string($header) && !preg_match('/^(Cookie|Authorization)\\s*:/i', $header));
  625. }
  626. if (is_array($curl_options[CURLOPT_HTTPHEADER] ?? null)) {
  627. $curl_options[CURLOPT_HTTPHEADER] = array_filter($curl_options[CURLOPT_HTTPHEADER], fn(mixed $header): bool =>
  628. is_string($header) && !preg_match('/^(Cookie|Authorization)\\s*:/i', $header));
  629. }
  630. }
  631. if ($max_redirs >= 0) {
  632. $redirs++;
  633. }
  634. if ($redirs > $max_redirs) {
  635. Minz_Log::warning('Error fetching content: Too many redirects were hit [' . \SimplePie\Misc::url_remove_credentials($original_url) . ']');
  636. break;
  637. }
  638. if ((isset($options[CURLOPT_POST]) || isset($curl_options[CURLOPT_POST])) &&
  639. in_array($c_status, [301, 302, 303], true)) { // Not for 307 and 308, which must not change the HTTP method
  640. unset($curl_options[CURLOPT_POST]);
  641. unset($curl_options[CURLOPT_POSTFIELDS]);
  642. unset($options[CURLOPT_POST]);
  643. unset($options[CURLOPT_POSTFIELDS]);
  644. if (is_array($options[CURLOPT_HTTPHEADER] ?? null)) {
  645. $options[CURLOPT_HTTPHEADER] = array_filter($options[CURLOPT_HTTPHEADER], fn(mixed $header): bool =>
  646. is_string($header) && !str_starts_with(strtolower(trim($header)), 'content-type:'));
  647. }
  648. if (is_array($curl_options[CURLOPT_HTTPHEADER] ?? null)) {
  649. $curl_options[CURLOPT_HTTPHEADER] = array_filter($curl_options[CURLOPT_HTTPHEADER], fn(mixed $header): bool =>
  650. is_string($header) && !str_starts_with(strtolower(trim($header)), 'content-type:'));
  651. }
  652. }
  653. $url = $location;
  654. continue;
  655. }
  656. $fail = $c_status != 200 || $c_error != '' || $body === false;
  657. if ($fail) {
  658. $body = '';
  659. Minz_Log::warning('Error fetching content: HTTP code ' . $c_status . ': ' . $c_error . ' ' . $url);
  660. if (in_array($c_status, [429, 503], true)) {
  661. $retryAfter = FreshRSS_http_Util::setRetryAfter($url, $proxy, $headers['retry-after'] ?? '');
  662. if ($c_status === 429) {
  663. $errorMessage = 'HTTP 429 Too Many Requests! [' . \SimplePie\Misc::url_remove_credentials($url) . ']';
  664. } elseif ($c_status === 503) {
  665. $errorMessage = 'HTTP 503 Service Unavailable! [' . \SimplePie\Misc::url_remove_credentials($url) . ']';
  666. }
  667. if ($retryAfter > 0) {
  668. $errorMessage .= ' We may retry after ' . date('c', $retryAfter);
  669. }
  670. }
  671. } elseif (!is_string($body) || strlen($body) === 0) { // TODO: Implement HTTP 410 Gone
  672. $body = '';
  673. } else {
  674. if (in_array($type, ['html', 'json', 'opml', 'xml'], true)) {
  675. $body = trim($body, " \n\r\t\v"); // Do not trim \x00 to avoid breaking a BOM
  676. }
  677. if (in_array($type, ['html', 'xml', 'opml'], true)) {
  678. $body = self::enforceHttpEncoding($body, $c_content_type);
  679. }
  680. if (in_array($type, ['html'], true)) {
  681. if (stripos($c_content_type, 'text/plain') !== false) {
  682. // Plain text to be displayed as preformatted text. Prefixed with UTF-8 BOM
  683. $body = "\xEF\xBB\xBF" . '<pre class="text-plain">' . htmlspecialchars($body, ENT_NOQUOTES, 'UTF-8') . '</pre>';
  684. } else {
  685. $body = self::enforceHtmlBase($body, $c_effective_url);
  686. }
  687. }
  688. }
  689. break;
  690. }
  691. if ($cachePath !== null && file_put_contents($cachePath, $body) === false) {
  692. Minz_Log::warning("Error saving cache $cachePath for $url");
  693. }
  694. return ['body' => is_string($body) ? $body : '', 'effective_url' => $c_effective_url, 'redirect_count' => $redirs,
  695. 'fail' => $fail, 'status' => $c_status, 'error' => $c_error];
  696. }
  697. /**
  698. * Converts an IP (v4 or v6) to a binary representation using inet_pton
  699. *
  700. * @param string $ip the IP to convert
  701. * @return string a binary representation of the specified IP
  702. */
  703. private static function ipToBits(string $ip): string {
  704. $binaryip = '';
  705. foreach (str_split(inet_pton($ip) ?: '') as $char) {
  706. $binaryip .= str_pad(decbin(ord($char)), 8, '0', STR_PAD_LEFT);
  707. }
  708. return $binaryip;
  709. }
  710. /**
  711. * Check if an ip belongs to the provided range (in CIDR format)
  712. *
  713. * @param string $ip the IP that we want to verify (ex: 192.168.16.1)
  714. * @param string $range the range to check against (ex: 192.168.16.0/24)
  715. * @return bool true if the IP is in the range, otherwise false
  716. */
  717. private static function checkCIDR(string $ip, string $range): bool {
  718. $binary_ip = self::ipToBits($ip);
  719. if ($binary_ip === '') {
  720. return false;
  721. }
  722. $split = explode('/', $range);
  723. $subnet = $split[0] ?? '';
  724. if ($subnet == '') {
  725. return false;
  726. }
  727. $binary_subnet = self::ipToBits($subnet);
  728. if ($binary_subnet === '') {
  729. return false;
  730. }
  731. if (strlen($binary_ip) !== strlen($binary_subnet)) {
  732. return false; // Do not mix IPv4 and IPv6
  733. }
  734. $mask_bits_str = $split[1] ?? '';
  735. if (!ctype_digit($mask_bits_str)) {
  736. return false;
  737. }
  738. $mask_bits = (int)$mask_bits_str;
  739. $max_mask_bits = str_contains($ip, ':') ? 128 : 32;
  740. if ($mask_bits < 0 || $mask_bits > $max_mask_bits) {
  741. return false; // Reject invalid mask bits lengths
  742. }
  743. if ($mask_bits === 0) {
  744. return true;
  745. }
  746. $ip_net_bits = substr($binary_ip, 0, $mask_bits);
  747. $subnet_bits = substr($binary_subnet, 0, $mask_bits);
  748. return $ip_net_bits === $subnet_bits;
  749. }
  750. /**
  751. * Check if the client (e.g. last proxy) is allowed to send unsafe headers.
  752. * This uses the `TRUSTED_PROXY` environment variable or the `trusted_sources` configuration option to get an array of the authorized ranges,
  753. * The connection IP is obtained from the `CONN_REMOTE_ADDR`
  754. * (if available, to be robust even when using Apache mod_remoteip) or `REMOTE_ADDR` environment variables.
  755. * @return bool true if the sender’s IP is in one of the ranges defined in the configuration, else false
  756. */
  757. public static function checkTrustedIP(): bool {
  758. if (!FreshRSS_Context::hasSystemConf()) {
  759. return false;
  760. }
  761. $remoteIp = Minz_Request::connectionRemoteAddress();
  762. if ($remoteIp === '') {
  763. return false;
  764. }
  765. $trusted = getenv('TRUSTED_PROXY');
  766. if ($trusted != 0 && is_string($trusted)) {
  767. $trusted = preg_split('/\s+/', $trusted, -1, PREG_SPLIT_NO_EMPTY);
  768. }
  769. if (!is_array($trusted) || empty($trusted)) {
  770. $trusted = FreshRSS_Context::systemConf()->trusted_sources;
  771. }
  772. foreach ($trusted as $cidr) {
  773. if (self::checkCIDR($remoteIp, $cidr)) {
  774. return true;
  775. }
  776. }
  777. return false;
  778. }
  779. public static function httpAuthUser(bool $onlyTrusted = true): string {
  780. $auths = array_unique(array_filter(
  781. array_intersect_key($_SERVER, ['REMOTE_USER' => '', 'REDIRECT_REMOTE_USER' => '', 'HTTP_REMOTE_USER' => '', 'HTTP_X_WEBAUTH_USER' => '']),
  782. fn($value) => is_string($value) && $value !== ''
  783. ));
  784. if (count($auths) > 1) {
  785. Minz_Log::warning('Multiple HTTP authentication headers!');
  786. return '';
  787. }
  788. if (!empty($_SERVER['REMOTE_USER']) && is_string($_SERVER['REMOTE_USER'])) {
  789. return $_SERVER['REMOTE_USER'];
  790. }
  791. if (!empty($_SERVER['REDIRECT_REMOTE_USER']) && is_string($_SERVER['REDIRECT_REMOTE_USER'])) {
  792. return $_SERVER['REDIRECT_REMOTE_USER'];
  793. }
  794. if (!$onlyTrusted || self::checkTrustedIP()) {
  795. if (!empty($_SERVER['HTTP_REMOTE_USER']) && is_string($_SERVER['HTTP_REMOTE_USER'])) {
  796. return $_SERVER['HTTP_REMOTE_USER'];
  797. }
  798. if (!empty($_SERVER['HTTP_X_WEBAUTH_USER']) && is_string($_SERVER['HTTP_X_WEBAUTH_USER'])) {
  799. return $_SERVER['HTTP_X_WEBAUTH_USER'];
  800. }
  801. }
  802. return '';
  803. }
  804. }