void-sentry-esp32/pin__guard_8h_source.html

#pragma once


#include "prov_types.h"


namespace prov

{

enum class PinCheck { Ok, Wrong, LockedOut, NotSet };


struct PinResult {

    PinCheck status = PinCheck::NotSet;

    uint32_t seconds_left = 0; // LockedOut only, rounded up

};


class PinGuard

{

public:

    static constexpr uint32_t kMaxFailures = 5;

    static constexpr uint32_t kBaseLockoutMs = 60000;

    static constexpr uint32_t kMaxLockoutMs = 3600000;


    explicit PinGuard(const PinRecord& rec = PinRecord{});

    bool set_pin(const char* pin, size_t len, const uint8_t (&salt)[kSaltLen]);

    PinResult check(const char* pin, size_t len, uint32_t now_ms);

    const PinRecord& record() const;


private:

    PinRecord _rec;

    uint32_t _failures = 0;

    uint32_t _lockouts = 0;

    bool _locked = false;

    uint32_t _lock_start_ms = 0;

    uint32_t _lock_len_ms = 0;

};


} // namespace prov

prov::PinGuard
Guards the PIN. The 5th consecutive wrong PIN starts a lockout of min(60 s * 2^k, 3600 s),...
Definition pin_guard.h:24

prov::PinGuard::check
PinResult check(const char *pin, size_t len, uint32_t now_ms)
Checks a PIN. While locked out nothing is evaluated. Wrap-safe in now_ms.
Definition pin_guard.cpp:57

prov::PinGuard::set_pin
bool set_pin(const char *pin, size_t len, const uint8_t(&salt)[kSaltLen])
Stores hash = sha256(salt || pin). False (nothing changed) if the PIN is not 4-8 digits.
Definition pin_guard.cpp:39

nvs_blob::ReadStatus::Ok
@ Ok
out holds exactly the stored bytes

prov_types.h
Plain value types shared by the WiFi provisioning logic (pure C++20, no heap).

prov::PinRecord
Salted PIN hash as stored in NVS.
Definition prov_types.h:38

prov::PinResult
Definition pin_guard.h:14