ホーム › Security.Cryptography › CryptXmlOpenToDecode

CryptXmlOpenToDecode

関数

XMLデジタル署名を検証するためのデコード用ハンドルを開く。

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

シグネチャ

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

HRESULT CryptXmlOpenToDecode(
    const CRYPT_XML_TRANSFORM_CHAIN_CONFIG* pConfig,   // optional
    CRYPT_XML_FLAGS dwFlags,
    const CRYPT_XML_PROPERTY* rgProperty,   // optional
    DWORD cProperty,
    const CRYPT_XML_BLOB* pEncoded,
    void** phCryptXml
);

パラメーター

名前

型

方向

説明

pConfig

CRYPT_XML_TRANSFORM_CHAIN_CONFIG*

inoptional

変換チェーンエンジンのハンドル。このパラメーターが NULL の場合、変換の適用には既定のエンジンが使用されます。

dwFlags

CRYPT_XML_FLAGS

どの CryptXML 拡張機能を読み込むか、および XML をシリアル化するかどうかを制御する DWORD 値。このパラメーターには、次のいずれかの値を指定できます。

値	意味
CRYPT_XML_FLAG_NO_SERIALIZE 0x80000000	シリアル化を抑止します。重要複数のスレッドが CryptXml オブジェクトにアクセスしている場合は、このフラグを設定しないでください。シリアル化により、2 つ以上のスレッドが CryptXml オブジェクトまたはメモリを同時に受け入れようとしたときの相互排他が保証されます。
CRYPT_XML_FLAG_DISABLE_EXTENSIONS 0x10000000	署名およびダイジェストには既定の実装のみが使用されます。このフラグが設定されている場合、他の登録済み拡張機能は読み込まれません。

rgProperty

CRYPT_XML_PROPERTY*

inoptional

追加のプロパティを格納する CRYPT_XML_PROPERTY 構造体の配列へのポインター。

cProperty

DWORD

rgProperty パラメーターが指す配列内の項目数。

pEncoded

CRYPT_XML_BLOB*

デコードする署名を格納する CRYPT_XML_BLOB 構造体へのポインター。

phCryptXml

void**

out

ドキュメントコンテキストオブジェクトのハンドル。ハンドルの使用が終わったら、CryptXmlClose 関数に渡して解放してください。

戻り値の型: HRESULT

公式ドキュメント

デコードのために XML デジタル署名を開き、CRYPT_XML_SIGNATURE 構造体をカプセル化するドキュメントコンテキストのハンドルを返します。ドキュメントコンテキストには、1 つ以上の Signature 要素を含めることができます。

戻り値

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

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

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

各言語での呼び出し定義

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

HRESULT CryptXmlOpenToDecode(
    const CRYPT_XML_TRANSFORM_CHAIN_CONFIG* pConfig,   // optional
    CRYPT_XML_FLAGS dwFlags,
    const CRYPT_XML_PROPERTY* rgProperty,   // optional
    DWORD cProperty,
    const CRYPT_XML_BLOB* pEncoded,
    void** phCryptXml
);

[DllImport("CRYPTXML.dll", ExactSpelling = true)]
static extern int CryptXmlOpenToDecode(
    IntPtr pConfig,   // CRYPT_XML_TRANSFORM_CHAIN_CONFIG* optional
    uint dwFlags,   // CRYPT_XML_FLAGS
    IntPtr rgProperty,   // CRYPT_XML_PROPERTY* optional
    uint cProperty,   // DWORD
    IntPtr pEncoded,   // CRYPT_XML_BLOB*
    IntPtr phCryptXml   // void** out
);

<DllImport("CRYPTXML.dll", ExactSpelling:=True)>
Public Shared Function CryptXmlOpenToDecode(
    pConfig As IntPtr,   ' CRYPT_XML_TRANSFORM_CHAIN_CONFIG* optional
    dwFlags As UInteger,   ' CRYPT_XML_FLAGS
    rgProperty As IntPtr,   ' CRYPT_XML_PROPERTY* optional
    cProperty As UInteger,   ' DWORD
    pEncoded As IntPtr,   ' CRYPT_XML_BLOB*
    phCryptXml As IntPtr   ' void** out
) As Integer
End Function

' pConfig : CRYPT_XML_TRANSFORM_CHAIN_CONFIG* optional
' dwFlags : CRYPT_XML_FLAGS
' rgProperty : CRYPT_XML_PROPERTY* optional
' cProperty : DWORD
' pEncoded : CRYPT_XML_BLOB*
' phCryptXml : void** out
Declare PtrSafe Function CryptXmlOpenToDecode Lib "cryptxml" ( _
    ByVal pConfig As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal rgProperty As LongPtr, _
    ByVal cProperty As Long, _
    ByVal pEncoded As LongPtr, _
    ByVal phCryptXml As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptXmlOpenToDecode = ctypes.windll.cryptxml.CryptXmlOpenToDecode
CryptXmlOpenToDecode.restype = ctypes.c_int
CryptXmlOpenToDecode.argtypes = [
    ctypes.c_void_p,  # pConfig : CRYPT_XML_TRANSFORM_CHAIN_CONFIG* optional
    wintypes.DWORD,  # dwFlags : CRYPT_XML_FLAGS
    ctypes.c_void_p,  # rgProperty : CRYPT_XML_PROPERTY* optional
    wintypes.DWORD,  # cProperty : DWORD
    ctypes.c_void_p,  # pEncoded : CRYPT_XML_BLOB*
    ctypes.c_void_p,  # phCryptXml : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPTXML.dll')
CryptXmlOpenToDecode = Fiddle::Function.new(
  lib['CryptXmlOpenToDecode'],
  [
    Fiddle::TYPE_VOIDP,  # pConfig : CRYPT_XML_TRANSFORM_CHAIN_CONFIG* optional
    -Fiddle::TYPE_INT,  # dwFlags : CRYPT_XML_FLAGS
    Fiddle::TYPE_VOIDP,  # rgProperty : CRYPT_XML_PROPERTY* optional
    -Fiddle::TYPE_INT,  # cProperty : DWORD
    Fiddle::TYPE_VOIDP,  # pEncoded : CRYPT_XML_BLOB*
    Fiddle::TYPE_VOIDP,  # phCryptXml : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "cryptxml")]
extern "system" {
    fn CryptXmlOpenToDecode(
        pConfig: *const CRYPT_XML_TRANSFORM_CHAIN_CONFIG,  // CRYPT_XML_TRANSFORM_CHAIN_CONFIG* optional
        dwFlags: u32,  // CRYPT_XML_FLAGS
        rgProperty: *const CRYPT_XML_PROPERTY,  // CRYPT_XML_PROPERTY* optional
        cProperty: u32,  // DWORD
        pEncoded: *const CRYPT_XML_BLOB,  // CRYPT_XML_BLOB*
        phCryptXml: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPTXML.dll")]
public static extern int CryptXmlOpenToDecode(IntPtr pConfig, uint dwFlags, IntPtr rgProperty, uint cProperty, IntPtr pEncoded, IntPtr phCryptXml);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPTXML_CryptXmlOpenToDecode' -Namespace Win32 -PassThru
# $api::CryptXmlOpenToDecode(pConfig, dwFlags, rgProperty, cProperty, pEncoded, phCryptXml)

#uselib "CRYPTXML.dll"
#func global CryptXmlOpenToDecode "CryptXmlOpenToDecode" sptr, sptr, sptr, sptr, sptr, sptr
; CryptXmlOpenToDecode varptr(pConfig), dwFlags, varptr(rgProperty), cProperty, varptr(pEncoded), phCryptXml   ; 戻り値は stat
; pConfig : CRYPT_XML_TRANSFORM_CHAIN_CONFIG* optional -> "sptr"
; dwFlags : CRYPT_XML_FLAGS -> "sptr"
; rgProperty : CRYPT_XML_PROPERTY* optional -> "sptr"
; cProperty : DWORD -> "sptr"
; pEncoded : CRYPT_XML_BLOB* -> "sptr"
; phCryptXml : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPTXML.dll"
#cfunc global CryptXmlOpenToDecode "CryptXmlOpenToDecode" var, int, var, int, var, sptr
; res = CryptXmlOpenToDecode(pConfig, dwFlags, rgProperty, cProperty, pEncoded, phCryptXml)
; pConfig : CRYPT_XML_TRANSFORM_CHAIN_CONFIG* optional -> "var"
; dwFlags : CRYPT_XML_FLAGS -> "int"
; rgProperty : CRYPT_XML_PROPERTY* optional -> "var"
; cProperty : DWORD -> "int"
; pEncoded : CRYPT_XML_BLOB* -> "var"
; phCryptXml : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPTXML.dll"
#cfunc global CryptXmlOpenToDecode "CryptXmlOpenToDecode" sptr, int, sptr, int, sptr, sptr
; res = CryptXmlOpenToDecode(varptr(pConfig), dwFlags, varptr(rgProperty), cProperty, varptr(pEncoded), phCryptXml)
; pConfig : CRYPT_XML_TRANSFORM_CHAIN_CONFIG* optional -> "sptr"
; dwFlags : CRYPT_XML_FLAGS -> "int"
; rgProperty : CRYPT_XML_PROPERTY* optional -> "sptr"
; cProperty : DWORD -> "int"
; pEncoded : CRYPT_XML_BLOB* -> "sptr"
; phCryptXml : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。