Fungsi BCryptCreateHash (bcrypt.h)

Artikel
07/16/2024

Fungsi BCryptCreateHash dipanggil untuk membuat objek hash atau Message Authentication Code (MAC).

Sintaksis

NTSTATUS BCryptCreateHash(
  [in, out]      BCRYPT_ALG_HANDLE  hAlgorithm,
  [out]          BCRYPT_HASH_HANDLE *phHash,
  [out]          PUCHAR             pbHashObject,
  [in, optional] ULONG              cbHashObject,
  [in, optional] PUCHAR             pbSecret,
  [in]           ULONG              cbSecret,
  [in]           ULONG              dwFlags
);

Parameter

[in, out] hAlgorithm

Handel penyedia algoritma yang dibuat dengan menggunakan fungsi BCryptOpenAlgorithmProvider . Algoritma yang ditentukan ketika penyedia dibuat harus mendukung antarmuka hash.

[out] phHash

Penunjuk ke nilai BCRYPT_HASH_HANDLE yang menerima handel yang mewakili objek hash atau MAC. Handel ini digunakan dalam fungsi hashing atau MAC berikutnya, seperti fungsi BCryptHashData. Setelah Anda selesai menggunakan handel ini, lepaskan dengan meneruskannya ke fungsi BCryptDestroyHash .

[out] pbHashObject

Penunjuk ke buffer yang menerima objek hash atau MAC. Parameter cbHashObject berisi ukuran buffer ini. Ukuran buffer ini yang diperlukan dapat diperoleh dengan memanggil fungsi BCryptGetProperty untuk mendapatkan properti BCRYPT_OBJECT_LENGTH. Ini akan memberikan ukuran objek hash atau MAC untuk algoritma yang ditentukan.

Memori ini hanya dapat dibebaskan setelah handel yang ditunjukkan oleh parameter phHash dihancurkan.

Jika nilai parameter ini NULL dan nilai parameter cbHashObject adalah nol, memori untuk objek hash dialokasikan dan dibebaskan oleh fungsi ini. Windows 7: Fungsionalitas manajemen memori ini tersedia dimulai dengan Windows 7.

[in, optional] cbHashObject

Ukurannya, dalam byte, dari pbHashObject buffer.

Jika nilai parameter ini nol dan nilai parameter pbHashObject NULL, memori untuk objek kunci dialokasikan dan dibebaskan oleh fungsi ini. Windows 7: Fungsionalitas manajemen memori ini tersedia dimulai dengan Windows 7.

[in, optional] pbSecret

Penunjuk ke buffer yang berisi kunci yang akan digunakan untuk hash atau MAC. Parameter cbSecret berisi ukuran buffer ini. Kunci ini hanya berlaku untuk algoritma hash yang dibuka oleh fungsi BCryptOpenAlgorithmProvider dengan menggunakan bendera BCRYPT_ALG_HANDLE_HMAC_FLAG . Jika tidak, atur parameter ini ke null.

[in] cbSecret

Ukurannya, dalam byte, dari pbSecret buffer. Jika tidak ada kunci yang digunakan, atur parameter ini ke nol.

[in] dwFlags

Bendera yang mengubah perilaku fungsi. Ini bisa nol atau nilai berikut.

Nilai	Arti
BCRYPT_HASH_REUSABLE_FLAG	Membuat objek hashing yang dapat digunakan kembali. Objek dapat digunakan untuk operasi hashing baru segera setelah memanggil BCryptFinishHash. Untuk informasi selengkapnya, lihat Membuat Hash dengan CNG. Windows Server 2008 R2, Windows 7, Windows Server 2008 dan Windows Vista: Bendera ini tidak didukung.

Mengembalikan nilai

Mengembalikan kode status yang menunjukkan keberhasilan atau kegagalan fungsi.

Kemungkinan kode pengembalian termasuk, tetapi tidak terbatas pada, berikut ini.

Mengembalikan kode	Deskripsi
STATUS_SUCCESS	Fungsi berhasil.
STATUS_BUFFER_TOO_SMALL	Ukuran objek hash yang ditentukan oleh parameter cbHashObject tidak cukup besar untuk menahan objek hash.
STATUS_INVALID_HANDLE	Handel algoritma dalam parameter hAlgoritma tidak valid.
STATUS_INVALID_PARAMETER	Satu atau beberapa parameter tidak valid.
STATUS_NOT_SUPPORTED	Penyedia algoritma yang ditentukan oleh parameter hAlgoritma tidak mendukung antarmuka hash.

Komentar

Bergantung pada mode prosesor apa yang didukung penyedia, BCryptCreateHash dapat dipanggil baik dari mode pengguna atau mode kernel. Pemanggil mode kernel dapat menjalankan baik di PASSIVE_LEVELIRQL atau IRQL DISPATCH_LEVEL. Jika tingkat IRQL saat ini DISPATCH_LEVEL, handel yang disediakan dalam parameter hAlgoritma harus dibuka dengan menggunakan bendera BCRYPT_PROV_DISPATCH, dan setiap penunjuk yang diteruskan ke fungsi BCryptCreateHash harus mengacu pada memori yang tidak dipagasi (atau dikunci).

Untuk memanggil fungsi ini dalam mode kernel, gunakan Cng.lib, yang merupakan bagian dari Driver Development Kit (DDK). Untuk informasi selengkapnya, lihat WDK dan Alat Pengembang.Windows Server 2008 dan Windows Vista: Untuk memanggil fungsi ini dalam mode kernel, gunakan Ksecdd.lib.

Persyaratan

Syarat	Nilai
klien minimum yang didukung	Windows Vista [aplikasi desktop \| Aplikasi UWP]
server minimum yang didukung	Windows Server 2008 [aplikasi desktop \| Aplikasi UWP]
Platform Target	Windows
Header	bcrypt.h
Pustaka	Bcrypt.lib
DLL	Bcrypt.dll

Lihat juga

BCryptDestroyHash

Bagikan melalui