ホーム › Security.Cryptography › CryptEncryptMessage

CryptEncryptMessage

関数

受信者証明書を用いてデータを暗号化メッセージに変換する。

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

シグネチャ

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

BOOL CryptEncryptMessage(
    CRYPT_ENCRYPT_MESSAGE_PARA* pEncryptPara,
    DWORD cRecipientCert,
    CERT_CONTEXT** rgpRecipientCert,
    const BYTE* pbToBeEncrypted,   // optional
    DWORD cbToBeEncrypted,
    BYTE* pbEncryptedBlob,   // optional
    DWORD* pcbEncryptedBlob
);

パラメーター

名前	型	方向	説明
pEncryptPara	CRYPT_ENCRYPT_MESSAGE_PARA*	in	暗号化パラメーターを格納する CRYPT_ENCRYPT_MESSAGE_PARA 構造体へのポインター。 CryptEncryptMessage 関数は、SHA2 OID である szOID_DH_SINGLE_PASS_STDDH_SHA256_KDF および szOID_DH_SINGLE_PASS_STDDH_SHA384_KDF をサポートしません。
cRecipientCert	DWORD	in	rgpRecipientCert 配列内の要素数。
rgpRecipientCert	CERT_CONTEXT**	in	メッセージの宛先となる受信者の証明書を格納する CERT_CONTEXT 構造体へのポインターの配列。
pbToBeEncrypted	BYTE*	inoptional	暗号化対象のメッセージを格納するバッファーへのポインター。
cbToBeEncrypted	DWORD	in	暗号化対象のメッセージのサイズ(バイト単位)。
pbEncryptedBlob	BYTE*	outoptional	暗号化およびエンコードされたメッセージを受け取るバッファーを格納する BLOB へのポインター。メモリ割り当てを目的としてこの情報のサイズを設定する場合、このパラメーターを NULL にできます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbEncryptedBlob	DWORD*	inout	pbEncryptedBlob パラメーターが指すバッファーのサイズ(バイト単位)を指定する DWORD へのポインター。関数が戻ると、この変数には pbEncryptedBlob にコピーされた暗号化およびエンコード済みメッセージのサイズ(バイト単位)が格納されます。注意 pbEncryptedBlob のバッファーで返されるデータを処理する場合、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなることがあります。(入力時には、想定される最大の出力データが収まるよう、バッファーサイズは通常十分に大きく指定されます。)出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するよう更新されます。

戻り値の型: BOOL

公式ドキュメント

CryptEncryptMessage 関数は、メッセージを暗号化してエンコードします。

戻り値

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

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

注意 CryptGenKey、 CryptEncrypt、 CryptImportKey、 CryptExportKey の呼び出しで発生したエラーは、この関数に伝播されることがあります。

GetLastError 関数は、最も多くの場合、次のエラーコードを返します。

戻り値	説明
ERROR_MORE_DATA	pbEncryptedBlob パラメーターで指定したバッファーが、返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ(バイト単位)を pcbEncryptedBlob が指す変数に格納します。
E_INVALIDARG	メッセージエンコードの種類が無効です。現在サポートされているのは PKCS_7_ASN_ENCODING のみです。*pEncryptPara 内の cbSize が無効です。

関数が失敗した場合、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 CryptEncryptMessage(
    CRYPT_ENCRYPT_MESSAGE_PARA* pEncryptPara,
    DWORD cRecipientCert,
    CERT_CONTEXT** rgpRecipientCert,
    const BYTE* pbToBeEncrypted,   // optional
    DWORD cbToBeEncrypted,
    BYTE* pbEncryptedBlob,   // optional
    DWORD* pcbEncryptedBlob
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptEncryptMessage(
    IntPtr pEncryptPara,   // CRYPT_ENCRYPT_MESSAGE_PARA*
    uint cRecipientCert,   // DWORD
    IntPtr rgpRecipientCert,   // CERT_CONTEXT**
    IntPtr pbToBeEncrypted,   // BYTE* optional
    uint cbToBeEncrypted,   // DWORD
    IntPtr pbEncryptedBlob,   // BYTE* optional, out
    ref uint pcbEncryptedBlob   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptEncryptMessage(
    pEncryptPara As IntPtr,   ' CRYPT_ENCRYPT_MESSAGE_PARA*
    cRecipientCert As UInteger,   ' DWORD
    rgpRecipientCert As IntPtr,   ' CERT_CONTEXT**
    pbToBeEncrypted As IntPtr,   ' BYTE* optional
    cbToBeEncrypted As UInteger,   ' DWORD
    pbEncryptedBlob As IntPtr,   ' BYTE* optional, out
    ByRef pcbEncryptedBlob As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pEncryptPara : CRYPT_ENCRYPT_MESSAGE_PARA*
' cRecipientCert : DWORD
' rgpRecipientCert : CERT_CONTEXT**
' pbToBeEncrypted : BYTE* optional
' cbToBeEncrypted : DWORD
' pbEncryptedBlob : BYTE* optional, out
' pcbEncryptedBlob : DWORD* in/out
Declare PtrSafe Function CryptEncryptMessage Lib "crypt32" ( _
    ByVal pEncryptPara As LongPtr, _
    ByVal cRecipientCert As Long, _
    ByVal rgpRecipientCert As LongPtr, _
    ByVal pbToBeEncrypted As LongPtr, _
    ByVal cbToBeEncrypted As Long, _
    ByVal pbEncryptedBlob As LongPtr, _
    ByRef pcbEncryptedBlob As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptEncryptMessage = ctypes.windll.crypt32.CryptEncryptMessage
CryptEncryptMessage.restype = wintypes.BOOL
CryptEncryptMessage.argtypes = [
    ctypes.c_void_p,  # pEncryptPara : CRYPT_ENCRYPT_MESSAGE_PARA*
    wintypes.DWORD,  # cRecipientCert : DWORD
    ctypes.c_void_p,  # rgpRecipientCert : CERT_CONTEXT**
    ctypes.POINTER(ctypes.c_ubyte),  # pbToBeEncrypted : BYTE* optional
    wintypes.DWORD,  # cbToBeEncrypted : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbEncryptedBlob : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbEncryptedBlob : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptEncryptMessage = Fiddle::Function.new(
  lib['CryptEncryptMessage'],
  [
    Fiddle::TYPE_VOIDP,  # pEncryptPara : CRYPT_ENCRYPT_MESSAGE_PARA*
    -Fiddle::TYPE_INT,  # cRecipientCert : DWORD
    Fiddle::TYPE_VOIDP,  # rgpRecipientCert : CERT_CONTEXT**
    Fiddle::TYPE_VOIDP,  # pbToBeEncrypted : BYTE* optional
    -Fiddle::TYPE_INT,  # cbToBeEncrypted : DWORD
    Fiddle::TYPE_VOIDP,  # pbEncryptedBlob : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbEncryptedBlob : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptEncryptMessage(
        pEncryptPara: *mut CRYPT_ENCRYPT_MESSAGE_PARA,  // CRYPT_ENCRYPT_MESSAGE_PARA*
        cRecipientCert: u32,  // DWORD
        rgpRecipientCert: *mut *mut CERT_CONTEXT,  // CERT_CONTEXT**
        pbToBeEncrypted: *const u8,  // BYTE* optional
        cbToBeEncrypted: u32,  // DWORD
        pbEncryptedBlob: *mut u8,  // BYTE* optional, out
        pcbEncryptedBlob: *mut u32  // DWORD* in/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 CryptEncryptMessage(IntPtr pEncryptPara, uint cRecipientCert, IntPtr rgpRecipientCert, IntPtr pbToBeEncrypted, uint cbToBeEncrypted, IntPtr pbEncryptedBlob, ref uint pcbEncryptedBlob);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptEncryptMessage' -Namespace Win32 -PassThru
# $api::CryptEncryptMessage(pEncryptPara, cRecipientCert, rgpRecipientCert, pbToBeEncrypted, cbToBeEncrypted, pbEncryptedBlob, pcbEncryptedBlob)

#uselib "CRYPT32.dll"
#func global CryptEncryptMessage "CryptEncryptMessage" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptEncryptMessage varptr(pEncryptPara), cRecipientCert, varptr(rgpRecipientCert), varptr(pbToBeEncrypted), cbToBeEncrypted, varptr(pbEncryptedBlob), varptr(pcbEncryptedBlob)   ; 戻り値は stat
; pEncryptPara : CRYPT_ENCRYPT_MESSAGE_PARA* -> "sptr"
; cRecipientCert : DWORD -> "sptr"
; rgpRecipientCert : CERT_CONTEXT** -> "sptr"
; pbToBeEncrypted : BYTE* optional -> "sptr"
; cbToBeEncrypted : DWORD -> "sptr"
; pbEncryptedBlob : BYTE* optional, out -> "sptr"
; pcbEncryptedBlob : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptEncryptMessage "CryptEncryptMessage" var, int, var, var, int, var, var
; res = CryptEncryptMessage(pEncryptPara, cRecipientCert, rgpRecipientCert, pbToBeEncrypted, cbToBeEncrypted, pbEncryptedBlob, pcbEncryptedBlob)
; pEncryptPara : CRYPT_ENCRYPT_MESSAGE_PARA* -> "var"
; cRecipientCert : DWORD -> "int"
; rgpRecipientCert : CERT_CONTEXT** -> "var"
; pbToBeEncrypted : BYTE* optional -> "var"
; cbToBeEncrypted : DWORD -> "int"
; pbEncryptedBlob : BYTE* optional, out -> "var"
; pcbEncryptedBlob : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptEncryptMessage "CryptEncryptMessage" sptr, int, sptr, sptr, int, sptr, sptr
; res = CryptEncryptMessage(varptr(pEncryptPara), cRecipientCert, varptr(rgpRecipientCert), varptr(pbToBeEncrypted), cbToBeEncrypted, varptr(pbEncryptedBlob), varptr(pcbEncryptedBlob))
; pEncryptPara : CRYPT_ENCRYPT_MESSAGE_PARA* -> "sptr"
; cRecipientCert : DWORD -> "int"
; rgpRecipientCert : CERT_CONTEXT** -> "sptr"
; pbToBeEncrypted : BYTE* optional -> "sptr"
; cbToBeEncrypted : DWORD -> "int"
; pbEncryptedBlob : BYTE* optional, out -> "sptr"
; pcbEncryptedBlob : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。