ホーム › Security.Cryptography › CryptXmlSign

CryptXmlSign

関数

鍵を用いてXMLデジタル署名を生成する。

DLLCRYPTXML.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT CryptXmlSign(
    void* hSignature,
    HCRYPTPROV_OR_NCRYPT_KEY_HANDLE hKey,   // optional
    CERT_KEY_SPEC dwKeySpec,
    CRYPT_XML_FLAGS dwFlags,
    CRYPT_XML_KEYINFO_SPEC dwKeyInfoSpec,
    const void* pvKeyInfoSpec,   // optional
    const CRYPT_XML_ALGORITHM* pSignatureMethod,
    const CRYPT_XML_ALGORITHM* pCanonicalization
);

パラメーター

名前

型

方向

説明

hSignature

void*

CRYPT_XML_SIGNATURE 構造体へのハンドル。

hKey

HCRYPTPROV_OR_NCRYPT_KEY_HANDLE

inoptional

SignedInfo 要素の署名に使用される秘密鍵のハンドル。 HMAC ベースの署名アルゴリズムの場合、このパラメーターは NULL でなければなりません。

dwKeySpec

CERT_KEY_SPEC

鍵の種類を指定する DWORD 値。このパラメーターには次のいずれかの値を指定できます。

値	意味
AT_KEYEXCHANGE 1	鍵ペアは鍵交換ペアです。
AT_SIGNATURE 2	鍵ペアは署名ペアです。
CERT_NCRYPT_KEY_SPEC 0xFFFFFFFF	鍵は Cryptography API: Next Generation (CNG) の鍵です。

dwFlags

CRYPT_XML_FLAGS

データの署名方法を制御する DWORD 値。このパラメーターには次のいずれかの値を指定できます。

値	意味
CRYPT_XML_SIGN_ADD_KEYVALUE 0x00000001	hKey パラメーターで指定されたハンドルから KeyValue 要素を設定します。重要 CRYPT_XML_SIGN_ADD_KEYVALUE フラグは、dwKeyInfoSpec パラメーターが CRYPT_XML_KEYINFO_SPEC_ENCODED に設定されている場合は使用できません。
CRYPT_XML_FLAG_DISABLE_EXTENSIONS 0x10000000	署名およびダイジェストには既定の実装のみが使用されます。このフラグが設定されている場合、登録されている他の拡張機能は読み込まれません。

dwKeyInfoSpec

CRYPT_XML_KEYINFO_SPEC

pvKeyInfoSpec パラメーターが指すデータ構造の種類。可能な組み合わせの例を以下に示します。

dwKeyInfec	pvKeyInfoSpec
CRYPT_XML_KEYINFO_SPEC_NONE	NULL に設定されます
CRYPT_XML_KEYINFO_SPEC_ENCODED	CRYPT_XML_BLOB 構造体を指します
CRYPT_XML_KEYINFO_SPEC_PARAM	CRYPT_XML_KEYINFO_PARAM 構造体を指します

pvKeyInfoSpec

void*

inoptional

構造体へのポインター。その型は dwKeyInfoSpec パラメーターの値によって決定されます。

pSignatureMethod

CRYPT_XML_ALGORITHM*

署名方式を指定する CRYPT_XML_ALGORITHM 構造体へのポインター。

pCanonicalization

CRYPT_XML_ALGORITHM*

正規化方式を指定する CRYPT_XML_ALGORITHM 構造体へのポインター。

戻り値の型: HRESULT

公式ドキュメント

SignedInfo 要素の暗号署名を作成します。

戻り値

関数が成功した場合、ゼロを返します。

関数が失敗した場合、エラーを示す HRESULT 値を返します。

解説(Remarks)

証明書が見つからない場合、CryptXmlSign は証明書選択用の UI を作成します。このウィンドウがセッション 0で実行されているプロセスから生成された場合、アプリケーションが予期せず終了する可能性があります。

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

各言語での呼び出し定義

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

HRESULT CryptXmlSign(
    void* hSignature,
    HCRYPTPROV_OR_NCRYPT_KEY_HANDLE hKey,   // optional
    CERT_KEY_SPEC dwKeySpec,
    CRYPT_XML_FLAGS dwFlags,
    CRYPT_XML_KEYINFO_SPEC dwKeyInfoSpec,
    const void* pvKeyInfoSpec,   // optional
    const CRYPT_XML_ALGORITHM* pSignatureMethod,
    const CRYPT_XML_ALGORITHM* pCanonicalization
);

[DllImport("CRYPTXML.dll", ExactSpelling = true)]
static extern int CryptXmlSign(
    IntPtr hSignature,   // void*
    UIntPtr hKey,   // HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
    uint dwKeySpec,   // CERT_KEY_SPEC
    uint dwFlags,   // CRYPT_XML_FLAGS
    int dwKeyInfoSpec,   // CRYPT_XML_KEYINFO_SPEC
    IntPtr pvKeyInfoSpec,   // void* optional
    IntPtr pSignatureMethod,   // CRYPT_XML_ALGORITHM*
    IntPtr pCanonicalization   // CRYPT_XML_ALGORITHM*
);

<DllImport("CRYPTXML.dll", ExactSpelling:=True)>
Public Shared Function CryptXmlSign(
    hSignature As IntPtr,   ' void*
    hKey As UIntPtr,   ' HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
    dwKeySpec As UInteger,   ' CERT_KEY_SPEC
    dwFlags As UInteger,   ' CRYPT_XML_FLAGS
    dwKeyInfoSpec As Integer,   ' CRYPT_XML_KEYINFO_SPEC
    pvKeyInfoSpec As IntPtr,   ' void* optional
    pSignatureMethod As IntPtr,   ' CRYPT_XML_ALGORITHM*
    pCanonicalization As IntPtr   ' CRYPT_XML_ALGORITHM*
) As Integer
End Function

' hSignature : void*
' hKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
' dwKeySpec : CERT_KEY_SPEC
' dwFlags : CRYPT_XML_FLAGS
' dwKeyInfoSpec : CRYPT_XML_KEYINFO_SPEC
' pvKeyInfoSpec : void* optional
' pSignatureMethod : CRYPT_XML_ALGORITHM*
' pCanonicalization : CRYPT_XML_ALGORITHM*
Declare PtrSafe Function CryptXmlSign Lib "cryptxml" ( _
    ByVal hSignature As LongPtr, _
    ByVal hKey As LongPtr, _
    ByVal dwKeySpec As Long, _
    ByVal dwFlags As Long, _
    ByVal dwKeyInfoSpec As Long, _
    ByVal pvKeyInfoSpec As LongPtr, _
    ByVal pSignatureMethod As LongPtr, _
    ByVal pCanonicalization As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptXmlSign = ctypes.windll.cryptxml.CryptXmlSign
CryptXmlSign.restype = ctypes.c_int
CryptXmlSign.argtypes = [
    ctypes.POINTER(None),  # hSignature : void*
    ctypes.c_size_t,  # hKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
    wintypes.DWORD,  # dwKeySpec : CERT_KEY_SPEC
    wintypes.DWORD,  # dwFlags : CRYPT_XML_FLAGS
    ctypes.c_int,  # dwKeyInfoSpec : CRYPT_XML_KEYINFO_SPEC
    ctypes.POINTER(None),  # pvKeyInfoSpec : void* optional
    ctypes.c_void_p,  # pSignatureMethod : CRYPT_XML_ALGORITHM*
    ctypes.c_void_p,  # pCanonicalization : CRYPT_XML_ALGORITHM*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPTXML.dll')
CryptXmlSign = Fiddle::Function.new(
  lib['CryptXmlSign'],
  [
    Fiddle::TYPE_VOIDP,  # hSignature : void*
    Fiddle::TYPE_UINTPTR_T,  # hKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
    -Fiddle::TYPE_INT,  # dwKeySpec : CERT_KEY_SPEC
    -Fiddle::TYPE_INT,  # dwFlags : CRYPT_XML_FLAGS
    Fiddle::TYPE_INT,  # dwKeyInfoSpec : CRYPT_XML_KEYINFO_SPEC
    Fiddle::TYPE_VOIDP,  # pvKeyInfoSpec : void* optional
    Fiddle::TYPE_VOIDP,  # pSignatureMethod : CRYPT_XML_ALGORITHM*
    Fiddle::TYPE_VOIDP,  # pCanonicalization : CRYPT_XML_ALGORITHM*
  ],
  Fiddle::TYPE_INT)

#[link(name = "cryptxml")]
extern "system" {
    fn CryptXmlSign(
        hSignature: *mut (),  // void*
        hKey: usize,  // HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional
        dwKeySpec: u32,  // CERT_KEY_SPEC
        dwFlags: u32,  // CRYPT_XML_FLAGS
        dwKeyInfoSpec: i32,  // CRYPT_XML_KEYINFO_SPEC
        pvKeyInfoSpec: *const (),  // void* optional
        pSignatureMethod: *const CRYPT_XML_ALGORITHM,  // CRYPT_XML_ALGORITHM*
        pCanonicalization: *const CRYPT_XML_ALGORITHM  // CRYPT_XML_ALGORITHM*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPTXML.dll")]
public static extern int CryptXmlSign(IntPtr hSignature, UIntPtr hKey, uint dwKeySpec, uint dwFlags, int dwKeyInfoSpec, IntPtr pvKeyInfoSpec, IntPtr pSignatureMethod, IntPtr pCanonicalization);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPTXML_CryptXmlSign' -Namespace Win32 -PassThru
# $api::CryptXmlSign(hSignature, hKey, dwKeySpec, dwFlags, dwKeyInfoSpec, pvKeyInfoSpec, pSignatureMethod, pCanonicalization)

#uselib "CRYPTXML.dll"
#func global CryptXmlSign "CryptXmlSign" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptXmlSign hSignature, hKey, dwKeySpec, dwFlags, dwKeyInfoSpec, pvKeyInfoSpec, varptr(pSignatureMethod), varptr(pCanonicalization)   ; 戻り値は stat
; hSignature : void* -> "sptr"
; hKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional -> "sptr"
; dwKeySpec : CERT_KEY_SPEC -> "sptr"
; dwFlags : CRYPT_XML_FLAGS -> "sptr"
; dwKeyInfoSpec : CRYPT_XML_KEYINFO_SPEC -> "sptr"
; pvKeyInfoSpec : void* optional -> "sptr"
; pSignatureMethod : CRYPT_XML_ALGORITHM* -> "sptr"
; pCanonicalization : CRYPT_XML_ALGORITHM* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPTXML.dll"
#cfunc global CryptXmlSign "CryptXmlSign" sptr, sptr, int, int, int, sptr, var, var
; res = CryptXmlSign(hSignature, hKey, dwKeySpec, dwFlags, dwKeyInfoSpec, pvKeyInfoSpec, pSignatureMethod, pCanonicalization)
; hSignature : void* -> "sptr"
; hKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional -> "sptr"
; dwKeySpec : CERT_KEY_SPEC -> "int"
; dwFlags : CRYPT_XML_FLAGS -> "int"
; dwKeyInfoSpec : CRYPT_XML_KEYINFO_SPEC -> "int"
; pvKeyInfoSpec : void* optional -> "sptr"
; pSignatureMethod : CRYPT_XML_ALGORITHM* -> "var"
; pCanonicalization : CRYPT_XML_ALGORITHM* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPTXML.dll"
#cfunc global CryptXmlSign "CryptXmlSign" sptr, sptr, int, int, int, sptr, sptr, sptr
; res = CryptXmlSign(hSignature, hKey, dwKeySpec, dwFlags, dwKeyInfoSpec, pvKeyInfoSpec, varptr(pSignatureMethod), varptr(pCanonicalization))
; hSignature : void* -> "sptr"
; hKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE optional -> "sptr"
; dwKeySpec : CERT_KEY_SPEC -> "int"
; dwFlags : CRYPT_XML_FLAGS -> "int"
; dwKeyInfoSpec : CRYPT_XML_KEYINFO_SPEC -> "int"
; pvKeyInfoSpec : void* optional -> "sptr"
; pSignatureMethod : CRYPT_XML_ALGORITHM* -> "sptr"
; pCanonicalization : CRYPT_XML_ALGORITHM* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。