ホーム › Security.Cryptography › CryptCreateHash

CryptCreateHash

関数

指定アルゴリズムのハッシュオブジェクトを作成する。

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

シグネチャ

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

BOOL CryptCreateHash(
    UINT_PTR hProv,
    ALG_ID Algid,
    UINT_PTR hKey,
    DWORD dwFlags,
    UINT_PTR* phHash
);

パラメーター

名前

型

方向

説明

hProv

UINT_PTR

CryptAcquireContext の呼び出しによって作成された CSP へのハンドルです。

Algid

ALG_ID

使用するハッシュアルゴリズムを識別する ALG_ID 値です。

このパラメーターに有効な値は、使用する CSP によって異なります。既定のアルゴリズムの一覧については、「解説」を参照してください。

hKey

UINT_PTR

ハッシュアルゴリズムの種類が、ハッシュベースメッセージ認証コード (HMAC) やメッセージ認証コード (MAC) アルゴリズムなどのキー付きハッシュである場合、ハッシュ用のキーをこのパラメーターで渡します。キーを使用しないアルゴリズムの場合、このパラメーターは 0 に設定する必要があります。

キー付きアルゴリズムの場合、キーは RC2 などのブロック暗号キーで、暗号利用モードが暗号ブロック連鎖 (CBC) であるものでなければなりません。

dwFlags

DWORD

次のフラグ値が定義されています。

値	意味
CRYPT_SECRETDIGEST 0x00000001	このフラグは使用されません。

phHash

UINT_PTR*

out

新しいハッシュオブジェクトへのハンドルが関数によってコピーされるアドレスです。ハッシュオブジェクトの使用が終わったら、CryptDestroyHash 関数を呼び出してハンドルを解放してください。

戻り値の型: BOOL

公式ドキュメント

データストリームのハッシュ処理を開始します。暗号化サービスプロバイダー (CSP) のハッシュオブジェクトへのハンドルを作成し、呼び出し元のアプリケーションに返します。

戻り値

関数が成功した場合、TRUE を返します。

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

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

戻り値	説明
ERROR_INVALID_HANDLE	いずれかのパラメーターが、有効でないハンドルを指定しています。
ERROR_INVALID_PARAMETER	いずれかのパラメーターに、有効でない値が含まれています。多くの場合、これは有効でないポインターです。
ERROR_NOT_ENOUGH_MEMORY	操作中にオペレーティングシステムのメモリが不足しました。
NTE_BAD_ALGID	Algid パラメーターが、この CSP がサポートしていないアルゴリズムを指定しています。
NTE_BAD_FLAGS	dwFlags パラメーターが 0 以外です。
NTE_BAD_KEY	CALG_MAC などのキー付きハッシュアルゴリズムが Algid で指定されており、hKey パラメーターが 0 であるか、有効でないキーハンドルを指定しています。このエラーコードは、キーがストリーム暗号用である場合、または暗号利用モードが CBC 以外である場合にも返されます。
NTE_NO_MEMORY	操作中に CSP のメモリが不足しました。

解説(Remarks)

Microsoft のサービスプロバイダーと、それらが実装するアルゴリズムの一覧については、Microsoft Cryptographic Service Providers を参照してください。

実際のハッシュの計算は、CryptHashData 関数および CryptHashSessionKey 関数で行います。これらの関数にはハッシュオブジェクトへのハンドルが必要です。すべてのデータをハッシュオブジェクトに追加した後、次のいずれかの操作を実行できます。

CryptGetHashParam を使用してハッシュ値を取得できます。
CryptDeriveKey を使用してセッションキーを派生できます。
CryptSignHash を使用してハッシュに署名できます。
CryptVerifySignature を使用して署名を検証できます。

この一覧の関数のいずれかを呼び出した後は、CryptHashData および CryptHashSessionKey を呼び出すことはできません。

例

次の例は、データストリームのハッシュ処理を開始する方法を示しています。ハッシュオブジェクトへのハンドルを作成し、呼び出し元のアプリケーションに返します。このハンドルは、任意のデータストリームをハッシュするために、後続の CryptHashData および CryptHashSessionKey の呼び出しで使用されます。この例の完全なコンテキストを含む例については、Example C Program: Creating and Hashing a Session Key を参照してください。この関数を使用する別の例については、Example C Program: Signing a Hash and Verifying the Hash Signature を参照してください。

//--------------------------------------------------------------------
//  Declare variables.

HCRYPTPROV hCryptProv;
HCRYPTHASH hHash;

//--------------------------------------------------------------------
// Get a handle to a cryptography provider context.


if(CryptAcquireContext(
   &hCryptProv, 
   NULL, 
   NULL, 
   PROV_RSA_FULL, 
   0)) 
{
    printf("CryptAcquireContext complete. \n");
}
else
{
     printf("Acquisition of context failed.\n");
     exit(1);
}
//--------------------------------------------------------------------
// Acquire a hash object handle.

if(CryptCreateHash(
   hCryptProv, 
   CALG_MD5, 
   0, 
   0, 
   &hHash)) 
{
    printf("An empty hash object has been created. \n");
}
else
{
    printf("Error during CryptBeginHash!\n");
    exit(1);
}

// Insert code that uses the hash object here.

//--------------------------------------------------------------------
// After processing, hCryptProv and hHash must be released.

if(hHash) 
   CryptDestroyHash(hHash);
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 CryptCreateHash(
    UINT_PTR hProv,
    ALG_ID Algid,
    UINT_PTR hKey,
    DWORD dwFlags,
    UINT_PTR* phHash
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptCreateHash(
    UIntPtr hProv,   // UINT_PTR
    uint Algid,   // ALG_ID
    UIntPtr hKey,   // UINT_PTR
    uint dwFlags,   // DWORD
    out UIntPtr phHash   // UINT_PTR* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptCreateHash(
    hProv As UIntPtr,   ' UINT_PTR
    Algid As UInteger,   ' ALG_ID
    hKey As UIntPtr,   ' UINT_PTR
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef phHash As UIntPtr   ' UINT_PTR* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProv : UINT_PTR
' Algid : ALG_ID
' hKey : UINT_PTR
' dwFlags : DWORD
' phHash : UINT_PTR* out
Declare PtrSafe Function CryptCreateHash Lib "advapi32" ( _
    ByVal hProv As LongPtr, _
    ByVal Algid As Long, _
    ByVal hKey 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

CryptCreateHash = ctypes.windll.advapi32.CryptCreateHash
CryptCreateHash.restype = wintypes.BOOL
CryptCreateHash.argtypes = [
    ctypes.c_size_t,  # hProv : UINT_PTR
    wintypes.DWORD,  # Algid : ALG_ID
    ctypes.c_size_t,  # hKey : UINT_PTR
    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')
CryptCreateHash = Fiddle::Function.new(
  lib['CryptCreateHash'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hProv : UINT_PTR
    -Fiddle::TYPE_INT,  # Algid : ALG_ID
    Fiddle::TYPE_UINTPTR_T,  # hKey : UINT_PTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # phHash : UINT_PTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CryptCreateHash(
        hProv: usize,  // UINT_PTR
        Algid: u32,  // ALG_ID
        hKey: usize,  // UINT_PTR
        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 CryptCreateHash(UIntPtr hProv, uint Algid, UIntPtr hKey, uint dwFlags, out UIntPtr phHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptCreateHash' -Namespace Win32 -PassThru
# $api::CryptCreateHash(hProv, Algid, hKey, dwFlags, phHash)

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

出力引数:

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