Skip to content

doc,test: clarify ChaCha20-Poly1305 usage

Rodrigo Muino Tomonari requested to merge github/fork/tniessen/mention-chacha20poly1305-in-crypto-doc into master

The crypto documentation does not list chacha20-poly1305 as a supported AEAD algorithm and omits that the algorithm requires passing the authTagLength option.

This patch changes that and also adds a test to assert that the documented behavior is correct.

Arguably, chacha20-poly1305 should not require the authTagLength option. I'll probably open a separate semver-minor PR to address that and update the documentation accordingly.

Merge request reports