KMS概要

概要

KMS APIはRESTfulの形式で提供されます。KMS Rest APIを呼び出すためにはAPI GatewayとSub Account認証を実行する必要があります。

API Gatewayを通じたAPI呼び出しは API Gateway説明書(旧、ユーザーガイド) をご参照ください。APIリクエストメッセージは以下のように構成されます。

リクエスト構成

API Gateway request signature v1 リクエスト構成

Header
  x-ncp-apigw-timestamp:{Timestamp}
  x-ncp-apigw-api-key:{API Gateway API Key}
  x-ncp-iam-access-key:{Sub Account Access Key}
  x-ncp-apigw-signature-v1:{API Gateway Signature}
  Content-Type:application/json
Body
  fieldName: {Base64 Encoded message}
URL
  https://kms.apigw.ntruss.com/keys/v1/{keyTag}/{action}

API Gateway request signature v2 リクエスト構成

Header
  x-ncp-apigw-timestamp:{Timestamp}
  x-ncp-iam-access-key:{Sub Account Access Key}
  x-ncp-apigw-signature-v2:{API Gateway Signature}
  Content-Type:application/json
Body
  fieldName: {Base64 Encoded message}
URL
  https://kms.apigw.ntruss.com/keys/v2/{keyTag}/{action}

例示

API Gateway request signature v1 例示

curl -i -s -X POST \
-H "x-ncp-apigw-timestamp:1511759789542" \
-H "x-ncp-apigw-api-key:12345678907qLxeMDTgd2kyKLOb" \
-H "x-ncp-iam-access-key:3A03131E1348C83101" \
-H "x-ncp-apigw-signature-v1:FkL1mw12345678DRu9R50tdGSyc/uQ/oTw=" \
-H "Content-Type:application/json" \
-d '{"plaintext":"dGVzdA=="}' \
'https://kms.apigw.ntruss.com/keys/v1/bc6b4afe023f29721934567893905c8f7d2ca631c57533211316c89fa3/encrypt'

API Gateway request signature v2 例示

curl -i -s -X POST \
-H "x-ncp-apigw-timestamp:1511759789542" \
-H "x-ncp-iam-access-key:3A03131E1348C83101" \
-H "x-ncp-apigw-signature-v2:FkL1mw12345678DRu9R50tdGSyc/uQ/oTw=" \
-H "Content-Type:application/json" \
-d '{"plaintext":"dGVzdA=="}' \
'https://kms.apigw.ntruss.com/keys/v2/bc6b4afe023f29721934567893905c8f7d2ca631c57533211316c89fa3/encrypt'

レスポンス例示

{
  "code": "SUCCESS",
  "msg": "",
  "data":{
    "ciphertext": "ncpkms:v1:gsYccPMkd/fAtqbKuj2ov4H+EdZC8Qb/b1GPIIN2Z61+yULo"
  }
}

エラーコード

Prefix

マスターキーで暗号化されて返却されるデータは'KMS prefix + 暗号文'で構成されています。KMS prefixは[ncpkms:バージョン情報]で構成されておりますし、これは複合化時に必ず必要な情報であるため、任意除去及び操作が禁止されます。KMS prefixが正しくない場合は、正確に複合化されません。返却されたままの状態で管理するのが望ましいです。

 ncpkms:v1:XjsPWPjqPrBi1N2DupSiSbX/ATkGmKA
 --------- -------------------------------
KMS prefix        暗号文