ホーム › Security.Cryptography › CryptSignCertificate

CryptSignCertificate

関数

被署名データに署名して証明書署名値を生成する。

DLLCRYPT32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// CRYPT32.dll
#include <windows.h>

BOOL CryptSignCertificate(
    HCRYPTPROV_OR_NCRYPT_KEY_HANDLE hCryptProvOrNCryptKey,   // optional
    DWORD dwKeySpec,   // optional
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    const BYTE* pbEncodedToBeSigned,
    DWORD cbEncodedToBeSigned,
    CRYPT_ALGORITHM_IDENTIFIER* pSignatureAlgorithm,
    const void* pvHashAuxInfo,   // optional
    BYTE* pbSignature,   // optional
    DWORD* pcbSignature
);

パラメーター

名前	型	方向	説明
hCryptProvOrNCryptKey	HCRYPTPROV_OR_NCRYPT_KEY_HANDLE	inoptional	署名に使うCSPまたはCNGキーのハンドル。秘密鍵を保持するプロバイダーを指す。
dwKeySpec	DWORD	inoptional	プロバイダーのコンテナーから使用する秘密キーを指定します。AT_KEYEXCHANGE または AT_SIGNATURE を指定できます。hCryptProvOrNCryptKey パラメーターに NCRYPT_KEY_HANDLE を使用する場合、このパラメーターは無視されます。
dwCertEncodingType	CERT_QUERY_ENCODING_TYPE	in	使用するエンコード種類を指定します。次の例のように、証明書とメッセージの両方のエンコード種類をビットごとの OR 演算で組み合わせて指定することは常に許容されます: X509_ASN_ENCODING \| PKCS_7_ASN_ENCODING 現在定義されているエンコード種類は次のとおりです: X509_ASN_ENCODING PKCS_7_ASN_ENCODING
pbEncodedToBeSigned	BYTE*	in	署名対象となるエンコードされたコンテンツへのポインター。
cbEncodedToBeSigned	DWORD	in	エンコードされたコンテンツ pbEncodedToBeSigned のサイズ (バイト単位)。
pSignatureAlgorithm	CRYPT_ALGORITHM_IDENTIFIER*	in	pszObjId メンバーが次のいずれかに設定された CRYPT_ALGORITHM_IDENTIFIER 構造体へのポインター: szOID_RSA_MD5RSA szOID_RSA_SHA1RSA szOID_X957_SHA1DSA szOID_RSA_SSA_PSS szOID_ECDSA_SPECIFIED 署名アルゴリズムがハッシュアルゴリズムの場合、署名には暗号化されていないハッシュオクテットのみが含まれます。ハッシュの暗号化に秘密キーは使用されません。dwKeySpec は使用されず、ハッシュ処理に適切な既定の CSP を使用できる場合は hCryptProvOrNCryptKey を NULL にできます。
pvHashAuxInfo	void*	inoptional	現在使用されていません。NULL である必要があります。
pbSignature	BYTE*	outoptional	コンテンツの署名済みハッシュを受け取るバッファーへのポインター。このパラメーターは、メモリ割り当てのためにこの情報のサイズを設定する目的で NULL にできます。詳細については、Retrieving Data of Unknown Length を参照してください。
pcbSignature	DWORD*	inout	pbSignature パラメーターが指すバッファーのサイズ (バイト単位) を格納する DWORD へのポインター。関数が戻ると、この DWORD にはバッファーに格納された、または格納されるバイト数が入ります。注バッファーで返されるデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなる場合があります。(入力時には通常、出力されうる最大データが収まるよう十分に大きいバッファーサイズを指定します。) 出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するよう更新されます。

戻り値の型: BOOL

公式ドキュメント

CryptSignCertificate 関数は、エンコードされた署名対象コンテンツ内の「署名対象 (to be signed)」情報に署名します。

戻り値

関数が成功した場合、戻り値は 0 以外 (TRUE) です。

関数が失敗した場合、戻り値は 0 (FALSE) です。拡張エラー情報を取得するには、GetLastError を呼び出します。

注呼び出される関数 CryptCreateHash、CryptSignHash、CryptHashData からのエラーがこの関数に伝播される場合があります。

この関数には次のエラーコードがあります。

戻りコード	説明
ERROR_MORE_DATA	pbSignature パラメーターで指定したバッファーが返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbSignature が指す変数に格納します。
NTE_BAD_ALGID	署名アルゴリズムのオブジェクト識別子 (OID) が、既知または対応しているハッシュアルゴリズムにマッピングされません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// CRYPT32.dll
#include <windows.h>

BOOL CryptSignCertificate(
    HCRYPTPROV_OR_NCRYPT_KEY_HANDLE hCryptProvOrNCryptKey,   // optional
    DWORD dwKeySpec,   // optional
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    const BYTE* pbEncodedToBeSigned,
    DWORD cbEncodedToBeSigned,
    CRYPT_ALGORITHM_IDENTIFIER* pSignatureAlgorithm,
    const void* pvHashAuxInfo,   // optional
    BYTE* pbSignature,   // optional
    DWORD* pcbSignature
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptSignCertificate(
    UIntPtr hCryptProvOrNCryptKey,   // HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
    uint dwKeySpec,   // DWORD optional
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    IntPtr pbEncodedToBeSigned,   // BYTE*
    uint cbEncodedToBeSigned,   // DWORD
    IntPtr pSignatureAlgorithm,   // CRYPT_ALGORITHM_IDENTIFIER*
    IntPtr pvHashAuxInfo,   // void* optional
    IntPtr pbSignature,   // BYTE* optional, out
    ref uint pcbSignature   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptSignCertificate(
    hCryptProvOrNCryptKey As UIntPtr,   ' HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
    dwKeySpec As UInteger,   ' DWORD optional
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    pbEncodedToBeSigned As IntPtr,   ' BYTE*
    cbEncodedToBeSigned As UInteger,   ' DWORD
    pSignatureAlgorithm As IntPtr,   ' CRYPT_ALGORITHM_IDENTIFIER*
    pvHashAuxInfo As IntPtr,   ' void* optional
    pbSignature As IntPtr,   ' BYTE* optional, out
    ByRef pcbSignature As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hCryptProvOrNCryptKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
' dwKeySpec : DWORD optional
' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' pbEncodedToBeSigned : BYTE*
' cbEncodedToBeSigned : DWORD
' pSignatureAlgorithm : CRYPT_ALGORITHM_IDENTIFIER*
' pvHashAuxInfo : void* optional
' pbSignature : BYTE* optional, out
' pcbSignature : DWORD* in/out
Declare PtrSafe Function CryptSignCertificate Lib "crypt32" ( _
    ByVal hCryptProvOrNCryptKey As LongPtr, _
    ByVal dwKeySpec As Long, _
    ByVal dwCertEncodingType As Long, _
    ByVal pbEncodedToBeSigned As LongPtr, _
    ByVal cbEncodedToBeSigned As Long, _
    ByVal pSignatureAlgorithm As LongPtr, _
    ByVal pvHashAuxInfo As LongPtr, _
    ByVal pbSignature As LongPtr, _
    ByRef pcbSignature As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptSignCertificate = ctypes.windll.crypt32.CryptSignCertificate
CryptSignCertificate.restype = wintypes.BOOL
CryptSignCertificate.argtypes = [
    ctypes.c_size_t,  # hCryptProvOrNCryptKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
    wintypes.DWORD,  # dwKeySpec : DWORD optional
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    ctypes.POINTER(ctypes.c_ubyte),  # pbEncodedToBeSigned : BYTE*
    wintypes.DWORD,  # cbEncodedToBeSigned : DWORD
    ctypes.c_void_p,  # pSignatureAlgorithm : CRYPT_ALGORITHM_IDENTIFIER*
    ctypes.POINTER(None),  # pvHashAuxInfo : void* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbSignature : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbSignature : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptSignCertificate = Fiddle::Function.new(
  lib['CryptSignCertificate'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hCryptProvOrNCryptKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
    -Fiddle::TYPE_INT,  # dwKeySpec : DWORD optional
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # pbEncodedToBeSigned : BYTE*
    -Fiddle::TYPE_INT,  # cbEncodedToBeSigned : DWORD
    Fiddle::TYPE_VOIDP,  # pSignatureAlgorithm : CRYPT_ALGORITHM_IDENTIFIER*
    Fiddle::TYPE_VOIDP,  # pvHashAuxInfo : void* optional
    Fiddle::TYPE_VOIDP,  # pbSignature : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbSignature : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptSignCertificate(
        hCryptProvOrNCryptKey: usize,  // HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
        dwKeySpec: u32,  // DWORD optional
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        pbEncodedToBeSigned: *const u8,  // BYTE*
        cbEncodedToBeSigned: u32,  // DWORD
        pSignatureAlgorithm: *mut CRYPT_ALGORITHM_IDENTIFIER,  // CRYPT_ALGORITHM_IDENTIFIER*
        pvHashAuxInfo: *const (),  // void* optional
        pbSignature: *mut u8,  // BYTE* optional, out
        pcbSignature: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern bool CryptSignCertificate(UIntPtr hCryptProvOrNCryptKey, uint dwKeySpec, uint dwCertEncodingType, IntPtr pbEncodedToBeSigned, uint cbEncodedToBeSigned, IntPtr pSignatureAlgorithm, IntPtr pvHashAuxInfo, IntPtr pbSignature, ref uint pcbSignature);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptSignCertificate' -Namespace Win32 -PassThru
# $api::CryptSignCertificate(hCryptProvOrNCryptKey, dwKeySpec, dwCertEncodingType, pbEncodedToBeSigned, cbEncodedToBeSigned, pSignatureAlgorithm, pvHashAuxInfo, pbSignature, pcbSignature)

#uselib "CRYPT32.dll"
#func global CryptSignCertificate "CryptSignCertificate" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptSignCertificate hCryptProvOrNCryptKey, dwKeySpec, dwCertEncodingType, varptr(pbEncodedToBeSigned), cbEncodedToBeSigned, varptr(pSignatureAlgorithm), pvHashAuxInfo, varptr(pbSignature), varptr(pcbSignature)   ; 戻り値は stat
; hCryptProvOrNCryptKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional -> "sptr"
; dwKeySpec : DWORD optional -> "sptr"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "sptr"
; pbEncodedToBeSigned : BYTE* -> "sptr"
; cbEncodedToBeSigned : DWORD -> "sptr"
; pSignatureAlgorithm : CRYPT_ALGORITHM_IDENTIFIER* -> "sptr"
; pvHashAuxInfo : void* optional -> "sptr"
; pbSignature : BYTE* optional, out -> "sptr"
; pcbSignature : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptSignCertificate "CryptSignCertificate" sptr, int, int, var, int, var, sptr, var, var
; res = CryptSignCertificate(hCryptProvOrNCryptKey, dwKeySpec, dwCertEncodingType, pbEncodedToBeSigned, cbEncodedToBeSigned, pSignatureAlgorithm, pvHashAuxInfo, pbSignature, pcbSignature)
; hCryptProvOrNCryptKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional -> "sptr"
; dwKeySpec : DWORD optional -> "int"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "int"
; pbEncodedToBeSigned : BYTE* -> "var"
; cbEncodedToBeSigned : DWORD -> "int"
; pSignatureAlgorithm : CRYPT_ALGORITHM_IDENTIFIER* -> "var"
; pvHashAuxInfo : void* optional -> "sptr"
; pbSignature : BYTE* optional, out -> "var"
; pcbSignature : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptSignCertificate "CryptSignCertificate" sptr, int, int, sptr, int, sptr, sptr, sptr, sptr
; res = CryptSignCertificate(hCryptProvOrNCryptKey, dwKeySpec, dwCertEncodingType, varptr(pbEncodedToBeSigned), cbEncodedToBeSigned, varptr(pSignatureAlgorithm), pvHashAuxInfo, varptr(pbSignature), varptr(pcbSignature))
; hCryptProvOrNCryptKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional -> "sptr"
; dwKeySpec : DWORD optional -> "int"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "int"
; pbEncodedToBeSigned : BYTE* -> "sptr"
; cbEncodedToBeSigned : DWORD -> "int"
; pSignatureAlgorithm : CRYPT_ALGORITHM_IDENTIFIER* -> "sptr"
; pvHashAuxInfo : void* optional -> "sptr"
; pbSignature : BYTE* optional, out -> "sptr"
; pcbSignature : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。