Spring Vault 소개와 Spring Boot API 연동 방법

on

 

Spring Vault 소개와 Spring Boot API 연동 방법

Spring Vault 소개와 Spring Boot API 연동 방법

Spring Vault는 HashiCorp Vault와의 통합을 제공하는 Spring 기반의 모듈로, 애플리케이션에서 비밀 정보를 안전하게 관리하고 사용할 수 있도록 설계되었습니다. 최근 버전인 Spring Vault 3.1.2를 기준으로 주요 개념과 사용법을 설명하겠습니다. 또한, Spring Vault를 활용하여 Spring Boot 애플리케이션에서 데이터베이스 비밀번호를 참조하는 구체적인 연동 방법과 유의 사항을 다룹니다.

Spring Vault란 무엇인가?

Spring Vault는 Spring 애플리케이션과 HashiCorp Vault 간의 통합을 간편하게 구현할 수 있도록 도와줍니다. 이를 통해 데이터베이스 비밀번호, API 키, 인증 정보와 같은 민감한 데이터를 중앙에서 관리하고, 동적으로 안전하게 제공받을 수 있습니다.

Vault는 보안 강화를 위해 암호화된 스토리지와 다양한 인증 방식을 제공합니다. Spring Vault는 이를 Spring 애플리케이션에서 쉽게 사용할 수 있도록 설정을 간소화합니다. 주요 기능은 다음과 같습니다:

  • Key-Value Secret Engine을 사용한 비밀 데이터 관리
  • Dynamic Secrets로 데이터베이스 사용자 자격 증명 동적 생성
  • TLS를 통한 보안 통신 지원
  • 다양한 인증 방식 (Token, AppRole, Kubernetes 등)과의 연동

Spring Vault의 주요 사용 사례

  1. Key-Value 기반 비밀 정보 관리

    • DB 비밀번호, API 키 등 민감한 데이터를 Vault에 저장하고 이를 애플리케이션에서 안전하게 읽습니다.

  2. 동적 비밀번호 관리

    • 데이터베이스 접근을 위한 동적 자격 증명을 제공받아 보안을 강화합니다.

  3. 애플리케이션 구성

    • 환경별로 다른 비밀 데이터를 중앙에서 관리하여 DevOps 환경에 적합합니다.

  4. 다양한 인증 방식

    • AppRole, AWS IAM, Kubernetes 인증 등 다양한 인증 방식을 지원합니다.

Spring Boot와 Spring Vault 연동 방법: 데이터베이스 비밀번호 참조

이제 Spring Vault를 Spring Boot API 프로젝트에 연동하여 데이터베이스 비밀번호를 참조하는 과정을 단계별로 설명합니다.

1. Vault에 비밀번호 저장

먼저, Vault에 데이터베이스 비밀번호를 저장합니다. HashiCorp Vault CLI를 사용하여 Key-Value Secret Engine에 정보를 입력합니다. 

vault kv put secret/db-credentials username=db_user password=db_password
  • secret/db-credentials: Vault의 비밀 경로.
  • username: DB 사용자명.
  • password: DB 비밀번호.

2. Spring Boot 의존성 추가

Spring Vault와 Spring Cloud Vault를 사용하기 위해 pom.xml에 다음 의존성을 추가합니다. 

<dependency>
    <groupId>org.springframework.vault</groupId>
    <artifactId>spring-vault-core</artifactId>
    <version>3.1.2</version>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-vault-config</artifactId>
    <version>4.0.0</version>
</dependency>

3. Spring Vault 설정

Vault 서버와의 연결 설정은 application.yml 파일에 작성합니다. 아래는 예제 설정입니다: 

spring:
  cloud:
    vault:
      uri: https://vault.example.com:8200
      token: s.aBcDeFgHiJkLmNoPqRsTuV
      authentication: token
      kv:
        enabled: true
        backend: secret
  • uri: Vault 서버 주소.
  • token: Vault에 접근하기 위한 인증 토큰. (운영 환경에서는 AppRole을 권장)

4. Spring Boot에서 Vault 속성 로드

Vault에 저장된 비밀 정보를 애플리케이션에서 로드하려면 application-name을 설정해야 합니다. 

spring:
  cloud:
    vault:
      kv:
        application-name: db-credentials

5. DataSource 설정

Vault에서 로드한 비밀번호를 데이터소스에 적용합니다.

방법 1: Spring Boot 기본 DataSource 사용

application.yml 파일에서 spring.datasource 속성을 설정합니다: 

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: ${username}  # Vault에서 로드된 값
    password: ${password}  # Vault에서 로드된 값


방법 2: Java Configuration 사용

Java Config 클래스를 작성하여 DataSource를 설정할 수도 있습니다: 

@Configuration
public class DataSourceConfig {

    @Value("${username}")
    private String username;

    @Value("${password}")
    private String password;

    @Bean
    public DataSource dataSource() {
        return DataSourceBuilder.create()
                .url("jdbc:mysql://localhost:3306/mydb")
                .username(username)
                .password(password)
                .build();
    }
}

6. 애플리케이션 실행 후 확인

애플리케이션이 실행되면, Vault에서 로드된 값이 데이터베이스 연결에 사용됩니다. 이를 확인하려면 다음과 같은 간단한 컴포넌트를 작성해 출력해보세요: 

@Component
public class VaultProperties {

    @Value("${username}")
    private String username;

    @Value("${password}")
    private String password;

    @PostConstruct
    public void printSecrets() {
        System.out.println("DB Username: " + username);
        System.out.println("DB Password: " + password);
    }
}

Spring Vault 도입 시 유의사항

  1. Vault 인증 방식:

    • 테스트 환경에서는 Token 인증을 사용할 수 있지만, 운영 환경에서는 AppRole, Kubernetes 인증 등 강력한 인증 방식을 사용해야 합니다.

  2. HTTPS 사용 필수:

    • Vault와의 통신은 반드시 HTTPS를 사용해야 합니다. 자체 서명 인증서를 사용하는 경우, Spring Boot에서 이를 신뢰할 수 있도록 설정하세요.

  3. 최소 권한 원칙 적용:

    • Vault의 정책 설정을 통해 애플리케이션이 최소한의 경로에만 접근할 수 있도록 권한을 제한하세요.

  4. Vault HA 구성:

    • Vault 서버를 운영 환경에 배포할 때는 고가용성을 위해 HA(High Availability) 구성을 적용하세요.

마무리

Spring Vault는 Spring Boot 애플리케이션에서 민감한 정보를 안전하게 관리하고 사용할 수 있는 강력한 도구입니다. 데이터베이스 비밀번호와 같은 중요한 정보를 안전하게 보호하면서도 애플리케이션 개발과 운영을 간소화할 수 있습니다. 위 가이드를 따라 설정하면, Vault를 효과적으로 활용할 수 있을 것입니다. 보안 강화를 위해 반드시 HTTPS와 최소 권한 정책을 적용하시기 바랍니다.

Comments

Post a Comment