ホーム › Security.Cryptography › PFXExportCertStore

PFXExportCertStore

関数

証明書ストアをパスワード保護したPFX BLOBにエクスポートする。

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

シグネチャ

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

BOOL PFXExportCertStore(
    HCERTSTORE hStore,
    CRYPT_INTEGER_BLOB* pPFX,
    LPCWSTR szPassword,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

hStore

HCERTSTORE

エクスポートする証明書を含む証明書ストアのハンドル。

pPFX

CRYPT_INTEGER_BLOB*

inout

エクスポートされた証明書とキーを格納する PFX パケットを保持する CRYPT_DATA_BLOB 構造体へのポインター。pPFX->pbData が NULL の場合、関数はエンコードされた BLOB に必要なバイト数を計算し、その値を pPFX->cbData に返します。pPFX->pbData が必要なサイズで確保されたバッファーを指している状態で関数を呼び出すと、関数はエンコードされたバイト列をそのバッファーにコピーし、pPFX->cbData をエンコードされたバイト長で更新します。

szPassword

LPCWSTR

PFX パケットの暗号化と検証に使用する文字列パスワード。パスワードの使用を終えたら、SecureZeroMemory 関数を呼び出してメモリからパスワードを消去してください。パスワードの保護に関する詳細については、Handling Passwords を参照してください。

dwFlags

DWORD

フラグ値には、次の値の任意の組み合わせを設定できます。

値	意味
EXPORT_PRIVATE_KEYS	証明書に加えて秘密キーもエクスポートされます。
REPORT_NO_PRIVATE_KEY	関連する秘密キーを持たない証明書が見つかった場合、関数は FALSE を返し、最終エラーを CRYPT_E_NOT_FOUND または NTE_NO_KEY のいずれかに設定します。
REPORT_NOT_ABLE_TO_EXPORT_PRIVATE_KEY	エクスポート不可能な秘密キーを持つ証明書が見つかった場合、関数は FALSE を返し、最終エラーを NTE_BAD_KEY、NTE_BAD_KEY_STATE、または NTE_PERM に設定します。

戻り値の型: BOOL

公式ドキュメント

参照される証明書ストアから証明書を、利用可能であれば関連する秘密キーも併せてエクスポートします。

戻り値

関数が成功した場合は TRUE (0 以外) を返し、失敗した場合は FALSE (0) を返します。拡張エラー情報を取得するには、 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 PFXExportCertStore(
    HCERTSTORE hStore,
    CRYPT_INTEGER_BLOB* pPFX,
    LPCWSTR szPassword,
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool PFXExportCertStore(
    IntPtr hStore,   // HCERTSTORE
    IntPtr pPFX,   // CRYPT_INTEGER_BLOB* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string szPassword,   // LPCWSTR
    uint dwFlags   // DWORD
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PFXExportCertStore(
    hStore As IntPtr,   ' HCERTSTORE
    pPFX As IntPtr,   ' CRYPT_INTEGER_BLOB* in/out
    <MarshalAs(UnmanagedType.LPWStr)> szPassword As String,   ' LPCWSTR
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hStore : HCERTSTORE
' pPFX : CRYPT_INTEGER_BLOB* in/out
' szPassword : LPCWSTR
' dwFlags : DWORD
Declare PtrSafe Function PFXExportCertStore Lib "crypt32" ( _
    ByVal hStore As LongPtr, _
    ByVal pPFX As LongPtr, _
    ByVal szPassword As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PFXExportCertStore = ctypes.windll.crypt32.PFXExportCertStore
PFXExportCertStore.restype = wintypes.BOOL
PFXExportCertStore.argtypes = [
    wintypes.HANDLE,  # hStore : HCERTSTORE
    ctypes.c_void_p,  # pPFX : CRYPT_INTEGER_BLOB* in/out
    wintypes.LPCWSTR,  # szPassword : LPCWSTR
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
PFXExportCertStore = Fiddle::Function.new(
  lib['PFXExportCertStore'],
  [
    Fiddle::TYPE_VOIDP,  # hStore : HCERTSTORE
    Fiddle::TYPE_VOIDP,  # pPFX : CRYPT_INTEGER_BLOB* in/out
    Fiddle::TYPE_VOIDP,  # szPassword : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn PFXExportCertStore(
        hStore: *mut core::ffi::c_void,  // HCERTSTORE
        pPFX: *mut CRYPT_INTEGER_BLOB,  // CRYPT_INTEGER_BLOB* in/out
        szPassword: *const u16,  // LPCWSTR
        dwFlags: u32  // DWORD
    ) -> 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 PFXExportCertStore(IntPtr hStore, IntPtr pPFX, [MarshalAs(UnmanagedType.LPWStr)] string szPassword, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_PFXExportCertStore' -Namespace Win32 -PassThru
# $api::PFXExportCertStore(hStore, pPFX, szPassword, dwFlags)

#uselib "CRYPT32.dll"
#func global PFXExportCertStore "PFXExportCertStore" sptr, sptr, sptr, sptr
; PFXExportCertStore hStore, varptr(pPFX), szPassword, dwFlags   ; 戻り値は stat
; hStore : HCERTSTORE -> "sptr"
; pPFX : CRYPT_INTEGER_BLOB* in/out -> "sptr"
; szPassword : LPCWSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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