ホーム › Security.Cryptography › PFXExportCertStoreEx

PFXExportCertStoreEx

関数

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

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

シグネチャ

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

BOOL PFXExportCertStoreEx(
    HCERTSTORE hStore,
    CRYPT_INTEGER_BLOB* pPFX,
    LPCWSTR szPassword,
    void* pvPara,
    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 を参照してください。

pvPara

void*

dwFlags パラメーターに PKCS12_PROTECT_TO_DOMAIN_SIDS または PKCS12_EXPORT_PBES2_PARAMS が含まれていない場合、このパラメーターは NULL でなければなりません。したがって、Windows 8 および Windows Server 2012 より前では、このパラメーターは NULL でなければなりません。

Windows 8 および Windows Server 2012 以降では、dwFlags パラメーターに PKCS12_PROTECT_TO_DOMAIN_SIDS が含まれている場合、pvPara パラメーターに NCRYPT_DESCRIPTOR_HANDLE 値を指すように設定して、PFX BLOB 内で PFX パスワードをどの Active Directory プリンシパルに対して保護するかを指定できます。現在のところ、パスワードは Active Directory のユーザー、コンピューター、またはグループに対して保護できます。保護記述子の詳細については、NCryptCreateProtectionDescriptor を参照してください。

Windows 10 1709 (Fall Creators Update) および Windows Server 2019 以降では、dwFlags パラメーターに PKCS12_EXPORT_PBES2_PARAMS が含まれている場合、使用するパスワードベースの暗号化アルゴリズムを選択するために、pvPara に PKCS12_EXPORT_PBES2_PARAMS 値を設定する必要があります。

dwFlags

DWORD

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

値	意味
EXPORT_PRIVATE_KEYS 0x0004	証明書に加えて秘密キーもエクスポートされます。
REPORT_NO_PRIVATE_KEY 0x0001	関連付けられた秘密キーを持たない証明書が見つかった場合、関数は FALSE を返し、最後のエラーは CRYPT_E_NOT_FOUND または NTE_NO_KEY のいずれかに設定されます。
REPORT_NOT_ABLE_TO_EXPORT_PRIVATE_KEY 0x0002	エクスポート不可能な秘密キーを持つ証明書が見つかった場合、関数は FALSE を返し、最後のエラーは NTE_BAD_KEY、NTE_BAD_KEY_STATE、または NTE_PERM に設定されます。
PKCS12_INCLUDE_EXTENDED_PROPERTIES 0x0010	証明書上のすべての拡張プロパティをエクスポートします。 Windows Server 2003 および Windows XP: この値はサポートされていません。
PKCS12_PROTECT_TO_DOMAIN_SIDS 0x0020	PFX BLOB には、pvPara パラメーターが指す Active Directory (AD) 保護記述子に対して保護される、埋め込みパスワードが含まれます。szPassword パラメーターが NULL でも空でもない場合、指定されたパスワードが保護されます。ただし、szPassword パラメーターが NULL または空文字列の場合は、ランダムな 40 文字のパスワードが作成されて保護されます。 PFXImportCertStore は、指定された保護記述子を使用して、ユーザー指定またはランダム生成のいずれであっても埋め込みパスワードを復号し、そのパスワードを使用して PFX BLOB を復号します。 Windows 8 および Windows Server 2012: このフラグのサポートが開始されます。
PKCS12_EXPORT_PBES2_PARAMS 0x0080	pvPara として渡された PKCS12_EXPORT_PBES2_PARAMS 値で指定されたパスワードベースの暗号化アルゴリズムを使用してエクスポートします。 Windows 10 1709 (Fall Creators Update) および Windows Server 2019: このフラグのサポートが開始されます。

戻り値の型: BOOL

公式ドキュメント

参照された証明書ストアから、証明書と、利用可能であればそれに関連付けられた秘密キーをエクスポートします。

戻り値

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

解説(Remarks)

Windows 8 および Windows Server 2012 以降では、PFX パスワードを Active Directory のユーザー、コンピューター、またはグループに対して保護できます。これを選択したがパスワードを作成しない場合は、一時的なパスワードがランダムに選択されます。パスワードは Active Directory プリンシパルを使用して暗号化され、PFX BLOB に埋め込まれます。詳細については、pvPara パラメーターおよび PKCS12_PROTECT_TO_DOMAIN_SIDS フラグを参照してください。

Windows 10 1709 (Fall Creators Update) および Windows Server 2019 以降では、次のレジストリキーを使用して、PFXExportCertStoreEx 関数がパスワードに対してハッシュ関数を反復する回数を制御できます。このキーの値は REG_DWORD 型です。

HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\PFX\PasswordIterationCount

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

各言語での呼び出し定義

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

BOOL PFXExportCertStoreEx(
    HCERTSTORE hStore,
    CRYPT_INTEGER_BLOB* pPFX,
    LPCWSTR szPassword,
    void* pvPara,
    DWORD dwFlags
);

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

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

' hStore : HCERTSTORE
' pPFX : CRYPT_INTEGER_BLOB* in/out
' szPassword : LPCWSTR
' pvPara : void*
' dwFlags : DWORD
Declare PtrSafe Function PFXExportCertStoreEx Lib "crypt32" ( _
    ByVal hStore As LongPtr, _
    ByVal pPFX As LongPtr, _
    ByVal szPassword As LongPtr, _
    ByVal pvPara 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

PFXExportCertStoreEx = ctypes.windll.crypt32.PFXExportCertStoreEx
PFXExportCertStoreEx.restype = wintypes.BOOL
PFXExportCertStoreEx.argtypes = [
    wintypes.HANDLE,  # hStore : HCERTSTORE
    ctypes.c_void_p,  # pPFX : CRYPT_INTEGER_BLOB* in/out
    wintypes.LPCWSTR,  # szPassword : LPCWSTR
    ctypes.POINTER(None),  # pvPara : void*
    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')
PFXExportCertStoreEx = Fiddle::Function.new(
  lib['PFXExportCertStoreEx'],
  [
    Fiddle::TYPE_VOIDP,  # hStore : HCERTSTORE
    Fiddle::TYPE_VOIDP,  # pPFX : CRYPT_INTEGER_BLOB* in/out
    Fiddle::TYPE_VOIDP,  # szPassword : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pvPara : void*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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