Need private packages and team management tools?Check out npm Teams »

@subns/humanoid-js

1.0.2 • Public • Published

humanoid

Humanoid

Build Status license version tested with jest

A Node.js package to bypass WAF anti-bot JS challenges.

About

Humanoid is a Node.js package to solve and bypass CloudFlare (and hopefully in the future - other WAFs' as well) JavaScript anti-bot challenges.
While anti-bot pages are solvable via headless browsers, they are pretty heavy and are usually considered over the top for scraping.
Humanoid can solve these challenges using the Node.js runtime and present the protected HTML page.
The session cookies can also be delegated to other bots to continue scraping causing them to avoid the JS challenges altogether.

Features

  • Random browser User-Agent
  • Auto-retry on failed challenges
  • Highly configurable - hack custom cookies, headers, etc
  • Clearing cookies and rotating User-Agent is supported
  • Supports decompression of Brotli content-encoding. Not supported by Node.js' request by default!

Installation

via npm:

npm install @subns/humanoid-js

Usage

Basic usage with promises:

const Humanoid = require("@subns/humanoid-js");
 
let humanoid = new Humanoid();
humanoid.get("https://www.cloudflare-protected.com")
    .then(res => {
     console.log(res.body) // <!DOCTYPE html><html lang="en">...
    })
    .catch(err => {
     console.error(err)
    })

Humanoid uses auto-bypass by default. You can override it on instance creation:

let humanoid = new Humanoid(autoBypass=false)
 
humanoid.get("https://canyoupwn.me")
  .then(res => {
   console.log(res.statusCode) // 503
   console.log(res.isSessionChallenged) // true
    humanoid.bypassJSChallenge(res)
      .then(challengeResponse => {
       // Note that challengeResponse.isChallengeSolved won't be set to true when doing manual bypassing.
       console.log(challengeResponse.body) // <!DOCTYPE html><html lang="en">...
      })
    }
  )
    .catch(err => {
        console.error(err)
    })

async/await is also supported, and is the preferred way to go:

(async function() {
  let humanoid = new Humanoid();
  let response = await humanoid.sendRequest("www.cloudflare-protected.com")
  console.log(response.body) // <!DOCTYPE html><html lang="en">...
}())

Humanoid API Methods

  rotateUA() // Replace the currently set user agent with a different one
  
  clearCookies() // "Set a new, empty cookie jar for the humanoid instance"
  
  get(url, queryString=undefined, headers=undefined) // Send a GET request to `url`.
  // if passed, queryString and headers should be objects 
  
  post(url, postBody=undefined, headers=undefined, dataType=undefined) // Send a POST request to `url`.
  // `dataType` should be either "form" or "json" - based on the content type of the POST request.
  
  sendRequest(url, method=undefined, data=undefined, headers=undefined, dataType=undefined) 
  // Send a request of method `method` to `url`
  
  bypassJSChallenge(response) // Bypass the anti-bot JS challenge found in response.body

TODOs

  • Add command line support
    • Support a flag to return the cookie jar after challenge solved - for better integration with other tools and scrapers
    • Have an option to simply bypass and return the protected HTML
  • Solve other WAFs similar anti-bot challenges
  • Add tests for request sending and challenge solving
  • Add Docker support 🐳

Issues and Contributions

All anti-bot challenges are likely to change in the future. If this is the case, please open an issue explaining the problem - try to include the target page if possible. I'll do my best to keep the code up to date with new challenges.
Any and all contributions are welcome - and are highly appreciated.

Install

npm i @subns/humanoid-js

DownloadsWeekly Downloads

1

Version

1.0.2

License

MIT

Unpacked Size

33 kB

Total Files

13

Last publish

Collaborators

  • avatar