BCryptEncrypt 函数 (bcrypt.h)
BCryptEncrypt 函数加密数据块。
语法
NTSTATUS BCryptEncrypt(
[in, out] BCRYPT_KEY_HANDLE hKey,
[in] PUCHAR pbInput,
[in] ULONG cbInput,
[in, optional] VOID *pPaddingInfo,
[in, out, optional] PUCHAR pbIV,
[in] ULONG cbIV,
[out, optional] PUCHAR pbOutput,
[in] ULONG cbOutput,
[out] ULONG *pcbResult,
[in] ULONG dwFlags
);
参数
[in, out] hKey
用于加密数据的密钥句柄。 此句柄是从其中一个密钥创建函数(例如 BCryptGenerateSymmetricKey、 BCryptGenerateKeyPair 或 BCryptImportKey)获取的。
[in] pbInput
包含要加密的纯文本的缓冲区的地址。 cbInput 参数包含要加密的纯文本的大小。 有关详细信息,请参阅“备注”。
[in] cbInput
pbInput 缓冲区中要加密的字节数。
[in, optional] pPaddingInfo
指向包含填充信息的结构的指针。 此参数仅用于非对称密钥和经过身份验证的加密模式。 如果使用经过身份验证的加密模式,则此参数必须指向 BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO 结构。 如果使用非对称键,则此参数指向的结构类型由 dwFlags 参数的值确定。 否则, 参数必须设置为 NULL。
[in, out, optional] pbIV
包含初始化 向量 (IV) 在加密期间使用的缓冲区的地址。 cbIV 参数包含此缓冲区的大小。 此函数将修改此缓冲区的内容。 如果以后需要重复使用 IV,请确保在调用此函数之前复制此缓冲区。
此参数是可选的,如果未使用 IV,可以为 NULL 。
可以通过调用 BCryptGetProperty 函数来获取 BCRYPT_BLOCK_LENGTH 属性来获取 IV 的所需大小。 这将为算法提供块的大小,这也是 IV 的大小。
[in] cbIV
pbIV 缓冲区的大小(以字节为单位)。
[out, optional] pbOutput
接收此函数生成的 密码文本 的缓冲区的地址。 cbOutput 参数包含此缓冲区的大小。 有关详细信息,请参阅“备注”。
如果此参数为 NULL,BCryptEncrypt 函数将计算 pbInput 参数中传递的数据的密文所需的大小。 在本例中,由STATUS_SUCCESS,由印刷机参数指向的位置将包含此大小。 pPaddingInfo 参数未修改。
如果 pbOutput 和 pbInput 参数的值为 NULL,则返回错误,除非正在使用经过身份验证的加密算法。 在后一种情况下,调用被视为具有零长度数据的经过身份验证的加密调用,身份验证标记在 pPaddingInfo 参数中返回。
[in] cbOutput
pbOutput 缓冲区的大小(以字节为单位)。 如果 pbOutput 参数为 NULL,则忽略此参数。
[out] pcbResult
指向 ULONG 变量的指针,该变量接收复制到 pbOutput 缓冲区的字节数。 如果 pbOutput 为 NULL,则接收密码文本所需的大小(以字节为单位)。
[in] dwFlags
一组标志,用于修改此函数的行为。 允许的标志集取决于 hKey 参数指定的键类型。
如果密钥是对称密钥,则此值可以为零或以下值。
值 | 含义 |
---|---|
|
允许加密算法将数据填充到下一个块大小。 如果未指定此标志,则 cbInput 参数中指定的纯文本大小必须是算法块大小的倍数。
可以通过调用 BCryptGetProperty 函数获取密钥的 BCRYPT_BLOCK_LENGTH 属性来获取块大小。 这将为算法提供块的大小。 此标志不得与经过身份验证的加密模式一起使用, (AES-CCM 和 AES-GCM) 。 |
如果键是非对称密钥,则此值可以是以下值之一。
值 | 含义 |
---|---|
|
请勿使用任何填充。 不使用 pPaddingInfo 参数。 cbInput 参数中指定的纯文本大小必须是算法块大小的倍数。 |
|
使用最佳非对称加密填充 (OAEP) 方案。 pPaddingInfo 参数是指向BCRYPT_OAEP_PADDING_INFO结构的指针。 |
|
数据将填充一个随机数,以四舍五入块大小。 不使用 pPaddingInfo 参数。 |
返回值
返回指示函数成功或失败的状态代码。
可能的返回代码包括但不限于以下内容。
返回代码 | 说明 |
---|---|
|
函数成功。 |
|
cbOutput 参数指定的大小不够大,无法容纳密码文本。 |
|
cbInput 参数不是算法块大小的倍数,并且 dwFlags 参数中未指定 BCRYPT_BLOCK_PADDING 或 BCRYPT_PAD_NONE 标志。 |
|
hKey 参数中的键句柄无效。 |
|
一个或多个参数无效。 |
|
该算法不支持加密。 |
注解
pbInput 和 pbOutput 参数可以相等。 在这种情况下,此函数将就地执行加密。 加密的数据大小可能大于未加密的数据大小,因此缓冲区必须足够大才能保存加密的数据。 如果 pbInput 和 pbOutput 不相等,则两个缓冲区可能不会重叠。
根据提供程序支持的处理器模式,可以从用户模式或内核模式调用 BCryptEncrypt 。 内核模式调用方可以在 PASSIVE_LEVELIRQL 或 DISPATCH_LEVEL IRQL 执行。 如果当前 IRQL 级别 DISPATCH_LEVEL,则 hKey 参数中提供的句柄必须派生自使用 BCRYPT_PROV_DISPATCH 标志打开的提供程序返回的算法句柄,并且传递给 BCryptEncrypt 函数的任何指针都必须引用非分页 (或锁定) 内存。
若要在内核模式下调用此函数,请使用 Cng.lib,它是驱动程序开发工具包 (DDK) 的一部分。 Windows Server 2008 和 Windows Vista: 若要在内核模式下调用此函数,请使用 Ksecdd.lib。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista [桌面应用 | UWP 应用] |
最低受支持的服务器 | Windows Server 2008 [桌面应用 | UWP 应用] |
目标平台 | Windows |
标头 | bcrypt.h |
Library | Bcrypt.lib |
DLL | Bcrypt.dll |