ホーム › Security.Cryptography › CryptGetKeyIdentifierProperty

CryptGetKeyIdentifierProperty

関数

鍵識別子に関連付けられたプロパティを取得する。

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

シグネチャ

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

BOOL CryptGetKeyIdentifierProperty(
    const CRYPT_INTEGER_BLOB* pKeyIdentifier,
    DWORD dwPropId,
    DWORD dwFlags,
    LPCWSTR pwszComputerName,   // optional
    void* pvReserved,   // optional
    void* pvData,   // optional
    DWORD* pcbData
);

パラメーター

名前

型

方向

説明

pKeyIdentifier

CRYPT_INTEGER_BLOB*

キー識別子を格納している CRYPT_HASH_BLOB へのポインターです。

dwPropId

DWORD

取得するプロパティを指定します。dwPropId の値によって、pvData パラメーターの型と内容が決まります。任意の証明書プロパティ ID を使用できます。

dwFlags

DWORD

次のフラグを使用できます。これらはビットごとの OR 演算で組み合わせることができます。

値	意味
CRYPT_KEYID_MACHINE_FLAG	LocalMachine(pwszComputerName が NULL の場合)またはリモートコンピューター(pwszComputerName が NULL でない場合)のキー識別子の一覧を検索します。詳細については pwszComputerName を参照してください。
CRYPT_KEYID_ALLOC_FLAG	pvData 用のメモリを割り当てるために LocalAlloc() 関数が呼び出されます。*pvData は割り当てられたメモリへのポインターで更新されます。割り当てられたメモリを解放するには LocalFree() を呼び出す必要があります。

pwszComputerName

LPCWSTR

inoptional

検索対象のリモートコンピューター名へのポインターです。CRYPT_KEYID_MACHINE_FLAG フラグが設定されている場合、リモートコンピューターからキー識別子の一覧を検索します。リモートコンピューターではなくローカルコンピューターを検索する場合は、pwszComputerName を NULL に設定します。

pvReserved

void*

optional

将来の使用のために予約されており、NULL である必要があります。

pvData

void*

outoptional

dwPropId によって決定されるデータを受け取るバッファーへのポインターです。pvData 構造体内のフィールドが指す要素は、構造体の後に続きます。そのため、pcbData に格納されるサイズが構造体のサイズを超える場合があります。

dwPropId が CERT_KEY_PROV_INFO_PROP_ID の場合、pvData はキー識別子のプロパティを格納する CRYPT_KEY_PROV_INFO 構造体を指します。

dwPropId が CERT_KEY_PROV_INFO_PROP_ID でない場合、pvData はキー識別子のプロパティを格納するバイト配列を指します。

メモリ割り当てのためにこの情報のサイズを取得するには、CRYPT_KEYID_ALLOC_FLAG が設定されていない場合、このパラメーターを NULL にできます。詳細については Retrieving Data of Unknown Length を参照してください。

CRYPT_KEYID_ALLOC_FLAG が設定されている場合、pvData は更新されるバッファーへのポインターのアドレスです。メモリが割り当てられ、そのポインターが *pvData に格納されるため、pvData を NULL にすることはできません。

pcbData

DWORD*

inout

pvData パラメーターが指すバッファーのサイズ(バイト単位)を格納する DWORD へのポインターです。関数が戻るとき、この DWORD にはバッファーに格納されたバイト数が格納されます。構造体は補助データへのポインターを含むことができるため、pcbData が指す変数に格納されるサイズは CRYPT_KEY_PROV_INFO 構造体より大きいサイズを示す場合があります。このサイズは、構造体が必要とするサイズとすべての補助データの合計です。

CRYPT_KEYID_ALLOC_FLAG が設定されている場合、pcbData は更新される DWORD へのポインターのアドレスです。

注意バッファーに返されたデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなる場合があります。入力時には、可能な限り最大の出力データがバッファーに収まるように、通常はバッファーサイズを十分大きく指定します。出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

戻り値の型: BOOL

公式ドキュメント

CryptGetKeyIdentifierProperty は、指定されたキー識別子から特定のプロパティを取得します。

戻り値

関数が成功した場合、ゼロ以外(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 CryptGetKeyIdentifierProperty(
    const CRYPT_INTEGER_BLOB* pKeyIdentifier,
    DWORD dwPropId,
    DWORD dwFlags,
    LPCWSTR pwszComputerName,   // optional
    void* pvReserved,   // optional
    void* pvData,   // optional
    DWORD* pcbData
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptGetKeyIdentifierProperty = Fiddle::Function.new(
  lib['CryptGetKeyIdentifierProperty'],
  [
    Fiddle::TYPE_VOIDP,  # pKeyIdentifier : CRYPT_INTEGER_BLOB*
    -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,  # pvData : void* optional, out
    Fiddle::TYPE_VOIDP,  # pcbData : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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