cn.stylefeng.roses.kernel.security.api.ImageCaptchaApi Maven / Gradle / Ivy
/*
* Copyright [2020-2030] [https://www.stylefeng.cn]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
*
* 1.请不要删除和修改根目录下的LICENSE文件。
* 2.请不要删除和修改Guns源码头部的版权声明。
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
* 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
* 6.若您的项目无法满足以上几点，可申请商业授权
*/
package cn.stylefeng.roses.kernel.security.api;
import cn.stylefeng.roses.kernel.security.api.pojo.ImageCaptcha;
/**
* 图形验证码Api
*
* 开启用户登录图形验证码后获取图形验证码
*
* @author chenjinlong
* @since 2021/1/15 13:46
*/
public interface ImageCaptchaApi {
/**
* 生成图形验证码
*
* @author chenjinlong
* @since 2021/1/15 12:38
*/
ImageCaptcha captcha();
/**
* 校验图形验证码
*
* @param verKey 缓存key值
* @param verCode 验证码
* @return true-验证码正确，false-验证码错误
* @author chenjinlong
* @since 2021/1/15 12:38
*/
boolean validateCaptcha(String verKey, String verCode);
/**
* 根据key值获取验证码
*
* @param verKey 缓存key值
* @author chenjinlong
* @since 2021/1/15 12:40
*/
String getVerCode(String verKey);
}