Struct crypto_box::SalsaBox

source · [−]

pub struct SalsaBox(_);

Expand description

Public-key encryption scheme based on the X25519 Elliptic Curve Diffie-Hellman function and the XSalsa20Poly1305 authenticated encryption cipher.

This type impls the aead::Aead trait, and otherwise functions as a symmetric Authenticated Encryption with Associated Data (AEAD) cipher once instantiated.

Implementations

source

impl SalsaBox

source

pub fn new(public_key: &PublicKey, secret_key: &SecretKey) -> Self

Create a new SalsaBox, performing X25519 Diffie-Hellman to derive a shared secret from the provided public and secret keys.

Trait Implementations

source

impl AeadCore for SalsaBox

type NonceSize = U24

The length of a nonce.

type TagSize = U16

The maximum length of the nonce.

type CiphertextOverhead = U0

The upper bound amount of additional space required to support a ciphertext vs. a plaintext. Read more

source

impl AeadInPlace for SalsaBox

source

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

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

source

fn encrypt_in_place_detached(
 &self,
 nonce: &GenericArray<u8, Self::NonceSize>,
 associated_data: &[u8 ],
 buffer: &mut [u8 ]
) -> Result<Tag, Error>

Encrypt the data in-place, returning the authentication tag

source

fn decrypt_in_place(
 &self,
 nonce: &GenericArray<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. Read more

source

fn decrypt_in_place_detached(
 &self,
 nonce: &GenericArray<u8, Self::NonceSize>,
 associated_data: &[u8 ],
 buffer: &mut [u8 ],
 tag: &Tag
) -> Result<(), Error>

Decrypt the message in-place, returning an error in the event the provided authentication tag does not match the given ciphertext (i.e. ciphertext is modified/unauthentic) Read more

source

impl Clone for SalsaBox

source

fn clone(&self) -> SalsaBox

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl RefUnwindSafe for SalsaBox

impl Send for SalsaBox

impl Sync for SalsaBox

impl Unpin for SalsaBox

impl UnwindSafe for SalsaBox

Blanket Implementations

source

impl<Alg> Aead for Alg where
Alg: AeadInPlace,

source

fn encrypt<'msg, 'aad>(
 &self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 plaintext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Encrypt the given plaintext payload, and return the resulting ciphertext as a vector of bytes. Read more

source

fn decrypt<'msg, 'aad>(
 &self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 ciphertext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Decrypt the given ciphertext slice, and return the resulting plaintext as a vector of bytes. Read more

source

impl<Alg> AeadMut for Alg where
Alg: AeadMutInPlace,

source

fn encrypt<'msg, 'aad>(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 plaintext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Encrypt the given plaintext slice, and return the resulting ciphertext as a vector of bytes. Read more

source

fn decrypt<'msg, 'aad>(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 ciphertext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Decrypt the given ciphertext slice, and return the resulting plaintext as a vector of bytes. Read more

source

impl<Alg> AeadMutInPlace for Alg where
Alg: AeadInPlace,

source

fn encrypt_in_place(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 associated_data: &[u8 ],
 buffer: &mut impl Buffer
) -> Result<(), Error>

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

source

fn encrypt_in_place_detached(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 associated_data: &[u8 ],
 buffer: &mut [u8 ]
) -> Result<GenericArray<u8, <Alg as AeadCore>::TagSize>, Error>

Encrypt the data in-place, returning the authentication tag

source

fn decrypt_in_place(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 associated_data: &[u8 ],
 buffer: &mut impl Buffer
) -> Result<(), Error>

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

source

fn decrypt_in_place_detached(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 associated_data: &[u8 ],
 buffer: &mut [u8 ],
 tag: &GenericArray<u8, <Alg as AeadCore>::TagSize>
) -> Result<(), Error>

Decrypt the data in-place, returning an error in the event the provided authentication tag does not match the given ciphertext (i.e. ciphertext is modified/unauthentic) Read more

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct crypto_box::SalsaBox

Implementations

impl SalsaBox

pub fn new(public_key: &PublicKey, secret_key: &SecretKey) -> Self

Trait Implementations

impl AeadCore for SalsaBox

type NonceSize = U24

type TagSize = U16

type CiphertextOverhead = U0

impl AeadInPlace for SalsaBox

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

fn encrypt_in_place_detached( &self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut [u8]) -> Result<Tag, Error>

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

fn decrypt_in_place_detached( &self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut [u8], tag: &Tag) -> Result<(), Error>

impl Clone for SalsaBox

fn clone(&self) -> SalsaBox

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

Auto Trait Implementations

impl RefUnwindSafe for SalsaBox

impl Send for SalsaBox

impl Sync for SalsaBox

impl Unpin for SalsaBox

impl UnwindSafe for SalsaBox

Blanket Implementations

impl<Alg> Aead for Alg where Alg: AeadInPlace,

fn encrypt<'msg, 'aad>( &self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, plaintext: impl Into<Payload<'msg, 'aad>>) -> Result<Vec<u8, Global>, Error>

fn decrypt<'msg, 'aad>( &self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, ciphertext: impl Into<Payload<'msg, 'aad>>) -> Result<Vec<u8, Global>, Error>

impl<Alg> AeadMut for Alg where Alg: AeadMutInPlace,

fn encrypt<'msg, 'aad>( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, plaintext: impl Into<Payload<'msg, 'aad>>) -> Result<Vec<u8, Global>, Error>

fn decrypt<'msg, 'aad>( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, ciphertext: impl Into<Payload<'msg, 'aad>>) -> Result<Vec<u8, Global>, Error>

impl<Alg> AeadMutInPlace for Alg where Alg: AeadInPlace,

fn encrypt_in_place( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, associated_data: &[u8], buffer: &mut impl Buffer) -> Result<(), Error>

fn encrypt_in_place_detached( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, associated_data: &[u8], buffer: &mut [u8]) -> Result<GenericArray<u8, <Alg as AeadCore>::TagSize>, Error>

fn decrypt_in_place( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, associated_data: &[u8], buffer: &mut impl Buffer) -> Result<(), Error>

fn decrypt_in_place_detached( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, associated_data: &[u8], buffer: &mut [u8], tag: &GenericArray<u8, <Alg as AeadCore>::TagSize>) -> Result<(), Error>

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

fn encrypt_in_place_detached(
&self,
nonce: &GenericArray<u8, Self::NonceSize>,
associated_data: &[u8 ],
buffer: &mut [u8 ]
) -> Result<Tag, Error>

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

fn decrypt_in_place_detached(
&self,
nonce: &GenericArray<u8, Self::NonceSize>,
associated_data: &[u8 ],
buffer: &mut [u8 ],
tag: &Tag
) -> Result<(), Error>

impl<Alg> Aead for Alg where
Alg: AeadInPlace,

fn encrypt<'msg, 'aad>(
&self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
plaintext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

fn decrypt<'msg, 'aad>(
&self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
ciphertext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

impl<Alg> AeadMut for Alg where
Alg: AeadMutInPlace,

fn encrypt<'msg, 'aad>(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
plaintext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

fn decrypt<'msg, 'aad>(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
ciphertext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

impl<Alg> AeadMutInPlace for Alg where
Alg: AeadInPlace,

fn encrypt_in_place(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
associated_data: &[u8 ],
buffer: &mut impl Buffer
) -> Result<(), Error>

fn encrypt_in_place_detached(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
associated_data: &[u8 ],
buffer: &mut [u8 ]
) -> Result<GenericArray<u8, <Alg as AeadCore>::TagSize>, Error>

fn decrypt_in_place(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
associated_data: &[u8 ],
buffer: &mut impl Buffer
) -> Result<(), Error>

fn decrypt_in_place_detached(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
associated_data: &[u8 ],
buffer: &mut [u8 ],
tag: &GenericArray<u8, <Alg as AeadCore>::TagSize>
) -> Result<(), Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,