Java 生鮮電商平臺 - API 接口設(shè)計之 token、timestamp、sign 具體架構(gòu)與實現(xiàn)
鏈接 : www.cnblogs.com/jurendage/p/12653865.html

一:token 簡介
Token:訪問令牌access token, 用于接口中, 用于標(biāo)識接口調(diào)用者的身份、憑證,減少用戶名和密碼的傳輸次數(shù)。一般情況下客戶端(接口調(diào)用方)需要先向服務(wù)器端申請一個接口調(diào)用的賬號,服務(wù)器會給出一個appId和一個key, key用于參數(shù)簽名使用,注意key保存到客戶端,需要做一些安全處理,防止泄露。
API Token(接口令牌): 用于訪問不需要用戶登錄的接口,如登錄、注冊、一些基本數(shù)據(jù)的獲取等。獲取接口令牌需要拿appId、timestamp和sign來換,sign=加密(timestamp+key)
USER Token(用戶令牌): 用于訪問需要用戶登錄之后的接口,如:獲取我的基本信息、保存、修改、刪除等操作。獲取用戶令牌需要拿用戶名和密碼來換
二:timestamp 簡介
DoS
Pingflood: 該攻擊在短時間內(nèi)向目的主機(jī)發(fā)送大量ping包,造成網(wǎng)絡(luò)堵塞或主機(jī)資源耗盡。
Synflood: 該攻擊以多個隨機(jī)的源主機(jī)地址向目的主機(jī)發(fā)送SYN包,而在收到目的主機(jī)的SYN ACK后并不回應(yīng),這樣,目的主機(jī)就為這些源主機(jī)建立了大量的連接隊列,而且由于沒有收到ACK一直維護(hù)著這些隊列,造成了資源的大量消耗而不能向正常請求提供服務(wù)。
Smurf:該攻擊向一個子網(wǎng)的廣播地址發(fā)一個帶有特定請求(如ICMP回應(yīng)請求)的包,并且將源地址偽裝成想要攻擊的主機(jī)地址。子網(wǎng)上所有主機(jī)都回應(yīng)廣播包請求而向被攻擊主機(jī)發(fā)包,使該主機(jī)受到攻擊。
Land-based:攻擊者將一個包的源地址和目的地址都設(shè)置為目標(biāo)主機(jī)的地址,然后將該包通過IP欺騙的方式發(fā)送給被攻擊主機(jī),這種包可以造成被攻擊主機(jī)因試圖與自己建立連接而陷入死循環(huán),從而很大程度地降低了系統(tǒng)性能。 Ping of Death:根據(jù)TCP/IP的規(guī)范,一個包的長度最大為65536字節(jié)。盡管一個包的長度不能超過65536字節(jié),但是一個包分成的多個片段的疊加卻能做到。當(dāng)一個主機(jī)收到了長度大于65536字節(jié)的包時,就是受到了Ping of Death攻擊,該攻擊會造成主機(jī)的宕機(jī)。 Teardrop:IP數(shù)據(jù)包在網(wǎng)絡(luò)傳遞時,數(shù)據(jù)包可以分成更小的片段。攻擊者可以通過發(fā)送兩段(或者更多)數(shù)據(jù)包來實現(xiàn)TearDrop攻擊。第一個包的偏移量為0,長度為N,第二個包的偏移量小于N。為了合并這些數(shù)據(jù)段,TCP/IP堆棧會分配超乎尋常的巨大資源,從而造成系統(tǒng)資源的缺乏甚至機(jī)器的重新啟動。 PingSweep:使用ICMP Echo輪詢多個主機(jī)。
三:sign 簡介
四:防止重復(fù)提交
注意:所有的安全措施都用上的話有時候難免太過復(fù)雜,在實際項目中需要根據(jù)自身情況作出裁剪,比如可以只使用簽名機(jī)制就可以保證信息不會被篡改,或者定向提供服務(wù)的時候只用Token機(jī)制就可以了。如何裁剪,全看項目實際情況和對接口安全性的要求。
五:使用流程
接口調(diào)用方(客戶端)向接口提供方(服務(wù)器)申請接口調(diào)用賬號,申請成功后,接口提供方會給接口調(diào)用方一個appId和一個key參數(shù) 客戶端攜帶參數(shù)appId、timestamp、sign去調(diào)用服務(wù)器端的API token,其中sign=加密(appId + timestamp + key) 客戶端拿著api_token 去訪問不需要登錄就能訪問的接口 當(dāng)訪問用戶需要登錄的接口時,客戶端跳轉(zhuǎn)到登錄頁面,通過用戶名和密碼調(diào)用登錄接口,登錄接口會返回一個usertoken, 客戶端拿著usertoken 去訪問需要登錄才能訪問的接口
六:示例代碼
1. dependency
org.springframework.boot spring-boot-starter-data-redis redis.clients jedis 2.9.0 org.springframework.boot spring-boot-starter-web
2. RedisConfiguration
@Configurationpublic class RedisConfiguration {@Beanpublic JedisConnectionFactory jedisConnectionFactory(){return new JedisConnectionFactory();}/*** 支持存儲對象* @return*/@Beanpublic RedisTemplateredisTemplate(){ RedisTemplateredisTemplate = new StringRedisTemplate(); redisTemplate.setConnectionFactory(jedisConnectionFactory());Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);ObjectMapper objectMapper = new ObjectMapper();objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);jackson2JsonRedisSerializer.setObjectMapper(objectMapper);redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);redisTemplate.afterPropertiesSet();return redisTemplate;}}
3. TokenController
@Slf4j@RestController@RequestMapping("/api/token")public class TokenController {@Autowiredprivate RedisTemplate redisTemplate;/*** API Token** @param sign* @return*/@PostMapping("/api_token")public ApiResponseapiToken(String appId, @RequestHeader("timestamp") String timestamp, @RequestHeader("sign") String sign) { Assert.isTrue(!StringUtils.isEmpty(appId) && !StringUtils.isEmpty(timestamp) && !StringUtils.isEmpty(sign), "參數(shù)錯誤");long reqeustInterval = System.currentTimeMillis() - Long.valueOf(timestamp);Assert.isTrue(reqeustInterval < 5 * 60 * 1000, "請求過期,請重新請求");// 1. 根據(jù)appId查詢數(shù)據(jù)庫獲取appSecretAppInfo appInfo = new AppInfo("1", "12345678954556");// 2. 校驗簽名String signString = timestamp + appId + appInfo.getKey();String signature = MD5Util.encode(signString);log.info(signature);Assert.isTrue(signature.equals(sign), "簽名錯誤");// 3. 如果正確生成一個token保存到redis中,如果錯誤返回錯誤信息AccessToken accessToken = this.saveToken(0, appInfo, null);return ApiResponse.success(accessToken);}@NotRepeatSubmit(5000)@PostMapping("user_token")public ApiResponseuserToken(String username, String password) { // 根據(jù)用戶名查詢密碼, 并比較密碼(密碼可以RSA加密一下)UserInfo userInfo = new UserInfo(username, "81255cb0dca1a5f304328a70ac85dcbd", "111111");String pwd = password + userInfo.getSalt();String passwordMD5 = MD5Util.encode(pwd);Assert.isTrue(passwordMD5.equals(userInfo.getPassword()), "密碼錯誤");// 2. 保存TokenAppInfo appInfo = new AppInfo("1", "12345678954556");AccessToken accessToken = this.saveToken(1, appInfo, userInfo);userInfo.setAccessToken(accessToken);return ApiResponse.success(userInfo);}private AccessToken saveToken(int tokenType, AppInfo appInfo, UserInfo userInfo) {String token = UUID.randomUUID().toString();// token有效期為2小時Calendar calendar = Calendar.getInstance();calendar.setTime(new Date());calendar.add(Calendar.SECOND, 7200);Date expireTime = calendar.getTime();// 4. 保存tokenValueOperationsoperations = redisTemplate.opsForValue(); TokenInfo tokenInfo = new TokenInfo();tokenInfo.setTokenType(tokenType);tokenInfo.setAppInfo(appInfo);if (tokenType == 1) {tokenInfo.setUserInfo(userInfo);}operations.set(token, tokenInfo, 7200, TimeUnit.SECONDS);AccessToken accessToken = new AccessToken(token, expireTime);return accessToken;}public static void main(String[] args) {long timestamp = System.currentTimeMillis();System.out.println(timestamp);String signString = timestamp + "1" + "12345678954556";String sign = MD5Util.encode(signString);System.out.println(sign);System.out.println("-------------------");signString = "password=123456&username=1&12345678954556" + "ff03e64b-427b-45a7-b78b-47d9e8597d3b1529815393153sdfsdfsfs" + timestamp + "A1scr6";sign = MD5Util.encode(signString);System.out.println(sign);}}
4. WebMvcConfiguration
@Configurationpublic class WebMvcConfiguration extends WebMvcConfigurationSupport {private static final String[] excludePathPatterns = {"/api/token/api_token"};@Autowiredprivate TokenInterceptor tokenInterceptor;@Overridepublic void addInterceptors(InterceptorRegistry registry) {super.addInterceptors(registry);registry.addInterceptor(tokenInterceptor).addPathPatterns("/api/**").excludePathPatterns(excludePathPatterns);}}5. TokenInterceptor@Componentpublic class TokenInterceptor extends HandlerInterceptorAdapter {@Autowiredprivate RedisTemplate redisTemplate;/**** @param request* @param response* @param handler 訪問的目標(biāo)方法* @return* @throws Exception*/@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {String token = request.getHeader("token");String timestamp = request.getHeader("timestamp");// 隨機(jī)字符串String nonce = request.getHeader("nonce");String sign = request.getHeader("sign");Assert.isTrue(!StringUtils.isEmpty(token) && !StringUtils.isEmpty(timestamp) && !StringUtils.isEmpty(sign), "參數(shù)錯誤");// 獲取超時時間NotRepeatSubmit notRepeatSubmit = ApiUtil.getNotRepeatSubmit(handler);long expireTime = notRepeatSubmit == null ? 5 * 60 * 1000 : notRepeatSubmit.value();// 2. 請求時間間隔long reqeustInterval = System.currentTimeMillis() - Long.valueOf(timestamp);Assert.isTrue(reqeustInterval < expireTime, "請求超時,請重新請求");// 3. 校驗Token是否存在ValueOperationstokenRedis = redisTemplate.opsForValue(); TokenInfo tokenInfo = tokenRedis.get(token);Assert.notNull(tokenInfo, "token錯誤");// 4. 校驗簽名(將所有的參數(shù)加進(jìn)來,防止別人篡改參數(shù)) 所有參數(shù)看參數(shù)名升續(xù)排序拼接成url// 請求參數(shù) + token + timestamp + nonceString signString = ApiUtil.concatSignString(request) + tokenInfo.getAppInfo().getKey() + token + timestamp + nonce;String signature = MD5Util.encode(signString);boolean flag = signature.equals(sign);Assert.isTrue(flag, "簽名錯誤");// 5. 拒絕重復(fù)調(diào)用(第一次訪問時存儲,過期時間和請求超時時間保持一致), 只有標(biāo)注不允許重復(fù)提交注解的才會校驗if (notRepeatSubmit != null) {ValueOperationssignRedis = redisTemplate.opsForValue(); boolean exists = redisTemplate.hasKey(sign);Assert.isTrue(!exists, "請勿重復(fù)提交");signRedis.set(sign, 0, expireTime, TimeUnit.MILLISECONDS);}return super.preHandle(request, response, handler);}}
6. MD5Util ----MD5工具類,加密生成數(shù)字簽名
public class MD5Util {private static final String hexDigits[] = { "0", "1", "2", "3", "4", "5","6", "7", "8", "9", "a", "b", "c", "d", "e", "f" };private static String byteArrayToHexString(byte b[]) {StringBuffer resultSb = new StringBuffer();for (int i = 0; i < b.length; i++)resultSb.append(byteToHexString(b[i]));return resultSb.toString();}private static String byteToHexString(byte b) {int n = b;if (n < 0)n += 256;int d1 = n / 16;int d2 = n % 16;return hexDigits[d1] + hexDigits[d2];}public static String encode(String origin) {return encode(origin, "UTF-8");}public static String encode(String origin, String charsetname) {String resultString = null;try {resultString = new String(origin);MessageDigest md = MessageDigest.getInstance("MD5");if (charsetname == null || "".equals(charsetname))resultString = byteArrayToHexString(md.digest(resultString.getBytes()));elseresultString = byteArrayToHexString(md.digest(resultString.getBytes(charsetname)));} catch (Exception exception) {}return resultString;}}
7. @NotRepeatSubmit ??-----自定義注解,防止重復(fù)提交。
/*** 禁止重復(fù)提交*/@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)public @interface NotRepeatSubmit {/** 過期時間,單位毫秒 **/long value() default 5000;}
8. AccessToken
@Data@AllArgsConstructorpublic class AccessToken {/** token */private String token;/** 失效時間 */private Date expireTime;}
9. AppInfo
@Data@NoArgsConstructor@AllArgsConstructorpublic class AppInfo {/** App id */private String appId;/** API 秘鑰 */private String key;}
10. TokenInfo
@Datapublic class TokenInfo {/** token類型: api:0 、user:1 */private Integer tokenType;/** App 信息 */private AppInfo appInfo;/** 用戶其他數(shù)據(jù) */private UserInfo userInfo;}
11. UserInfo
@Datapublic class UserInfo {/** 用戶名 */private String username;/** 手機(jī)號 */private String mobile;/** 郵箱 */private String email;/** 密碼 */private String password;/** 鹽 */private String salt;private AccessToken accessToken;public UserInfo(String username, String password, String salt) {this.username = username;this.password = password;this.salt = salt;}}
12. ApiCodeEnum
/*** 錯誤碼code可以使用純數(shù)字,使用不同區(qū)間標(biāo)識一類錯誤,也可以使用純字符,也可以使用前綴+編號** 錯誤碼:ERR + 編號** 可以使用日志級別的前綴作為錯誤類型區(qū)分 Info(I) Error(E) Warning(W)** 或者以業(yè)務(wù)模塊 + 錯誤號** TODO 錯誤碼設(shè)計** Alipay 用了兩個code,兩個msg(https://docs.open.alipay.com/api_1/alipay.trade.pay)*/public enum ApiCodeEnum {SUCCESS("10000", "success"),UNKNOW_ERROR("ERR0001","未知錯誤"),PARAMETER_ERROR("ERR0002","參數(shù)錯誤"),TOKEN_EXPIRE("ERR0003","認(rèn)證過期"),REQUEST_TIMEOUT("ERR0004","請求超時"),SIGN_ERROR("ERR0005","簽名錯誤"),REPEAT_SUBMIT("ERR0006","請不要頻繁操作"),;/** 代碼 */private String code;/** 結(jié)果 */private String msg;ApiCodeEnum(String code, String msg) {this.code = code;this.msg = msg;}public String getCode() {return code;}public String getMsg() {return msg;}}
13. ApiResult
@Data@NoArgsConstructor@AllArgsConstructorpublic class ApiResult {/** 代碼 */private String code;/** 結(jié)果 */private String msg;}
14. ApiUtil ?-------這個參考支付寶加密的算法寫的.我直接Copy過來了。
public class ApiUtil {/*** 按參數(shù)名升續(xù)拼接參數(shù)* @param request* @return*/public static String concatSignString(HttpServletRequest request) {MapparamterMap = new HashMap<>(); request.getParameterMap().forEach((key, value) -> paramterMap.put(key, value[0]));// 按照key升續(xù)排序,然后拼接參數(shù)SetkeySet = paramterMap.keySet(); String[] keyArray = keySet.toArray(new String[keySet.size()]);Arrays.sort(keyArray);StringBuilder sb = new StringBuilder();for (String k : keyArray) {// 或略掉的字段if (k.equals("sign")) {continue;}if (paramterMap.get(k).trim().length() > 0) {// 參數(shù)值為空,則不參與簽名sb.append(k).append("=").append(paramterMap.get(k).trim()).append("&");}}return sb.toString();}public static String concatSignString(Mapmap) { MapparamterMap = new HashMap<>(); map.forEach((key, value) -> paramterMap.put(key, value));// 按照key升續(xù)排序,然后拼接參數(shù)SetkeySet = paramterMap.keySet(); String[] keyArray = keySet.toArray(new String[keySet.size()]);Arrays.sort(keyArray);StringBuilder sb = new StringBuilder();for (String k : keyArray) {if (paramterMap.get(k).trim().length() > 0) {// 參數(shù)值為空,則不參與簽名sb.append(k).append("=").append(paramterMap.get(k).trim()).append("&");}}return sb.toString();}/*** 獲取方法上的@NotRepeatSubmit注解* @param handler* @return*/public static NotRepeatSubmit getNotRepeatSubmit(Object handler) {if (handler instanceof HandlerMethod) {HandlerMethod handlerMethod = (HandlerMethod) handler;Method method = handlerMethod.getMethod();NotRepeatSubmit annotation = method.getAnnotation(NotRepeatSubmit.class);return annotation;}return null;}}
15. ApiResponse
@Data@Slf4jpublic class ApiResponse{ /** 結(jié)果 */private ApiResult result;/** 數(shù)據(jù) */private T data;/** 簽名 */private String sign;public staticApiResponse success(T data) { return response(ApiCodeEnum.SUCCESS.getCode(), ApiCodeEnum.SUCCESS.getMsg(), data);}public static ApiResponse error(String code, String msg) {return response(code, msg, null);}public staticApiResponse response(String code, String msg, T data) { ApiResult result = new ApiResult(code, msg);ApiResponse response = new ApiResponse();response.setResult(result);response.setData(data);String sign = signData(data);response.setSign(sign);return response;}private staticString signData(T data) { // TODO 查詢keyString key = "12345678954556";MapresponseMap = null; try {responseMap = getFields(data);} catch (IllegalAccessException e) {return null;}String urlComponent = ApiUtil.concatSignString(responseMap);String signature = urlComponent + "key=" + key;String sign = MD5Util.encode(signature);return sign;}/*** @param data 反射的對象,獲取對象的字段名和值* @throws IllegalArgumentException* @throws IllegalAccessException*/public static MapgetFields(Object data) throws IllegalAccessException, IllegalArgumentException { if (data == null) return null;Mapmap = new HashMap<>(); Field[] fields = data.getClass().getDeclaredFields();for (int i = 0; i < fields.length; i++) {Field field = fields[i];field.setAccessible(true);String name = field.getName();Object value = field.get(data);if (field.get(data) != null) {map.put(name, value.toString());}}return map;}}
七: ThreadLocal
ThreadLocal是線程內(nèi)的全局上下文。就是在單個線程中,方法之間共享的內(nèi)存,每個方法都可以從該上下文中獲取值和修改值。
實際案例:
在調(diào)用api時都會傳一個token參數(shù),通常會寫一個攔截器來校驗token是否合法,我們可以通過token找到對應(yīng)的用戶信息(User),如果token合法,然后將用戶信息存儲到ThreadLocal中,這樣無論是在controller、service、dao的哪一層都能訪問到該用戶的信息。作用類似于Web中的request作用域。
傳統(tǒng)方式我們要在方法中訪問某個變量,可以通過傳參的形式往方法中傳參,如果多個方法都要使用那么每個方法都要傳參;如果使用ThreadLocal所有方法就不需要傳該參數(shù)了,每個方法都可以通過ThreadLocal來訪問該值。
ThreadLocalUtil.set("key", value); 保存值
T value = ThreadLocalUtil.get("key"); 獲取值
ThreadLocalUtil
public class ThreadLocalUtil{ private static final ThreadLocal@Overrideprotected MapinitialValue() { return new HashMap<>(4);}};public static MapgetThreadLocal(){ return threadLocal.get();}public staticT get(String key) { Map map = (Map)threadLocal.get();return (T)map.get(key);}public staticT get(String key,T defaultValue) { Map map = (Map)threadLocal.get();return (T)map.get(key) == null ? defaultValue : (T)map.get(key);}public static void set(String key, Object value) {Map map = (Map)threadLocal.get();map.put(key, value);}public static void set(MapkeyValueMap) { Map map = (Map)threadLocal.get();map.putAll(keyValueMap);}public static void remove() {threadLocal.remove();}public staticMap fetchVarsByPrefix(String prefix) { Mapvars = new HashMap<>(); if( prefix == null ){return vars;}Map map = (Map)threadLocal.get();Setset = map.entrySet(); for( Map.Entry entry : set){Object key = entry.getKey();if( key instanceof String ){if( ((String) key).startsWith(prefix) ){vars.put((String)key,(T)entry.getValue());}}}return vars;}public staticT remove(String key) { Map map = (Map)threadLocal.get();return (T)map.remove(key);}public static void clear(String prefix) {if( prefix == null ){return;}Map map = (Map)threadLocal.get();Setset = map.entrySet(); ListremoveKeys = new ArrayList<>(); for( Map.Entry entry : set ){Object key = entry.getKey();if( key instanceof String ){if( ((String) key).startsWith(prefix) ){removeKeys.add((String)key);}}}for( String key : removeKeys ){map.remove(key);}}}
總結(jié)
這個是目前第三方數(shù)據(jù)接口交互過程中常用的一些參數(shù)與使用示例,希望對大家有點幫助。
當(dāng)然如果為了保證更加的安全,可以加上RSA,RSA2,AES等等加密方式,保證了數(shù)據(jù)的更加的安全,但是唯一的缺點是加密與解密比較耗費CPU的資源。
之前博主分享了很多資源,有的已經(jīng)刪除了(你懂得),如果有的你當(dāng)時沒有領(lǐng)到還想領(lǐng)得就可以加我微信,我在發(fā)給你,你需要得資源也可以給我說,我盡力給你找~
