[:sparkles: feat] jwt 추가

HyungJooKim · HyungJooKim · commit df5ac86add62 · 2021-12-29T21:38:28.000+09:00
1.회원가입, 로그인을 위한 jwt 관련 class 추가
diff --git a/src/main/java/com/readydance/backend/jwt/JwtAuthenticationFilter.java b/src/main/java/com/readydance/backend/jwt/JwtAuthenticationFilter.java
@@ -0,0 +1,76 @@
+package com.readydance.backend.jwt;
+
+import com.readydance.backend.dto.UserPrincipal;
+import org.springframework.security.authentication.AuthenticationManager;
+import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.AuthenticationException;
+import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
+
+import javax.servlet.FilterChain;
+import javax.servlet.http.Cookie;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
+import java.util.ArrayList;
+
+/**
+ * JWT를 이용한 로그인 인증
+ * 로그인에 성공했을 시 User 정보로(payload 에 담아) JWT Token 을 생성하고 JWT 토큰을 응답 쿠키에 넣어준다.
+ */
+public class JwtAuthenticationFilter extends UsernamePasswordAuthenticationFilter {
+
+    private final AuthenticationManager authenticationManager;
+
+    public JwtAuthenticationFilter(AuthenticationManager authenticationManager) {
+        super(authenticationManager);
+        this.authenticationManager = authenticationManager;
+    }
+
+    /**
+     * 로그인 인증 시도
+     */
+    @Override
+    public Authentication attemptAuthentication(
+            HttpServletRequest request,
+            HttpServletResponse response
+    ) throws AuthenticationException {
+        // 로그인할 때 입력한 username과 password를 가지고 authenticationToken를 생성한다.
+        UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(
+                request.getParameter("username"),
+                request.getParameter("password"),
+                new ArrayList<>()
+        );
+        return authenticationManager.authenticate(authenticationToken);
+    }
+
+    /**
+     * 인증에 성공했을 때 사용
+     * JWT Token 을 생성해서 쿠키에 넣는다.
+     */
+    @Override
+    protected void successfulAuthentication(
+            HttpServletRequest request,
+            HttpServletResponse response,
+            FilterChain chain,
+            Authentication authResult
+    ) throws IOException {
+        UserPrincipal user = (UserPrincipal) authResult.getPrincipal();
+        String token = JwtUtils.createToken(user);
+        // 쿠키 생성(쿠키이름 + 값)
+        Cookie cookie = new Cookie(JwtProperties.COOKIE_NAME, token);
+        cookie.setMaxAge(JwtProperties.EXPIRATION_TIME); // 쿠키의 만료시간 설정 (현재 10분으로 설정해 놓음)
+        cookie.setPath("/"); //사용할 수 있는 경로 설정 (root)
+        response.addCookie(cookie); //응답에 쿠키를 넣는다.
+        response.sendRedirect("/"); //redirection url 을 root 로 설정
+    }
+
+    @Override
+    protected void unsuccessfulAuthentication(
+            HttpServletRequest request,
+            HttpServletResponse response,
+            AuthenticationException failed
+    ) throws IOException {
+        response.sendRedirect("/login"); //실패 시 다시 login 페이지로 돌아갈 수 있도록 redirection 설정
+    }
+}
diff --git a/src/main/java/com/readydance/backend/jwt/JwtKey.java b/src/main/java/com/readydance/backend/jwt/JwtKey.java
@@ -0,0 +1,56 @@
+package com.readydance.backend.jwt;
+
+import io.jsonwebtoken.security.Keys;
+import org.springframework.data.util.Pair;
+
+import java.nio.charset.StandardCharsets;
+import java.security.Key;
+import java.util.Map;
+import java.util.Random;
+
+/**
+ * JWT Key를 제공하고 조회
+ */
+public class JwtKey {
+    /**
+     * Kid-Key List 외부로 절대 유출되어서는 안되어 따라서 Key Rolling 적용
+     * Key Rolling : Secret Key 를 여러개 사용하고 수시로 수정을 해주어서 안전한 상태로 유지
+     * Secret Key 1개에 Unique Id (kid) 를 연결시켜 JWT 토큰을 만들 때 kid 를 포함하여 제공 하고 토큰을 해석할 때 kid 를 통해 signature 를 검증
+     */
+    private static final Map<String, String> SECRET_KEY_SET = Map.of(
+            "key1", "SpringSecurityJWTPracticeProjectIsSoGoodAndThisProjectIsSoFunSpringSecurityJWTPracticeProjectIsSoGoodAndThisProjectIsSoFun"
+    );
+    /*
+     "key2", "GoodSpringSecurityNiceSpringSecurityGoodSpringSecurityNiceSpringSecurityGoodSpringSecurityNiceSpringSecurityGoodSpringSecurityNiceSpringSecurity",
+            "key3", "HelloSpringSecurityHelloSpringSecurityHelloSpringSecurityHelloSpringSecurityHelloSpringSecurityHelloSpringSecurityHelloSpringSecurityHelloSpringSecurity"
+     */
+    //Todo 알고리즘 추가해서
+    private static final String[] KID_SET = SECRET_KEY_SET.keySet().toArray(new String[0]);
+    private static Random randomIndex = new Random();
+
+    /**
+     * 위 3가지 키 set 중에서 SECRET_KEY_SET 에서 랜덤한 KEY 를 가져온다.
+     *
+     * @return kid와 key Pair
+     */
+    public static Pair<String, Key> getRandomKey() {
+        String kid = KID_SET[randomIndex.nextInt(KID_SET.length)];
+        String secretKey = SECRET_KEY_SET.get(kid);
+        return Pair.of(kid, Keys.hmacShaKeyFor(secretKey.getBytes(StandardCharsets.UTF_8)));
+    }
+
+    /**
+     * kid 를 통해 Secret Key를 찾는다.
+     *
+     * @param kid kid
+     * @return Key
+     */
+    public static Key getKey(String kid) {
+        //SECRET_KEY 를 통해 객체 생성
+        String key = SECRET_KEY_SET.getOrDefault(kid, null);
+        if (key == null)
+            return null;
+        //Secret_key 의 길이에 따라서 적절한 암호화 방식을 선택해줌
+        return Keys.hmacShaKeyFor(key.getBytes(StandardCharsets.UTF_8));
+    }
+}
diff --git a/src/main/java/com/readydance/backend/jwt/JwtProperties.java b/src/main/java/com/readydance/backend/jwt/JwtProperties.java
@@ -0,0 +1,9 @@
+package com.readydance.backend.jwt;
+
+/**
+ * JWT 기본 설정값
+ */
+public class JwtProperties {
+    public static final int EXPIRATION_TIME = 600000; // 10분
+    public static final String COOKIE_NAME = "JWT-AUTHENTICATION";
+}
diff --git a/src/main/java/com/readydance/backend/jwt/JwtUtils.java b/src/main/java/com/readydance/backend/jwt/JwtUtils.java
@@ -0,0 +1,126 @@
+package com.readydance.backend.jwt;
+
+import com.readydance.backend.dto.UserPrincipal;
+import io.jsonwebtoken.*;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.redis.core.RedisTemplate;
+import org.springframework.data.util.Pair;
+import org.springframework.stereotype.Service;
+
+import javax.servlet.http.HttpServletRequest;
+import java.security.Key;
+import java.util.Date;
+
+// Json 웹 토큰을 생성하고 확인
+@Service
+@Slf4j
+public class JwtUtils {
+
+    private Pair<String, Key> accessTokenSecret = JwtKey.getRandomKey();;
+
+    private Pair<String, Key> refreshTokenSecret = JwtKey.getRandomKey();;
+
+
+    private static final String HEADER_NAME = "Authorization";
+
+    @Autowired
+    RedisTemplate<String, Object> redisTemplate;
+
+    public enum TokenType { ACCESS_TOKEN, REFRESH_TOKEN }
+
+    /**
+     * 토큰에서 username 찾기
+     *
+     * @param token 토큰
+     * @return username
+     */
+    public static String getUsername(String token) {
+        // parsing 을 통해 jwtToken 에서 username 을 찾는다.
+        return Jwts.parserBuilder()
+                //secret key 를 꺼내와 검증 실패 시 SignatureException 발생, 만료 시 ExpiredJwtException 발생
+                .setSigningKeyResolver(SigningKeyResolver.instance)
+                .build()
+                .parseClaimsJws(token)//토큰을 주입(파싱)
+                .getBody()
+                .getSubject(); // username
+    }
+
+    /**
+     * user로 토큰 생성
+     * HEADER(JWT 를 검증하는데 필요한 정보를 가진 객체) : alg(signature 에 사용한 암호화 알고리즘), kid
+     * PAYLOAD(실질적으로 인증에 필요한 데이터를 저장) : sub(유저 네임), iat(토큰 발행 시간), exp(토큰 만료 시간)
+     * 인증할 떄 payload 에 있는 username 을 가져와서 조회할 때 사용한다.
+     * SIGNATURE(jwt token 이 올바른지에 대한 일종의 서명) : JwtKey.getRandomKey 로 구한 Secret Key 로 HS512 해시(암호화)
+     * signature 는 header 와 payload 를 합친 뒤 비밀키로 hash 를 생성하여 암호화 한다.
+     * @param user 유저
+     * @return jwt token
+     */
+    public static String createToken(UserPrincipal user) {
+        Claims claims = Jwts.claims().setSubject(user.getUsername()); // subject
+        Date now = new Date(); // 현재 시간
+        Pair<String, Key> key = JwtKey.getRandomKey();
+        // JWT Token 생성
+        return Jwts.builder()
+                .setClaims(claims) // subject 정보 저장
+                .setIssuedAt(now)  // 토큰 발행 시간 정보 저장
+                .setExpiration(new Date(now.getTime() + JwtProperties.EXPIRATION_TIME)) // 토큰 만료 시간 설정 저장
+                .setHeaderParam(JwsHeader.KEY_ID, key.getFirst()) // 헤더 설정 key.getFirst() : kid
+                .signWith(key.getSecond()) // signature
+                .compact();
+    }
+
+    // Access Token 발급
+    public String generateAccessToken(UserPrincipal userPrincipal) {
+        return createToken(userPrincipal);
+    }
+
+    // Refresh Token 발급
+    public String generateRefreshToken(UserPrincipal userPrincipal) {
+        return createToken(userPrincipal);
+    }
+
+    // Request의 Header에서 token 파싱
+    public String extractToken(HttpServletRequest request) {
+        return request.getHeader(HEADER_NAME);
+    }
+
+    // Jwt 토큰 유효성검사
+    public boolean validateToken(String token) {
+        Pair<String, Key> secretKey = accessTokenSecret;
+        try {
+            log.debug("validateToken's secretKey : " + secretKey);
+            // 1. setSigningKey를 통해 디지털 서명되었는지를 확인한다.
+            Jws<Claims> claims = Jwts.parser()
+                    .setSigningKey(secretKey.getSecond())
+                    .parseClaimsJws(token);
+            // 2. 만료일자가 지났는지 확인한다.
+            boolean isNotExpire = !claims.getBody().getExpiration().before(new Date()); // 만료되면 false를 반환
+            // 3. 블랙리스트인지 확인한다.
+            if (redisTemplate.opsForValue().get(token) != null) { // 블랙리스트에 access token이 존재할 경우
+                log.info("이미 로그아웃 처리된 사용자입니다.");
+                return false;
+            }
+            return isNotExpire;
+        } catch (Exception e) {
+            return false;
+        }
+    }
+
+    public Date getExpirationDate(String token, TokenType tokenType) {
+        Pair<String, Key> secretKey;
+
+        if (tokenType == TokenType.ACCESS_TOKEN) {
+            secretKey = accessTokenSecret;
+        } else {
+            secretKey = refreshTokenSecret;
+        }
+
+        log.debug("getExpirationDate's secretKey : " + secretKey);
+        return Jwts.parser()
+                .setSigningKey(secretKey.getSecond())
+                .parseClaimsJws(token)
+                .getBody()
+                .getExpiration();
+    }
+}
diff --git a/src/main/java/com/readydance/backend/jwt/SigningKeyResolver.java b/src/main/java/com/readydance/backend/jwt/SigningKeyResolver.java
@@ -0,0 +1,24 @@
+package com.readydance.backend.jwt;
+
+import io.jsonwebtoken.Claims;
+import io.jsonwebtoken.JwsHeader;
+import io.jsonwebtoken.SigningKeyResolverAdapter;
+
+import java.security.Key;
+
+/**
+ * JwsHeader 를 통해 Signature 검증에 필요한 Key 를 가져오는 코드를 구현
+ */
+public class SigningKeyResolver extends SigningKeyResolverAdapter {
+    public static SigningKeyResolver instance = new SigningKeyResolver();
+
+    @Override
+    public Key resolveSigningKey(JwsHeader jwsHeader, Claims claims) {
+        //header 에서 kid 를 찾고 kid 로 secret key 를 가져옴
+        //즉 secret key 를 꺼내와 검증을 할 수 있게 도와주는 역할
+        String kid = jwsHeader.getKeyId();
+        if (kid == null)
+            return null;
+        return JwtKey.getKey(kid);
+    }
+}
