ホーム › Security.Cryptography › CryptMsgUpdate

CryptMsgUpdate

関数

暗号メッセージにデータを追加して処理を更新する。

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

シグネチャ

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

BOOL CryptMsgUpdate(
    void* hCryptMsg,
    const BYTE* pbData,   // optional
    DWORD cbData,
    BOOL fFinal
);

パラメーター

名前	型	方向	説明
hCryptMsg	void*	in	更新対象となるメッセージの暗号化メッセージハンドル。
pbData	BYTE*	inoptional	エンコードまたはデコードするデータを保持するバッファーへのポインター。
cbData	DWORD	in	pbData バッファー内のデータのバイト数。
fFinal	BOOL	in	エンコードまたはデコードの対象となる最後のデータブロックを処理していることを示します。このフラグの正しい使い方は、処理対象のメッセージがデタッチされたデータを持つかどうかによって異なります。メッセージにデタッチされたデータが含まれているかどうかは、メッセージを開いた関数の呼び出し時に dwFlags へ CMSG_DETACHED_FLAG を設定したかどうかで示されます。 CMSG_DETACHED_FLAG が設定されておらず、メッセージが CryptMsgOpenToDecode または CryptMsgOpenToEncode で開かれた場合は、fFinal を TRUE に設定し、CryptMsgUpdate は一度だけ呼び出します。 CMSG_DETACHED_FLAG フラグが設定され、メッセージが CryptMsgOpenToEncode で開かれた場合は、CryptMsgUpdate の最後の呼び出しでのみ fFinal を TRUE に設定します。 CMSG_DETACHED_FLAG フラグが設定され、メッセージが CryptMsgOpenToDecode で開かれた場合は、CryptMsgUpdate を一度呼び出してヘッダーを処理する際に fFinal を TRUE に設定します。その後の CryptMsgUpdate 呼び出しでデタッチされたデータを処理している間は、最後のデタッチされたデータブロックを処理するまで FALSE に設定します。CryptMsgUpdate の最後の呼び出しでは TRUE に設定します。デタッチされたデータをデコードする際、メッセージのヘッダーとコンテンツは別々の BLOB に含まれます。各 BLOB について、その BLOB に対する最後の関数呼び出しを行う際に fFinal を TRUE に設定する必要があります。

戻り値の型: BOOL

公式ドキュメント

暗号化メッセージにコンテンツを追加します。

戻り値

関数が成功した場合、戻り値は 0 以外 (TRUE) です。

関数が失敗した場合、戻り値は 0 (FALSE) です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

ストリーミングを使用している場合、 CryptMsgOpenToDecode および CryptMsgOpenToEncode の pStreamInfo で指定されたアプリケーション定義のコールバック関数で発生したエラーが、CryptMsgUpdate へ伝播されることがあります。この場合、コールバック関数が戻った後に CryptMsgUpdate が SetLastError を呼び出さないため、アプリケーションの制御下で発生したエラーが保持されます。アプリケーションがストリーミングされたデータを処理している間にエラーが発生した場合に SetLastError を呼び出すのは、コールバック関数 (またはそこから呼び出される API のいずれか) の責任です。

次の表に、GetLastError 関数によって最もよく返されるエラーコードを示します。

戻りコード	説明
CRYPT_E_INVALID_MSG_TYPE	メッセージの種類が無効です。
CRYPT_E_MSG_ERROR	暗号化操作の実行中にエラーが発生しました。
CRYPT_E_OID_FORMAT	オブジェクト識別子の形式が正しくありません。
CRYPT_E_UNEXPECTED_ENCODING	メッセージが期待されるとおりにエンコードされていません。
CRYPT_E_UNKNOWN_ALGO	暗号化アルゴリズムが不明です。
E_INVALIDARG	1 つ以上の引数が無効です。
E_OUTOFMEMORY	メモリが不足しました。

次の関数のいずれかから伝播されたエラーが発生することがあります。

関数が失敗した場合、GetLastError が Abstract Syntax Notation One (ASN.1) のエンコード/デコードエラーを返すことがあります。これらのエラーについては、 ASN.1 Encoding/Decoding Return Values を参照してください。

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

各言語での呼び出し定義

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

BOOL CryptMsgUpdate(
    void* hCryptMsg,
    const BYTE* pbData,   // optional
    DWORD cbData,
    BOOL fFinal
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptMsgUpdate(
    IntPtr hCryptMsg,   // void*
    IntPtr pbData,   // BYTE* optional
    uint cbData,   // DWORD
    bool fFinal   // BOOL
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptMsgUpdate(
    hCryptMsg As IntPtr,   ' void*
    pbData As IntPtr,   ' BYTE* optional
    cbData As UInteger,   ' DWORD
    fFinal As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hCryptMsg : void*
' pbData : BYTE* optional
' cbData : DWORD
' fFinal : BOOL
Declare PtrSafe Function CryptMsgUpdate Lib "crypt32" ( _
    ByVal hCryptMsg As LongPtr, _
    ByVal pbData As LongPtr, _
    ByVal cbData As Long, _
    ByVal fFinal As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptMsgUpdate = ctypes.windll.crypt32.CryptMsgUpdate
CryptMsgUpdate.restype = wintypes.BOOL
CryptMsgUpdate.argtypes = [
    ctypes.POINTER(None),  # hCryptMsg : void*
    ctypes.POINTER(ctypes.c_ubyte),  # pbData : BYTE* optional
    wintypes.DWORD,  # cbData : DWORD
    wintypes.BOOL,  # fFinal : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptMsgUpdate = Fiddle::Function.new(
  lib['CryptMsgUpdate'],
  [
    Fiddle::TYPE_VOIDP,  # hCryptMsg : void*
    Fiddle::TYPE_VOIDP,  # pbData : BYTE* optional
    -Fiddle::TYPE_INT,  # cbData : DWORD
    Fiddle::TYPE_INT,  # fFinal : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptMsgUpdate(
        hCryptMsg: *mut (),  // void*
        pbData: *const u8,  // BYTE* optional
        cbData: u32,  // DWORD
        fFinal: i32  // BOOL
    ) -> 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 CryptMsgUpdate(IntPtr hCryptMsg, IntPtr pbData, uint cbData, bool fFinal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptMsgUpdate' -Namespace Win32 -PassThru
# $api::CryptMsgUpdate(hCryptMsg, pbData, cbData, fFinal)

#uselib "CRYPT32.dll"
#func global CryptMsgUpdate "CryptMsgUpdate" sptr, sptr, sptr, sptr
; CryptMsgUpdate hCryptMsg, varptr(pbData), cbData, fFinal   ; 戻り値は stat
; hCryptMsg : void* -> "sptr"
; pbData : BYTE* optional -> "sptr"
; cbData : DWORD -> "sptr"
; fFinal : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptMsgUpdate "CryptMsgUpdate" sptr, var, int, int
; res = CryptMsgUpdate(hCryptMsg, pbData, cbData, fFinal)
; hCryptMsg : void* -> "sptr"
; pbData : BYTE* optional -> "var"
; cbData : DWORD -> "int"
; fFinal : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptMsgUpdate "CryptMsgUpdate" sptr, sptr, int, int
; res = CryptMsgUpdate(hCryptMsg, varptr(pbData), cbData, fFinal)
; hCryptMsg : void* -> "sptr"
; pbData : BYTE* optional -> "sptr"
; cbData : DWORD -> "int"
; fFinal : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。