summaryrefslogtreecommitdiff
path: root/securecookie.go
diff options
context:
space:
mode:
authorMatt Silverlock <silverlock@google.com>2018-09-13 21:41:34 +0300
committerMatt Silverlock <silverlock@google.com>2018-09-13 21:41:34 +0300
commit11123820fba8bbc52739252fb69b5e421fcbea3a (patch)
treecae86b6237a663875ab160271d9ff668558c2e8a /securecookie.go
parent1aeabd195284b0b9e2be63137c303377d84d7eb8 (diff)
[docs] Add note RE: persistence to GenerateRandomKey
Diffstat (limited to 'securecookie.go')
-rw-r--r--securecookie.go4
1 files changed, 4 insertions, 0 deletions
diff --git a/securecookie.go b/securecookie.go
index 61af390..a34f851 100644
--- a/securecookie.go
+++ b/securecookie.go
@@ -506,6 +506,10 @@ func decode(value []byte) ([]byte, error) {
// GenerateRandomKey creates a random key with the given length in bytes.
// On failure, returns nil.
//
+// Note that keys created using `GenerateRandomKey()` are not automatically
+// persisted. New keys will be created when the application is restarted, and
+// previously issued cookies will not be able to be decoded.
+//
// Callers should explicitly check for the possibility of a nil return, treat
// it as a failure of the system random number generator, and not continue.
func GenerateRandomKey(length int) []byte {