@zorilla/puppeteer-extra-plugin-stealth 1.0.0

package/dist/evasions/user-agent-override/README.md

@@ -0,0 +1,53 @@
+## API
+
+
+#### Table of Contents
+
+- [class: Plugin](#class-plugin)
+
+### class: [Plugin](https://github.com/zorillajs/zorilla/blob/ab0047d1af7dc38412744abdb61bcfc35c42dc34/packages/puppeteer-extra-plugin-stealth/evasions/user-agent-override/index.js#L42-L203)
+
+- `opts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options (optional, default `{}`)
+  - `opts.userAgent` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** The user agent to use (default: browser.userAgent())
+  - `opts.locale` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** The locale to use in `Accept-Language` header and in `navigator.languages` (default: `en-US,en`)
+  - `opts.maskLinux` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Wether to hide Linux as platform in the user agent or not - true by default
+
+**Extends: PuppeteerExtraPlugin**
+
+Fixes the UserAgent info (composed of UA string, Accept-Language, Platform, and UA hints).
+
+If you don't provide any values this plugin will default to using the regular UserAgent string (while stripping the headless part).
+Default language is set to "en-US,en", the other settings match the UserAgent string.
+If you are running on Linux, it will mask the settins to look like Windows. This behavior can be disabled with the `maskLinux` option.
+
+By default puppeteer will not set a `Accept-Language` header in headless:
+It's (theoretically) possible to fix that using either `page.setExtraHTTPHeaders` or a `--lang` launch arg.
+Unfortunately `page.setExtraHTTPHeaders` will lowercase everything and launch args are not always available. :)
+
+In addition, the `navigator.platform` property is always set to the host value, e.g. `Linux` which makes detection very easy.
+
+Note: You cannot use the regular `page.setUserAgent()` puppeteer call in your code,
+as it will reset the language and platform values you set with this plugin.
+
+Example:
+
+```javascript
+const puppeteer = require('@zorilla/puppeteer-extra')
+
+const StealthPlugin = require('@zorilla/puppeteer-extra-plugin-stealth')
+const stealth = StealthPlugin()
+// Remove this specific stealth plugin from the default set
+stealth.enabledEvasions.delete('user-agent-override')
+puppeteer.use(stealth)
+
+// Stealth plugins are just regular `puppeteer-extra` plugins and can be added as such
+const UserAgentOverride = require('@zorilla/puppeteer-extra-plugin-stealth/evasions/user-agent-override')
+// Define custom UA and locale
+const ua = UserAgentOverride({
+  userAgent: 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)',
+  locale: 'de-DE,de'
+})
+puppeteer.use(ua)
+```
+
+---

package/dist/evasions/user-agent-override/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/evasions/user-agent-override/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/evasions/user-agent-override/index.js"],"names":[],"mappings":""}

package/dist/evasions/user-agent-override/index.js

@@ -0,0 +1,206 @@
+import { PuppeteerExtraPlugin } from '@zorilla/puppeteer-extra-plugin';
+
+/**
+ * Fixes the UserAgent info (composed of UA string, Accept-Language, Platform, and UA hints).
+ *
+ * If you don't provide any values this plugin will default to using the regular UserAgent string (while stripping the headless part).
+ * Default language is set to "en-US,en", the other settings match the UserAgent string.
+ * If you are running on Linux, it will mask the settins to look like Windows. This behavior can be disabled with the `maskLinux` option.
+ *
+ * By default puppeteer will not set a `Accept-Language` header in headless:
+ * It's (theoretically) possible to fix that using either `page.setExtraHTTPHeaders` or a `--lang` launch arg.
+ * Unfortunately `page.setExtraHTTPHeaders` will lowercase everything and launch args are not always available. :)
+ *
+ * In addition, the `navigator.platform` property is always set to the host value, e.g. `Linux` which makes detection very easy.
+ *
+ * Note: You cannot use the regular `page.setUserAgent()` puppeteer call in your code,
+ * as it will reset the language and platform values you set with this plugin.
+ *
+ * @example
+ * const puppeteer = require("puppeteer-extra")
+ *
+ * const StealthPlugin = require("puppeteer-extra-plugin-stealth")
+ * const stealth = StealthPlugin()
+ * // Remove this specific stealth plugin from the default set
+ * stealth.enabledEvasions.delete("user-agent-override")
+ * puppeteer.use(stealth)
+ *
+ * // Stealth plugins are just regular `puppeteer-extra` plugins and can be added as such
+ * const UserAgentOverride = require("puppeteer-extra-plugin-stealth/evasions/user-agent-override")
+ * // Define custom UA and locale
+ * const ua = UserAgentOverride({ userAgent: "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)", locale: "de-DE,de" })
+ * puppeteer.use(ua)
+ *
+ * @param {Object} [opts] - Options
+ * @param {string} [opts.userAgent] - The user agent to use (default: browser.userAgent())
+ * @param {string} [opts.locale] - The locale to use in `Accept-Language` header and in `navigator.languages` (default: `en-US,en`)
+ * @param {boolean} [opts.maskLinux] - Wether to hide Linux as platform in the user agent or not - true by default
+ *
+ */
+class Plugin extends PuppeteerExtraPlugin {
+  constructor(opts = {}) {
+    super(opts);
+
+    this._headless = false;
+  }
+
+  get name() {
+    return 'stealth/evasions/user-agent-override';
+  }
+
+  get dependencies() {
+    return new Set(['user-preferences']);
+  }
+
+  get defaults() {
+    return {
+      userAgent: null,
+      locale: 'en-US,en',
+      maskLinux: true,
+    };
+  }
+
+  async onPageCreated(page) {
+    // Determine the full user agent string, strip the "Headless" part
+    let ua =
+      this.opts.userAgent ||
+      (await page.browser().userAgent()).replace('HeadlessChrome/', 'Chrome/');
+
+    if (
+      this.opts.maskLinux &&
+      ua.includes('Linux') &&
+      !ua.includes('Android') // Skip Android user agents since they also contain Linux
+    ) {
+      ua = ua.replace(/\(([^)]+)\)/, '(Windows NT 10.0; Win64; x64)'); // Replace the first part in parentheses with Windows data
+    }
+
+    // Full version number from Chrome
+    const uaVersion = ua.includes('Chrome/')
+      ? ua.match(/Chrome\/([\d|.]+)/)[1]
+      : (await page.browser().version()).match(/\/([\d|.]+)/)[1];
+
+    // Get platform identifier (short or long version)
+    const _getPlatform = (extended = false) => {
+      if (ua.includes('Mac OS X')) {
+        return extended ? 'Mac OS X' : 'MacIntel';
+      } else if (ua.includes('Android')) {
+        return 'Android';
+      } else if (ua.includes('Linux')) {
+        return 'Linux';
+      } else {
+        return extended ? 'Windows' : 'Win32';
+      }
+    };
+
+    // Source in C++: https://source.chromium.org/chromium/chromium/src/+/master:components/embedder_support/user_agent_utils.cc;l=55-100
+    const _getBrands = () => {
+      const seed = uaVersion.split('.')[0]; // the major version number of Chrome
+
+      const order = [
+        [0, 1, 2],
+        [0, 2, 1],
+        [1, 0, 2],
+        [1, 2, 0],
+        [2, 0, 1],
+        [2, 1, 0],
+      ][seed % 6];
+      const escapedChars = [' ', ' ', ';'];
+
+      const greaseyBrand = `${escapedChars[order[0]]}Not${
+        escapedChars[order[1]]
+      }A${escapedChars[order[2]]}Brand`;
+
+      const greasedBrandVersionList = [];
+      greasedBrandVersionList[order[0]] = {
+        brand: greaseyBrand,
+        version: '99',
+      };
+      greasedBrandVersionList[order[1]] = {
+        brand: 'Chromium',
+        version: seed,
+      };
+      greasedBrandVersionList[order[2]] = {
+        brand: 'Google Chrome',
+        version: seed,
+      };
+
+      return greasedBrandVersionList;
+    };
+
+    // Return OS version
+    const _getPlatformVersion = () => {
+      if (ua.includes('Mac OS X ')) {
+        return ua.match(/Mac OS X ([^)]+)/)[1];
+      } else if (ua.includes('Android ')) {
+        return ua.match(/Android ([^;]+)/)[1];
+      } else if (ua.includes('Windows ')) {
+        return ua.match(/Windows .*?([\d|.]+);?/)[1];
+      } else {
+        return '';
+      }
+    };
+
+    // Get architecture, this seems to be empty on mobile and x86 on desktop
+    const _getPlatformArch = () => (_getMobile() ? '' : 'x86');
+
+    // Return the Android model, empty on desktop
+    const _getPlatformModel = () =>
+      _getMobile() ? ua.match(/Android.*?;\s([^)]+)/)[1] : '';
+
+    const _getMobile = () => ua.includes('Android');
+
+    const override = {
+      userAgent: ua,
+      platform: _getPlatform(),
+      userAgentMetadata: {
+        brands: _getBrands(),
+        fullVersion: uaVersion,
+        platform: _getPlatform(true),
+        platformVersion: _getPlatformVersion(),
+        architecture: _getPlatformArch(),
+        model: _getPlatformModel(),
+        mobile: _getMobile(),
+      },
+    };
+
+    // In case of headless, override the acceptLanguage in CDP.
+    // This is not preferred, as it messed up the header order.
+    // On headful, we set the user preference language setting instead.
+    if (this._headless) {
+      override.acceptLanguage = this.opts.locale || 'en-US,en';
+    }
+
+    this.debug('onPageCreated - Will set these user agent options', {
+      override,
+      opts: this.opts,
+    });
+
+    const client =
+      typeof page._client === 'function' ? page._client() : page._client;
+    client.send('Network.setUserAgentOverride', override);
+  }
+
+  async beforeLaunch(options) {
+    // Check if launched headless
+    this._headless = options.headless;
+  }
+
+  async beforeConnect() {
+    // Treat browsers using connect() as headless browsers
+    this._headless = true;
+  }
+
+  get data() {
+    return [
+      {
+        name: 'userPreferences',
+        value: {
+          intl: { accept_languages: this.opts.locale || 'en-US,en' },
+        },
+      },
+    ];
+  }
+}
+
+const defaultExport = opts => new Plugin(opts);
+module.exports = defaultExport;

package/dist/evasions/user-agent-override/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/evasions/user-agent-override/index.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,MAAO,SAAQ,oBAAoB;IACvC,YAAY,IAAI,GAAG,EAAE;QACnB,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,sCAAsC,CAAC;IAChD,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,GAAG,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,QAAQ;QACV,OAAO;YACL,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,UAAU;YAClB,SAAS,EAAE,IAAI;SAChB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,IAAI;QACtB,kEAAkE;QAClE,IAAI,EAAE,GACJ,IAAI,CAAC,IAAI,CAAC,SAAS;YACnB,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;QAE3E,IACE,IAAI,CAAC,IAAI,CAAC,SAAS;YACnB,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC;YACpB,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,yDAAyD;UACjF,CAAC;YACD,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,+BAA+B,CAAC,CAAC,CAAC,0DAA0D;QAC7H,CAAC;QAED,kCAAkC;QAClC,MAAM,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC;YACtC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;YAClC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QAE7D,kDAAkD;QAClD,MAAM,YAAY,GAAG,CAAC,QAAQ,GAAG,KAAK,EAAE,EAAE;YACxC,IAAI,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC5B,OAAO,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC;YAC5C,CAAC;iBAAM,IAAI,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBAClC,OAAO,SAAS,CAAC;YACnB,CAAC;iBAAM,IAAI,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBAChC,OAAO,OAAO,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,OAAO,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;YACxC,CAAC;QACH,CAAC,CAAC;QAEF,qIAAqI;QACrI,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,qCAAqC;YAE3E,MAAM,KAAK,GAAG;gBACZ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;aACV,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;YACZ,MAAM,YAAY,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YAErC,MAAM,YAAY,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAC5C,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CACvB,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAElC,MAAM,uBAAuB,GAAG,EAAE,CAAC;YACnC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG;gBAClC,KAAK,EAAE,YAAY;gBACnB,OAAO,EAAE,IAAI;aACd,CAAC;YACF,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG;gBAClC,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,IAAI;aACd,CAAC;YACF,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG;gBAClC,KAAK,EAAE,eAAe;gBACtB,OAAO,EAAE,IAAI;aACd,CAAC;YAEF,OAAO,uBAAuB,CAAC;QACjC,CAAC,CAAC;QAEF,oBAAoB;QACpB,MAAM,mBAAmB,GAAG,GAAG,EAAE;YAC/B,IAAI,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC7B,OAAO,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC;iBAAM,IAAI,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBACnC,OAAO,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,CAAC;iBAAM,IAAI,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBACnC,OAAO,EAAE,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/C,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC,CAAC;QAEF,wEAAwE;QACxE,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAE3D,6CAA6C;QAC7C,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAC7B,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAE1D,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAEhD,MAAM,QAAQ,GAAG;YACf,SAAS,EAAE,EAAE;YACb,QAAQ,EAAE,YAAY,EAAE;YACxB,iBAAiB,EAAE;gBACjB,MAAM,EAAE,UAAU,EAAE;gBACpB,WAAW,EAAE,SAAS;gBACtB,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC;gBAC5B,eAAe,EAAE,mBAAmB,EAAE;gBACtC,YAAY,EAAE,gBAAgB,EAAE;gBAChC,KAAK,EAAE,iBAAiB,EAAE;gBAC1B,MAAM,EAAE,UAAU,EAAE;aACrB;SACF,CAAC;QAEF,2DAA2D;QAC3D,2DAA2D;QAC3D,mEAAmE;QACnE,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC;QAC3D,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,mDAAmD,EAAE;YAC9D,QAAQ;YACR,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAC;QAEH,MAAM,MAAM,GACV,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QACrE,MAAM,CAAC,IAAI,CAAC,8BAA8B,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAAO;QACxB,6BAA6B;QAC7B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,sDAAsD;QACtD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAED,IAAI,IAAI;QACN,OAAO;YACL;gBACE,IAAI,EAAE,iBAAiB;gBACvB,KAAK,EAAE;oBACL,IAAI,EAAE,EAAE,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,UAAU,EAAE;iBAC3D;aACF;SACF,CAAC;IACJ,CAAC;CACF;AAED,MAAM,aAAa,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;AAC/C,MAAM,CAAC,OAAO,GAAG,aAAa,CAAC"}

package/dist/evasions/user-agent-override/package.json

@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "type": "module",
+  "main": "index.js"
+}

package/dist/evasions/webgl.vendor/README.md

@@ -0,0 +1,20 @@
+## API
+
+
+#### Table of Contents
+
+- [class: Plugin](#class-plugin)
+
+### class: [Plugin](https://github.com/zorillajs/zorilla/blob/e6133619b051febed630ada35241664eba59b9fa/packages/puppeteer-extra-plugin-stealth/evasions/webgl.vendor/index.js#L17-L55)
+
+- `opts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options (optional, default `{}`)
+  - `opts.vendor` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** The vendor string to use (default: `Intel Inc.`)
+  - `opts.renderer` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** The renderer string (default: `Intel Iris OpenGL Engine`)
+
+**Extends: PuppeteerExtraPlugin**
+
+Fix WebGL Vendor/Renderer being set to Google in headless mode
+
+Example data (Apple Retina MBP 13): {vendor: "Intel Inc.", renderer: "Intel(R) Iris(TM) Graphics 6100"}
+
+---

package/dist/evasions/webgl.vendor/index.d.ts

@@ -0,0 +1,17 @@
+export default function _default(pluginConfig: any): Plugin;
+/**
+ * Fix WebGL Vendor/Renderer being set to Google in headless mode
+ *
+ * Example data (Apple Retina MBP 13): {vendor: "Intel Inc.", renderer: "Intel(R) Iris(TM) Graphics 6100"}
+ *
+ * @param {Object} [opts] - Options
+ * @param {string} [opts.vendor] - The vendor string to use (default: `Intel Inc.`)
+ * @param {string} [opts.renderer] - The renderer string (default: `Intel Iris OpenGL Engine`)
+ */
+declare class Plugin extends PuppeteerExtraPlugin {
+    constructor(opts?: {});
+    onPageCreated(page: any): Promise<void>;
+}
+import { PuppeteerExtraPlugin } from '@zorilla/puppeteer-extra-plugin';
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/evasions/webgl.vendor/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/evasions/webgl.vendor/index.js"],"names":[],"mappings":"AAsDA,4DAEC;AApDD;;;;;;;;GAQG;AACH;IACE,uBAEC;IAOD,wCA4BC;CACF;qCApDoC,iCAAiC"}

package/dist/evasions/webgl.vendor/index.js

@@ -0,0 +1,57 @@
+import { PuppeteerExtraPlugin } from '@zorilla/puppeteer-extra-plugin';
+
+import withUtils from '../_utils/withUtils.js';
+
+/**
+ * Fix WebGL Vendor/Renderer being set to Google in headless mode
+ *
+ * Example data (Apple Retina MBP 13): {vendor: "Intel Inc.", renderer: "Intel(R) Iris(TM) Graphics 6100"}
+ *
+ * @param {Object} [opts] - Options
+ * @param {string} [opts.vendor] - The vendor string to use (default: `Intel Inc.`)
+ * @param {string} [opts.renderer] - The renderer string (default: `Intel Iris OpenGL Engine`)
+ */
+class Plugin extends PuppeteerExtraPlugin {
+  constructor(opts = {}) {
+    super(opts);
+  }
+
+  get name() {
+    return 'stealth/evasions/webgl.vendor';
+  }
+
+  /* global WebGLRenderingContext WebGL2RenderingContext */
+  async onPageCreated(page) {
+    await withUtils(page).evaluateOnNewDocument((utils, opts) => {
+      const getParameterProxyHandler = {
+        apply: (target, ctx, args) => {
+          const param = (args || [])[0];
+          const result = utils.cache.Reflect.apply(target, ctx, args);
+          // UNMASKED_VENDOR_WEBGL
+          if (param === 37445) {
+            return opts.vendor || 'Intel Inc.'; // default in headless: Google Inc.
+          }
+          // UNMASKED_RENDERER_WEBGL
+          if (param === 37446) {
+            return opts.renderer || 'Intel Iris OpenGL Engine'; // default in headless: Google SwiftShader
+          }
+          return result;
+        },
+      };
+
+      // There's more than one WebGL rendering context
+      // https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext#Browser_compatibility
+      // To find out the original values here: Object.getOwnPropertyDescriptors(WebGLRenderingContext.prototype.getParameter)
+      const addProxy = (obj, propName) => {
+        utils.replaceWithProxy(obj, propName, getParameterProxyHandler);
+      };
+      // For whatever weird reason loops don't play nice with Object.defineProperty, here's the next best thing:
+      addProxy(WebGLRenderingContext.prototype, 'getParameter');
+      addProxy(WebGL2RenderingContext.prototype, 'getParameter');
+    }, this.opts);
+  }
+}
+
+export default function (pluginConfig) {
+  return new Plugin(pluginConfig);
+}

package/dist/evasions/webgl.vendor/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/evasions/webgl.vendor/index.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAE/C;;;;;;;;GAQG;AACH,MAAM,MAAO,SAAQ,oBAAoB;IACvC,YAAY,IAAI,GAAG,EAAE;QACnB,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAED,IAAI,IAAI;QACN,OAAO,+BAA+B,CAAC;IACzC,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,aAAa,CAAC,IAAI;QACtB,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAC1D,MAAM,wBAAwB,GAAG;gBAC/B,KAAK,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;oBAC3B,MAAM,KAAK,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC9B,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;oBAC5D,wBAAwB;oBACxB,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;wBACpB,OAAO,IAAI,CAAC,MAAM,IAAI,YAAY,CAAC,CAAC,mCAAmC;oBACzE,CAAC;oBACD,0BAA0B;oBAC1B,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;wBACpB,OAAO,IAAI,CAAC,QAAQ,IAAI,0BAA0B,CAAC,CAAC,0CAA0C;oBAChG,CAAC;oBACD,OAAO,MAAM,CAAC;gBAChB,CAAC;aACF,CAAC;YAEF,gDAAgD;YAChD,gGAAgG;YAChG,uHAAuH;YACvH,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;gBACjC,KAAK,CAAC,gBAAgB,CAAC,GAAG,EAAE,QAAQ,EAAE,wBAAwB,CAAC,CAAC;YAClE,CAAC,CAAC;YACF,0GAA0G;YAC1G,QAAQ,CAAC,qBAAqB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YAC1D,QAAQ,CAAC,sBAAsB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QAC7D,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY;IACnC,OAAO,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;AAClC,CAAC"}

package/dist/evasions/webgl.vendor/package.json

@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "type": "module",
+  "main": "index.js"
+}

package/dist/evasions/window.outerdimensions/README.md

@@ -0,0 +1,17 @@
+## API
+
+
+#### Table of Contents
+
+- [class: Plugin](#class-plugin)
+
+### class: [Plugin](https://github.com/zorillajs/zorilla/blob/e6133619b051febed630ada35241664eba59b9fa/packages/puppeteer-extra-plugin-stealth/evasions/window.outerdimensions/index.js#L9-L40)
+
+- `opts` (optional, default `{}`)
+
+**Extends: PuppeteerExtraPlugin**
+
+Fix missing window.outerWidth/window.outerHeight in headless mode
+Will also set the viewport to match window size, unless specified by user
+
+---

package/dist/evasions/window.outerdimensions/index.d.ts

@@ -0,0 +1,13 @@
+export default function _default(pluginConfig: any): Plugin;
+/**
+ * Fix missing window.outerWidth/window.outerHeight in headless mode
+ * Will also set the viewport to match window size, unless specified by user
+ */
+declare class Plugin extends PuppeteerExtraPlugin {
+    constructor(opts?: {});
+    onPageCreated(page: any): Promise<void>;
+    beforeLaunch(options: any): Promise<any>;
+}
+import { PuppeteerExtraPlugin } from '@zorilla/puppeteer-extra-plugin';
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/evasions/window.outerdimensions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/evasions/window.outerdimensions/index.js"],"names":[],"mappings":"AAuCA,4DAEC;AAvCD;;;GAGG;AACH;IACE,uBAEC;IAMD,wCAYC;IAED,yCAOC;CACF;qCArCoC,iCAAiC"}

package/dist/evasions/window.outerdimensions/index.js

@@ -0,0 +1,42 @@
+import { PuppeteerExtraPlugin } from '@zorilla/puppeteer-extra-plugin';
+
+/**
+ * Fix missing window.outerWidth/window.outerHeight in headless mode
+ * Will also set the viewport to match window size, unless specified by user
+ */
+class Plugin extends PuppeteerExtraPlugin {
+  constructor(opts = {}) {
+    super(opts);
+  }
+
+  get name() {
+    return 'stealth/evasions/window.outerdimensions';
+  }
+
+  async onPageCreated(page) {
+    // Chrome returns undefined, Firefox false
+    await page.evaluateOnNewDocument(() => {
+      try {
+        if (window.outerWidth && window.outerHeight) {
+          return; // nothing to do here
+        }
+        const windowFrame = 85; // probably OS and WM dependent
+        window.outerWidth = window.innerWidth;
+        window.outerHeight = window.innerHeight + windowFrame;
+      } catch (_err) {}
+    });
+  }
+
+  async beforeLaunch(options) {
+    // Have viewport match window size, unless specified by user
+    // https://github.com/GoogleChrome/puppeteer/issues/3688
+    if (!('defaultViewport' in options)) {
+      options.defaultViewport = null;
+    }
+    return options;
+  }
+}
+
+export default function (pluginConfig) {
+  return new Plugin(pluginConfig);
+}

package/dist/evasions/window.outerdimensions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/evasions/window.outerdimensions/index.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE;;;GAGG;AACH,MAAM,MAAO,SAAQ,oBAAoB;IACvC,YAAY,IAAI,GAAG,EAAE;QACnB,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAED,IAAI,IAAI;QACN,OAAO,yCAAyC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,IAAI;QACtB,0CAA0C;QAC1C,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE;YACpC,IAAI,CAAC;gBACH,IAAI,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;oBAC5C,OAAO,CAAC,qBAAqB;gBAC/B,CAAC;gBACD,MAAM,WAAW,GAAG,EAAE,CAAC,CAAC,+BAA+B;gBACvD,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;gBACtC,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;YACxD,CAAC;YAAC,OAAO,IAAI,EAAE,CAAC,CAAA,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAAO;QACxB,4DAA4D;QAC5D,wDAAwD;QACxD,IAAI,CAAC,CAAC,iBAAiB,IAAI,OAAO,CAAC,EAAE,CAAC;YACpC,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;QACjC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY;IACnC,OAAO,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;AAClC,CAAC"}

package/dist/evasions/window.outerdimensions/package.json

@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "type": "module",
+  "main": "index.js"
+}

package/dist/index.d.ts

@@ -0,0 +1,130 @@
+import { PuppeteerExtraPlugin } from '@zorilla/puppeteer-extra-plugin';
+import type * as Puppeteer from '@zorilla/puppeteer-extra-plugin/dist/puppeteer';
+interface PluginOptions {
+    enabledEvasions?: Set<string>;
+    availableEvasions?: Set<string>;
+    [key: string]: unknown;
+}
+interface BrowserOptions {
+    [key: string]: unknown;
+}
+/**
+ * Stealth mode: Applies various techniques to make detection of headless puppeteer harder. 💯
+ *
+ * ### Purpose
+ * There are a couple of ways the use of puppeteer can easily be detected by a target website.
+ * The addition of `HeadlessChrome` to the user-agent being only the most obvious one.
+ *
+ * The goal of this plugin is to be the definite companion to puppeteer to avoid
+ * detection, applying new techniques as they surface.
+ *
+ * As this cat & mouse game is in it's infancy and fast-paced the plugin
+ * is kept as flexibile as possible, to support quick testing and iterations.
+ *
+ * ### Modularity
+ * This plugin uses `puppeteer-extra`'s dependency system to only require
+ * code mods for evasions that have been enabled, to keep things modular and efficient.
+ *
+ * The `stealth` plugin is a convenience wrapper that requires multiple [evasion techniques](./evasions/)
+ * automatically and comes with defaults. You could also bypass the main module and require
+ * specific evasion plugins yourself, if you whish to do so (as they're standalone `puppeteer-extra` plugins):
+ *
+ * ```es6
+ * // bypass main module and require a specific stealth plugin directly:
+ * puppeteer.use(require('@zorilla/puppeteer-extra-plugin-stealth/evasions/console.debug')())
+ * ```
+ *
+ * ### Contributing
+ * PRs are welcome, if you want to add a new evasion technique I suggest you
+ * look at the [template](./evasions/_template) to kickstart things.
+ *
+ * ### Kudos
+ * Thanks to [Evan Sangaline](https://intoli.com/blog/not-possible-to-block-chrome-headless/) and [Paul Irish](https://github.com/paulirish/headless-cat-n-mouse) for kickstarting the discussion!
+ *
+ * ---
+ *
+ * @todo
+ * - white-/blacklist with url globs (make this a generic plugin method?)
+ * - dynamic whitelist based on function evaluation
+ *
+ * @example
+ * const puppeteer = require('@zorilla/puppeteer-extra')
+ * // Enable stealth plugin with all evasions
+ * puppeteer.use(require('@zorilla/puppeteer-extra-plugin-stealth')())
+ *
+ *
+ * ;(async () => {
+ *   // Launch the browser in headless mode and set up a page.
+ *   const browser = await puppeteer.launch({ args: ['--no-sandbox'], headless: true })
+ *   const page = await browser.newPage()
+ *
+ *   // Navigate to the page that will perform the tests.
+ *   const testUrl = 'https://intoli.com/blog/' +
+ *     'not-possible-to-block-chrome-headless/chrome-headless-test.html'
+ *   await page.goto(testUrl)
+ *
+ *   // Save a screenshot of the results.
+ *   const screenshotPath = '/tmp/headless-test-result.png'
+ *   await page.screenshot({path: screenshotPath})
+ *   console.log('have a look at the screenshot:', screenshotPath)
+ *
+ *   await browser.close()
+ * })()
+ *
+ * @param {Object} [opts] - Options
+ * @param {Set<string>} [opts.enabledEvasions] - Specify which evasions to use (by default all)
+ *
+ */
+declare class StealthPlugin extends PuppeteerExtraPlugin {
+    constructor(opts?: PluginOptions);
+    get name(): string;
+    get defaults(): Required<PluginOptions>;
+    /**
+     * Requires evasion techniques dynamically based on configuration.
+     *
+     * @private
+     */
+    get dependencies(): Set<string>;
+    /**
+     * Get all available evasions.
+     *
+     * Please look into the [evasions directory](./evasions/) for an up to date list.
+     *
+     * @type {Set<string>} - A Set of all available evasions.
+     *
+     * @example
+     * const pluginStealth = require('@zorilla/puppeteer-extra-plugin-stealth')()
+     * console.log(pluginStealth.availableEvasions) // => Set { 'user-agent', 'console.debug' }
+     * puppeteer.use(pluginStealth)
+     */
+    get availableEvasions(): Set<string>;
+    /**
+     * Get all enabled evasions.
+     *
+     * Enabled evasions can be configured either through `opts` or by modifying this property.
+     *
+     * @type {Set<string>} - A Set of all enabled evasions.
+     *
+     * @example
+     * // Remove specific evasion from enabled ones dynamically
+     * const pluginStealth = require('@zorilla/puppeteer-extra-plugin-stealth')()
+     * pluginStealth.enabledEvasions.delete('console.debug')
+     * puppeteer.use(pluginStealth)
+     */
+    get enabledEvasions(): Set<string>;
+    /**
+     * @private
+     */
+    set enabledEvasions(evasions: Set<string>);
+    onBrowser(browser: Puppeteer.Browser, _opts: BrowserOptions): Promise<void>;
+}
+/**
+ * Default export, PuppeteerExtraStealthPlugin
+ *
+ * @param {Object} [opts] - Options
+ * @param {Set<string>} [opts.enabledEvasions] - Specify which evasions to use (by default all)
+ */
+declare const _default: (opts?: PluginOptions) => StealthPlugin;
+export default _default;
+export { StealthPlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,KAAK,KAAK,SAAS,MAAM,gDAAgD,CAAC;AAEjF,UAAU,aAAa;IACrB,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9B,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,UAAU,cAAc;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,cAAM,aAAc,SAAQ,oBAAoB;gBAClC,IAAI,GAAE,aAAkB;IAIpC,IAAa,IAAI,IAAI,MAAM,CAE1B;IAED,IAAa,QAAQ,IAAI,QAAQ,CAAC,aAAa,CAAC,CAwB/C;IAED;;;;OAIG;IACH,IAAa,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,CAGvC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,iBAAiB,IAAI,GAAG,CAAC,MAAM,CAAC,CAEnC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,eAAe,IAAI,GAAG,CAAC,MAAM,CAAC,CAEjC;IAED;;OAEG;IACH,IAAI,eAAe,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,EAExC;IAEc,SAAS,CACtB,OAAO,EAAE,SAAS,CAAC,OAAO,EAC1B,KAAK,EAAE,cAAc,GACpB,OAAO,CAAC,IAAI,CAAC;CAOjB;AAED;;;;;GAKG;yBACa,OAAO,aAAa,KAAG,aAAa;AAApD,wBAAgF;AAGhF,OAAO,EAAE,aAAa,EAAE,CAAC"}