Struct ChaCha20Poly1305

pub struct ChaCha20Poly1305 { /* private fields */ }

Available on crate feature chacha20poly1305 only.

OpenSSH variant of ChaCha20Poly1305: chacha20-poly1305@openssh.com as described in PROTOCOL.chacha20poly1305.

Differences from ChaCha20Poly1305-IETF as described in RFC8439:

• Nonce is 64-bit instead of 96-bit (i.e. uses legacy “djb” ChaCha20 variant).
• The AAD and ciphertext inputs of Poly1305 are not padded.
• The lengths of ciphertext and AAD are not authenticated using Poly1305.
• Maximum supported AAD size is 16.

Usage notes

• In the context of SSH packet encryption, AAD will be 4 bytes and contain the encrypted length.
• In the context of SSH key encryption, AAD will be empty.

Trait Implementations

impl AeadCore for ChaCha20Poly1305

const TAG_POSITION: TagPosition = TagPosition::Postfix

The AEAD tag position.

type NonceSize = UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>

The length of a nonce.

type TagSize = UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>

The maximum length of the tag.

impl AeadInOut for ChaCha20Poly1305

fn encrypt_inout_detached( &self, nonce: &ChaChaNonce, associated_data: &[u8], buffer: InOutBuf<'_, '_, u8>, ) -> Result<Tag>

Encrypt the data in the provided InOutBuf, returning the authentication tag.

fn decrypt_inout_detached( &self, nonce: &ChaChaNonce, associated_data: &[u8], buffer: InOutBuf<'_, '_, u8>, tag: &Tag, ) -> Result<()>

Decrypt the data in the provided InOutBuf, returning an error in the event the provided authentication tag is invalid for the given ciphertext (i.e. ciphertext is modified/unauthentic)

fn encrypt_in_place( &self, nonce: &Array<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut dyn Buffer, ) -> Result<(), Error>

Encrypt the given buffer containing a plaintext message in-place.

fn decrypt_in_place( &self, nonce: &Array<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut dyn Buffer, ) -> Result<(), Error>

Decrypt the message in-place, returning an error in the event the provided authentication tag does not match the given ciphertext.

impl Clone for ChaCha20Poly1305

fn clone(&self) -> ChaCha20Poly1305

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for ChaCha20Poly1305

fn drop(&mut self)

Executes the destructor for this type.

impl KeyInit for ChaCha20Poly1305

fn new(key: &ChaChaKey) -> Self

Create new value from fixed size key.

fn weak_key_test(_key: &Array<u8, Self::KeySize>) -> Result<(), WeakKeyError>

Check if the key might be considered weak.

fn new_checked(key: &Array<u8, Self::KeySize>) -> Result<Self, WeakKeyError>

Create new value from fixed size key after checking it for weakness.

fn new_from_slice(key: &[u8]) -> Result<Self, InvalidLength>

Create new value from variable size key.

impl KeySizeUser for ChaCha20Poly1305

type KeySize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>

Key size in bytes.

fn key_size() -> usize

Return key size in bytes.

impl ZeroizeOnDrop for ChaCha20Poly1305

Available on crate feature zeroize only.