Nerds Publishing Monstrosities
    Have ideas to improve npm?Join in the discussion! »

    puppeteer-extra-plugin-stealth
    TypeScript icon, indicating that this package has built-in type declarations

    2.7.8 • Public • Published

    puppeteer-extra-plugin-stealth GitHub Workflow Status Discord npm

    A plugin for puppeteer-extra to prevent detection.

    Install

    yarn add puppeteer-extra-plugin-stealth
    # - or -
    npm install puppeteer-extra-plugin-stealth

    If this is your first puppeteer-extra plugin here's everything you need:

    yarn add puppeteer puppeteer-extra puppeteer-extra-plugin-stealth
    # - or -
    npm install puppeteer puppeteer-extra puppeteer-extra-plugin-stealth

    Usage

    // puppeteer-extra is a drop-in replacement for puppeteer,
    // it augments the installed puppeteer with plugin functionality
    const puppeteer = require('puppeteer-extra')
    
    // add stealth plugin and use defaults (all evasion techniques)
    const StealthPlugin = require('puppeteer-extra-plugin-stealth')
    puppeteer.use(StealthPlugin())
    
    // puppeteer usage as normal
    puppeteer.launch({ headless: true }).then(async browser => {
      console.log('Running tests..')
      const page = await browser.newPage()
      await page.goto('https://bot.sannysoft.com')
      await page.waitForTimeout(5000)
      await page.screenshot({ path: 'testresult.png', fullPage: true })
      await browser.close()
      console.log(`All done, check the screenshot. ✨`)
    })
    TypeScript usage

    puppeteer-extra and most plugins are written in TS, so you get perfect type support out of the box. :)

    import puppeteer from 'puppeteer-extra'
    import StealthPlugin from 'puppeteer-extra-plugin-stealth'
    
    puppeteer
      .use(StealthPlugin())
      .launch({ headless: true })
      .then(async browser => {
        const page = await browser.newPage()
        await page.goto('https://bot.sannysoft.com')
        await page.waitForTimeout(5000)
        await page.screenshot({ path: 'stealth.png', fullPage: true })
        await browser.close()
      })

    Please check this wiki entry in case you have TypeScript related import issues.


    Please check out the main documentation to learn more about puppeteer-extra (Firefox usage, other Plugins, etc).

    Status

    • puppeeteer-extra with stealth passes all public bot tests.

    Please note: I consider this a friendly competition in a rather interesting cat and mouse game. If the other team (👋) wants to detect headless chromium there are still ways to do that (at least I noticed a few, which I'll tackle in future updates).

    It's probably impossible to prevent all ways to detect headless chromium, but it should be possible to make it so difficult that it becomes cost-prohibitive or triggers too many false-positives to be feasible.

    If something new comes up or you experience a problem, please do your homework and create a PR in a respectful way (this is Github, not reddit) or I might not be motivated to help. :)

    Changelog

    🎁 Note: Until we've automated changelog updates in markdown files please follow the #announcements channel in our discord server for the latest updates and changelog info.

    Older changelog:

    v2.4.7

    • New: user-agent-override - Used to set a stealthy UA string, language & platform. This also fixes issues with the prior method of setting the Accept-Language header through request interception (#104, kudos to @Niek)
    • New: navigator.vendor - Makes it possible to optionally override navigator.vendor (#110, thanks @Niek)
    • Improved: navigator.webdriver: Now uses ES6 Proxies to pass instanceof tests (#117, thanks @aabbccsmith)
    • Removed: user-agent, accept-language (now obsolete)

    v2.4.2 / v2.4.1

    • Improved: iframe.contentWindow - We now proxy the original window object and smartly redirect calls that might reveal it's true identity, as opposed to mocking it like peasants :)
    • Improved: accept-language - More robust and it's now possible to set a custom locale if needed.
    • ⭐️ Passes the headless-cat-n-mouse test

    v2.4.0

    Let's ring the bell for round 2 in this cat and mouse fight 😄

    • New: All evasions now have a specific before and after test to make make this whole topic less voodoo
    • New: media.codecs - we spoof the presence of proprietary codecs in Chromium now
    • New & improved: iframe.contentWindow - Found a way to fix srcdoc frame based detection without breaking recaptcha inline popup & other iframes (please report any issues)
    • New: accept-language - Adds a missing Accept-Language header in headless (capitalized correctly, page.setExtraHTTPHeaders is all lowercase which can be detected)
    • Improved: chrome.runtime - More extensive mocking of the chrome object
    • ⭐️ All fpscanner tests are now green, as well as all intoli tests and the areyouheadless test
    v2.1.2
    • Improved: navigator.plugins - we fully emulate plugins/mimetypes in headless now 🎉
    • New: webgl.vendor - is otherwise set to "Google" in headless
    • New: window.outerdimensions - fix missing window.outerWidth/outerHeight and viewport
    • Fixed: navigator.webdriver now returns undefined instead of false

    Test results (red is bad)

    Vanilla puppeteer without stealth 😢

    Chromium + headless Chromium + headful Chrome + headless Chrome + headful

    Puppeteer with stealth plugin 💯

    Chromium + headless Chromium + headful Chrome + headless Chrome + headful

    Note: The MQ_SCREEN test is broken on their page (will fail in regular Chrome as well).

    Tests have been done using this test site and these scripts.

    Improved reCAPTCHA v3 scores

    Using stealth also seems to help with maintaining a normal reCAPTCHA v3 score.

    Regular Puppeteer
    Stealth Puppeteer

    Note: The official test is to be taken with a grain of salt, as the score is calculated individually per site and multiple other factors (past behaviour, IP address, etc). Based on anecdotal observations it still seems to work as a rough indicator.

    Tip: Have a look at the recaptcha plugin if you have issues with reCAPTCHAs.

    API

    Table of Contents

    class: StealthPlugin

    • opts Object? Options (optional, default {})
      • opts.enabledEvasions Set<string>? Specify which evasions to use (by default all)

    Extends: PuppeteerExtraPlugin

    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 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):

    // bypass main module and require a specific stealth plugin directly:
    puppeteer.use(
      require('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 to kickstart things.

    Kudos

    Thanks to Evan Sangaline and Paul Irish for kickstarting the discussion!


    Example:

    const puppeteer = require('puppeteer-extra')
    // Enable stealth plugin with all evasions
    puppeteer.use(require('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()
    })()

    .availableEvasions

    Type: Set<string>

    Get all available evasions.

    Please look into the evasions directory for an up to date list.

    Example:

    const pluginStealth = require('puppeteer-extra-plugin-stealth')()
    console.log(pluginStealth.availableEvasions) // => Set { 'user-agent', 'console.debug' }
    puppeteer.use(pluginStealth)

    .enabledEvasions

    Type: Set<string>

    Get all enabled evasions.

    Enabled evasions can be configured either through opts or by modifying this property.

    Example:

    // Remove specific evasion from enabled ones dynamically
    const pluginStealth = require('puppeteer-extra-plugin-stealth')()
    pluginStealth.enabledEvasions.delete('console.debug')
    puppeteer.use(pluginStealth)

    defaultExport(opts?)

    • opts Object? Options
      • opts.enabledEvasions Set<string>? Specify which evasions to use (by default all)

    Default export, PuppeteerExtraStealthPlugin


    License

    Copyright © 2018 - 2021, berstend̡̲̫̹̠̖͚͓̔̄̓̐̄͛̀͘. Released under the MIT License.

    Install

    npm i puppeteer-extra-plugin-stealth

    DownloadsWeekly Downloads

    67,643

    Version

    2.7.8

    License

    MIT

    Unpacked Size

    727 kB

    Total Files

    98

    Last publish

    Collaborators

    • avatar