跳至主要內容

OAuth2

码匠君大约 4 分钟配置属性

[一]登录失败次数限制配置

前缀：herodotus.oauth2.authentication.sign-in-failure-limited

enabled

  • Type: Boolean
  • Default: true

是否开启登录失败检测，默认开启.

max-times

  • Type: Integer
  • Default: 5

允许最大失败次数.

auto-unlock

  • Type: Boolean
  • Default: true

是否自动解锁被锁定用户，默认开启.

expire

  • Type: Duration
  • Default: 2h

记录失败次数的缓存过期时间，默认：2小时。

注

需要使用 Spring Boot Duration 类型参数配置的格式进行配置

  • ns for nanoseconds (纳秒)
  • us for microseconds (微秒)
  • ms for milliseconds (毫秒)
  • s for seconds (秒)
  • m for minutes (分)
  • h for hours (时)
  • d for days (天)

[二]登录使用终端限制配置

前缀：herodotus.oauth2.authentication.sign-in-endpoint-limited

enabled

  • Type: Boolean
  • Default: false

同一终端登录限制是否开启，默认关闭。

警告

该配置与 herodotus.oauth2.authentication.sign-in-kick-out-limited.enabled 是互斥关系。不能同时为 true。

maximum

  • Type: Integer
  • Default: 1

同一终端，允许同时登录的最大数量。

[三]同一账号登录踢出配置

前缀：herodotus.oauth2.authentication.sign-in-kick-out-limited

enabled

  • Type: Boolean
  • Default: true

是否开启 Session 踢出功能，默认开启

警告

该配置与 herodotus.oauth2.authentication.sign-in-endpoint-limited.enabled 是互斥关系。不能同时为 true。

[四]自定义授权码登录页面配置

前缀：herodotus.oauth2.authentication.form-login

username-parameter

  • Type: String
  • Default: username

修改自定义 Spring Security 登录页面用户名参数名称

在某些安全测试要求中，认为使用 username 等常见英文单词作为用户名参数会存在安全隐患，可通过该配置进行修改

password-parameter

  • Type: String
  • Default: password

修改自定义 Spring Security 登录页面密码参数名称

在某些安全测试要求中，认为使用 password 等常见英文单词作为密码参数会存在安全隐患，可通过该配置进行修改

remember-me-parameter

  • Type: String
  • Default: remember-me

修改自定义 Spring Security 登录页面 RemeberMe 参数名称

login-page-url

  • Type: String
  • Default: /login

授权码模式登录页面地址

failure-url

  • Type: String
  • Default: /login?error

授权码模式登录页面登录错误地址

logout-success-url

  • Type: String
  • Default: /login?logout

授权码模式登录页面注销地址

registration-url

  • Type: String
  • Default: 空

自定义注册操作页面 URL。如果配置了该参数，则会在授权码模式登录页面中显示 还没有系统账号? 注册

forgot-password-url

  • Type: String
  • Default: 空

自定义忘记密码操作页面 URL。如果配置了该参数，则会在授权码模式登录页面中显示 忘记密码

  • Type: Duration
  • Default: 30d

为了统一授权码模式登录页面与一人一码数据加密传输体系，在授权码页面没有拿到 Session 时，主动生成 Session。生成的 Session 需要存放在 Cookie 中，该参数用于指定存放 Session 的 Cookie 默认有效期。

注

需要使用 Spring Boot Duration 类型参数配置的格式进行配置

  • ns for nanoseconds (纳秒)
  • us for microseconds (微秒)
  • ms for milliseconds (毫秒)
  • s for seconds (秒)
  • m for minutes (分)
  • h for hours (时)
  • d for days (天)

captcha-enabled

  • Type: Boolean
  • Default: true

授权码模式登录页面是否显示验证码。

category

  • Type: String
  • Default: HUTOOL_GIF

授权码模式登录页面显示的验证码类型。当前支持的验证码类型：

  • ARITHMETIC：算数类型验证码
  • CHINESE：中文类型验证码
  • CHINESE_GIF：中文GIF类型验证码
  • SPEC_GIF：GIF类型验证码
  • SPEC：PNG类型验证码
  • HUTOOL_LINE：Hutool线段干扰验证码
  • HUTOOL_CIRCLE：Hutool圆圈干扰验证码
  • HUTOOL_SHEAR：Hutool扭曲干扰验证码
  • HUTOOL_GIF：Hutool GIF验证码

警告

Herodotus Cloud 还支持滑块拼图验证码（JIGSAW） 和文字点选验证码（WORD_CLICK）。但是，这里不支持行为验证码的配置，所以如果配置了行为验证码类型：JIGSAW 和 WORD_CLICK 将不会显示验证，操作也会出错

[五]电子邮件消息配置

前缀：herodotus.oauth2.authentication.mail

expire

  • Type: Duration
  • Default: 5m

电子邮件验证码有效期。

注

需要使用 Spring Boot Duration 类型参数配置的格式进行配置

  • ns for nanoseconds (纳秒)
  • us for microseconds (微秒)
  • ms for milliseconds (毫秒)
  • s for seconds (秒)
  • m for minutes (分)
  • h for hours (时)
  • d for days (天)

length

  • Type: Integer
  • Default: 6

电子邮件验证码位数。默认为6位数字。

service-account

  • Type: String
  • Default: 空

系统服务通知统一Email账号。

注

不配置该参数，将不会发送邮件

verify-email-url

  • Type: String
  • Default: 空

验证电子邮件功能发送的验证跳转 Url，可结合自己业务定义。

modifyPasswordUrl

  • Type: String
  • Default: 空

登录位置异常提醒邮件中提供的修改密码 URL，可结合自己业务定义。