2021-02-28 15:05:39 +05:30
|
|
|
<div align="center">
|
|
|
|
|
<h1>mCaptcha</h1>
|
|
|
|
|
<p>
|
|
|
|
|
<strong>mCaptcha - PoW based DoS protection</strong>
|
|
|
|
|
</p>
|
|
|
|
|
|
2021-03-11 11:53:37 +05:30
|
|
|
[](https://mcaptcha.github.io/mCaptcha/m_captcha/index.html)
|
|
|
|
|
[](https://mcaptcha.org/docs/api/mcaptcha-system)
|
2021-03-07 20:17:10 +05:30
|
|
|
[](https://deps.rs/repo/github/mCaptcha/mCaptcha)
|
2021-03-09 17:37:46 +05:30
|
|
|
[](http://www.gnu.org/licenses/agpl-3.0)
|
2021-03-11 11:53:37 +05:30
|
|
|
/badge.svg>)
|
2021-02-28 15:05:39 +05:30
|
|
|
<br />
|
2021-03-11 11:53:37 +05:30
|
|
|
[](https://codecov.io/gh/mCaptcha/mCaptcha)
|
2021-03-09 17:37:46 +05:30
|
|
|
[](https://matrix.to/#/+mcaptcha:matrix.batsense.net)
|
2021-02-28 15:05:39 +05:30
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2021-03-11 11:53:37 +05:30
|
|
|
mCaptcha uses SHA256 based proof-of-work(PoW) to rate limit users.
|
2021-03-02 18:02:06 +05:30
|
|
|
|
2021-03-09 17:37:46 +05:30
|
|
|
If someone wants to hammer your site, they will have to do more work to
|
2021-03-02 18:02:06 +05:30
|
|
|
send requests than your server will have to do to respond to their
|
2021-03-09 17:37:46 +05:30
|
|
|
request.
|
|
|
|
|
|
2021-03-11 11:53:37 +05:30
|
|
|
> **NOTE:** `0.1` is out, expect breaking changes as ergonomics and
|
|
|
|
|
> performance is improved. Checkout [changelog](./CHANGELOG.md) for
|
|
|
|
|
> changes and migration pointers.
|
2021-03-02 18:02:06 +05:30
|
|
|
|
|
|
|
|
## Why use mCaptcha?
|
2021-03-11 11:53:37 +05:30
|
|
|
|
2021-03-02 18:02:06 +05:30
|
|
|
- Free software, privacy focused
|
|
|
|
|
- Seamless UX - No more annoying captchas!
|
|
|
|
|
- IP address independent(sort of) - your users are behind a NAT? We got you covered!
|
|
|
|
|
- Automatic bot throttling
|
|
|
|
|
- Resistant to replay attacks - bye-bye captcha farms!
|
|
|
|
|
|
|
|
|
|
## Demo
|
|
|
|
|
|
|
|
|
|
I'll try to write a dedicated demo server but until then you can try
|
|
|
|
|
[Shuttlecraft/identity](github.com/shuttlecraft/identity)'s sign up page
|
|
|
|
|
available at https://accounts.shuttlecraft.io/signup. Feel free to
|
|
|
|
|
provide bogus information while signing up(project under development,
|
|
|
|
|
database frequently wiped).
|
|
|
|
|
|
|
|
|
|
Be sure to open dev tools' network tab to witness the magic!
|
2021-02-28 15:05:39 +05:30
|
|
|
|
2021-03-11 11:53:37 +05:30
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
- [master-branch](https://mcaptcha.github.io/mCaptcha/m_captcha/index.html)
|
|
|
|
|
- [All published versions](https://mcaptcha.org/docs/api/mcaptcha-system)
|
|
|
|
|
|
|
|
|
|
## Usage
|
2021-02-28 15:05:39 +05:30
|
|
|
|
2021-03-02 18:02:06 +05:30
|
|
|
mCaptcha is made up of three components:
|
|
|
|
|
|
|
|
|
|
#### 1. Front-end library
|
2021-03-11 11:53:37 +05:30
|
|
|
|
2021-03-02 18:02:06 +05:30
|
|
|
We have a WASM library now, Android and iOS libraries soon
|
|
|
|
|
|
|
|
|
|
#### 2. Back-end library
|
2021-03-11 11:53:37 +05:30
|
|
|
|
2021-03-02 18:02:06 +05:30
|
|
|
We have Rust library, other languages will have support soon
|
2021-02-28 15:05:39 +05:30
|
|
|
|
2021-03-02 18:02:06 +05:30
|
|
|
#### 3. Rate limiting service
|
2021-03-11 11:53:37 +05:30
|
|
|
|
|
|
|
|
Under development.
|
2021-02-28 15:05:39 +05:30
|
|
|
|
2021-03-02 18:02:06 +05:30
|
|
|
A paid, managed service will be made available soon but
|
|
|
|
|
I([@realaravinth](https://batsense.net)) encourage you guys to
|
|
|
|
|
self-host. Go decentralisation!
|
2021-02-28 15:05:39 +05:30
|
|
|
|
2021-03-02 18:02:06 +05:30
|
|
|
## Contributing
|
2021-03-11 11:53:37 +05:30
|
|
|
|
2021-03-02 18:02:06 +05:30
|
|
|
yes please!
|
