diff options
| author | Jakob Unterwurzacher | 2021-09-07 17:58:42 +0200 |
|---|---|---|
| committer | Jakob Unterwurzacher | 2021-09-07 18:15:04 +0200 |
| commit | f47e287c202ba92e9b48e65bf95e0771c6c4997c (patch) | |
| tree | d46cfc841c46b82977da1e83dd1be5080edbf8ae /internal/stupidgcm/xchacha.go | |
| parent | d598536709db355366e90870c6df3508c71c5884 (diff) | |
stupidgcm: revamp package documentation
Maybe interesting for people following
https://github.com/rfjakob/gocryptfs/issues/452
Diffstat (limited to 'internal/stupidgcm/xchacha.go')
| -rw-r--r-- | internal/stupidgcm/xchacha.go | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/internal/stupidgcm/xchacha.go b/internal/stupidgcm/xchacha.go index 055b7f7..deb6e2f 100644 --- a/internal/stupidgcm/xchacha.go +++ b/internal/stupidgcm/xchacha.go @@ -26,12 +26,15 @@ type stupidXchacha20poly1305 struct { wiped bool } -// NewXchacha20poly1305 returns a XChaCha20-Poly1305 AEAD that uses the given 256-bit key. +// NewXchacha20poly1305 returns a XChaCha20-Poly1305 cipher that satisfied the +// cipher.AEAD interface. // // XChaCha20-Poly1305 is a ChaCha20-Poly1305 variant that takes a longer nonce, // suitable to be generated randomly without risk of collisions. It should be // preferred when nonce uniqueness cannot be trivially ensured, or whenever // nonces are randomly generated. +// +// Only 32-bytes keys and 24-byte IVs are supported. func NewXchacha20poly1305(key []byte) cipher.AEAD { if len(key) != chacha20poly1305.KeySize { log.Panic("bad key length") |