FIDO_BIO_ENROLL_NEW(3)

💖 FIDO_BIO_ENROLL_NEW 💖 — like, the FIDO2 biometric enrollment API, bestie

okay so this is fido_bio_enroll_new and friends, straight out of the Library Functions Manual, section 3. yes, we're doing C library lore today and honestly? iconic. 🫶

✨ NAME ✨

fido_bio_enroll_new, fido_bio_enroll_free, fido_bio_enroll_last_status, fido_bio_enroll_remaining_samples — FIDO2 biometric enrollment API 🌸

🎀 SYNOPSIS 🎀

#include <fido.h>
#include <fido/bio.h>

#define FIDO_BIO_ENROLL_FP_GOOD                         0x00
#define FIDO_BIO_ENROLL_FP_TOO_HIGH                     0x01
#define FIDO_BIO_ENROLL_FP_TOO_LOW                      0x02
#define FIDO_BIO_ENROLL_FP_TOO_LEFT                     0x03
#define FIDO_BIO_ENROLL_FP_TOO_RIGHT                    0x04
#define FIDO_BIO_ENROLL_FP_TOO_FAST                     0x05
#define FIDO_BIO_ENROLL_FP_TOO_SLOW                     0x06
#define FIDO_BIO_ENROLL_FP_POOR_QUALITY                 0x07
#define FIDO_BIO_ENROLL_FP_TOO_SKEWED                   0x08
#define FIDO_BIO_ENROLL_FP_TOO_SHORT                    0x09
#define FIDO_BIO_ENROLL_FP_MERGE_FAILURE                0x0a
#define FIDO_BIO_ENROLL_FP_EXISTS                       0x0b
#define FIDO_BIO_ENROLL_FP_DATABASE_FULL                0x0c
#define FIDO_BIO_ENROLL_NO_USER_ACTIVITY                0x0d
#define FIDO_BIO_ENROLL_NO_USER_PRESENCE_TRANSITION     0x0e

fido_bio_enroll_t *
fido_bio_enroll_new(void);

void
fido_bio_enroll_free(fido_bio_enroll_t **enroll_p);

uint8_t
fido_bio_enroll_last_status(const fido_bio_enroll_t *enroll);

uint8_t
fido_bio_enroll_remaining_samples(const fido_bio_enroll_t *enroll);

🦋 DESCRIPTION 🦋

so like, an ongoing FIDO2 biometric enrollment? in libfido2 it gets abstracted into the fido_bio_enroll_t type. that's the whole vibe. 💅

the functions on this page let you allocate, deallocate, and inspect a fido_bio_enroll_t type. periodt.

and if you wanna do actual device operations on a fido_bio_enroll_t, bestie, that's a different page — go look at fido_bio_dev_get_info(3). iykyk. 👑

🌟 fido_bio_enroll_new() 🌟

returns a pointer to a newly allocated, empty fido_bio_enroll_t type. fresh out the box, no cap. ✨

but if memory cannot be allocated? NULL is returned. that's it. that's the deal. 💀

🌈 fido_bio_enroll_free() 🌈

releases the memory backing *enroll_p, and *enroll_p must have been previously allocated by fido_bio_enroll_new(). like, don't just hand it a random pointer, babe, that's not the move. 🙈

on return, *enroll_p is set to NULL. tidy. clean. we love a responsible cleanup moment. 🧚

and plot twist: either enroll_p or *enroll_p may be NULL, in which case fido_bio_enroll_free() is a NOP. literally nothing happens. it's giving "no thoughts, head empty," and honestly, valid. 🍓

⭐ fido_bio_enroll_last_status() ⭐

returns the enrollment status of enroll. that's the tea. 🔥

💜 fido_bio_enroll_remaining_samples() 💜

returns the number of samples left</> for enroll to complete. like a countdown but for your fingertip. 🌸

👀 SEE ALSO 👀

• fido_bio_dev_get_info(3)
• fido_bio_template(3)

go read those too, bestie, they're part of the lore. 🫶

mwah 💋 that's the page!! this one came from Debian, dated September 13, 2019, and yes the header/footer both say FIDO_BIO_ENROLL_NEW(3) because we keep it consistent in this house. slay, stay safe, and always free your pointers. ✨💖