puppeteer-recaptcha-solver

Google Recapctha v2 solver with puppeteer. You can simply use it in your project by passing to the constructor your Page object. The solver is using SpeechToText recognition, you can use one of our integrated solvers with your API key or to provide your own solving function. You can also integrate your own logger.

Disclaimer

This is an academic project, it is not intended to be used in production. It is not recommended to use this project for any other purpose than educational. The author is not responsible for any misuse of this project.

Demo

https://user-images.githubusercontent.com/63049090/209352713-c3263dc8-0c37-4786-b28f-0af997b3b60e.mp4

Table of contents

• Puppeteer Recaptcha Solver
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation
  • Usage
  • API
    • Constructor
    • Solve
    • General Types
      • Examples
        • Default Logger
        • WitAI Transcriber
        • Google SpeechToText Transcriber
  • Contributing
  • Built With
  • Authors
  • License

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install.

Getting Started

These instructions will help to you install the package in your project, set it and use it. See Contributing for notes on how to help and contribute this project.

Installation

BEFORE YOU INSTALL: please read the prerequisites

To install and set up the library, run:

$ npm install puppeteer-recaptcha-solver

Usage

To use, simply create the object and execute the solve command.

Example:

(async () => {
    const browser = await puppeteer.launch({
        headless: false,
    });
    const page = await browser.newPage();

    const solver = new ReCaptchaSolver({
        page,
        maxRetries: 3,
        transcriber: Transcribers.witAI,
        apiKey: 'YOUR_API_KEY'
    });

    await page.goto(
        'https://recaptcha-demo.appspot.com/recaptcha-v2-checkbox.php'
    );

    const solved = await solver.solve();

    console.log('Captcha solved: ', solved);
    await page.screenshot({ path: 'example/example.png' });
    await browser.close();
})();

API

Constructor

 const solver = new ReCaptchaSolver({
      page,
      log,
      maxRetries: 3,
      transcriber: Transcribers.witAI,
      apiKey: 'YOUR_API_KEY'
});

A constructor to the object.

Fields

Supported options for the constructor field are listed below.

| Field | Type | Default value | Required | Description | | --- |-------------| --- | --- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | page | Page | | Yes | puppeteer page object | | log | Logger | console.log | No | A logger that the solver will use. You can also use the default logger or noopLogger to disable the logs |
| transcriber | Transcriber | witAI | No | A transcriber that the solver will use to transcriber the audio to text. You can can choose between witAI or googleSpeechToText by passing Transcribers.witAI or Transcribers.googeSpeechToText or passing you own Transcriber function. | | maxRetries | number | 3 | No | Total number of retries until the captcha is solved | | apiKey | string | | No | API key to your transcribe service |

Solve

const solved: boolean = await solver.solve();

A command that will start the solving process. Returns a Promise<boolean> to indicate if the captcha successfully solved.

General Types

| Type | Signature | Description | |-------------|--------------------------------------------------------------------------------------------------------|------------------------------------------------------| | Logger | interface Logger { log(message: string): void | Promise<void>; error(message: string): void | Promise<void>; warn(message: string): void | Promise<void>; info(message: string): void | Promise<void>; debug(message: string): void | Promise<void>;} | A logger object that the solver will use. | | Transcriber | type Transcriber = ( audioBuffer: ArrayBuffer, apiKey?: string) => Promise<string | null>; | A transcribe function that gets an ArrayBuffer and should return the text |

Examples

default Logger

const defaultLogger: Logger = {
    log: (message: string) => console.log('[LOG]', message),
    error: (message: string) => console.error('[ERROR]', message),
    warn: (message: string) => console.warn('[WARN]', message),
    info: (message: string) => console.info('[INFO]', message),
    debug: (message: string) => console.debug('[DEBUG]', message),
};

witAI Transcriber

const witAI: Transcriber = async (
    audioBuffer: ArrayBuffer,
    apiKey?: string
) => {
    if (!apiKey) {
        throw new Error('witAI transcriber requires API key');
    }

    const { data } = await axios.post<string>(
        'https://api.wit.ai/speech?v=20220622',
        audioBuffer,
        {
            headers: {
                Authorization: `Bearer ${apiKey}`,
                'Content-Type': 'audio/mpeg3',
            },
        }
    );

    const parsed =
        typeof data === 'string'
            ? JSON.parse(data.split('\r\n').slice(-1)[0] || '{}')
            : data;

    return parsed?.text;
}

Google SpeechToText Transcriber

const googleSpeechToText: Transcriber = async (
    audioBuffer: ArrayBuffer,
    apiKey?: string
) => {
    if (!apiKey) {
        throw new Error('googleSpeechToText transcriber requires API key');
    }

    const { data } = await axios.post<string>(
        `https://speech.googleapis.com/v1p1beta1/speech:recognize?key=${apiKey}`,
        {
            config: {
                encoding: 'MP3',
                sampleRateHertz: 16000,
                languageCode: 'en-US',
            },
            audio: {
                content: Buffer.from(audioBuffer).toString('base64'),
            },
        }
    );

    const parsed =
        typeof data === 'string'
            ? JSON.parse(data.split('\r\n').slice(-1)[0] || '{}')
            : data;

    return parsed?.results?.[0]?.alternatives?.[0]?.transcript;
};

Contributing

Start with cloning this repo on your local machine:

$ git clone https://github.com/dore51/puppeteer-captcha-solver.git
$ cd puppeteer-captcha-solver

To install and set up the library, run:

$ npm install

To check that everything works

$ npm run example

Running the tests

$ npm test

Building a distribution version

$ npm run build

This task will create a distribution version of the project inside your local lib/ folder

publishing the distribution version

$ npm publish

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request :sunglasses:

Built With

This package has the following dependencies:

• Axios: A promise-based HTTP client for the browser and Node.js. Axios is used to make HTTP requests in the package.

The following dependencies are only required for development and testing purposes:

• Node.js: A JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js is required to run the package.
• Puppeteer: A Node library that provides a high-level API to control Chrome or Chromium over the DevTools Protocol. Puppeteer is used to automate and control the browser in order to solve the reCAPTCHA challenge.
• Prettier: A code formatter that enforces a consistent style across the codebase.
• Jest: A testing framework for JavaScript.
• puppeteer-screen-recorder: A utility for recording screencasts of a Puppeteer page.
• TSLint: A static analysis tool that checks TypeScript code for readability, maintainability, and functionality errors.

Authors

• Dor Eitan - Github

See also the list of contributors who participated in this project.

License

MIT License © Dor Eitan