Win32 API 日本語リファレンス
ホーム › Security.Authentication.Identity › EncryptMessage

EncryptMessage

関数
セキュリティコンテキストを用いてメッセージを暗号化する。
DLLSECUR32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT EncryptMessage(
    SecHandle* phContext,
    DWORD fQOP,
    SecBufferDesc* pMessage,
    DWORD MessageSeqNo
);

パラメーター

名前型方向説明
phContextSecHandle*inメッセージの暗号化に使用するセキュリティ コンテキストへのハンドル。
fQOPDWORDin

保護の品質を示すパッケージ固有のフラグ。セキュリティ パッケージは、このパラメーターを使用して暗号化アルゴリズムの選択を可能にできます。

Digest SSP を使用する場合、このパラメーターは 0 に設定する必要があります。

pMessageSecBufferDesc*in

SecBufferDesc 構造体へのポインター。入力時、この構造体は SECBUFFER_DATA 型にできる 1 つ以上の SecBuffer 構造体を参照します。そのバッファーには暗号化するメッセージが含まれます。メッセージはインプレースで暗号化され、構造体の元の内容は上書きされます。

この関数は、SECBUFFER_READONLY 属性を持つバッファーを処理しません。

メッセージを含む SecBuffer 構造体の長さは、cbMaximumMessage 以下でなければなりません。この値は QueryContextAttributes (Digest) (SECPKG_ATTR_STREAM_SIZES) 関数から取得します。

Digest SSP を使用する場合、署名情報を保持するために、SECBUFFER_PADDING 型または SEC_BUFFER_DATA 型の 2 番目のバッファーが必要です。出力バッファーのサイズを取得するには、 QueryContextAttributes (Digest) 関数を呼び出し、SECPKG_ATTR_SIZES を指定します。この関数は SecPkgContext_Sizes 構造体を返します。出力バッファーのサイズは、cbMaxSignature メンバーと cbBlockSize メンバーの値の合計です。

SSL を使用しないアプリケーションは、SECBUFFER_PADDING 型の SecBuffer を指定する必要があります。

MessageSeqNoDWORDin

トランスポート アプリケーションがメッセージに割り当てたシーケンス番号。トランスポート アプリケーションがシーケンス番号を管理しない場合、このパラメーターは 0 でなければなりません。

Digest SSP を使用する場合、このパラメーターは 0 に設定する必要があります。Digest SSP はシーケンス番号を内部で管理します。

戻り値の型: HRESULT

公式ドキュメント

Digest を使用してメッセージを暗号化し、プライバシーを提供します。

戻り値

関数が成功すると、SEC_E_OK を返します。

関数が失敗すると、次のいずれかのエラー コードを返します。

戻りコード 説明
SEC_E_BUFFER_TOO_SMALL
出力バッファーが小さすぎます。詳細については、「解説」を参照してください。
SEC_E_CONTEXT_EXPIRED
アプリケーションが、既に閉じられたコンテキストを参照しています。正しく記述されたアプリケーションでは、このエラーは発生しないはずです。
SEC_E_CRYPTO_SYSTEM_INVALID
セキュリティ コンテキストに選択された暗号はサポートされていません。
SEC_E_INSUFFICIENT_MEMORY
要求された操作を完了するのに十分なメモリがありません。
SEC_E_INVALID_HANDLE
phContext パラメーターに無効なコンテキスト ハンドルが指定されました。
SEC_E_INVALID_TOKEN
SECBUFFER_DATA 型のバッファーが見つかりませんでした。
SEC_E_QOP_NOT_SUPPORTED
セキュリティ コンテキストは、機密性と整合性のどちらもサポートしていません。

解説(Remarks)

EncryptMessage (Digest) 関数は、メッセージと、セキュリティ コンテキストから得たセッション キーに基づいてメッセージを暗号化します。

トランスポート アプリケーションがシーケンス検出をサポートするようにセキュリティ コンテキストを作成し、呼び出し元がシーケンス番号を指定した場合、この関数はその情報を暗号化されたメッセージに含めます。この情報を含めることで、メッセージのリプレイ、挿入、抑止から保護されます。セキュリティ パッケージは、トランスポート アプリケーションから渡されたシーケンス番号を組み込みます。

Digest SSP を使用する場合は、QueryContextAttributes (Digest) 関数を呼び出して SECPKG_ATTR_SIZES を指定し、出力バッファーのサイズを取得します。この関数は SecPkgContext_Sizes 構造体を返します。出力バッファーのサイズは、cbMaxSignature メンバーと cbBlockSize メンバーの値の合計です。

注 これらのバッファーは、示されている順序で指定する必要があります。
バッファーの種類 説明
SECBUFFER_STREAM_HEADER 内部で使用されます。初期化は不要です。
SECBUFFER_DATA 暗号化するプレーンテキスト メッセージを含みます。
SECBUFFER_STREAM_TRAILER 内部で使用されます。初期化は不要です。
SECBUFFER_EMPTY 内部で使用されます。初期化は不要です。サイズは 0 にできます。

最適なパフォーマンスを得るには、pMessage 構造体を連続したメモリから割り当てる必要があります。

Windows XP: この関数は SealMessage という名前でも知られていました。アプリケーションは現在、EncryptMessage (Digest) のみを使用する必要があります。

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

各言語での呼び出し定義

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

HRESULT EncryptMessage(
    SecHandle* phContext,
    DWORD fQOP,
    SecBufferDesc* pMessage,
    DWORD MessageSeqNo
);
[DllImport("SECUR32.dll", ExactSpelling = true)]
static extern int EncryptMessage(
    IntPtr phContext,   // SecHandle*
    uint fQOP,   // DWORD
    IntPtr pMessage,   // SecBufferDesc*
    uint MessageSeqNo   // DWORD
);
<DllImport("SECUR32.dll", ExactSpelling:=True)>
Public Shared Function EncryptMessage(
    phContext As IntPtr,   ' SecHandle*
    fQOP As UInteger,   ' DWORD
    pMessage As IntPtr,   ' SecBufferDesc*
    MessageSeqNo As UInteger   ' DWORD
) As Integer
End Function
' phContext : SecHandle*
' fQOP : DWORD
' pMessage : SecBufferDesc*
' MessageSeqNo : DWORD
Declare PtrSafe Function EncryptMessage Lib "secur32" ( _
    ByVal phContext As LongPtr, _
    ByVal fQOP As Long, _
    ByVal pMessage As LongPtr, _
    ByVal MessageSeqNo As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EncryptMessage = ctypes.windll.secur32.EncryptMessage
EncryptMessage.restype = ctypes.c_int
EncryptMessage.argtypes = [
    ctypes.c_void_p,  # phContext : SecHandle*
    wintypes.DWORD,  # fQOP : DWORD
    ctypes.c_void_p,  # pMessage : SecBufferDesc*
    wintypes.DWORD,  # MessageSeqNo : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SECUR32.dll')
EncryptMessage = Fiddle::Function.new(
  lib['EncryptMessage'],
  [
    Fiddle::TYPE_VOIDP,  # phContext : SecHandle*
    -Fiddle::TYPE_INT,  # fQOP : DWORD
    Fiddle::TYPE_VOIDP,  # pMessage : SecBufferDesc*
    -Fiddle::TYPE_INT,  # MessageSeqNo : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "secur32")]
extern "system" {
    fn EncryptMessage(
        phContext: *mut SecHandle,  // SecHandle*
        fQOP: u32,  // DWORD
        pMessage: *mut SecBufferDesc,  // SecBufferDesc*
        MessageSeqNo: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SECUR32.dll")]
public static extern int EncryptMessage(IntPtr phContext, uint fQOP, IntPtr pMessage, uint MessageSeqNo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SECUR32_EncryptMessage' -Namespace Win32 -PassThru
# $api::EncryptMessage(phContext, fQOP, pMessage, MessageSeqNo)
#uselib "SECUR32.dll"
#func global EncryptMessage "EncryptMessage" sptr, sptr, sptr, sptr
; EncryptMessage varptr(phContext), fQOP, varptr(pMessage), MessageSeqNo   ; 戻り値は stat
; phContext : SecHandle* -> "sptr"
; fQOP : DWORD -> "sptr"
; pMessage : SecBufferDesc* -> "sptr"
; MessageSeqNo : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SECUR32.dll"
#cfunc global EncryptMessage "EncryptMessage" var, int, var, int
; res = EncryptMessage(phContext, fQOP, pMessage, MessageSeqNo)
; phContext : SecHandle* -> "var"
; fQOP : DWORD -> "int"
; pMessage : SecBufferDesc* -> "var"
; MessageSeqNo : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT EncryptMessage(SecHandle* phContext, DWORD fQOP, SecBufferDesc* pMessage, DWORD MessageSeqNo)
#uselib "SECUR32.dll"
#cfunc global EncryptMessage "EncryptMessage" var, int, var, int
; res = EncryptMessage(phContext, fQOP, pMessage, MessageSeqNo)
; phContext : SecHandle* -> "var"
; fQOP : DWORD -> "int"
; pMessage : SecBufferDesc* -> "var"
; MessageSeqNo : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	secur32 = windows.NewLazySystemDLL("SECUR32.dll")
	procEncryptMessage = secur32.NewProc("EncryptMessage")
)

// phContext (SecHandle*), fQOP (DWORD), pMessage (SecBufferDesc*), MessageSeqNo (DWORD)
r1, _, err := procEncryptMessage.Call(
	uintptr(phContext),
	uintptr(fQOP),
	uintptr(pMessage),
	uintptr(MessageSeqNo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function EncryptMessage(
  phContext: Pointer;   // SecHandle*
  fQOP: DWORD;   // DWORD
  pMessage: Pointer;   // SecBufferDesc*
  MessageSeqNo: DWORD   // DWORD
): Integer; stdcall;
  external 'SECUR32.dll' name 'EncryptMessage';
result := DllCall("SECUR32\EncryptMessage"
    , "Ptr", phContext   ; SecHandle*
    , "UInt", fQOP   ; DWORD
    , "Ptr", pMessage   ; SecBufferDesc*
    , "UInt", MessageSeqNo   ; DWORD
    , "Int")   ; return: HRESULT
●EncryptMessage(phContext, fQOP, pMessage, MessageSeqNo) = DLL("SECUR32.dll", "int EncryptMessage(void*, dword, void*, dword)")
# 呼び出し: EncryptMessage(phContext, fQOP, pMessage, MessageSeqNo)
# phContext : SecHandle* -> "void*"
# fQOP : DWORD -> "dword"
# pMessage : SecBufferDesc* -> "void*"
# MessageSeqNo : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "secur32" fn EncryptMessage(
    phContext: [*c]SecHandle, // SecHandle*
    fQOP: u32, // DWORD
    pMessage: [*c]SecBufferDesc, // SecBufferDesc*
    MessageSeqNo: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc EncryptMessage(
    phContext: ptr SecHandle,  # SecHandle*
    fQOP: uint32,  # DWORD
    pMessage: ptr SecBufferDesc,  # SecBufferDesc*
    MessageSeqNo: uint32  # DWORD
): int32 {.importc: "EncryptMessage", stdcall, dynlib: "SECUR32.dll".}
pragma(lib, "secur32");
extern(Windows)
int EncryptMessage(
    SecHandle* phContext,   // SecHandle*
    uint fQOP,   // DWORD
    SecBufferDesc* pMessage,   // SecBufferDesc*
    uint MessageSeqNo   // DWORD
);
ccall((:EncryptMessage, "SECUR32.dll"), stdcall, Int32,
      (Ptr{SecHandle}, UInt32, Ptr{SecBufferDesc}, UInt32),
      phContext, fQOP, pMessage, MessageSeqNo)
# phContext : SecHandle* -> Ptr{SecHandle}
# fQOP : DWORD -> UInt32
# pMessage : SecBufferDesc* -> Ptr{SecBufferDesc}
# MessageSeqNo : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t EncryptMessage(
    void* phContext,
    uint32_t fQOP,
    void* pMessage,
    uint32_t MessageSeqNo);
]]
local secur32 = ffi.load("secur32")
-- secur32.EncryptMessage(phContext, fQOP, pMessage, MessageSeqNo)
-- phContext : SecHandle*
-- fQOP : DWORD
-- pMessage : SecBufferDesc*
-- MessageSeqNo : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SECUR32.dll');
const EncryptMessage = lib.func('__stdcall', 'EncryptMessage', 'int32_t', ['void *', 'uint32_t', 'void *', 'uint32_t']);
// EncryptMessage(phContext, fQOP, pMessage, MessageSeqNo)
// phContext : SecHandle* -> 'void *'
// fQOP : DWORD -> 'uint32_t'
// pMessage : SecBufferDesc* -> 'void *'
// MessageSeqNo : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SECUR32.dll", {
  EncryptMessage: { parameters: ["pointer", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.EncryptMessage(phContext, fQOP, pMessage, MessageSeqNo)
// phContext : SecHandle* -> "pointer"
// fQOP : DWORD -> "u32"
// pMessage : SecBufferDesc* -> "pointer"
// MessageSeqNo : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EncryptMessage(
    void* phContext,
    uint32_t fQOP,
    void* pMessage,
    uint32_t MessageSeqNo);
C, "SECUR32.dll");
// $ffi->EncryptMessage(phContext, fQOP, pMessage, MessageSeqNo);
// phContext : SecHandle*
// fQOP : DWORD
// pMessage : SecBufferDesc*
// MessageSeqNo : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Secur32 extends StdCallLibrary {
    Secur32 INSTANCE = Native.load("secur32", Secur32.class);
    int EncryptMessage(
        Pointer phContext,   // SecHandle*
        int fQOP,   // DWORD
        Pointer pMessage,   // SecBufferDesc*
        int MessageSeqNo   // DWORD
    );
}
@[Link("secur32")]
lib LibSECUR32
  fun EncryptMessage = EncryptMessage(
    phContext : SecHandle*,   # SecHandle*
    fQOP : UInt32,   # DWORD
    pMessage : SecBufferDesc*,   # SecBufferDesc*
    MessageSeqNo : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EncryptMessageNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>, Uint32);
typedef EncryptMessageDart = int Function(Pointer<Void>, int, Pointer<Void>, int);
final EncryptMessage = DynamicLibrary.open('SECUR32.dll')
    .lookupFunction<EncryptMessageNative, EncryptMessageDart>('EncryptMessage');
// phContext : SecHandle* -> Pointer<Void>
// fQOP : DWORD -> Uint32
// pMessage : SecBufferDesc* -> Pointer<Void>
// MessageSeqNo : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EncryptMessage(
  phContext: Pointer;   // SecHandle*
  fQOP: DWORD;   // DWORD
  pMessage: Pointer;   // SecBufferDesc*
  MessageSeqNo: DWORD   // DWORD
): Integer; stdcall;
  external 'SECUR32.dll' name 'EncryptMessage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EncryptMessage"
  c_EncryptMessage :: Ptr () -> Word32 -> Ptr () -> Word32 -> IO Int32
-- phContext : SecHandle* -> Ptr ()
-- fQOP : DWORD -> Word32
-- pMessage : SecBufferDesc* -> Ptr ()
-- MessageSeqNo : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let encryptmessage =
  foreign "EncryptMessage"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* phContext : SecHandle* -> (ptr void) *)
(* fQOP : DWORD -> uint32_t *)
(* pMessage : SecBufferDesc* -> (ptr void) *)
(* MessageSeqNo : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library secur32 (t "SECUR32.dll"))
(cffi:use-foreign-library secur32)

(cffi:defcfun ("EncryptMessage" encrypt-message :convention :stdcall) :int32
  (ph-context :pointer)   ; SecHandle*
  (f-qop :uint32)   ; DWORD
  (p-message :pointer)   ; SecBufferDesc*
  (message-seq-no :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EncryptMessage = Win32::API::More->new('SECUR32',
    'int EncryptMessage(LPVOID phContext, DWORD fQOP, LPVOID pMessage, DWORD MessageSeqNo)');
# my $ret = $EncryptMessage->Call($phContext, $fQOP, $pMessage, $MessageSeqNo);
# phContext : SecHandle* -> LPVOID
# fQOP : DWORD -> DWORD
# pMessage : SecBufferDesc* -> LPVOID
# MessageSeqNo : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型