Verify

Prev Next

Classic/VPC環境で利用できます。

最大8KBサイズで署名されたデータと署名を照合して検証した結果を返します。RSA2048または ECDSAキータイプでのみリクエストできます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST
  • API Gateway request signature v1: /keys/v1/{keyTag}/verify
  • API Gateway request signature v2: /keys/v2/{keyTag}/verify

リクエストヘッダ

Key Management Service APIで共通して使用されるヘッダの詳細は、Key Management Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
keyTag String Required キータグ
  • キー名から派生したキーの固有 ID
  • Get Key Listを通じて確認
  • REST APIで暗号化または復号化をリクエストする際に使用
  • キータグは機密情報として扱われない

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
data String Required 署名されたデータ
signature String Required 照合対象の署名

リクエスト例

リクエストのサンプルコードは次の通りです。

  • API Gateway request signature v1リクエスト
curl --location --request POST 'https://kms.apigw.ntruss.com/keys/v1/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/verify' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-api-key: {API Gateway API Key}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v1: {API Gateway Signature}' \
--data '{
  "data": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==",
  "signature": "{SIGNATURE}"
}'
  • API Gateway request signature v2リクエスト
curl --location --request POST 'https://kms.apigw.ntruss.com/keys/v2/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/verify' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "data": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==",
  "signature": "{SIGNATURE}"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code String - 成功したかどうか
msg String - レスオンスコード(code)の説明
  • リクエスト成功(SUCCESS)時、空の値「""」と表示
  • data Object - レスポンス結果
    data.valid String - 署名されたデータと署名は一致するかどうか
    • true | false
      • true: 一致
      • false: 一致しない

    レスポンスステータスコード

    Key Management Service APIで共通して使用されるレスポンスステータスコードの詳細は、Key Management Serviceのレスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
        "code": "SUCCESS",
        "msg": "",
        "data": {
            "valid": true
        }
    }