ホーム › Security.Cryptography › CryptProtectData

CryptProtectData

関数

現在のユーザーまたは機械のコンテキストでデータを暗号化保護する。

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

シグネチャ

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

BOOL CryptProtectData(
    CRYPT_INTEGER_BLOB* pDataIn,
    LPCWSTR szDataDescr,   // optional
    CRYPT_INTEGER_BLOB* pOptionalEntropy,   // optional
    void* pvReserved,   // optional
    CRYPTPROTECT_PROMPTSTRUCT* pPromptStruct,   // optional
    DWORD dwFlags,
    CRYPT_INTEGER_BLOB* pDataOut
);

パラメーター

名前型方向説明

pDataIn CRYPT_INTEGER_BLOB* in 暗号化する plaintext(平文)を含む DATA_BLOB 構造体へのポインターです。

szDataDescr LPCWSTR inoptional 暗号化するデータの、人間が読める形式の説明文字列です。この説明文字列は暗号化されたデータに含められます。このパラメーターは省略可能で、NULL に設定できます。

pOptionalEntropy CRYPT_INTEGER_BLOB* inoptional データの暗号化に使用するパスワードまたはその他の追加エントロピーを含む DATA_BLOB 構造体へのポインターです。暗号化フェーズで使用した DATA_BLOB 構造体は、復号フェーズでも使用する必要があります。追加エントロピーを使用しない場合、このパラメーターは NULL に設定できます。パスワードの保護については、Handling Passwords を参照してください。

pvReserved void* optional 将来の使用のために予約されており、NULL に設定する必要があります。

pPromptStruct CRYPTPROTECT_PROMPTSTRUCT* inoptional プロンプトを表示する場所とタイミング、およびそれらのプロンプトの内容に関する情報を提供する CRYPTPROTECT_PROMPTSTRUCT 構造体へのポインターです。このパラメーターは、暗号化フェーズと復号フェーズの両方で NULL に設定できます。

dwFlags

DWORD

このパラメーターには、次のいずれかのフラグを指定できます。フラグが不要な場合、このパラメーターは 0 に設定できます。

値	意味
CRYPTPROTECT_LOCAL_MACHINE	このフラグを設定すると、暗号化されたデータが個々のユーザーではなく現在のコンピューターに関連付けられます。CryptProtectData が呼び出されたコンピューター上の任意のユーザーが、CryptUnprotectData を使用してデータを復号できます。
CRYPTPROTECT_UI_FORBIDDEN	このフラグは、ユーザーインターフェイス (UI) を表示できないリモート状況で使用されます。このフラグが設定されており、保護操作または保護解除操作のいずれかに対して UI が指定されている場合、操作は失敗し、GetLastError は ERROR_PASSWORD_RESTRICTION コードを返します。
CRYPTPROTECT_AUDIT	このフラグは、保護操作および保護解除操作に対して監査を生成します。監査ログのエントリは、szDataDescr が NULL でも空でもない場合にのみ記録されます。

pDataOut CRYPT_INTEGER_BLOB* out 暗号化されたデータを受け取る DATA_BLOB 構造体へのポインターです。DATA_BLOB 構造体の使用を終えたら、LocalFree 関数を呼び出して pbData メンバーを解放してください。

戻り値の型: BOOL

公式ドキュメント

DATA_BLOB 構造体内のデータを暗号化します。

戻り値

関数が成功すると、TRUE を返します。

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

解説(Remarks)

通常、データを暗号化したユーザーと一致するログオン credentials(資格情報)を持つユーザーのみが、そのデータを復号できます。さらに、復号は通常、データが暗号化されたコンピューター上でのみ行えます。ただし、ローミングプロファイルを持つユーザーは、ネットワーク上の別のコンピューターからデータを復号できます。

データの暗号化時に CRYPTPROTECT_LOCAL_MACHINE フラグが設定されている場合、暗号化が行われたコンピューター上の任意のユーザーがデータを復号できます。

この関数は、暗号化を実行するためにセッションキーを作成します。セッションキーは、データを復号する際に再び導出されます。

この関数はまた、データの改ざんを防ぐために、暗号化されたデータに Message Authentication Code (MAC)(キー付き整合性チェック)を追加します。

同一プロセス内またはプロセス間で一時的に使用するためにメモリを暗号化するには、CryptProtectMemory 関数を呼び出してください。

例

次の例は、DATA_BLOB 構造体内のデータの暗号化を示しています。CryptProtectData 関数は、ユーザーのログオン資格情報を使用して作成したセッションキーを用いて暗号化を行います。この関数を使用する別の例については、Example C Program: Using CryptProtectData を参照してください。

// Encrypt data from DATA_BLOB DataIn to DATA_BLOB DataOut.

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

DATA_BLOB DataIn;
DATA_BLOB DataOut;
BYTE *pbDataInput =(BYTE *)"Hello world of data protection.";
DWORD cbDataInput = strlen((char *)pbDataInput)+1;

//--------------------------------------------------------------------
// Initialize the DataIn structure.

DataIn.pbData = pbDataInput;    
DataIn.cbData = cbDataInput;

//--------------------------------------------------------------------
//  Begin protect phase. Note that the encryption key is created
//  by the function and is not passed.

if(CryptProtectData(
     &DataIn,
     L"This is the description string.", // A description string
                                         // to be included with the
                                         // encrypted data. 
     NULL,                               // Optional entropy not used.
     NULL,                               // Reserved.
     NULL,                               // Pass NULL for the 
                                         // prompt structure.
     0,
     &DataOut))
{
     printf("The encryption phase worked.\n");
     LocalFree(DataOut.pbData);
}
else
{
    printf("Encryption error using CryptProtectData.\n");
    exit(1); 
}

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

各言語での呼び出し定義

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

BOOL CryptProtectData(
    CRYPT_INTEGER_BLOB* pDataIn,
    LPCWSTR szDataDescr,   // optional
    CRYPT_INTEGER_BLOB* pOptionalEntropy,   // optional
    void* pvReserved,   // optional
    CRYPTPROTECT_PROMPTSTRUCT* pPromptStruct,   // optional
    DWORD dwFlags,
    CRYPT_INTEGER_BLOB* pDataOut
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptProtectData(
    IntPtr pDataIn,   // CRYPT_INTEGER_BLOB*
    [MarshalAs(UnmanagedType.LPWStr)] string szDataDescr,   // LPCWSTR optional
    IntPtr pOptionalEntropy,   // CRYPT_INTEGER_BLOB* optional
    IntPtr pvReserved,   // void* optional
    IntPtr pPromptStruct,   // CRYPTPROTECT_PROMPTSTRUCT* optional
    uint dwFlags,   // DWORD
    IntPtr pDataOut   // CRYPT_INTEGER_BLOB* out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptProtectData(
    pDataIn As IntPtr,   ' CRYPT_INTEGER_BLOB*
    <MarshalAs(UnmanagedType.LPWStr)> szDataDescr As String,   ' LPCWSTR optional
    pOptionalEntropy As IntPtr,   ' CRYPT_INTEGER_BLOB* optional
    pvReserved As IntPtr,   ' void* optional
    pPromptStruct As IntPtr,   ' CRYPTPROTECT_PROMPTSTRUCT* optional
    dwFlags As UInteger,   ' DWORD
    pDataOut As IntPtr   ' CRYPT_INTEGER_BLOB* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pDataIn : CRYPT_INTEGER_BLOB*
' szDataDescr : LPCWSTR optional
' pOptionalEntropy : CRYPT_INTEGER_BLOB* optional
' pvReserved : void* optional
' pPromptStruct : CRYPTPROTECT_PROMPTSTRUCT* optional
' dwFlags : DWORD
' pDataOut : CRYPT_INTEGER_BLOB* out
Declare PtrSafe Function CryptProtectData Lib "crypt32" ( _
    ByVal pDataIn As LongPtr, _
    ByVal szDataDescr As LongPtr, _
    ByVal pOptionalEntropy As LongPtr, _
    ByVal pvReserved As LongPtr, _
    ByVal pPromptStruct As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pDataOut As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptProtectData = ctypes.windll.crypt32.CryptProtectData
CryptProtectData.restype = wintypes.BOOL
CryptProtectData.argtypes = [
    ctypes.c_void_p,  # pDataIn : CRYPT_INTEGER_BLOB*
    wintypes.LPCWSTR,  # szDataDescr : LPCWSTR optional
    ctypes.c_void_p,  # pOptionalEntropy : CRYPT_INTEGER_BLOB* optional
    ctypes.POINTER(None),  # pvReserved : void* optional
    ctypes.c_void_p,  # pPromptStruct : CRYPTPROTECT_PROMPTSTRUCT* optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pDataOut : CRYPT_INTEGER_BLOB* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptProtectData = Fiddle::Function.new(
  lib['CryptProtectData'],
  [
    Fiddle::TYPE_VOIDP,  # pDataIn : CRYPT_INTEGER_BLOB*
    Fiddle::TYPE_VOIDP,  # szDataDescr : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pOptionalEntropy : CRYPT_INTEGER_BLOB* optional
    Fiddle::TYPE_VOIDP,  # pvReserved : void* optional
    Fiddle::TYPE_VOIDP,  # pPromptStruct : CRYPTPROTECT_PROMPTSTRUCT* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pDataOut : CRYPT_INTEGER_BLOB* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptProtectData(
        pDataIn: *mut CRYPT_INTEGER_BLOB,  // CRYPT_INTEGER_BLOB*
        szDataDescr: *const u16,  // LPCWSTR optional
        pOptionalEntropy: *mut CRYPT_INTEGER_BLOB,  // CRYPT_INTEGER_BLOB* optional
        pvReserved: *mut (),  // void* optional
        pPromptStruct: *mut CRYPTPROTECT_PROMPTSTRUCT,  // CRYPTPROTECT_PROMPTSTRUCT* optional
        dwFlags: u32,  // DWORD
        pDataOut: *mut CRYPT_INTEGER_BLOB  // CRYPT_INTEGER_BLOB* 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 CryptProtectData(IntPtr pDataIn, [MarshalAs(UnmanagedType.LPWStr)] string szDataDescr, IntPtr pOptionalEntropy, IntPtr pvReserved, IntPtr pPromptStruct, uint dwFlags, IntPtr pDataOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptProtectData' -Namespace Win32 -PassThru
# $api::CryptProtectData(pDataIn, szDataDescr, pOptionalEntropy, pvReserved, pPromptStruct, dwFlags, pDataOut)

#uselib "CRYPT32.dll"
#func global CryptProtectData "CryptProtectData" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptProtectData varptr(pDataIn), szDataDescr, varptr(pOptionalEntropy), pvReserved, varptr(pPromptStruct), dwFlags, varptr(pDataOut)   ; 戻り値は stat
; pDataIn : CRYPT_INTEGER_BLOB* -> "sptr"
; szDataDescr : LPCWSTR optional -> "sptr"
; pOptionalEntropy : CRYPT_INTEGER_BLOB* optional -> "sptr"
; pvReserved : void* optional -> "sptr"
; pPromptStruct : CRYPTPROTECT_PROMPTSTRUCT* optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; pDataOut : CRYPT_INTEGER_BLOB* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptProtectData "CryptProtectData" var, wstr, var, sptr, var, int, var
; res = CryptProtectData(pDataIn, szDataDescr, pOptionalEntropy, pvReserved, pPromptStruct, dwFlags, pDataOut)
; pDataIn : CRYPT_INTEGER_BLOB* -> "var"
; szDataDescr : LPCWSTR optional -> "wstr"
; pOptionalEntropy : CRYPT_INTEGER_BLOB* optional -> "var"
; pvReserved : void* optional -> "sptr"
; pPromptStruct : CRYPTPROTECT_PROMPTSTRUCT* optional -> "var"
; dwFlags : DWORD -> "int"
; pDataOut : CRYPT_INTEGER_BLOB* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptProtectData "CryptProtectData" sptr, wstr, sptr, sptr, sptr, int, sptr
; res = CryptProtectData(varptr(pDataIn), szDataDescr, varptr(pOptionalEntropy), pvReserved, varptr(pPromptStruct), dwFlags, varptr(pDataOut))
; pDataIn : CRYPT_INTEGER_BLOB* -> "sptr"
; szDataDescr : LPCWSTR optional -> "wstr"
; pOptionalEntropy : CRYPT_INTEGER_BLOB* optional -> "sptr"
; pvReserved : void* optional -> "sptr"
; pPromptStruct : CRYPTPROTECT_PROMPTSTRUCT* optional -> "sptr"
; dwFlags : DWORD -> "int"
; pDataOut : CRYPT_INTEGER_BLOB* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。