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

NCryptCreateClaim

関数
対象キーに関するクレーム(証明)を作成する。
DLLncrypt.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT NCryptCreateClaim(
    NCRYPT_KEY_HANDLE hSubjectKey,   // optional
    NCRYPT_KEY_HANDLE hAuthorityKey,   // optional
    DWORD dwClaimType,
    BCryptBufferDesc* pParameterList,   // optional
    BYTE* pbClaimBlob,   // optional
    DWORD cbClaimBlob,
    DWORD* pcbResult,
    DWORD dwFlags
);

パラメーター

名前方向説明
hSubjectKeyNCRYPT_KEY_HANDLEinoptionalクレームの作成対象となるサブジェクトキーのハンドル。
hAuthorityKeyNCRYPT_KEY_HANDLEinoptionalクレームの基になる権限キーのハンドル。
dwClaimTypeDWORDinクレームの種類。
pParameterListBCryptBufferDesc*inoptional省略可能なパラメーターリスト。
pbClaimBlobBYTE*outoptional作成されたクレーム blob の出力。
cbClaimBlobDWORDinpbClaimBlob バッファーのサイズ (バイト単位)。
pcbResultDWORD*out作成されたクレーム blob の出力。
dwFlagsDWORDin現在のところ、定義されているフラグはありません。dwFlags パラメーターには 0 を設定してください。

戻り値の型: HRESULT

公式ドキュメント

キーの構成証明クレームを作成します。

戻り値

関数の成功または失敗を示すステータスコードを返します。

解説(Remarks)

仮想化ベースのセキュリティ (VBS) を使用した秘密キーの保護/構成証明

メモ

VBS フラグに関する情報は、商業的にリリースされる前に大幅に変更される可能性があるプレリリース製品に関するものです。Microsoft は、ここで提供される情報について、明示または黙示を問わず、いかなる保証も行いません。

この API は、VBS キー保護 (VBS を使用して秘密キーを保護/構成証明する Windows モジュール) に基づくセキュリティキーの高度な構成証明を可能にします。セキュリティキーの構成証明は、このキーがアンカーキー (構成証明キーとも呼ばれます) に関連付けられていることを証明します。この機能は、コンテキスト外のキーの使用を制限することで、異なるエンティティ間の通信のセキュリティレベルを高める可能性があります。

この API は、VBS キー保護における構成証明キーに基づく構成証明クレームの作成と検証をサポートするための新しいフラグを定義します。

この API に対して定義されている dwClaimType の種類は次のとおりです:

Claim Type 説明
NCRYPT_CLAIM_VBS_ROOT この種類は、生成されたクレームが VBS ルートキーによって生成されたことを示します。
NCRYPT_CLAIM_VBS_IDENTITY この種類は、生成されたクレームが VBS の識別/構成証明によって生成されたことを示します。これは、クレームが構成証明フラグ NCRYPT_ALLOW_KEY_ATTESTATION_FLAG で昇格された VBS キーによって生成されることを意味します (詳細は後述)。

構成証明クレームを作成する際に pParameterList バッファーに設定するバッファーの種類は次のとおりです:

[!div class="mx-tdBreakAll"]

Buffer Type 説明
NCRYPTBUFFER_ATTESTATION_STATEMENT_SIGNATURE_HASH NCryptCreateClaim で構成証明クレームを作成する際にパラメーターバッファーに設定するバッファーの種類。これは NCRYPT_CLAIM_VBS_IDENTITY クレームでは必須のパラメーター型です。

このパラメーターは、構成証明クレームの作成を通じて使用されるハッシュ関数の種類を構成します。このパラメーターの値は ncrypt.h で定義されています (CNG Algorithm Identifiers の定数と同様です):

#define NCRYPT_SHA1_ALGORITHM BCRYPT_SHA1_ALGORITHM
#define NCRYPT_SHA256_ALGORITHM BCRYPT_SHA256_ALGORITHM
#define NCRYPT_SHA384_ALGORITHM BCRYPT_SHA384_ALGORITHM
#define NCRYPT_SHA512_ALGORITHM BCRYPT_SHA512_ALGORITHM
NCRYPTBUFFER_ATTESTATION_STATEMENT_SIGNATURE_PADDING_SCHEME NCryptCreateClaim で構成証明クレームを作成する際にパラメーターバッファーに設定するバッファーの種類。作成される NCRYPT_CLAIM_VBS_IDENTITY クレーム内の構成証明キーが RSA キーである場合に必須のパラメーターです。

このパラメーターは、構成証明クレームの作成を通じて使用される署名関数のパディングスキームを構成します。このパラメーターに指定できる値は bcrypt.h で定義されています (NCryptSignHashdwFlags 定数と同様です):

#define BCRYPT_PAD_PSS 0x00000008
NCRYPTBUFFER_ATTESTATION_STATEMENT_SIGNATURE_PADDING_ALGO NCryptCreateClaim で構成証明クレームを作成する際にパラメーターバッファーに設定する新しいバッファーの種類。作成される NCRYPT_CLAIM_VBS_IDENTITY クレーム内の構成証明キーが RSA キーである場合に必須のパラメーターです。このパラメーターは、パディングの作成に使用する暗号アルゴリズムを識別する null 終端の Unicode 文字列へのポインターです。このアルゴリズムはハッシュアルゴリズムでなければなりません。このパラメーターの値は ncrypt.h で定義されています (CNG Algorithm Identifiers の定数と同様です):

#define NCRYPT_SHA1_ALGORITHM BCRYPT_SHA1_ALGORITHM
#define NCRYPT_SHA256_ALGORITHM BCRYPT_SHA256_ALGORITHM
#define NCRYPT_SHA384_ALGORITHM BCRYPT_SHA384_ALGORITHM
#define NCRYPT_SHA512_ALGORITHM BCRYPT_SHA512_ALGORITHM
NCRYPTBUFFER_ATTESTATION_STATEMENT_SIGNATURE_PADDING_SALT_SIZE NCryptCreateClaim で構成証明クレームを作成する際にパラメーターバッファーに設定する新しいバッファーの種類。作成される NCRYPT_CLAIM_VBS_IDENTITY クレーム内の構成証明キーが RSA キーである場合に必須のパラメーターです。

このパラメーターは、パディングに使用するランダムソルトのサイズ (バイト単位) を表します。
NCRYPTBUFFER_ATTESTATION_STATEMENT_NONCE NCryptCreateClaim で構成証明クレームを作成する際にパラメーターバッファーに設定するバッファーの種類。このパラメーターは NCRYPTBUFFER_CLAIM_KEYATTESTATION_NONCE のエイリアスです。

この例は、新しい API フラグ NCRYPT_ALLOW_KEY_ATTESTATION_FLAG の使用方法を示します。さらに、クレーム作成のための nonce 値は NCRYPTBUFFER_ATTESTATION_STATEMENT_NONCE パラメーター型によって設定されます。

この例は、次の主要なステップで構成されます:

  1. 新しい構成証明キーが作成されます。このキーは API 関数 NCryptSetProperty を使用して特殊化されます。構成証明の生成は署名キーに基づきます。
  2. さらなる構成証明のためにクレームが作成されます。このクレームは構成証明キーおよび組み込みの VBS キーに関連付けられます。クレームは、構成証明キーを指定することで NCryptVerifyClaim で検証できます。
  3. メモリリークを避けるために、構成証明キーオブジェクトが解放されます。
// Create an attestation/identity key. This function is invoked in the main code flow below.
NCRYPT_KEY_HANDLE CreateAttestationKey(NCRYPT_PROV_HANDLE provider)
{

    NCRYPT_KEY_HANDLE attestationKey = NULL;
    HRESULT hr;

    if (FAILED(hr = NCryptCreatePersistedKey(
                    provider,
                    &attestationKey,
                    BCRYPT_RSA_ALGORITHM,
                    L"AttestationKey", // a unique name for the attestation key in the key store
                    0, //dwLegacyKeySpec, not used
                    NCRYPT_REQUIRE_VBS_FLAG/*This flag targets VBS */)))
    {
        wprintf(L"Error creating an Attestation Identity Key with NCryptCreatePersistedKey(): 0x%X\n", hr);
        goto cleanup;
    }

    // This is a new flag. It’s used to enable the capability in an attestation key.
    DWORD keyUsagePolicy = NCRYPT_ALLOW_KEY_ATTESTATION_FLAG;
    if (FAILED(hr = NCryptSetProperty(
                    attestationKey,
                    NCRYPT_KEY_USAGE_PROPERTY,
                    (PUCHAR)&keyUsagePolicy,
                    sizeof(keyUsagePolicy),
                    0 /*dwFlags*/)))
    {
        wprintf(L"Error setting property with NCryptSetProperty (): 0x%X\n", hr);
        goto cleanup;
    }

    DWORD keySizeBits = 2048; // minimum allowed RSA key size
    if (FAILED(hr = NCryptSetProperty(
                    attestationKey,
                    NCRYPT_LENGTH_PROPERTY,
                    (PUCHAR)&keySizeBits,
                    sizeof(keySizeBits),
                    0 /*dwFlags*/)))
    {
        wprintf(L"Error setting property with NCryptSetProperty (): 0x%X\n", hr);
        goto cleanup;
    }
    
    if (FAILED(hr = NCryptFinalizeKey(attestationKey, 0 /*dwFlags*/)))
    {
        wprintf(L"Error finalizing key with NCryptFinalizeKey (): 0x%X\n", hr);
        goto cleanup;
    }

    return attestationKey;
cleanup:
    if (attestationKey != NULL)
    {
        NCryptFreeObject(attestationKey);
    }

    return NULL;
}

HRESULT CreateAttestation()
{
    HRESULT hr = S_OK;
    NCRYPT_PROV_HANDLE provider = NULL;
    
    BYTE nonce[] = "TheSuperSecretNonce";
    // This way of setting parameters is an existent pattern for NCrypt APIs
    NCryptBuffer paramBuffers[] =
    {
        { sizeof(nonce), NCRYPTBUFFER_ATTESTATION_STATEMENT_NONCE, (PBYTE)&nonce },
    };
    NCryptBufferDesc params = { NCRYPTBUFFER_VERSION, ARRAYSIZE(paramBuffers), paramBuffers };
    
    if (FAILED(hr = NCryptOpenStorageProvider(&provider, MS_KEY_STORAGE_PROVIDER, 0)))
    {
        wprintf(L"Error opening storage provider in NCryptOpenStorageProvider: 0x%X\n", hr);
        goto cleanup;
    }
    
    // Create a VBS attestation key
    NCRYPT_KEY_HANDLE attestationKey = CreateAttestationKey(provider);
    if (attestationKey == NULL)
    {
        hr = E_ABORT;
        goto cleanup;
    }
    
    DWORD bytesWritten = 0;
    
    if (FAILED(hr = NCryptCreateClaim(
                    attestationKey, // key that is being attested here and may attest other keys.
                    NULL, // implies that IDKS (VBS root signing key) will be used.
                    NCRYPT_CLAIM_VBS_ROOT, // used to attest a key with IDKS (VBS root signing key).
                    &params, // parameters list
                    NULL, // getting the size
                    0, // getting the size
                    &bytesWritten,
                    0 /*dwFlags*/)))
    {
        wprintf(L"Error creating claim with NCryptCreateClaim (): 0x%X\n", hr);
        goto cleanup;
    }
    
    DWORD claimBufferSize = bytesWritten;
    
    PBYTE claimBuffer = (PBYTE) HeapAlloc(GetProcessHeap(), 0,claimBufferSize);
    if (NULL == claimBuffer)
    {
        hr = HRESULT_FROM_WIN32(GetLastError());
        wprintf(L"Error allocating buffer for the claim: 0x%X\n", hr);
        goto cleanup;
    }
    
    bytesWritten = 0;
    if (FAILED(hr = NCryptCreateClaim(
                    attestationKey, // key that is being attested here and may attest other keys.
                    NULL, //implies that IDKS (VBS root signing key) will be used.
                    NCRYPT_CLAIM_VBS_ROOT, // used to attest with IDKS (VBS root signing key).
                    &params, // parameters list
                    claimBuffer,
                    claimBufferSize,
                    &bytesWritten,
                    0)))
    {
        wprintf(L"Error creating claim with NCryptCreateClaim (): 0x%X\n", hr);
        goto cleanup;
    }
    
    wprintf(L"The claim is created successfully. It may be shared with the verifier side.\n");

cleanup:
    if (provider != NULL)
    {
        NCryptFreeObject(provider);
    }
    if (attestationKey != NULL)
    {
        NCryptFreeObject(attestationKey);
    }
    if (claimBuffer)
    {
        HeapFree(GetProcessHeap(), 0, claimBuffer);
    }
    
    return hr;
}

次の例は、汎用の暗号キーと、それに関連付けられた構成証明クレームを作成するための新しい API パラメーターの使用方法を示します。この汎用キーは、構成証明クレームの生成に使用されます。

クレーム作成のためのハッシュアルゴリズムの種類とパディングは、それぞれ NCRYPTBUFFER_ATTESTATION_STATEMENT_SIGNATURE_HASH および NCRYPTBUFFER_ATTESTATION_STATEMENT_SIGNATURE_PADDING_[SCHEME/ALGO/SALT_SIZE] パラメーターに設定されます。

次の点に注意してください:

このクレームにより、汎用キーが構成証明キーに関連付けられていることを検証できます。

//
HRESULT hr = S_OK;
NCRYPT_PROV_HANDLE provider = NULL;

if (FAILED(hr = NCryptOpenStorageProvider(&provider, MS_KEY_STORAGE_PROVIDER, 0)))
{
    wprintf(L"Error opening storage provider in NCryptOpenStorageProvider: 0x%X\n", hr);
    goto cleanup;
}

NCRYPT_KEY_HANDLE attestationKey = NULL;

// Open the attestation key, created in CreateAttestationKey(), see previous example
if (FAILED(hr = NCryptOpenKey(
                provider,
                &attestationKey,
                L"AttestationKey",
                0, //dwLegacyKeySpec, not used
                0 ,/* dwFlags */)))
{
    wprintf(L"Error openning the attestation key with NCryptOpenKey (): 0x%X\n", hr);
    goto cleanup;
}

NCRYPT_KEY_HANDLE tokenKey = NULL; // Token key that is bound to the security token

// Create VBS token (general purpose) key
if (FAILED(hr = NCryptCreatePersistedKey(
                provider,
                &tokenKey,
                BCRYPT_RSA_ALGORITHM,
                L"TokenKey",
                0, //dwLegacyKeySpec, not used
                NCRYPT_REQUIRE_VBS_FLAG /*This flag targets VBS*/)))
{
    wprintf(L"Error creating an token key with NCryptCreatePersistedKey(): 0x%X\n", hr);
    goto cleanup;
}

DWORD keySizeBits = 2048;
if (FAILED(hr = NCryptSetProperty(
                tokenKey,
                NCRYPT_LENGTH_PROPERTY,
                (PUCHAR)&keySizeBits,
                sizeof(keySizeBits),
                0 /*dwFlags*/)))
{
    wprintf(L"Error setting property with NCryptSetProperty (): 0x%X\n", hr);
    goto cleanup;
}

if (FAILED(hr = NCryptFinalizeKey(tokenKey, 0 /*dwFlags*/)))
{
    wprintf(L"Error finalizing key with NCryptFinalizeKey (): 0x%X\n", hr);
    goto cleanup;
}

DWORD bytesWritten = 0;

DWORD hashAlgoType; // This is a new flag. It’s used to set type of hash algorithm of the claim// Set specific hash function type to produce the claim
wchar_t pHashAlgo[] = NCRYPT_SHA512_ALGORITHM;
// Set specific padding scheme for hash function to produce the claim
ULONG paddingScheme = BCRYPT_PAD_PSS;
wchar_t pPaddingAlgo[] = NCRYPT_SHA256_ALGORITHM;
ULONG paddingSalt = 345;

// This way of setting parameters is an existent pattern for NCrypt APIs
NCryptBuffer paramBuffers[] =
{
    { sizeof(NCRYPT_SHA512_ALGORITHM), NCRYPTBUFFER_ATTESTATION_STATEMENT_SIGNATURE_HASH, (PBYTE)&pHashAlgo },
    { sizeof(paddingScheme), NCRYPTBUFFER_ATTESTATION_STATEMENT_SIGNATURE_PADDING_SCHEME , (PBYTE)&paddingScheme },
    { sizeof(NCRYPT_SHA256_ALGORITHM), NCRYPTBUFFER_ATTESTATION_STATEMENT_SIGNATURE_PADDING_ALGO, (PBYTE)&pPaddingAlgo },
    { sizeof(paddingSalt, NCRYPTBUFFER_ATTESTATION_STATEMENT_SIGNATURE_PADDING_SALT_SIZE, (PBYTE)&paddingSalt }
};
NCryptBufferDesc params = { NCRYPTBUFFER_VERSION, ARRAYSIZE(paramBuffers), paramBuffers };

if (FAILED(hr = NCryptCreateClaim(
                tokenKey, // key that is being attested
                attestationKey,
                NCRYPT_CLAIM_VBS_IDENTITY, // attest general-purpose key with an attestation (identity) key.
                &params, // parameters list
                NULL, // getting the size
                0, // getting the size
                &bytesWritten,
                0 /*dwFlags*/)))
{
    wprintf(L"Error creating claim with NCryptCreateClaim (): 0x%X\n", hr);
    goto cleanup;
}

DWORD claimBufferSize = bytesWritten;

PBYTE claimBuffer = (PBYTE) HeapAlloc(GetProcessHeap(), 0,claimBufferSize);
if (NULL == claimBuffer)
{
    hr = HRESULT_FROM_WIN32(GetLastError());
    wprintf(L"Error allocating buffer for the claim: 0x%X\n", hr);
    goto cleanup;
}
bytesWritten = 0;

if (FAILED(hr = NCryptCreateClaim(
                tokenKey, // key that is being attested
                attestationKey, // we assume that it is already initialized
                NCRYPT_CLAIM_VBS_IDENTITY, // attest general-purpose key with an attestation (identity) key
                &params,
                claimBuffer,
                claimBufferSize,
                &bytesWritten,
                0)))
{
    wprintf(L"Error creating claim with NCryptCreateClaim (): 0x%X\n", hr);
    goto cleanup;
}

wprintf(L"The claim is created successfully. It may be shared with the verifier side.\n");

cleanup:
    if (provider != NULL)
    {
    NCryptFreeObject(provider);
    }
    if (tokenKey != NULL)
    {
    NCryptFreeObject(tokenKey);
    }
    if (attestationKey != NULL)
    {
    NCryptDeleteKey(attestationKey);
    }
    if (claimBuffer)
    {
    HeapFree(GetProcessHeap(), 0, claimBuffer);
    }
    
return hr;
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT NCryptCreateClaim(
    NCRYPT_KEY_HANDLE hSubjectKey,   // optional
    NCRYPT_KEY_HANDLE hAuthorityKey,   // optional
    DWORD dwClaimType,
    BCryptBufferDesc* pParameterList,   // optional
    BYTE* pbClaimBlob,   // optional
    DWORD cbClaimBlob,
    DWORD* pcbResult,
    DWORD dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptCreateClaim(
    UIntPtr hSubjectKey,   // NCRYPT_KEY_HANDLE optional
    UIntPtr hAuthorityKey,   // NCRYPT_KEY_HANDLE optional
    uint dwClaimType,   // DWORD
    IntPtr pParameterList,   // BCryptBufferDesc* optional
    IntPtr pbClaimBlob,   // BYTE* optional, out
    uint cbClaimBlob,   // DWORD
    out uint pcbResult,   // DWORD* out
    uint dwFlags   // DWORD
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptCreateClaim(
    hSubjectKey As UIntPtr,   ' NCRYPT_KEY_HANDLE optional
    hAuthorityKey As UIntPtr,   ' NCRYPT_KEY_HANDLE optional
    dwClaimType As UInteger,   ' DWORD
    pParameterList As IntPtr,   ' BCryptBufferDesc* optional
    pbClaimBlob As IntPtr,   ' BYTE* optional, out
    cbClaimBlob As UInteger,   ' DWORD
    <Out> ByRef pcbResult As UInteger,   ' DWORD* out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hSubjectKey : NCRYPT_KEY_HANDLE optional
' hAuthorityKey : NCRYPT_KEY_HANDLE optional
' dwClaimType : DWORD
' pParameterList : BCryptBufferDesc* optional
' pbClaimBlob : BYTE* optional, out
' cbClaimBlob : DWORD
' pcbResult : DWORD* out
' dwFlags : DWORD
Declare PtrSafe Function NCryptCreateClaim Lib "ncrypt" ( _
    ByVal hSubjectKey As LongPtr, _
    ByVal hAuthorityKey As LongPtr, _
    ByVal dwClaimType As Long, _
    ByVal pParameterList As LongPtr, _
    ByVal pbClaimBlob As LongPtr, _
    ByVal cbClaimBlob As Long, _
    ByRef pcbResult 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

NCryptCreateClaim = ctypes.windll.ncrypt.NCryptCreateClaim
NCryptCreateClaim.restype = ctypes.c_int
NCryptCreateClaim.argtypes = [
    ctypes.c_size_t,  # hSubjectKey : NCRYPT_KEY_HANDLE optional
    ctypes.c_size_t,  # hAuthorityKey : NCRYPT_KEY_HANDLE optional
    wintypes.DWORD,  # dwClaimType : DWORD
    ctypes.c_void_p,  # pParameterList : BCryptBufferDesc* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbClaimBlob : BYTE* optional, out
    wintypes.DWORD,  # cbClaimBlob : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbResult : DWORD* out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptCreateClaim = Fiddle::Function.new(
  lib['NCryptCreateClaim'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hSubjectKey : NCRYPT_KEY_HANDLE optional
    Fiddle::TYPE_UINTPTR_T,  # hAuthorityKey : NCRYPT_KEY_HANDLE optional
    -Fiddle::TYPE_INT,  # dwClaimType : DWORD
    Fiddle::TYPE_VOIDP,  # pParameterList : BCryptBufferDesc* optional
    Fiddle::TYPE_VOIDP,  # pbClaimBlob : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbClaimBlob : DWORD
    Fiddle::TYPE_VOIDP,  # pcbResult : DWORD* out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "ncrypt")]
extern "system" {
    fn NCryptCreateClaim(
        hSubjectKey: usize,  // NCRYPT_KEY_HANDLE optional
        hAuthorityKey: usize,  // NCRYPT_KEY_HANDLE optional
        dwClaimType: u32,  // DWORD
        pParameterList: *mut BCryptBufferDesc,  // BCryptBufferDesc* optional
        pbClaimBlob: *mut u8,  // BYTE* optional, out
        cbClaimBlob: u32,  // DWORD
        pcbResult: *mut u32,  // DWORD* out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptCreateClaim(UIntPtr hSubjectKey, UIntPtr hAuthorityKey, uint dwClaimType, IntPtr pParameterList, IntPtr pbClaimBlob, uint cbClaimBlob, out uint pcbResult, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptCreateClaim' -Namespace Win32 -PassThru
# $api::NCryptCreateClaim(hSubjectKey, hAuthorityKey, dwClaimType, pParameterList, pbClaimBlob, cbClaimBlob, pcbResult, dwFlags)
#uselib "ncrypt.dll"
#func global NCryptCreateClaim "NCryptCreateClaim" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; NCryptCreateClaim hSubjectKey, hAuthorityKey, dwClaimType, varptr(pParameterList), varptr(pbClaimBlob), cbClaimBlob, varptr(pcbResult), dwFlags   ; 戻り値は stat
; hSubjectKey : NCRYPT_KEY_HANDLE optional -> "sptr"
; hAuthorityKey : NCRYPT_KEY_HANDLE optional -> "sptr"
; dwClaimType : DWORD -> "sptr"
; pParameterList : BCryptBufferDesc* optional -> "sptr"
; pbClaimBlob : BYTE* optional, out -> "sptr"
; cbClaimBlob : DWORD -> "sptr"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ncrypt.dll"
#cfunc global NCryptCreateClaim "NCryptCreateClaim" sptr, sptr, int, var, var, int, var, int
; res = NCryptCreateClaim(hSubjectKey, hAuthorityKey, dwClaimType, pParameterList, pbClaimBlob, cbClaimBlob, pcbResult, dwFlags)
; hSubjectKey : NCRYPT_KEY_HANDLE optional -> "sptr"
; hAuthorityKey : NCRYPT_KEY_HANDLE optional -> "sptr"
; dwClaimType : DWORD -> "int"
; pParameterList : BCryptBufferDesc* optional -> "var"
; pbClaimBlob : BYTE* optional, out -> "var"
; cbClaimBlob : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT NCryptCreateClaim(NCRYPT_KEY_HANDLE hSubjectKey, NCRYPT_KEY_HANDLE hAuthorityKey, DWORD dwClaimType, BCryptBufferDesc* pParameterList, BYTE* pbClaimBlob, DWORD cbClaimBlob, DWORD* pcbResult, DWORD dwFlags)
#uselib "ncrypt.dll"
#cfunc global NCryptCreateClaim "NCryptCreateClaim" intptr, intptr, int, var, var, int, var, int
; res = NCryptCreateClaim(hSubjectKey, hAuthorityKey, dwClaimType, pParameterList, pbClaimBlob, cbClaimBlob, pcbResult, dwFlags)
; hSubjectKey : NCRYPT_KEY_HANDLE optional -> "intptr"
; hAuthorityKey : NCRYPT_KEY_HANDLE optional -> "intptr"
; dwClaimType : DWORD -> "int"
; pParameterList : BCryptBufferDesc* optional -> "var"
; pbClaimBlob : BYTE* optional, out -> "var"
; cbClaimBlob : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procNCryptCreateClaim = ncrypt.NewProc("NCryptCreateClaim")
)

// hSubjectKey (NCRYPT_KEY_HANDLE optional), hAuthorityKey (NCRYPT_KEY_HANDLE optional), dwClaimType (DWORD), pParameterList (BCryptBufferDesc* optional), pbClaimBlob (BYTE* optional, out), cbClaimBlob (DWORD), pcbResult (DWORD* out), dwFlags (DWORD)
r1, _, err := procNCryptCreateClaim.Call(
	uintptr(hSubjectKey),
	uintptr(hAuthorityKey),
	uintptr(dwClaimType),
	uintptr(pParameterList),
	uintptr(pbClaimBlob),
	uintptr(cbClaimBlob),
	uintptr(pcbResult),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function NCryptCreateClaim(
  hSubjectKey: NativeUInt;   // NCRYPT_KEY_HANDLE optional
  hAuthorityKey: NativeUInt;   // NCRYPT_KEY_HANDLE optional
  dwClaimType: DWORD;   // DWORD
  pParameterList: Pointer;   // BCryptBufferDesc* optional
  pbClaimBlob: Pointer;   // BYTE* optional, out
  cbClaimBlob: DWORD;   // DWORD
  pcbResult: Pointer;   // DWORD* out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ncrypt.dll' name 'NCryptCreateClaim';
result := DllCall("ncrypt\NCryptCreateClaim"
    , "UPtr", hSubjectKey   ; NCRYPT_KEY_HANDLE optional
    , "UPtr", hAuthorityKey   ; NCRYPT_KEY_HANDLE optional
    , "UInt", dwClaimType   ; DWORD
    , "Ptr", pParameterList   ; BCryptBufferDesc* optional
    , "Ptr", pbClaimBlob   ; BYTE* optional, out
    , "UInt", cbClaimBlob   ; DWORD
    , "Ptr", pcbResult   ; DWORD* out
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: HRESULT
●NCryptCreateClaim(hSubjectKey, hAuthorityKey, dwClaimType, pParameterList, pbClaimBlob, cbClaimBlob, pcbResult, dwFlags) = DLL("ncrypt.dll", "int NCryptCreateClaim(int, int, dword, void*, void*, dword, void*, dword)")
# 呼び出し: NCryptCreateClaim(hSubjectKey, hAuthorityKey, dwClaimType, pParameterList, pbClaimBlob, cbClaimBlob, pcbResult, dwFlags)
# hSubjectKey : NCRYPT_KEY_HANDLE optional -> "int"
# hAuthorityKey : NCRYPT_KEY_HANDLE optional -> "int"
# dwClaimType : DWORD -> "dword"
# pParameterList : BCryptBufferDesc* optional -> "void*"
# pbClaimBlob : BYTE* optional, out -> "void*"
# cbClaimBlob : DWORD -> "dword"
# pcbResult : DWORD* out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ncrypt" fn NCryptCreateClaim(
    hSubjectKey: usize, // NCRYPT_KEY_HANDLE optional
    hAuthorityKey: usize, // NCRYPT_KEY_HANDLE optional
    dwClaimType: u32, // DWORD
    pParameterList: [*c]BCryptBufferDesc, // BCryptBufferDesc* optional
    pbClaimBlob: [*c]u8, // BYTE* optional, out
    cbClaimBlob: u32, // DWORD
    pcbResult: [*c]u32, // DWORD* out
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc NCryptCreateClaim(
    hSubjectKey: uint,  # NCRYPT_KEY_HANDLE optional
    hAuthorityKey: uint,  # NCRYPT_KEY_HANDLE optional
    dwClaimType: uint32,  # DWORD
    pParameterList: ptr BCryptBufferDesc,  # BCryptBufferDesc* optional
    pbClaimBlob: ptr uint8,  # BYTE* optional, out
    cbClaimBlob: uint32,  # DWORD
    pcbResult: ptr uint32,  # DWORD* out
    dwFlags: uint32  # DWORD
): int32 {.importc: "NCryptCreateClaim", stdcall, dynlib: "ncrypt.dll".}
pragma(lib, "ncrypt");
extern(Windows)
int NCryptCreateClaim(
    size_t hSubjectKey,   // NCRYPT_KEY_HANDLE optional
    size_t hAuthorityKey,   // NCRYPT_KEY_HANDLE optional
    uint dwClaimType,   // DWORD
    BCryptBufferDesc* pParameterList,   // BCryptBufferDesc* optional
    ubyte* pbClaimBlob,   // BYTE* optional, out
    uint cbClaimBlob,   // DWORD
    uint* pcbResult,   // DWORD* out
    uint dwFlags   // DWORD
);
ccall((:NCryptCreateClaim, "ncrypt.dll"), stdcall, Int32,
      (Csize_t, Csize_t, UInt32, Ptr{BCryptBufferDesc}, Ptr{UInt8}, UInt32, Ptr{UInt32}, UInt32),
      hSubjectKey, hAuthorityKey, dwClaimType, pParameterList, pbClaimBlob, cbClaimBlob, pcbResult, dwFlags)
# hSubjectKey : NCRYPT_KEY_HANDLE optional -> Csize_t
# hAuthorityKey : NCRYPT_KEY_HANDLE optional -> Csize_t
# dwClaimType : DWORD -> UInt32
# pParameterList : BCryptBufferDesc* optional -> Ptr{BCryptBufferDesc}
# pbClaimBlob : BYTE* optional, out -> Ptr{UInt8}
# cbClaimBlob : DWORD -> UInt32
# pcbResult : DWORD* out -> Ptr{UInt32}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t NCryptCreateClaim(
    uintptr_t hSubjectKey,
    uintptr_t hAuthorityKey,
    uint32_t dwClaimType,
    void* pParameterList,
    uint8_t* pbClaimBlob,
    uint32_t cbClaimBlob,
    uint32_t* pcbResult,
    uint32_t dwFlags);
]]
local ncrypt = ffi.load("ncrypt")
-- ncrypt.NCryptCreateClaim(hSubjectKey, hAuthorityKey, dwClaimType, pParameterList, pbClaimBlob, cbClaimBlob, pcbResult, dwFlags)
-- hSubjectKey : NCRYPT_KEY_HANDLE optional
-- hAuthorityKey : NCRYPT_KEY_HANDLE optional
-- dwClaimType : DWORD
-- pParameterList : BCryptBufferDesc* optional
-- pbClaimBlob : BYTE* optional, out
-- cbClaimBlob : DWORD
-- pcbResult : DWORD* out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ncrypt.dll');
const NCryptCreateClaim = lib.func('__stdcall', 'NCryptCreateClaim', 'int32_t', ['uintptr_t', 'uintptr_t', 'uint32_t', 'void *', 'uint8_t *', 'uint32_t', 'uint32_t *', 'uint32_t']);
// NCryptCreateClaim(hSubjectKey, hAuthorityKey, dwClaimType, pParameterList, pbClaimBlob, cbClaimBlob, pcbResult, dwFlags)
// hSubjectKey : NCRYPT_KEY_HANDLE optional -> 'uintptr_t'
// hAuthorityKey : NCRYPT_KEY_HANDLE optional -> 'uintptr_t'
// dwClaimType : DWORD -> 'uint32_t'
// pParameterList : BCryptBufferDesc* optional -> 'void *'
// pbClaimBlob : BYTE* optional, out -> 'uint8_t *'
// cbClaimBlob : DWORD -> 'uint32_t'
// pcbResult : DWORD* out -> 'uint32_t *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ncrypt.dll", {
  NCryptCreateClaim: { parameters: ["usize", "usize", "u32", "pointer", "pointer", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.NCryptCreateClaim(hSubjectKey, hAuthorityKey, dwClaimType, pParameterList, pbClaimBlob, cbClaimBlob, pcbResult, dwFlags)
// hSubjectKey : NCRYPT_KEY_HANDLE optional -> "usize"
// hAuthorityKey : NCRYPT_KEY_HANDLE optional -> "usize"
// dwClaimType : DWORD -> "u32"
// pParameterList : BCryptBufferDesc* optional -> "pointer"
// pbClaimBlob : BYTE* optional, out -> "pointer"
// cbClaimBlob : DWORD -> "u32"
// pcbResult : DWORD* out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t NCryptCreateClaim(
    size_t hSubjectKey,
    size_t hAuthorityKey,
    uint32_t dwClaimType,
    void* pParameterList,
    uint8_t* pbClaimBlob,
    uint32_t cbClaimBlob,
    uint32_t* pcbResult,
    uint32_t dwFlags);
C, "ncrypt.dll");
// $ffi->NCryptCreateClaim(hSubjectKey, hAuthorityKey, dwClaimType, pParameterList, pbClaimBlob, cbClaimBlob, pcbResult, dwFlags);
// hSubjectKey : NCRYPT_KEY_HANDLE optional
// hAuthorityKey : NCRYPT_KEY_HANDLE optional
// dwClaimType : DWORD
// pParameterList : BCryptBufferDesc* optional
// pbClaimBlob : BYTE* optional, out
// cbClaimBlob : DWORD
// pcbResult : DWORD* 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 Ncrypt extends StdCallLibrary {
    Ncrypt INSTANCE = Native.load("ncrypt", Ncrypt.class);
    int NCryptCreateClaim(
        long hSubjectKey,   // NCRYPT_KEY_HANDLE optional
        long hAuthorityKey,   // NCRYPT_KEY_HANDLE optional
        int dwClaimType,   // DWORD
        Pointer pParameterList,   // BCryptBufferDesc* optional
        byte[] pbClaimBlob,   // BYTE* optional, out
        int cbClaimBlob,   // DWORD
        IntByReference pcbResult,   // DWORD* out
        int dwFlags   // DWORD
    );
}
@[Link("ncrypt")]
lib Libncrypt
  fun NCryptCreateClaim = NCryptCreateClaim(
    hSubjectKey : LibC::SizeT,   # NCRYPT_KEY_HANDLE optional
    hAuthorityKey : LibC::SizeT,   # NCRYPT_KEY_HANDLE optional
    dwClaimType : UInt32,   # DWORD
    pParameterList : BCryptBufferDesc*,   # BCryptBufferDesc* optional
    pbClaimBlob : UInt8*,   # BYTE* optional, out
    cbClaimBlob : UInt32,   # DWORD
    pcbResult : UInt32*,   # DWORD* 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 NCryptCreateClaimNative = Int32 Function(UintPtr, UintPtr, Uint32, Pointer<Void>, Pointer<Uint8>, Uint32, Pointer<Uint32>, Uint32);
typedef NCryptCreateClaimDart = int Function(int, int, int, Pointer<Void>, Pointer<Uint8>, int, Pointer<Uint32>, int);
final NCryptCreateClaim = DynamicLibrary.open('ncrypt.dll')
    .lookupFunction<NCryptCreateClaimNative, NCryptCreateClaimDart>('NCryptCreateClaim');
// hSubjectKey : NCRYPT_KEY_HANDLE optional -> UintPtr
// hAuthorityKey : NCRYPT_KEY_HANDLE optional -> UintPtr
// dwClaimType : DWORD -> Uint32
// pParameterList : BCryptBufferDesc* optional -> Pointer<Void>
// pbClaimBlob : BYTE* optional, out -> Pointer<Uint8>
// cbClaimBlob : DWORD -> Uint32
// pcbResult : DWORD* out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NCryptCreateClaim(
  hSubjectKey: NativeUInt;   // NCRYPT_KEY_HANDLE optional
  hAuthorityKey: NativeUInt;   // NCRYPT_KEY_HANDLE optional
  dwClaimType: DWORD;   // DWORD
  pParameterList: Pointer;   // BCryptBufferDesc* optional
  pbClaimBlob: Pointer;   // BYTE* optional, out
  cbClaimBlob: DWORD;   // DWORD
  pcbResult: Pointer;   // DWORD* out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ncrypt.dll' name 'NCryptCreateClaim';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NCryptCreateClaim"
  c_NCryptCreateClaim :: CUIntPtr -> CUIntPtr -> Word32 -> Ptr () -> Ptr Word8 -> Word32 -> Ptr Word32 -> Word32 -> IO Int32
-- hSubjectKey : NCRYPT_KEY_HANDLE optional -> CUIntPtr
-- hAuthorityKey : NCRYPT_KEY_HANDLE optional -> CUIntPtr
-- dwClaimType : DWORD -> Word32
-- pParameterList : BCryptBufferDesc* optional -> Ptr ()
-- pbClaimBlob : BYTE* optional, out -> Ptr Word8
-- cbClaimBlob : DWORD -> Word32
-- pcbResult : DWORD* out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ncryptcreateclaim =
  foreign "NCryptCreateClaim"
    (size_t @-> size_t @-> uint32_t @-> (ptr void) @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* hSubjectKey : NCRYPT_KEY_HANDLE optional -> size_t *)
(* hAuthorityKey : NCRYPT_KEY_HANDLE optional -> size_t *)
(* dwClaimType : DWORD -> uint32_t *)
(* pParameterList : BCryptBufferDesc* optional -> (ptr void) *)
(* pbClaimBlob : BYTE* optional, out -> (ptr uint8_t) *)
(* cbClaimBlob : DWORD -> uint32_t *)
(* pcbResult : DWORD* out -> (ptr uint32_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ncrypt (t "ncrypt.dll"))
(cffi:use-foreign-library ncrypt)

(cffi:defcfun ("NCryptCreateClaim" ncrypt-create-claim :convention :stdcall) :int32
  (h-subject-key :uint64)   ; NCRYPT_KEY_HANDLE optional
  (h-authority-key :uint64)   ; NCRYPT_KEY_HANDLE optional
  (dw-claim-type :uint32)   ; DWORD
  (p-parameter-list :pointer)   ; BCryptBufferDesc* optional
  (pb-claim-blob :pointer)   ; BYTE* optional, out
  (cb-claim-blob :uint32)   ; DWORD
  (pcb-result :pointer)   ; DWORD* out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NCryptCreateClaim = Win32::API::More->new('ncrypt',
    'int NCryptCreateClaim(WPARAM hSubjectKey, WPARAM hAuthorityKey, DWORD dwClaimType, LPVOID pParameterList, LPVOID pbClaimBlob, DWORD cbClaimBlob, LPVOID pcbResult, DWORD dwFlags)');
# my $ret = $NCryptCreateClaim->Call($hSubjectKey, $hAuthorityKey, $dwClaimType, $pParameterList, $pbClaimBlob, $cbClaimBlob, $pcbResult, $dwFlags);
# hSubjectKey : NCRYPT_KEY_HANDLE optional -> WPARAM
# hAuthorityKey : NCRYPT_KEY_HANDLE optional -> WPARAM
# dwClaimType : DWORD -> DWORD
# pParameterList : BCryptBufferDesc* optional -> LPVOID
# pbClaimBlob : BYTE* optional, out -> LPVOID
# cbClaimBlob : DWORD -> DWORD
# pcbResult : DWORD* out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型