Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/youkol/kaptcha-spring-boot-starter
kaptcha for spring boot autoconfigure
https://github.com/youkol/kaptcha-spring-boot-starter
kaptcha kaptcha-spring-boot-starter spring-boot
Last synced: 10 days ago
JSON representation
kaptcha for spring boot autoconfigure
- Host: GitHub
- URL: https://github.com/youkol/kaptcha-spring-boot-starter
- Owner: youkol
- License: apache-2.0
- Created: 2020-02-17T12:42:53.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-14T16:07:48.000Z (over 3 years ago)
- Last Synced: 2024-12-18T06:21:41.675Z (14 days ago)
- Topics: kaptcha, kaptcha-spring-boot-starter, spring-boot
- Language: Java
- Homepage: https://github.com/youkol/kaptcha-spring-boot-starter
- Size: 145 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kaptcha-spring-boot-starter
[](https://maven-badges.herokuapp.com/maven-central/com.youkol.support.kaptcha/kaptcha-spring-boot-starter)
[](https://oss.sonatype.org/content/repositories/snapshots/com/youkol/support/kaptcha/kaptcha-spring-boot-starter/)
[](http://www.apache.org/licenses/LICENSE-2.0.html)
Kaptcha for spring boot autoconfigure.
### 1. Maven
```xml
com.youkol.support.kaptcha
kaptcha-spring-boot-starter
LATEST_VERSION
```
### 2. Config spring-boot application.yml
```yaml
# Support zero-configuration mode, it will running by the default value.
# For Example:
youkol:
web:
kaptcha:
enabled: true
servlet:
enabled: true
url-mapping: /kaptcha
size-param: size
font-size-param: fontSize
cache:
# cache.type = session or redis.
type: session
token-name: YOUKOL-KAPTCHA-TOKEN
timeout: 300000
config:
kaptcha:
#
# Note: To avoid syntax errors in yaml files,
# when border property is "no", don't set value of border color and border thickness.
# when border property is "yes", You must omit the border property setting and
# set value of border color and border thickness directly.
#
# Take a look at the following example:
# 1) Hide border
border: "no"
# 2) Show border
# border:
# color: "105,179,90"
# thickness: 1
producer:
impl: com.google.code.kaptcha.impl.DefaultKaptcha
textproducer:
# simple math text creator, for example `7+8=?`
# impl: com.youkol.support.kaptcha.text.impl.SimpleMathTextCreator
impl: com.google.code.kaptcha.text.impl.DefaultTextCreator
char:
string: abcde2345678gfynmnpwx
length: 5
space: 2
font:
names: \u5fae\u8f6f\u96c5\u9ed1,Arial,\u5b8b\u4f53,\u6977\u4f53
size: 40
color: BLUE
noise:
impl: com.google.code.kaptcha.impl.NoNoise
color: BLACK
obscurificator:
impl: com.google.code.kaptcha.impl.WaterRipple
word:
impl: com.youkol.support.kaptcha.text.impl.SimpleWordRenderer
background:
impl: com.google.code.kaptcha.impl.DefaultBackground
clear:
from: LIGHT_GRAY
to: WHITE
image:
width: 200
height: 50
```
### 3. Send Request Url
GET http(s)://{host}:{port}/{contextPath}/{urlMapping}
For example:
1. response image
Request: `GET` http://localhost:8080/kaptcha
Response: `kaptcha image (image/jpeg)`
2. response json
Request: `GET` http://localhost:8080/kaptcha?format=base64
Response:
```
{
"code": "200",
"message": "OK",
"data": {
"uuid": "f7e7001f042a47eaa73dcdafe01a7b9d",
"image": "data:image/jpeg;base64,/9j/4AA...RRRQB//9k="
}
}
```
### 4. validate image code
sample code:
```java
// For example:
@Autowired
private KaptchaCacheResolver kaptchaCacheResolver;
public Object login(HttpServletRequest request) {
// some things.
// valid Kaptcha
String code = request.getParameter("code");
boolean bValid = kaptchaCacheResolver.validKaptcha(request, code);
// other things.
}
```
**Note:**
when use redis mode, you must put token-name and token-value in request header.
- token-name: `youkol.web.kaptcha.cache.token-name`
- token-value: the uuid of response (The uuid also can get from response header)
### About [Kaptcha](https://github.com/youkol/kaptcha)
Please see more information about this project.
http://code.google.com/p/kaptcha/