ホーム › Security.Cryptography › CryptXmlSetHMACSecret
CryptXmlSetHMACSecret
関数XML署名に使用するHMAC共有秘密鍵を設定する。
シグネチャ
// CRYPTXML.dll
#include <windows.h>
HRESULT CryptXmlSetHMACSecret(
void* hSignature,
const BYTE* pbSecret,
DWORD cbSecret
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hSignature | void* | in | XML の Signature 要素のハンドル。 |
| pbSecret | BYTE* | in | バイト列のブロックを格納するバッファーへのポインター。 このポインターは、CryptXmlSign 関数または CryptXmlVerify 関数の呼び出し中、有効である必要があります。 |
| cbSecret | DWORD | in | pbSecret パラメーターが指すバッファーのサイズ (バイト単位)。 |
戻り値の型: HRESULT
公式ドキュメント
CryptXmlSign 関数または CryptXmlVerify 関数を呼び出す前に、ハンドルに HMAC シークレットを設定します。
戻り値
関数が成功した場合、関数はゼロを返します。
関数が失敗した場合は、エラーを示す HRESULT 値を返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// CRYPTXML.dll
#include <windows.h>
HRESULT CryptXmlSetHMACSecret(
void* hSignature,
const BYTE* pbSecret,
DWORD cbSecret
);[DllImport("CRYPTXML.dll", ExactSpelling = true)]
static extern int CryptXmlSetHMACSecret(
IntPtr hSignature, // void*
IntPtr pbSecret, // BYTE*
uint cbSecret // DWORD
);<DllImport("CRYPTXML.dll", ExactSpelling:=True)>
Public Shared Function CryptXmlSetHMACSecret(
hSignature As IntPtr, ' void*
pbSecret As IntPtr, ' BYTE*
cbSecret As UInteger ' DWORD
) As Integer
End Function' hSignature : void*
' pbSecret : BYTE*
' cbSecret : DWORD
Declare PtrSafe Function CryptXmlSetHMACSecret Lib "cryptxml" ( _
ByVal hSignature As LongPtr, _
ByVal pbSecret As LongPtr, _
ByVal cbSecret As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CryptXmlSetHMACSecret = ctypes.windll.cryptxml.CryptXmlSetHMACSecret
CryptXmlSetHMACSecret.restype = ctypes.c_int
CryptXmlSetHMACSecret.argtypes = [
ctypes.POINTER(None), # hSignature : void*
ctypes.POINTER(ctypes.c_ubyte), # pbSecret : BYTE*
wintypes.DWORD, # cbSecret : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('CRYPTXML.dll')
CryptXmlSetHMACSecret = Fiddle::Function.new(
lib['CryptXmlSetHMACSecret'],
[
Fiddle::TYPE_VOIDP, # hSignature : void*
Fiddle::TYPE_VOIDP, # pbSecret : BYTE*
-Fiddle::TYPE_INT, # cbSecret : DWORD
],
Fiddle::TYPE_INT)#[link(name = "cryptxml")]
extern "system" {
fn CryptXmlSetHMACSecret(
hSignature: *mut (), // void*
pbSecret: *const u8, // BYTE*
cbSecret: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("CRYPTXML.dll")]
public static extern int CryptXmlSetHMACSecret(IntPtr hSignature, IntPtr pbSecret, uint cbSecret);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPTXML_CryptXmlSetHMACSecret' -Namespace Win32 -PassThru
# $api::CryptXmlSetHMACSecret(hSignature, pbSecret, cbSecret)#uselib "CRYPTXML.dll"
#func global CryptXmlSetHMACSecret "CryptXmlSetHMACSecret" sptr, sptr, sptr
; CryptXmlSetHMACSecret hSignature, varptr(pbSecret), cbSecret ; 戻り値は stat
; hSignature : void* -> "sptr"
; pbSecret : BYTE* -> "sptr"
; cbSecret : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "CRYPTXML.dll" #cfunc global CryptXmlSetHMACSecret "CryptXmlSetHMACSecret" sptr, var, int ; res = CryptXmlSetHMACSecret(hSignature, pbSecret, cbSecret) ; hSignature : void* -> "sptr" ; pbSecret : BYTE* -> "var" ; cbSecret : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPTXML.dll" #cfunc global CryptXmlSetHMACSecret "CryptXmlSetHMACSecret" sptr, sptr, int ; res = CryptXmlSetHMACSecret(hSignature, varptr(pbSecret), cbSecret) ; hSignature : void* -> "sptr" ; pbSecret : BYTE* -> "sptr" ; cbSecret : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT CryptXmlSetHMACSecret(void* hSignature, BYTE* pbSecret, DWORD cbSecret) #uselib "CRYPTXML.dll" #cfunc global CryptXmlSetHMACSecret "CryptXmlSetHMACSecret" intptr, var, int ; res = CryptXmlSetHMACSecret(hSignature, pbSecret, cbSecret) ; hSignature : void* -> "intptr" ; pbSecret : BYTE* -> "var" ; cbSecret : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT CryptXmlSetHMACSecret(void* hSignature, BYTE* pbSecret, DWORD cbSecret) #uselib "CRYPTXML.dll" #cfunc global CryptXmlSetHMACSecret "CryptXmlSetHMACSecret" intptr, intptr, int ; res = CryptXmlSetHMACSecret(hSignature, varptr(pbSecret), cbSecret) ; hSignature : void* -> "intptr" ; pbSecret : BYTE* -> "intptr" ; cbSecret : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
cryptxml = windows.NewLazySystemDLL("CRYPTXML.dll")
procCryptXmlSetHMACSecret = cryptxml.NewProc("CryptXmlSetHMACSecret")
)
// hSignature (void*), pbSecret (BYTE*), cbSecret (DWORD)
r1, _, err := procCryptXmlSetHMACSecret.Call(
uintptr(hSignature),
uintptr(pbSecret),
uintptr(cbSecret),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction CryptXmlSetHMACSecret(
hSignature: Pointer; // void*
pbSecret: Pointer; // BYTE*
cbSecret: DWORD // DWORD
): Integer; stdcall;
external 'CRYPTXML.dll' name 'CryptXmlSetHMACSecret';result := DllCall("CRYPTXML\CryptXmlSetHMACSecret"
, "Ptr", hSignature ; void*
, "Ptr", pbSecret ; BYTE*
, "UInt", cbSecret ; DWORD
, "Int") ; return: HRESULT●CryptXmlSetHMACSecret(hSignature, pbSecret, cbSecret) = DLL("CRYPTXML.dll", "int CryptXmlSetHMACSecret(void*, void*, dword)")
# 呼び出し: CryptXmlSetHMACSecret(hSignature, pbSecret, cbSecret)
# hSignature : void* -> "void*"
# pbSecret : BYTE* -> "void*"
# cbSecret : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "cryptxml" fn CryptXmlSetHMACSecret(
hSignature: ?*anyopaque, // void*
pbSecret: [*c]u8, // BYTE*
cbSecret: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc CryptXmlSetHMACSecret(
hSignature: pointer, # void*
pbSecret: ptr uint8, # BYTE*
cbSecret: uint32 # DWORD
): int32 {.importc: "CryptXmlSetHMACSecret", stdcall, dynlib: "CRYPTXML.dll".}pragma(lib, "cryptxml");
extern(Windows)
int CryptXmlSetHMACSecret(
void* hSignature, // void*
ubyte* pbSecret, // BYTE*
uint cbSecret // DWORD
);ccall((:CryptXmlSetHMACSecret, "CRYPTXML.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{UInt8}, UInt32),
hSignature, pbSecret, cbSecret)
# hSignature : void* -> Ptr{Cvoid}
# pbSecret : BYTE* -> Ptr{UInt8}
# cbSecret : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CryptXmlSetHMACSecret(
void* hSignature,
uint8_t* pbSecret,
uint32_t cbSecret);
]]
local cryptxml = ffi.load("cryptxml")
-- cryptxml.CryptXmlSetHMACSecret(hSignature, pbSecret, cbSecret)
-- hSignature : void*
-- pbSecret : BYTE*
-- cbSecret : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('CRYPTXML.dll');
const CryptXmlSetHMACSecret = lib.func('__stdcall', 'CryptXmlSetHMACSecret', 'int32_t', ['void *', 'uint8_t *', 'uint32_t']);
// CryptXmlSetHMACSecret(hSignature, pbSecret, cbSecret)
// hSignature : void* -> 'void *'
// pbSecret : BYTE* -> 'uint8_t *'
// cbSecret : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("CRYPTXML.dll", {
CryptXmlSetHMACSecret: { parameters: ["pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.CryptXmlSetHMACSecret(hSignature, pbSecret, cbSecret)
// hSignature : void* -> "pointer"
// pbSecret : BYTE* -> "pointer"
// cbSecret : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CryptXmlSetHMACSecret(
void* hSignature,
uint8_t* pbSecret,
uint32_t cbSecret);
C, "CRYPTXML.dll");
// $ffi->CryptXmlSetHMACSecret(hSignature, pbSecret, cbSecret);
// hSignature : void*
// pbSecret : BYTE*
// cbSecret : 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 Cryptxml extends StdCallLibrary {
Cryptxml INSTANCE = Native.load("cryptxml", Cryptxml.class);
int CryptXmlSetHMACSecret(
Pointer hSignature, // void*
byte[] pbSecret, // BYTE*
int cbSecret // DWORD
);
}@[Link("cryptxml")]
lib LibCRYPTXML
fun CryptXmlSetHMACSecret = CryptXmlSetHMACSecret(
hSignature : Void*, # void*
pbSecret : UInt8*, # BYTE*
cbSecret : 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 CryptXmlSetHMACSecretNative = Int32 Function(Pointer<Void>, Pointer<Uint8>, Uint32);
typedef CryptXmlSetHMACSecretDart = int Function(Pointer<Void>, Pointer<Uint8>, int);
final CryptXmlSetHMACSecret = DynamicLibrary.open('CRYPTXML.dll')
.lookupFunction<CryptXmlSetHMACSecretNative, CryptXmlSetHMACSecretDart>('CryptXmlSetHMACSecret');
// hSignature : void* -> Pointer<Void>
// pbSecret : BYTE* -> Pointer<Uint8>
// cbSecret : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CryptXmlSetHMACSecret(
hSignature: Pointer; // void*
pbSecret: Pointer; // BYTE*
cbSecret: DWORD // DWORD
): Integer; stdcall;
external 'CRYPTXML.dll' name 'CryptXmlSetHMACSecret';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CryptXmlSetHMACSecret"
c_CryptXmlSetHMACSecret :: Ptr () -> Ptr Word8 -> Word32 -> IO Int32
-- hSignature : void* -> Ptr ()
-- pbSecret : BYTE* -> Ptr Word8
-- cbSecret : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let cryptxmlsethmacsecret =
foreign "CryptXmlSetHMACSecret"
((ptr void) @-> (ptr uint8_t) @-> uint32_t @-> returning int32_t)
(* hSignature : void* -> (ptr void) *)
(* pbSecret : BYTE* -> (ptr uint8_t) *)
(* cbSecret : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library cryptxml (t "CRYPTXML.dll"))
(cffi:use-foreign-library cryptxml)
(cffi:defcfun ("CryptXmlSetHMACSecret" crypt-xml-set-hmacsecret :convention :stdcall) :int32
(h-signature :pointer) ; void*
(pb-secret :pointer) ; BYTE*
(cb-secret :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CryptXmlSetHMACSecret = Win32::API::More->new('CRYPTXML',
'int CryptXmlSetHMACSecret(LPVOID hSignature, LPVOID pbSecret, DWORD cbSecret)');
# my $ret = $CryptXmlSetHMACSecret->Call($hSignature, $pbSecret, $cbSecret);
# hSignature : void* -> LPVOID
# pbSecret : BYTE* -> LPVOID
# cbSecret : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。