NCryptEncrypt 関数 (ncrypt.h)
NCryptEncrypt 関数は、データブロックを暗号化します。
構文
SECURITY_STATUS NCryptEncrypt(
[in] NCRYPT_KEY_HANDLE hKey,
[in] PBYTE pbInput,
[in] DWORD cbInput,
[in, optional] VOID *pPaddingInfo,
[out] PBYTE pbOutput,
[in] DWORD cbOutput,
[out] DWORD *pcbResult,
[in] DWORD dwFlags
);
パラメーター
[in] hKey
データの暗号化に使用するキーのハンドル。
[in] pbInput
暗号化するデータを含むバッファーのアドレス。 cbInput パラメーターには、暗号化するデータのサイズが含まれています。 詳細については、「解説」を参照してください。
[in] cbInput
暗号化する pbInput バッファー内のバイト数。
[in, optional] pPaddingInfo
埋め込み情報を含む構造体へのポインター。 このパラメーターが指す構造体の実際の型は、 dwFlags パラメーターの値によって異なります。 このパラメーターは非対称キーでのみ使用され、それ以外の場合は NULL である 必要があります。
[out] pbOutput
この関数によって生成された暗号化されたデータを受け取るバッファーのアドレス。 cbOutput パラメーターには、このバッファーのサイズが含まれています。 詳細については、「解説」を参照してください。
このパラメーターが NULL の場合、この関数は暗号化されたデータに必要なサイズを計算し、 pcbResult パラメーターが指す場所のサイズを返します。
[in] cbOutput
pbOutput バッファーのサイズ (バイト単位)。 pbOutput パラメーターが NULL の場合、このパラメーターは無視されます。
[out] pcbResult
pbOutput バッファーにコピーされたバイト数を受け取る DWORD 変数へのポインター。 pbOutput が NULL の場合、暗号テキストに必要なサイズ (バイト単位) を受け取ります。
[in] dwFlags
関数の動作を変更するフラグ。 許可されるフラグのセットは、 hKey パラメーターで指定されたキーの種類によって異なります。
キーが非対称キーの場合は、次のいずれかの値を指定できます。
値 | 意味 |
---|---|
|
パディングは使用しないでください。 pPaddingInfo パラメーターは使用されません。
NCRYPT_NO_PADDING_FLAGを指定した場合、NCryptEncrypt 関数は最初の N ビットのみを暗号化します。N は hKey パラメーターとして渡されたキーの長さです。 最初の N ビットの後のビットはすべて無視されます。 |
|
最適非対称暗号化パディング (OAEP) スキームを使用します。 pPaddingInfo パラメーターは、BCRYPT_OAEP_PADDING_INFO構造体へのポインターです。 |
|
データには、ブロック サイズを丸めるために乱数が埋め込まれます。 pPaddingInfo パラメーターは使用されません。 |
|
キー サービス プロバイダー (KSP) にユーザー インターフェイスが表示されないことを要求します。 プロバイダーが操作する UI を表示する必要がある場合、呼び出しは失敗し、KSP は NTE_SILENT_CONTEXT エラー コードを最後のエラーとして設定する必要があります。 |
戻り値
関数の成功または失敗を示す状態コードを返します。
可能なリターン コードには、次のものが含まれますが、これらに限定されません。
リターン コード | 説明 |
---|---|
|
関数は成功しました。 |
|
dwFlags パラメーターに無効な値が含まれています。 |
|
hKey パラメーターによって識別されるキーが終了していないか、不完全です。 |
|
cbOutput パラメーターで指定されたサイズは、暗号化されたデータを保持するのに十分な大きさではありません。 |
|
hKey パラメーターが無効です。 |
|
1 つ以上のパラメーターが無効です。 |
注釈
pbInput パラメーターと pbOutput パラメーターは、同じバッファーを指すことができます。 この場合、この関数は暗号化を実行します。 暗号化されたデータ サイズが暗号化されていないデータ サイズよりも大きくなる可能性があるため、バッファーは暗号化されたデータを保持するのに十分な大きさにする必要があります。
サービスは 、StartService 関数からこの関数を呼び出してはなりません。 サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答を停止する可能性があります。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ | UWP アプリ] |
サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリ | UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | ncrypt.h |
Library | Ncrypt.lib |
[DLL] | Ncrypt.dll |