ホーム › Security.Cryptography › CryptImportPublicKeyInfoEx

CryptImportPublicKeyInfoEx

関数

鍵アルゴリズムを指定して公開鍵情報を拡張インポートする。

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

シグネチャ

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

BOOL CryptImportPublicKeyInfoEx(
    UINT_PTR hCryptProv,
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_PUBLIC_KEY_INFO* pInfo,
    ALG_ID aiKeyAlg,
    DWORD dwFlags,
    void* pvAuxInfo,   // optional
    UINT_PTR* phKey
);

パラメーター

名前	型	方向	説明
hCryptProv	UINT_PTR	in	インポートされる公開キーを受け取る CSP のハンドル。このハンドルは、あらかじめ CryptAcquireContext を使用して作成しておく必要があります。
dwCertEncodingType	CERT_QUERY_ENCODING_TYPE	in	使用するエンコードタイプを指定します。次の例に示すように、証明書とメッセージエンコードタイプの両方をビットごとの OR 演算で組み合わせて指定することは常に有効です。 X509_ASN_ENCODING \| PKCS_7_ASN_ENCODING 現在定義されているエンコードタイプは次のとおりです。 X509_ASN_ENCODING PKCS_7_ASN_ENCODING
pInfo	CERT_PUBLIC_KEY_INFO*	in	プロバイダーにインポートする公開キーを格納する CERT_PUBLIC_KEY_INFO 構造体のアドレス。メモ pInfo パラメーターが指す Algorithm メンバーの pzObjId メンバーと dwCertEncodingType パラメーターによって、インストール可能な CRYPT_OID_IMPORT_PUBLIC_KEY_INFO_FUNC コールバック関数が決定されます。インストール可能な関数が見つからない場合は、キーを RSA 公開キー (szOID_RSA_RSA) としてインポートしようとします。
aiKeyAlg	ALG_ID	in	既定のアルゴリズム CALG_RSA_KEYX をオーバーライドする CSP 固有のアルゴリズムを格納する ALG_ID 構造体。
dwFlags	DWORD	in	将来の使用のために予約されており、0 にする必要があります。
pvAuxInfo	void*	inoptional	将来の使用のために予約されており、NULL にする必要があります。
phKey	UINT_PTR*	out	インポートされた公開キーのハンドルを受け取る HCRYPTKEY 変数のアドレス。公開キーの使用が終わったら、CryptDestroyKey 関数を呼び出してハンドルを解放してください。

戻り値の型: BOOL

公式ドキュメント

重要この API は非推奨です。(CryptImportPublicKeyInfoEx)

戻り値

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

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

メモ呼び出される関数 CryptGetUserKey および CryptExportKey からのエラーが、この関数に伝播されることがあります。この関数には次のエラーコードがあります。

値	説明
ERROR_FILE_NOT_FOUND	指定された dwCertEncodingType および pInfo パラメーターに対して、インストールまたは登録できるインポート関数が見つかりませんでした。

関数が失敗した場合、GetLastError が Abstract Syntax Notation One (ASN.1) のエンコード/デコードエラーを返すことがあります。これらのエラーについては、 ASN.1 Encoding/Decoding Return Values を参照してください。

解説(Remarks)

この関数は通常、証明書から公開キーを取得するために使用します。これは、次の擬似コードに示すように、入力済みの証明書構造体から CERT_PUBLIC_KEY_INFO 構造体を渡すことで行います。

PCCERT_CONTEXT pCertContext

// 証明書から証明書コンテキスト構造体を取得します。
pCertContext = CertCreateCertificateContext(...)
if(pCertContext)
{
    HCRYPTKEY hCertPubKey

    // 証明書の公開キー情報を取得します。
    CryptImportPublicKeyInfo(
        hCryptProv, 
        X509_ASN_ENCODING, 
        &pCertContext->pCertInfo->SubjectPublicKeyInfo, 
        &hCertPubKey)

    CertFreeCertificateContext(pCertContext)
}

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

各言語での呼び出し定義

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

BOOL CryptImportPublicKeyInfoEx(
    UINT_PTR hCryptProv,
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_PUBLIC_KEY_INFO* pInfo,
    ALG_ID aiKeyAlg,
    DWORD dwFlags,
    void* pvAuxInfo,   // optional
    UINT_PTR* phKey
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptImportPublicKeyInfoEx(
    UIntPtr hCryptProv,   // UINT_PTR
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    IntPtr pInfo,   // CERT_PUBLIC_KEY_INFO*
    uint aiKeyAlg,   // ALG_ID
    uint dwFlags,   // DWORD
    IntPtr pvAuxInfo,   // void* optional
    out UIntPtr phKey   // UINT_PTR* out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptImportPublicKeyInfoEx(
    hCryptProv As UIntPtr,   ' UINT_PTR
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    pInfo As IntPtr,   ' CERT_PUBLIC_KEY_INFO*
    aiKeyAlg As UInteger,   ' ALG_ID
    dwFlags As UInteger,   ' DWORD
    pvAuxInfo As IntPtr,   ' void* optional
    <Out> ByRef phKey As UIntPtr   ' UINT_PTR* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptImportPublicKeyInfoEx = Fiddle::Function.new(
  lib['CryptImportPublicKeyInfoEx'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hCryptProv : UINT_PTR
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # pInfo : CERT_PUBLIC_KEY_INFO*
    -Fiddle::TYPE_INT,  # aiKeyAlg : ALG_ID
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pvAuxInfo : void* optional
    Fiddle::TYPE_VOIDP,  # phKey : UINT_PTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptImportPublicKeyInfoEx(
        hCryptProv: usize,  // UINT_PTR
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        pInfo: *mut CERT_PUBLIC_KEY_INFO,  // CERT_PUBLIC_KEY_INFO*
        aiKeyAlg: u32,  // ALG_ID
        dwFlags: u32,  // DWORD
        pvAuxInfo: *mut (),  // void* optional
        phKey: *mut usize  // UINT_PTR* 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 CryptImportPublicKeyInfoEx(UIntPtr hCryptProv, uint dwCertEncodingType, IntPtr pInfo, uint aiKeyAlg, uint dwFlags, IntPtr pvAuxInfo, out UIntPtr phKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptImportPublicKeyInfoEx' -Namespace Win32 -PassThru
# $api::CryptImportPublicKeyInfoEx(hCryptProv, dwCertEncodingType, pInfo, aiKeyAlg, dwFlags, pvAuxInfo, phKey)

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

出力引数:

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