wgcfg: improve SymmetricKey docs

crawshaw · crawshaw · commit d127a1647efb · 2020-03-31T21:30:06.000+11:00
Signed-off-by: David Crawshaw &lt;crawshaw@tailscale.com&gt;
diff --git a/wgcfg/key.go b/wgcfg/key.go
@@ -229,8 +229,7 @@ func ParseSymmetricHexKey(s string) (SymmetricKey, error) {
 	return key, nil
 }
 
-// SymmetricKey is a chacha20poly1305 key.
-// It is used by WireGuard to represent pre-shared symmetric keys.
+// SymmetricKey is a 32-byte value used as a pre-shared key.
 type SymmetricKey [chacha20poly1305.KeySize]byte
 
 func (k SymmetricKey) Base64() string             { return base64.StdEncoding.EncodeToString(k[:]) }

Original file line number	Diff line number	Diff line change
`@@ -229,8 +229,7 @@ func ParseSymmetricHexKey(s string) (SymmetricKey, error) {`
`229`	`229`	`return key, nil`
`230`	`230`	`}`
`231`	`231`
`232`		`-// SymmetricKey is a chacha20poly1305 key.`
`233`		`-// It is used by WireGuard to represent pre-shared symmetric keys.`
	`232`	`+// SymmetricKey is a 32-byte value used as a pre-shared key.`
`234`	`233`	`type SymmetricKey [chacha20poly1305.KeySize]byte`
`235`	`234`
`236`	`235`	`func (k SymmetricKey) Base64() string { return base64.StdEncoding.EncodeToString(k[:]) }`