gnutls_x509_key_purpose_get(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_key_purpose_get(3) 💖

okay bestie, welcome to the gnutls manual — yes, the whole thing, and yes, we're doing this one together. this page is about gnutls_x509_key_purpose_get, an API function, and it's lowkey one of the cutest little getters in the x509 extended world. let's go 🦋

✨ NAME ✨

gnutls_x509_key_purpose_get — API function

(it gets a key purpose. that's the whole vibe. main character of exactly one job 👑)

🌸 SYNOPSIS 🌸

#include <gnutls/x509-ext.h>

int gnutls_x509_key_purpose_get(gnutls_x509_key_purposes_t p, unsigned
       idx, gnutls_datum_t * oid);

like, there it is. the whole thing. no cap. ✨

🎀 ARGUMENTS 🎀

  • gnutls_x509_key_purposes_t p — the key purposes, bestie. the whole lil collection you're digging through. 🍓
  • unsigned idx — the index of the key purpose you wanna retrieve. yes, you gotta know which one you want, it's not gonna read your mind. 🙈
  • gnutls_datum_t * oid — will hold the object identifier of the key purpose. and listen — it's to be treated as constant, so don't you dare go modifying it, okay? look respectfully. 💅

💜 DESCRIPTION 💜

so this function will retrieve the specified-by-the-index key purpose inside the purposes type. literally: you hand it p and idx, it hands you back the oid for that one.

and the object identifier? it'll be a null terminated string. iconic behavior, honestly. 🌈

⭐ RETURNS ⭐

  • on success, GNUTLS_E_SUCCESS (0) is returned — slay, everything worked 🎉
  • GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE if the index is out of bounds — i.e. you asked for a key purpose that simply does not exist, bestie, and that's a you problem 😭
  • otherwise a negative error value — yeah. something went sideways. 💀

🦋 SINCE 🦋

3.3.0 — so this has been around a while, it's a seasoned queen 👑

🧚 REPORTING BUGS 🧚

found a bug? don't suffer in silence, tell the 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.

(translation: share it, remix it, just keep the receipt. 🫶)

🌟 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/

okay that's the whole page, and honestly? she ate. 💅✨ this was the gnutls manual, version 3.8.13, dated with the gnutls_x509_key_purpose_get(3) page itself — so if you need me, i'll be right here in /usr/share/doc/gnutls/. bye bestie, go read your oids responsibly 🎀🦋💖

📦 where this page comes from