基于JWT的token身份认证方案
一、使用JSON Web Token的好处?
1.性能问题。二、JSON Web Token是什么?
JWT是基于token的身份认证的方案。
json web token全称。可以保证安全传输的前提下传送一些基本的信息,以减轻对外部存储的依赖,减少了分布式组件的依赖,减少了硬件的资源。
可实现无状态、分布式的Web应用授权,jwt的安全特性保证了token的不可伪造和不可篡改。
本质上是一个独立的身份验证令牌,可以包含用户标识、用户角色和权限等信息,以及您可以存储任何其他信息(自包含)。任何人都可以轻松读取和解析,并使用密钥来验证真实性。
缺陷:
JWT就是一个字符串,经过加密处理与校验处理的字符串,形式为:
A.B.C
A由JWT头部信息header加密得到
B由JWT用到的身份验证信息json数据加密得到
C由A和B加密得到,是校验部分
头部部分header
{
“alg”: “HS256”,
“typ”: “JWT”
}
alg描述的是签名算法。默认值是HS256。
将header用base64加密,得到A。
载荷部分payload
{
“iss”: “发行者”,
“sub”: 主题”,
“aud”: “观众”,
“exp”:”过期时间”,
“iat”:”签发时间”
以下可以添加自定义数据
“id”:”1”,
“nickname”:”昵称”
}
根据JWT claim set[用base64]加密得到的。claim set是一个json数据,是表明用户身份的数据,可自行指定字段很灵活,也有固定字段表示特定含义(但不一定要包含特定字段,只是推荐)。
Base64算法是可逆的,不可以在载荷部分保存用户密码等敏感信息。如果业务需要,也可以采用对称密钥加密。
签名部分signature
HMACSHA256(Base64(Header) + “.” + Base64(Payload), secret),secret是加密的盐。
签名的目的是用来验证头部和载荷是否被非法篡改。
验签过程描述:获取token值,读取Header部分并Base64解码,得到签名算法。根据以上方法算出签名,如果签名信息不一致,说明是非法的。
三、JSON Web Token工作原理
-
初次登录:用户初次登录,输入用户名密码
-
密码验证:服务器从数据库取出用户名和密码进行验证
-
生成JWT:服务器端验证通过,根据从数据库返回的信息,以及预设规则,生成JWT
-
返还JWT:服务器的将token放在cookie中将JWT返还
-
带JWT的请求:以后客户端发起请求,带上cookie中的token信息。
四、jwt+redis的登录方案流程:
-
前端服务器收到用户登录请求,传给后台API网关。
- API网关把请求分发到用户服务里进行身份验证。
-
后台用户服务验证通过,然后从账号信息抽取出userName、login_time等基本信息组成payload,进而组装一个JWT,把JWT放入redis(因为退出的时候无法使jwt立即作废,所以使用保存在redis中,退出的时候delete掉就可以了,鉴权的时候加一层判断jwt是否在redis里,如果不在则证明jwt已过期作废),然后包装cookie中返回到前端服务器,这就登录成功了。
-
前端服务器拿到JWT,进行存储(可以存储在缓存中,也可以存储在数据库中,如果是浏览器,可以存储在 localStorage 中,我实现的是放入到cookie里面)
-
登录后,再访问其他微服务的时候,前端会携带jwt访问后台,后台校验 JWT,验签通过后,返回相应资源和数据就可以了。
(这里没有将redis画出来)
结合拦截器与上篇session-cookie方式的区别:
首次登录步骤:
1.首先AuthInterceptor拦截器拦截用户请求,在preHandle中看cookie中是否有token信息,没有就接着拦截器AuthActionInterceptor拦截需要登录的url,看threadlocal当中是否有user对象,如果没有就跳转到登录页面进行登录,登录成功后会将user对象放到threadlocal中。(注意这个地方和上篇中提到的登录成功后将user放到session的不同)
登录处理流程:在数据库中查询验证用户名密码,通过就讲账号信息抽取出username、email等信息组成一个payload,进而组装成一个JWT,然后将JWT放到redis当中,设置过期时间。
生成token:
给定签名算法、给定载荷的map、进行签名
2.当业务逻辑处理完之后在AuthInterceptor的postHandle中,从threadlocal获取user对象中的token信息,将token放到cookie中返回给前端。
3.请求结束后在AuthInterceptor的afterCompletion将user从threadlocal中移除。
验证流程:
前端将携带jwt的cookie传到后台,AuthInterceptor会根据token验证解析出user,(注意根之前在session中取对象的不同)验证后再将user放到threadlocal中,AuthActionInterceptor一看threadlocal有user对象,直接通过。后面的步骤一样。
验证token:
1)从token的Header中拿出签名算法,看和之前生成token的签名算法是否一致。
2)验证签名,获取载荷map,从中获取用户标识email,在redis中看是否失效,如果失效,抛出未登录错误;如果未失效,更新redis的失效时间,返回用户的信息。
AuthInterceptor
@Component public class AuthInterceptor implements HandlerInterceptor { private static final String TOKEN_COOKIE = "token"; @Autowired private UserDao userDao; @Override public boolean preHandle(HttpServletRequest req, HttpServletResponse res, Object handler) throws Exception { Map<String, String[]> map = req.getParameterMap(); map.forEach((k,v) ->req.setAttribute(k, Joiner.on(",").join(v))); String requestURI = req.getRequestURI(); if (requestURI.startsWith("/static") || requestURI.startsWith("/error")) { return true; } Cookie cookie = WebUtils.getCookie(req, TOKEN_COOKIE); if (cookie != null && StringUtils.isNoneBlank(cookie.getValue())) { User user = userDao.getUserByToken(cookie.getValue()); if (user != null) { req.setAttribute(CommonConstants.LOGIN_USER_ATTRIBUTE, user); // req.setAttribute(CommonConstants.USER_ATTRIBUTE, user); UserContext.setUser(user); } } return true; } @Override public void postHandle(HttpServletRequest req, HttpServletResponse res, Object handler, ModelAndView modelAndView) throws Exception { String requestURI = req.getRequestURI(); if (requestURI.startsWith("/static") || requestURI.startsWith("/error")) { return ; } User user = UserContext.getUser(); if (user != null && StringUtils.isNoneBlank(user.getToken())) { String token = requestURI.startsWith("logout")? "" : user.getToken(); Cookie cookie = new Cookie(TOKEN_COOKIE, token); //此处的参数,是相对于应用服务器存放应用的文件夹的根目录而言的(比如tomcat下面的webapp),因此cookie.setPath("/"); //之后,可以在webapp文件夹下的所有应用共享cookie,而cookie.setPath("/webapp_b/"); //是指cas应用设置的cookie只能在webapp_b应用下的获得,即便是产生这个cookie的cas应用也不可以。 cookie.setPath("/"); //如果在Cookie中设置了"HttpOnly"为true属性,那么通过JavaScript脚本将无法读取到Cookie信息,这样能有效的防止XSS攻击,让网站应用更加安全。 //这里可以让js读取,置为false cookie.setHttpOnly(false); res.addCookie(cookie); } } @Override public void afterCompletion(HttpServletRequest req, HttpServletResponse response, Object handler, Exception ex) throws Exception { UserContext.remove(); } }
AuthActionInterceptor
@Component public class AuthActionInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest req, HttpServletResponse res, Object handler) throws Exception { User user = UserContext.getUser(); if (user == null) { String msg = URLEncoder.encode("请先登录", "utf-8"); StringBuffer sb = req.getRequestURL(); String target = URLEncoder.encode(sb.toString(), "utf-8"); if ("GET".equalsIgnoreCase(req.getMethod())) { res.sendRedirect("/accounts/signin?errorMsg=" + msg + "&target=" + target); }else { res.sendRedirect("/accounts/signin?errorMsg=" + msg); } return false; } return true; } @Override public void postHandle(HttpServletRequest req, HttpServletResponse res, Object handler, ModelAndView modelAndView) throws Exception { } @Override public void afterCompletion(HttpServletRequest req, HttpServletResponse response, Object handler, Exception ex) throws Exception { } }
UserService
/** * 校验用户名密码、生成token并返回用户对象 * @param email * @param passwd * @return */ public User auth(String email, String passwd) { if (StringUtils.isBlank(email) || StringUtils.isBlank(passwd)) { throw new UserException(Type.USER_AUTH_FAIL,"User Auth Fail"); } User user = new User(); user.setEmail(email); user.setPasswd(HashUtils.encryPassword(passwd)); //user.setEnable(1); List<User> list = getUserByQuery(user); if (!list.isEmpty()) { User retUser = list.get(0); onLogin(retUser); return retUser; } throw new UserException(Type.USER_AUTH_FAIL,"User Auth Fail"); } //生成token的操作 private void onLogin(User user) { //最后一个是时间戳 String token = JwtHelper.genToken(ImmutableMap.of("email", user.getEmail(), "name", user.getName(),"ts",Instant.now().getEpochSecond()+"")); renewToken(token,user.getEmail()); user.setToken(token); } //重新设置缓存过期时间 private String renewToken(String token, String email) { redisTemplate.opsForValue().set(email, token); redisTemplate.expire(email, 30, TimeUnit.MINUTES); return token; } //验证token获取登录用户 public User getLoginedUserByToken(String token) { Map<String, String> map = null; try { map = JwtHelper.verifyToken(token); } catch (Exception e) { throw new UserException(Type.USER_NOT_LOGIN,"User not login"); } String email = map.get("email"); Long expired = redisTemplate.getExpire(email); //判断是否失效 if (expired > 0L) { renewToken(token, email); User user = getUserByEmail(email); user.setToken(token); return user; } throw new UserException(Type.USER_NOT_LOGIN,"user not login"); } private User getUserByEmail(String email) { User user = new User(); user.setEmail(email); List<User> list = getUserByQuery(user); if (!list.isEmpty()) { return list.get(0); } throw new UserException(Type.USER_NOT_FOUND,"User not found for " + email); } public void invalidate(String token) { Map<String, String> map = JwtHelper.verifyToken(token); redisTemplate.delete(map.get("email")); }
JWTHelper
public class JwtHelper { private static final String SECRET = "session_secret"; //发布者 后面一块去校验 private static final String ISSUER = "mooc_user"; //生成token的操作 public static String genToken(Map<String, String> claims){ try { //签名算法 Algorithm algorithm = Algorithm.HMAC256(SECRET); JWTCreator.Builder builder = JWT.create().withIssuer(ISSUER).withExpiresAt(DateUtils.addDays(new Date(), 1)); //相当于将claims存储在token中 claims.forEach((k,v) -> builder.withClaim(k, v)); return builder.sign(algorithm).toString(); } catch (IllegalArgumentException | UnsupportedEncodingException e) { throw new RuntimeException(e); } } //验证token public static Map<String, String> verifyToken(String token) { Algorithm algorithm = null; try { algorithm = Algorithm.HMAC256(SECRET); } catch (IllegalArgumentException | UnsupportedEncodingException e) { throw new RuntimeException(e); } JWTVerifier verifier = JWT.require(algorithm).withIssuer(ISSUER).build(); DecodedJWT jwt = verifier.verify(token); Map<String, Claim> map = jwt.getClaims(); Map<String, String> resultMap = Maps.newHashMap(); map.forEach((k,v) -> resultMap.put(k, v.asString())); return resultMap; } }