Crate easy_captcha

Rust图形验证码，由Java同名开源库whvcse/EasyCaptcha移植而来👏，100%纯Rust实现，支持gif、算术等类型。

Rust Captcha library, which is ported from Java’s same-name library whvcse/EasyCaptcha, implemented in 100% pure Rust, supporting GIF and arithmetic problems.

目前已适配框架 / Frameworks which is adapted now:

• axum + tower-sessions

更多框架欢迎您提交PR，参与适配🙏 PR for new frameworks are welcomed

使用 Usage

若您正在使用的框架已适配，您可直接通过CaptchaUtil类（并导入相应框架的trait）来使用验证码：

If your framework is adapted, you can just use CaptchaUtil and importing traits of your framework to use the Captcha:

use std::collections::HashMap;
use axum::extract::Query;
use axum::response::IntoResponse;
use easy_captcha::captcha::gif::GifCaptcha;
use easy_captcha::extension::axum_tower_sessions::{
    CaptchaAxumTowerSessionExt, CaptchaAxumTowerSessionStaticExt,
};
use easy_captcha::extension::CaptchaUtil;
use easy_captcha::NewCaptcha;

/// 接口：获取验证码
/// Handler: Get a captcha
async fn get_captcha(session: tower_sessions::Session) -> Result<axum::response::Response, axum::http::StatusCode> {
    let mut captcha: CaptchaUtil<GifCaptcha> = CaptchaUtil::new();
    match captcha.out(&session).await {
        Ok(response) => Ok(response),
        Err(_) => Err(axum::http::StatusCode::INTERNAL_SERVER_ERROR),
    }
}

/// 接口：验证验证码
/// Handler: Verify captcha codes
async fn verify_captcha(
    session: tower_sessions::Session,
    Query(query): Query<HashMap<String, String>>,
) -> axum::response::Response {
    // 从请求中获取验证码 Getting code from the request.
    if let Some(code) = query.get("code") {
        // 调用CaptchaUtil的静态方法验证验证码是否正确 Use a static method in CaptchaUtil to verify.
        if CaptchaUtil::ver(code, &session).await {
            CaptchaUtil::clear(&session).await; // 如果愿意的话，你可以从Session中清理掉验证码  You may clear the Captcha from the Session if you want
            "Your code is valid, thank you.".into_response()
        } else {
            "Your code is not valid, I'm sorry.".into_response()
        }
    } else {
        "You didn't provide the code.".into_response()
    }
}

您也可以自定义验证码的各项属性

You can also specify properties of the Captcha.

use easy_captcha::captcha::gif::GifCaptcha;
use easy_captcha::extension::axum_tower_sessions::CaptchaAxumTowerSessionExt;
use easy_captcha::extension::CaptchaUtil;
use easy_captcha::NewCaptcha;

async fn get_captcha(session: tower_sessions::Session) -> Result<axum::response::Response, axum::http::StatusCode> {
    let mut captcha: CaptchaUtil<GifCaptcha> = CaptchaUtil::with_size_and_len(127, 48, 4);
    match captcha.out(&session).await {
        Ok(response) => Ok(response),
        Err(_) => Err(axum::http::StatusCode::INTERNAL_SERVER_ERROR),
    }
}

项目当前提供了三种验证码实现：SpecCaptcha（静态PNG）、GifCaptcha（动态GIF） 、ArithmeticCaptcha（算术PNG），您可按需使用。

There is three implementation of Captcha currently, which are SpecCaptcha(static PNG), GifCaptcha(GIF), ArithmeticCaptcha(Arithmetic problems), you can use them according to your need.

自带字体效果 / Fonts shipped

字体/Fonts	效果/Preview
CaptchaFont::Font1
CaptchaFont::Font2
CaptchaFont::Font3
CaptchaFont::Font4
CaptchaFont::Font5
CaptchaFont::Font6
CaptchaFont::Font7
CaptchaFont::Font8
CaptchaFont::Font9
CaptchaFont::Font10

Modules

• captcha
  不同种类的Captcha实现 Different types of Captcha
• extension
  针对于Web框架的扩展 Extensions to web frameworks, like axum-tower_session.

Enums

• CaptchaFont
  内置字体 Fonts shipped with the library
• CaptchaType
  验证码文本类型 The character type of the captcha

Traits

• AbstractCaptcha
  验证码的抽象方法 Traits which a Captcha must implements.
• NewCaptcha
  初始化验证码的抽象方法 Traits for initialize a Captcha instance.