A no-nonsense CAPTCHA system with seamless UX | Backend component
Find a file
realaravinth b6afe79a81
fix: initialize DOM elements only when executing methods/in pages that
contain those elements

SUMMARY
    Trying to grab elements globally in a script results in it trying to
    initialize in all pages. When the element is absent, the script
    fails and JavaScript crashes.
2022-07-23 00:48:51 +05:30
.github feat: CI: publish docker img 2022-07-22 23:42:25 +05:30
config feat: load config to make captcha stats optional 2022-05-27 15:25:33 +05:30
db fix: add sqlx offline compilation data 2022-07-22 20:04:41 +05:30
docs Fixing some docs issues and adding some lines in docker-compose.yml (#33) 2022-07-19 15:54:42 +05:30
scripts fix: don't escape license prefixes and script content 2022-07-23 00:47:44 +05:30
src fix: prevent sitekey abuse with account secret authentication for access token validation 2022-07-22 19:44:35 +05:30
static use yaml directly for displaying open api spec 2021-10-08 15:36:42 +05:30
templates fix: initialize DOM elements only when executing methods/in pages that 2022-07-23 00:48:51 +05:30
utils/cache-bust feat: run cache busting via a separate bin 2022-05-14 15:59:40 +05:30
.dockerignore docker: wasm build step 2021-07-15 15:27:01 +05:30
.env_sample feat: setup CI to use .env_sample and postgres URI 2022-05-11 13:33:29 +05:30
.eslintrc.js frontend linting 2021-10-08 15:24:29 +05:30
.gitignore move pow wasm lib out to a separate repo 2021-12-01 21:18:30 +05:30
build.rs feat: migrate fetch captcha config to use db_* 2022-05-27 18:16:47 +05:30
Cargo.lock feat: update libmcaptcha 2022-07-21 18:29:16 +05:30
Cargo.toml feat: migrate record_stats to use db_* 2022-05-27 16:23:33 +05:30
CHANGELOG.md feat: add changelog entry to doc change in access token verification 2022-07-22 19:49:07 +05:30
code_of_conduct.md added code_of_conduct.md 2021-05-02 18:13:13 +05:30
Cross.toml cache control 2021-05-30 17:55:11 +05:30
docker-compose.yml fix: services.mcaptcha.depends_on must be a list 2022-07-20 14:44:46 +05:30
Dockerfile feat: docker build caching with cargo-chef 2022-05-28 16:22:34 +05:30
jest.config.ts upgrade dev dependencies 2021-10-13 10:37:51 +05:30
LICENSE.md licence 2021-03-09 17:49:20 +05:30
Makefile feat: cache-bust when make run is called 2022-07-23 00:48:05 +05:30
package.json chore: migrate dart-sass to sass 2022-05-08 17:36:49 +05:30
README.md fix: docker-compose -d up -> docker-compose up -d 2022-07-20 14:45:25 +05:30
rustfmt.toml get notifications 2021-05-10 15:38:09 +05:30
sailfish.toml chore: upgrade sailfish 2022-05-08 17:57:29 +05:30
sqlx-data.json fix: add sqlx offline compilation data 2022-07-22 20:04:41 +05:30
tsconfig.json Load pow-sha256 polyfill to support browsers that aren't capable of 2021-12-08 14:52:06 +05:30
webpack.config.js chore: migrate dart-sass to sass 2022-05-08 17:36:49 +05:30
yarn.lock chore: migrate dart-sass to sass 2022-05-08 17:36:49 +05:30

mcaptcha logo

mCaptcha

Proof of work based, privacy respecting CAPTCHA system with a kickass UX.

Documentation Build Docker dependency status codecov
AGPL License Chat

STATUS: ACTIVE DEVELOPMENT

Skip to demo

mCaptcha is a privacy respecting, free CAPTCHA system with a kickass UX. Your users no longer have to interact with ridiculous image-based CAPTCHA system, wasting precious mental bandwidth. Instead, your computer will do the work for you, see for yourself!

How does it work?

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!
  • No tracking: Our CAPTCHA routes are cookie free!
  • IP address independent: your users are behind a NAT? We got you covered!
  • 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

Client-side widget:

mCaptcha's UX is super silent, solving CAPTCHAs have never been more easier. One click and you are on your way. To observe mCaptcha in action, open dev tools and monitor console and network activity.

  1. Link to widget

  2. Video:

Demo servers are available at:

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:

git clone https://github.com/mCaptcha/mCaptcha.git
docker-compose up -d

After the containers are up, visit http://localhost:7000 and login with the default credentials:

  • username: aaronsw
  • password: password

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

See DEPLOYMENT.md detailed alternate deployment methods.

Development:

See HACKING.md

Deployment:

See DEPLOYMENT.md

Configuration:

See CONFIGURATION.md