Win32 API 日本語リファレンス
ホームSecurity.Cryptography › CertFindSubjectInCTL

CertFindSubjectInCTL

関数
CTL内から指定サブジェクトのエントリを検索する。
DLLCRYPT32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

CTL_ENTRY* CertFindSubjectInCTL(
    DWORD dwEncodingType,
    DWORD dwSubjectType,
    void* pvSubject,
    CTL_CONTEXT* pCtlContext,
    DWORD dwFlags
);

パラメーター

名前方向説明
dwEncodingTypeDWORDin

使用するエンコーディングの種類を指定します。現在は X509_ASN_ENCODINGPKCS_7_ASN_ENCODING のみが使用されますが、将来的にエンコーディングの種類が追加される可能性があります。現在のいずれのエンコーディングの種類についても、次を使用します。

X509_ASN_ENCODING | PKCS_7_ASN_ENCODING

dwSubjectTypeDWORDin

CTL 内で検索するサブジェクトの種類を指定します。既定の検索を行う場合は NULL を指定できます。

意味
CTL_CERT_SUBJECT_TYPE
pvSubject のデータ型: CERT_CONTEXT 構造体へのポインター。

CTL の SubjectAlgorithm を調べて、サブジェクトの識別情報の表現方法を判別します。当初は SubjectAlgorithm の値として SHA1 と MD5 ハッシュのみがサポートされます。該当するハッシュプロパティは CERT_CONTEXT 構造体から取得されます。

CTL_ANY_SUBJECT_TYPE
pvSubject のデータ型: CTL_ANY_SUBJECT_INFO 構造体へのポインター。

この構造体の SubjectAlgorithm メンバーは CTL のアルゴリズムの種類と一致している必要があり、SubjectIdentifier メンバーは CTL エントリのいずれかと一致している必要があります。

証明書の ハッシュ、または CTL_ANY_SUBJECT_INFO 構造体の SubjectIdentifier メンバーが、サブジェクトエントリを検索する際のキーとして使用されます。キーとエントリの SubjectIdentifier との間でバイナリのメモリ比較が行われます。

dwSubjectType に上記いずれかの値が設定されている場合、dwEncodingType は使用されません。

pvSubjectvoid*indwSubjectType パラメーターと組み合わせて使用されるポインター。
pCtlContextCTL_CONTEXT*in検索対象となる CTL_CONTEXT 構造体へのポインター。
dwFlagsDWORDin将来の使用のために予約されており、ゼロである必要があります。

戻り値の型: CTL_ENTRY*

公式ドキュメント

CertFindSubjectInCTL 関数は、指定されたサブジェクトを証明書信頼リスト (CTL) 内で検索します。

戻り値

関数が成功した場合、戻り値は見つかったエントリです(見つかった場合)。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、 GetLastError を呼び出します。考えられるエラーコードの一部を次に示します。

戻りコード 説明
CRYPT_E_NOT_FOUND
サブジェクトが CTL 内で見つかりませんでした。
E_INVALIDARG
dwSubjectType パラメーターが CTL_CERT_SUBJECT_TYPE または CTL_ANY_SUBJECT_TYPE のいずれでもありませんでした。
NTE_BAD_ALGID
CTL の SubjectAlgorithm メンバーが SHA1 または MD5 のいずれにも対応していませんでした。

解説(Remarks)

証明書のハッシュ、または CTL_ANY_SUBJECT_INFO 構造体の SubjectIdentifier メンバーが、サブジェクトエントリを検索する際のキーとして使用されます。キーとエントリの SubjectIdentifier との間でバイナリのメモリ比較が行われます。

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

各言語での呼び出し定義

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

CTL_ENTRY* CertFindSubjectInCTL(
    DWORD dwEncodingType,
    DWORD dwSubjectType,
    void* pvSubject,
    CTL_CONTEXT* pCtlContext,
    DWORD dwFlags
);
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CertFindSubjectInCTL(
    uint dwEncodingType,   // DWORD
    uint dwSubjectType,   // DWORD
    IntPtr pvSubject,   // void*
    IntPtr pCtlContext,   // CTL_CONTEXT*
    uint dwFlags   // DWORD
);
<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertFindSubjectInCTL(
    dwEncodingType As UInteger,   ' DWORD
    dwSubjectType As UInteger,   ' DWORD
    pvSubject As IntPtr,   ' void*
    pCtlContext As IntPtr,   ' CTL_CONTEXT*
    dwFlags As UInteger   ' DWORD
) As IntPtr
End Function
' dwEncodingType : DWORD
' dwSubjectType : DWORD
' pvSubject : void*
' pCtlContext : CTL_CONTEXT*
' dwFlags : DWORD
Declare PtrSafe Function CertFindSubjectInCTL Lib "crypt32" ( _
    ByVal dwEncodingType As Long, _
    ByVal dwSubjectType As Long, _
    ByVal pvSubject As LongPtr, _
    ByVal pCtlContext As LongPtr, _
    ByVal dwFlags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CertFindSubjectInCTL = ctypes.windll.crypt32.CertFindSubjectInCTL
CertFindSubjectInCTL.restype = ctypes.c_void_p
CertFindSubjectInCTL.argtypes = [
    wintypes.DWORD,  # dwEncodingType : DWORD
    wintypes.DWORD,  # dwSubjectType : DWORD
    ctypes.POINTER(None),  # pvSubject : void*
    ctypes.c_void_p,  # pCtlContext : CTL_CONTEXT*
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertFindSubjectInCTL = Fiddle::Function.new(
  lib['CertFindSubjectInCTL'],
  [
    -Fiddle::TYPE_INT,  # dwEncodingType : DWORD
    -Fiddle::TYPE_INT,  # dwSubjectType : DWORD
    Fiddle::TYPE_VOIDP,  # pvSubject : void*
    Fiddle::TYPE_VOIDP,  # pCtlContext : CTL_CONTEXT*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "crypt32")]
extern "system" {
    fn CertFindSubjectInCTL(
        dwEncodingType: u32,  // DWORD
        dwSubjectType: u32,  // DWORD
        pvSubject: *mut (),  // void*
        pCtlContext: *mut CTL_CONTEXT,  // CTL_CONTEXT*
        dwFlags: u32  // DWORD
    ) -> *mut CTL_ENTRY;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern IntPtr CertFindSubjectInCTL(uint dwEncodingType, uint dwSubjectType, IntPtr pvSubject, IntPtr pCtlContext, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertFindSubjectInCTL' -Namespace Win32 -PassThru
# $api::CertFindSubjectInCTL(dwEncodingType, dwSubjectType, pvSubject, pCtlContext, dwFlags)
#uselib "CRYPT32.dll"
#func global CertFindSubjectInCTL "CertFindSubjectInCTL" sptr, sptr, sptr, sptr, sptr
; CertFindSubjectInCTL dwEncodingType, dwSubjectType, pvSubject, varptr(pCtlContext), dwFlags   ; 戻り値は stat
; dwEncodingType : DWORD -> "sptr"
; dwSubjectType : DWORD -> "sptr"
; pvSubject : void* -> "sptr"
; pCtlContext : CTL_CONTEXT* -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CRYPT32.dll"
#cfunc global CertFindSubjectInCTL "CertFindSubjectInCTL" int, int, sptr, var, int
; res = CertFindSubjectInCTL(dwEncodingType, dwSubjectType, pvSubject, pCtlContext, dwFlags)
; dwEncodingType : DWORD -> "int"
; dwSubjectType : DWORD -> "int"
; pvSubject : void* -> "sptr"
; pCtlContext : CTL_CONTEXT* -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; CTL_ENTRY* CertFindSubjectInCTL(DWORD dwEncodingType, DWORD dwSubjectType, void* pvSubject, CTL_CONTEXT* pCtlContext, DWORD dwFlags)
#uselib "CRYPT32.dll"
#cfunc global CertFindSubjectInCTL "CertFindSubjectInCTL" int, int, intptr, var, int
; res = CertFindSubjectInCTL(dwEncodingType, dwSubjectType, pvSubject, pCtlContext, dwFlags)
; dwEncodingType : DWORD -> "int"
; dwSubjectType : DWORD -> "int"
; pvSubject : void* -> "intptr"
; pCtlContext : CTL_CONTEXT* -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	crypt32 = windows.NewLazySystemDLL("CRYPT32.dll")
	procCertFindSubjectInCTL = crypt32.NewProc("CertFindSubjectInCTL")
)

// dwEncodingType (DWORD), dwSubjectType (DWORD), pvSubject (void*), pCtlContext (CTL_CONTEXT*), dwFlags (DWORD)
r1, _, err := procCertFindSubjectInCTL.Call(
	uintptr(dwEncodingType),
	uintptr(dwSubjectType),
	uintptr(pvSubject),
	uintptr(pCtlContext),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // CTL_ENTRY*
function CertFindSubjectInCTL(
  dwEncodingType: DWORD;   // DWORD
  dwSubjectType: DWORD;   // DWORD
  pvSubject: Pointer;   // void*
  pCtlContext: Pointer;   // CTL_CONTEXT*
  dwFlags: DWORD   // DWORD
): Pointer; stdcall;
  external 'CRYPT32.dll' name 'CertFindSubjectInCTL';
result := DllCall("CRYPT32\CertFindSubjectInCTL"
    , "UInt", dwEncodingType   ; DWORD
    , "UInt", dwSubjectType   ; DWORD
    , "Ptr", pvSubject   ; void*
    , "Ptr", pCtlContext   ; CTL_CONTEXT*
    , "UInt", dwFlags   ; DWORD
    , "Ptr")   ; return: CTL_ENTRY*
●CertFindSubjectInCTL(dwEncodingType, dwSubjectType, pvSubject, pCtlContext, dwFlags) = DLL("CRYPT32.dll", "void* CertFindSubjectInCTL(dword, dword, void*, void*, dword)")
# 呼び出し: CertFindSubjectInCTL(dwEncodingType, dwSubjectType, pvSubject, pCtlContext, dwFlags)
# dwEncodingType : DWORD -> "dword"
# dwSubjectType : DWORD -> "dword"
# pvSubject : void* -> "void*"
# pCtlContext : CTL_CONTEXT* -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "crypt32" fn CertFindSubjectInCTL(
    dwEncodingType: u32, // DWORD
    dwSubjectType: u32, // DWORD
    pvSubject: ?*anyopaque, // void*
    pCtlContext: [*c]CTL_CONTEXT, // CTL_CONTEXT*
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) [*c]CTL_ENTRY;
proc CertFindSubjectInCTL(
    dwEncodingType: uint32,  # DWORD
    dwSubjectType: uint32,  # DWORD
    pvSubject: pointer,  # void*
    pCtlContext: ptr CTL_CONTEXT,  # CTL_CONTEXT*
    dwFlags: uint32  # DWORD
): ptr CTL_ENTRY {.importc: "CertFindSubjectInCTL", stdcall, dynlib: "CRYPT32.dll".}
pragma(lib, "crypt32");
extern(Windows)
CTL_ENTRY* CertFindSubjectInCTL(
    uint dwEncodingType,   // DWORD
    uint dwSubjectType,   // DWORD
    void* pvSubject,   // void*
    CTL_CONTEXT* pCtlContext,   // CTL_CONTEXT*
    uint dwFlags   // DWORD
);
ccall((:CertFindSubjectInCTL, "CRYPT32.dll"), stdcall, Ptr{CTL_ENTRY},
      (UInt32, UInt32, Ptr{Cvoid}, Ptr{CTL_CONTEXT}, UInt32),
      dwEncodingType, dwSubjectType, pvSubject, pCtlContext, dwFlags)
# dwEncodingType : DWORD -> UInt32
# dwSubjectType : DWORD -> UInt32
# pvSubject : void* -> Ptr{Cvoid}
# pCtlContext : CTL_CONTEXT* -> Ptr{CTL_CONTEXT}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* CertFindSubjectInCTL(
    uint32_t dwEncodingType,
    uint32_t dwSubjectType,
    void* pvSubject,
    void* pCtlContext,
    uint32_t dwFlags);
]]
local crypt32 = ffi.load("crypt32")
-- crypt32.CertFindSubjectInCTL(dwEncodingType, dwSubjectType, pvSubject, pCtlContext, dwFlags)
-- dwEncodingType : DWORD
-- dwSubjectType : DWORD
-- pvSubject : void*
-- pCtlContext : CTL_CONTEXT*
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CRYPT32.dll');
const CertFindSubjectInCTL = lib.func('__stdcall', 'CertFindSubjectInCTL', 'void *', ['uint32_t', 'uint32_t', 'void *', 'void *', 'uint32_t']);
// CertFindSubjectInCTL(dwEncodingType, dwSubjectType, pvSubject, pCtlContext, dwFlags)
// dwEncodingType : DWORD -> 'uint32_t'
// dwSubjectType : DWORD -> 'uint32_t'
// pvSubject : void* -> 'void *'
// pCtlContext : CTL_CONTEXT* -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CRYPT32.dll", {
  CertFindSubjectInCTL: { parameters: ["u32", "u32", "pointer", "pointer", "u32"], result: "pointer" },
});
// lib.symbols.CertFindSubjectInCTL(dwEncodingType, dwSubjectType, pvSubject, pCtlContext, dwFlags)
// dwEncodingType : DWORD -> "u32"
// dwSubjectType : DWORD -> "u32"
// pvSubject : void* -> "pointer"
// pCtlContext : CTL_CONTEXT* -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* CertFindSubjectInCTL(
    uint32_t dwEncodingType,
    uint32_t dwSubjectType,
    void* pvSubject,
    void* pCtlContext,
    uint32_t dwFlags);
C, "CRYPT32.dll");
// $ffi->CertFindSubjectInCTL(dwEncodingType, dwSubjectType, pvSubject, pCtlContext, dwFlags);
// dwEncodingType : DWORD
// dwSubjectType : DWORD
// pvSubject : void*
// pCtlContext : CTL_CONTEXT*
// dwFlags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Crypt32 extends StdCallLibrary {
    Crypt32 INSTANCE = Native.load("crypt32", Crypt32.class);
    Pointer CertFindSubjectInCTL(
        int dwEncodingType,   // DWORD
        int dwSubjectType,   // DWORD
        Pointer pvSubject,   // void*
        Pointer pCtlContext,   // CTL_CONTEXT*
        int dwFlags   // DWORD
    );
}
@[Link("crypt32")]
lib LibCRYPT32
  fun CertFindSubjectInCTL = CertFindSubjectInCTL(
    dwEncodingType : UInt32,   # DWORD
    dwSubjectType : UInt32,   # DWORD
    pvSubject : Void*,   # void*
    pCtlContext : CTL_CONTEXT*,   # CTL_CONTEXT*
    dwFlags : UInt32   # DWORD
  ) : CTL_ENTRY*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CertFindSubjectInCTLNative = Pointer<Void> Function(Uint32, Uint32, Pointer<Void>, Pointer<Void>, Uint32);
typedef CertFindSubjectInCTLDart = Pointer<Void> Function(int, int, Pointer<Void>, Pointer<Void>, int);
final CertFindSubjectInCTL = DynamicLibrary.open('CRYPT32.dll')
    .lookupFunction<CertFindSubjectInCTLNative, CertFindSubjectInCTLDart>('CertFindSubjectInCTL');
// dwEncodingType : DWORD -> Uint32
// dwSubjectType : DWORD -> Uint32
// pvSubject : void* -> Pointer<Void>
// pCtlContext : CTL_CONTEXT* -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CertFindSubjectInCTL(
  dwEncodingType: DWORD;   // DWORD
  dwSubjectType: DWORD;   // DWORD
  pvSubject: Pointer;   // void*
  pCtlContext: Pointer;   // CTL_CONTEXT*
  dwFlags: DWORD   // DWORD
): Pointer; stdcall;
  external 'CRYPT32.dll' name 'CertFindSubjectInCTL';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CertFindSubjectInCTL"
  c_CertFindSubjectInCTL :: Word32 -> Word32 -> Ptr () -> Ptr () -> Word32 -> IO (Ptr ())
-- dwEncodingType : DWORD -> Word32
-- dwSubjectType : DWORD -> Word32
-- pvSubject : void* -> Ptr ()
-- pCtlContext : CTL_CONTEXT* -> Ptr ()
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let certfindsubjectinctl =
  foreign "CertFindSubjectInCTL"
    (uint32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning (ptr void))
(* dwEncodingType : DWORD -> uint32_t *)
(* dwSubjectType : DWORD -> uint32_t *)
(* pvSubject : void* -> (ptr void) *)
(* pCtlContext : CTL_CONTEXT* -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library crypt32 (t "CRYPT32.dll"))
(cffi:use-foreign-library crypt32)

(cffi:defcfun ("CertFindSubjectInCTL" cert-find-subject-in-ctl :convention :stdcall) :pointer
  (dw-encoding-type :uint32)   ; DWORD
  (dw-subject-type :uint32)   ; DWORD
  (pv-subject :pointer)   ; void*
  (p-ctl-context :pointer)   ; CTL_CONTEXT*
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CertFindSubjectInCTL = Win32::API::More->new('CRYPT32',
    'LPVOID CertFindSubjectInCTL(DWORD dwEncodingType, DWORD dwSubjectType, LPVOID pvSubject, LPVOID pCtlContext, DWORD dwFlags)');
# my $ret = $CertFindSubjectInCTL->Call($dwEncodingType, $dwSubjectType, $pvSubject, $pCtlContext, $dwFlags);
# dwEncodingType : DWORD -> DWORD
# dwSubjectType : DWORD -> DWORD
# pvSubject : void* -> LPVOID
# pCtlContext : CTL_CONTEXT* -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型