Struct DetectionKey

pub struct DetectionKey<const GAMMA: u8>(/* private fields */);

A collection of “secret” data that can be used to determine if a FuzzyTag was intended for the derived tagging key with probability p

Implementations

impl<const GAMMA: u8> DetectionKey<GAMMA>

pub fn id(&self) -> String

a convenient id for a detection key for internal accounting purposes do not expose this to applications

impl<const GAMMA: u8> DetectionKey<GAMMA>

pub fn false_positive_probability(&self) -> f64

calculate the ideal false positive rate of this detection key

   use fuzzytags::RootSecret;
    use rand::rngs::OsRng;
    let mut rng = OsRng;
   let secret = RootSecret::<24>::generate(&mut rng);
   let tagging_key = secret.tagging_key();
   // extract a detection key
   let detection_key = secret.extract_detection_key(5);
   detection_key.false_positive_probability();

pub fn test_tag(&self, tag: &Tag<GAMMA>) -> bool

returns true if the tag was intended for this key Example:

   use fuzzytags::RootSecret;
   use rand::rngs::OsRng;
   let mut rng = OsRng;
   let secret = RootSecret::<24>::generate(&mut rng);
   let tagging_key = secret.tagging_key();
   // extract a detection key
   let detection_key = secret.extract_detection_key(5);

   // Give tagging key to a another party...
   // and then they can do...
   let tag = tagging_key.generate_tag(&mut rng);

   // The server can now do this:
   if detection_key.test_tag(&tag) {
   // the message attached to this tag *might* be for the party associated with the detection key
   } else {
   // the message attached to this tag is definitely *not* for the party associated with the detection key.
   }

Trait Implementations

impl<const GAMMA: u8> Clone for DetectionKey<GAMMA>

fn clone(&self) -> DetectionKey<GAMMA>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const GAMMA: u8> Debug for DetectionKey<GAMMA>

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

Formats the value using the given formatter.

impl<'de, const GAMMA: u8> Deserialize<'de> for DetectionKey<GAMMA>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const GAMMA: u8> Display for DetectionKey<GAMMA>

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

Formats the value using the given formatter.

impl<const GAMMA: u8> Serialize for DetectionKey<GAMMA>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.