30 stable releases (3 major)
new 3.0.0 | Dec 9, 2024 |
---|---|
2.7.6 | Oct 24, 2024 |
2.5.0 | Sep 14, 2024 |
2.4.4 | Jul 27, 2024 |
0.4.0 | Nov 23, 2020 |
#198 in Web programming
755 downloads per month
130KB
2K
SLoC
Rust library hcaptcha
The rust library hcaptcha is used with your backend service to verify the hcaptcha response provided from the client.
Installation
To use hcaptcha, add the following to your Cargo.toml
:
[dependencies]
hcaptcha = "3.0.0"
Breaking changes with version 3.0.0
- The
Hcaptcha
prefix has been removed from all types. - The default feature now uses
rustls-backend
and not thenativetls-backend
. - The
verify_client_response
method has been deprecated in favour or theverify
method.
Usage
Derive a validation method on the data structure representing your data, marking the captcha components in the data structure.
# use hcaptcha::Hcaptcha;
#[derive(Debug, Deserialize, Hcaptcha)]
pub struct ContactForm {
name: String,
phone: String,
email: String,
message: String,
#[captcha]
token: String,
}
Validate the captcha data.
# #[tokio::main]
# async main() -> Result<(), Box<dyn std::error::Error>> {
let contact_form: ContactForm = serde_json::from_str(e.body_string())?;
contact_form.valid_response(&secret, None).await?;
# }
# fn get_your_secret() -> String {
# "0x123456789abcde0f123456789abcdef012345678".to_string()
# }
See the examples folder for an AWS Lambda contact form example.
Web Assembly
Hcaptcha has been tested in a web assembly project using wasm-bindgen and node.
See the hcaptcha-wasm
example for a sample project which can be run using wasm-pack test --node
.
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Credits
Initial version based on recaptcha-rs by panicbit.
Dependencies
~5–17MB
~244K SLoC