JAVA | JWT (JSON Web Token) 을 이용한 Bearer 검증

▶ JSON Web Token

정보를 안전하게 전송하기 위해 웹 표준(RFC 7519) 방식으로, 인증에 필요한 중요정보(api key, api secret) 만료일, 발행자, 암호화 알고리즘과 같은 기본 정보까지 포함하고 있다.

JSON 문자열을 BASE64 인코딩하고 뒷부분에 문자열을 서버에 있는(우리가 생성해서 사용할) 비밀 키로 Hashing 해서 덧붙여 전송한다.

 

아래처럼 3가지(header, payload, signatue) 정보가.으로 구분되어 합쳐진 형태를 가지고 있다.

 

HEADER.PAYLOAD.SIGNATUE

 

Step

1. Secret Key (임의의 문자열을 사용 또는 문자열을 Base64 등으로 인코딩하여 사용) 를 바탕으로 setJwtToken (/api/create/token) 을 호출하여 토큰을 생성한다.

2. 생성된 토큰을 Header의 Authorization에 Bearer 토큰 형식으로 넣은 후 restApiPost (/api/post) 을 호출하여 토큰을 검증한다.

3. 검증 후 응답할 데이터를 JSONObject에 담아서 사용한다.

 

※ 프론트엔드 & 백엔드 과정에서 사용할 refreshToken 생성이 필요한 경우 createToken 메서드에서 추가적으로 만료시간등을 확장하여 생성하면 된다. (생성 시 refreshToken에는 필요 없는 claim, subject 등은 제외해도 된다.)

 

1. pom.xml에 jjwt dependency를 추가

 

<dependency>
    <groupId>io.jsonwebtoken</groupId>
    <artifactId>jjwt</artifactId>
    <version>0.9.1</version>
</dependency>

 

 

2. 토큰 생성 및 검증 Class 작성

 

import java.io.UnsupportedEncodingException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.ExpiredJwtException;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;    

/*
JWT(Json Web Token)란 Json 포맷을 이용하여 사용자에 대한 속성을 저장하는 
Claim 기반의 Web Token이다. 
JWT는 토큰 자체를 정보로 사용하는 Self-Contained 방식으로 정보를 안전하게 전달한다. 
 */
public class JwtTokenUtil {
    
    // 토큰 생성
    public String createToken(String jwtSecretKey) {
        /*
         *  HEADER 부분 설정
         * 
            헤더는 typ과 alg 두 가지 정보로 구성된다. alg는 헤더(Header)를 암호화 하는 것이 아니고, 
            Signature를 해싱하기 위한 알고리즘을 지정하는 것이다.
            typ: 토큰의 타입을 지정 ex) JWT
            alg: 알고리즘 방식을 지정하며, 서명(Signature) 및 토큰 검증에 사용 ex) HS256(SHA256) 또는 RSA
        */
        Map<String, Object> headers = new HashMap<>();
        
        // Type 설정
        headers.put("typ", "JWT");
        
        // HS256는 해시 알고리즘의 일종으로, base64와 같이 임의로 디코딩을 할 수 없습니다.
        headers.put("alg", "HS256");

        /*
         * PAYLOAD 부분 설정
         * 
            토큰의 페이로드에는 토큰에서 사용할 정보의 조각들인 클레임(Claim)이 담겨 있다. 
            클레임은 총 3가지로 나누어지며, 
            Json(Key/Value) 형태로 다수의 정보를 넣을 수 있다.
            header와 payload에는 기밀정보는 넣으면 안된다.
        */
        Map<String, Object> payloads = new HashMap<>();
        
        // API 용도에 맞게 암호화 하여 properties로 관리해서 사용하는것을 권장한다.
        payloads.put("apiKey", "lf2McyT3V5gDu2pNNm4VxmX3C2mezX3s");
		
        // 토큰 유효 시간 (2시간)
        Long expiredTime = 1000 * 60L * 60L * 2L;
		
        // 토큰 만료 시간
        Date ext = new Date(); 
        ext.setTime(ext.getTime() + expiredTime);
        
        /*
         *  토큰 Builder
         * 
            등록된 클레임은 토큰 정보를 표현하기 위해 이미 정해진 종류의 데이터들로, 
            모두 선택적으로 작성이 가능하며 사용할 것을 권장한다. 
            또한 JWT를 간결하게 하기 위해 key는 모두 길이 3의 String이다. 
            여기서 subject로는 unique한 값을 사용하는데, 사용자 이메일을 주로 사용한다.
            
            iss: 토큰 발급자(issuer)
            sub: 토큰 제목(subject)
            aud: 토큰 대상자(audience)
            exp: 토큰 만료 시간(expiration), NumericDate 형식으로 되어 있어야 함 ex) 1480849147370
            nbf: 토큰 활성 날짜(not before), 이 날이 지나기 전의 토큰은 활성화되지 않음
            iat: 토큰 발급 시간(issued at), 토큰 발급 이후의 경과 시간을 알 수 있음
            jti: JWT 토큰 식별자(JWT ID), 중복 방지를 위해 사용하며, 일회용 토큰(Access Token) 등에 사용
            
            *Signature(서명)
            서명(Signature)은 토큰을 인코딩하거나 유효성 검증을 할 때 사용하는 고유한 암호화 코드이다. 
            서명(Signature)은 위에서 만든 헤더(Header)와 페이로드(Payload)의 값을 각각 BASE64로 인코딩하고,
            인코딩한 값을 비밀 키를 이용해 헤더(Header)에서 정의한 알고리즘으로 해싱을 하고, 
            이 값을 다시 BASE64로 인코딩하여 생성한다.
        */
        String jwt = Jwts.builder()
                .setHeader(headers) // Headers 설정
                .setClaims(payloads) // Claims 설정
                .setSubject("user-auth") // 토큰 용도 
                .setExpiration(ext) // 토큰 만료 시간 설정
                .signWith(SignatureAlgorithm.HS256, jwtSecretKey.getBytes()) // HS256과 Key로 Sign
                .compact(); // 토큰 생성

        return jwt;
    }

    // 토큰 검증
    public Map<String, Object> verifyJWT(String jwtSecretKey, String authorization) throws UnsupportedEncodingException {
        
        Map<String, Object> claimMap = null;
        
        try {
            Claims claims = Jwts.parser()
                    .setSigningKey(jwtSecretKey.getBytes("UTF-8")) // Set SignKey
                    .parseClaimsJws(authorization) // 파싱 및 검증, 실패 시 에러
                    .getBody();

            claimMap = claims;
            
            //Date expiration = claims.get("exp", Date.class);
            //String data = claims.get("data", String.class);
        } 
        catch (ExpiredJwtException e) { // 토큰이 만료되었을 경우
            System.out.println("# expir ===");
            System.out.println(e);
        } 
        catch (Exception e) { // 그외 에러났을 경우
            System.out.println("# error ===");
            System.out.println(e);
        }
        
        return claimMap;
    }    
}

 

 

3. JWT 토큰 생성 및 검증 Class 작성

 

//Getter, Setter Auto Create
@Data
public class JwtVo {
    private String jwtSecretKey;
    private String token;
    private String data;
}

 

import java.util.Map;
import java.util.regex.Pattern;
import javax.servlet.http.HttpServletRequest;
import org.json.JSONObject;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.podo.common.vo.JwtVo;
import com.podo.core.util.JwtTokenUtil;

/*
@RestController : 기본으로 하위에 있는 메소드들은 모두 @ResponseBody를 가지게 된다.
@RequestBody : 클라이언트가 요청한 XML/JSON을 자바 객체로 변환해서 전달 받을 수 있다.
@ResponseBody : 자바 객체를 XML/JSON으로 변환해서 응답 객체의 Body에 실어 전송할 수 있다.
    클라이언트에게 JSON 객체를 받아야 할 경우는 @RequestBody, 
    자바 객체를 클라이언트에게 JSON으로 전달해야할 경우에는 
    @ResponseBody 어노테이션을 붙여주면 된다. 
@ResponseBody를 사용한 경우 View가 아닌 자바 객체를 리턴해주면 된다.
*/
@RestController
@RequestMapping("/api")
public class SampleApiController {

    // properties - jwt.secret.key
    @Value("${globals.jwt.secret.key}")
    private String jwtSecretKey;

    // properties - jwt.member.api.key
    @Value("${globals.jwt.member.api.key}")
    private String jwtMemberApiKey;

    JwtTokenUtil jwtUtil = new JwtTokenUtil();

    @PostMapping("/create/token")
    public String setJwtToken(@RequestBody JwtVo jwtVo) throws Exception {

        String key = jwtVo.getJwtSecretKey();

        JSONObject jsonObj = new JSONObject();

        if (!"".equals(key)) {
            jsonObj.put("token", jwtUtil.createToken(key));
        } else {
            jsonObj.put("token", "");
        }

        return jsonObj.toString();
    }

    @PostMapping("/post")
    public String restApiPost(HttpServletRequest request, @RequestBody JwtVo jwtVo) throws Exception {

        String authorization = request.getHeader("Authorization");

        JSONObject jsonObj = new JSONObject();

        if ("".equals("authorization")) {
            throw new Exception("Authorization isEmpty");
        } else {
            // Authorized Bearer
            if (Pattern.matches("^Bearer .*", authorization)) {
                authorization = authorization.replaceAll("^Bearer( )*", "");

                Map < String, Object > jwsClaims = jwtUtil.verifyJWT(jwtSecretKey, authorization);

                if (jwsClaims.get("apiKey") != null) {
                    String apiKey = jwsClaims.get("apiKey").toString();

                    // Authorized Users
                    if (jwtMemberApiKey.equals(apiKey)) {
                        jsonObj.put("result", "success");
                        jsonObj.put("name", "jackson");
                        jsonObj.put("job", "singer");
                    } else { // Unauthenticated User 
                        jsonObj.put("result", "fail");
                    }
                } else {
                    throw new Exception("ApiKey Empty Exception");
                }
            } else {
                throw new Exception("InvalidTokenException");
            }
        }

        return jsonObj.toString();
    }
}

 

 

JwtTokenUtil Download

JwtTokenUtil.zip

0.00MB