Share via

BCryptGenerateSymmetricKey 函式 (bcrypt.h)

  • 發行項

BCryptGenerateSymmetricKey 函式會建立密鑰物件，以搭配提供的密鑰的對稱金鑰加密演演算法使用。

語法

NTSTATUS BCryptGenerateSymmetricKey(
  [in, out]       BCRYPT_ALG_HANDLE hAlgorithm,
  [out]           BCRYPT_KEY_HANDLE *phKey,
  [out, optional] PUCHAR            pbKeyObject,
  [in]            ULONG             cbKeyObject,
  [in]            PUCHAR            pbSecret,
  [in]            ULONG             cbSecret,
  [in]            ULONG             dwFlags
);

參數

[in, out] hAlgorithm

使用 BCryptOpenAlgorithmProvider 函式建立的演算法提供者句柄。 建立提供者時指定的演演算法必須支援對稱金鑰加密。

[out] phKey

接收索引鍵句柄的 BCRYPT_KEY_HANDLE 指標。 此句柄用於需要密鑰的後續函式，例如 BCryptEncrypt。 當不再需要此句柄時，必須將它傳遞至 BCryptDestroyKey 函 式來釋出此句柄。

[out, optional] pbKeyObject

接收索引鍵對象的緩衝區指標。 cbKeyObject 參數包含這個緩衝區的大小。 呼叫 BCryptGetProperty 函式以取得此緩衝區的必要大小，以取得 BCRYPT_OBJECT_LENGTH 屬性。 這會提供指定演算法的索引鍵物件大小。

此記憶體只能在 phKey 金鑰句柄終結之後釋放。

如果此參數的值是 NULL ，而 cbKeyObject 參數的值是零，則此函式會配置並釋放索引鍵物件的記憶體。Windows 7： 從 Windows 7 開始，可以使用此記憶體管理功能。

[in] cbKeyObject

pbKeyObject 緩衝區的大小，以位元組為單位。

如果此參數的值是零，而且 pbKeyObject 參數的值是 NULL，則此函式會配置並釋放索引鍵物件的記憶體。Windows 7： 從 Windows 7 開始，可以使用此記憶體管理功能。

[in] pbSecret

緩衝區的指標，其中包含要從中建立索引鍵物件的索引鍵。 cbSecret 參數包含這個緩衝區的大小。 這通常是密碼的哈希或其他可重現的數據。 如果傳入的數據超過目標金鑰大小，則會截斷數據，並忽略多餘的數據。

注意 強烈建議應用程式傳入目標索引鍵所需的確切位元節數目。
 

[in] cbSecret

pbSecret 緩衝區的大小，以位元組為單位。

[in] dwFlags

一組旗標，可修改此函式的行為。 目前未定義旗標，因此此參數應該是零。

傳回值

傳回狀態代碼，指出函式的成功或失敗。

可能的傳回碼包括但不限於下列各項。

傳回碼 Description
STATUS_SUCCESS
 函式成功。
STATUS_BUFFER_TOO_SMALL
 cbKeyObject 參數所指定的索引鍵物件大小不足以保存索引鍵物件。
STATUS_INVALID_HANDLE
 hAlgorithm 參數中的演算法句柄無效。
STATUS_INVALID_PARAMETER
 一或多個參數無效。

備註

根據提供者支持的處理器模式，可以從使用者模式或核心模式呼叫 BCryptGenerateSymmetricKey 。 核心模式呼叫端可以在 IRQL PASSIVE_LEVEL 或DISPATCH_LEVELIRQL 上執行。 如果目前的 IRQL 層級 DISPATCH_LEVEL， 則 hAlgorithm 參數中提供的句柄必須使用 BCRYPT_PROV_DISPATCH 旗標來開啟，而且傳遞至 BCryptGenerateSymmetricKey 函式的任何指標都必須參考非分頁 (或鎖定的) 記憶體。

若要在核心模式中呼叫此函式，請使用 Cng.lib，這是驅動程式開發工具包 (DDK) 的一部分。 Windows Server 2008 和 Windows Vista： 若要在核心模式中呼叫此函式，請使用 Ksecdd.lib。

規格需求

需求 值
最低支援的用戶端 Windows Vista [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2008 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 bcrypt.h
程式庫 Bcrypt.lib
Dll Bcrypt.dll

另請參閱

BCryptDestroyKey