ホーム › Security.Cryptography › CryptExportPublicKeyInfo

CryptExportPublicKeyInfo

関数

暗号プロバイダの鍵から公開鍵情報をエクスポートする。

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

シグネチャ

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

BOOL CryptExportPublicKeyInfo(
    HCRYPTPROV_OR_NCRYPT_KEY_HANDLE hCryptProvOrNCryptKey,
    DWORD dwKeySpec,   // optional
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_PUBLIC_KEY_INFO* pInfo,   // optional
    DWORD* pcbInfo
);

パラメーター

名前	型	方向	説明
hCryptProvOrNCryptKey	HCRYPTPROV_OR_NCRYPT_KEY_HANDLE	in	公開キー情報をエクスポートする際に使用する暗号化サービスプロバイダー (CSP) のハンドル。このハンドルは、CryptAcquireContext 関数を使用して作成された HCRYPTPROV ハンドル、または NCryptOpenKey 関数を使用して作成された NCRYPT_KEY_HANDLE ハンドルである必要があります。新しいアプリケーションでは、常に CNG CSP の NCRYPT_KEY_HANDLE ハンドルを渡してください。
dwKeySpec	DWORD	inoptional	プロバイダーのコンテナーから使用する秘密キーを指定します。AT_KEYEXCHANGE または AT_SIGNATURE を指定できます。hCryptProvOrNCryptKey パラメーターに NCRYPT_KEY_HANDLE が使用されている場合、このパラメーターは無視されます。
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*	outoptional	エクスポートする公開キー情報を受け取る CERT_PUBLIC_KEY_INFO 構造体へのポインター。メモリ割り当てのためにこの情報のサイズを設定するには、このパラメーターを NULL にできます。詳細については、不明な長さのデータの取得を参照してください。
pcbInfo	DWORD*	inout	pInfo パラメーターが指すバッファーのサイズ (バイト単位) を格納する DWORD へのポインター。関数が戻ると、この DWORD には戻りバッファーに必要なバイト数が格納されます。注意バッファーに返されたデータを処理する際、アプリケーションは実際に返されたデータのサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなることがあります。(入力時には、想定される最大の出力データがバッファーに収まるように、通常は十分な大きさのバッファーサイズが指定されます。) 出力時には、このパラメーターが指す変数は、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

戻り値の型: BOOL

公式ドキュメント

CryptExportPublicKeyInfo 関数は、プロバイダーの対応する秘密キーに関連付けられた公開キー情報をエクスポートします。この関数の更新版については、CryptExportPublicKeyInfoEx を参照してください。

戻り値

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

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

注意呼び出された関数 CryptGetUserKey および CryptExportKey からのエラーが、この関数に伝播される場合があります。

この関数には次のエラーコードがあります。

戻り値	説明
ERROR_MORE_DATA	pInfo パラメーターで指定されたバッファーが返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbInfo が指す変数に格納します。
ERROR_FILE_NOT_FOUND	証明書のエンコードの種類が無効です。現在サポートされているのは X509_ASN_ENCODING のみです。

関数が失敗した場合、GetLastError は Abstract Syntax Notation One (ASN.1) のエンコード/デコードエラーを返すことがあります。これらのエラーの詳細については、 ASN.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 CryptExportPublicKeyInfo(
    HCRYPTPROV_OR_NCRYPT_KEY_HANDLE hCryptProvOrNCryptKey,
    DWORD dwKeySpec,   // optional
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_PUBLIC_KEY_INFO* pInfo,   // optional
    DWORD* pcbInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptExportPublicKeyInfo(
    UIntPtr hCryptProvOrNCryptKey,   // HCRYPTPROV_OR_NCRYPT_KEY_HANDLE
    uint dwKeySpec,   // DWORD optional
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    IntPtr pInfo,   // CERT_PUBLIC_KEY_INFO* optional, out
    ref uint pcbInfo   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptExportPublicKeyInfo(
    hCryptProvOrNCryptKey As UIntPtr,   ' HCRYPTPROV_OR_NCRYPT_KEY_HANDLE
    dwKeySpec As UInteger,   ' DWORD optional
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    pInfo As IntPtr,   ' CERT_PUBLIC_KEY_INFO* optional, out
    ByRef pcbInfo As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hCryptProvOrNCryptKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE
' dwKeySpec : DWORD optional
' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' pInfo : CERT_PUBLIC_KEY_INFO* optional, out
' pcbInfo : DWORD* in/out
Declare PtrSafe Function CryptExportPublicKeyInfo Lib "crypt32" ( _
    ByVal hCryptProvOrNCryptKey As LongPtr, _
    ByVal dwKeySpec As Long, _
    ByVal dwCertEncodingType As Long, _
    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

CryptExportPublicKeyInfo = ctypes.windll.crypt32.CryptExportPublicKeyInfo
CryptExportPublicKeyInfo.restype = wintypes.BOOL
CryptExportPublicKeyInfo.argtypes = [
    ctypes.c_size_t,  # hCryptProvOrNCryptKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE
    wintypes.DWORD,  # dwKeySpec : DWORD optional
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    ctypes.c_void_p,  # pInfo : CERT_PUBLIC_KEY_INFO* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbInfo : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptExportPublicKeyInfo = Fiddle::Function.new(
  lib['CryptExportPublicKeyInfo'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hCryptProvOrNCryptKey : HCRYPTPROV_OR_NCRYPT_KEY_HANDLE
    -Fiddle::TYPE_INT,  # dwKeySpec : DWORD optional
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    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 CryptExportPublicKeyInfo(
        hCryptProvOrNCryptKey: usize,  // HCRYPTPROV_OR_NCRYPT_KEY_HANDLE
        dwKeySpec: u32,  // DWORD optional
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        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", SetLastError = true)]
public static extern bool CryptExportPublicKeyInfo(UIntPtr hCryptProvOrNCryptKey, uint dwKeySpec, uint dwCertEncodingType, IntPtr pInfo, ref uint pcbInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptExportPublicKeyInfo' -Namespace Win32 -PassThru
# $api::CryptExportPublicKeyInfo(hCryptProvOrNCryptKey, dwKeySpec, dwCertEncodingType, pInfo, pcbInfo)

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

出力引数:

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