[Spring] Springboot 개발 환경 분리 및 Datasource 암호화 하기

📝개발 환경 분리하기

다른사람과 같이 진행하는 토이프로젝트에서 테스트용 환경과 개발 환경의 DB를 다르게 설정해 놨기 때문에 환경의 분리가 필요했다. 이 때 환경을 application.proerties 나 .yml 을 이용하여 분리를 한다. 

 

기존 application.yml

spring:
  datasource:
    url: jdbc:h2:tcp://localhost/~/gubun
    username: sa
    password:
    driver-class-name: org.h2.Driver
  jpa:
    hibernate:
      ddl-auto: create
    properties:
      hibernate:
        format_sql: true
logging.level:
  org.hibernate.SQL: debug
#  org.hibernate.type: trace

 

AWS RDS 를 개발 db로 사용하기로 해서 기존 H2 DB를 쓰던 환경을 테스트로 두고, 새로 추가한 Postgres DB를 개발 환경으로(test,dev) 분리하기로 하였다.

(SpringBoot 2.4 버전 이후로 on-profile 을 이용해야 한다. 기존의 방식은 deprecated 됨)

 

application.yml

spring:
  profiles:
    active: dev

logging.level:
  org.hibernate.SQL: debug
#  org.hibernate.type: trace

application-test.yml

server:
  port: 8080

spring:
  config:
    activate:
      on-profile: test
  datasource:
    url: jdbc:h2:tcp://localhost/~/gubun
    username: sa
    password:
    driver-class-name: org.h2.Driver
  jpa:
    hibernate:
      ddl-auto: create
    properties:
      hibernate:
        format_sql: true

 

application-dev.yml

server:
  port: 9090

spring:
  config:
    activate:
      on-profile: dev
  datasource:
    url: ##DB위치
    username: ##이름
    password: ##패스워드
    driver-class-name: org.postgresql.Driver
  jpa:
    hibernate:
      ddl-auto: none
    properties:
      hibernate:
        format_sql: true

 

📝DataSource 암호화 하기

그런데 여기서 한 가지 문제는 이 프로젝트가 Git으로 관리 되고 있다는 것이다.
만약 저 DataSource 그대로 Git에 올려버리면 보안문제는 물론이고 AWS에서 막아버린다.
.yml 을 gitignore을 통해 안 올리는 방법도 있겠지만 여기선 암호화해서 올리려고 한다.

 

Jasypt

Jasypt는 민감정보를 암호화 해주는 모듈로, 여기선 민감정보를 암호화 한 뒤에 환경변수로 복호화키를 설정하여 접속할 수 있게 할 것이다. 

https://www.devglan.com/online-tools/jasypt-online-encryption-decryption

Programming Blog Article Feeds as per your Interest | DevGlan

이 곳에 들어가면 직접 암/복호화를 수행할 수 있다.

key를 이용하여 복호화를 수행하려면 Two Way Encryption이라는 옵션을 선택해야 한다.
단방향 암호화가 아니기 때문에 복호화 키를 이용하면 바로 원문이 나온다.
참고로, 저 EncryptedString은 Encrypt를 수행할 때 마다 매번 다른 EncryptedString이 나온다.

이제 Spring에서 이를 이용해보자.

 

의존성추가하기 (ulisesbocchio-jasypt)

dependencies {

	// 암호화 모듈
	implementation 'com.github.ulisesbocchio:jasypt-spring-boot-starter:3.0.4'
}

참고) 3.0.3 부터 방식이 달라져서 이전 버전을 이용하면 동작 되지 않을 수도 있음

 

https://github.com/ulisesbocchio/jasypt-spring-boot

GitHub - ulisesbocchio/jasypt-spring-boot: Jasypt integration for Spring boot

 

Configuration 추가하기

import lombok.extern.slf4j.Slf4j;
import org.jasypt.encryption.StringEncryptor;
import org.jasypt.encryption.pbe.PooledPBEStringEncryptor;
import org.jasypt.encryption.pbe.config.SimpleStringPBEConfig;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 서버 정보 암호화 하기위한 ConfigClass
 * 아래의 URL에서 encrypt decrypt 가능
 * https://www.devglan.com/online-tools/jasypt-online-encryption-decryption
 *
 * application-dev.yml 안에 있는 암호화된 DB 정보를 decrypt 하기 위해선 환경변수에서 값을 직접 입력받아야 합니다.
 */
@Configuration
@Slf4j
public class JasyptConfig {

    @Bean("jasyptStringEncryptor")
    public StringEncryptor stringEncryptor() {

        PooledPBEStringEncryptor encryptor = new PooledPBEStringEncryptor();
        SimpleStringPBEConfig config = new SimpleStringPBEConfig();
        config.setPassword(System.getenv("JASYPT_PASSWORD"));
        config.setAlgorithm("PBEWithMD5AndDES");
        config.setKeyObtentionIterations("1000");
        config.setPoolSize("1");
        config.setProviderName("SunJCE");
        config.setSaltGeneratorClassName("org.jasypt.salt.RandomSaltGenerator");
        config.setIvGeneratorClassName("org.jasypt.iv.NoIvGenerator");
        config.setStringOutputType("base64");
        encryptor.setConfig(config);
        return encryptor;
    }
}

 

config.setPassword(System.getenv("JASYPT_PASSWORD")); 이 부분이 환경변수로 부터 키 값을 받아와서 설정해 주는 부분이다. 환경변수를 시스템변수에 추가해서 사용할 수 있는데, 필자는 null 이 반환이 되어서 직접 runConfigurations에 추가해서 진행 하였다.

 

 

그리고 다시 돌아와서 application-dev.yml 부분의 DB정보를 암호화 하여 나온 값들로 채워주면 되는데 ENC()로 감싸주면 끝

spring:
  config:
    activate:
      on-profile: dev
  datasource:
    url: ENC(Akn44dXsH2btWIRNfqmNJc60LKUOWP2c+PVQ15+xSoZf4ddzGl1JcI13hbWZ9LUVeXo6kwdlBIuw+YKPaSUkK8h0sQWonoADl1lGUFwdS4NAaeQugwBBNJIu6kwxMBJ1)
    username: ENC(EmRRq+Xam8r36WFSPZas2UjrcY/DfwSv)
    password: ENC(daX0fX/g9fgOzXIz8TroQj50f1XwHf4z6qHiPA0Vv3g=)
    driver-class-name: org.postgresql.Driver
  jpa:
    hibernate:
      ddl-auto: none
    properties:
      hibernate:
        format_sql: true