ホーム › Security.Cryptography › CryptDecodeMessage

CryptDecodeMessage

関数

暗号化や署名付きメッセージをデコードして内容を取得する。

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

シグネチャ

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

BOOL CryptDecodeMessage(
    DWORD dwMsgTypeFlags,
    CRYPT_DECRYPT_MESSAGE_PARA* pDecryptPara,   // optional
    CRYPT_VERIFY_MESSAGE_PARA* pVerifyPara,   // optional
    DWORD dwSignerIndex,
    const BYTE* pbEncodedBlob,
    DWORD cbEncodedBlob,
    DWORD dwPrevInnerContentType,
    DWORD* pdwMsgType,   // optional
    DWORD* pdwInnerContentType,   // optional
    BYTE* pbDecoded,   // optional
    DWORD* pcbDecoded,   // optional
    CERT_CONTEXT** ppXchgCert,   // optional
    CERT_CONTEXT** ppSignerCert   // optional
);

パラメーター

名前	型	方向	説明
dwMsgTypeFlags	DWORD	in	メッセージの種類を示します。メッセージの種類はビット単位の OR 演算子で組み合わせることができます。このパラメーターには次のいずれかのメッセージの種類を指定できます。 CMSG_DATA_FLAG CMSG_SIGNED_FLAG CMSG_ENVELOPED_FLAG CMSG_SIGNED_AND_ENVELOPED_FLAG CMSG_HASHED_FLAG 注意関数から戻った後、pdwMsgType が指す DWORD には、メッセージの種類が設定されます。
pDecryptPara	CRYPT_DECRYPT_MESSAGE_PARA*	inoptional	復号パラメーターを格納する CRYPT_DECRYPT_MESSAGE_PARA 構造体へのポインターです。
pVerifyPara	CRYPT_VERIFY_MESSAGE_PARA*	inoptional	検証パラメーターを格納する CRYPT_VERIFY_MESSAGE_PARA 構造体へのポインターです。
dwSignerIndex	DWORD	in	メッセージに存在しうる複数の署名者のうち、どの署名者を検証するかを示します。このインデックスを変えながら関数を複数回呼び出すことで、追加の署名者を検証できます。最初の署名者では dwSignerIndex を 0 に設定します。関数が FALSE を返し、かつ GetLastError が CRYPT_E_NO_SIGNER を返した場合、直前の呼び出しでメッセージの最後の署名者が返されたことを意味します。このパラメーターは CMSG_SIGNED_AND_ENVELOPED 型または CMSG_SIGNED 型のメッセージでのみ使用します。その他のメッセージの種類では 0 に設定してください。
pbEncodedBlob	BYTE*	in	デコード対象となるエンコードされた BLOB へのポインターです。
cbEncodedBlob	DWORD	in	エンコードされた BLOB のサイズ (バイト単位) です。
dwPrevInnerContentType	DWORD	in	入れ子になった暗号化メッセージを処理する場合にのみ適用されます。外側の暗号化メッセージを処理する場合は 0 に設定する必要があります。入れ子になった暗号化メッセージをデコードする場合は、外側のメッセージに対する以前の CryptDecodeMessage の呼び出しで pdwInnerContentType に返された値を設定します。pdwMsgType に一覧表示されている任意の CMSG 型を指定できます。下位互換性のため、dwPrevInnerContentType は 0 に設定してください。
pdwMsgType	DWORD*	outoptional	返されるメッセージの種類を指定する DWORD へのポインターです。このパラメーターには次のいずれかのメッセージの種類を指定できます。 CMSG_DATA CMSG_SIGNED CMSG_ENVELOPED CMSG_SIGNED_AND_ENVELOPED CMSG_HASHED
pdwInnerContentType	DWORD*	outoptional	内側のメッセージの種類を指定する DWORD へのポインターです。pdwMsgType で使用されるメッセージの種類のコードがここでも使用されます。暗号化の入れ子がない場合は CMSG_DATA が返されます。
pbDecoded	BYTE*	outoptional	デコードされたメッセージを受け取るバッファーへのポインターです。デコードされたメッセージが不要な場合、またはメモリ割り当てのためにデコードされたメッセージのサイズを取得する場合は、このパラメーターを NULL にできます。このパラメーターが NULL の場合、デコードされたメッセージは返されません。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbDecoded	DWORD*	inoutoptional	pbDecoded パラメーターが指すバッファーのサイズ (バイト単位) を指定する変数へのポインターです。関数から戻ると、この変数にはデコードされたメッセージのサイズが格納されます。注意バッファーに返されたデータを処理する際、アプリケーションは実際に返されたデータのサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなる場合があります。(入力時には、出力されうる最大のデータが収まるよう、通常は十分に大きなバッファーサイズを指定します。) 出力時には、このパラメーターが指す変数が、バッファーにコピーされた実際のデータサイズを反映するように更新されます。
ppXchgCert	CERT_CONTEXT**	outoptional	メッセージのデコードに必要な秘密交換キーに対応する証明書を持つ CERT_CONTEXT 構造体へのポインターへのポインターです。このパラメーターは CMSG_ENVELOPED 型および CMSG_SIGNED_AND_ENVELOPED 型のメッセージに対してのみ設定されます。
ppSignerCert	CERT_CONTEXT**	outoptional	署名者の証明書コンテキストを表す CERT_CONTEXT 構造体へのポインターへのポインターです。このパラメーターは CMSG_SIGNED 型および CMSG_SIGNED_AND_ENVELOPED 型のメッセージに対してのみ設定されます。

戻り値の型: BOOL

公式ドキュメント

暗号化メッセージのデコード、復号、および検証を行います。

戻り値

関数が成功すると、0 以外の値 (TRUE) が返されます。

関数が失敗すると、0 (FALSE) が返されます。拡張エラー情報を取得するには、 GetLastError を呼び出します。

CryptDecryptMessage、 CryptVerifyMessageSignature、または CryptVerifyMessageHash 関数のエラーがこの関数に伝播することがあります。

次のエラーコードが GetLastError 関数によって返される最も一般的なものです。

戻り値	説明
ERROR_MORE_DATA	pbDecoded パラメーターで指定したバッファーが返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbDecoded が指す変数に格納します。

解説(Remarks)

dwMsgTypeFlags パラメーターは、許可されるメッセージの集合を指定します。たとえば、SIGNED メッセージまたは ENVELOPED メッセージのいずれかをデコードするには、dwMsgTypeFlags に CMSG_SIGNED_FLAG | CMSG_ENVELOPED_FLAG を設定します。pDecryptPara パラメーターまたは pVerifyPara パラメーターのいずれか一方、または両方を指定する必要があります。

メッセージのデコードまたは検証に成功すると、ppXchgCert および ppSignerCert が指す証明書コンテキストのポインターが更新されます。これらは CertFreeCertificateContext を呼び出して解放する必要があります。関数が失敗した場合、これらは NULL に設定されます。

関数を呼び出す前に ppXchgCert または ppSignerCert パラメーターを NULL に設定できます。これは、交換証明書または署名者の証明書コンテキストの取得を呼び出し元が必要としないことを示します。

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

各言語での呼び出し定義

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

BOOL CryptDecodeMessage(
    DWORD dwMsgTypeFlags,
    CRYPT_DECRYPT_MESSAGE_PARA* pDecryptPara,   // optional
    CRYPT_VERIFY_MESSAGE_PARA* pVerifyPara,   // optional
    DWORD dwSignerIndex,
    const BYTE* pbEncodedBlob,
    DWORD cbEncodedBlob,
    DWORD dwPrevInnerContentType,
    DWORD* pdwMsgType,   // optional
    DWORD* pdwInnerContentType,   // optional
    BYTE* pbDecoded,   // optional
    DWORD* pcbDecoded,   // optional
    CERT_CONTEXT** ppXchgCert,   // optional
    CERT_CONTEXT** ppSignerCert   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptDecodeMessage(
    uint dwMsgTypeFlags,   // DWORD
    IntPtr pDecryptPara,   // CRYPT_DECRYPT_MESSAGE_PARA* optional
    IntPtr pVerifyPara,   // CRYPT_VERIFY_MESSAGE_PARA* optional
    uint dwSignerIndex,   // DWORD
    IntPtr pbEncodedBlob,   // BYTE*
    uint cbEncodedBlob,   // DWORD
    uint dwPrevInnerContentType,   // DWORD
    IntPtr pdwMsgType,   // DWORD* optional, out
    IntPtr pdwInnerContentType,   // DWORD* optional, out
    IntPtr pbDecoded,   // BYTE* optional, out
    IntPtr pcbDecoded,   // DWORD* optional, in/out
    IntPtr ppXchgCert,   // CERT_CONTEXT** optional, out
    IntPtr ppSignerCert   // CERT_CONTEXT** optional, out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptDecodeMessage(
    dwMsgTypeFlags As UInteger,   ' DWORD
    pDecryptPara As IntPtr,   ' CRYPT_DECRYPT_MESSAGE_PARA* optional
    pVerifyPara As IntPtr,   ' CRYPT_VERIFY_MESSAGE_PARA* optional
    dwSignerIndex As UInteger,   ' DWORD
    pbEncodedBlob As IntPtr,   ' BYTE*
    cbEncodedBlob As UInteger,   ' DWORD
    dwPrevInnerContentType As UInteger,   ' DWORD
    pdwMsgType As IntPtr,   ' DWORD* optional, out
    pdwInnerContentType As IntPtr,   ' DWORD* optional, out
    pbDecoded As IntPtr,   ' BYTE* optional, out
    pcbDecoded As IntPtr,   ' DWORD* optional, in/out
    ppXchgCert As IntPtr,   ' CERT_CONTEXT** optional, out
    ppSignerCert As IntPtr   ' CERT_CONTEXT** optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwMsgTypeFlags : DWORD
' pDecryptPara : CRYPT_DECRYPT_MESSAGE_PARA* optional
' pVerifyPara : CRYPT_VERIFY_MESSAGE_PARA* optional
' dwSignerIndex : DWORD
' pbEncodedBlob : BYTE*
' cbEncodedBlob : DWORD
' dwPrevInnerContentType : DWORD
' pdwMsgType : DWORD* optional, out
' pdwInnerContentType : DWORD* optional, out
' pbDecoded : BYTE* optional, out
' pcbDecoded : DWORD* optional, in/out
' ppXchgCert : CERT_CONTEXT** optional, out
' ppSignerCert : CERT_CONTEXT** optional, out
Declare PtrSafe Function CryptDecodeMessage Lib "crypt32" ( _
    ByVal dwMsgTypeFlags As Long, _
    ByVal pDecryptPara As LongPtr, _
    ByVal pVerifyPara As LongPtr, _
    ByVal dwSignerIndex As Long, _
    ByVal pbEncodedBlob As LongPtr, _
    ByVal cbEncodedBlob As Long, _
    ByVal dwPrevInnerContentType As Long, _
    ByVal pdwMsgType As LongPtr, _
    ByVal pdwInnerContentType As LongPtr, _
    ByVal pbDecoded As LongPtr, _
    ByVal pcbDecoded As LongPtr, _
    ByVal ppXchgCert As LongPtr, _
    ByVal ppSignerCert As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptDecodeMessage = ctypes.windll.crypt32.CryptDecodeMessage
CryptDecodeMessage.restype = wintypes.BOOL
CryptDecodeMessage.argtypes = [
    wintypes.DWORD,  # dwMsgTypeFlags : DWORD
    ctypes.c_void_p,  # pDecryptPara : CRYPT_DECRYPT_MESSAGE_PARA* optional
    ctypes.c_void_p,  # pVerifyPara : CRYPT_VERIFY_MESSAGE_PARA* optional
    wintypes.DWORD,  # dwSignerIndex : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbEncodedBlob : BYTE*
    wintypes.DWORD,  # cbEncodedBlob : DWORD
    wintypes.DWORD,  # dwPrevInnerContentType : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwMsgType : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwInnerContentType : DWORD* optional, out
    ctypes.POINTER(ctypes.c_ubyte),  # pbDecoded : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbDecoded : DWORD* optional, in/out
    ctypes.c_void_p,  # ppXchgCert : CERT_CONTEXT** optional, out
    ctypes.c_void_p,  # ppSignerCert : CERT_CONTEXT** optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptDecodeMessage = Fiddle::Function.new(
  lib['CryptDecodeMessage'],
  [
    -Fiddle::TYPE_INT,  # dwMsgTypeFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pDecryptPara : CRYPT_DECRYPT_MESSAGE_PARA* optional
    Fiddle::TYPE_VOIDP,  # pVerifyPara : CRYPT_VERIFY_MESSAGE_PARA* optional
    -Fiddle::TYPE_INT,  # dwSignerIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pbEncodedBlob : BYTE*
    -Fiddle::TYPE_INT,  # cbEncodedBlob : DWORD
    -Fiddle::TYPE_INT,  # dwPrevInnerContentType : DWORD
    Fiddle::TYPE_VOIDP,  # pdwMsgType : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pdwInnerContentType : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pbDecoded : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbDecoded : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # ppXchgCert : CERT_CONTEXT** optional, out
    Fiddle::TYPE_VOIDP,  # ppSignerCert : CERT_CONTEXT** optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptDecodeMessage(
        dwMsgTypeFlags: u32,  // DWORD
        pDecryptPara: *mut CRYPT_DECRYPT_MESSAGE_PARA,  // CRYPT_DECRYPT_MESSAGE_PARA* optional
        pVerifyPara: *mut CRYPT_VERIFY_MESSAGE_PARA,  // CRYPT_VERIFY_MESSAGE_PARA* optional
        dwSignerIndex: u32,  // DWORD
        pbEncodedBlob: *const u8,  // BYTE*
        cbEncodedBlob: u32,  // DWORD
        dwPrevInnerContentType: u32,  // DWORD
        pdwMsgType: *mut u32,  // DWORD* optional, out
        pdwInnerContentType: *mut u32,  // DWORD* optional, out
        pbDecoded: *mut u8,  // BYTE* optional, out
        pcbDecoded: *mut u32,  // DWORD* optional, in/out
        ppXchgCert: *mut *mut CERT_CONTEXT,  // CERT_CONTEXT** optional, out
        ppSignerCert: *mut *mut CERT_CONTEXT  // CERT_CONTEXT** optional, out
    ) -> 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 CryptDecodeMessage(uint dwMsgTypeFlags, IntPtr pDecryptPara, IntPtr pVerifyPara, uint dwSignerIndex, IntPtr pbEncodedBlob, uint cbEncodedBlob, uint dwPrevInnerContentType, IntPtr pdwMsgType, IntPtr pdwInnerContentType, IntPtr pbDecoded, IntPtr pcbDecoded, IntPtr ppXchgCert, IntPtr ppSignerCert);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptDecodeMessage' -Namespace Win32 -PassThru
# $api::CryptDecodeMessage(dwMsgTypeFlags, pDecryptPara, pVerifyPara, dwSignerIndex, pbEncodedBlob, cbEncodedBlob, dwPrevInnerContentType, pdwMsgType, pdwInnerContentType, pbDecoded, pcbDecoded, ppXchgCert, ppSignerCert)

#uselib "CRYPT32.dll"
#func global CryptDecodeMessage "CryptDecodeMessage" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptDecodeMessage dwMsgTypeFlags, varptr(pDecryptPara), varptr(pVerifyPara), dwSignerIndex, varptr(pbEncodedBlob), cbEncodedBlob, dwPrevInnerContentType, varptr(pdwMsgType), varptr(pdwInnerContentType), varptr(pbDecoded), varptr(pcbDecoded), varptr(ppXchgCert), varptr(ppSignerCert)   ; 戻り値は stat
; dwMsgTypeFlags : DWORD -> "sptr"
; pDecryptPara : CRYPT_DECRYPT_MESSAGE_PARA* optional -> "sptr"
; pVerifyPara : CRYPT_VERIFY_MESSAGE_PARA* optional -> "sptr"
; dwSignerIndex : DWORD -> "sptr"
; pbEncodedBlob : BYTE* -> "sptr"
; cbEncodedBlob : DWORD -> "sptr"
; dwPrevInnerContentType : DWORD -> "sptr"
; pdwMsgType : DWORD* optional, out -> "sptr"
; pdwInnerContentType : DWORD* optional, out -> "sptr"
; pbDecoded : BYTE* optional, out -> "sptr"
; pcbDecoded : DWORD* optional, in/out -> "sptr"
; ppXchgCert : CERT_CONTEXT** optional, out -> "sptr"
; ppSignerCert : CERT_CONTEXT** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptDecodeMessage "CryptDecodeMessage" int, var, var, int, var, int, int, var, var, var, var, var, var
; res = CryptDecodeMessage(dwMsgTypeFlags, pDecryptPara, pVerifyPara, dwSignerIndex, pbEncodedBlob, cbEncodedBlob, dwPrevInnerContentType, pdwMsgType, pdwInnerContentType, pbDecoded, pcbDecoded, ppXchgCert, ppSignerCert)
; dwMsgTypeFlags : DWORD -> "int"
; pDecryptPara : CRYPT_DECRYPT_MESSAGE_PARA* optional -> "var"
; pVerifyPara : CRYPT_VERIFY_MESSAGE_PARA* optional -> "var"
; dwSignerIndex : DWORD -> "int"
; pbEncodedBlob : BYTE* -> "var"
; cbEncodedBlob : DWORD -> "int"
; dwPrevInnerContentType : DWORD -> "int"
; pdwMsgType : DWORD* optional, out -> "var"
; pdwInnerContentType : DWORD* optional, out -> "var"
; pbDecoded : BYTE* optional, out -> "var"
; pcbDecoded : DWORD* optional, in/out -> "var"
; ppXchgCert : CERT_CONTEXT** optional, out -> "var"
; ppSignerCert : CERT_CONTEXT** optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptDecodeMessage "CryptDecodeMessage" int, sptr, sptr, int, sptr, int, int, sptr, sptr, sptr, sptr, sptr, sptr
; res = CryptDecodeMessage(dwMsgTypeFlags, varptr(pDecryptPara), varptr(pVerifyPara), dwSignerIndex, varptr(pbEncodedBlob), cbEncodedBlob, dwPrevInnerContentType, varptr(pdwMsgType), varptr(pdwInnerContentType), varptr(pbDecoded), varptr(pcbDecoded), varptr(ppXchgCert), varptr(ppSignerCert))
; dwMsgTypeFlags : DWORD -> "int"
; pDecryptPara : CRYPT_DECRYPT_MESSAGE_PARA* optional -> "sptr"
; pVerifyPara : CRYPT_VERIFY_MESSAGE_PARA* optional -> "sptr"
; dwSignerIndex : DWORD -> "int"
; pbEncodedBlob : BYTE* -> "sptr"
; cbEncodedBlob : DWORD -> "int"
; dwPrevInnerContentType : DWORD -> "int"
; pdwMsgType : DWORD* optional, out -> "sptr"
; pdwInnerContentType : DWORD* optional, out -> "sptr"
; pbDecoded : BYTE* optional, out -> "sptr"
; pcbDecoded : DWORD* optional, in/out -> "sptr"
; ppXchgCert : CERT_CONTEXT** optional, out -> "sptr"
; ppSignerCert : CERT_CONTEXT** optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。