ホーム › Security.Cryptography › CertSerializeCTLStoreElement

CertSerializeCTLStoreElement

関数

CTLとそのプロパティをシリアル化する。

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

シグネチャ

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

BOOL CertSerializeCTLStoreElement(
    CTL_CONTEXT* pCtlContext,
    DWORD dwFlags,
    BYTE* pbElement,   // optional
    DWORD* pcbElement
);

パラメーター

名前	型	方向	説明
pCtlContext	CTL_CONTEXT*	in	シリアル化される CTL_CONTEXT 構造体へのポインターです。
dwFlags	DWORD	in	将来の使用のために予約されており、ゼロである必要があります。
pbElement	BYTE*	outoptional	シリアル化された出力を受け取るバッファーへのポインターです。これには、エンコードされた CTL と、場合によってはそのプロパティが含まれます。このパラメーターを NULL にすると、メモリ割り当てのためにこの情報のサイズを設定できます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbElement	DWORD*	inout	pbElement パラメーターが指すバッファーのサイズ (バイト単位) を指定する DWORD 値へのポインターです。関数が戻るとき、この DWORD 値にはバッファーに格納されたバイト数が含まれます。注意バッファーで返されるデータを処理する場合、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなる場合があります。(入力時には、可能な限り最大の出力データがバッファーに収まるように、通常はバッファーサイズを十分に大きく指定します。) 出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

戻り値の型: BOOL

公式ドキュメント

CertSerializeCTLStoreElement 関数は、エンコードされた証明書信頼リスト (CTL) コンテキストと、そのプロパティのエンコードされた表現をシリアル化します。結果はストレージに永続化でき、後で CTL とプロパティを取得できます。

戻り値

関数が成功した場合、戻り値は TRUE です。

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

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

各言語での呼び出し定義

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

BOOL CertSerializeCTLStoreElement(
    CTL_CONTEXT* pCtlContext,
    DWORD dwFlags,
    BYTE* pbElement,   // optional
    DWORD* pcbElement
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertSerializeCTLStoreElement(
    IntPtr pCtlContext,   // CTL_CONTEXT*
    uint dwFlags,   // DWORD
    IntPtr pbElement,   // BYTE* optional, out
    ref uint pcbElement   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertSerializeCTLStoreElement(
    pCtlContext As IntPtr,   ' CTL_CONTEXT*
    dwFlags As UInteger,   ' DWORD
    pbElement As IntPtr,   ' BYTE* optional, out
    ByRef pcbElement As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pCtlContext : CTL_CONTEXT*
' dwFlags : DWORD
' pbElement : BYTE* optional, out
' pcbElement : DWORD* in/out
Declare PtrSafe Function CertSerializeCTLStoreElement Lib "crypt32" ( _
    ByVal pCtlContext As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pbElement As LongPtr, _
    ByRef pcbElement As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertSerializeCTLStoreElement = ctypes.windll.crypt32.CertSerializeCTLStoreElement
CertSerializeCTLStoreElement.restype = wintypes.BOOL
CertSerializeCTLStoreElement.argtypes = [
    ctypes.c_void_p,  # pCtlContext : CTL_CONTEXT*
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbElement : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbElement : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertSerializeCTLStoreElement = Fiddle::Function.new(
  lib['CertSerializeCTLStoreElement'],
  [
    Fiddle::TYPE_VOIDP,  # pCtlContext : CTL_CONTEXT*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pbElement : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbElement : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CertSerializeCTLStoreElement(
        pCtlContext: *mut CTL_CONTEXT,  // CTL_CONTEXT*
        dwFlags: u32,  // DWORD
        pbElement: *mut u8,  // BYTE* optional, out
        pcbElement: *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 CertSerializeCTLStoreElement(IntPtr pCtlContext, uint dwFlags, IntPtr pbElement, ref uint pcbElement);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertSerializeCTLStoreElement' -Namespace Win32 -PassThru
# $api::CertSerializeCTLStoreElement(pCtlContext, dwFlags, pbElement, pcbElement)

#uselib "CRYPT32.dll"
#func global CertSerializeCTLStoreElement "CertSerializeCTLStoreElement" sptr, sptr, sptr, sptr
; CertSerializeCTLStoreElement varptr(pCtlContext), dwFlags, varptr(pbElement), varptr(pcbElement)   ; 戻り値は stat
; pCtlContext : CTL_CONTEXT* -> "sptr"
; dwFlags : DWORD -> "sptr"
; pbElement : BYTE* optional, out -> "sptr"
; pcbElement : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CertSerializeCTLStoreElement "CertSerializeCTLStoreElement" var, int, var, var
; res = CertSerializeCTLStoreElement(pCtlContext, dwFlags, pbElement, pcbElement)
; pCtlContext : CTL_CONTEXT* -> "var"
; dwFlags : DWORD -> "int"
; pbElement : BYTE* optional, out -> "var"
; pcbElement : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CertSerializeCTLStoreElement "CertSerializeCTLStoreElement" sptr, int, sptr, sptr
; res = CertSerializeCTLStoreElement(varptr(pCtlContext), dwFlags, varptr(pbElement), varptr(pcbElement))
; pCtlContext : CTL_CONTEXT* -> "sptr"
; dwFlags : DWORD -> "int"
; pbElement : BYTE* optional, out -> "sptr"
; pcbElement : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。