[Spring Boot] AOP를 활용한 커스텀 애노테이션 만들기

2024.11.17 - [BE/🍃 Spring] - [Spring Boot] AOP 개념 정리

2024.11.18 - [BE/🍃 Spring] - [Spring Boot] AOP 사용 방법과 예시코드

 

현재 진행하고 있는 프로젝트의 일부 API에서 요청/응답 데이터를 End-to-End 암호화 해서 통신하고 있습니다. 그러다 보니 Controller 혹은 암복호화와 관련 없는 로직에 암호화 관련 코드가 들어가야 하는 경우가 있었습니다. 

암복호화를 수행하는 static object를 만들어 사용을 해왔었는데, AOP를 이용해서 이를 개선해 보면 어떨까 싶었습니다. 요청 객체 자체를 가로채 복호화 해서 평문값을 바로 Controller에서 사용할 수 있게 하고, 응답을 클라이언트에 전달하기 전에 응답 값을 가로채 암호화 하고 전달할 수 있게 하여 Controller에서 횡단 관심사인 암복호화 aspect를 분리해 낼 수 있을 것이라 생각했습니다. 

 

일부 API에서 암복호화가 진행됬기 때문에 Controller 클래스나 패키지 단위가 아닌 커스텀 애너테이션 있는 메서드를 대상으로 요청/응답 암복호화를 진행하기로 했습니다. 그리고 애너테이션을 사용하면 이로 인해 이 메서드가 어떤 동작을 할 것인지 함께 일하는 개발자에게 명시적으로 보여줄 수 있을 것이라 판단했습니다.

 

결론적으로 해당 방법을 실제 코드에 적용하진 못했지만 AOP와 애너테이션 조합을 공유하면 좋을 것 같아 글을 작성했습니다

---

기본코드

    @PostMapping("/regist")
    public ResponseEntity<BaseResponse> regist(
            @RequestBody RegistAccountRequest request
    ) {
        RegistAccountResponse registAccountResponse = bankService.registAccount(request);
        BaseResponse response = BaseResponse.builder()
                .code("00000")
                .msg("success")
                .data(registAccountResponse)
                .build();
        return ResponseEntity.ok(response);
    }

 

// request
{
    "owner_name" : "user1",
    "password" : "2017",
    "amount" : 1000000
}

// response
{
    "code": "00000",
    "msg": "success",
    "data": {
        "accountNumber": "084256-19-1458"
    }
}

 

기본 코드는 평문 request/response를 사용합니다.

 

암복호화 

    @PostMapping("/regist")
    public ResponseEntity<BaseResponse> regist(
            @RequestBody BaseRequest request
    ) throws Exception {
        String plaintText = AESUtil.decrypt(request.getData()); // v
        RegistAccountRequest registAccountRequest = objectMapper.readValue(plaintText, RegistAccountRequest.class); // v
        RegistAccountResponse registAccountResponse = bankService.registAccount(registAccountRequest);
        String dataJson = objectMapper.writeValueAsString(registAccountResponse); // v

        BaseResponse response = BaseResponse.builder()
                .code("00000")
                .msg("success")
                .data(AESUtil.encrypt(dataJson)) // v
                .build();

        return ResponseEntity.ok(response);
    }

 

엄격한 보안을 위해 End-to-End 암호화를 진행한다고 해봅시다. 예제 코드에서는 Controller에 request를 복호화 하고 response를 암호화 하는 코드를 간단히 작성했습니다. 이 중에서 reqeust를 평문으로 만드는 것과, 응답의 body에 들어가는 객체를 암호화 하는 것을 커스텀 애너테이션과 aop를 사용해서 작성해 보겠습니다.

// request
{   
    "data" : "/PJ/p778x9sf8G0YXUUxGwn5NRhrPu4gWqwxKxDdQMxwq+wxJAxOucVvZSmzEnjNu/Z41THSQKzaQn8IVEZxfg=="
}

// response
{
    "code": "00000",
    "msg": "success",
    "data": "dMDQDB5ePZTBfxDJtkSREbZEHxguTT5RI+4MoBjtcVNWimRi/Ypg1NlXrHr9Rn+O"
}

 

암복호화시 request/response 예시는 위 코드와 같습니다. 예시를 위해 간단한 암호화를 진행했습니다.

 

AESUtil

public class AESUtil {
    private static final String SECRET_KEY = "youabledevsecret";

    public static String encrypt(String data) throws Exception {
        SecretKey secretKey = new SecretKeySpec(SECRET_KEY.getBytes(), "AES");
        Cipher cipher = Cipher.getInstance("AES");
        cipher.init(Cipher.ENCRYPT_MODE, secretKey);
        return Base64.getEncoder().encodeToString(cipher.doFinal(data.getBytes()));
    }

    public static String decrypt(String data) throws Exception {
        SecretKeySpec secretKey = new SecretKeySpec(SECRET_KEY.getBytes(), "AES");
        Cipher cipher = Cipher.getInstance("AES");
        cipher.init(Cipher.DECRYPT_MODE, secretKey);
        return new String(cipher.doFinal(Base64.getDecoder().decode(data)));
    }
}

 

예시 코드를 위해 보안에 취약한 암복호화 Util을 생성했습니다.

 

Custom Annotation

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface DecryptRequest {
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface EncryptResponse {
}

 

커스텀 애너테이션을 생성해 줍니다.

DecryptRequest는 암호화된 요청 데이터를 복호화 하고, EncryptResponse는 응답을 암호화 하는데 사용합니다

 

AOP

@Aspect
@Component
@RequiredArgsConstructor
public class EncryptionAspect {

}

 

Aspect를 추가해 줍니다.

 

    @Around("@annotation(DecryptRequest)")
    public Object decryptRequest(ProceedingJoinPoint joinPoint, DecryptRequest decryptRequest) throws Throwable {
        Object[] args = joinPoint.getArgs();

        if (args.length > 0 && args[0] instanceof BaseRequest request) {
            String decryptedJson = AESUtil.decrypt(request.getData());
            request.setData(decryptedJson);
        }
        return joinPoint.proceed(args);
    }

 

DecryptRequest 애너테이션이 붙어 있는 메서드의 첫번째 파라미터인 BaseRequest의 data를 복호화 하여 다시 해당 메서드의 파라미터로 전달해줍니다. 

 

    @Around("@annotation(EncryptResponse)")
    public Object encryptResponse(ProceedingJoinPoint joinPoint, EncryptResponse encryptResponse) throws Throwable {
        Object result = joinPoint.proceed();

        if (result instanceof ResponseEntity<?> responseEntity) {
            Object body = responseEntity.getBody();

            if (body instanceof BaseResponse baseResponse) {
                String dataJson = objectMapper.writeValueAsString(baseResponse.getData());
                String encryptedData = AESUtil.encrypt(dataJson);

                BaseResponse encryptedResponse = BaseResponse.builder()
                        .code(baseResponse.getCode())
                        .msg(baseResponse.getMsg())
                        .data(encryptedData)
                        .build();

                return ResponseEntity.ok(encryptedResponse);
            }
        }

        return result;
    }

 

EncryptResponse 애너테이션이 추가된 메서드가 호출되고 난 후 리턴 값인 ResponseEntity<BaseResponse>을 전달 받아 BaseResponse의 data 부분을 암호화 하여 다시 호출된 메서드로 전달합니다.

 

Result

    @DecryptRequest
    @EncryptResponse
    @PostMapping("/regist")
    public ResponseEntity<BaseResponse> regist(
            @RequestBody BaseRequest request
    ) throws Exception {
        RegistAccountRequest registAccountRequest = objectMapper.readValue(request.getData(), RegistAccountRequest.class); // v
        RegistAccountResponse registAccountResponse = bankService.registAccount(registAccountRequest);
        BaseResponse response = BaseResponse.builder()
                .code("00000")
                .msg("success")
                .data(registAccountResponse)
                .build();

        return ResponseEntity.ok(response);
    }

 

요청/응답 암복호화를 원하는 메서드에 애너테이션을 추가합니다. Controller 로직에서 암복호화 하는 로직이 Aspect로 분리되었습니다

 

// request
{   
    "data" : "/PJ/p778x9sf8G0YXUUxGwn5NRhrPu4gWqwxKxDdQMxwq+wxJAxOucVvZSmzEnjNu/Z41THSQKzaQn8IVEZxfg=="
}

// response
{
    "code": "00000",
    "msg": "success",
    "data": "dMDQDB5ePZTBfxDJtkSREfohsFHbBF6VrddM4ZnyN3hWimRi/Ypg1NlXrHr9Rn+O"
}