ホーム › Security.Cryptography › NCryptUnprotectSecret

NCryptUnprotectSecret

関数

NCryptProtectSecretで保護されたデータを復号する。

DLLncrypt.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT NCryptUnprotectSecret(
    NCRYPT_DESCRIPTOR_HANDLE* phDescriptor,   // optional
    NCRYPT_FLAGS dwFlags,
    const BYTE* pbProtectedBlob,
    DWORD cbProtectedBlob,
    const NCRYPT_ALLOC_PARA* pMemPara,   // optional
    HWND hWnd,   // optional
    BYTE** ppbData,
    DWORD* pcbData
);

パラメーター

名前

型

方向

説明

phDescriptor

NCRYPT_DESCRIPTOR_HANDLE*

outoptional

保護記述子ハンドルへのポインター。

dwFlags

NCRYPT_FLAGS

このフラグには、0、または次の値のビット単位の OR を指定できます。

値	意味
NCRYPT_SILENT_FLAG	キーサービスプロバイダーがユーザーインターフェイスを表示しないように要求します。
NCRYPT_UNPROTECT_NO_DECRYPT	保護されたデータ BLOB のヘッダーのみをデコードします。実際の復号は行われません。

pbProtectedBlob

BYTE*

復号するデータを含むバイト配列へのポインター。

cbProtectedBlob

DWORD

pbProtectedBlob パラメーターが指すバイト配列のバイト数。

pMemPara

NCRYPT_ALLOC_PARA*

inoptional

カスタムメモリ管理関数を指定するために使用できる NCRYPT_ALLOC_PARA 構造体へのポインター。この引数を NULL に設定すると、メモリの割り当てに LocalAlloc 関数が内部的に使用されるため、アプリケーションは ppbData パラメーターが指すメモリを解放するために LocalFree を呼び出す必要があります。

hWnd

HWND

inoptional

表示するユーザーインターフェイスがある場合、その親ウィンドウへのハンドル。

ppbData

BYTE**

out

復号されたデータへのポインターを受け取る変数のアドレス。

pcbData

DWORD*

out

ppbData 変数が指す復号済みデータのサイズ (バイト単位) を格納する ULONG 変数へのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定された保護記述子でデータを復号します。

戻り値

関数の成功または失敗を示すステータスコードを返します。返される可能性のあるコードには、以下のものが含まれますが、これらに限定されません。

戻り値	説明
ERROR_SUCCESS	関数は成功しました。
NTE_BAD_FLAGS	dwFlags パラメーターには、NCRYPT_SILENT_FLAG または NCRYPT_UNPROTECT_NO_DECRYPT のみを指定できます。
NTE_INVALID_PARAMETER	pbProtectedBlob、ppbData、および pcbData の各パラメーターを NULL にすることはできません。 cbData パラメーターを 1 未満にすることはできません。

解説(Remarks)

キー、キーマテリアル、およびパスワードを復号するには、NCryptUnprotectSecret 関数を使用します。より大きなメッセージを復号するには、NCryptStreamOpenToUnprotect 関数および NCryptStreamUpdate 関数を使用します。

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

各言語での呼び出し定義

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

HRESULT NCryptUnprotectSecret(
    NCRYPT_DESCRIPTOR_HANDLE* phDescriptor,   // optional
    NCRYPT_FLAGS dwFlags,
    const BYTE* pbProtectedBlob,
    DWORD cbProtectedBlob,
    const NCRYPT_ALLOC_PARA* pMemPara,   // optional
    HWND hWnd,   // optional
    BYTE** ppbData,
    DWORD* pcbData
);

[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptUnprotectSecret(
    IntPtr phDescriptor,   // NCRYPT_DESCRIPTOR_HANDLE* optional, out
    uint dwFlags,   // NCRYPT_FLAGS
    IntPtr pbProtectedBlob,   // BYTE*
    uint cbProtectedBlob,   // DWORD
    IntPtr pMemPara,   // NCRYPT_ALLOC_PARA* optional
    IntPtr hWnd,   // HWND optional
    IntPtr ppbData,   // BYTE** out
    out uint pcbData   // DWORD* out
);

<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptUnprotectSecret(
    phDescriptor As IntPtr,   ' NCRYPT_DESCRIPTOR_HANDLE* optional, out
    dwFlags As UInteger,   ' NCRYPT_FLAGS
    pbProtectedBlob As IntPtr,   ' BYTE*
    cbProtectedBlob As UInteger,   ' DWORD
    pMemPara As IntPtr,   ' NCRYPT_ALLOC_PARA* optional
    hWnd As IntPtr,   ' HWND optional
    ppbData As IntPtr,   ' BYTE** out
    <Out> ByRef pcbData As UInteger   ' DWORD* out
) As Integer
End Function

' phDescriptor : NCRYPT_DESCRIPTOR_HANDLE* optional, out
' dwFlags : NCRYPT_FLAGS
' pbProtectedBlob : BYTE*
' cbProtectedBlob : DWORD
' pMemPara : NCRYPT_ALLOC_PARA* optional
' hWnd : HWND optional
' ppbData : BYTE** out
' pcbData : DWORD* out
Declare PtrSafe Function NCryptUnprotectSecret Lib "ncrypt" ( _
    ByVal phDescriptor As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pbProtectedBlob As LongPtr, _
    ByVal cbProtectedBlob As Long, _
    ByVal pMemPara As LongPtr, _
    ByVal hWnd As LongPtr, _
    ByVal ppbData As LongPtr, _
    ByRef pcbData As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NCryptUnprotectSecret = ctypes.windll.ncrypt.NCryptUnprotectSecret
NCryptUnprotectSecret.restype = ctypes.c_int
NCryptUnprotectSecret.argtypes = [
    ctypes.c_void_p,  # phDescriptor : NCRYPT_DESCRIPTOR_HANDLE* optional, out
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
    ctypes.POINTER(ctypes.c_ubyte),  # pbProtectedBlob : BYTE*
    wintypes.DWORD,  # cbProtectedBlob : DWORD
    ctypes.c_void_p,  # pMemPara : NCRYPT_ALLOC_PARA* optional
    wintypes.HANDLE,  # hWnd : HWND optional
    ctypes.c_void_p,  # ppbData : BYTE** out
    ctypes.POINTER(wintypes.DWORD),  # pcbData : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptUnprotectSecret = Fiddle::Function.new(
  lib['NCryptUnprotectSecret'],
  [
    Fiddle::TYPE_VOIDP,  # phDescriptor : NCRYPT_DESCRIPTOR_HANDLE* optional, out
    -Fiddle::TYPE_INT,  # dwFlags : NCRYPT_FLAGS
    Fiddle::TYPE_VOIDP,  # pbProtectedBlob : BYTE*
    -Fiddle::TYPE_INT,  # cbProtectedBlob : DWORD
    Fiddle::TYPE_VOIDP,  # pMemPara : NCRYPT_ALLOC_PARA* optional
    Fiddle::TYPE_VOIDP,  # hWnd : HWND optional
    Fiddle::TYPE_VOIDP,  # ppbData : BYTE** out
    Fiddle::TYPE_VOIDP,  # pcbData : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ncrypt")]
extern "system" {
    fn NCryptUnprotectSecret(
        phDescriptor: *mut *mut core::ffi::c_void,  // NCRYPT_DESCRIPTOR_HANDLE* optional, out
        dwFlags: u32,  // NCRYPT_FLAGS
        pbProtectedBlob: *const u8,  // BYTE*
        cbProtectedBlob: u32,  // DWORD
        pMemPara: *const NCRYPT_ALLOC_PARA,  // NCRYPT_ALLOC_PARA* optional
        hWnd: *mut core::ffi::c_void,  // HWND optional
        ppbData: *mut *mut u8,  // BYTE** out
        pcbData: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptUnprotectSecret(IntPtr phDescriptor, uint dwFlags, IntPtr pbProtectedBlob, uint cbProtectedBlob, IntPtr pMemPara, IntPtr hWnd, IntPtr ppbData, out uint pcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptUnprotectSecret' -Namespace Win32 -PassThru
# $api::NCryptUnprotectSecret(phDescriptor, dwFlags, pbProtectedBlob, cbProtectedBlob, pMemPara, hWnd, ppbData, pcbData)

#uselib "ncrypt.dll"
#func global NCryptUnprotectSecret "NCryptUnprotectSecret" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; NCryptUnprotectSecret phDescriptor, dwFlags, varptr(pbProtectedBlob), cbProtectedBlob, varptr(pMemPara), hWnd, varptr(ppbData), varptr(pcbData)   ; 戻り値は stat
; phDescriptor : NCRYPT_DESCRIPTOR_HANDLE* optional, out -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "sptr"
; pbProtectedBlob : BYTE* -> "sptr"
; cbProtectedBlob : DWORD -> "sptr"
; pMemPara : NCRYPT_ALLOC_PARA* optional -> "sptr"
; hWnd : HWND optional -> "sptr"
; ppbData : BYTE** out -> "sptr"
; pcbData : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ncrypt.dll"
#cfunc global NCryptUnprotectSecret "NCryptUnprotectSecret" sptr, int, var, int, var, sptr, var, var
; res = NCryptUnprotectSecret(phDescriptor, dwFlags, pbProtectedBlob, cbProtectedBlob, pMemPara, hWnd, ppbData, pcbData)
; phDescriptor : NCRYPT_DESCRIPTOR_HANDLE* optional, out -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "int"
; pbProtectedBlob : BYTE* -> "var"
; cbProtectedBlob : DWORD -> "int"
; pMemPara : NCRYPT_ALLOC_PARA* optional -> "var"
; hWnd : HWND optional -> "sptr"
; ppbData : BYTE** out -> "var"
; pcbData : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ncrypt.dll"
#cfunc global NCryptUnprotectSecret "NCryptUnprotectSecret" sptr, int, sptr, int, sptr, sptr, sptr, sptr
; res = NCryptUnprotectSecret(phDescriptor, dwFlags, varptr(pbProtectedBlob), cbProtectedBlob, varptr(pMemPara), hWnd, varptr(ppbData), varptr(pcbData))
; phDescriptor : NCRYPT_DESCRIPTOR_HANDLE* optional, out -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "int"
; pbProtectedBlob : BYTE* -> "sptr"
; cbProtectedBlob : DWORD -> "int"
; pMemPara : NCRYPT_ALLOC_PARA* optional -> "sptr"
; hWnd : HWND optional -> "sptr"
; ppbData : BYTE** out -> "sptr"
; pcbData : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。