Arav/justcaptcha
1
0
Fork 0
Code Issues Releases 6 Activity
A simple CAPTCHA service implementation.
81 Commits 1 Branch 6 Tags 212 KiB
Go 100%
7e506ee982
Go to file
Alexander "Arav" Andreev 7e506ee982
A README was rewritten and complemented with a new behavior of a GET /:id endpoint.
2022-08-28 23:33:59 +04:00
bin Initial commit with a fully working program, lel. 2022-06-24 23:09:46 +04:00
build/archlinux Oops, removed file renaming. 2022-08-25 04:58:39 +04:00
cmd/justcaptchad A version increased to 1.1.1. And a version now is being passed from ldflags in a Makefile. 2022-08-17 21:49:57 +04:00
init/systemd Removed unnecessary quotes around a path to unix-socket. 2022-08-24 21:22:31 +04:00
internal Added a Remove() method to a DB instance. 2022-08-28 23:32:42 +04:00
pkg Added Remove() method. CAPTCHA word is capitalised in comments. In IsSolved() method of a DB a CAPTCHA's IsSolved method is now called within a return statement. 2022-08-28 23:27:54 +04:00
.gitignore Initial commit with a fully working program, lel. 2022-06-24 23:09:46 +04:00
go.mod Updated indirect dependencies. And go version to 1.18. 2022-08-19 02:31:02 +04:00
go.sum Updated go.sum. 2022-08-24 21:21:54 +04:00
LICENSE Initial commit with a fully working program, lel. 2022-06-24 23:09:46 +04:00
Makefile Version changed to 1.1.2. 2022-08-19 02:26:03 +04:00
README.md A README was rewritten and complemented with a new behavior of a GET /:id endpoint. 2022-08-28 23:33:59 +04:00

README.md

justcaptcha ver. 1.1.2

A simple CAPTCHA service implementation.

Usage

justcaptchad -expiry 5m -listen /var/run/justcaptchad/j.sock

-expiry takes time for CAPTCHA to be valid for in format X{s,m,h}.

-listen is ip:port or /path/to/unix.sock to listen on.

API

Get a new CAPTCHA

GET /

It will return an ID of a new CAPTCHA in plain text.

HTTP codes

  • 200 if created (and it always being created)

Get an image for a CAPTCHA

GET /:captcha_id/image?style=

Responds with an image in JPEG format.

An optional URL query parameter style= set a name of a CAPTCHA style if implemented by used CAPTCHA implementation.

HTTP codes

  • 200 if exists
  • 404 if doesn't exist
  • 500 if for some reason an image wasn't created

Submit an answer

POST /:captcha_id

Accepts application/x-www-form-urlencoded content type.

It takes one parameter answer=123456.

Responds with an empty body and one of the HTTP codes.

HTTP codes

  • 200 if solved
  • 403 if not solved
  • 404 if doesn't exist

Check if captcha is solved

GET /:captcha_id?remove

Responds with an empty body and one of the HTTP codes.

If an optional remove URL query parameter without a value supplied. CAPTCHA will be removed without check if it is solved and a HTTP code 200 will be sent. Otherwise, a 403 HTTP code will be sent, and, e.g. browser will print an error message to console. So, in this case it helps to keep a browser's console cleaner. If CAPTCHA doesn't exist a 404 HTTP code still will be returned.

This can be useful to remove an unused CAPTCHA from a DB without waiting for it to be expired. E.g. when a visitor requests for a new CAPTCHA because he struggle to solve it.

HTTP codes

  • 200 if solved
  • 403 if not solved
  • 404 if doesn't exist