RestfulAPI接口安全性设计

Z时代
2024-01-10
分类：综合

1.API接口设计规范

https://github.com/mishe/blog/issues/129

2.安全性设计

a.白名单限制

仅接受特定系统的请求响应，调用方的IP地址需要在本系统中报备，否则无法调用

b.合法身份合法性验证

Basic Authentication :这种方式是直接将用户名和密码放到Header中，使用 Authorization: Basic Zm9vOmJhcg== ，使用最简单但是最不安全。

TOKEN认证:这种方式也是再HTTP头中，使用 Authorization: Bearer <token> ，使用最广泛的TOKEN是JWT，通过签名过的TOKEN。

Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准（(RFC 7519).该token被设计为紧凑且安全的，特别适用于分布式站点的单点登录（SSO）场景。

类似JWT，只是用户登录成功后将token信息是保存在redis中，可以设置token有效期,或主动将token失效等，并返回给用户。

其他认证接口时必须在header中输入token信息，并验证。

@Aspect
@Component
public class SecurityAspect {
    @Resource(name = "redisTokenManager")
    private TokenManager tokenManager;
    @Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")
    public void controllerAspect() {
    }
    /**
     * 接收到客户端请求时执行
     * 
     * @param pjp
     * @return
     * @throws Throwable
     */
    @Around("controllerAspect()")
    public Object execute(ProceedingJoinPoint pjp) throws Throwable {
	// 从切点上获取目标方法
	MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
	Method method = methodSignature.getMethod();
	/**
	 * 验证Token
	 */
	if (method.isAnnotationPresent(TokenSecurity.class)) {
	    // 从 request header 中获取当前 token
	    HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes())
		    .getRequest();
	    String token = request.getHeader(Constant.DEFAULT_TOKEN_NAME);
	    if (StringUtils.isEmpty(token)) {
		throw new TokenException("客户端X-Token参数不能为空,且从Header中传入,如果没有登录,请先登录获取Token");
	    }
	    // 检查 token 有效性
	    if (!tokenManager.checkToken(token)) {
		String message = String.format("Token [%s] 非法", token);
		throw new TokenException(message);
	    }
	}
	// 调用目标方法
	return pjp.proceed();
    }
}