此组件支持query、json表单签名
请求头需添加以下参数
| 参数名称 | 必填 | 说明 | 示例 |
|---|---|---|---|
| x-ca-key | 是 | 应用Id (服务端生成) | 1683980765855 |
| x-ca-nonce | 是 | 每次请求随机生成(UUID) | 8091a230-8c4f-4d6f-b4be-6c585af6c8ad |
| x-ca-timestamp | 是 | 请求时间戳（毫秒） | 1683980765855 |
| x-ca-signature-method | 是 | 签名方法 | MD5 |
| x-ca-signature | 是 | 签名 | 5b2T5oiR6YGH5LiK5L2g |
<dependency>
<groupId>cn.idea360</groupId>
<artifactId>api-signature</artifactId>
<version>1.2.0</version>
</dependency> String sign = base64(md5AsHex(queryString+body+nonce+timestamp+appSecret));
- MD5
- HmacSHA1
- HmacSHA256
支持自定义签名算法(可覆盖内置算法), 通过
cn.idea360.signature.configration.SignatureConfigration.addSignatureAlgorithm注入
- GET
- POST Content-Type:application/x-www-form-urlencoded
- POST Content-Type:application/json
- POST Content-Type:multipart/form-data
签名配置
示例中配置URI /sign/** 需要验签, 签名中心分发的密钥信息为:
appName: 当我遇上你
appId: xxx
appSecret: 123
signatureMethod: MD5
package cn.idea360.signature;
import cn.idea360.signature.configration.SignatureConfigration;
import cn.idea360.signature.filter.SignatureFilter;
import cn.idea360.signature.properties.Secret;
import cn.idea360.signature.properties.SignatureProperties;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.Collections;
/**
* @author cuishiying
*/
@Configuration
public class SignatureAutoConfiguration {
@Bean
@ConditionalOnMissingBean({SignatureProperties.class})
public SignatureProperties signatureProperties() {
SignatureProperties signatureProperties = new SignatureProperties();
signatureProperties.setIncludedUris(Collections.singletonList("/sign/**"));
signatureProperties.setSecrets(Collections.singletonList(Secret.builder()
.appName("当我遇上你")
.appId("xxx")
.appSecret("123")
.build()));
return signatureProperties;
}
@Bean
@ConditionalOnMissingBean({SignatureConfigration.class})
public SignatureConfigration signatureConfigration(SignatureProperties signatureProperties) {
SignatureConfigration signatureConfigration = new SignatureConfigration();
signatureConfigration.setSignatureProperties(signatureProperties);
return signatureConfigration;
}
@Bean
@ConditionalOnMissingBean({SignatureFilter.class})
public FilterRegistrationBean<SignatureFilter> filterRegistration(SignatureConfigration signatureConfigration) {
FilterRegistrationBean<SignatureFilter> registration = new FilterRegistrationBean<>();
registration.setFilter(new SignatureFilter(signatureConfigration));
registration.addUrlPatterns("/*");
registration.setName("SignatureFilter");
registration.setOrder(1);
return registration;
}
}接口请求示例