Struct DetectionKey

pub struct DetectionKey { /* private fields */ }

Used to examine Clues and determine whether they were possibly sent to the detection key’s ClueKey.

Implementations

impl DetectionKey

pub fn new<R: RngCore + CryptoRng>(rng: R) -> Self

Create a random detection key using the supplied rng.

pub fn from_field(dtk: Fr) -> Self

Create a detection key using the supplied field element directly.

Warning

This function exists to support custom key derivation mechanisms; it’s the caller’s responsibility to construct the detection key dtk correctly.

pub fn to_bytes(&self) -> [u8; 32]

Serialize this detection key to bytes.

pub fn from_bytes(bytes: [u8; 32]) -> Result<Self, Error>

Deserialize a detection key from bytes.

pub fn clue_key(&self) -> ClueKey

Obtain the clue key corresponding to this detection key.

pub fn examine(&self, clue: &Clue) -> bool

Use this detection key to examine the given clue, returning true if the clue was possibly sent to this detection key’s clue key.

This test has false positives, but no false negatives.

This function executes in constant time with respect to the detection key material, but short-circuits to return early on a false detection.