Struct fuzzytags::FuzzyDetectionKey

pub struct FuzzyDetectionKey(_);

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

Implementations

impl FuzzyDetectionKey

pub fn id(&self) -> String

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

impl FuzzyDetectionKey

pub fn false_positive_probability(&self) -> f64

calculate the ideal false positive rate of this detection key

   use fuzzytags::FuzzySecretKey;
   let gamma = 24;
   let secret_key = FuzzySecretKey::generate(gamma);
   let public_key = secret_key.public_key();
   // extract a detection key
   let detection_key = secret_key.extract(5);
   detection_key.false_positive_probability();

pub fn test_tag(&self, tag: &FuzzyTag) -> bool

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

   use fuzzytags::FuzzySecretKey;
    let gamma = 24;
   let secret_key = FuzzySecretKey::generate(gamma);
   let public_key = secret_key.public_key();
   // extract a detection key
   let detection_key = secret_key.extract(5);

   // Give public key to a another party...
   // and then they can do...
   let tag = public_key.generate_tag();

   // 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 Clone for FuzzyDetectionKey

fn clone(&self) -> FuzzyDetectionKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FuzzyDetectionKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FuzzyDetectionKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for FuzzyDetectionKey

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

Formats the value using the given formatter.

impl Serialize for FuzzyDetectionKey

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

Serialize this value into the given Serde serializer.