import URL from '../../url/URL.js'; import * as PropertySymbol from '../../PropertySymbol.js'; import IBrowserWindow from '../../window/IBrowserWindow.js'; import { isIP } from 'net'; import Headers from '../Headers.js'; import IRequestReferrerPolicy from '../types/IRequestReferrerPolicy.js'; import Request from '../Request.js'; const REQUEST_REFERRER_UNSUPPORTED_PROTOCOL_REGEXP = /^(about|blob|data):$/; const REFERRER_POLICIES: IRequestReferrerPolicy[] = [ '', 'no-referrer', 'no-referrer-when-downgrade', 'same-origin', 'origin', 'strict-origin', 'origin-when-cross-origin', 'strict-origin-when-cross-origin', 'unsafe-url' ]; /** * Fetch referrer utility. */ export default class FetchRequestReferrerUtility { /** * Prepares the request before being sent. * * @param originURL Origin URL. * @param request Request. */ public static prepareRequest(originURL: URL, request: Request): void { if (!request.referrerPolicy) { (request.referrerPolicy) = 'strict-origin-when-cross-origin'; } if (request.referrer && request.referrer !== 'no-referrer') { request[PropertySymbol.referrer] = this.getSentReferrer(originURL, request); } else { request[PropertySymbol.referrer] = 'no-referrer'; } } /** * Returns initial referrer. * * @param window Window. * @param referrer Referrer. * @returns Initial referrer. */ public static getInitialReferrer( window: IBrowserWindow, referrer: '' | 'no-referrer' | 'client' | string | URL ): '' | 'no-referrer' | 'client' | URL { if (referrer === '' || referrer === 'no-referrer' || referrer === 'client') { return referrer; } else if (referrer) { const referrerURL = referrer instanceof URL ? referrer : new URL(referrer, window.location); return referrerURL.origin === window.location.origin ? referrerURL : 'client'; } return 'client'; } /** * Returns referrer policy from header. * * @see https://w3c.github.io/webappsec-referrer-policy/#parse-referrer-policy-from-header * @param headers Response headers * @returns Policy. */ public static getReferrerPolicyFromHeader(headers: Headers): IRequestReferrerPolicy { const referrerPolicyHeader = headers.get('Referrer-Policy'); if (!referrerPolicyHeader) { return ''; } const policyTokens = referrerPolicyHeader.split(/[,\s]+/); let policy: IRequestReferrerPolicy = ''; for (const token of policyTokens) { if (token && REFERRER_POLICIES.includes(token)) { policy = token; } } return policy; } /** * Returns the request referrer to be used as the value for the "Referer" header. * * Based on: * https://github.com/node-fetch/node-fetch/blob/main/src/utils/referrer.js (MIT) * * @see https://w3c.github.io/webappsec-referrer-policy/#determine-requests-referrer * @param originURL Origin URL. * @param request Request. * @returns Request referrer. */ private static getSentReferrer( originURL: URL, request: Request ): '' | 'no-referrer' | 'client' | URL { if (request.referrer === 'about:client' && originURL.origin === 'null') { return 'no-referrer'; } const requestURL = new URL(request.url); const referrerURL = request.referrer === 'about:client' ? new URL(originURL.href) : new URL(request.referrer); if (REQUEST_REFERRER_UNSUPPORTED_PROTOCOL_REGEXP.test(referrerURL.protocol)) { return 'no-referrer'; } referrerURL.username = ''; referrerURL.password = ''; referrerURL.hash = ''; switch (request.referrerPolicy) { case 'no-referrer': return 'no-referrer'; case 'origin': return new URL(referrerURL.origin); case 'unsafe-url': return referrerURL; case 'strict-origin': if ( this.isURLPotentiallyTrustWorthy(referrerURL) && !this.isURLPotentiallyTrustWorthy(requestURL) ) { return 'no-referrer'; } return new URL(referrerURL.origin); case 'strict-origin-when-cross-origin': if (referrerURL.origin === requestURL.origin) { return referrerURL; } if ( this.isURLPotentiallyTrustWorthy(referrerURL) && !this.isURLPotentiallyTrustWorthy(requestURL) ) { return 'no-referrer'; } return new URL(referrerURL.origin); case 'same-origin': if (referrerURL.origin === requestURL.origin) { return referrerURL; } return 'no-referrer'; case 'origin-when-cross-origin': if (referrerURL.origin === requestURL.origin) { return referrerURL; } return new URL(referrerURL.origin); case 'no-referrer-when-downgrade': if ( this.isURLPotentiallyTrustWorthy(referrerURL) && !this.isURLPotentiallyTrustWorthy(requestURL) ) { return 'no-referrer'; } return referrerURL; } return 'no-referrer'; } /** * Returns "true" if the request's referrer is potentially trustworthy. * * @see https://w3c.github.io/webappsec-secure-contexts/#is-origin-trustworthy * @param url URL. * @returns "true" if the request's referrer is potentially trustworthy. */ private static isURLPotentiallyTrustWorthy(url: URL): boolean { // 1. If url is "about:blank" or "about:srcdoc", return "Potentially Trustworthy". if (/^about:(blank|srcdoc)$/.test(url.href)) { return true; } // 2. If url's scheme is "data", return "Potentially Trustworthy". if (url.protocol === 'data:') { return true; } // Note: The origin of blob: and filesystem: URLs is the origin of the context in which they were // Created. Therefore, blobs created in a trustworthy origin will themselves be potentially // Trustworthy. if (/^(blob|filesystem):$/.test(url.protocol)) { return true; } // 3. Return the result of executing ยง3.2 Is origin potentially trustworthy? on url's origin. return this.isOriginPotentiallyTrustWorthy(url); } /** * Returns "true" if the request's referrer origin is potentially trustworthy. * * @see https://w3c.github.io/webappsec-secure-contexts/#is-origin-trustworthy * @param url URL. * @returns "true" if the request's referrer origin is potentially trustworthy. */ private static isOriginPotentiallyTrustWorthy(url: URL): boolean { // 1. If origin is an opaque origin, return "Not Trustworthy". // Not applicable // 2. Assert: origin is a tuple origin. // Not for implementations // 3. If origin's scheme is either "https" or "wss", return "Potentially Trustworthy". if (/^(http|ws)s:$/.test(url.protocol)) { return true; } // 4. If origin's host component matches one of the CIDR notations 127.0.0.0/8 or ::1/128 [RFC4632], return "Potentially Trustworthy". const hostIp = url.host.replace(/(^\[)|(]$)/g, ''); const hostIPVersion = isIP(hostIp); if (hostIPVersion === 4 && /^127\./.test(hostIp)) { return true; } if (hostIPVersion === 6 && /^(((0+:){7})|(::(0+:){0,6}))0*1$/.test(hostIp)) { return true; } // 5. If origin's host component is "localhost" or falls within ".localhost", and the user agent conforms to the name resolution rules in [let-localhost-be-localhost], return "Potentially Trustworthy". // We are returning FALSE here because we cannot ensure conformance to // Let-localhost-be-loalhost (https://tools.ietf.org/html/draft-west-let-localhost-be-localhost) if (url.host === 'localhost' || url.host.endsWith('.localhost')) { return false; } // 6. If origin's scheme component is file, return "Potentially Trustworthy". if (url.protocol === 'file:') { return true; } // 7. If origin's scheme component is one which the user agent considers to be authenticated, return "Potentially Trustworthy". // Not supported // 8. If origin has been configured as a trustworthy origin, return "Potentially Trustworthy". // Not supported // 9. Return "Not Trustworthy". return false; } }