ホーム › Security.Cryptography › CryptEnumKeyIdentifierProperties

CryptEnumKeyIdentifierProperties

関数

鍵識別子とそのプロパティをコールバックで列挙する。

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

シグネチャ

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

BOOL CryptEnumKeyIdentifierProperties(
    const CRYPT_INTEGER_BLOB* pKeyIdentifier,   // optional
    DWORD dwPropId,
    DWORD dwFlags,
    LPCWSTR pwszComputerName,   // optional
    void* pvReserved,   // optional
    void* pvArg,   // optional
    PFN_CRYPT_ENUM_KEYID_PROP pfnEnum
);

パラメーター

名前	型	方向	説明
pKeyIdentifier	CRYPT_INTEGER_BLOB*	inoptional	キー識別子を格納した CRYPT_HASH_BLOB 構造体へのポインターです。 pKeyIdentifier が NULL の場合、この関数はすべてのキー識別子を列挙します。 pKeyIdentifier が NULL でない場合、コールバック関数 pfnEnum は指定したキー識別子に対してのみ呼び出されます。
dwPropId	DWORD	in	列挙対象のプロパティ識別子を示します。 dwPropId がゼロに設定されている場合、この関数はすべてのプロパティを伴ってコールバック関数を呼び出します。 dwPropId がゼロ以外で、かつ pKeyIdentifier が NULL の場合、コールバック関数は指定したプロパティを持つキー識別子に対してのみ呼び出されます(pfnEnum の cProp パラメーターは 1 に設定されます)。そのプロパティを持たないキー識別子はすべてスキップされます。任意の証明書プロパティ識別子を使用できます。
dwFlags	DWORD	in	既定では、CurrentUser のキー識別子の一覧が検索されます。CRYPT_KEYID_MACHINE_FLAG が設定されている場合は、LocalMachine(pwszComputerName が NULL の場合)またはリモートコンピューター(pwszComputerName が NULL でない場合)のキー識別子の一覧が検索されます。詳細については pwszComputerName を参照してください。
pwszComputerName	LPCWSTR	inoptional	検索対象となるリモートコンピューターの名前へのポインターです。dwFlags に CRYPT_KEYID_MACHINE_FLAG が設定されている場合、リモートコンピューターからキー識別子の一覧が検索されます。リモートコンピューターではなくローカルコンピューターを検索する場合は、pwszComputerName を NULL に設定します。
pvReserved	void*	optional	将来の使用のために予約されており、NULL でなければなりません。
pvArg	void*	inoutoptional	コールバック関数に渡されるデータへのポインターです。型は void であり、アプリケーションが任意の情報を保持する構造体や引数を宣言、定義、初期化できるようにします。
pfnEnum	PFN_CRYPT_ENUM_KEYID_PROP	in	入力パラメーターに一致する各キー識別子エントリに対して実行される、アプリケーション定義のコールバック関数へのポインターです。コールバック関数のパラメーターの詳細については、CRYPT_ENUM_KEYID_PROP を参照してください。

戻り値の型: BOOL

公式ドキュメント

CryptEnumKeyIdentifierProperties 関数は、キー識別子とそのプロパティを列挙します。

戻り値

CryptEnumKeyIdentifierProperties 関数は、最後のキー識別子が列挙されるか、コールバック関数が FALSE を返すまで、CRYPT_ENUM_KEYID_PROP コールバック関数を繰り返し呼び出します。

メイン関数が成功した場合、この関数は 0 以外(TRUE)を返します。

関数が失敗した場合は 0(FALSE)を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

列挙を継続するには、関数は TRUE を返します。

列挙を停止するには、関数は FALSE を返し、最終エラーコードを設定します。

解説(Remarks)

キー識別子は、証明書コンテキストと同じプロパティを持つことができます。

例

この関数を使用する例については、 Example C Program: Working with Key Identifiers を参照してください。

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

各言語での呼び出し定義

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

BOOL CryptEnumKeyIdentifierProperties(
    const CRYPT_INTEGER_BLOB* pKeyIdentifier,   // optional
    DWORD dwPropId,
    DWORD dwFlags,
    LPCWSTR pwszComputerName,   // optional
    void* pvReserved,   // optional
    void* pvArg,   // optional
    PFN_CRYPT_ENUM_KEYID_PROP pfnEnum
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptEnumKeyIdentifierProperties(
    IntPtr pKeyIdentifier,   // CRYPT_INTEGER_BLOB* optional
    uint dwPropId,   // DWORD
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pwszComputerName,   // LPCWSTR optional
    IntPtr pvReserved,   // void* optional
    IntPtr pvArg,   // void* optional, in/out
    IntPtr pfnEnum   // PFN_CRYPT_ENUM_KEYID_PROP
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptEnumKeyIdentifierProperties(
    pKeyIdentifier As IntPtr,   ' CRYPT_INTEGER_BLOB* optional
    dwPropId As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pwszComputerName As String,   ' LPCWSTR optional
    pvReserved As IntPtr,   ' void* optional
    pvArg As IntPtr,   ' void* optional, in/out
    pfnEnum As IntPtr   ' PFN_CRYPT_ENUM_KEYID_PROP
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pKeyIdentifier : CRYPT_INTEGER_BLOB* optional
' dwPropId : DWORD
' dwFlags : DWORD
' pwszComputerName : LPCWSTR optional
' pvReserved : void* optional
' pvArg : void* optional, in/out
' pfnEnum : PFN_CRYPT_ENUM_KEYID_PROP
Declare PtrSafe Function CryptEnumKeyIdentifierProperties Lib "crypt32" ( _
    ByVal pKeyIdentifier As LongPtr, _
    ByVal dwPropId As Long, _
    ByVal dwFlags As Long, _
    ByVal pwszComputerName As LongPtr, _
    ByVal pvReserved As LongPtr, _
    ByVal pvArg As LongPtr, _
    ByVal pfnEnum As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptEnumKeyIdentifierProperties = ctypes.windll.crypt32.CryptEnumKeyIdentifierProperties
CryptEnumKeyIdentifierProperties.restype = wintypes.BOOL
CryptEnumKeyIdentifierProperties.argtypes = [
    ctypes.c_void_p,  # pKeyIdentifier : CRYPT_INTEGER_BLOB* optional
    wintypes.DWORD,  # dwPropId : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # pwszComputerName : LPCWSTR optional
    ctypes.POINTER(None),  # pvReserved : void* optional
    ctypes.POINTER(None),  # pvArg : void* optional, in/out
    ctypes.c_void_p,  # pfnEnum : PFN_CRYPT_ENUM_KEYID_PROP
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptEnumKeyIdentifierProperties = Fiddle::Function.new(
  lib['CryptEnumKeyIdentifierProperties'],
  [
    Fiddle::TYPE_VOIDP,  # pKeyIdentifier : CRYPT_INTEGER_BLOB* optional
    -Fiddle::TYPE_INT,  # dwPropId : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pwszComputerName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pvReserved : void* optional
    Fiddle::TYPE_VOIDP,  # pvArg : void* optional, in/out
    Fiddle::TYPE_VOIDP,  # pfnEnum : PFN_CRYPT_ENUM_KEYID_PROP
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptEnumKeyIdentifierProperties(
        pKeyIdentifier: *const CRYPT_INTEGER_BLOB,  // CRYPT_INTEGER_BLOB* optional
        dwPropId: u32,  // DWORD
        dwFlags: u32,  // DWORD
        pwszComputerName: *const u16,  // LPCWSTR optional
        pvReserved: *mut (),  // void* optional
        pvArg: *mut (),  // void* optional, in/out
        pfnEnum: *const core::ffi::c_void  // PFN_CRYPT_ENUM_KEYID_PROP
    ) -> 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 CryptEnumKeyIdentifierProperties(IntPtr pKeyIdentifier, uint dwPropId, uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string pwszComputerName, IntPtr pvReserved, IntPtr pvArg, IntPtr pfnEnum);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptEnumKeyIdentifierProperties' -Namespace Win32 -PassThru
# $api::CryptEnumKeyIdentifierProperties(pKeyIdentifier, dwPropId, dwFlags, pwszComputerName, pvReserved, pvArg, pfnEnum)

#uselib "CRYPT32.dll"
#func global CryptEnumKeyIdentifierProperties "CryptEnumKeyIdentifierProperties" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptEnumKeyIdentifierProperties varptr(pKeyIdentifier), dwPropId, dwFlags, pwszComputerName, pvReserved, pvArg, pfnEnum   ; 戻り値は stat
; pKeyIdentifier : CRYPT_INTEGER_BLOB* optional -> "sptr"
; dwPropId : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; pwszComputerName : LPCWSTR optional -> "sptr"
; pvReserved : void* optional -> "sptr"
; pvArg : void* optional, in/out -> "sptr"
; pfnEnum : PFN_CRYPT_ENUM_KEYID_PROP -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptEnumKeyIdentifierProperties "CryptEnumKeyIdentifierProperties" var, int, int, wstr, sptr, sptr, sptr
; res = CryptEnumKeyIdentifierProperties(pKeyIdentifier, dwPropId, dwFlags, pwszComputerName, pvReserved, pvArg, pfnEnum)
; pKeyIdentifier : CRYPT_INTEGER_BLOB* optional -> "var"
; dwPropId : DWORD -> "int"
; dwFlags : DWORD -> "int"
; pwszComputerName : LPCWSTR optional -> "wstr"
; pvReserved : void* optional -> "sptr"
; pvArg : void* optional, in/out -> "sptr"
; pfnEnum : PFN_CRYPT_ENUM_KEYID_PROP -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptEnumKeyIdentifierProperties "CryptEnumKeyIdentifierProperties" sptr, int, int, wstr, sptr, sptr, sptr
; res = CryptEnumKeyIdentifierProperties(varptr(pKeyIdentifier), dwPropId, dwFlags, pwszComputerName, pvReserved, pvArg, pfnEnum)
; pKeyIdentifier : CRYPT_INTEGER_BLOB* optional -> "sptr"
; dwPropId : DWORD -> "int"
; dwFlags : DWORD -> "int"
; pwszComputerName : LPCWSTR optional -> "wstr"
; pvReserved : void* optional -> "sptr"
; pvArg : void* optional, in/out -> "sptr"
; pfnEnum : PFN_CRYPT_ENUM_KEYID_PROP -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。