ホーム › Security.Cryptography › CertCreateCTLEntryFromCertificateContextProperties

CertCreateCTLEntryFromCertificateContextProperties

関数

証明書のプロパティからCTLエントリを作成する。

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

シグネチャ

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

BOOL CertCreateCTLEntryFromCertificateContextProperties(
    const CERT_CONTEXT* pCertContext,
    DWORD cOptAttr,
    CRYPT_ATTRIBUTE* rgOptAttr,   // optional
    DWORD dwFlags,
    void* pvReserved,   // optional
    CTL_ENTRY* pCtlEntry,   // optional
    DWORD* pcbCtlEntry
);

パラメーター

名前	型	方向	説明
pCertContext	CERT_CONTEXT*	in	CTL の作成に使用する CERT_CONTEXT へのポインターです。
cOptAttr	DWORD	in	追加する属性の数を指定する DWORD です。
rgOptAttr	CRYPT_ATTRIBUTE*	inoptional	CTL に追加する CRYPT_ATTRIBUTE 属性の配列へのポインターです。
dwFlags	DWORD	in	DWORD です。チェーン構築ハッシュプロパティを属性として強制的に含めるには、CTL_ENTRY_FROM_PROP_CHAIN_FLAG を設定できます。
pvReserved	void*	optional	VOID へのポインターです。将来使用するために予約されています。
pCtlEntry	CTL_ENTRY*	outoptional	CTL_ENTRY 構造体へのポインターのアドレスです。CTL エントリを取得するには、この関数を 2 回呼び出します。1 回目の呼び出しでは、このパラメーターを NULL に設定します。関数が戻ったら、pcbCtlEntry パラメーターから取得したバイト数を使用してメモリを割り当てます。再度関数を呼び出し、このパラメーターに割り当てたメモリのアドレスを設定します。
pcbCtlEntry	DWORD*	inout	CTL_ENTRY 構造体に割り当てる必要があるバイト数を格納する DWORD へのポインターです。バイト数を取得するには、この関数を 2 回呼び出します。1 回目の呼び出しでは、このパラメーターを 0 が格納された DWORD 値のアドレスに設定し、pCtlEntry パラメーターを NULL に設定します。1 回目の呼び出しが成功すると、その DWORD 値には CTL_ENTRY 構造体に割り当てる必要があるバイト数が格納されます。必要なメモリを割り当て、pCtlEntry パラメーターにそのメモリのアドレスを指定して、再度関数を呼び出します。

戻り値の型: BOOL

公式ドキュメント

CertCreateCTLEntryFromCertificateContextProperties 関数は、証明書コンテキストのプロパティを属性とする証明書信頼リスト (CTL) エントリを作成します。CTL エントリ内の SubjectIdentifier は、証明書の SHA1 ハッシュです。

戻り値

関数が成功すると、0 以外 (TRUE) を返します。

関数が失敗すると、0 (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 CertCreateCTLEntryFromCertificateContextProperties(
    const CERT_CONTEXT* pCertContext,
    DWORD cOptAttr,
    CRYPT_ATTRIBUTE* rgOptAttr,   // optional
    DWORD dwFlags,
    void* pvReserved,   // optional
    CTL_ENTRY* pCtlEntry,   // optional
    DWORD* pcbCtlEntry
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertCreateCTLEntryFromCertificateContextProperties(
    IntPtr pCertContext,   // CERT_CONTEXT*
    uint cOptAttr,   // DWORD
    IntPtr rgOptAttr,   // CRYPT_ATTRIBUTE* optional
    uint dwFlags,   // DWORD
    IntPtr pvReserved,   // void* optional
    IntPtr pCtlEntry,   // CTL_ENTRY* optional, out
    ref uint pcbCtlEntry   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertCreateCTLEntryFromCertificateContextProperties(
    pCertContext As IntPtr,   ' CERT_CONTEXT*
    cOptAttr As UInteger,   ' DWORD
    rgOptAttr As IntPtr,   ' CRYPT_ATTRIBUTE* optional
    dwFlags As UInteger,   ' DWORD
    pvReserved As IntPtr,   ' void* optional
    pCtlEntry As IntPtr,   ' CTL_ENTRY* optional, out
    ByRef pcbCtlEntry As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pCertContext : CERT_CONTEXT*
' cOptAttr : DWORD
' rgOptAttr : CRYPT_ATTRIBUTE* optional
' dwFlags : DWORD
' pvReserved : void* optional
' pCtlEntry : CTL_ENTRY* optional, out
' pcbCtlEntry : DWORD* in/out
Declare PtrSafe Function CertCreateCTLEntryFromCertificateContextProperties Lib "crypt32" ( _
    ByVal pCertContext As LongPtr, _
    ByVal cOptAttr As Long, _
    ByVal rgOptAttr As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pvReserved As LongPtr, _
    ByVal pCtlEntry As LongPtr, _
    ByRef pcbCtlEntry As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertCreateCTLEntryFromCertificateContextProperties = ctypes.windll.crypt32.CertCreateCTLEntryFromCertificateContextProperties
CertCreateCTLEntryFromCertificateContextProperties.restype = wintypes.BOOL
CertCreateCTLEntryFromCertificateContextProperties.argtypes = [
    ctypes.c_void_p,  # pCertContext : CERT_CONTEXT*
    wintypes.DWORD,  # cOptAttr : DWORD
    ctypes.c_void_p,  # rgOptAttr : CRYPT_ATTRIBUTE* optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(None),  # pvReserved : void* optional
    ctypes.c_void_p,  # pCtlEntry : CTL_ENTRY* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbCtlEntry : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertCreateCTLEntryFromCertificateContextProperties = Fiddle::Function.new(
  lib['CertCreateCTLEntryFromCertificateContextProperties'],
  [
    Fiddle::TYPE_VOIDP,  # pCertContext : CERT_CONTEXT*
    -Fiddle::TYPE_INT,  # cOptAttr : DWORD
    Fiddle::TYPE_VOIDP,  # rgOptAttr : CRYPT_ATTRIBUTE* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pvReserved : void* optional
    Fiddle::TYPE_VOIDP,  # pCtlEntry : CTL_ENTRY* optional, out
    Fiddle::TYPE_VOIDP,  # pcbCtlEntry : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CertCreateCTLEntryFromCertificateContextProperties(
        pCertContext: *const CERT_CONTEXT,  // CERT_CONTEXT*
        cOptAttr: u32,  // DWORD
        rgOptAttr: *mut CRYPT_ATTRIBUTE,  // CRYPT_ATTRIBUTE* optional
        dwFlags: u32,  // DWORD
        pvReserved: *mut (),  // void* optional
        pCtlEntry: *mut CTL_ENTRY,  // CTL_ENTRY* optional, out
        pcbCtlEntry: *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 CertCreateCTLEntryFromCertificateContextProperties(IntPtr pCertContext, uint cOptAttr, IntPtr rgOptAttr, uint dwFlags, IntPtr pvReserved, IntPtr pCtlEntry, ref uint pcbCtlEntry);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertCreateCTLEntryFromCertificateContextProperties' -Namespace Win32 -PassThru
# $api::CertCreateCTLEntryFromCertificateContextProperties(pCertContext, cOptAttr, rgOptAttr, dwFlags, pvReserved, pCtlEntry, pcbCtlEntry)

#uselib "CRYPT32.dll"
#func global CertCreateCTLEntryFromCertificateContextProperties "CertCreateCTLEntryFromCertificateContextProperties" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CertCreateCTLEntryFromCertificateContextProperties varptr(pCertContext), cOptAttr, varptr(rgOptAttr), dwFlags, pvReserved, varptr(pCtlEntry), varptr(pcbCtlEntry)   ; 戻り値は stat
; pCertContext : CERT_CONTEXT* -> "sptr"
; cOptAttr : DWORD -> "sptr"
; rgOptAttr : CRYPT_ATTRIBUTE* optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; pvReserved : void* optional -> "sptr"
; pCtlEntry : CTL_ENTRY* optional, out -> "sptr"
; pcbCtlEntry : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CertCreateCTLEntryFromCertificateContextProperties "CertCreateCTLEntryFromCertificateContextProperties" var, int, var, int, sptr, var, var
; res = CertCreateCTLEntryFromCertificateContextProperties(pCertContext, cOptAttr, rgOptAttr, dwFlags, pvReserved, pCtlEntry, pcbCtlEntry)
; pCertContext : CERT_CONTEXT* -> "var"
; cOptAttr : DWORD -> "int"
; rgOptAttr : CRYPT_ATTRIBUTE* optional -> "var"
; dwFlags : DWORD -> "int"
; pvReserved : void* optional -> "sptr"
; pCtlEntry : CTL_ENTRY* optional, out -> "var"
; pcbCtlEntry : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CertCreateCTLEntryFromCertificateContextProperties "CertCreateCTLEntryFromCertificateContextProperties" sptr, int, sptr, int, sptr, sptr, sptr
; res = CertCreateCTLEntryFromCertificateContextProperties(varptr(pCertContext), cOptAttr, varptr(rgOptAttr), dwFlags, pvReserved, varptr(pCtlEntry), varptr(pcbCtlEntry))
; pCertContext : CERT_CONTEXT* -> "sptr"
; cOptAttr : DWORD -> "int"
; rgOptAttr : CRYPT_ATTRIBUTE* optional -> "sptr"
; dwFlags : DWORD -> "int"
; pvReserved : void* optional -> "sptr"
; pCtlEntry : CTL_ENTRY* optional, out -> "sptr"
; pcbCtlEntry : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。