指定された証明書を使用してデジタル署名を生成します。

リクエストパラメーターの署名アルゴリズムは、キータイプと一致する必要があります。 次の表に、署名アルゴリズムとキータイプの間のマッピングを示します。

アルゴリズム

キータイプ

RSA_PKCS1_SHA_256

RSA_2048

RSA_PSS_SHA_256

RSA_2048

ECDSA_SHA_256

EC_P256

SM2DSA

EC_SM2

この例では、IDが12345678-1234-1234-1234-12345678 **** および署名アルゴリズムECDSA_SHA_256を使用して、生データVGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4= のデジタル署名を生成します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 CertificatePrivateKeySign

実行する操作です。 値をCertificatePrivateKeySignに設定します。

アルゴリズム String 必須 ECDSA_SHA_256

署名アルゴリズム。 設定可能な値は以下のとおりです。

  • RSA_PKCS1_SHA_256
  • RSA_PSS_SHA_256
  • ECDSA_SHA_256
  • SM2DSA
    SM2DSA署名アルゴリズムは、中国本土でマネージドハードウェアセキュリティモジュール (HSM) が使用されているリージョンでのみサポートされています。 詳細については、「マネージドHSMの概要」をご参照ください。
CertificateId String 必須 12345678-1234-1234-1234-12345678 ****

証明書の ID 。 これは、Certificates Managerの証明書のグローバル一意識別子 (GUID) です。

Message String 必須 VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4=

署名するデータ。The data to be signed.

値はBase64でエンコードする必要があります。 For example, if the data to be signed in the hexadecimal format is [0x31, 0x32, 0x33, 0x34], set this parameter to the Base64-encoded value MTIzNA==.

MessageTypeパラメーターがRAWに設定されている場合、データのサイズは4 KB以下でなければなりません。

If the size of the data is greater than 4 KB, you can set the MessageType parameter to DIGEST and set the Message parameter to the digest of the data. ダイジェストは、ハッシュ値とも呼ばれる。 オンプレミスマシンでデータのダイジェストを計算できます。 Certificates Managerは、独自の証明書アプリケーションシステムで計算したダイジェストを使用します。 使用するメッセージダイジェストアルゴリズムは、指定された署名アルゴリズムと一致する必要があります。 署名アルゴリズムとメッセージダイジェストアルゴリズムの間の次のマッピングに従います。

  • 署名アルゴリズムがRSA_PKCS1_SHA_256、RSA_PSS_SHA_256、またはECDSA_SHA_256の場合、メッセージダイジェストアルゴリズムをSHA-256する必要があります。
  • 署名アルゴリズムがSM2DSAの場合、メッセージダイジェストアルゴリズムはSM3でなければならない。
証明書のキータイプがEC_SM2で、MessageTypeパラメーターがDIGESTに設定されている場合、Messageパラメーターの値はeになります。これはGB/T 32918.2 2016 6.1で説明されています。
MessageType String 必須 RAW

メッセージのタイプ。 設定可能な値は以下のとおりです。

  • RAW: 生データ。 デフォルト値です。
  • DIGEST: 生データのメッセージダイジェスト (ハッシュ値) 。

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター データ型 説明
CertificateId String 12345678-1234-1234-1234-12345678 ****

証明書の ID 。

RequestId String 5979d897-d69f-4fc9-87dd-f3bb73c40b80

リクエストの ID です。

SignatureValue String ZOyyygCyaOW6Gj **** MlNKiuyjfzw=

署名値です。

値はBase64でエンコードされます。

リクエストの例

http(s)://[Endpoint]/? アクション=CertificatePrivateKeySign
&アルゴリズム=ECDSA_SHA_256
&CertificateId=12345678-1234-1234-1234-12345678 ****
&メッセージ=VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4=
&MessageType=RAW
&<共通リクエストパラメーター> |

正常に処理された場合のレスポンス例

XML 形式

<KMS>
      <CertificateId>12345678-1234-1234-1234-123456789012</CertificateId>
      <SignatureValue> ZOyygCyaOW6Gj **** MlNKiuyjfzw=</SignatureValue>
      <RequestId>5979d897-d69f-4fc9-87dd-f3bb73c40b80</RequestId>
</KMS>

JSON 形式

{
  "CertificateId": "12345678-1234-1234-1234-123456789012" 、
  "SignatureValue": "ZOyIygCyaOW6Gj **** MlNKiuyjfzw=" 、
  "RequestId": "5979d897-d69f-4fc9-87dd-f3bb73c40b80"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
404 証明書. NotFound 指定された証明書が見つかりません。 指定された証明書が存在しない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。