https://github.com/notreeceharris/open-captcha
Generates captchas using WebGL and modified Three.js in Node.js backend, delivering them to web frontends for real-time, object-based challenges.
https://github.com/notreeceharris/open-captcha
captcha nodejs threejs webgl
Last synced: 4 months ago
JSON representation
Generates captchas using WebGL and modified Three.js in Node.js backend, delivering them to web frontends for real-time, object-based challenges.
- Host: GitHub
- URL: https://github.com/notreeceharris/open-captcha
- Owner: NotReeceHarris
- License: agpl-3.0
- Created: 2025-01-08T23:38:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-08T23:41:08.000Z (over 1 year ago)
- Last Synced: 2025-01-09T03:54:01.312Z (over 1 year ago)
- Topics: captcha, nodejs, threejs, webgl
- Language: JavaScript
- Homepage:
- Size: 11.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
> [!CAUTION]
> This is a proof of concept and has not been tested against image recognition yet, to keep your system secure use an already proven secure captcha. However if you have the skills or resources to run image recognition on some samples please see [`examples/`](/examples/) for some sample outputs.
# open-captcha
open-captcha stands out from other captcha providers in a big way. Forget about connecting to external services or making your users work for free to train AI. Our approach ensures that each challenge is unique and employs the most advanced anti-ai detection methods, all while being completly self-hosted and intergrated into your web-app.
## Benchmarking
To benchmark yourself run the script `npm run benchmark`, please consider sharing your benchmark results by making a [PR](https://github.com/ChatterSec/open-captcha/pulls) to the [BENCHMARK.md](BENCHMARK.md).
version | os | cpu | gpu | runs | avg generation time
--- | --- | --- | --- | --- | ---
0.1.x-serverRendering | `Linux 5.15.0-94-generic #104-Ubuntu 2024 x86_64 x86_64 x86_64 GNU/Linux` | `11th Gen Intel(R) Core(TM) i7-1165G7 @ 2.80GHz` | `TigerLake-LP GT2 [Iris Xe Graphics]` | 500 | 350.41 /ms
0.1.x-serverRendering | `Windows 10 Home 22H2` | `AMD Ryzen 7 3700X 8-Core Processor 3.60 GHz` | `NVIDIA GeForce RTX 3060 TI` | 500 | 534.71 / ms
0.1.x-serverRendering | `Windows 11 Pro 22H2` | `13th Gen Intel(R) Core(TM) i5-13420H 2.10 GHz` | `Intel(R) UHD Graphics` | 500 | 703.04 / ms
## Setup Guide & Installation Steps
Unfortunately, setting up open-captcha isn't straightforward for everyone. However, in some cases, all you need to do is run the `npm install` command. Because open-captcha relies on headless image generation, which is not natively supported in Node.js, there are a few build requirements to consider.
First, ensure that you have the required dependencies listed below. Then, it's a matter of some trial and error from there. Make sure you have `python3` aliased as `python`, as some tasks may require specific permissions. You can either run them as root or configure your permissions accordingly.
```
npm i open-captcha@latest
```
## System dependencies
In most cases setting up `open-captcha` from npm should just work. However, since open-captcha uses image rendering you may run into problems and you might need to adjust your system configuration and make sure all your dependencies are up to date. For general information on building native modules, see the [`node-gyp`](https://github.com/nodejs/node-gyp) documentation.
### Linux
- [Python 3.x](https://www.python.org/)
- A GNU C++ environment (available via the `build-essential` package on `apt`)
- [libxi-dev](http://www.x.org/wiki/)
- Working and up to date OpenGL drivers
- [GLEW](http://glew.sourceforge.net/)
- [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/)
### Ubuntu / Debian
```
sudo apt-get install -y build-essential libxi-dev libglu1-mesa-dev libglew-dev pkg-config python3 python-is-python3
```
### CentOs
```
sudo yum install -y gcc-c++ libXi-devel mesa-libGL-devel glew-devel pkgconfig python3
```
### Windows
- [Python 3.x](https://www.python.org/)
- [Microsoft Visual Studio](https://www.microsoft.com/en-us/download/details.aspx?id=5555)
- [d3dcompiler_47.dll](https://www.dll-files.com/d3dcompiler_47.dll.html) you can find another copy in the `deps/` dir.
### Mac OS X
- [Python 3.x](https://www.python.org/)
- [XCode](https://developer.apple.com/xcode/)
## Contributing
All contributions are welcome ❤️, if you plan on contributing please read the [CONTRIBUTING](/CONTRIBUTING.md) and [CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) for more information.
## Licensing
```
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
```
For more details please read the [LICENSE](/LICENSE), To know more about the GPLA-3.0 license you can read more on the [GNU official website](https://www.gnu.org/licenses/agpl-3.0).