Add package doc with meaning of bcrypt

microsoft · Sep 9, 2024 · 9403ef0 · 9403ef0
1 parent ffb1756
commit 9403ef0
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/internal/bcrypt/bcrypt_windows.go b/internal/bcrypt/bcrypt_windows.go
@@ -3,6 +3,11 @@
 
 //go:generate go run github.com/microsoft/go-crypto-winnative/cmd/mksyscall -output zsyscall_windows.go bcrypt_windows.go
 
+// Package bcrypt implements interop with bcrypt.dll, a component of Windows CNG.
+// See https://learn.microsoft.com/en-us/windows/win32/api/bcrypt/
+// and https://learn.microsoft.com/en-us/windows/win32/seccng/cng-algorithm-identifiers
+//
+// Note: this package is not related to the bcrypt password hashing algorithm.
 package bcrypt
 
 import (