GNUTLS_X509_PRIVKEY_SET_PIN_FUNCTION(3)

📦
version 3.8.13 · 7 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, fedora 43, fedora 44, ubuntu stonking

✨ gnutls_x509_privkey_set_pin_function(3) ✨

okay bestie, welcome to the gnutls manual, and today's episode is about one very specific little function. it's an API function, it lives in gnutls, and it's about to be your new bestie if you've ever needed to hand a PIN over to something that really wants a PIN. 💅

🌸 NAME 🌸

gnutls_x509_privkey_set_pin_function — an API function, no cap

🎀 SYNOPSIS 🎀

#include <gnutls/x509.h>

void gnutls_x509_privkey_set_pin_function(gnutls_x509_privkey_t privkey,
gnutls_pin_callback_t fn, void * userdata);

💖 ARGUMENTS 💖

  • gnutls_x509_privkey_t privkey — the certificate structure 🫶 like, this is the thing you're attaching your callback to.
  • gnutls_pin_callback_t fn — the callback ✨ the actual function that's gonna get called.
  • void * userdata — data associated with the callback 🌈 it rides along with fn, so whatever you need to hand it, this is where it goes.

🦋 DESCRIPTION 🦋

so here's the tea, bestie: this function will set a callback function to be used when it is required to access a protected object. that's the whole vibe. 🔐

and the important part — this function overrides the global function set using gnutls_pkcs11_set_pin_function(). so if you've already set a global one and then you set this one, this one wins. local beats global, main character energy, periodt. 👑

also note, and this is key: this callback is used when decrypting a key. 🔑 that's its moment, that's its whole thing.

⭐ SINCE ⭐

3.4.0 — she's been around for a while, iconic behavior.

😭 REPORTING BUGS 😭

found a bug? don't suffer in silence, tell the gnutls people:

Copyright © 2001-2023 Free Software Foundation, Inc., and others.

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. 💜

🌈 SEE ALSO 🌈

The full documentation for gnutls is maintained as a Texinfo manual. If the /usr/share/doc/gnutls/ directory does not contain the HTML form, visit:

https://www.gnutls.org/manual/

and that's the whole page, bestie!! 🎀✨ this was gnutls, version 3.8.13, and honestly? she ate. go set that callback. 🫶💅

📦 where this page comes from