Struct MsgAuthCode

pub struct MsgAuthCode { /* private fields */ }

Message authentication code

Implementations

impl MsgAuthCode

pub fn new(name: &str) -> Result<MsgAuthCode>

Create a new message authentication code

Examples

let hmac = botan::MsgAuthCode::new("HMAC(SHA-256)").unwrap();

let poly1305 = botan::MsgAuthCode::new("Poly1305").unwrap();

pub fn algo_name(&self) -> Result<String>

Return the name of this algorithm which may or may not exactly match what was provided to new()

Examples

let mac = botan::MsgAuthCode::new("HMAC(SHA-384)").unwrap();
assert_eq!(mac.algo_name().unwrap(), "HMAC(SHA-384)");

pub fn key_spec(&self) -> Result<KeySpec>

Return information about the key lengths supported by this object

pub fn output_length(&self) -> Result<usize>

Return the output length of the authentication code, in bytes

Examples

let hmac = botan::MsgAuthCode::new("HMAC(SHA-256)").unwrap();
assert_eq!(hmac.output_length().unwrap(), 32);

pub fn set_key(&mut self, key: &[u8]) -> Result<()>

Set the key for the authentication code object

Examples

let mut hmac = botan::MsgAuthCode::new("HMAC(SHA-256)").unwrap();
hmac.set_key(&vec![0; 16]).unwrap();

pub fn set_nonce(&mut self, nonce: &[u8]) -> Result<()>

Set the nonce for the authentication code object

Only a few MACs support this; currently only GMAC

Examples

let mut gmac = botan::MsgAuthCode::new("GMAC(AES-128)").unwrap();
gmac.set_key(&vec![0; 16]).unwrap();
gmac.set_nonce(&vec![0; 12]);

pub fn update(&mut self, data: &[u8]) -> Result<()>

Add data to a MAC computation, may be called many times

Examples

let mut hmac = botan::MsgAuthCode::new("HMAC(SHA-256)").unwrap();
assert!(hmac.update(&[23]).is_err()); // key not set yet
hmac.set_key(&vec![0; 16]).unwrap();
hmac.update(&[1,2,3]).unwrap();
hmac.update(&[4,5,6]).unwrap();

pub fn finish(&mut self) -> Result<Vec<u8>>

Complete a MAC computation, after which the object is reset to MAC a new message with the same key.

Examples

let mut hmac = botan::MsgAuthCode::new("HMAC(SHA-256)").unwrap();
assert!(hmac.update(&[23]).is_err()); // key not set yet
hmac.set_key(&vec![0; 16]).unwrap();
hmac.update(&[1,2,3]).unwrap();
hmac.update(&[4,5,6]).unwrap();
let mac = hmac.finish().unwrap();

pub fn clear(&mut self) -> Result<()>

Clear the MAC key

Examples

let mut hmac = botan::MsgAuthCode::new("HMAC(SHA-256)").unwrap();
hmac.set_key(&vec![0; 16]).unwrap();
hmac.update(&[1,2,3]).unwrap();
hmac.clear().unwrap();
assert!(hmac.update(&[23]).is_err()); // key not set anymore

Trait Implementations

impl Debug for MsgAuthCode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for MsgAuthCode

fn drop(&mut self)

Executes the destructor for this type.

impl Send for MsgAuthCode

impl Sync for MsgAuthCode