[JAVA - Spring Boot] 암호화/복호화 기능 만들기

백견불여일타 스프링 부트 쇼핑몰 프로젝트 with JPA:이젠 프로젝트다!

 

 

React.js 스프링 부트 AWS로 배우는 웹 개발 101:SPA REST API 기반 웹 애플리케이션 개발

 

 

스타트 스프링 부트:초급 개발자들을 위한 가볍고 넓은 스프링 부트

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

GitHub - junyharang-coding-study/JunyHarang-JAVA-EncryptionDecryption: JAVA와 Spring Boot를 통해 Data를 암호화/복호화

 

🚀 암호화/복호화

    🔽 개요

        📦 소개

주니하랑은 현재 진행중인 Side Project에서 이용자의 개인정보 등을 암호화하여 DB에 저장하고, 권한이 있는 이용자 혹은 사용자에게는 복호화하여 노출될 수 있도록 하는 Logic을 구현하고 싶었어요.

오늘은 그 방법에 대해 Spring Boot를 가지고 놀아 보려합니다.

 

 

 

 

        📦 초기 구성

Project 생성

최초 Project를 위와 같이 생성해 줄게요.

의존성 설정

위와 같이 Spring Boot Version과 의존성을 구성해 주었어요.

build.gradle

그런 뒤 22번째에 jpa 의존성도 추가해 주었어요.

# application.yml

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://{DBMS IP}:{PORT}/{DB 이름}?serverTimezone=UTC&characterEncoding=UTF-8
    username: {DBMS 계정명}
    password: {비밀번호}
    driver-class-name: com.mysql.cj.jdbc.Driver

  jpa:
    hibernate:
      ddl-auto: create
      show_sql: true
      format_sql: true
      use_sql_comments: true
      dialect: org.hibernate.dialect.MySQL5InnoDBDialect

  h2:
    console:
      enabled: true

application.yml은 위와 같이 설정하여 DB를 사용할 수 있게 해 주었어요.

 

 

 

    🔽  암/복호화 Class

        📦 기능 구현

본격적으로 암 / 복호화 역할을 수행할 Class를 만들어 줄게요.

package com.junyharang.endecrypttest.common.constant.endecryption;

import org.apache.commons.codec.DecoderException;
import org.apache.commons.codec.binary.Hex;

import javax.crypto.BadPaddingException;
import javax.crypto.Cipher;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.StandardCharsets;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.util.Base64;
import java.util.Locale;

public class DataEnDecryption {

    public static String base64Encoder(String value) {
        byte[] byteKey = value.getBytes();
        return Base64.getEncoder().encodeToString(byteKey);
    }

    public static String dataEnDecrypt(String cipherKey, String data, int cipherMode) {

        String result = null;

        try {
            Cipher cipher = Cipher.getInstance("AES");

            byte[] initializationVector = new byte[16];
            int index = 0;

            for (byte b : cipherKey.getBytes(StandardCharsets.UTF_8)) {
                initializationVector[index++ % 16] ^= b;
            }

            SecretKeySpec keySpec = new SecretKeySpec(initializationVector, "AES");
            cipher.init(cipherMode, keySpec);

            if (cipherMode == Cipher.DECRYPT_MODE) {
                result = new String(cipher.doFinal(Hex.decodeHex(data)), StandardCharsets.UTF_8);
            } else if (cipherMode == Cipher.ENCRYPT_MODE) {
                result = new String(Hex.encodeHex(cipher.doFinal(data.getBytes(StandardCharsets.UTF_8)))).toUpperCase(Locale.ROOT);
            } else {

            }
        } catch (NoSuchAlgorithmException |
                 NoSuchPaddingException |
                 DecoderException |
                 IllegalBlockSizeException |
                 BadPaddingException |
                 InvalidKeyException error) {

            error.printStackTrace();
        }
        return result;
    }
}

반응형

전체 주니하랑이 작성한 Code는 위와 같아요.

하나하나 뜯어보면서 분석해 볼게요.

DataEnDecryption 17 ~ 22번째 줄

최초 base64Endocer라는 Method를 만들어 주었어요.
이 Method는 어떤 값을 받게 되면 해당 값을 Base64로 Encoder 해주는 Method에요.

💡 참고 사항
Base64란?
byte 형식으로 된 Binary Data를 Program 간에 다루기 편한 ascii Code로 이뤄진 Data.

컴퓨터 분야에서 쓰이는 Base 64 (베이스 육십사)란 8비트 이진 데이터(예를 들어 실행 파일이나, ZIP 파일 등)를 문자 코드에 영향을 받지 않는 공통 ASCII 영역의 문자들로만 이루어진 일련의 문자열로 바꾸는 인코딩 방식을 가리키는 개념이다.

원래 Base 64를 글자 그대로 번역하여 보면 64진법이란 뜻이다. 특별히 64진법이 컴퓨터에서 흥미로운 것은, 64가 2의 제곱수(64 = 26)이며, 2의 제곱수들에 기반한 진법들 중에서 화면에 표시되는 ASCII 문자들을 써서 표현할 수 있는 가장 큰 진법이기 때문이다. 즉, 다음 제곱수인 128진법에는 128개의 기호가 필요한데 화면에 표시되는 ASCII 문자들은 128개가 되지 않는다.

그런 까닭에 이 인코딩은 전자 메일을 통한 이진 데이터 전송 등에 많이 쓰이고 있다. Base 64에는 어떤 문자와 기호를 쓰느냐에 따라 여러 변종이 있지만, 잘 알려진 것은 모두 처음 62개는 알파벳 A-Z, a-z와 0-9를 사용하고 있으며 마지막 두 개를 어떤 기호를 쓰느냐의 차이만 있다.

출처 : https://ko.wikipedia.org/wiki/%EB%B2%A0%EC%9D%B4%EC%8A%A464

 

위와 같이 Value가 들어왔어요.

.getBytes()는 문자열(String)을 Byte Code로 Encoding 해주는 Method이고,
이걸 byte 배열로 하나하나 나누어서 변환을 해주는 Method에요.

위와 같이 getBytes() 매개 변수로 케릭터 셋을 넘기지 않으면 이용자 Platform에 기본 Charset으로 Encoding 되요.

즉, Byte의 시퀀스로 Encoding 하고, 새로운 Byte Array에 결과를 저장하도록 해요.

이 문자열이 Default Charset으로 Encoding 할 수 없는 경우 이 Method의 동작은 지정되지 않아요.

최종적으로 Base64로 Encoding되어 반환된 값은 위와 같아요.

이 Method를 만든 이유는 아래 구현된 기능 가지고 놀기를 보시면 더 자세히 이해가 되실거에요.
주니하랑은 암호화 / 복호화 Logic을 만들면서 Key가 될 값이 공개 되지 않았으면 좋겠다는 생각이 들었어요.

물론 지금 Logic도 완전히 비공개는 아니지만, 매번 게시물이 작성될 때 마다, 게시물 제목을 통해 Base64로
Encoding하여 암호화 Key에 사용된다면 하나를 정해서 계속 Key로 사용하는 것보다 안전할 것이라고 판단했기 때문에 만든 Method에요.

dataEnDecrypt()

728x90

이 부분이 본격적인 암호화 / 복호화 처리하는 Method에요.

최초 매개 변수에서 cipherKey는 AES로 암호화 할 때 사용될 Key 값을 받기 위함이고,
data는 실제 암/복호화 할 내용을 받는 것이며, cipherMode의 경우 1이 들어오면 암호화 2가 들어오면
복호화 Logic을 처리 하기 위해 매개 변수로 값을 받는 것이에요.

Cipher는 암호화 권한이 있는 사용자만 Message를 이해하거나,
접근할 수 있도록 Message를 Encoding하는 과정이에요.

Cipher Class는 암 / 복호화 기능을 제공하고, JCE Framework의 핵심 구성이에요.
또한, Java Cryptography Extension(JCE)는 JAVA 보안 기능의 핵심을 담당하는 JAVA Cryptography Architectur(JCA)의 일부분이며, Application Data 암호화, 복호화 그리고 개인 Data Hashing을 제공해요.

30번줄에 Cipher 객체를 인스턴스화 하기 위해서는 static getInstance()를 호출해야 하고, 이 때, 희망하는 암호화 방법에 대한 이름을 전달하면 됩니다. 즉, 선택적으로 provider의 이름을 표시할 수 있는 것이에요.

AES 변환은 getInstance Method에 Cipher 객체를 AES 암호화하라고 요청하는 것이에요.

💡 참고 사항
Java에서 secretKey의 길이가 32bit라면 AES-256, 24bit면 AES-192, 16bit의 경우 AES-128로 암호화

 

32번째 줄부터 33번째 줄은 byte Array 16개짜리를 생성해서 IV(Inialization Vetor, 초기화 벡터)를 만들어 줄 준비를
하고, 반복문을 돌리기 위해 Index 번호를 담을 변수를 초기화 해주었어요.

            for (byte b : cipherKey.getBytes(StandardCharsets.UTF_8)) {
                initializationVector[index++ % 16] ^= b;
            }

35 ~ 37번째 줄에 반복문을 보면 매개 변수로 전달된 암호화를 위한 Key값을 byte Array로 변환을 하는데, UTF-8 형식으로 변환하여 하나하나 반복을 할 때 마다 byte b 변수에 담겨 반복문이 돌도록 하여 주었어요.

 

int a = 5;
System.out.prinln(a ^= 3);


// 출력값 : 00000000000000000000000000000011

그런 뒤 initializationVector에 index 변수에 16을 나눈 나머지 값에 1을 더한 번째 값을 비트 단위 XOR 할당 연산자로 이진 값으로 나오도록 해주었어요. 즉, 양쪽 오퍼랜드에 대해 Bit 단위 XOR 연산을 실행하고, 그 결과를 initializationVector에 index 변수에 16을 나눈 나머지 값에 1을 더한 번째 값에 넣도록 해 주었어요.

            SecretKeySpec keySpec = new SecretKeySpec(initializationVector, "AES");
            cipher.init(cipherMode, keySpec);

그런 뒤 SecretKeySpec 생성자에 IV값과 암호화 방식을 선택할 문자열을 넣어 Key Spec을 정한 객체를 만들었어요.

Key Interface는 암호화 작업들을 위한 Key를 나타내요. Keys는 Encoding된 Key, Key의 Encoding Format, 암호화 알고리즘을 포함하는 불투명한 컨테이너에요.

Key는 일반적으로 Key Factory를 사용하는 key generators, certificates, 또는 key specifications를 통해 획득할 수 있어요. 그래서 주니하랑은 initializationVector를 통해 양방향 Key를 생성해 준 것이에요.

Cipher객체를 초기화하면서 매개변수로 입력 받은 Mode (1 = 암호화, 2 = 복호화)를 받고,
keySpec이라는 객체를 전달해 주었어요.

💡 참고 사항
Cipher 초기화(Initalizaion)

Cipher 객체 초기화를 위해 Key 혹은 증명서(Certificate) 그리고, Chpher 동작 Mode를 나타내는 opmode와 함께 init() Method 호출.

선택적으로 Random과 관련된 Source를 전달할 수 있으며, 기본적으로 가장 높은 우선 순위로 설치된 Provider의 SecureRandom 구현 사용.

알고리즘 별 매개 변수 Set을 선택적으로 지정할 수 있다. 예를 들어 IvParameterSpec을 전달하여 초기화 백터 지정 가능.

이용 가능 Cipher 동작 Mode
∙ ENCRYPT_MODE : cipher 객체를 암호화 Mode로 초기화
∙ DECRYPT_MODE: cipher 객체를 복호화 Mode로 초기화
∙ WRAP_MODE: cipher 객체를 key-wrapping Mode 초기화
∙ UNWRAP_MODE: cipher 객체를 key-unwrapping Mode 초기화

만약 공급된 Key가 길이나, Encoding이 적합하지 못해 cipher 초기화에 부적합하다면 init()은
InvalidKeyException을 터트리게 되요.

또한, Cipher가 Key에서 확인할 수 있는 특정 알고리즘 매개 변수가 필요하거나, Key가 허용 가능한 최대 크기(설정된 JCE 관할 정책 File에 따라 결정)를 초과할 경우에도 Exception이 터지게 되요.

만약 인증서를 사용하게 되면 아래 예제처럼 할 수 있어요.

public byte[] encryptMessage(byte[] message, Certificate certificate) throws InvalidKeyException, NoSuchPaddingException, NoSuchAlgorithmException {
    
    Cipher cipher = Cipher.getInstance("RSA/ECB/PKCS1Padding");
    cipher.init(Cipher.ENCRYPT_MODE, certificate);
    
    //...
}

Cipher 객체는 Data 암호화를 위해 getPublicKey()를 호출하여 인증서(certificate)로 부터
공용키를 얻게 되는 방식이에요.

40번째 줄 Debuging

if (cipherMode == Cipher.DECRYPT_MODE) {
    result = new String(cipher.doFinal(Hex.decodeHex(data)), StandardCharsets.UTF_8);
} else if (cipherMode == Cipher.ENCRYPT_MODE) {
    result = new String(Hex.encodeHex(cipher.doFinal(data.getBytes(StandardCharsets.UTF_8)))).toUpperCase(Locale.ROOT);
} else {
    throw new PropertyValueException("암/복호화 Mode 변수값이 잘못 되었습니다.", "DataEnDecryption.dataEnDecrypt(int cipherMode)", Integer.toString(cipherMode));
}

그런 뒤 위와 같이 42 ~ 48번째 줄에 if문을 통해 매개 변수로 전달된
cipherMode 변수 값이 1인지 2인지 그 외 값인지를 확인하고 있어요.

만약 1이라면 암호화 Logic을 수행하는 else if문을 타게 될 것이고, 복호화라면 if문을 타게 될 것이에요.

그 외에 값이 들어온다면 PropertyValueExeception이 터지면서 위와 같이
어떤 것이 잘못되었는지 알 수 있게 해 주었어요.

복호화 Logic을 타게 되면 어떤일이 벌어질까요?

먼저 String 객체를 만들게 되는데, 이 곳에 doFinal()을 통해 암호화 또는 복호화 Logic을 수행할 수 있어요. doFinal()은 암호화 또는 복호화된 Message를 포함한 byte Array를 반환해 주는 친구에요.

그래서 해당 Method 매개 변수로 매개 변수로 전달된 암호화할 Message값을 byte Array 형식으로 변경하되 UTF-8 형식으로 변환되게 한 뒤 toUpperCase()로 문자열 모두를 대문자로 변경하게 해 Root Locale 즉, ROOT Locale은 언어, 나라 및 변형이 Empty의 캐릭터 Line인 것 같은 Locale인데, 이것은 모든 Locale의 기저 Locale로 간주되어 Locale에 의존하는 Operation 언어/국가의 중립적 Locale로써 이용되는데, 이것은 매개 변수로 전달해 준 뒤 반환된 값을

org.apache.commons.codec.binary.Hex를 이용하여 Hex Encode를 해주는데,
이것을 통해 Hex 즉, 16진수로 변환하여 반환하도록 해 주었어요.

암호화 Logic을 수행한 뒤 반환값

결국 위와 같은 값이 반환되는 것이에요.


그럼 복호화 Logic을 타게 되면 어떤일이 발생할까요?

최초 doFinal()을 통해 복호화된 Message를 포함한 byte Array를 반환받아 result 변수에 넣을건데,
doFinal() 매개 변수로 Hex.encodeHex()로 16진수 암호화된 값을 복호화하면서
UTF-8 형식으로 반환될 수 있도록 처리해 주었어요.

위와 같이 암호화된 Data가 입력이 되면 

해당 Logic을 통해 복호화가 되는 걸 확인할 수 있어요.

    🔽  Test

        📦 구현된 기능 가지고 놀기

해당 내용에 대한 Code는 이 곳에서 확인할 수 있으시도록 준비해 두었어요.

BoardServiceImpl.java - 28 ~ 51번째 줄

최초 주니하랑은 게시물 작성 Method를 만들어 주었어요.

38번째 줄에 보면 위에서 만든 DataEnDecryption 객체안에 base64Encodr()를 호출하는데, 그 때 ReqeustDTO로 전달된 게시물 제목을 넣어 전달하여 해당 게시글 제목을 base64로 Encoding한 값을 cipherKey 변수에 담도록 하여 주었어요.

그런 뒤 해당 DTO 값을 Data Base에 넣어주기 위해 Entity의 Build Pattern을 이용하여 제목은 DTO의 값을 그대로 꺼내 전달하여 주었고, 내용은 DataEnDecryption 객체에 dataEnDecrypt()를 호출하여 암호화 저장을 할 수 있도록 Logic을 구현하였어요.

첫번째 매개변수에는 암호화 Key가 될 값으로 38번째 줄에서 만든 Base64 형식으로 Encoding된 제목을 전달하여 주고, 두번째 매개변수로 암호화할 Message
즉, DTO에 담긴 내용 값을 전달하여 준 뒤 마지막으로
암, 복호화 여부를 결정하게 될 cipherMode 값을 1로 하여 전달하여 주고,
이를 JPA Repository를 통해 저장된 뒤 해당 ID를 반환 받을 수 있도록 구현하였어요.

Swagger를 통한 게시글 작성

위와 같이 정상적으로 등록 성공을 한 것을 볼 수 있어요.

test_board Table

DataBase에도 제목은 평문 저장 되었지만, 내용은 암호화 되서 저장된 것을 확인할 수 있어요.

BoardServiceImpl.java - 63 ~ 88번째 줄

 

BoardServiceImpl.java - 133 ~ 138번째 줄

다음으로는 복호화 Logic을 확인하기 위한 상세 보기 기능이에요.

67번째 줄에 Data Base에서 값을 가져오기 위해 중복되는 코드를 하나의 Method로 만들어서 매개 변수로 전달된 id값을 전달해 주었어요.

135번째 줄을 보게 되면 JPA Repository의 findById()를 통해 id값을 넣어 해당 값을 찾을 수 있도록 처리한 뒤 이를 Optional로 감싸 반환하게 해 주었어요.

76번째 줄에 DataBase에 저장되어 있던 평문 게시글 제목값을 DataEnDecryption 객체의 base64Encoder()로 전달하여 Base64값을 얻어낸 뒤 이를 cipherKey 변수에 저장하여 주었어요.

그런 뒤 BoardResponseDTO Builder Pattern을 이용하여 Data Base에서 조회된 해당 ID값에 게시글 id와 제목을 반환하게 했고, 암호화 되어 저장되어 있던 내용에 대해 복호화 Logic을 탈 수 있도록 첫번째 매개 변수에 cipherKey를 전달해 주고, 두번째 매개변수에는 DataBase에서 찾은 암호화된 값을 넣어주고, 마지막으로 해당 Logic이 복호화 Logic으로 처리 될 수 있도록 2라는 정수값을 넣어 주었어요.

Swagger를 통한 게시글 상세 조회

 
이렇게 하여 위와 같이 복호화된 결과값을 얻을 수 있는 것을 확인할 수 있었어요.

DataEnDecryptionTest

위와 같이 Test Code도 작성해 보았어요.

Test 결과

정상적으로 Test를 진행하는 것을 확인할 수 있었어요.

 

 

🧐 참고 자료

[Java] Cipher, 자바의 암호화&복호화를 담당하는 클래스

 

백견불여일타 스프링 부트 쇼핑몰 프로젝트 with JPA:이젠 프로젝트다!

 

 

React.js 스프링 부트 AWS로 배우는 웹 개발 101:SPA REST API 기반 웹 애플리케이션 개발

 

 

스타트 스프링 부트:초급 개발자들을 위한 가볍고 넓은 스프링 부트

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."