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

CMSG_STREAM_INFO

構造体
サイズx64: 24 バイト / x86: 12 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
cbContentDWORD4+0+0コンテンツのサイズをバイト単位で指定します。CMSG_INDEFINITE_LENGTH(0xFFFFFFFF) が渡されない限り、通常の Distinguished Encoding Rules (DER) エンコードが使用されます。CMSG_INDEFINITE_LENGTH を渡すことは、アプリケーションがコンテンツの長さを指定しないことを示します。これにより、不定長の Basic Encoding Rules (BER) エンコードの使用が強制されます。
pfnStreamOutputPFN_CMSG_STREAM_OUTPUT8/4+8+4

大きなメッセージを処理する際に、ディスクからデータを読み取り、ディスクにデータを書き込むために使用されるコールバック関数のアドレスです。

コールバック関数は、次のシグネチャとパラメーターを持つ必要があります。

#include <windows.h>
#include <Wincrypt.h>

BOOL WINAPI CmsgStreamOutputCallback(
  IN const void *pvArg,  //in
  IN BYTE *pbData,       //in
  IN DWORD cbData,       //in
  IN BOOL fFinal         //in
);
意味
pvArg
CMSG_STREAM_INFO で指定された引数です。
pbData
アプリケーションが利用できる、処理済みデータのブロックへのポインターです。
cbData
pbData にある処理済みデータのブロックのサイズ (バイト単位) です。
fFinal
最後のデータブロックを処理中であり、コールバックが実行されるのはこれが最後であることを示します。
pvArgvoid*8/4+16+8コールバック関数に渡す引数へのポインターです。通常これは、より深くネストされたメッセージ (デコード時) またはより浅くネストされたメッセージ (エンコード時) へのハンドルを含む状態データに使用されます。

公式ドキュメント

CMSG_STREAM_INFO 構造体は、データを単一ブロックで処理するのではなく、ストリーム処理できるようにするために使用されます。ストリーム処理は、大きなメッセージを処理する場合に最もよく使用されます。ストリーム処理されるメッセージは、ハードディスク上のファイル、サーバー、CD ROM など、シリアル化された任意のソースから取得できます。

この構造体は、 CryptMsgOpenToEncode 関数および CryptMsgOpenToDecode 関数に渡されます。

解説(Remarks)

メッセージが非常に大きい場合、メッセージ全体をメモリに格納して一度に処理することは、困難であるか不可能なことさえあります。処理対象のデータを扱いやすいサイズのブロックにストリーミングすることで、メモリの制限に達することなく大きなメッセージを処理できます。メッセージのエンコードまたはデコードには、ストリーミングと共に 下位レベルのメッセージ関数 を使用できます。ストリーミングによるエンコードおよびデコードでは、任意の深さのメッセージのネストがサポートされます。

ストリームとして処理する入力メッセージは、一度に 1 ブロックずつ CryptMsgUpdate に入力され、ブロックのサイズはアプリケーションが決定します。ストリーミングされたメッセージがエンコードまたはデコードのために処理されると、結果として得られる出力データは、pfnStreamOutput メンバーで指定されたアプリケーション定義のコールバック関数を通じてアプリケーションに返されます。

出力データのブロックサイズについて仮定することはできません。サイズはいくつかの理由で変動するためです。たとえば、エンベロープされたメッセージを処理する際に暗号化アルゴリズムのブロックサイズによって出力ブロックサイズにばらつきが生じる場合や、PKCS # 7 で定義されているメッセージヘッダーと SignerInfo を含むブロックが処理される場合などです。

出力ブロックのサイズは、コールバック関数の cbData パラメーターで渡されます。出力データの用途は、呼び出し元のアプリケーションが決定します。通常、メモリの制限により、ストリーム処理の出力は全体をメモリ上に保持せず、ディスクまたはサーバー上のファイルにシリアル化します。

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

各言語での定義

#include <windows.h>

// CMSG_STREAM_INFO  (x64 24 / x86 12 バイト)
typedef struct CMSG_STREAM_INFO {
    DWORD cbContent;
    PFN_CMSG_STREAM_OUTPUT pfnStreamOutput;
    void* pvArg;
} CMSG_STREAM_INFO;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CMSG_STREAM_INFO
{
    public uint cbContent;
    public IntPtr pfnStreamOutput;
    public IntPtr pvArg;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CMSG_STREAM_INFO
    Public cbContent As UInteger
    Public pfnStreamOutput As IntPtr
    Public pvArg As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class CMSG_STREAM_INFO(ctypes.Structure):
    _fields_ = [
        ("cbContent", wintypes.DWORD),
        ("pfnStreamOutput", ctypes.c_void_p),
        ("pvArg", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct CMSG_STREAM_INFO {
    pub cbContent: u32,
    pub pfnStreamOutput: *mut core::ffi::c_void,
    pub pvArg: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type CMSG_STREAM_INFO struct {
	cbContent uint32
	pfnStreamOutput uintptr
	pvArg uintptr
}
type
  CMSG_STREAM_INFO = record
    cbContent: DWORD;
    pfnStreamOutput: Pointer;
    pvArg: Pointer;
  end;
const CMSG_STREAM_INFO = extern struct {
    cbContent: u32,
    pfnStreamOutput: ?*anyopaque,
    pvArg: ?*anyopaque,
};
type
  CMSG_STREAM_INFO {.bycopy.} = object
    cbContent: uint32
    pfnStreamOutput: pointer
    pvArg: pointer
struct CMSG_STREAM_INFO
{
    uint cbContent;
    void* pfnStreamOutput;
    void* pvArg;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; CMSG_STREAM_INFO サイズ: 12 バイト(x86)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; cbContent : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; pfnStreamOutput : PFN_CMSG_STREAM_OUTPUT (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pvArg : void* (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CMSG_STREAM_INFO サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; cbContent : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; pfnStreamOutput : PFN_CMSG_STREAM_OUTPUT (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; pvArg : void* (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global CMSG_STREAM_INFO
    #field int cbContent
    #field intptr pfnStreamOutput
    #field intptr pvArg
#endstruct

stdim st, CMSG_STREAM_INFO        ; NSTRUCT 変数を確保
st->cbContent = 100
mes "cbContent=" + st->cbContent