Struct Tag 

pub struct Tag(/* private fields */);

An authentication tag

This represents an authentication tag computed for a message using a secret key. The tag can be publicly shared and later verified to ensure the authenticity of a message.

Implementations

impl Tag

pub fn from_slice(slice: &[u8]) -> Result<Self>

Creates a tag from a byte slice

This function creates a tag from an existing byte slice, which must be exactly BYTES (32) bytes long. This is useful when you receive a tag from another party and need to verify it.

Arguments

• slice - Byte slice of exactly BYTES (32) bytes length

Returns

• Result<Self> - A new tag or an error if the input is invalid

Errors

Returns an error if the input is not exactly BYTES bytes long

Example

use libsodium_rs as sodium;
use sodium::crypto_auth;
use sodium::ensure_init;

// Initialize libsodium
ensure_init().expect("Failed to initialize libsodium");

// Create a tag from existing bytes
let tag_bytes = [0x42; crypto_auth::BYTES]; // In a real application, this would be a real tag
let tag = crypto_auth::Tag::from_slice(&tag_bytes).unwrap();

pub fn as_bytes(&self) -> &[u8]

Returns a reference to the tag as a byte slice

This method provides access to the raw bytes of the tag, which can be useful when you need to transmit the tag or store it.

Returns

• &[u8] - Reference to the tag bytes

Example

use libsodium_rs as sodium;
use sodium::crypto_auth;
use sodium::ensure_init;

// Initialize libsodium
ensure_init().expect("Failed to initialize libsodium");

// Generate a random key
let key = crypto_auth::Key::generate().unwrap();

// Compute authentication tag for a message
let message = b"Hello, world!";
let tag = crypto_auth::auth(message, &key).unwrap();

// Get the raw bytes of the tag
let tag_bytes = tag.as_bytes();
assert_eq!(tag_bytes.len(), crypto_auth::BYTES);

Trait Implementations

impl AsRef<[u8]> for Tag

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Tag

fn clone(&self) -> Tag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Eq for Tag

impl From<Tag> for [u8; 32]

fn from(tag: Tag) -> [u8; 32]

Converts to this type from the input type.

impl From<[u8; 32]> for Tag

fn from(bytes: [u8; 32]) -> Self

Converts to this type from the input type.

impl PartialEq for Tag

fn eq(&self, other: &Tag) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Tag

impl TryFrom<&[u8]> for Tag

type Error = SodiumError

The type returned in the event of a conversion error.

fn try_from(slice: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.