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

BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO

構造体
サイズx64: 88 バイト / x86: 64 バイト

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

フィールド

フィールドサイズx64x86説明
cbSizeDWORD4+0+0この構造体のサイズ (バイト単位) です。このフィールドを直接設定しないでください。代わりに BCRYPT_INIT_AUTH_MODE_INFO マクロを使用してください。
dwInfoVersionDWORD4+4+4構造体のバージョン番号です。 サポートされる値は BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO_VERSION のみです。このフィールドを直接設定しないでください。代わりに BCRYPT_INIT_AUTH_MODE_INFO マクロを使用してください。
pbNonceBYTE*8/4+8+8ノンスを格納するバッファーへのポインターです。Advanced Encryption Standard (AES) 用の Microsoft アルゴリズムプロバイダーは、Counter with CBC-MAC (CCM) モードおよび Galois/Counter Mode (GCM) の連鎖モードでノンスを必要とし、指定がない場合はエラーを返します。ノンスを使用しない場合、このメンバーは NULL に設定しなければなりません。
cbNonceDWORD4+16+12pbNonce メンバーが指すバッファーのサイズ (バイト単位) です。 ノンスを使用しない場合、このメンバーは 0 に設定しなければなりません。
pbAuthDataBYTE*8/4+24+16認証データを格納するバッファーへのポインターです。 これは Message Authentication Code (MAC) には含まれますが、暗号化されないデータです。 認証データがない場合、このメンバーは NULL に設定しなければなりません。
cbAuthDataDWORD4+32+20pbAuthData メンバーが指すバッファーのサイズ (バイト単位) です。 認証データがない場合、このメンバーは 0 に設定しなければなりません。
pbTagBYTE*8/4+40+24

バッファーへのポインターです。

このメンバーの用途は、この構造体を渡す関数によって異なります。

関数 説明
BCryptEncrypt
バッファーは認証タグを受け取ります。
BCryptDecrypt
バッファーには、照合に使用する認証タグが格納されます。

タグがない場合、このメンバーは NULL に設定しなければなりません。

cbTagDWORD4+48+28pbTag バッファーのサイズ (バイト単位) です。バッファーは認証タグ全体を格納できるだけの長さでなければなりません。 CCM や GCM などの一部の認証モードでは、複数の長さのタグとの照合がサポートされます。 有効な認証タグの長さを取得するには、BCryptGetProperty を使用して BCRYPT_AUTH_TAG_LENGTH プロパティを照会します。 タグがない場合、このメンバーは 0 に設定しなければなりません。
pbMacContextBYTE*8/4+56+32

暗号化または復号化を連鎖させる場合に、BCryptEncryptBCryptDecrypt の呼び出し間で部分的に計算された MAC を保持するバッファーへのポインターです。

暗号化または復号化の入力が複数のバッファーに分散している場合は、BCryptEncrypt 関数および BCryptDecrypt 関数の呼び出しを連鎖させる必要があります。連鎖は、dwFlags メンバーに BCRYPT_AUTH_MODE_IN_PROGRESS_FLAG フラグを設定することで指示します。

このバッファーは呼び出し元が用意する必要があり、使用する暗号の認証タグの最大長以上のサイズでなければなりません。有効な認証タグの長さを取得するには、BCryptGetProperty を使用して BCRYPT_AUTH_TAG_LENGTH プロパティを照会します。

BCryptEncryptBCryptDecrypt の呼び出しを連鎖させない場合、このメンバーは NULL に設定しなければなりません。

cbMacContextDWORD4+64+36pbMacContext メンバーが指すバッファーのサイズ (バイト単位) です。 BCryptEncryptBCryptDecrypt の呼び出しを連鎖させない場合、このメンバーは 0 に設定しなければなりません。
cbAADDWORD4+68+40

BCryptEncrypt 関数および BCryptDecrypt 関数が使用する追加認証データ (AAD) の長さ (バイト単位) です。 このメンバーは、呼び出しを連鎖させる場合にのみ使用されます。

このメンバーは、dwFlags メンバーに BCRYPT_AUTH_MODE_IN_PROGRESS_FLAG フラグが設定されている場合にのみ使用されます。

BCryptEncrypt または BCryptDecrypt の最初の呼び出しでは、このフィールドを 0 に設定しなければなりません。

Note 連鎖の途中では、このメンバーは内部的に管理されます。変更すると、計算される MAC の値が壊れます。
cbDataULONGLONG8+72+48

暗号化または復号化されたペイロードデータの長さ (バイト単位) です。 このメンバーは、呼び出しを連鎖させる場合にのみ使用されます。

このメンバーは、dwFlags メンバーに BCRYPT_AUTH_MODE_IN_PROGRESS_FLAG フラグが設定されている場合にのみ使用されます。

BCryptEncrypt または BCryptDecrypt の最初の呼び出しでは、直接設定するか BCRYPT_INIT_AUTH_INFO マクロを呼び出して、このフィールドを 0 に設定しなければなりません。

Note 連鎖の途中では、このメンバーは内部的に管理されます。変更すると、計算される MAC の値が壊れます。
dwFlagsDWORD4+80+56

このフラグは、BCryptEncrypt または BCryptDecrypt 関数の呼び出しを連鎖させる場合に使用します。 呼び出しを連鎖させない場合、このメンバーは 0 に設定しなければなりません。

意味
0x00000000
BCryptEncrypt の場合は、認証タグを計算し、pbTag メンバーが指すバッファーに格納します。

BCryptDecrypt の場合は、認証タグを計算し、pbTag メンバーが指すバッファーに渡されたタグと比較します。BCryptEncrypt または BCryptDecrypt の複数回の呼び出しを連鎖させる場合、この値は連鎖の終了を示します。

BCRYPT_AUTH_MODE_CHAIN_CALLS_FLAG
0x00000001
BCryptEncrypt 関数および BCryptDecrypt 関数の呼び出しが連鎖しており、MAC 値は計算されないことを示します。連鎖の最後の呼び出しでこの値をクリアすると、連鎖全体に対する MAC 値が計算されます。
BCRYPT_AUTH_MODE_IN_PROGRESS_FLAG
0x00000002
この BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO 構造体が、連鎖した BCryptEncrypt 関数または BCryptDecrypt 関数の一連の呼び出しで使用されていることを示します。このフラグは内部的に設定および管理されます。
Note 連鎖の途中では、このフラグの値は内部的に管理されます。変更すると、計算される MAC の値が壊れます。

公式ドキュメント

BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO 構造体は、BCryptEncrypt 関数および BCryptDecrypt 関数で使用し、認証付き暗号モードに関する追加情報を格納します。

解説(Remarks)

この構造体のサイズは、64 ビットオペレーティングシステムと 32 ビットオペレーティングシステムとで異なります。 64 ビットオペレーティングシステムでは、64 ビットプロセスと 32 ビットプロセスとでサイズが異なります。 この構造体のインスタンスは、スレッド間で共有したり、プロセス間で受け渡したりしてはなりません。

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

各言語での定義

#include <windows.h>

// BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO  (x64 88 / x86 64 バイト)
typedef struct BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO {
    DWORD cbSize;
    DWORD dwInfoVersion;
    BYTE* pbNonce;
    DWORD cbNonce;
    BYTE* pbAuthData;
    DWORD cbAuthData;
    BYTE* pbTag;
    DWORD cbTag;
    BYTE* pbMacContext;
    DWORD cbMacContext;
    DWORD cbAAD;
    ULONGLONG cbData;
    DWORD dwFlags;
} BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO
{
    public uint cbSize;
    public uint dwInfoVersion;
    public IntPtr pbNonce;
    public uint cbNonce;
    public IntPtr pbAuthData;
    public uint cbAuthData;
    public IntPtr pbTag;
    public uint cbTag;
    public IntPtr pbMacContext;
    public uint cbMacContext;
    public uint cbAAD;
    public ulong cbData;
    public uint dwFlags;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO
    Public cbSize As UInteger
    Public dwInfoVersion As UInteger
    Public pbNonce As IntPtr
    Public cbNonce As UInteger
    Public pbAuthData As IntPtr
    Public cbAuthData As UInteger
    Public pbTag As IntPtr
    Public cbTag As UInteger
    Public pbMacContext As IntPtr
    Public cbMacContext As UInteger
    Public cbAAD As UInteger
    Public cbData As ULong
    Public dwFlags As UInteger
End Structure
import ctypes
from ctypes import wintypes

class BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO(ctypes.Structure):
    _fields_ = [
        ("cbSize", wintypes.DWORD),
        ("dwInfoVersion", wintypes.DWORD),
        ("pbNonce", ctypes.c_void_p),
        ("cbNonce", wintypes.DWORD),
        ("pbAuthData", ctypes.c_void_p),
        ("cbAuthData", wintypes.DWORD),
        ("pbTag", ctypes.c_void_p),
        ("cbTag", wintypes.DWORD),
        ("pbMacContext", ctypes.c_void_p),
        ("cbMacContext", wintypes.DWORD),
        ("cbAAD", wintypes.DWORD),
        ("cbData", ctypes.c_ulonglong),
        ("dwFlags", wintypes.DWORD),
    ]
#[repr(C)]
pub struct BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO {
    pub cbSize: u32,
    pub dwInfoVersion: u32,
    pub pbNonce: *mut core::ffi::c_void,
    pub cbNonce: u32,
    pub pbAuthData: *mut core::ffi::c_void,
    pub cbAuthData: u32,
    pub pbTag: *mut core::ffi::c_void,
    pub cbTag: u32,
    pub pbMacContext: *mut core::ffi::c_void,
    pub cbMacContext: u32,
    pub cbAAD: u32,
    pub cbData: u64,
    pub dwFlags: u32,
}
import "golang.org/x/sys/windows"

type BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO struct {
	cbSize uint32
	dwInfoVersion uint32
	pbNonce uintptr
	cbNonce uint32
	pbAuthData uintptr
	cbAuthData uint32
	pbTag uintptr
	cbTag uint32
	pbMacContext uintptr
	cbMacContext uint32
	cbAAD uint32
	cbData uint64
	dwFlags uint32
}
type
  BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO = record
    cbSize: DWORD;
    dwInfoVersion: DWORD;
    pbNonce: Pointer;
    cbNonce: DWORD;
    pbAuthData: Pointer;
    cbAuthData: DWORD;
    pbTag: Pointer;
    cbTag: DWORD;
    pbMacContext: Pointer;
    cbMacContext: DWORD;
    cbAAD: DWORD;
    cbData: UInt64;
    dwFlags: DWORD;
  end;
const BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO = extern struct {
    cbSize: u32,
    dwInfoVersion: u32,
    pbNonce: ?*anyopaque,
    cbNonce: u32,
    pbAuthData: ?*anyopaque,
    cbAuthData: u32,
    pbTag: ?*anyopaque,
    cbTag: u32,
    pbMacContext: ?*anyopaque,
    cbMacContext: u32,
    cbAAD: u32,
    cbData: u64,
    dwFlags: u32,
};
type
  BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO {.bycopy.} = object
    cbSize: uint32
    dwInfoVersion: uint32
    pbNonce: pointer
    cbNonce: uint32
    pbAuthData: pointer
    cbAuthData: uint32
    pbTag: pointer
    cbTag: uint32
    pbMacContext: pointer
    cbMacContext: uint32
    cbAAD: uint32
    cbData: uint64
    dwFlags: uint32
struct BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO
{
    uint cbSize;
    uint dwInfoVersion;
    void* pbNonce;
    uint cbNonce;
    void* pbAuthData;
    uint cbAuthData;
    void* pbTag;
    uint cbTag;
    void* pbMacContext;
    uint cbMacContext;
    uint cbAAD;
    ulong cbData;
    uint dwFlags;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO サイズ: 64 バイト(x86)
dim st, 16    ; 4byte整数×16(構造体サイズ 64 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwInfoVersion : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pbNonce : BYTE* (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; cbNonce : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; pbAuthData : BYTE* (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; cbAuthData : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; pbTag : BYTE* (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; cbTag : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; pbMacContext : BYTE* (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; cbMacContext : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; cbAAD : DWORD (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; cbData : ULONGLONG (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; dwFlags : DWORD (+56, 4byte)  st.14 = 値  /  値 = st.14   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO サイズ: 88 バイト(x64)
dim st, 22    ; 4byte整数×22(構造体サイズ 88 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwInfoVersion : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pbNonce : BYTE* (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; cbNonce : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; pbAuthData : BYTE* (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; cbAuthData : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; pbTag : BYTE* (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; cbTag : DWORD (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; pbMacContext : BYTE* (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; cbMacContext : DWORD (+64, 4byte)  st.16 = 値  /  値 = st.16   (lpoke/lpeek も可)
; cbAAD : DWORD (+68, 4byte)  st.17 = 値  /  値 = st.17   (lpoke/lpeek も可)
; cbData : ULONGLONG (+72, 8byte)  qpoke st,72,値 / qpeek(st,72)  ※IronHSPのみ。3.7/3.8は lpoke st,72,下位 : lpoke st,76,上位
; dwFlags : DWORD (+80, 4byte)  st.20 = 値  /  値 = st.20   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO
    #field int cbSize
    #field int dwInfoVersion
    #field intptr pbNonce
    #field int cbNonce
    #field intptr pbAuthData
    #field int cbAuthData
    #field intptr pbTag
    #field int cbTag
    #field intptr pbMacContext
    #field int cbMacContext
    #field int cbAAD
    #field int64 cbData
    #field int dwFlags
#endstruct

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