From 7029a2efc7c689d58e885eb12374b23c578763f9 Mon Sep 17 00:00:00 2001
From: Matt Silverlock <matt@eatsleeprepeat.net>
Date: Sat, 8 Aug 2015 19:16:04 +0800
Subject: Improved warning around GenerateRandomKey.

---
 securecookie.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/securecookie.go b/securecookie.go
index 7dd373d..b1cb144 100644
--- a/securecookie.go
+++ b/securecookie.go
@@ -474,6 +474,9 @@ func decode(value []byte) ([]byte, error) {
 
 // GenerateRandomKey creates a random key with the given length in bytes.
 // On failure, returns nil.
+//
+// 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 {
 	k := make([]byte, length)
 	if _, err := io.ReadFull(rand.Reader, k); err != nil {
-- 
cgit v1.2.3