website/content/docs/user-manual/cli.md at 4636d943745f64e860870270557cf510796a5d73

4.1 KiB

Raw Blame History

title

description

lead

date

lastmod

draft

CLI tool

Instructions to install mCaptcha CLI

2023-10-27T08:48:45+00:00

false

docs

parent
user-manual

A CLI tool exists to compute mCaptcha challenges. It can be installed from multiple sources:

Install

crates.io

The CLI tool is available on, crates.io, the Rust language's package registry. Rust language toolchain is required to install from crates.io, please see rustup.rs for Instructions to install it.

cargo install mcaptcha-cli

Pre-compiled binaries

Nightly builds and stable releases are regularly published to dl.mcaptcha.org for a variety of CPU architectures and operating systems.

Download binary, checksum and GPG signature files

wget https://dl.mcaptcha.org/mcaptcha/cli/{VERSION}/{FILENAME}.tar.gz
wget https://dl.mcaptcha.org/mcaptcha/cli/{VERSION}/{FILENAME}.tar.gz.asc
wget https://dl.mcaptcha.org/mcaptcha/cli/{VERSION}/{FILENAME}.tar.gz.sha256

Verify checksum

sha256sum -c {FILENAME}.tar.gz.sha256

Download mCaptcha's GPG release keys and verify GPG signature

gpg --keyserver keyserver.ubuntu.com --recv 73DAC973A9ADBB9ADCB5CDC4595A08135BA9FF73
gpg --verify {FILENAME}.tar.gz.asc

Install Binary

tar -xvzf {FILENAME}.tar.gz && sudo cp {FILENAME}/mcaptcha-cli /usr/local/bin

Build from source

Install Rust tool chain Please see here for instructions.
Download source code

git clone https://git.batsense.net/mCaptcha/cli

Compile and install

cargo build --release && sudp cp ./target/release/mcaptcha-cli
/usr/local/bin

Pass mCaptcha challenge

The CLI tool requires details about the challenge to work on it. The tool can be used in three different modes compute challenge:

Protected Page: Compute mCaptcha challenge for the CAPTCHA at a protected page
Widget URL: Compute PoW for captcha at widget URL
(Developer mode) Offline: Computes PoW over given CAPTCHA parameters

From protected page URL

The most convenient mode: copy the URL of the webpage which has the mCaptcha widget (example: showcase.mcaptcha.org) and run the CLI tool with it to get an authorization code: Compute challenge using the URL

03:39 atm@lab cli ±|feat-parse-webpage ✗|→ mcaptcha-cli protected-page https://showcase.mcaptcha.org/
Authorization token: eRAZJiMrW58uDYA1s64Tmwq1u30HutuF

If you have the widget URL (will be in format https://mcaptcha.example.org/widget?sitekey=randomstring), it can be used to solve challenge as well:

Compute PoW by fetching parameters from  CAPTCHA URL

Usage: mcaptcha-cli online --url <URL>

Options:
  -u, --url <URL>  URL of the CAPTCHA. Example:  https://example.org/widget?sitekey=foo
  -h, --help       Print help

Example usage:

13:32 atm@lab cli ±|online ✗|→ mcaptcha-cli online -u https://demo.mcaptcha.org/widget?sitekey=pHy0AktWyOKuxZDzFfoaewncWecCHo23
Authorization token: 3xleN26OctBuVu3X4t6CYyUjErhaxQvz

[Developer mode] Offline

Useful while debugging mCaptcha configurations, works on raw challenge parameters.

Help menu:

Compute PoW with offline parameters

Usage: mcaptcha-cli offline --salt <SALT> --phrase <PHRASE> --difficulty-factor <DIFFICULTY_FACTOR>

Options:
  -s, --salt <SALT>                            Salt with which PoW should be computed
  -p, --phrase <PHRASE>                        Phrase over which PoW should be computed
  -d, --difficulty-factor <DIFFICULTY_FACTOR>  Difficulty Factor
  -h, --help                                   Print help