ホーム › Security.Cryptography › NCryptEncrypt

NCryptEncrypt

関数

指定したキーを使ってデータを暗号化する。

DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptEncrypt(
    NCRYPT_KEY_HANDLE hKey,
    BYTE* pbInput,   // optional
    DWORD cbInput,
    void* pPaddingInfo,   // optional
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    NCRYPT_FLAGS dwFlags
);

パラメーター

名前

型

方向

説明

hKey

NCRYPT_KEY_HANDLE

データの暗号化に使用するキーのハンドル。

pbInput

BYTE*

inoptional

暗号化するデータが格納されているバッファーのアドレス。cbInput パラメーターには暗号化するデータのサイズを指定します。詳細については「解説」を参照してください。

cbInput

DWORD

pbInput バッファー内の暗号化するデータのバイト数。

pPaddingInfo

void*

inoptional

パディング情報を格納する構造体へのポインター。このパラメーターが指す構造体の実際の型は、dwFlags パラメーターの値によって異なります。このパラメーターは非対称キーでのみ使用され、それ以外の場合は NULL でなければなりません。

pbOutput

BYTE*

outoptional

この関数が生成する暗号化データを受け取るバッファーのアドレス。cbOutput パラメーターにはこのバッファーのサイズを指定します。詳細については「解説」を参照してください。

このパラメーターが NULL の場合、この関数は暗号化データに必要なサイズを計算し、そのサイズを pcbResult パラメーターが指す場所に返します。

cbOutput

DWORD

pbOutput バッファーのサイズ(バイト単位)。pbOutput パラメーターが NULL の場合、このパラメーターは無視されます。

pcbResult

DWORD*

out

pbOutput バッファーにコピーされたバイト数を受け取る DWORD 変数へのポインター。pbOutput が NULL の場合は、暗号文に必要なサイズ(バイト単位)を受け取ります。

dwFlags

NCRYPT_FLAGS

関数の動作を変更するフラグ。指定可能なフラグの集合は、hKey パラメーターで指定されたキーの種類によって異なります。

キーが非対称キーの場合、次のいずれかの値を指定できます。

値	意味
NCRYPT_NO_PADDING_FLAG	パディングを使用しません。pPaddingInfo パラメーターは使用されません。 NCRYPT_NO_PADDING_FLAG を指定した場合、NCryptEncrypt 関数は先頭の N ビットのみを暗号化します。ここで N は hKey パラメーターとして渡されたキーの長さです。先頭の N ビット以降のビットは無視されます。
NCRYPT_PAD_OAEP_FLAG	Optimal Asymmetric Encryption Padding (OAEP) 方式を使用します。pPaddingInfo パラメーターは BCRYPT_OAEP_PADDING_INFO 構造体へのポインターです。
NCRYPT_PAD_PKCS1_FLAG	ブロックサイズに合わせるため、データは乱数でパディングされます。pPaddingInfo パラメーターは使用されません。
NCRYPT_SILENT_FLAG	キーストレージプロバイダー (KSP) がユーザーインターフェイスを表示しないことを要求します。プロバイダーが動作のために UI を表示する必要がある場合、呼び出しは失敗し、KSP は最後のエラーとして NTE_SILENT_CONTEXT エラーコードを設定する必要があります。

戻り値の型: HRESULT

公式ドキュメント

データのブロックを暗号化します。(NCryptEncrypt)

戻り値

関数の成功または失敗を示すステータスコードを返します。

返される可能性のあるコードには、次のものが含まれますが、これらに限定されません。

戻り値	説明
ERROR_SUCCESS	関数は成功しました。
NTE_BAD_FLAGS	dwFlags パラメーターに無効な値が含まれています。
NTE_BAD_KEY_STATE	hKey パラメーターで識別されるキーが確定されていないか、不完全です。
NTE_BUFFER_TOO_SMALL	cbOutput パラメーターで指定されたサイズが、暗号化データを格納するのに十分な大きさではありません。
NTE_INVALID_HANDLE	hKey パラメーターが無効です。
NTE_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。

解説(Remarks)

pbInput パラメーターと pbOutput パラメーターは同じバッファーを指すことができます。この場合、この関数はインプレースで暗号化を実行します。暗号化されたデータのサイズが暗号化前のデータのサイズより大きくなる可能性があるため、バッファーは暗号化データを格納できる十分な大きさでなければなりません。

サービスは、その StartService 関数からこの関数を呼び出してはなりません。サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答を停止する可能性があります。

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

各言語での呼び出し定義

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

HRESULT NCryptEncrypt(
    NCRYPT_KEY_HANDLE hKey,
    BYTE* pbInput,   // optional
    DWORD cbInput,
    void* pPaddingInfo,   // optional
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    NCRYPT_FLAGS dwFlags
);

[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptEncrypt(
    UIntPtr hKey,   // NCRYPT_KEY_HANDLE
    IntPtr pbInput,   // BYTE* optional
    uint cbInput,   // DWORD
    IntPtr pPaddingInfo,   // void* optional
    IntPtr pbOutput,   // BYTE* optional, out
    uint cbOutput,   // DWORD
    out uint pcbResult,   // DWORD* out
    uint dwFlags   // NCRYPT_FLAGS
);

<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptEncrypt(
    hKey As UIntPtr,   ' NCRYPT_KEY_HANDLE
    pbInput As IntPtr,   ' BYTE* optional
    cbInput As UInteger,   ' DWORD
    pPaddingInfo As IntPtr,   ' void* optional
    pbOutput As IntPtr,   ' BYTE* optional, out
    cbOutput As UInteger,   ' DWORD
    <Out> ByRef pcbResult As UInteger,   ' DWORD* out
    dwFlags As UInteger   ' NCRYPT_FLAGS
) As Integer
End Function

' hKey : NCRYPT_KEY_HANDLE
' pbInput : BYTE* optional
' cbInput : DWORD
' pPaddingInfo : void* optional
' pbOutput : BYTE* optional, out
' cbOutput : DWORD
' pcbResult : DWORD* out
' dwFlags : NCRYPT_FLAGS
Declare PtrSafe Function NCryptEncrypt Lib "ncrypt" ( _
    ByVal hKey As LongPtr, _
    ByVal pbInput As LongPtr, _
    ByVal cbInput As Long, _
    ByVal pPaddingInfo As LongPtr, _
    ByVal pbOutput As LongPtr, _
    ByVal cbOutput As Long, _
    ByRef pcbResult As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NCryptEncrypt = ctypes.windll.ncrypt.NCryptEncrypt
NCryptEncrypt.restype = ctypes.c_int
NCryptEncrypt.argtypes = [
    ctypes.c_size_t,  # hKey : NCRYPT_KEY_HANDLE
    ctypes.POINTER(ctypes.c_ubyte),  # pbInput : BYTE* optional
    wintypes.DWORD,  # cbInput : DWORD
    ctypes.POINTER(None),  # pPaddingInfo : void* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbOutput : BYTE* optional, out
    wintypes.DWORD,  # cbOutput : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbResult : DWORD* out
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptEncrypt = Fiddle::Function.new(
  lib['NCryptEncrypt'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hKey : NCRYPT_KEY_HANDLE
    Fiddle::TYPE_VOIDP,  # pbInput : BYTE* optional
    -Fiddle::TYPE_INT,  # cbInput : DWORD
    Fiddle::TYPE_VOIDP,  # pPaddingInfo : void* optional
    Fiddle::TYPE_VOIDP,  # pbOutput : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbOutput : DWORD
    Fiddle::TYPE_VOIDP,  # pcbResult : DWORD* out
    -Fiddle::TYPE_INT,  # dwFlags : NCRYPT_FLAGS
  ],
  Fiddle::TYPE_INT)

#[link(name = "ncrypt")]
extern "system" {
    fn NCryptEncrypt(
        hKey: usize,  // NCRYPT_KEY_HANDLE
        pbInput: *mut u8,  // BYTE* optional
        cbInput: u32,  // DWORD
        pPaddingInfo: *mut (),  // void* optional
        pbOutput: *mut u8,  // BYTE* optional, out
        cbOutput: u32,  // DWORD
        pcbResult: *mut u32,  // DWORD* out
        dwFlags: u32  // NCRYPT_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptEncrypt(UIntPtr hKey, IntPtr pbInput, uint cbInput, IntPtr pPaddingInfo, IntPtr pbOutput, uint cbOutput, out uint pcbResult, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptEncrypt' -Namespace Win32 -PassThru
# $api::NCryptEncrypt(hKey, pbInput, cbInput, pPaddingInfo, pbOutput, cbOutput, pcbResult, dwFlags)

#uselib "ncrypt.dll"
#func global NCryptEncrypt "NCryptEncrypt" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; NCryptEncrypt hKey, varptr(pbInput), cbInput, pPaddingInfo, varptr(pbOutput), cbOutput, varptr(pcbResult), dwFlags   ; 戻り値は stat
; hKey : NCRYPT_KEY_HANDLE -> "sptr"
; pbInput : BYTE* optional -> "sptr"
; cbInput : DWORD -> "sptr"
; pPaddingInfo : void* optional -> "sptr"
; pbOutput : BYTE* optional, out -> "sptr"
; cbOutput : DWORD -> "sptr"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ncrypt.dll"
#cfunc global NCryptEncrypt "NCryptEncrypt" sptr, var, int, sptr, var, int, var, int
; res = NCryptEncrypt(hKey, pbInput, cbInput, pPaddingInfo, pbOutput, cbOutput, pcbResult, dwFlags)
; hKey : NCRYPT_KEY_HANDLE -> "sptr"
; pbInput : BYTE* optional -> "var"
; cbInput : DWORD -> "int"
; pPaddingInfo : void* optional -> "sptr"
; pbOutput : BYTE* optional, out -> "var"
; cbOutput : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : NCRYPT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ncrypt.dll"
#cfunc global NCryptEncrypt "NCryptEncrypt" sptr, sptr, int, sptr, sptr, int, sptr, int
; res = NCryptEncrypt(hKey, varptr(pbInput), cbInput, pPaddingInfo, varptr(pbOutput), cbOutput, varptr(pcbResult), dwFlags)
; hKey : NCRYPT_KEY_HANDLE -> "sptr"
; pbInput : BYTE* optional -> "sptr"
; cbInput : DWORD -> "int"
; pPaddingInfo : void* optional -> "sptr"
; pbOutput : BYTE* optional, out -> "sptr"
; cbOutput : DWORD -> "int"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。