pkg/crypto/hmac: fix package documentation

Change-Id: I655aa7a95e36ffea34f5409d533bb070565317f5 Reviewed-on: https://cue-review.googlesource.com/c/cue/+/9683 Reviewed-by: CUE cueckoo <[email protected]> Reviewed-by: Paul Jolly <[email protected]>
cuelang · May 5, 2021 · 2118921 · 2118921
1 parent 1f1c3f6
commit 2118921
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/pkg/crypto/hmac/hmac.go b/pkg/crypto/hmac/hmac.go
@@ -1,4 +1,4 @@
-// Copyright 2020 CUE Authors
+// Copyright 2021 CUE Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,6 +11,12 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+// Package hmac implements the Keyed-Hash Message Authentication Code (HMAC) as
+// defined in U.S. Federal Information Processing Standards Publication 198.
+//
+// An HMAC is a cryptographic hash that uses a key to sign a message.
+// The receiver verifies the hash by recomputing it using the same key.
 package hmac
 
 import (