[#FSChaCha20Poly1305]
= FSChaCha20Poly1305
:mrdocs:

Forward‐secure wrapper around AEADChaCha20Poly1305.

== Synopsis

Declared in `<crypto/chacha20poly1305.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class FSChaCha20Poly1305;
----

== Description

This implements an AEAD which automatically increments the nonce on every encryption or decryption, and cycles keys after a predetermined number of encryptions or decryptions.

See BIP324 for details.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:FSChaCha20Poly1305/2constructor-011.adoc[`FSChaCha20Poly1305`]         [.small]#[constructor]#
| Constructors
| xref:FSChaCha20Poly1305/operator_assign-0bf.adoc[`operator=`] 
| Assignment operators
| xref:FSChaCha20Poly1305/Decrypt-0e.adoc[`Decrypt`] 
| `Decrypt` overloads
| xref:FSChaCha20Poly1305/Encrypt-04.adoc[`Encrypt`] 
| `Encrypt` overloads
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:FSChaCha20Poly1305/EXPANSION.adoc[`EXPANSION`] 
| Expansion when encrypting.
| xref:FSChaCha20Poly1305/KEYLEN.adoc[`KEYLEN`] 
| Length of keys expected by the constructor.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#