ホーム › Security.Cryptography › CryptImportPublicKeyInfoEx2

CryptImportPublicKeyInfoEx2

関数

公開鍵情報をBCrypt鍵ハンドルとしてインポートする。

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

シグネチャ

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

BOOL CryptImportPublicKeyInfoEx2(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_PUBLIC_KEY_INFO* pInfo,
    CRYPT_IMPORT_PUBLIC_KEY_FLAGS dwFlags,
    void* pvAuxInfo,   // optional
    BCRYPT_KEY_HANDLE* phKey
);

パラメーター

名前

型

方向

説明

dwCertEncodingType

CERT_QUERY_ENCODING_TYPE

サブジェクトの暗号化に使用された証明書エンコード型です。この値の上位 WORD に含まれるメッセージエンコード型識別子は、この関数では無視されます。

このパラメーターには、現在定義されている次の証明書エンコード型を指定できます。

値	意味
X509_ASN_ENCODING 1 (0x1)	X.509 証明書エンコードを指定します。

pInfo

CERT_PUBLIC_KEY_INFO*

プロバイダーにインポートする公開鍵情報を格納した CERT_PUBLIC_KEY_INFO 構造体のアドレスです。

dwFlags

CRYPT_IMPORT_PUBLIC_KEY_FLAGS

この関数の動作を変更するフラグのセットです。ゼロ、または次の値の 1 つ以上の組み合わせを指定できます。

値	意味
CRYPT_OID_INFO_PUBKEY_SIGN_KEY_FLAG	CRYPT_PUBKEY_ALG_OID_GROUP_ID グループ内で、CRYPT_OID_PUBKEY_ENCRYPT_ONLY_FLAG フラグが明示的に設定されている公開鍵をスキップします。
CRYPT_OID_INFO_PUBKEY_ENCRYPT_KEY_FLAG	CRYPT_PUBKEY_ALG_OID_GROUP_ID グループ内で、CRYPT_OID_PUBKEY_SIGN_ONLY_FLAG フラグが明示的に設定されている公開鍵をスキップします。

これらのフラグは、公開鍵オブジェクト識別子を対応する CNG 公開鍵アルゴリズム識別子にマッピングする際に、CryptFindOIDInfo 関数の dwKeyType パラメーターに渡されます。

pvAuxInfo

void*

inoptional

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

phKey

BCRYPT_KEY_HANDLE*

out

インポートされた鍵のハンドルを受け取る BCRYPT_KEY_HANDLE 変数のアドレスです。

このハンドルが不要になったら、BCryptDestroyKey 関数を呼び出して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

公開鍵オブジェクト識別子 (OID) に対応する CNG 非対称プロバイダーに公開鍵をインポートし、その鍵に対する CNG ハンドルを返します。

戻り値

関数が成功すると、ゼロ以外の値 (TRUE) を返します。

関数が失敗すると、ゼロ (FALSE) を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。考えられるエラーコードには、次のものが含まれますが、これらに限定されません。

戻り値コード	説明
ERROR_FILE_NOT_FOUND	指定された dwCertEncodingType および pInfo パラメーターに対して、インストールまたは登録可能なインポート関数が見つかりませんでした。
E_INVALIDARG	1 つ以上のパラメーターが無効です。

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

各言語での呼び出し定義

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

BOOL CryptImportPublicKeyInfoEx2(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_PUBLIC_KEY_INFO* pInfo,
    CRYPT_IMPORT_PUBLIC_KEY_FLAGS dwFlags,
    void* pvAuxInfo,   // optional
    BCRYPT_KEY_HANDLE* phKey
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptImportPublicKeyInfoEx2(
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    IntPtr pInfo,   // CERT_PUBLIC_KEY_INFO*
    uint dwFlags,   // CRYPT_IMPORT_PUBLIC_KEY_FLAGS
    IntPtr pvAuxInfo,   // void* optional
    IntPtr phKey   // BCRYPT_KEY_HANDLE* out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptImportPublicKeyInfoEx2(
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    pInfo As IntPtr,   ' CERT_PUBLIC_KEY_INFO*
    dwFlags As UInteger,   ' CRYPT_IMPORT_PUBLIC_KEY_FLAGS
    pvAuxInfo As IntPtr,   ' void* optional
    phKey As IntPtr   ' BCRYPT_KEY_HANDLE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' pInfo : CERT_PUBLIC_KEY_INFO*
' dwFlags : CRYPT_IMPORT_PUBLIC_KEY_FLAGS
' pvAuxInfo : void* optional
' phKey : BCRYPT_KEY_HANDLE* out
Declare PtrSafe Function CryptImportPublicKeyInfoEx2 Lib "crypt32" ( _
    ByVal dwCertEncodingType As Long, _
    ByVal pInfo As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pvAuxInfo As LongPtr, _
    ByVal phKey As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptImportPublicKeyInfoEx2 = ctypes.windll.crypt32.CryptImportPublicKeyInfoEx2
CryptImportPublicKeyInfoEx2.restype = wintypes.BOOL
CryptImportPublicKeyInfoEx2.argtypes = [
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    ctypes.c_void_p,  # pInfo : CERT_PUBLIC_KEY_INFO*
    wintypes.DWORD,  # dwFlags : CRYPT_IMPORT_PUBLIC_KEY_FLAGS
    ctypes.POINTER(None),  # pvAuxInfo : void* optional
    ctypes.c_void_p,  # phKey : BCRYPT_KEY_HANDLE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptImportPublicKeyInfoEx2 = Fiddle::Function.new(
  lib['CryptImportPublicKeyInfoEx2'],
  [
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # pInfo : CERT_PUBLIC_KEY_INFO*
    -Fiddle::TYPE_INT,  # dwFlags : CRYPT_IMPORT_PUBLIC_KEY_FLAGS
    Fiddle::TYPE_VOIDP,  # pvAuxInfo : void* optional
    Fiddle::TYPE_VOIDP,  # phKey : BCRYPT_KEY_HANDLE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptImportPublicKeyInfoEx2(
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        pInfo: *mut CERT_PUBLIC_KEY_INFO,  // CERT_PUBLIC_KEY_INFO*
        dwFlags: u32,  // CRYPT_IMPORT_PUBLIC_KEY_FLAGS
        pvAuxInfo: *mut (),  // void* optional
        phKey: *mut *mut core::ffi::c_void  // BCRYPT_KEY_HANDLE* 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 CryptImportPublicKeyInfoEx2(uint dwCertEncodingType, IntPtr pInfo, uint dwFlags, IntPtr pvAuxInfo, IntPtr phKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptImportPublicKeyInfoEx2' -Namespace Win32 -PassThru
# $api::CryptImportPublicKeyInfoEx2(dwCertEncodingType, pInfo, dwFlags, pvAuxInfo, phKey)

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

出力引数:

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