Win32 API 日本語リファレンス
ホームSecurity.Cryptography › CryptGetKeyParam

CryptGetKeyParam

関数
暗号鍵オブジェクトのパラメータを取得する。
DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CryptGetKeyParam(
    UINT_PTR hKey,
    CRYPT_KEY_PARAM_ID dwParam,
    BYTE* pbData,   // optional
    DWORD* pdwDataLen,
    DWORD dwFlags
);

パラメーター

名前方向説明
hKeyUINT_PTRin照会対象のキーのハンドル。
dwParamCRYPT_KEY_PARAM_IDin

実行する照会の種類を指定します。

すべてのキーの種類に対して、このパラメーターには次のいずれかの値を指定できます。

意味
KP_ALGID
キーのアルゴリズムを取得します。pbData パラメーターは、キーの作成時に指定されたアルゴリズムの識別子を受け取る ALG_ID 値へのポインターです。

CryptGenKey 関数の Algid パラメーターに AT_KEYEXCHANGE または AT_SIGNATURE を指定した場合、キーの生成に使用されるアルゴリズム識別子は使用するプロバイダーによって異なります。詳細については、 ALG_ID を参照してください。

KP_BLOCKLEN
hKey パラメーターでセッションキーが指定されている場合、キーの暗号のブロック長を取得します。pbData パラメーターは、ブロック長をビット単位で受け取る DWORD 値へのポインターです。ストリーム暗号の場合、この値は常にゼロです。

hKey公開鍵/秘密鍵のペアが指定されている場合、そのキーペアの暗号化の粒度を取得します。pbData パラメーターは、暗号化の粒度をビット単位で受け取る DWORD 値へのポインターです。たとえば、Microsoft Base Cryptographic Provider は 512 ビットの RSA キーペアを生成するため、これらのキーに対しては 512 が返されます。公開鍵アルゴリズム暗号化をサポートしていない場合、取得される値は未定義です。

KP_CERTIFICATE
pbData は、Distinguished Encoding Rules (DER) でエンコードされた X.509 証明書を受け取るバッファーのアドレスです。証明書内の公開鍵は、対応する署名キーまたは交換キーと一致している必要があります。
KP_GET_USE_COUNT
この値は使用されません。
KP_KEYLEN
キーの実際の長さを取得します。pbData パラメーターは、キー長をビット単位で受け取る DWORD 値へのポインターです。KP_KEYLEN は任意のキーの種類の長さを取得するために使用できます。Microsoft の暗号化サービスプロバイダー (CSP) は、CALG_DES に対して 64 ビット、CALG_3DES_112 に対して 128 ビット、CALG_3DES に対して 192 ビットのキー長を返します。これらの長さは、CryptGetProvParam 関数の dwParam 値を PP_ENUMALGS に設定してアルゴリズムを列挙したときに返される長さとは異なります。この呼び出しで返される長さは、キーに含まれるパリティビットを含めたキーの実際のサイズです。

CALG_CYLINK_MEK ALG_ID をサポートする Microsoft CSP は、このアルゴリズムに対して 64 ビットを返します。CALG_CYLINK_MEK は 40 ビットのキーですが、パリティビットとゼロ化されたキービットによってキー長が 64 ビットになっています。

KP_SALT
キーのソルト値を取得します。pbData パラメーターは、ソルト値をリトルエンディアン形式で受け取る BYTE 配列へのポインターです。ソルト値のサイズは、使用する CSP およびアルゴリズムによって異なります。ソルト値は公開鍵/秘密鍵のペアには適用されません。
KP_PERMISSIONS
キーのアクセス許可を取得します。pbData パラメーターは、キーのアクセス許可フラグを受け取る DWORD 値へのポインターです。

現在、次のアクセス許可識別子が定義されています。キーのアクセス許可は、ゼロ、または次の値の 1 つ以上の組み合わせにできます。

CRYPT_ARCHIVE
キーのハンドルが有効な間、エクスポートを許可します。このアクセス許可は、キーの内部アクセス許可フィールドで既に設定されている場合にのみ設定できます。このアクセス許可をクリアしようとしても無視されます。
CRYPT_DECRYPT
復号を許可します。
CRYPT_ENCRYPT
暗号化を許可します。
CRYPT_EXPORT
キーのエクスポートを許可します。
CRYPT_EXPORT_KEY
キーをキーのエクスポートに使用することを許可します。
CRYPT_IMPORT_KEY
キーをキーのインポートに使用することを許可します。
CRYPT_MAC
キーでメッセージ認証コード (MAC) を使用することを許可します。
CRYPT_READ
値の読み取りを許可します。
CRYPT_WRITE
値の設定を許可します。

hKey パラメーターで Digital Signature Standard (DSS) キーが指定されている場合、dwParam 値には次のいずれかの値も設定できます。

意味
KP_P
DSS キーのモジュラス素数 P を取得します。pbData パラメーターは、値をリトルエンディアン形式で受け取るバッファーへのポインターです。pdwDataLen パラメーターには、バッファーのサイズがバイト単位で格納されます。
KP_Q
DSS キーのモジュラス素数 Q を取得します。pbData パラメーターは、値をリトルエンディアン形式で受け取るバッファーへのポインターです。pdwDataLen パラメーターには、バッファーのサイズがバイト単位で格納されます。
KP_G
DSS キーのジェネレーター G を取得します。pbData パラメーターは、値をリトルエンディアン形式で受け取るバッファーへのポインターです。pdwDataLen パラメーターには、バッファーのサイズがバイト単位で格納されます。

hKey パラメーターでブロック暗号セッションキーが指定されている場合、dwParam 値には次のいずれかの値も設定できます。

意味
KP_EFFECTIVE_KEYLEN
RC2 キーの実効キー長を取得します。pbData パラメーターは、実効キー長を受け取る DWORD 値へのポインターです。
KP_IV
キーの初期化ベクトルを取得します。pbData パラメーターは、初期化ベクトルを受け取る BYTE 配列へのポインターです。この配列のサイズはブロックサイズ (バイト単位) です。たとえば、ブロック長が 64 ビットの場合、初期化ベクトルは 8 バイトで構成されます。
KP_PADDING
パディングモードを取得します。pbData パラメーターは、暗号で使用されるパディング方式を識別する数値識別子を受け取る DWORD 値へのポインターです。これは次のいずれかの値になります。
PKCS5_PADDING
PKCS 5 (sec 6.2) パディング方式を指定します。
RANDOM_PADDING
パディングに乱数を使用します。このパディング方式は Microsoft 提供の CSP ではサポートされていません。
ZERO_PADDING
パディングにゼロを使用します。このパディング方式は Microsoft 提供の CSP ではサポートされていません。
KP_MODE
暗号モードを取得します。pbData パラメーターは、暗号モード識別子を受け取る DWORD 値へのポインターです。暗号モードの詳細については、 Data Encryption and Decryption を参照してください。

現在、次の暗号モード識別子が定義されています。

CRYPT_MODE_CBC
暗号モードは暗号ブロック連鎖 (CBC) です。
CRYPT_MODE_CFB
暗号モードは暗号フィードバック (CFB) です。Microsoft CSP は現在、暗号フィードバックモードでは 8 ビットのフィードバックのみをサポートしています。
CRYPT_MODE_ECB
暗号モードは電子コードブック (ECB) です。
CRYPT_MODE_OFB
暗号モードは出力フィードバック (OFB) です。Microsoft CSP は現在、出力フィードバックモードをサポートしていません。
CRYPT_MODE_CTS
暗号モードは暗号文スティーリングモードです。
KP_MODE_BITS
フィードバックするビット数を取得します。pbData パラメーターは、OFB または CFB 暗号モードを使用する場合に 1 サイクルあたりに処理されるビット数を受け取る DWORD 値へのポインターです。

hKeyDiffie-Hellman アルゴリズムまたは Digital Signature Algorithm (DSA) キーが指定されている場合、dwParam 値には次の値も設定できます。

意味
KP_VERIFY_PARAMS
Diffie-Hellman アルゴリズムまたは DSA キーのパラメーターを検証します。pbData パラメーターは使用されず、pdwDataLen が指す値にはゼロが格納されます。

この関数は、キーパラメーターが有効な場合は 0 以外の値を、そうでない場合はゼロを返します。

KP_KEYVAL
この値は使用されません。

Windows Vista、Windows Server 2003、Windows XP: CALG_AGREEDKEY_ANY 型のインポートされた Diffie-Hellman アルゴリズムキーから秘密合意値を取得します。pbData パラメーターは、秘密合意値をリトルエンディアン形式で受け取るバッファーのアドレスです。このバッファーはキーと同じ長さである必要があります。dwFlags パラメーターは 0xF42A19B6 に設定する必要があります。このプロパティは、ローカルシステムアカウントで実行されているスレッドからのみ取得できます。このプロパティは上記の各オペレーティングシステムで使用できます。以降のバージョンでは変更または使用できなくなる可能性があります。

hKey で証明書が指定されている場合、dwParam 値には次の値も設定できます。

意味
KP_CERTIFICATE
DER エンコードされた X.509 証明書を格納するバッファー。pbData パラメーターは使用されず、pdwDataLen が指す値にはゼロが格納されます。

この関数は、キーパラメーターが有効な場合は 0 以外の値を、そうでない場合はゼロを返します。

pbDataBYTE*outoptional

データを受け取るバッファーへのポインター。このデータの形式は dwParam の値によって異なります。

このバッファーのサイズが不明な場合は、このパラメーターに NULL を渡し、pdwDataLen が指す値をゼロに設定することで、実行時に必要なサイズを取得できます。この関数は、必要なバッファーのサイズをバイト単位で pdwDataLen が指す値に格納します。詳細については、 Retrieving Data of Unknown Length を参照してください。

pdwDataLenDWORD*inout

DWORD 値へのポインター。呼び出し時には、pbData パラメーターが指すバッファーのサイズをバイト単位で格納します。関数が返るときには、この DWORD 値にバッファーに格納されたバイト数が格納されます。

注意 バッファーで返されたデータを処理する場合、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さい場合があります。入力時には、最大の出力データが収まるように十分な大きさのバッファーサイズを指定することがあります。出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。
dwFlagsDWORDinこのパラメーターは将来の使用のために予約されており、ゼロに設定する必要があります。

戻り値の型: BOOL

公式ドキュメント

キーの操作を制御するデータを取得します。

戻り値

関数が成功した場合は、0 以外の値を返します。

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

"NTE" で始まるエラーコードは、使用している特定の CSP によって生成されます。発生する可能性のあるエラーコードには次のものがあります。

戻り値コード 説明
ERROR_INVALID_HANDLE
いずれかのパラメーターが、有効でないハンドルを指定しています。
ERROR_INVALID_PARAMETER
いずれかのパラメーターに有効でない値が含まれています。多くの場合、これは有効でないポインターです。
ERROR_MORE_DATA
pbData パラメーターで指定したバッファーが、返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズをバイト単位で pdwDataLen が指す変数に格納します。
NTE_BAD_FLAGS
dwFlags パラメーターが 0 以外です。
NTE_BAD_KEY または NTE_NO_KEY
hKey パラメーターで指定したキーが有効ではありません。
NTE_BAD_TYPE
dwParam パラメーターが不明な値番号を指定しています。
NTE_BAD_UID
キーの作成時に指定された CSP コンテキストが見つかりません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL CryptGetKeyParam(
    UINT_PTR hKey,
    CRYPT_KEY_PARAM_ID dwParam,
    BYTE* pbData,   // optional
    DWORD* pdwDataLen,
    DWORD dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptGetKeyParam(
    UIntPtr hKey,   // UINT_PTR
    uint dwParam,   // CRYPT_KEY_PARAM_ID
    IntPtr pbData,   // BYTE* optional, out
    ref uint pdwDataLen,   // DWORD* in/out
    uint dwFlags   // DWORD
);
<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptGetKeyParam(
    hKey As UIntPtr,   ' UINT_PTR
    dwParam As UInteger,   ' CRYPT_KEY_PARAM_ID
    pbData As IntPtr,   ' BYTE* optional, out
    ByRef pdwDataLen As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hKey : UINT_PTR
' dwParam : CRYPT_KEY_PARAM_ID
' pbData : BYTE* optional, out
' pdwDataLen : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function CryptGetKeyParam Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal dwParam As Long, _
    ByVal pbData As LongPtr, _
    ByRef pdwDataLen As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CryptGetKeyParam = ctypes.windll.advapi32.CryptGetKeyParam
CryptGetKeyParam.restype = wintypes.BOOL
CryptGetKeyParam.argtypes = [
    ctypes.c_size_t,  # hKey : UINT_PTR
    wintypes.DWORD,  # dwParam : CRYPT_KEY_PARAM_ID
    ctypes.POINTER(ctypes.c_ubyte),  # pbData : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwDataLen : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptGetKeyParam = Fiddle::Function.new(
  lib['CryptGetKeyParam'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hKey : UINT_PTR
    -Fiddle::TYPE_INT,  # dwParam : CRYPT_KEY_PARAM_ID
    Fiddle::TYPE_VOIDP,  # pbData : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pdwDataLen : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn CryptGetKeyParam(
        hKey: usize,  // UINT_PTR
        dwParam: u32,  // CRYPT_KEY_PARAM_ID
        pbData: *mut u8,  // BYTE* optional, out
        pdwDataLen: *mut u32,  // DWORD* in/out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool CryptGetKeyParam(UIntPtr hKey, uint dwParam, IntPtr pbData, ref uint pdwDataLen, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptGetKeyParam' -Namespace Win32 -PassThru
# $api::CryptGetKeyParam(hKey, dwParam, pbData, pdwDataLen, dwFlags)
#uselib "ADVAPI32.dll"
#func global CryptGetKeyParam "CryptGetKeyParam" sptr, sptr, sptr, sptr, sptr
; CryptGetKeyParam hKey, dwParam, varptr(pbData), varptr(pdwDataLen), dwFlags   ; 戻り値は stat
; hKey : UINT_PTR -> "sptr"
; dwParam : CRYPT_KEY_PARAM_ID -> "sptr"
; pbData : BYTE* optional, out -> "sptr"
; pdwDataLen : DWORD* in/out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global CryptGetKeyParam "CryptGetKeyParam" sptr, int, var, var, int
; res = CryptGetKeyParam(hKey, dwParam, pbData, pdwDataLen, dwFlags)
; hKey : UINT_PTR -> "sptr"
; dwParam : CRYPT_KEY_PARAM_ID -> "int"
; pbData : BYTE* optional, out -> "var"
; pdwDataLen : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CryptGetKeyParam(UINT_PTR hKey, CRYPT_KEY_PARAM_ID dwParam, BYTE* pbData, DWORD* pdwDataLen, DWORD dwFlags)
#uselib "ADVAPI32.dll"
#cfunc global CryptGetKeyParam "CryptGetKeyParam" intptr, int, var, var, int
; res = CryptGetKeyParam(hKey, dwParam, pbData, pdwDataLen, dwFlags)
; hKey : UINT_PTR -> "intptr"
; dwParam : CRYPT_KEY_PARAM_ID -> "int"
; pbData : BYTE* optional, out -> "var"
; pdwDataLen : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procCryptGetKeyParam = advapi32.NewProc("CryptGetKeyParam")
)

// hKey (UINT_PTR), dwParam (CRYPT_KEY_PARAM_ID), pbData (BYTE* optional, out), pdwDataLen (DWORD* in/out), dwFlags (DWORD)
r1, _, err := procCryptGetKeyParam.Call(
	uintptr(hKey),
	uintptr(dwParam),
	uintptr(pbData),
	uintptr(pdwDataLen),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CryptGetKeyParam(
  hKey: NativeUInt;   // UINT_PTR
  dwParam: DWORD;   // CRYPT_KEY_PARAM_ID
  pbData: Pointer;   // BYTE* optional, out
  pdwDataLen: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CryptGetKeyParam';
result := DllCall("ADVAPI32\CryptGetKeyParam"
    , "UPtr", hKey   ; UINT_PTR
    , "UInt", dwParam   ; CRYPT_KEY_PARAM_ID
    , "Ptr", pbData   ; BYTE* optional, out
    , "Ptr", pdwDataLen   ; DWORD* in/out
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: BOOL
●CryptGetKeyParam(hKey, dwParam, pbData, pdwDataLen, dwFlags) = DLL("ADVAPI32.dll", "bool CryptGetKeyParam(int, dword, void*, void*, dword)")
# 呼び出し: CryptGetKeyParam(hKey, dwParam, pbData, pdwDataLen, dwFlags)
# hKey : UINT_PTR -> "int"
# dwParam : CRYPT_KEY_PARAM_ID -> "dword"
# pbData : BYTE* optional, out -> "void*"
# pdwDataLen : DWORD* in/out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn CryptGetKeyParam(
    hKey: usize, // UINT_PTR
    dwParam: u32, // CRYPT_KEY_PARAM_ID
    pbData: [*c]u8, // BYTE* optional, out
    pdwDataLen: [*c]u32, // DWORD* in/out
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc CryptGetKeyParam(
    hKey: uint,  # UINT_PTR
    dwParam: uint32,  # CRYPT_KEY_PARAM_ID
    pbData: ptr uint8,  # BYTE* optional, out
    pdwDataLen: ptr uint32,  # DWORD* in/out
    dwFlags: uint32  # DWORD
): int32 {.importc: "CryptGetKeyParam", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
int CryptGetKeyParam(
    size_t hKey,   // UINT_PTR
    uint dwParam,   // CRYPT_KEY_PARAM_ID
    ubyte* pbData,   // BYTE* optional, out
    uint* pdwDataLen,   // DWORD* in/out
    uint dwFlags   // DWORD
);
ccall((:CryptGetKeyParam, "ADVAPI32.dll"), stdcall, Int32,
      (Csize_t, UInt32, Ptr{UInt8}, Ptr{UInt32}, UInt32),
      hKey, dwParam, pbData, pdwDataLen, dwFlags)
# hKey : UINT_PTR -> Csize_t
# dwParam : CRYPT_KEY_PARAM_ID -> UInt32
# pbData : BYTE* optional, out -> Ptr{UInt8}
# pdwDataLen : DWORD* in/out -> Ptr{UInt32}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CryptGetKeyParam(
    uintptr_t hKey,
    uint32_t dwParam,
    uint8_t* pbData,
    uint32_t* pdwDataLen,
    uint32_t dwFlags);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.CryptGetKeyParam(hKey, dwParam, pbData, pdwDataLen, dwFlags)
-- hKey : UINT_PTR
-- dwParam : CRYPT_KEY_PARAM_ID
-- pbData : BYTE* optional, out
-- pdwDataLen : DWORD* in/out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const CryptGetKeyParam = lib.func('__stdcall', 'CryptGetKeyParam', 'int32_t', ['uintptr_t', 'uint32_t', 'uint8_t *', 'uint32_t *', 'uint32_t']);
// CryptGetKeyParam(hKey, dwParam, pbData, pdwDataLen, dwFlags)
// hKey : UINT_PTR -> 'uintptr_t'
// dwParam : CRYPT_KEY_PARAM_ID -> 'uint32_t'
// pbData : BYTE* optional, out -> 'uint8_t *'
// pdwDataLen : DWORD* in/out -> 'uint32_t *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  CryptGetKeyParam: { parameters: ["usize", "u32", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.CryptGetKeyParam(hKey, dwParam, pbData, pdwDataLen, dwFlags)
// hKey : UINT_PTR -> "usize"
// dwParam : CRYPT_KEY_PARAM_ID -> "u32"
// pbData : BYTE* optional, out -> "pointer"
// pdwDataLen : DWORD* in/out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CryptGetKeyParam(
    size_t hKey,
    uint32_t dwParam,
    uint8_t* pbData,
    uint32_t* pdwDataLen,
    uint32_t dwFlags);
C, "ADVAPI32.dll");
// $ffi->CryptGetKeyParam(hKey, dwParam, pbData, pdwDataLen, dwFlags);
// hKey : UINT_PTR
// dwParam : CRYPT_KEY_PARAM_ID
// pbData : BYTE* optional, out
// pdwDataLen : DWORD* in/out
// dwFlags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
    boolean CryptGetKeyParam(
        long hKey,   // UINT_PTR
        int dwParam,   // CRYPT_KEY_PARAM_ID
        byte[] pbData,   // BYTE* optional, out
        IntByReference pdwDataLen,   // DWORD* in/out
        int dwFlags   // DWORD
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun CryptGetKeyParam = CryptGetKeyParam(
    hKey : LibC::SizeT,   # UINT_PTR
    dwParam : UInt32,   # CRYPT_KEY_PARAM_ID
    pbData : UInt8*,   # BYTE* optional, out
    pdwDataLen : UInt32*,   # DWORD* in/out
    dwFlags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CryptGetKeyParamNative = Int32 Function(UintPtr, Uint32, Pointer<Uint8>, Pointer<Uint32>, Uint32);
typedef CryptGetKeyParamDart = int Function(int, int, Pointer<Uint8>, Pointer<Uint32>, int);
final CryptGetKeyParam = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<CryptGetKeyParamNative, CryptGetKeyParamDart>('CryptGetKeyParam');
// hKey : UINT_PTR -> UintPtr
// dwParam : CRYPT_KEY_PARAM_ID -> Uint32
// pbData : BYTE* optional, out -> Pointer<Uint8>
// pdwDataLen : DWORD* in/out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CryptGetKeyParam(
  hKey: NativeUInt;   // UINT_PTR
  dwParam: DWORD;   // CRYPT_KEY_PARAM_ID
  pbData: Pointer;   // BYTE* optional, out
  pdwDataLen: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CryptGetKeyParam';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CryptGetKeyParam"
  c_CryptGetKeyParam :: CUIntPtr -> Word32 -> Ptr Word8 -> Ptr Word32 -> Word32 -> IO CInt
-- hKey : UINT_PTR -> CUIntPtr
-- dwParam : CRYPT_KEY_PARAM_ID -> Word32
-- pbData : BYTE* optional, out -> Ptr Word8
-- pdwDataLen : DWORD* in/out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cryptgetkeyparam =
  foreign "CryptGetKeyParam"
    (size_t @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* hKey : UINT_PTR -> size_t *)
(* dwParam : CRYPT_KEY_PARAM_ID -> uint32_t *)
(* pbData : BYTE* optional, out -> (ptr uint8_t) *)
(* pdwDataLen : DWORD* in/out -> (ptr uint32_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("CryptGetKeyParam" crypt-get-key-param :convention :stdcall) :int32
  (h-key :uint64)   ; UINT_PTR
  (dw-param :uint32)   ; CRYPT_KEY_PARAM_ID
  (pb-data :pointer)   ; BYTE* optional, out
  (pdw-data-len :pointer)   ; DWORD* in/out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CryptGetKeyParam = Win32::API::More->new('ADVAPI32',
    'BOOL CryptGetKeyParam(WPARAM hKey, DWORD dwParam, LPVOID pbData, LPVOID pdwDataLen, DWORD dwFlags)');
# my $ret = $CryptGetKeyParam->Call($hKey, $dwParam, $pbData, $pdwDataLen, $dwFlags);
# hKey : UINT_PTR -> WPARAM
# dwParam : CRYPT_KEY_PARAM_ID -> DWORD
# pbData : BYTE* optional, out -> LPVOID
# pdwDataLen : DWORD* in/out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型