How-to guides

사용자는 Samsung Cloud Platform Console을 통해 Secret Vault 서비스의 필수 정보를 입력하고, 상세 옵션을 선택하여 해당 서비스를 생성할 수 있습니다.

Secret Vault 생성하기

Samsung Cloud Platform Console에서 Secret Vault 서비스를 생성하여 사용할 수 있습니다.

Secret Vault를 생성하려면 다음 절차를 따르세요.

1. 모든 서비스 > Security > Secret Vault 메뉴를 클릭하세요. Secret Vault의 Service Home 페이지로 이동합니다.
2. Service Home 페이지에서 Secret Vault 생성 버튼을 클릭하세요. Secret Vault 생성 페이지로 이동합니다.
3. Secret Vault 생성 페이지에서 서비스 생성에 필요한 정보들을 입력하고, 상세 옵션을 선택하세요.
   • 서비스 정보 입력 영역에서 필요한 정보를 선택하세요.

     구분	필수 여부	상세 설명
     Secret명	필수	Secret 이름 입력 영문 소문자와 숫자를 사용하여 3~63자 입력
     유형	필수	암호화 대상의 유형 선택
     인증키	필수	Secret Vault 서비스에 사용할 인증키 선택 사용 버튼을 클릭하여 인증키 관리 메뉴에서 미리 생성한 인증키 중에서 선택하세요. 인증키 관리 메뉴에서 보안 인증방식을 반드시 임시키 인증으로 선택해야 합니다. 만료된 인증키는 조회되지 않으며, 사용 기한이 30일 미만이거나 Secret Vault 상품에서 이미 사용 중인 인증키는 사용할 수 없습니다. (인증키 1개당 1개의 Secret Vault 상품만 신청할 수 있습니다.)
     Token 사용 기간	필수	인증키를 암호화하여 제공되는 Token의 사용 기간 입력 Token 사용 기간은 기본적으로 입력한 인증키의 유효 기간과 동일하게 자동으로 설정됩니다. 인증키 유효 기간을 영구로 설정한 경우, Token 사용 기간은 최대 7300일(20년)까지 설정할 수 있습니다. Token 사용 기간은 서비스 신청 완료 후에는 변경할 수 없습니다. 보안 강화를 위해 Token의 주기적인 교체를 권장합니다. Token 사용 기간이 만료되면 임시키 발급이 불가능하며, 서비스 신규 신청을 통해 Token을 새로 발급받아야 합니다. Token 사용 기간이 만료되면 기간 연장이 불가능하고 더 이상 Token을 사용할 수 없습니다. Token 사용 기간이 만료되기 전에 서비스 신규 신청을 통해 Token을 새로 발급받고, 발급받은 Token 정보를 소스 코드에 적용하세요.
     임시키 교체 주기	필수	Samsung Cloud Platform 자원에 접근하기 위해 사용될 임시키의 교체 주기 선택 임시키 사용시간은 서비스 생성 완료 시점부터 적용됩니다. 보안 강화를 위해 임시키의 사용 기간은 최대 1.5일(36시간)까지만 설정할 수 있습니다. 임시키 사용 기간이 만료되기 전에 신규 임시키가 발급되며, 동일한 사용 기간이 적용됩니다.
     접근 허용 IP	필수	접근을 허용할 IP를 입력한 후 추가 버튼 클릭 입력한 IP는 반드시 인증키 관리 > 보안설정 > 접근 허용 IP에서도 동일하게 설정해야 접근 허용이 가능합니다. 단일 IP를 입력할 경우에도 반드시 IP 뒤에 ‘/32’를 기입하세요. IP는 최대 10개까지 등록할 수 있습니다.
     설명	선택	추가 정보 입력

     표. Secret Vault 서비스 정보 입력 항목
   • 추가 정보 입력 영역에서 필요한 정보를 선택하세요.

     구분	필수 여부	상세 설명
     태그	선택	태그 추가 태그 추가 버튼을 클릭하여 태그를 생성하여 추가하거나 기존 태그 추가 가능 자원 당 최대 50개까지 추가 가능 추가된 신규 태그는 서비스 생성 완료 후 적용

     표. Secret Vault 추가 정보 입력 항목
4. 요약 패널에서 생성한 상세 정보와 예상 청구 금액을 확인하고, 완료 버튼을 클릭하세요.
   • 생성이 완료되면, Secret Vault 목록 페이지에서 생성한 자원을 확인하세요.

Secret Vault 상세 정보 확인하기

Secret Vault 서비스의 전체 자원 목록과 상세 정보를 확인하고 수정할 수 있습니다. Secret Vault 상세 페이지에서는 상세 정보, 태그, 작업 이력 탭으로 구성되어 있습니다.

Secret Vault 서비스의 상세 정보를 확인하려면 다음 절차를 따르세요.

1. 모든 서비스 > Security > Secret Vault 메뉴를 클릭하세요. Secret Vault의 Service Home 페이지로 이동합니다.
2. Service Home 페이지에서 Secret Vault 메뉴를 클릭하세요. Secret Vault 목록 페이지로 이동합니다.
3. Secret Vault 목록 페이지에서 상세 정보를 확인할 자원을 클릭하세요. Secret Vault 상세 페이지로 이동합니다.
   • Secret Vault 상세 페이지에는 상태 정보 및 부가 기능 정보가 표시되며, 상세 정보, 태그, 작업 이력 탭으로 구성됩니다.

     구분	상세 설명
     Secret Vault 상태	사용자가 생성한 Secret Vault의 상태 Active: 작동 중 To be terminated: 서비스 해지 신청 후, 해지 대기 상태 서비스의 해지 예정 시간이 표시되고, 서비스 해지를 취소할 수 있습니다. Expired: Token 만료 상태 Expired 상태로 변경된 Secret은 정보 조회 등의 어떠한 액션도 불가하며, 7일 후 자동으로 삭제됩니다.
     임시키 교체	사용 중인 임시키를 즉시 삭제하고 신규 임시키 생성 Secret Vault 서비스의 생성자 본인만 임시키를 교체할 수 있습니다.
     서비스 해지	서비스를 해지하는 버튼

     표. Secret Vault 상태 정보 및 부가 기능

상세 정보

Secret Vault 목록 페이지에서 선택한 자원의 상세 정보를 확인하고, 필요한 경우 정보를 수정할 수 있습니다.

태그

Secret Vault 목록 페이지에서 선택한 자원의 태그 정보를 확인하고, 추가하거나 변경 또는 삭제할 수 있습니다.

작업 이력

Secret Vault 목록 페이지에서 선택한 자원의 작업 이력을 확인할 수 있습니다.

Secret Vault 해지하기

사용하지 않는 해당 서비스를 해지하여 운영 비용을 절감할 수 있습니다. 단, 서비스를 해지하면 운영 중인 서비스가 즉시 중단될 수 있으므로 서비스 중단 시 발생하는 영향을 충분히 고려한 후 해지 작업을 진행해야 합니다.

Secret Vault를 해지하려면 다음 절차를 따르세요.

1. 모든 서비스 > Security > Secret Vault 메뉴를 클릭하세요. Secret Vault의 Service Home 페이지로 이동합니다.
2. Service Home 페이지에서 Secret Vault 메뉴를 클릭하세요. Secret Vault 목록 페이지로 이동합니다.
3. Secret Vault 목록 페이지에서 해지할 자원을 선택하고, 서비스 해지 버튼을 클릭하세요. 서비스 해지 팝업창으로 이동합니다.
4. 서비스 해지 팝업창에서 해지 대기 기간(7~30일)을 입력한 후, 확인 버튼을 클릭하세요. 사용자가 입력한 해지 대기 기간 이후에 서비스가 해지됩니다.

Secret Vault 해지 취소하기

해지 대기 중인 서비스의 해지를 취소하여 다시 사용할 수 있습니다.

Secret Vault를 해지취소하려면 다음 절차를 따르세요.

1. 모든 서비스 > Security > Secret Vault 메뉴를 클릭하세요. Secret Vault의 Service Home 페이지로 이동합니다.
2. Service Home 페이지에서 Secret Vault 메뉴를 클릭하세요. Secret Vault 목록 페이지로 이동합니다.
3. Secret Vault 목록 페이지에서 해지를 취소할 자원을 클릭하세요. Secret Vault 상세 페이지로 이동합니다.
4. Secret Vault 상세 페이지에서 해지 취소 버튼을 클릭하세요. 서비스 해지 취소 팝업창으로 이동합니다.
5. 서비스 해지 취소 팝업창에서 내용을 확인한 후, 확인 버튼을 클릭하세요. 해지를 취소한 자원의 상태가 Active로 복구됩니다.

Application Token 설정하기

Secret Vault 서비스 신청을 통해 발급받은 Token 정보는 OpenAPI 임시키 발급 요청을 위한 API 호출에 필요한 정보입니다. Token 정보를 각각의 Application 환경에 맞춰 설정하세요.

Token 정보를 설정하려면 다음 절차를 따르세요.

1. Token 정보를 Application의 환경 변수 설정 파일에 적용하세요.
2. Token 정보를 Application 내의 API 호출 Logic이 참조할 수 있도록 설정하세요.
   • 사용 OpenAPI → GET /v1/temporarykey/{secretvault_id}
   • 자세한 내용은 Samsung Cloud Platform Console의 Open API 가이드를 참고하세요.
3. Token 정보를 Application 내의 API 호출 Logic이 참조할 수 있도록 설정하세요.
   • 임시키는 기존 소스 코드의 하드 코딩을 제거하고 Token 정보를 이용한 OpenAPI 호출을 통해 발급받아 사용할 수 있습니다. 자세한 내용은 Samsung Cloud Platform Console의 Open API 가이드를 참고하세요.

application.yml 또는 application.properties 등의 환경 변수 설정 파일

발급받은 Token 정보를 환경 변수 설정 파일에 적용하세요.

secretvault.secretvault.id= {{ ID }}
secretvault.tokenId= {{ Token ID }}
secretvault.tokenSecret= {{ Token Secret }}

Java 파일

환경 변수 인식을 위한 class 파일에 적용하세요.

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SecretVaultConfiguration {
    @Value("${secretvault.id}")
    private String id;

    @Value("${secretvault.tokenId}")
    private String tokenId;

    @Value("${secretvault.tokenSecret}")
    private String tokenSecret;

    @Bean
    public OpenApiClient openApiClient() {
        // OpenApiClient 또는 다른 API 클라이언트를 생성하고 설정 값을 사용하여 초기화
        return new OpenApiClient(secretVaultName, tokenId, tokenSecret);
    }
}