]> git.ipfire.org Git - thirdparty/wireguard-go.git/commitdiff
wgcfg: improve SymmetricKey docs
authorDavid Crawshaw <crawshaw@tailscale.com>
Tue, 31 Mar 2020 10:28:56 +0000 (21:28 +1100)
committerDavid Crawshaw <david@zentus.com>
Tue, 31 Mar 2020 10:30:06 +0000 (21:30 +1100)
Signed-off-by: David Crawshaw <crawshaw@tailscale.com>
wgcfg/key.go

index 1597203b148a0f01604abc842c31d8869a3dede2..cdbbeea7099119a2d8a93dcd20b96098fb2090e5 100644 (file)
@@ -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[:]) }