Struct mumble_protocol::crypt::CryptState

pub struct CryptState<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> { /* fields omitted */ }

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

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

pub fn generate_new() -> Self

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

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.

pub fn get_good(&self) -> u32

Returns the amount of packets transmitted without issues.

pub fn get_late(&self) -> u32

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

pub fn get_lost(&self) -> u32

Returns the amount of packets which were lost.

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

Returns the shared, private key.

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

Returns the nonce used for encrypting.

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

Returns the nonce used for decrypting.

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

Updates the nonce used for decrypting.

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

Encrypts an encoded voice packet and returns the resulting bytes.

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

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

type Item = VoicePacket<DecodeDst>

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

pub 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.

pub 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.

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

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.

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

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.