gocap

type Cap struct {
	// contains filtered or unexported fields
}

type CapOption func(c *Cap)

type ChallengeData struct {
	Challenge ChallengeItem `json:"challenge"`
	Expires   int64         `json:"expires"` //过期时间,毫秒级时间戳
	Token     string        `json:"token"`   //质询令牌
}

type ChallengeItem struct {
	C int `json:"c"` //质询数量
	S int `json:"s"` //质询大小
	D int `json:"d"` //质询难度
}

type MemoryStorage struct {
	// contains filtered or unexported fields
}

type RedisStorage struct {
	// contains filtered or unexported fields
}

type RedisStorageConfig struct {
	RedisAddr string `json:"redis_addr"` //required. host:port
	RedisUser string `json:"redis_user"` //optional.
	RedisPass string `json:"redis_pass"` //optional.
	RedisDb   int    `json:"redis_db"`   //optional.

	PrefixChallenge string `json:"prefix_challenge"` //质询数据缓存前缀
	PrefixToken     string `json:"prefix_token"`     //验证令牌数据缓存前缀
}

type Storage interface {
	// SetChallenge 设置质询令牌
	//   - {token} 质询令牌
	//   - {expiresTs} 过期时刻, 秒级时间戳
	SetChallenge(ctx context.Context, token string, expiresTs int64) error
	// GetChallenge 获取质询令牌过期时间
	//   - {token} 质询令牌
	//   - {isGetDel} 是否获取后删除. 可选
	GetChallenge(ctx context.Context, token string, isGetDel ...bool) (ts int64, exists bool)

	// SetToken 设置验证令牌
	//   - {key} 验证令牌Key
	//   - {expiresTs} 过期时刻, 秒级时间戳
	SetToken(ctx context.Context, key string, expiresTs int64) error
	// GetToken 获取验证令牌过期时间
	//   - {key} 验证令牌Key
	//   - {isGetDel} 是否获取后删除. 可选
	GetToken(ctx context.Context, key string, isGetDel ...bool) (ts int64, exists bool)

	// Cleanup 清理过期数据
	Cleanup() error
}

type TokenData struct {
	Expires int64  `json:"expires,omitzero"` //过期时间,毫秒级时间戳
	Token   string `json:"token,omitzero"`   //验证令牌
}

type VerificationParams struct {
	Token     string  `json:"token"`              //质询令牌
	Solutions []int64 `json:"solutions,omitzero"` //质询解方案组
}

type VerificationResult struct {
	*TokenData
	Success bool   `json:"success"`
	Message string `json:"message,omitzero"`
}