ホーム › Security.Cryptography › CryptMsgOpenToEncode

CryptMsgOpenToEncode

関数

エンコード用の暗号メッセージ(PKCS#7/CMS)を開く。

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

シグネチャ

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

void* CryptMsgOpenToEncode(
    DWORD dwMsgEncodingType,
    DWORD dwFlags,
    CRYPT_MSG_TYPE dwMsgType,
    const void* pvMsgEncodeInfo,
    LPSTR pszInnerContentObjID,   // optional
    CMSG_STREAM_INFO* pStreamInfo   // optional
);

パラメーター

名前

型

方向

説明

dwMsgEncodingType

DWORD

使用するエンコードの種類を指定します。次の例のように、証明書のエンコードの種類とメッセージのエンコードの種類の両方をビットごとの OR 演算で組み合わせて指定することは常に有効です。

X509_ASN_ENCODING | PKCS_7_ASN_ENCODING

現在定義されているエンコードの種類は次のとおりです。

dwFlags

DWORD

現在定義されている dwFlags を次の表に示します。

値	意味
CMSG_BARE_CONTENT_FLAG	ストリーム出力には、(PKCS #7 で定義される)外側の ContentInfo ラッパーが付きません。これにより、囲んでいるメッセージへストリーミングするのに適したものになります。
CMSG_DETACHED_FLAG	後続の CryptMsgUpdate の呼び出しに対して、分離されたデータが供給されます。
CMSG_AUTHENTICATED_ATTRIBUTES_FLAG	本来は不要な場合でも、認証属性が(PKCS #7 で定義される)SignerInfo に強制的に含められます。
CMSG_CONTENTS_OCTETS_FLAG	Distinguished Encoding Rules(DER)を使用してエンコードされ、エンベロープメッセージ内に入れ子になっているメッセージのサイズを計算する際に使用します。これはストリーミングを実行するときに特に有用です。
CMSG_CMS_ENCAPSULATED_CONTENT_FLAG	設定すると、データ型以外の内部コンテンツが OCTET STRING 内にカプセル化されます。署名付きメッセージとエンベロープメッセージの両方に適用されます。
CMSG_CRYPT_RELEASE_CONTEXT_FLAG	設定すると、この関数に渡された hCryptProv は、最後の CryptMsgUpdate の時点で解放されます。関数が失敗した場合、ハンドルは解放されません。注エンベロープの受信者の hCryptProv は解放されません。

dwMsgType

CRYPT_MSG_TYPE

メッセージの種類を示します。これは次のいずれかの値でなければなりません。

値	意味
CMSG_DATA	この値は使用されません。
CMSG_SIGNED	pvMsgEncodeInfo パラメーターは、エンコード情報を含む CMSG_SIGNED_ENCODE_INFO 構造体のアドレスです。
CMSG_ENVELOPED	pvMsgEncodeInfo パラメーターは、エンコード情報を含む CMSG_ENVELOPED_ENCODE_INFO 構造体のアドレスです。
CMSG_SIGNED_AND_ENVELOPED	この値は現在実装されていません。
CMSG_HASHED	pvMsgEncodeInfo パラメーターは、エンコード情報を含む CMSG_HASHED_ENCODE_INFO 構造体のアドレスです。

pvMsgEncodeInfo

void*

エンコード情報を含む構造体のアドレスです。データの種類は dwMsgType パラメーターの値によって異なります。詳細については dwMsgType を参照してください。

pszInnerContentObjID

LPSTR

inoptional

CryptMsgCalculateEncodedLength が呼び出され、 CryptMsgUpdate 用のデータが既にメッセージエンコードされている場合は、適切なオブジェクト識別子(OID)を pszInnerContentObjID に渡します。pszInnerContentObjID が NULL の場合、内部コンテンツの型は以前にエンコードされていないものとみなされ、オクテット文字列としてエンコードされて CMSG_DATA 型が割り当てられます。

注ストリーミングを使用している場合、pszInnerContentObjID は NULL または szOID_RSA_data のいずれかでなければなりません。

次のアルゴリズム OID が一般的に使用されます。送信者と受信者がその OID に関連付けられたセマンティクスについて合意することで、ユーザーは新しい内部コンテンツの用途を定義できます。

szOID_RSA_data
szOID_RSA_signedData
szOID_RSA_envelopedData
szOID_RSA_signEnvData
szOID_RSA_digestedData
szOID_RSA_encryptedData
SPC_INDIRECT_DATA_OBJID

pStreamInfo

CMSG_STREAM_INFO*

inoptional

ストリーミングを使用している場合、このパラメーターは CMSG_STREAM_INFO 構造体のアドレスです。CMSG_STREAM_INFO 構造体の pfnStreamOutput メンバーで指定されたコールバック関数は、 CryptMsgUpdate が実行されたときに呼び出されます。コールバックには、エンコードの結果として得られたエンコード済みバイト列が渡されます。コールバックの使用方法の詳細については、 CMSG_STREAM_INFO を参照してください。

注ストリーミングを使用している場合、アプリケーションは、この関数が返すメッセージハンドルが CryptMsgClose 関数によって閉じられるまで、pvMsgEncodeInfo パラメーターで渡されたデータハンドル(CMSG_SIGNER_ENCODE_INFO 構造体の hCryptProv メンバーのプロバイダーハンドルなど)を解放してはなりません。

ストリーミングを使用しない場合、このパラメーターには NULL を設定します。

ストリーミングは CMSG_HASHED メッセージの種類では使用されません。ハッシュ化されたデータを扱う場合、このパラメーターには NULL を設定する必要があります。

署名付きメッセージがエンベロープメッセージに格納される場合を考えます。署名付きメッセージのストリーミングエンコードによるエンコード出力は、エンベロープメッセージの別のストリーミングエンコードへ送られます。ストリーミングエンコードのコールバックは CryptMsgUpdate を呼び出してエンベロープメッセージをエンコードします。エンベロープメッセージのコールバックは、入れ子になった署名付きメッセージのエンコード済みバイト列を受け取ります。

戻り値の型: void*

公式ドキュメント

暗号化メッセージをエンコード用に開き、開かれたメッセージのハンドルを返します。

戻り値

関数が成功した場合、開かれたメッセージのハンドルを返します。このハンドルは不要になったら、CryptMsgClose 関数に渡して閉じる必要があります。

この関数が失敗した場合、NULL が返されます。

拡張エラー情報を取得するには、 GetLastError 関数を使用します。

GetLastError 関数が返す最も一般的なエラーコードを次の表に示します。

戻り値	説明
CRYPT_E_INVALID_MSG_TYPE	メッセージの種類が無効です。
CRYPT_E_OID_FORMAT	OID の形式が不正です。
CRYPT_E_UNKNOWN_ALGO	暗号アルゴリズムが不明です。
E_INVALIDARG	1 つ以上の引数が無効です。
E_OUTOFMEMORY	メモリが不足しています。

さらに、dwMsgType が CMSG_SIGNED の場合、 CryptCreateHash からエラーが伝播することがあります。

dwMsgType が CMSG_ENVELOPED の場合、 CryptGenKey、 CryptImportKey、および CryptExportKey からエラーが伝播することがあります。

dwMsgType が CMSG_HASHED の場合、 CryptCreateHash からエラーが伝播することがあります。

解説(Remarks)

暗号化を実行する関数では、暗号化された対称鍵は、内部で CryptExportKey が呼び出された後に、リトルエンディアン形式からビッグエンディアン形式へ反転されます。復号を実行する関数では、暗号化された対称鍵は、 CryptImportKey が呼び出される前に、ビッグエンディアン形式からリトルエンディアン形式へ反転されます。

対称鍵を CryptGenKey および CryptImportKey で生成およびインポートする際には、CRYPT_NO_SALT が指定されます。

RC2 暗号化アルゴリズムで暗号化されたメッセージでは、鍵のインポートまたはエクスポート時に RC2 鍵の有効な鍵長を判別するために、CryptGetKeyParam とともに KP_EFFECTIVE_KEYLEN が使用されます。

RC2 暗号化アルゴリズムで暗号化されたメッセージでは、 CMSG_ENVELOPED_ENCODE_INFO 構造体の ContentEncryptionAlgorithm メンバーの ASN RC2 パラメーターを処理するように、エンコードおよびデコード操作が更新されました。

RC4、DES、3DES の各暗号化アルゴリズムで暗号化されたメッセージでは、CMSG_ENVELOPED_ENCODE_INFO 構造体の ContentEncryptionAlgorithm メンバーの ASN IV オクテット文字列パラメーターを、エンコードおよびデコード操作が処理するようになりました。

例

この関数を使用する例については、 Example C Program: Signing, Encoding, Decoding, and Verifying a Message、 Alternate Code for Encoding an Enveloped Message、 Example C Program: Encoding an Enveloped, Signed Message、および Example C Program: Encoding and Decoding a Hashed Message を参照してください。

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

各言語での呼び出し定義

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

void* CryptMsgOpenToEncode(
    DWORD dwMsgEncodingType,
    DWORD dwFlags,
    CRYPT_MSG_TYPE dwMsgType,
    const void* pvMsgEncodeInfo,
    LPSTR pszInnerContentObjID,   // optional
    CMSG_STREAM_INFO* pStreamInfo   // optional
);

[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CryptMsgOpenToEncode(
    uint dwMsgEncodingType,   // DWORD
    uint dwFlags,   // DWORD
    uint dwMsgType,   // CRYPT_MSG_TYPE
    IntPtr pvMsgEncodeInfo,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string pszInnerContentObjID,   // LPSTR optional
    IntPtr pStreamInfo   // CMSG_STREAM_INFO* optional
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptMsgOpenToEncode(
    dwMsgEncodingType As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    dwMsgType As UInteger,   ' CRYPT_MSG_TYPE
    pvMsgEncodeInfo As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> pszInnerContentObjID As String,   ' LPSTR optional
    pStreamInfo As IntPtr   ' CMSG_STREAM_INFO* optional
) As IntPtr
End Function

' dwMsgEncodingType : DWORD
' dwFlags : DWORD
' dwMsgType : CRYPT_MSG_TYPE
' pvMsgEncodeInfo : void*
' pszInnerContentObjID : LPSTR optional
' pStreamInfo : CMSG_STREAM_INFO* optional
Declare PtrSafe Function CryptMsgOpenToEncode Lib "crypt32" ( _
    ByVal dwMsgEncodingType As Long, _
    ByVal dwFlags As Long, _
    ByVal dwMsgType As Long, _
    ByVal pvMsgEncodeInfo As LongPtr, _
    ByVal pszInnerContentObjID As String, _
    ByVal pStreamInfo As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptMsgOpenToEncode = ctypes.windll.crypt32.CryptMsgOpenToEncode
CryptMsgOpenToEncode.restype = ctypes.c_void_p
CryptMsgOpenToEncode.argtypes = [
    wintypes.DWORD,  # dwMsgEncodingType : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.DWORD,  # dwMsgType : CRYPT_MSG_TYPE
    ctypes.POINTER(None),  # pvMsgEncodeInfo : void*
    wintypes.LPCSTR,  # pszInnerContentObjID : LPSTR optional
    ctypes.c_void_p,  # pStreamInfo : CMSG_STREAM_INFO* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptMsgOpenToEncode = Fiddle::Function.new(
  lib['CryptMsgOpenToEncode'],
  [
    -Fiddle::TYPE_INT,  # dwMsgEncodingType : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    -Fiddle::TYPE_INT,  # dwMsgType : CRYPT_MSG_TYPE
    Fiddle::TYPE_VOIDP,  # pvMsgEncodeInfo : void*
    Fiddle::TYPE_VOIDP,  # pszInnerContentObjID : LPSTR optional
    Fiddle::TYPE_VOIDP,  # pStreamInfo : CMSG_STREAM_INFO* optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "crypt32")]
extern "system" {
    fn CryptMsgOpenToEncode(
        dwMsgEncodingType: u32,  // DWORD
        dwFlags: u32,  // DWORD
        dwMsgType: u32,  // CRYPT_MSG_TYPE
        pvMsgEncodeInfo: *const (),  // void*
        pszInnerContentObjID: *mut u8,  // LPSTR optional
        pStreamInfo: *mut CMSG_STREAM_INFO  // CMSG_STREAM_INFO* optional
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern IntPtr CryptMsgOpenToEncode(uint dwMsgEncodingType, uint dwFlags, uint dwMsgType, IntPtr pvMsgEncodeInfo, [MarshalAs(UnmanagedType.LPStr)] string pszInnerContentObjID, IntPtr pStreamInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptMsgOpenToEncode' -Namespace Win32 -PassThru
# $api::CryptMsgOpenToEncode(dwMsgEncodingType, dwFlags, dwMsgType, pvMsgEncodeInfo, pszInnerContentObjID, pStreamInfo)

#uselib "CRYPT32.dll"
#func global CryptMsgOpenToEncode "CryptMsgOpenToEncode" sptr, sptr, sptr, sptr, sptr, sptr
; CryptMsgOpenToEncode dwMsgEncodingType, dwFlags, dwMsgType, pvMsgEncodeInfo, pszInnerContentObjID, varptr(pStreamInfo)   ; 戻り値は stat
; dwMsgEncodingType : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwMsgType : CRYPT_MSG_TYPE -> "sptr"
; pvMsgEncodeInfo : void* -> "sptr"
; pszInnerContentObjID : LPSTR optional -> "sptr"
; pStreamInfo : CMSG_STREAM_INFO* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptMsgOpenToEncode "CryptMsgOpenToEncode" int, int, int, sptr, str, var
; res = CryptMsgOpenToEncode(dwMsgEncodingType, dwFlags, dwMsgType, pvMsgEncodeInfo, pszInnerContentObjID, pStreamInfo)
; dwMsgEncodingType : DWORD -> "int"
; dwFlags : DWORD -> "int"
; dwMsgType : CRYPT_MSG_TYPE -> "int"
; pvMsgEncodeInfo : void* -> "sptr"
; pszInnerContentObjID : LPSTR optional -> "str"
; pStreamInfo : CMSG_STREAM_INFO* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptMsgOpenToEncode "CryptMsgOpenToEncode" int, int, int, sptr, str, sptr
; res = CryptMsgOpenToEncode(dwMsgEncodingType, dwFlags, dwMsgType, pvMsgEncodeInfo, pszInnerContentObjID, varptr(pStreamInfo))
; dwMsgEncodingType : DWORD -> "int"
; dwFlags : DWORD -> "int"
; dwMsgType : CRYPT_MSG_TYPE -> "int"
; pvMsgEncodeInfo : void* -> "sptr"
; pszInnerContentObjID : LPSTR optional -> "str"
; pStreamInfo : CMSG_STREAM_INFO* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。