CryptMsgControl
関数シグネチャ
// CRYPT32.dll
#include <windows.h>
BOOL CryptMsgControl(
void* hCryptMsg,
DWORD dwFlags,
DWORD dwCtrlType,
const void* pvCtrlPara // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hCryptMsg | void* | in | 制御を適用する暗号化メッセージのハンドル。 | ||||||||||||||||||||||||||||||||||||||||
| dwFlags | DWORD | in | dwCtrlType パラメーターが次のいずれかである場合に、次の値が定義されます。
dwCtrlType パラメーターが復号操作を指定していない場合は、この値をゼロに設定します。 | ||||||||||||||||||||||||||||||||||||||||
| dwCtrlType | DWORD | in | 実行する操作の種類。現在定義されているメッセージ制御の種類と、pvCtrlPara パラメーターに渡す構造体の型を次の表に示します。
| ||||||||||||||||||||||||||||||||||||||||
| pvCtrlPara | void* | inoptional | dwCtrlType の値によって決まる構造体へのポインター。
|
戻り値の型: BOOL
公式ドキュメント
CryptMsgUpdate 関数の最終呼び出しによってメッセージがデコードされた後に、制御操作を実行します。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗すると、戻り値は 0 になり、GetLastError 関数は Abstract Syntax Notation One (ASN.1) のエンコード/デコード エラーを返します。これらのエラーについては、 ASN.1 Encoding/Decoding Return Values を参照してください。
ストリーミングされたエンベロープ メッセージがデコードされている場合、 CryptMsgOpenToDecode 関数の pStreamInfo パラメーターで指定したアプリケーション定義のコールバック関数で発生したエラーが、CryptMsgControl 関数に伝播される場合があります。この場合、コールバック関数が戻った後に CryptMsgControl 関数によって SetLastError 関数は呼び出されません。これにより、アプリケーションの制御下で発生したエラーが保持されます。アプリケーションがストリーミング データを処理している間にエラーが発生した場合に SetLastError 関数を呼び出すのは、コールバック関数 (またはそれが呼び出す API のいずれか) の責任です。
伝播されるエラーは、次の関数から発生する可能性があります。
- CryptCreateHash
- CryptDecrypt
- CryptGetHashParam
- CryptGetUserKey
- CryptHashData
- CryptImportKey
- CryptSignHash
- CryptVerifySignature
最もよく返されるエラー コードは次のとおりです。
| 戻り値 | 説明 |
|---|---|
| メッセージのコンテンツは既に復号されています。このエラーは、dwCtrlType パラメーターが CMSG_CTRL_DECRYPT に設定されている場合に返されることがあります。 | |
| メッセージに、期待される認証済み属性が含まれていません。このエラーは、dwCtrlType パラメーターが CMSG_CTRL_VERIFY_SIGNATURE に設定されている場合に返されることがあります。 | |
| エンコードまたはデコード中にエラーが発生しました。このエラーは、dwCtrlType パラメーターが CMSG_CTRL_VERIFY_SIGNATURE に設定されている場合に返されることがあります。 | |
| 制御の種類が無効です。 | |
| ハッシュ値が正しくありません。 | |
| インデックス値が無効です。 | |
| メッセージの種類が無効です。 | |
| オブジェクト識別子の形式が正しくありません。このエラーは、dwCtrlType パラメーターが CMSG_CTRL_ADD_SIGNER に設定されている場合に返されることがあります。 | |
| エンベロープ データ メッセージに、指定された受信者が含まれていません。このエラーは、dwCtrlType パラメーターが CMSG_CTRL_DECRYPT に設定されている場合に返されることがあります。 | |
| メッセージに指定された署名者が見つかりませんでした。このエラーは、dwCtrlType パラメーターが CMSG_CTRL_VERIFY_SIGNATURE に設定されている場合に返されることがあります。 | |
| 暗号アルゴリズムが不明です。 | |
| メッセージが期待どおりにエンコードされていません。このエラーは、dwCtrlType パラメーターが CMSG_CTRL_VERIFY_SIGNATURE に設定されている場合に返されることがあります。 | |
| 1 つ以上の引数が無効です。このエラーは、dwCtrlType パラメーターが CMSG_CTRL_DECRYPT に設定されている場合に返されることがあります。 | |
| 操作を完了するのに十分なメモリがありませんでした。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// CRYPT32.dll
#include <windows.h>
BOOL CryptMsgControl(
void* hCryptMsg,
DWORD dwFlags,
DWORD dwCtrlType,
const void* pvCtrlPara // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptMsgControl(
IntPtr hCryptMsg, // void*
uint dwFlags, // DWORD
uint dwCtrlType, // DWORD
IntPtr pvCtrlPara // void* optional
);<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptMsgControl(
hCryptMsg As IntPtr, ' void*
dwFlags As UInteger, ' DWORD
dwCtrlType As UInteger, ' DWORD
pvCtrlPara As IntPtr ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hCryptMsg : void*
' dwFlags : DWORD
' dwCtrlType : DWORD
' pvCtrlPara : void* optional
Declare PtrSafe Function CryptMsgControl Lib "crypt32" ( _
ByVal hCryptMsg As LongPtr, _
ByVal dwFlags As Long, _
ByVal dwCtrlType As Long, _
ByVal pvCtrlPara As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CryptMsgControl = ctypes.windll.crypt32.CryptMsgControl
CryptMsgControl.restype = wintypes.BOOL
CryptMsgControl.argtypes = [
ctypes.POINTER(None), # hCryptMsg : void*
wintypes.DWORD, # dwFlags : DWORD
wintypes.DWORD, # dwCtrlType : DWORD
ctypes.POINTER(None), # pvCtrlPara : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('CRYPT32.dll')
CryptMsgControl = Fiddle::Function.new(
lib['CryptMsgControl'],
[
Fiddle::TYPE_VOIDP, # hCryptMsg : void*
-Fiddle::TYPE_INT, # dwFlags : DWORD
-Fiddle::TYPE_INT, # dwCtrlType : DWORD
Fiddle::TYPE_VOIDP, # pvCtrlPara : void* optional
],
Fiddle::TYPE_INT)#[link(name = "crypt32")]
extern "system" {
fn CryptMsgControl(
hCryptMsg: *mut (), // void*
dwFlags: u32, // DWORD
dwCtrlType: u32, // DWORD
pvCtrlPara: *const () // void* optional
) -> 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 CryptMsgControl(IntPtr hCryptMsg, uint dwFlags, uint dwCtrlType, IntPtr pvCtrlPara);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptMsgControl' -Namespace Win32 -PassThru
# $api::CryptMsgControl(hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara)#uselib "CRYPT32.dll"
#func global CryptMsgControl "CryptMsgControl" sptr, sptr, sptr, sptr
; CryptMsgControl hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara ; 戻り値は stat
; hCryptMsg : void* -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwCtrlType : DWORD -> "sptr"
; pvCtrlPara : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "CRYPT32.dll"
#cfunc global CryptMsgControl "CryptMsgControl" sptr, int, int, sptr
; res = CryptMsgControl(hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara)
; hCryptMsg : void* -> "sptr"
; dwFlags : DWORD -> "int"
; dwCtrlType : DWORD -> "int"
; pvCtrlPara : void* optional -> "sptr"; BOOL CryptMsgControl(void* hCryptMsg, DWORD dwFlags, DWORD dwCtrlType, void* pvCtrlPara)
#uselib "CRYPT32.dll"
#cfunc global CryptMsgControl "CryptMsgControl" intptr, int, int, intptr
; res = CryptMsgControl(hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara)
; hCryptMsg : void* -> "intptr"
; dwFlags : DWORD -> "int"
; dwCtrlType : DWORD -> "int"
; pvCtrlPara : void* optional -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
crypt32 = windows.NewLazySystemDLL("CRYPT32.dll")
procCryptMsgControl = crypt32.NewProc("CryptMsgControl")
)
// hCryptMsg (void*), dwFlags (DWORD), dwCtrlType (DWORD), pvCtrlPara (void* optional)
r1, _, err := procCryptMsgControl.Call(
uintptr(hCryptMsg),
uintptr(dwFlags),
uintptr(dwCtrlType),
uintptr(pvCtrlPara),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction CryptMsgControl(
hCryptMsg: Pointer; // void*
dwFlags: DWORD; // DWORD
dwCtrlType: DWORD; // DWORD
pvCtrlPara: Pointer // void* optional
): BOOL; stdcall;
external 'CRYPT32.dll' name 'CryptMsgControl';result := DllCall("CRYPT32\CryptMsgControl"
, "Ptr", hCryptMsg ; void*
, "UInt", dwFlags ; DWORD
, "UInt", dwCtrlType ; DWORD
, "Ptr", pvCtrlPara ; void* optional
, "Int") ; return: BOOL●CryptMsgControl(hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara) = DLL("CRYPT32.dll", "bool CryptMsgControl(void*, dword, dword, void*)")
# 呼び出し: CryptMsgControl(hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara)
# hCryptMsg : void* -> "void*"
# dwFlags : DWORD -> "dword"
# dwCtrlType : DWORD -> "dword"
# pvCtrlPara : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "crypt32" fn CryptMsgControl(
hCryptMsg: ?*anyopaque, // void*
dwFlags: u32, // DWORD
dwCtrlType: u32, // DWORD
pvCtrlPara: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;proc CryptMsgControl(
hCryptMsg: pointer, # void*
dwFlags: uint32, # DWORD
dwCtrlType: uint32, # DWORD
pvCtrlPara: pointer # void* optional
): int32 {.importc: "CryptMsgControl", stdcall, dynlib: "CRYPT32.dll".}pragma(lib, "crypt32");
extern(Windows)
int CryptMsgControl(
void* hCryptMsg, // void*
uint dwFlags, // DWORD
uint dwCtrlType, // DWORD
void* pvCtrlPara // void* optional
);ccall((:CryptMsgControl, "CRYPT32.dll"), stdcall, Int32,
(Ptr{Cvoid}, UInt32, UInt32, Ptr{Cvoid}),
hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara)
# hCryptMsg : void* -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# dwCtrlType : DWORD -> UInt32
# pvCtrlPara : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CryptMsgControl(
void* hCryptMsg,
uint32_t dwFlags,
uint32_t dwCtrlType,
void* pvCtrlPara);
]]
local crypt32 = ffi.load("crypt32")
-- crypt32.CryptMsgControl(hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara)
-- hCryptMsg : void*
-- dwFlags : DWORD
-- dwCtrlType : DWORD
-- pvCtrlPara : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('CRYPT32.dll');
const CryptMsgControl = lib.func('__stdcall', 'CryptMsgControl', 'int32_t', ['void *', 'uint32_t', 'uint32_t', 'void *']);
// CryptMsgControl(hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara)
// hCryptMsg : void* -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// dwCtrlType : DWORD -> 'uint32_t'
// pvCtrlPara : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("CRYPT32.dll", {
CryptMsgControl: { parameters: ["pointer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.CryptMsgControl(hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara)
// hCryptMsg : void* -> "pointer"
// dwFlags : DWORD -> "u32"
// dwCtrlType : DWORD -> "u32"
// pvCtrlPara : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CryptMsgControl(
void* hCryptMsg,
uint32_t dwFlags,
uint32_t dwCtrlType,
void* pvCtrlPara);
C, "CRYPT32.dll");
// $ffi->CryptMsgControl(hCryptMsg, dwFlags, dwCtrlType, pvCtrlPara);
// hCryptMsg : void*
// dwFlags : DWORD
// dwCtrlType : DWORD
// pvCtrlPara : void* optional
// 構造体/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 Crypt32 extends StdCallLibrary {
Crypt32 INSTANCE = Native.load("crypt32", Crypt32.class);
boolean CryptMsgControl(
Pointer hCryptMsg, // void*
int dwFlags, // DWORD
int dwCtrlType, // DWORD
Pointer pvCtrlPara // void* optional
);
}@[Link("crypt32")]
lib LibCRYPT32
fun CryptMsgControl = CryptMsgControl(
hCryptMsg : Void*, # void*
dwFlags : UInt32, # DWORD
dwCtrlType : UInt32, # DWORD
pvCtrlPara : Void* # void* optional
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CryptMsgControlNative = Int32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>);
typedef CryptMsgControlDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final CryptMsgControl = DynamicLibrary.open('CRYPT32.dll')
.lookupFunction<CryptMsgControlNative, CryptMsgControlDart>('CryptMsgControl');
// hCryptMsg : void* -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// dwCtrlType : DWORD -> Uint32
// pvCtrlPara : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CryptMsgControl(
hCryptMsg: Pointer; // void*
dwFlags: DWORD; // DWORD
dwCtrlType: DWORD; // DWORD
pvCtrlPara: Pointer // void* optional
): BOOL; stdcall;
external 'CRYPT32.dll' name 'CryptMsgControl';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CryptMsgControl"
c_CryptMsgControl :: Ptr () -> Word32 -> Word32 -> Ptr () -> IO CInt
-- hCryptMsg : void* -> Ptr ()
-- dwFlags : DWORD -> Word32
-- dwCtrlType : DWORD -> Word32
-- pvCtrlPara : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let cryptmsgcontrol =
foreign "CryptMsgControl"
((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hCryptMsg : void* -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* dwCtrlType : DWORD -> uint32_t *)
(* pvCtrlPara : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library crypt32 (t "CRYPT32.dll"))
(cffi:use-foreign-library crypt32)
(cffi:defcfun ("CryptMsgControl" crypt-msg-control :convention :stdcall) :int32
(h-crypt-msg :pointer) ; void*
(dw-flags :uint32) ; DWORD
(dw-ctrl-type :uint32) ; DWORD
(pv-ctrl-para :pointer)) ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CryptMsgControl = Win32::API::More->new('CRYPT32',
'BOOL CryptMsgControl(LPVOID hCryptMsg, DWORD dwFlags, DWORD dwCtrlType, LPVOID pvCtrlPara)');
# my $ret = $CryptMsgControl->Call($hCryptMsg, $dwFlags, $dwCtrlType, $pvCtrlPara);
# hCryptMsg : void* -> LPVOID
# dwFlags : DWORD -> DWORD
# dwCtrlType : DWORD -> DWORD
# pvCtrlPara : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。