mCaptcha/README.md

mCaptcha Guard

Back-end component of mCaptcha

STATUS: ACTIVE DEVELOPMENT

Guard is the back-end component of the mCaptcha system.

---

mCaptcha uses SHA256 based proof-of-work(PoW) to rate limit users.

When a user wants to do something on an mCaptcha-protected website,

1. they will have to generate proof-of-work(a bunch of math that will takes time to compute) and submit it to mCaptcha.

2. We'll validate the proof:

   • if validation is unsuccessful, they will be prevented from accessing their target website
   • if validation is successful, read on,

3. They will be issued a token that they should submit along with their request/form submission to the target website.

4. The target website should validate the user-submitted token with mCaptcha before processing the user's request.

The whole process is automated from the user's POV. All they have to do is click on a button to initiate the process.

mCaptcha makes interacting with websites (computationally)expensive for the user. A well-behaving user will experience a slight delay(no delay when under moderate load to 2s when under attack; PoW difficulty is variable) but if someone wants to hammer your site, they will have to do more work to send requests than your server will have to do to respond to their request.

Why use mCaptcha?

• Free software, privacy focused
• Seamless UX - No more annoying CAPTCHAs!
• IP address independent: your users are behind a NAT? We got you covered!
• Automatic bot throttling:
• Resistant to replay attacks: proof-of-work configurations have short lifetimes(30s) and can be used only once. If a user submits a PoW to an already used configuration or an expired one, their proof will be rejected.

Demo

Demo servers are available at:

• https://demo.mcaptcha.org/
• https://demo2.mcaptcha.org/ (runs on a Raspberry Pi!)

Core functionality is working but it's still very much work-in-progress. Since we don't have a stable release yet, hosted demo servers might be a few versions behind master. Please check footer for build commit.

Feel free to provide bogus information while signing up(project under development, database frequently wiped).

Self-hosted:

Clone the repo and run the following from the root of the repo:

$ docker-compose -d up

It takes a while to build the image so please be patient :)

Development:

See DEVELOPMENT.md

How to build

• Install Cargo using rustup with:

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

• Clone the repository with:

$ git clone https://github.com/mCaptcha/guard

• Build with Cargo:

$ cd guard && cargo build

Configuration:

Guard is highly configurable. Configuration is applied/merged in the following order:

1. path to configuration file passed in via GUARD_CONFIG
2. ./config/default.toml
3. /etc/guard/config.toml
4. environment variables.

Setup

Environment variables:

Setting environment variables are optional. The configuration files have all the necessary parameters listed. By setting environment variables, you will be overriding the values set in the configuration files.

Database:

Name	Value
GUARD_DATEBASE_PASSWORD	Postgres password
GUARD_DATEBASE_NAME	Postgres database name
GUARD_DATEBASE_PORT	Postgres port
GUARD_DATEBASE_HOSTNAME	Postgres hostmane
GUARD_DATEBASE_USERNAME	Postgres username
GUARD_DATEBASE_POOL	Postgres database connection pool size

Server:

Name	Value
GUARD_SERVER_PORT (or) PORT**	The port on which you want wagon to listen to
GUARD_SERVER_IP	The IP address on which you want wagon to listen to
GUARD_SERVER_STATIC_FILES_DIR	Path to directory containing static files
GUARD_CONFIG	Path to config file