ホーム › Security.Cryptography › CryptDuplicateHash

CryptDuplicateHash

関数

ハッシュオブジェクトを複製して状態をコピーする。

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

シグネチャ

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

BOOL CryptDuplicateHash(
    UINT_PTR hHash,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags,
    UINT_PTR* phHash
);

パラメーター

名前	型	方向	説明
hHash	UINT_PTR	in	複製するハッシュのハンドル。
pdwReserved	DWORD*	optional	将来の使用のために予約されており、0 を指定する必要があります。
dwFlags	DWORD	in	将来の使用のために予約されており、0 を指定する必要があります。
phHash	UINT_PTR*	out	複製されたハッシュのハンドルのアドレス。ハッシュの使用が終わったら、CryptDestroyHash 関数を呼び出してハンドルを解放してください。

戻り値の型: BOOL

公式ドキュメント

ハッシュを、複製を行った時点までの状態で正確に複製します。

戻り値

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

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

「NTE」で始まるエラーコードは、使用している特定の暗号化サービスプロバイダー (CSP) によって生成されます。考えられるエラーコードの一部を以下に示します。

戻り値	説明
ERROR_CALL_NOT_IMPLEMENTED	これは新しい関数であるため、既存の CSP では実装できません。CSP がこの関数をサポートしていない場合に、このエラーが返されます。
ERROR_INVALID_PARAMETER	いずれかのパラメーターに無効な値が含まれています。これは多くの場合、無効なポインターです。
NTE_BAD_HASH	元のハッシュのハンドルが無効です。

解説(Remarks)

CryptDuplicateHash は、ハッシュと、そのハッシュの正確な状態のコピーを作成します。この関数は、呼び出し元アプリケーションが 2 つのハッシュを生成する必要があり、かつ両方のハッシュが共通のデータをハッシュした状態から開始しなければならない場合に使用できます。たとえば、ハッシュを作成して共通データをハッシュし、CryptDuplicateHash 関数で複製を作成してから、各ハッシュに固有のデータを追加する、といった使い方ができます。

CryptDuplicateHash で作成したハッシュを破棄するには、CryptDestroyHash 関数を呼び出す必要があります。元のハッシュを破棄しても、複製されたハッシュは破棄されません。複製されたハッシュは、作成された時点で元のハッシュとは別個のものになります。2 つのハッシュの間で共有される状態はありません。

例

次の例は、ハッシュの正確なコピーを作成する方法を示しています。この例の完全なコンテキストを含む例については、C プログラムの例: ハッシュの複製を参照してください。

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

HCRYPTPROV   hCryptProv = NULL;
HCRYPTHASH   hOriginalHash = NULL;
HCRYPTHASH   hDuplicateHash = NULL;

//-------------------------------------------------------------------
// Acquire a CSP context.

if(CryptAcquireContext(
   &hCryptProv, 
   NULL, 
   NULL, 
   PROV_RSA_FULL, 
   0)) 
{
    printf("CryptAcquireContext succeeded. \n");
}
else
{
    printf("Error during CryptAcquireContext.\n");
    exit(1);
}
//-------------------------------------------------------------------
// Create a hash.

if (CryptCreateHash(
    hCryptProv, 
    CALG_SHA1, 
    0, 
    0,
    &hOriginalHash))
{
   printf("An empty hash object has been created. \n");
}
else
{
   printf("Error during CryptCreateHash.\n");
   exit(1);
}
//-------------------------------------------------------------------
// Hash a BYTE string.

if (CryptHashData(
    hOriginalHash, 
    (BYTE*)"Some Common Data", 
    sizeof("Some Common Data"), 0))
{
   printf("An original hash has been created. \n");
}
else
{
   printf("Error during CryptHashData.\n");
   exit(1);
}
//-------------------------------------------------------------------
// Duplicate the hash.

if (CryptDuplicateHash(
   hOriginalHash, 
   NULL, 
   0, 
   &hDuplicateHash))
{
   printf("The hash has been duplicated. \n");
}
else
{
   printf("Error during CryptDuplicateHash.\n");
   exit(1);
}
//-------------------------------------------------------------------
// At this point, the two hash objects are exactly the same.
// The two hash objects can be handled separately.
// When all processing on the hash object is completed, 
// both objects should be destroyed, and the cryptographic
// context should be released.

//-------------------------------------------------------------------
// Destroy the original hash.

if(CryptDestroyHash(hOriginalHash))
{
   printf("The original hash has been destroyed. \n");
}
else
{
   printf("Error during CryptDestroyHash on the original "
       "hash object.\n");
   exit(1);
}
//-------------------------------------------------------------------
// Destroy the duplicate hash.

if (CryptDestroyHash(hDuplicateHash))
{
   printf("The duplicate hash has been destroyed. \n");
}
else
{
   printf("Error during CryptDestroyHash on the duplicated hash object.\n");
   exit(1);
}

//-------------------------------------------------------------------
// Release the CSP.

if(hCryptProv) 
   CryptReleaseContext(hCryptProv,0);

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

各言語での呼び出し定義

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

BOOL CryptDuplicateHash(
    UINT_PTR hHash,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags,
    UINT_PTR* phHash
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptDuplicateHash(
    UIntPtr hHash,   // UINT_PTR
    IntPtr pdwReserved,   // DWORD* optional
    uint dwFlags,   // DWORD
    out UIntPtr phHash   // UINT_PTR* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptDuplicateHash(
    hHash As UIntPtr,   ' UINT_PTR
    pdwReserved As IntPtr,   ' DWORD* optional
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef phHash As UIntPtr   ' UINT_PTR* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hHash : UINT_PTR
' pdwReserved : DWORD* optional
' dwFlags : DWORD
' phHash : UINT_PTR* out
Declare PtrSafe Function CryptDuplicateHash Lib "advapi32" ( _
    ByVal hHash As LongPtr, _
    ByVal pdwReserved As LongPtr, _
    ByVal dwFlags As Long, _
    ByRef phHash As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptDuplicateHash = ctypes.windll.advapi32.CryptDuplicateHash
CryptDuplicateHash.restype = wintypes.BOOL
CryptDuplicateHash.argtypes = [
    ctypes.c_size_t,  # hHash : UINT_PTR
    ctypes.POINTER(wintypes.DWORD),  # pdwReserved : DWORD* optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(ctypes.c_size_t),  # phHash : UINT_PTR* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptDuplicateHash = Fiddle::Function.new(
  lib['CryptDuplicateHash'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hHash : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pdwReserved : DWORD* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # phHash : UINT_PTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CryptDuplicateHash(
        hHash: usize,  // UINT_PTR
        pdwReserved: *mut u32,  // DWORD* optional
        dwFlags: u32,  // DWORD
        phHash: *mut usize  // UINT_PTR* out
    ) -> 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 CryptDuplicateHash(UIntPtr hHash, IntPtr pdwReserved, uint dwFlags, out UIntPtr phHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptDuplicateHash' -Namespace Win32 -PassThru
# $api::CryptDuplicateHash(hHash, pdwReserved, dwFlags, phHash)

#uselib "ADVAPI32.dll"
#func global CryptDuplicateHash "CryptDuplicateHash" sptr, sptr, sptr, sptr
; CryptDuplicateHash hHash, varptr(pdwReserved), dwFlags, varptr(phHash)   ; 戻り値は stat
; hHash : UINT_PTR -> "sptr"
; pdwReserved : DWORD* optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; phHash : UINT_PTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CryptDuplicateHash "CryptDuplicateHash" sptr, var, int, var
; res = CryptDuplicateHash(hHash, pdwReserved, dwFlags, phHash)
; hHash : UINT_PTR -> "sptr"
; pdwReserved : DWORD* optional -> "var"
; dwFlags : DWORD -> "int"
; phHash : UINT_PTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CryptDuplicateHash "CryptDuplicateHash" sptr, sptr, int, sptr
; res = CryptDuplicateHash(hHash, varptr(pdwReserved), dwFlags, varptr(phHash))
; hHash : UINT_PTR -> "sptr"
; pdwReserved : DWORD* optional -> "sptr"
; dwFlags : DWORD -> "int"
; phHash : UINT_PTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。