ホーム › Security.Cryptography › CryptExportPKCS8

CryptExportPKCS8

関数

秘密鍵をPKCS#8形式のBLOBとしてエクスポートする。

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

シグネチャ

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

BOOL CryptExportPKCS8(
    UINT_PTR hCryptProv,
    DWORD dwKeySpec,
    LPSTR pszPrivateKeyObjId,
    DWORD dwFlags,
    void* pvAuxInfo,   // optional
    BYTE* pbPrivateKeyBlob,   // optional
    DWORD* pcbPrivateKeyBlob
);

パラメーター

名前

型

方向

説明

hCryptProv

UINT_PTR

HCRYPTPROV 変数で、cryptographic service provider (CSP) を格納します。これは CryptAcquireContext を呼び出して取得した CSP のハンドルです。

dwKeySpec

DWORD

鍵の指定を格納する DWORD 変数です。既定のプロバイダーでは、次の dwKeySpec 値が定義されています。

値	意味
AT_KEYEXCHANGE	セッション鍵の暗号化/復号に使用される鍵です。
AT_SIGNATURE	デジタル署名の作成と検証に使用される鍵です。

pszPrivateKeyObjId

LPSTR

秘密鍵のオブジェクト識別子 (OID) を格納する LPSTR 変数です。

dwFlags

DWORD

このパラメーターは、pbPrivateKeyBlob が NULL の場合は 0 を、それ以外の場合は 0x8000 を指定します。

pvAuxInfo

void*

inoptional

このパラメーターは NULL に設定する必要があります。

pbPrivateKeyBlob

BYTE*

outoptional

エクスポートする秘密鍵を受け取る BYTE 構造体の配列へのポインターです。

秘密鍵には、PKCS #8 標準で定義されている PKCS #8 PrivateKeyInfo Abstract Syntax Notation One (ASN.1) 型の情報が格納されます。

メモリ割り当てのために、このパラメーターを NULL に設定することで、エクスポートする秘密鍵のサイズを取得できます。詳細については、 Retrieving Data of Unknown Length を参照してください。

pcbPrivateKeyBlob

DWORD*

inout

DWORD へのポインターです。入力時には、pbPrivateKeyBlob を格納するために必要なメモリ割り当てのサイズ (バイト単位) を格納できます。pbPrivateKeyBlob が NULL の場合、このパラメーターには関数を 2 回目に呼び出すために必要なメモリ割り当てのサイズが返されます。詳細については、 Retrieving Data of Unknown Length を参照してください。

戻り値の型: BOOL

公式ドキュメント

秘密鍵を PKCS 形式でエクスポートします (CryptExportPKCS8)

戻り値

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

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

この関数に固有のエラーコードは次のとおりです。

戻り値	説明
ERROR_UNSUPPORTED_TYPE	インストールまたは登録できるエクスポート関数が見つかりませんでした。
ERROR_MORE_DATA	pbPrivateKeyBlob パラメーターで指定されたバッファーが返されるデータを格納するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbPrivateKeyBlob パラメーターが指す変数に格納します。

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

解説(Remarks)

この関数は非対称鍵に対してのみサポートされています。

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

各言語での呼び出し定義

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

BOOL CryptExportPKCS8(
    UINT_PTR hCryptProv,
    DWORD dwKeySpec,
    LPSTR pszPrivateKeyObjId,
    DWORD dwFlags,
    void* pvAuxInfo,   // optional
    BYTE* pbPrivateKeyBlob,   // optional
    DWORD* pcbPrivateKeyBlob
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptExportPKCS8(
    UIntPtr hCryptProv,   // UINT_PTR
    uint dwKeySpec,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string pszPrivateKeyObjId,   // LPSTR
    uint dwFlags,   // DWORD
    IntPtr pvAuxInfo,   // void* optional
    IntPtr pbPrivateKeyBlob,   // BYTE* optional, out
    ref uint pcbPrivateKeyBlob   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptExportPKCS8(
    hCryptProv As UIntPtr,   ' UINT_PTR
    dwKeySpec As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pszPrivateKeyObjId As String,   ' LPSTR
    dwFlags As UInteger,   ' DWORD
    pvAuxInfo As IntPtr,   ' void* optional
    pbPrivateKeyBlob As IntPtr,   ' BYTE* optional, out
    ByRef pcbPrivateKeyBlob As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hCryptProv : UINT_PTR
' dwKeySpec : DWORD
' pszPrivateKeyObjId : LPSTR
' dwFlags : DWORD
' pvAuxInfo : void* optional
' pbPrivateKeyBlob : BYTE* optional, out
' pcbPrivateKeyBlob : DWORD* in/out
Declare PtrSafe Function CryptExportPKCS8 Lib "crypt32" ( _
    ByVal hCryptProv As LongPtr, _
    ByVal dwKeySpec As Long, _
    ByVal pszPrivateKeyObjId As String, _
    ByVal dwFlags As Long, _
    ByVal pvAuxInfo As LongPtr, _
    ByVal pbPrivateKeyBlob As LongPtr, _
    ByRef pcbPrivateKeyBlob As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptExportPKCS8 = ctypes.windll.crypt32.CryptExportPKCS8
CryptExportPKCS8.restype = wintypes.BOOL
CryptExportPKCS8.argtypes = [
    ctypes.c_size_t,  # hCryptProv : UINT_PTR
    wintypes.DWORD,  # dwKeySpec : DWORD
    wintypes.LPCSTR,  # pszPrivateKeyObjId : LPSTR
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(None),  # pvAuxInfo : void* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbPrivateKeyBlob : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbPrivateKeyBlob : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptExportPKCS8 = Fiddle::Function.new(
  lib['CryptExportPKCS8'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hCryptProv : UINT_PTR
    -Fiddle::TYPE_INT,  # dwKeySpec : DWORD
    Fiddle::TYPE_VOIDP,  # pszPrivateKeyObjId : LPSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pvAuxInfo : void* optional
    Fiddle::TYPE_VOIDP,  # pbPrivateKeyBlob : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbPrivateKeyBlob : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptExportPKCS8(
        hCryptProv: usize,  // UINT_PTR
        dwKeySpec: u32,  // DWORD
        pszPrivateKeyObjId: *mut u8,  // LPSTR
        dwFlags: u32,  // DWORD
        pvAuxInfo: *mut (),  // void* optional
        pbPrivateKeyBlob: *mut u8,  // BYTE* optional, out
        pcbPrivateKeyBlob: *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 CryptExportPKCS8(UIntPtr hCryptProv, uint dwKeySpec, [MarshalAs(UnmanagedType.LPStr)] string pszPrivateKeyObjId, uint dwFlags, IntPtr pvAuxInfo, IntPtr pbPrivateKeyBlob, ref uint pcbPrivateKeyBlob);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptExportPKCS8' -Namespace Win32 -PassThru
# $api::CryptExportPKCS8(hCryptProv, dwKeySpec, pszPrivateKeyObjId, dwFlags, pvAuxInfo, pbPrivateKeyBlob, pcbPrivateKeyBlob)

#uselib "CRYPT32.dll"
#func global CryptExportPKCS8 "CryptExportPKCS8" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptExportPKCS8 hCryptProv, dwKeySpec, pszPrivateKeyObjId, dwFlags, pvAuxInfo, varptr(pbPrivateKeyBlob), varptr(pcbPrivateKeyBlob)   ; 戻り値は stat
; hCryptProv : UINT_PTR -> "sptr"
; dwKeySpec : DWORD -> "sptr"
; pszPrivateKeyObjId : LPSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; pvAuxInfo : void* optional -> "sptr"
; pbPrivateKeyBlob : BYTE* optional, out -> "sptr"
; pcbPrivateKeyBlob : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptExportPKCS8 "CryptExportPKCS8" sptr, int, str, int, sptr, var, var
; res = CryptExportPKCS8(hCryptProv, dwKeySpec, pszPrivateKeyObjId, dwFlags, pvAuxInfo, pbPrivateKeyBlob, pcbPrivateKeyBlob)
; hCryptProv : UINT_PTR -> "sptr"
; dwKeySpec : DWORD -> "int"
; pszPrivateKeyObjId : LPSTR -> "str"
; dwFlags : DWORD -> "int"
; pvAuxInfo : void* optional -> "sptr"
; pbPrivateKeyBlob : BYTE* optional, out -> "var"
; pcbPrivateKeyBlob : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptExportPKCS8 "CryptExportPKCS8" sptr, int, str, int, sptr, sptr, sptr
; res = CryptExportPKCS8(hCryptProv, dwKeySpec, pszPrivateKeyObjId, dwFlags, pvAuxInfo, varptr(pbPrivateKeyBlob), varptr(pcbPrivateKeyBlob))
; hCryptProv : UINT_PTR -> "sptr"
; dwKeySpec : DWORD -> "int"
; pszPrivateKeyObjId : LPSTR -> "str"
; dwFlags : DWORD -> "int"
; pvAuxInfo : void* optional -> "sptr"
; pbPrivateKeyBlob : BYTE* optional, out -> "sptr"
; pcbPrivateKeyBlob : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。