Struct CryptState

Source
pub struct CryptState<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> { /* private fields */ }
Expand description

Implements OCB2-AES128 for encryption and authentication of the voice packets when transmitted over UDP. Also provides statistics about good, late and lost packets.

Implements a Codec which parses a stream of encrypted data chunks into VoicePackets.

Note that OCB is covered by patents, however a license has been granted for use in “most” software. See: http://web.cs.ucdavis.edu/~rogaway/ocb/license.htm

Based on https://github.com/mumble-voip/mumble/blob/e31d267a11b4ed0597ad41309a7f6b715837141f/src/CryptState.cpp

Implementations§

Source§

impl<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> CryptState<EncodeDst, DecodeDst>

Source

pub fn generate_new() -> Self

Creates a new CryptState with randomly generated key and initial encrypt- and decrypt-nonce.

Source

pub fn new_from( key: [u8; 16], encrypt_nonce: [u8; 16], decrypt_nonce: [u8; 16], ) -> Self

Creates a new CryptState from previously generated key, encrypt- and decrypt-nonce.

Source

pub fn get_good(&self) -> u32

Returns the amount of packets transmitted without issues.

Source

pub fn get_late(&self) -> u32

Returns the amount of packets which were transmitted successfully but arrived late.

Source

pub fn get_lost(&self) -> u32

Returns the amount of packets which were lost.

Source

pub fn get_key(&self) -> &[u8; 16]

Returns the shared, private key.

Source

pub fn get_encrypt_nonce(&self) -> [u8; 16]

Returns the nonce used for encrypting.

Source

pub fn get_decrypt_nonce(&self) -> [u8; 16]

Returns the nonce used for decrypting.

Source

pub fn set_decrypt_nonce(&mut self, nonce: &[u8; 16])

Updates the nonce used for decrypting.

Source

pub fn encrypt(&mut self, packet: VoicePacket<EncodeDst>, dst: &mut BytesMut)

Encrypts an encoded voice packet and returns the resulting bytes.

Source

pub fn decrypt( &mut self, buf: &mut BytesMut, ) -> Result<Result<VoicePacket<DecodeDst>, Error>, DecryptError>

Decrypts a voice packet and (if successful) returns the Result of parsing the packet.

Trait Implementations§

Source§

impl<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> Decoder for CryptState<EncodeDst, DecodeDst>

Source§

type Item = VoicePacket<DecodeDst>

The type of decoded frames.
Source§

type Error = Error

The type of unrecoverable frame decoding errors. Read more
Source§

fn decode( &mut self, buf_mut: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes. Read more
Source§

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O. Read more
Source§

fn framed<T>(self, io: T) -> Framed<T, Self>
where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data. Read more
Source§

impl<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> Encoder<VoicePacket<EncodeDst>> for CryptState<EncodeDst, DecodeDst>

Source§

type Error = Error

The type of encoding errors. Read more
Source§

fn encode( &mut self, item: VoicePacket<EncodeDst>, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided. Read more

Auto Trait Implementations§

§

impl<EncodeDst, DecodeDst> Freeze for CryptState<EncodeDst, DecodeDst>

§

impl<EncodeDst, DecodeDst> RefUnwindSafe for CryptState<EncodeDst, DecodeDst>
where EncodeDst: RefUnwindSafe, DecodeDst: RefUnwindSafe,

§

impl<EncodeDst, DecodeDst> Send for CryptState<EncodeDst, DecodeDst>
where EncodeDst: Send, DecodeDst: Send,

§

impl<EncodeDst, DecodeDst> Sync for CryptState<EncodeDst, DecodeDst>
where EncodeDst: Sync, DecodeDst: Sync,

§

impl<EncodeDst, DecodeDst> Unpin for CryptState<EncodeDst, DecodeDst>
where EncodeDst: Unpin, DecodeDst: Unpin,

§

impl<EncodeDst, DecodeDst> UnwindSafe for CryptState<EncodeDst, DecodeDst>
where EncodeDst: UnwindSafe, DecodeDst: UnwindSafe,

Blanket Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.