ホーム › Security.Cryptography › CryptExportPublicKeyInfoFromBCryptKeyHandle

CryptExportPublicKeyInfoFromBCryptKeyHandle

関数

BCrypt鍵ハンドルから公開鍵情報をエクスポートする。

DLLCRYPT32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

BOOL CryptExportPublicKeyInfoFromBCryptKeyHandle(
    BCRYPT_KEY_HANDLE hBCryptKey,
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    LPSTR pszPublicKeyObjId,   // optional
    DWORD dwFlags,
    void* pvAuxInfo,   // optional
    CERT_PUBLIC_KEY_INFO* pInfo,   // optional
    DWORD* pcbInfo
);

パラメーター

名前

型

方向

説明

hBCryptKey

BCRYPT_KEY_HANDLE

公開鍵情報をエクスポートする元となる鍵のハンドルです。

dwCertEncodingType

CERT_QUERY_ENCODING_TYPE

一致させるエンコーディングの種類を指定します。

この値には、現在定義されている以下のエンコーディングの種類のビットごとの組み合わせを指定できます。

pszPublicKeyObjId

LPSTR

inoptional

鍵のエクスポートに使用するインストール可能な関数を識別するオブジェクト識別子 (OID) へのポインターです。OID の上位ワードが 0 以外の場合、pszPublicKeyObjId は「2.5.29.1」のような OID 文字列、または「file.」のような ASCII 文字列のいずれかへのポインターになります。OID の上位ワードが 0 の場合は、下位ワードがオブジェクト識別子として使用される整数識別子を指定します。

dwFlags

DWORD

公開鍵情報をどのようにエクスポートするかを示す DWORD 値です。

Value	Meaning
CRYPT_OID_INFO_PUBKEY_SIGN_KEY_FLAG 0x80000000	CRYPT_PUBKEY_ALG_OID_GROUP_ID グループ内で、CRYPT_OID_PUBKEY_ENCRYPT_ONLY_FLAG フラグが明示的に設定された公開鍵をスキップします。
CRYPT_OID_INFO_PUBKEY_ENCRYPT_KEY_FLAG 0x40000000	CRYPT_PUBKEY_ALG_OID_GROUP_ID グループ内で、CRYPT_OID_PUBKEY_SIGN_ONLY_FLAG フラグが明示的に設定された公開鍵をスキップします。

pvAuxInfo

void*

inoptional

このパラメーターは将来の使用のために予約されており、NULL を設定する必要があります。

pInfo

CERT_PUBLIC_KEY_INFO*

outoptional

エクスポートする公開鍵情報を受け取る CERT_PUBLIC_KEY_INFO 構造体へのポインターです。

このパラメーターには NULL を指定でき、メモリ割り当てのためにこの情報のサイズを設定する目的で使用できます。詳細については、 Retrieving Data of Unknown Length を参照してください。

pcbInfo

DWORD*

inout

pInfo パラメーターが指すバッファーのサイズをバイト単位で格納する DWORD へのポインターです。関数が返ると、この DWORD にはバッファーに格納されたバイト数が格納されます。

戻り値の型: BOOL

公式ドキュメント

プロバイダーの対応する秘密鍵に関連付けられた公開鍵情報をエクスポートします。

戻り値

関数が成功した場合は TRUE を返し、それ以外の場合は FALSE を返します。

解説(Remarks)

CryptExportPublicKeyInfoFromBCryptKeyHandle 関数が、pszPublicKeyObjId パラメーターで指定された OID に対応するインストール可能な OID 関数を見つけられない場合、その鍵を RSA 公開鍵 (szOID_RSA_RSA) としてエクスポートしようとします。鍵が RSA 公開鍵としてエクスポートされる場合、dwFlags および pvAuxInfo パラメーターの値は使用されません。

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

各言語での呼び出し定義

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

BOOL CryptExportPublicKeyInfoFromBCryptKeyHandle(
    BCRYPT_KEY_HANDLE hBCryptKey,
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    LPSTR pszPublicKeyObjId,   // optional
    DWORD dwFlags,
    void* pvAuxInfo,   // optional
    CERT_PUBLIC_KEY_INFO* pInfo,   // optional
    DWORD* pcbInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", ExactSpelling = true)]
static extern bool CryptExportPublicKeyInfoFromBCryptKeyHandle(
    IntPtr hBCryptKey,   // BCRYPT_KEY_HANDLE
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    [MarshalAs(UnmanagedType.LPStr)] string pszPublicKeyObjId,   // LPSTR optional
    uint dwFlags,   // DWORD
    IntPtr pvAuxInfo,   // void* optional
    IntPtr pInfo,   // CERT_PUBLIC_KEY_INFO* optional, out
    ref uint pcbInfo   // DWORD* in/out
);

<DllImport("CRYPT32.dll", ExactSpelling:=True)>
Public Shared Function CryptExportPublicKeyInfoFromBCryptKeyHandle(
    hBCryptKey As IntPtr,   ' BCRYPT_KEY_HANDLE
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    <MarshalAs(UnmanagedType.LPStr)> pszPublicKeyObjId As String,   ' LPSTR optional
    dwFlags As UInteger,   ' DWORD
    pvAuxInfo As IntPtr,   ' void* optional
    pInfo As IntPtr,   ' CERT_PUBLIC_KEY_INFO* optional, out
    ByRef pcbInfo As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hBCryptKey : BCRYPT_KEY_HANDLE
' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' pszPublicKeyObjId : LPSTR optional
' dwFlags : DWORD
' pvAuxInfo : void* optional
' pInfo : CERT_PUBLIC_KEY_INFO* optional, out
' pcbInfo : DWORD* in/out
Declare PtrSafe Function CryptExportPublicKeyInfoFromBCryptKeyHandle Lib "crypt32" ( _
    ByVal hBCryptKey As LongPtr, _
    ByVal dwCertEncodingType As Long, _
    ByVal pszPublicKeyObjId As String, _
    ByVal dwFlags As Long, _
    ByVal pvAuxInfo As LongPtr, _
    ByVal pInfo As LongPtr, _
    ByRef pcbInfo As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptExportPublicKeyInfoFromBCryptKeyHandle = ctypes.windll.crypt32.CryptExportPublicKeyInfoFromBCryptKeyHandle
CryptExportPublicKeyInfoFromBCryptKeyHandle.restype = wintypes.BOOL
CryptExportPublicKeyInfoFromBCryptKeyHandle.argtypes = [
    wintypes.HANDLE,  # hBCryptKey : BCRYPT_KEY_HANDLE
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    wintypes.LPCSTR,  # pszPublicKeyObjId : LPSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(None),  # pvAuxInfo : void* optional
    ctypes.c_void_p,  # pInfo : CERT_PUBLIC_KEY_INFO* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbInfo : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptExportPublicKeyInfoFromBCryptKeyHandle = Fiddle::Function.new(
  lib['CryptExportPublicKeyInfoFromBCryptKeyHandle'],
  [
    Fiddle::TYPE_VOIDP,  # hBCryptKey : BCRYPT_KEY_HANDLE
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # pszPublicKeyObjId : LPSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pvAuxInfo : void* optional
    Fiddle::TYPE_VOIDP,  # pInfo : CERT_PUBLIC_KEY_INFO* optional, out
    Fiddle::TYPE_VOIDP,  # pcbInfo : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptExportPublicKeyInfoFromBCryptKeyHandle(
        hBCryptKey: *mut core::ffi::c_void,  // BCRYPT_KEY_HANDLE
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        pszPublicKeyObjId: *mut u8,  // LPSTR optional
        dwFlags: u32,  // DWORD
        pvAuxInfo: *mut (),  // void* optional
        pInfo: *mut CERT_PUBLIC_KEY_INFO,  // CERT_PUBLIC_KEY_INFO* optional, out
        pcbInfo: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll")]
public static extern bool CryptExportPublicKeyInfoFromBCryptKeyHandle(IntPtr hBCryptKey, uint dwCertEncodingType, [MarshalAs(UnmanagedType.LPStr)] string pszPublicKeyObjId, uint dwFlags, IntPtr pvAuxInfo, IntPtr pInfo, ref uint pcbInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptExportPublicKeyInfoFromBCryptKeyHandle' -Namespace Win32 -PassThru
# $api::CryptExportPublicKeyInfoFromBCryptKeyHandle(hBCryptKey, dwCertEncodingType, pszPublicKeyObjId, dwFlags, pvAuxInfo, pInfo, pcbInfo)

#uselib "CRYPT32.dll"
#func global CryptExportPublicKeyInfoFromBCryptKeyHandle "CryptExportPublicKeyInfoFromBCryptKeyHandle" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptExportPublicKeyInfoFromBCryptKeyHandle hBCryptKey, dwCertEncodingType, pszPublicKeyObjId, dwFlags, pvAuxInfo, varptr(pInfo), varptr(pcbInfo)   ; 戻り値は stat
; hBCryptKey : BCRYPT_KEY_HANDLE -> "sptr"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "sptr"
; pszPublicKeyObjId : LPSTR optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; pvAuxInfo : void* optional -> "sptr"
; pInfo : CERT_PUBLIC_KEY_INFO* optional, out -> "sptr"
; pcbInfo : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptExportPublicKeyInfoFromBCryptKeyHandle "CryptExportPublicKeyInfoFromBCryptKeyHandle" sptr, int, str, int, sptr, var, var
; res = CryptExportPublicKeyInfoFromBCryptKeyHandle(hBCryptKey, dwCertEncodingType, pszPublicKeyObjId, dwFlags, pvAuxInfo, pInfo, pcbInfo)
; hBCryptKey : BCRYPT_KEY_HANDLE -> "sptr"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "int"
; pszPublicKeyObjId : LPSTR optional -> "str"
; dwFlags : DWORD -> "int"
; pvAuxInfo : void* optional -> "sptr"
; pInfo : CERT_PUBLIC_KEY_INFO* optional, out -> "var"
; pcbInfo : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptExportPublicKeyInfoFromBCryptKeyHandle "CryptExportPublicKeyInfoFromBCryptKeyHandle" sptr, int, str, int, sptr, sptr, sptr
; res = CryptExportPublicKeyInfoFromBCryptKeyHandle(hBCryptKey, dwCertEncodingType, pszPublicKeyObjId, dwFlags, pvAuxInfo, varptr(pInfo), varptr(pcbInfo))
; hBCryptKey : BCRYPT_KEY_HANDLE -> "sptr"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "int"
; pszPublicKeyObjId : LPSTR optional -> "str"
; dwFlags : DWORD -> "int"
; pvAuxInfo : void* optional -> "sptr"
; pInfo : CERT_PUBLIC_KEY_INFO* optional, out -> "sptr"
; pcbInfo : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。