Key Management Service 개요

Classic/VPC 환경에서 이용 가능합니다.

Key Management Service는 암호화 운영 및 구현에 필수적인 암호 키 관리 기능을 제공하는 네이버 클라우드 플랫폼의 서비스입니다. Key Management Service에서는 암호화와 복호화를 비롯한 여러 키 관리 기능에 대한 API를 RESTful 형태로 제공합니다.

Key Management Service API 1.0 공통 설정

Key Management Service API 1.0에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

API Gateway request signature v1: https://kms.apigw.ntruss.com/keys/v1
API Gateway request signature v2: https://kms.apigw.ntruss.com/keys/v2

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

• API Gateway request signature v1 방식 요청

  필드	필수 여부	설명
  x-ncp-apigw-timestamp	Required	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초) API Gateway 서버와 5분 이상 시간차 발생 시 유효하지 않은 요청으로 간주
  x-ncp-apigw-api-key	Required	네이버 클라우드 플랫폼의 API Gateway 서비스에서 발급받은 키
  x-ncp-iam-access-key	Required	네이버 클라우드 플랫폼에서 발급받은 Access Key Access Key 발급 및 확인: 인증키 생성 참조 서브 계정의 Access Key 발급 및 확인: 서브 계정 생성 참조
  x-ncp-apigw-signature-v1	Required	네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 Secret Key 발급 및 확인: 인증키 생성 참조 서명 생성: 시그니처 생성 참조

• API Gateway request signature v2 방식 요청

  필드	필수 여부	설명
  x-ncp-apigw-timestamp	Required	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초) API Gateway 서버와 5분 이상 시간차 발생 시 유효하지 않은 요청으로 간주
  x-ncp-iam-access-key	Required	네이버 클라우드 플랫폼에서 발급받은 Access Key Access Key 발급 및 확인: 인증키 생성 참조 서브 계정의 Access Key 발급 및 확인: 서브 계정 생성 참조
  x-ncp-apigw-signature-v2	Required	네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 Secret Key 발급 및 확인: 인증키 생성 참조 서명 생성: 시그니처 생성 참조

응답

공통 응답 형식을 설명합니다.

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

오류 구문

요청 처리 결과 오류 구문에 대한 설명은 다음과 같습니다.

{
"error": {
"errorCode": "300",
"message": "Not Found Exception",
"details": "URL not found."
}
}

상태 코드가 200 OK이더라도 결과적으로 실패한 오류 구문에 대한 설명은 다음과 같습니다.

• <예시> 유효하지 않은 요청 데이터 입력

  {
  "code": "NOT_VALID_INPUT",
  "msg": "Fail: not valid input",
  "data": null
  }
  

Key Management Service API 2.0 공통 설정

Key Management Service API 2.0에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

https://ocapi.ncloud.com/kms/v1

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

• 계정 인증(Account Auth) 방식 요청

  필드	필수 여부	설명
  x-ncp-apigw-timestamp	Required	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초) API Gateway 서버와 5분 이상 시간차 발생 시 유효하지 않은 요청으로 간주
  x-ncp-iam-access-key	Required	네이버 클라우드 플랫폼에서 발급받은 Access Key Access Key 발급 및 확인: 인증키 생성 참조 서브 계정의 Access Key 발급 및 확인: 서브 계정 생성 참조
  x-ncp-apigw-signature-v2	Required	네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 Secret Key 발급 및 확인: 인증키 생성 참조 서명 생성: 시그니처 생성 참조

• 토큰 인증(Token Auth) 방식 요청

  필드	필수 여부	설명
  x-ncp-ocapi-token	Required	Key Management Service에서 생성한 키의 액세스 토큰(Access Token) 또는 리프레시 토큰(Refresh Token) JWT(JSON Web Token) 타입 토큰 토큰 생성: Create Token Set 참조 사용 API 액세스 토큰: Encrypt, Decrypt, Create Custom Key, Re-encrypt, Sign, Verify, Get Public Key 리프레시 토큰: Create Access Token, Renew Token Set

응답

공통 응답 형식을 설명합니다.

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

오류 구문

요청 처리 결과 오류 구문에 대한 설명은 다음과 같습니다.

{
"error": {
"errorCode": "300",
"message": "Not Found",
"details": "null"
}
}

Key Management Service API

Key Management Service API 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

Key Management Service API 1.0

Key Management Service API 1.0 관련 API에 대한 설명은 다음과 같습니다.

Key Management Service API 2.0

Key Management Service API 2.0 관련 API에 대한 설명은 다음과 같습니다.

Account Auth API

Account Auth API 관련 API에 대한 설명은 다음과 같습니다.

Token Auth API

Token Auth API 관련 API에 대한 설명은 다음과 같습니다.

Key Management Service 연관 리소스

Key Management Service API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.

• Key Management Service API 사용 방법
• 서명(시그니처) 생성: 요청 헤더에 추가할 서명 생성 방법
• API Gateway 사용 가이드: 요청 헤더에 추가할 API Key 발급
• Sub Account 사용 가이드: 요청 헤더에 추가할 Access Key 발급 방법
• Ncloud 공통 응답 상태 코드: Key Management Service에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보
• Key Management Service 서비스 사용 방법
• Key Management Service 사용 가이드: 네이버 클라우드 플랫폼 콘솔에서 Key Management Service 사용하는 방법
• Ncloud 사용 환경 가이드: VPC, Classic 환경 및 지원 여부에 대한 가이드
• 요금 소개, 특징, 상세 기능: Key Management Service의 요금 체계, 특징, 상세 기능 요약
• 서비스 최신 소식: Key Management Service 관련 최신 소식
• 자주 하는 질문: Key Management Service 사용자들이 자주 하는 질문
• 고객 지원: API 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의