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

CryptGetProvParam

関数
暗号化サービスプロバイダーのパラメータを取得する。
DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CryptGetProvParam(
    UINT_PTR hProv,
    DWORD dwParam,
    BYTE* pbData,   // optional
    DWORD* pdwDataLen,
    DWORD dwFlags
);

パラメーター

名前方向説明
hProvUINT_PTRinクエリ対象の CSP のハンドル。このハンドルは CryptAcquireContext 関数を使用して作成されている必要があります。
dwParamDWORDin

クエリの種類。次のクエリが定義されています。

意味
PP_ADMIN_PIN
31 (0x1F)
管理者の暗証番号 (PIN) を pbData パラメーターに LPSTR として返します。
PP_APPLI_CERT
18 (0x12)
この定数は使用されません。
PP_CHANGE_PASSWORD
7 (0x7)
この定数は使用されません。
PP_CERTCHAIN
9 (0x9)
hProv ハンドルに関連付けられた証明書チェーンを返します。返される証明書チェーンは X509_ASN_ENCODING でエンコードされています。
PP_CONTAINER
6 (0x6)
現在の キーコンテナー の名前を null 終端の CHAR 文字列として返します。この文字列は、使用するキーコンテナーを指定するために CryptAcquireContext 関数の pszContainer パラメーターに渡したものとまったく同じです。pszContainer パラメーターを読み取ることで、既定のキーコンテナーの名前を取得できます。
PP_CRYPT_COUNT_KEY_USE
41 (0x29)
Microsoft CSP では実装されていません。この動作は他の CSP によって実装される場合があります。

Windows XP: このパラメーターはサポートされていません。

PP_ENUMALGS
1 (0x1)
クエリ対象の CSP がサポートする 1 つのアルゴリズムに関する情報を含む PROV_ENUMALGS 構造体。

この値を初めて読み取るときは、dwFlags パラメーターに CRYPT_FIRST フラグを指定する必要があります。これにより、この関数は列挙内の最初の要素を取得します。後続の要素は、dwFlags パラメーターに CRYPT_NEXT フラグを設定することで取得できます。この関数が ERROR_NO_MORE_ITEMS エラーコードで失敗した場合、列挙の末尾に達しています。

この関数はスレッドセーフではなく、マルチスレッドのコンテキストで使用すると、利用可能なすべてのアルゴリズムが列挙されない場合があります。

PP_ENUMALGS_EX
22 (0x16)
クエリ対象の CSP がサポートする 1 つのアルゴリズムに関する情報を含む PROV_ENUMALGS_EX 構造体。返される構造体には、PP_ENUMALGS で返される構造体よりも多くのアルゴリズム情報が含まれます。

この値を初めて読み取るときは、dwFlags パラメーターに CRYPT_FIRST フラグを指定する必要があります。これにより、この関数は列挙内の最初の要素を取得します。後続の要素は、dwFlags パラメーターに CRYPT_NEXT フラグを設定することで取得できます。この関数が ERROR_NO_MORE_ITEMS エラーコードで失敗した場合、列挙の末尾に達しています。

この関数はスレッドセーフではなく、マルチスレッドのコンテキストで使用すると、利用可能なすべてのアルゴリズムが列挙されない場合があります。

PP_ENUMCONTAINERS
2 (0x2)
CSP が管理するキーコンテナーの 1 つの名前を null 終端の CHAR 文字列として返します。

この値を初めて読み取るときは、dwFlags パラメーターに CRYPT_FIRST フラグを指定する必要があります。これにより、この関数は列挙内の最初の要素を取得します。後続の要素は、dwFlags パラメーターに CRYPT_NEXT フラグを設定することで取得できます。この関数が ERROR_NO_MORE_ITEMS エラーコードで失敗した場合、列挙の末尾に達しています。

コンピューターに関連付けられたキーコンテナーを列挙するには、まず CRYPT_MACHINE_KEYSET フラグを指定して CryptAcquireContext を呼び出し、CryptAcquireContext から返されたハンドルを CryptGetProvParam 呼び出しの hProv パラメーターとして使用します。

この関数はスレッドセーフではなく、マルチスレッドのコンテキストで使用すると、利用可能なすべてのアルゴリズムが列挙されない場合があります。

PP_ENUMELECTROOTS
26 (0x1A)
この定数は使用されません。
PP_ENUMEX_SIGNING_PROT
40 (0x28)
現在の CSP が PROV_ENUMALGS_EX 構造体の dwProtocols メンバーをサポートしているかどうかを示します。この関数が成功した場合、CSP は PROV_ENUMALGS_EX 構造体の dwProtocols メンバーをサポートしています。この関数が NTE_BAD_TYPE エラーコードで失敗した場合、CSP は dwProtocols メンバーをサポートしていません。
PP_ENUMMANDROOTS
25 (0x19)
この定数は使用されません。
PP_IMPTYPE
3 (0x3)
CSP がどのように実装されているかを示す DWORD 値。可能な値の一覧については、「解説」を参照してください。
PP_KEY_TYPE_SUBTYPE
10 (0xA)
このクエリは使用されません。
PP_KEYEXCHANGE_PIN
32 (0x20)
キー交換 PIN が pbData に含まれていることを指定します。PIN は null 終端の ASCII 文字列として表されます。
PP_KEYSET_SEC_DESCR
8 (0x8)
キーストレージコンテナーの セキュリティ記述子 を取得します。pbData パラメーターは、キーストレージコンテナーのセキュリティ記述子を受け取る SECURITY_DESCRIPTOR 構造体のアドレスです。セキュリティ記述子は自己相対形式で返されます。
PP_KEYSET_TYPE
27 (0x1B)
hProv パラメーターがコンピューターのキーセットかどうかを判定します。pbData パラメーターは DWORD である必要があります。CryptAcquireContext 関数に CRYPT_MACHINE_KEYSET フラグが渡されていた場合、この DWORD にそのフラグが設定されます。
PP_KEYSPEC
39 (0x27)
CSP がサポートするキー指定子の値に関する情報を返します。キー指定子の値は論理 OR で結合され、呼び出しの pbData パラメーターに DWORD として返されます。たとえば、Microsoft Base Cryptographic Provider バージョン 1.0 は AT_SIGNATURE | AT_KEYEXCHANGE という DWORD 値を返します。
PP_KEYSTORAGE
17 (0x11)
CRYPT_SEC_DESCRDWORD 値を返します。
PP_KEYX_KEYSIZE_INC
35 (0x23)
AT_KEYEXCHANGE の増分長のビット数。この情報は PP_ENUMALGS_EX 値で返される情報と組み合わせて使用します。PP_ENUMALGS_EXPP_KEYX_KEYSIZE_INC を使用して返される情報により、AT_KEYEXCHANGE の有効なキー長を決定できます。これらのキー長は CryptGenKey で使用できます。たとえば、CSP が CALG_RSA_KEYX (AT_KEYEXCHANGE) を最小キー長 512 ビット、最大キー長 1024 ビットで列挙し、増分長を 64 ビットとして返す場合、有効なキー長は 512、576、640、… 1024 です。
PP_NAME
4 (0x4)
CSP の名前を null 終端の CHAR 文字列として返します。この文字列は、現在の CSP を使用するように指定するために CryptAcquireContext 関数の pszProvider パラメーターに渡したものと同一です。
PP_PROVTYPE
16 (0x10)
CSP のプロバイダータイプを示す DWORD 値。
PP_ROOT_CERTSTORE
46 (0x2E)
スマートカードのルート証明書ストアを取得します。この証明書ストアには、スマートカードに格納されているすべてのルート証明書が含まれます。

pbData パラメーターは、証明書ストアのハンドルを受け取る HCERTSTORE 変数のアドレスです。このハンドルが不要になったら、呼び出し元は CertCloseStore 関数を使用して閉じる必要があります。

Windows Server 2003 および Windows XP: このパラメーターはサポートされていません。

PP_SESSION_KEYSIZE
20 (0x14)
セッションキーのサイズ (ビット単位)。
PP_SGC_INFO
37 (0x25)
サーバーゲート暗号化 (SGC) で使用されます。
PP_SIG_KEYSIZE_INC
34 (0x22)
AT_SIGNATURE の増分長のビット数。この情報は PP_ENUMALGS_EX 値で返される情報と組み合わせて使用します。PP_ENUMALGS_EXPP_SIG_KEYSIZE_INC を使用して返される情報により、AT_SIGNATURE の有効な キー長 を決定できます。これらのキー長は CryptGenKey で使用できます。

たとえば、CSP が CALG_RSA_SIGN (AT_SIGNATURE) を最小 キー長 512 ビット、最大キー長 1024 ビットで列挙し、増分長を 64 ビットとして返す場合、有効なキー長は 512、576、640、… 1024 です。

PP_SIGNATURE_PIN
33 (0x21)
キー署名 PIN が pbData に含まれていることを指定します。PIN は null 終端の ASCII 文字列として表されます。
PP_SMARTCARD_GUID
45 (0x2D)
スマートカードの識別子を取得します。pbData パラメーターは、スマートカードの識別子を受け取る GUID 構造体のアドレスです。

Windows Server 2003 および Windows XP: このパラメーターはサポートされていません。

PP_SMARTCARD_READER
43 (0x2B)
スマートカードリーダーの名前を取得します。pbData パラメーターは、スマートカードリーダーの名前を含む null 終端の ANSI 文字列を受け取る ANSI 文字配列のアドレスです。pdwDataLen パラメーターが指す変数に格納されるこのバッファーのサイズには、NULL 終端文字を含める必要があります。

Windows Server 2003 および Windows XP: このパラメーターはサポートされていません。

PP_SYM_KEYSIZE
19 (0x13)
対称キーのサイズ。
PP_UI_PROMPT
21 (0x15)
このクエリは使用されません。
PP_UNIQUE_CONTAINER
36 (0x24)
現在のキーコンテナーの一意のコンテナー名を null 終端の CHAR 文字列として返します。多くの CSP では、この名前は PP_CONTAINER 値を使用したときに返される名前と同じです。CryptAcquireContext 関数はこのコンテナー名で動作する必要があります。
PP_USE_HARDWARE_RNG
38 (0x26)
ハードウェア乱数生成器 (RNG) がサポートされているかどうかを示します。PP_USE_HARDWARE_RNG を指定すると、ハードウェア RNG がサポートされている場合はこの関数が成功して TRUE を返します。ハードウェア RNG がサポートされていない場合は失敗して FALSE を返します。RNG がサポートされている場合、CryptSetProvParamPP_USE_HARDWARE_RNG を設定して、このプロバイダーコンテキストに対して CSP がハードウェア RNG のみを排他的に使用することを示すことができます。PP_USE_HARDWARE_RNG を使用する場合、pbData パラメーターは NULL でなければならず、dwFlags はゼロでなければなりません。

現在、ハードウェア RNG の使用をサポートしている Microsoft CSP はありません。

PP_USER_CERTSTORE
42 (0x2A)
スマートカードのユーザー証明書ストアを取得します。この証明書ストアには、スマートカードに格納されているすべてのユーザー証明書が含まれます。このストア内の証明書は PKCS_7_ASN_ENCODING または X509_ASN_ENCODING エンコードでエンコードされており、CERT_KEY_PROV_INFO_PROP_ID プロパティを含んでいる必要があります。

pbData パラメーターは、メモリ内証明書ストアのハンドルを受け取る HCERTSTORE 変数のアドレスです。このハンドルが不要になったら、呼び出し元は CertCloseStore 関数を使用して閉じる必要があります。

Windows Server 2003 および Windows XP: このパラメーターはサポートされていません。

PP_VERSION
5 (0x5)
CSP のバージョン番号。最下位バイトにマイナーバージョン番号、その次に上位のバイトにメジャーバージョン番号が含まれます。バージョン 2.0 は 0x00000200 として表されます。Microsoft Base Cryptographic Provider および Microsoft Enhanced Cryptographic Provider の以前のバージョンとの下位互換性を維持するため、後のバージョンでもプロバイダー名には「v1.0」の表記が残されています。
pbDataBYTE*outoptional

データを受け取るバッファーへのポインター。このデータの形式は dwParam の値によって異なります。dwParamPP_USE_HARDWARE_RNG に設定されている場合、pbDataNULL に設定する必要があります。

メモリ割り当てのためにこの情報のサイズを取得するには、このパラメーターを NULL にできます。詳細については、長さが不明なデータの取得 を参照してください。

pdwDataLenDWORD*inout

pbData パラメーターが指すバッファーのサイズ (バイト単位) を指定する DWORD 値へのポインター。関数が戻るとき、この DWORD 値には、バッファーに格納された、または格納されるバイト数が含まれます。

バッファーに返されたデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さい場合があります。(入力時には、出力データの最大サイズが確実にバッファーに収まるよう、バッファーサイズを十分大きく指定するのが通常です。) 出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

PP_ENUMALGS または PP_ENUMALGS_EX が設定されている場合、pdwDataLen パラメーターの動作は多少異なります。pbDataNULL であるか、pdwDataLen が指す値が小さすぎる場合、このパラメーターに返される値は、現在読み取られている項目のサイズではなく、列挙リスト内の最大項目のサイズになります。

PP_ENUMCONTAINERS が設定されている場合、関数の最初の呼び出しでは、現在のプロバイダーが許可する最大のキーコンテナーのサイズが返されます。これは、既存の最長のコンテナーの長さや現在のコンテナーの長さを返すといった他の可能な動作とは対照的です。後続の列挙呼び出しでは dwLen パラメーターは変更されません。列挙された各コンテナーについて、必要であれば呼び出し元が null 終端文字列の長さをプログラムで判定できます。列挙値のいずれかを読み取り、かつ pbData パラメーターが NULL の場合、サイズ情報を正しく取得するには CRYPT_FIRST フラグを指定する必要があります。

dwFlagsDWORDin

dwParamPP_KEYSET_SEC_DESCR の場合、キーが格納されている キーコンテナーセキュリティ記述子 が取得されます。この場合、dwFlags は、Platform SDK で定義されている、要求するセキュリティ情報を示す SECURITY_INFORMATION ビットフラグを渡すために使用されます。SECURITY_INFORMATION ビットフラグはビットごとの OR 演算で組み合わせることができます。

PP_KEYSET_SEC_DESCR での使用には次の値が定義されています。

意味
OWNER_SECURITY_INFORMATION
オブジェクトの所有者識別子が参照されています。
GROUP_SECURITY_INFORMATION
オブジェクトのプライマリグループ識別子が参照されています。
DACL_SECURITY_INFORMATION
オブジェクトの随意 ACL が参照されています。
SACL_SECURITY_INFORMATION
オブジェクトのシステム ACL が参照されています。

PP_ENUMALGSPP_ENUMALGS_EXPP_ENUMCONTAINERS での使用には次の値が定義されています。

意味
CRYPT_FIRST
1 (0x1)
列挙内の最初の要素を取得します。これは列挙子をリセットするのと同じ効果があります。
CRYPT_NEXT
2 (0x2)
列挙内の次の要素を取得します。取得する要素がなくなると、この関数は失敗し、最終エラーを ERROR_NO_MORE_ITEMS に設定します。
CRYPT_SGC_ENUM
4 (0x4)
サーバーゲート暗号化 (SGC) 対応の証明書を取得します。SGC 対応の証明書はサポートされなくなりました。
CRYPT_SGC
このフラグは使用されません。
CRYPT_FASTSGC
このフラグは使用されません。

戻り値の型: BOOL

公式ドキュメント

暗号化サービスプロバイダー (CSP) の動作を制御するパラメーターを取得します。

戻り値

関数が成功した場合、戻り値は 0 以外 (TRUE) になります。

関数が失敗した場合、戻り値は 0 (FALSE) になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

NTE で始まるエラーコードは、使用している特定の CSP によって生成されます。考えられるエラーコードの一部を次に示します。

戻り値 説明
ERROR_INVALID_HANDLE
いずれかのパラメーターが無効なハンドルを指定しています。
ERROR_INVALID_PARAMETER
いずれかのパラメーターに無効な値が含まれています。これは多くの場合、無効なポインターです。
ERROR_MORE_DATA
pbData パラメーターで指定されたバッファーが返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pdwDataLen が指す変数に格納します。
ERROR_NO_MORE_ITEMS
列挙リストの末尾に達しました。有効なデータは pbData バッファーに格納されていません。このエラーコードは、dwParamPP_ENUMALGS または PP_ENUMCONTAINERS と等しい場合にのみ返されます。
NTE_BAD_FLAGS
dwFlags パラメーターが無効なフラグを指定しています。
NTE_BAD_TYPE
dwParam パラメーターが不明な値の番号を指定しています。
NTE_BAD_UID
hProv で指定された CSP コンテキスト が無効です。

解説(Remarks)

この関数は、マルチスレッドプログラムのスレッド上で使用してはなりません。

dwParamPP_IMPTYPE の場合、次の値が pbData に返されます。

意味
CRYPT_IMPL_HARDWARE
0x01
実装はハードウェア内にあります。
CRYPT_IMPL_SOFTWARE
0x02
実装はソフトウェア内にあります。
CRYPT_IMPL_MIXED
0x03
実装はハードウェアとソフトウェアの両方にまたがります。
CRYPT_IMPL_UNKNOWN
0x04
実装タイプは不明です。
CRYPT_IMPL_REMOVABLE
0x08
実装はリムーバブルメディア内にあります。

dwFlags パラメーターは、要求するセキュリティ情報を示す SECURITY_INFORMATION ビットフラグを渡すために使用されます。セキュリティ記述子 へのポインターは pbData パラメーターに返され、セキュリティ記述子の長さは pdwDataLen パラメーターに返されます。キーコンテナーのセキュリティは SetFileSecurity および GetFileSecurity で処理されます。

dwParamPP_ENUMALGS または PP_ENUMALGS_EX に設定して列挙したアルゴリズムのクラスを判定できます。これは、サポートされている暗号化アルゴリズムの一覧を表示し、それ以外を除外するために行うことがあります。GET_ALG_CLASS(x) マクロは、アルゴリズム識別子を引数に取り、そのアルゴリズムの一般的なクラスを示すコードを返します。返される可能性のある値は次のとおりです。

次の表は、Microsoft Base Cryptographic Provider がサポートするアルゴリズムと、各アルゴリズムのクラスの一覧です。

名前 識別子 クラス
"MD2" CALG_MD2 ALG_CLASS_HASH
"MD5" CALG_MD5 ALG_CLASS_HASH
"SHA" CALG_SHA ALG_CLASS_HASH
"MAC" CALG_MAC ALG_CLASS_HASH
"RSA_SIGN" CALG_RSA_SIGN ALG_CLASS_SIGNATURE
"RSA_KEYX" CALG_RSA_KEYX ALG_CLASS_KEY_EXCHANGE
"RC2" CALG_RC2 ALG_CLASS_DATA_ENCRYPT
"RC4" CALG_RC4 ALG_CLASS_DATA_ENCRYPT

認識されないアルゴリズム識別子を持つアルゴリズムをアプリケーションで使用してはなりません。不明な暗号化アルゴリズムを使用すると、予測できない結果を招く可能性があります。

次の例は、暗号化サービスプロバイダーハンドルに関連付けられた CSP の名前と、そのハンドルに関連付けられたキーコンテナーの名前を取得する方法を示しています。この例の完全なコンテキストについては、C プログラムの例: CryptAcquireContext の使用 を参照してください。

この関数を使用する別の例については、C プログラムの例: CSP プロバイダーとプロバイダータイプの列挙 を参照してください。

//-----------------------------------------------------------------
//  Declare and initialize variables.

HCRYPTPROV hCryptProv;
BYTE       pbData[1000];       // 1000 will hold the longest 
                               // key container name.
DWORD cbData;

//-------------------------------------------------------------------
// An HCRYPTPROV must be acquired before using code like that in 
// "Example C Program Using CryptAcquireContext."

//-------------------------------------------------------------------
// Read the name of the default CSP.

cbData = 1000;
if(CryptGetProvParam(
    hCryptProv, 
    PP_NAME, 
    pbData, 
    &cbData, 
    0))
{
    printf("CryptGetProvParam succeeded.\n");
    printf("Provider name: %s\n", pbData);
}
else
{
    printf("Error reading CSP name. \n");
    exit(1);
}
//--------------------------------------------------------------------
// Read the name of the default key container.

cbData = 1000;
if(CryptGetProvParam(
    hCryptProv, 
    PP_CONTAINER, 
    pbData, 
    &cbData, 
    0))
{
    printf("CryptGetProvParam succeeded. \n");
    printf("Key Container name: %s\n", pbData);
}
else
{
    printf("Error reading key container name. \n");
    exit(1);
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL CryptGetProvParam(
    UINT_PTR hProv,
    DWORD dwParam,
    BYTE* pbData,   // optional
    DWORD* pdwDataLen,
    DWORD dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptGetProvParam(
    UIntPtr hProv,   // UINT_PTR
    uint dwParam,   // DWORD
    IntPtr pbData,   // BYTE* optional, out
    ref uint pdwDataLen,   // DWORD* in/out
    uint dwFlags   // DWORD
);
<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptGetProvParam(
    hProv As UIntPtr,   ' UINT_PTR
    dwParam As UInteger,   ' DWORD
    pbData As IntPtr,   ' BYTE* optional, out
    ByRef pdwDataLen As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProv : UINT_PTR
' dwParam : DWORD
' pbData : BYTE* optional, out
' pdwDataLen : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function CryptGetProvParam Lib "advapi32" ( _
    ByVal hProv 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

CryptGetProvParam = ctypes.windll.advapi32.CryptGetProvParam
CryptGetProvParam.restype = wintypes.BOOL
CryptGetProvParam.argtypes = [
    ctypes.c_size_t,  # hProv : UINT_PTR
    wintypes.DWORD,  # dwParam : DWORD
    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')
CryptGetProvParam = Fiddle::Function.new(
  lib['CryptGetProvParam'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hProv : UINT_PTR
    -Fiddle::TYPE_INT,  # dwParam : DWORD
    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 CryptGetProvParam(
        hProv: usize,  // UINT_PTR
        dwParam: u32,  // DWORD
        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 CryptGetProvParam(UIntPtr hProv, uint dwParam, IntPtr pbData, ref uint pdwDataLen, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptGetProvParam' -Namespace Win32 -PassThru
# $api::CryptGetProvParam(hProv, dwParam, pbData, pdwDataLen, dwFlags)
#uselib "ADVAPI32.dll"
#func global CryptGetProvParam "CryptGetProvParam" sptr, sptr, sptr, sptr, sptr
; CryptGetProvParam hProv, dwParam, varptr(pbData), varptr(pdwDataLen), dwFlags   ; 戻り値は stat
; hProv : UINT_PTR -> "sptr"
; dwParam : DWORD -> "sptr"
; pbData : BYTE* optional, out -> "sptr"
; pdwDataLen : DWORD* in/out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global CryptGetProvParam "CryptGetProvParam" sptr, int, var, var, int
; res = CryptGetProvParam(hProv, dwParam, pbData, pdwDataLen, dwFlags)
; hProv : UINT_PTR -> "sptr"
; dwParam : DWORD -> "int"
; pbData : BYTE* optional, out -> "var"
; pdwDataLen : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CryptGetProvParam(UINT_PTR hProv, DWORD dwParam, BYTE* pbData, DWORD* pdwDataLen, DWORD dwFlags)
#uselib "ADVAPI32.dll"
#cfunc global CryptGetProvParam "CryptGetProvParam" intptr, int, var, var, int
; res = CryptGetProvParam(hProv, dwParam, pbData, pdwDataLen, dwFlags)
; hProv : UINT_PTR -> "intptr"
; dwParam : DWORD -> "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")
	procCryptGetProvParam = advapi32.NewProc("CryptGetProvParam")
)

// hProv (UINT_PTR), dwParam (DWORD), pbData (BYTE* optional, out), pdwDataLen (DWORD* in/out), dwFlags (DWORD)
r1, _, err := procCryptGetProvParam.Call(
	uintptr(hProv),
	uintptr(dwParam),
	uintptr(pbData),
	uintptr(pdwDataLen),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CryptGetProvParam(
  hProv: NativeUInt;   // UINT_PTR
  dwParam: DWORD;   // DWORD
  pbData: Pointer;   // BYTE* optional, out
  pdwDataLen: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CryptGetProvParam';
result := DllCall("ADVAPI32\CryptGetProvParam"
    , "UPtr", hProv   ; UINT_PTR
    , "UInt", dwParam   ; DWORD
    , "Ptr", pbData   ; BYTE* optional, out
    , "Ptr", pdwDataLen   ; DWORD* in/out
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: BOOL
●CryptGetProvParam(hProv, dwParam, pbData, pdwDataLen, dwFlags) = DLL("ADVAPI32.dll", "bool CryptGetProvParam(int, dword, void*, void*, dword)")
# 呼び出し: CryptGetProvParam(hProv, dwParam, pbData, pdwDataLen, dwFlags)
# hProv : UINT_PTR -> "int"
# dwParam : DWORD -> "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 CryptGetProvParam(
    hProv: usize, // UINT_PTR
    dwParam: u32, // DWORD
    pbData: [*c]u8, // BYTE* optional, out
    pdwDataLen: [*c]u32, // DWORD* in/out
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc CryptGetProvParam(
    hProv: uint,  # UINT_PTR
    dwParam: uint32,  # DWORD
    pbData: ptr uint8,  # BYTE* optional, out
    pdwDataLen: ptr uint32,  # DWORD* in/out
    dwFlags: uint32  # DWORD
): int32 {.importc: "CryptGetProvParam", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
int CryptGetProvParam(
    size_t hProv,   // UINT_PTR
    uint dwParam,   // DWORD
    ubyte* pbData,   // BYTE* optional, out
    uint* pdwDataLen,   // DWORD* in/out
    uint dwFlags   // DWORD
);
ccall((:CryptGetProvParam, "ADVAPI32.dll"), stdcall, Int32,
      (Csize_t, UInt32, Ptr{UInt8}, Ptr{UInt32}, UInt32),
      hProv, dwParam, pbData, pdwDataLen, dwFlags)
# hProv : UINT_PTR -> Csize_t
# dwParam : DWORD -> 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 CryptGetProvParam(
    uintptr_t hProv,
    uint32_t dwParam,
    uint8_t* pbData,
    uint32_t* pdwDataLen,
    uint32_t dwFlags);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.CryptGetProvParam(hProv, dwParam, pbData, pdwDataLen, dwFlags)
-- hProv : UINT_PTR
-- dwParam : DWORD
-- 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 CryptGetProvParam = lib.func('__stdcall', 'CryptGetProvParam', 'int32_t', ['uintptr_t', 'uint32_t', 'uint8_t *', 'uint32_t *', 'uint32_t']);
// CryptGetProvParam(hProv, dwParam, pbData, pdwDataLen, dwFlags)
// hProv : UINT_PTR -> 'uintptr_t'
// dwParam : DWORD -> '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", {
  CryptGetProvParam: { parameters: ["usize", "u32", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.CryptGetProvParam(hProv, dwParam, pbData, pdwDataLen, dwFlags)
// hProv : UINT_PTR -> "usize"
// dwParam : DWORD -> "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 CryptGetProvParam(
    size_t hProv,
    uint32_t dwParam,
    uint8_t* pbData,
    uint32_t* pdwDataLen,
    uint32_t dwFlags);
C, "ADVAPI32.dll");
// $ffi->CryptGetProvParam(hProv, dwParam, pbData, pdwDataLen, dwFlags);
// hProv : UINT_PTR
// dwParam : DWORD
// 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 CryptGetProvParam(
        long hProv,   // UINT_PTR
        int dwParam,   // DWORD
        byte[] pbData,   // BYTE* optional, out
        IntByReference pdwDataLen,   // DWORD* in/out
        int dwFlags   // DWORD
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun CryptGetProvParam = CryptGetProvParam(
    hProv : LibC::SizeT,   # UINT_PTR
    dwParam : UInt32,   # DWORD
    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 CryptGetProvParamNative = Int32 Function(UintPtr, Uint32, Pointer<Uint8>, Pointer<Uint32>, Uint32);
typedef CryptGetProvParamDart = int Function(int, int, Pointer<Uint8>, Pointer<Uint32>, int);
final CryptGetProvParam = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<CryptGetProvParamNative, CryptGetProvParamDart>('CryptGetProvParam');
// hProv : UINT_PTR -> UintPtr
// dwParam : DWORD -> Uint32
// pbData : BYTE* optional, out -> Pointer<Uint8>
// pdwDataLen : DWORD* in/out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CryptGetProvParam(
  hProv: NativeUInt;   // UINT_PTR
  dwParam: DWORD;   // DWORD
  pbData: Pointer;   // BYTE* optional, out
  pdwDataLen: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CryptGetProvParam';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CryptGetProvParam"
  c_CryptGetProvParam :: CUIntPtr -> Word32 -> Ptr Word8 -> Ptr Word32 -> Word32 -> IO CInt
-- hProv : UINT_PTR -> CUIntPtr
-- dwParam : DWORD -> 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 cryptgetprovparam =
  foreign "CryptGetProvParam"
    (size_t @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* hProv : UINT_PTR -> size_t *)
(* dwParam : DWORD -> 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 ("CryptGetProvParam" crypt-get-prov-param :convention :stdcall) :int32
  (h-prov :uint64)   ; UINT_PTR
  (dw-param :uint32)   ; DWORD
  (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 $CryptGetProvParam = Win32::API::More->new('ADVAPI32',
    'BOOL CryptGetProvParam(WPARAM hProv, DWORD dwParam, LPVOID pbData, LPVOID pdwDataLen, DWORD dwFlags)');
# my $ret = $CryptGetProvParam->Call($hProv, $dwParam, $pbData, $pdwDataLen, $dwFlags);
# hProv : UINT_PTR -> WPARAM
# dwParam : DWORD -> DWORD
# pbData : BYTE* optional, out -> LPVOID
# pdwDataLen : DWORD* in/out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目