CryptEncrypt 関数 (wincrypt.h)
Secure/Multipurpose Internet Mail Extensions (S/MIME) 電子メールの相互運用性
構文
BOOL CryptEncrypt(
[in] HCRYPTKEY hKey,
[in] HCRYPTHASH hHash,
[in] BOOL Final,
[in] DWORD dwFlags,
[in, out] BYTE *pbData,
[in, out] DWORD *pdwDataLen,
[in] DWORD dwBufLen
);
パラメーター
[in] hKey
暗号化キーのハンドル。 アプリケーションは、CryptGenKey または CryptImportKey 関数を使用して、このハンドルを取得します。
キーは、使用する暗号化アルゴリズムを指定します。
[in] hHash
ハッシュ オブジェクトへのハンドル。 データを同時にハッシュおよび暗号化する場合は、hHash パラメーターでハッシュ オブジェクトへのハンドルを渡すことができます。 ハッシュ値は、プレーンテキスト 渡された状態で更新されます。 このオプションは、署名された暗号化されたテキストを生成する場合に便利です。
CryptEncrypt
ハッシュを実行しない場合、このパラメーターは NULL
[in] Final
これが暗号化される系列の最後のセクションかどうかを指定するブール値。
[in] dwFlags
次の dwFlags 値は定義されていますが、将来使用するために予約されています。
価値 | 意味 |
---|---|
|
最適な非対称暗号化パディング (OAEP) (PKCS #1 バージョン 2) を使用します。 このフラグは、RSA 暗号化/暗号化解除を使用する microsoft Enhanced Cryptographic Provider |
[in, out] pbData
暗号化するプレーンテキストを含むバッファーへのポインター。 このバッファー内のプレーンテキストは、この関数によって作成
pdwDataLen パラメーターは、プレーンテキストの長さ (バイト単位) を含む変数を指します。 dwBufLen パラメーターには、このバッファーの合計サイズ (バイト単位) が含まれています。
このパラメーターに NULLが含まれている場合、この関数は暗号テキストに必要なサイズを計算し、pdwDataLen パラメーターが指す値に配置します。
[in, out] pdwDataLen
pbData バッファー内のプレーンテキストの長さをバイト単位で格納する、DWORD 値へのポインター。 終了時に、この DWORD には、pbData バッファーに書き込まれた暗号テキストの長さ (バイト単位) が含まれます。
pbData が NULL
[in] dwBufLen
pbData バッファー
使用されるアルゴリズムによっては、暗号化されたテキストが元のプレーンテキストよりも大きくなる場合があることに注意してください。 この場合、pbData バッファーは、暗号化されたテキストとパディングを格納するのに十分な大きさにする必要があります。
原則として、ストリーム暗号 を使用する場合、暗号テキストはプレーンテキストと同じサイズになります。 ブロック暗号 が使用されている場合、暗号テキストはプレーンテキストより大きいブロック長までです。
戻り値
関数が成功した場合、関数は 0 以外 (TRUE) を返します。
関数が失敗した場合は、0 (FALSE
NTE で開始されるエラー コードは、使用されている特定の CSP によって生成されます。 考えられるエラー コードの一部を次に示します。
価値 | 形容 |
---|---|
|
パラメーターの 1 つは無効なハンドルを指定します。 |
|
パラメーターの 1 つに無効な値が含まれています。 これは、多くの場合、無効なポインターです。 |
|
hKeyセッション キー は、この CSP がサポートしていないアルゴリズムを指定します。 |
|
暗号化するデータが無効です。 たとえば、ブロック暗号が使用され、 |
|
dwFlags パラメーターは 0 以外です。 |
|
hHash パラメーターには、無効なハンドルが含まれています。 |
|
既に "完了" とマークされているハッシュ オブジェクトにデータを追加しようとしました。 |
|
hKey パラメーターに、キーへの有効なハンドルが含まれていません。 |
|
出力バッファーのサイズが小さすぎて、生成された暗号テキストを保持できません。 |
|
キーの作成時に指定された CSP コンテキストが見つかりません。 |
|
アプリケーションが同じデータを 2 回暗号化しようとしました。 |
|
予期しない方法で関数が失敗しました。 |
|
操作中に CSP のメモリが不足しました。 |
備考
大量のデータを暗号化する場合は、CryptEncrypt を繰り返し呼び出すことによって、セクションで行うことができます。
- キーがブロック暗号キーの場合、データは暗号のブロック サイズの倍数に埋め込まれます。 データの長さが暗号のブロック サイズと等しい場合は、1 つの追加のパディング ブロックがデータに追加されます。 暗号のブロック サイズを見つけるには、CryptGetKeyParam を使用してキーのKP_BLOCKLEN値を取得します。
- 暗号が チェーン モードので動作している場合、次の CryptEncrypt 操作によって、暗号のフィードバック レジスタがキーのKP_IV値にリセットされます。
- 暗号が ストリーム暗号の場合、次の CryptEncrypt は、暗号を初期 状態にリセットします。
// Set the IV for the original key. Do not use the original key for
// encryption or decryption after doing this because the key's
// feedback register will get modified and you cannot change it.
CryptSetKeyParam(hOriginalKey, KP_IV, newIV)
while(block = NextBlock())
{
// Create a duplicate of the original key. This causes the
// original key's IV to be copied into the duplicate key's
// feedback register.
hDuplicateKey = CryptDuplicateKey(hOriginalKey)
// Encrypt the block with the duplicate key.
CryptEncrypt(hDuplicateKey, block)
// Destroy the duplicate key. Its feedback register has been
// modified by the CryptEncrypt function, so it cannot be used
// again. It will be re-duplicated in the next iteration of the
// loop.
CryptDestroyKey(hDuplicateKey)
}
例
この関数を使用する例については、「例 C Program: Encrypting a File and Example C Program: Decrypting a File」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows XP [デスクトップ アプリのみ] |
サポートされる最小サーバー | Windows Server 2003 [デスクトップ アプリのみ] |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | wincrypt.h |
ライブラリ | Advapi32.lib |
DLL | Advapi32.dll |