Struct CaptchaManager 

pub struct CaptchaManager { /* private fields */ }

Implementations

impl CaptchaManager

pub fn new( secret: String, challenge_ttl: u64, noise: NoiseOptions, registry: Option<Arc<dyn ChallengeRegistry>>, gen_opts: GenerationOptions, samples: &SampleSet, ) -> Result<Self>

secret must be at least 32 bytes. It is zeroized on drop.

Without a registry every challenge accepts nine guesses.

samples is decoded once here.

Errors

Returns CaptchaError::InvalidInput if secret is shorter than 32 bytes, if challenge_ttl is outside 1..=86400, or if noise, gen_opts or samples are out of range. Returns CaptchaError::Decode if a sample fails to decode.

pub fn generate_challenge<T: SpriteTarget>(&self) -> Result<CaptchaChallenge<T>>

Errors

Returns CaptchaError::Decode or CaptchaError::Encode when the sprite cannot be built, and CaptchaError::Clock when the system clock predates the unix epoch.

pub fn verify_challenge( &self, challenge_id: &str, selected: &[u8], ) -> Result<bool>

selected holds one index per round, in the order the sprites were issued. Returns Ok(false) for a well-formed guess that does not match.

Errors

Returns CaptchaError::InvalidInput for a challenge_id that is empty or longer than an issued id, a selected length other than GenerationOptions::rounds, or any index outside 1..=9. Returns CaptchaError::Registry when the registry refuses the id, including a correct guess that lost a race to an earlier one.