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

SslComputeFinishedHash

関数
SSLハンドシェイクのFinishedメッセージ用ハッシュを計算する。
DLLncrypt.dll呼出規約winapi

シグネチャ

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

HRESULT SslComputeFinishedHash(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE hMasterKey,
    NCRYPT_HASH_HANDLE hHandshakeHash,
    BYTE* pbOutput,
    DWORD cbOutput,
    DWORD dwFlags
);

パラメーター

名前方向説明
hSslProviderNCRYPT_PROV_HANDLEinSchannel SSLプロバイダのハンドル。
hMasterKeyNCRYPT_KEY_HANDLEinセッションのマスター鍵ハンドル。
hHandshakeHashNCRYPT_HASH_HANDLEinハンドシェイクハッシュのハンドル。
pbOutputBYTE*out計算したFinishedハッシュを書き込む出力バッファ。
cbOutputDWORDinpbOutputのバイト数。
dwFlagsDWORDin動作を制御するフラグ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT SslComputeFinishedHash(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE hMasterKey,
    NCRYPT_HASH_HANDLE hHandshakeHash,
    BYTE* pbOutput,
    DWORD cbOutput,
    DWORD dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int SslComputeFinishedHash(
    UIntPtr hSslProvider,   // NCRYPT_PROV_HANDLE
    UIntPtr hMasterKey,   // NCRYPT_KEY_HANDLE
    UIntPtr hHandshakeHash,   // NCRYPT_HASH_HANDLE
    IntPtr pbOutput,   // BYTE* out
    uint cbOutput,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function SslComputeFinishedHash(
    hSslProvider As UIntPtr,   ' NCRYPT_PROV_HANDLE
    hMasterKey As UIntPtr,   ' NCRYPT_KEY_HANDLE
    hHandshakeHash As UIntPtr,   ' NCRYPT_HASH_HANDLE
    pbOutput As IntPtr,   ' BYTE* out
    cbOutput As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hSslProvider : NCRYPT_PROV_HANDLE
' hMasterKey : NCRYPT_KEY_HANDLE
' hHandshakeHash : NCRYPT_HASH_HANDLE
' pbOutput : BYTE* out
' cbOutput : DWORD
' dwFlags : DWORD
Declare PtrSafe Function SslComputeFinishedHash Lib "ncrypt" ( _
    ByVal hSslProvider As LongPtr, _
    ByVal hMasterKey As LongPtr, _
    ByVal hHandshakeHash As LongPtr, _
    ByVal pbOutput As LongPtr, _
    ByVal cbOutput 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

SslComputeFinishedHash = ctypes.windll.ncrypt.SslComputeFinishedHash
SslComputeFinishedHash.restype = ctypes.c_int
SslComputeFinishedHash.argtypes = [
    ctypes.c_size_t,  # hSslProvider : NCRYPT_PROV_HANDLE
    ctypes.c_size_t,  # hMasterKey : NCRYPT_KEY_HANDLE
    ctypes.c_size_t,  # hHandshakeHash : NCRYPT_HASH_HANDLE
    ctypes.POINTER(ctypes.c_ubyte),  # pbOutput : BYTE* out
    wintypes.DWORD,  # cbOutput : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procSslComputeFinishedHash = ncrypt.NewProc("SslComputeFinishedHash")
)

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

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

foreign import stdcall safe "SslComputeFinishedHash"
  c_SslComputeFinishedHash :: CUIntPtr -> CUIntPtr -> CUIntPtr -> Ptr Word8 -> Word32 -> Word32 -> IO Int32
-- hSslProvider : NCRYPT_PROV_HANDLE -> CUIntPtr
-- hMasterKey : NCRYPT_KEY_HANDLE -> CUIntPtr
-- hHandshakeHash : NCRYPT_HASH_HANDLE -> CUIntPtr
-- pbOutput : BYTE* out -> Ptr Word8
-- cbOutput : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sslcomputefinishedhash =
  foreign "SslComputeFinishedHash"
    (size_t @-> size_t @-> size_t @-> (ptr uint8_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hSslProvider : NCRYPT_PROV_HANDLE -> size_t *)
(* hMasterKey : NCRYPT_KEY_HANDLE -> size_t *)
(* hHandshakeHash : NCRYPT_HASH_HANDLE -> size_t *)
(* pbOutput : BYTE* out -> (ptr uint8_t) *)
(* cbOutput : DWORD -> 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 ("SslComputeFinishedHash" ssl-compute-finished-hash :convention :stdcall) :int32
  (h-ssl-provider :uint64)   ; NCRYPT_PROV_HANDLE
  (h-master-key :uint64)   ; NCRYPT_KEY_HANDLE
  (h-handshake-hash :uint64)   ; NCRYPT_HASH_HANDLE
  (pb-output :pointer)   ; BYTE* out
  (cb-output :uint32)   ; DWORD
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SslComputeFinishedHash = Win32::API::More->new('ncrypt',
    'int SslComputeFinishedHash(WPARAM hSslProvider, WPARAM hMasterKey, WPARAM hHandshakeHash, LPVOID pbOutput, DWORD cbOutput, DWORD dwFlags)');
# my $ret = $SslComputeFinishedHash->Call($hSslProvider, $hMasterKey, $hHandshakeHash, $pbOutput, $cbOutput, $dwFlags);
# hSslProvider : NCRYPT_PROV_HANDLE -> WPARAM
# hMasterKey : NCRYPT_KEY_HANDLE -> WPARAM
# hHandshakeHash : NCRYPT_HASH_HANDLE -> WPARAM
# pbOutput : BYTE* out -> LPVOID
# cbOutput : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。