GNUTLS_SRP_SET_CLIENT_CREDENTIALS(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_srp_set_client_credentials — it's giving "log me in, bestie" ✨

okay so this is a page from the gnutls manual (yes, that gnutls, the TLS library, she's iconic) and today we're talking about one very specific little function that sets up your SRP client creds. strap in 🎀

🌸 NAME 🌸

gnutls_srp_set_client_credentials — literally just an API function, that's it, that's the whole name 💅

🦋 SYNOPSIS 🦋

#include <gnutls/gnutls.h>

int gnutls_srp_set_client_credentials(gnutls_srp_client_credentials_t
res, const char * username, const char * password);
not me noticing the line break in the middle of the parameter list — that's just how the manpage wraps it, keep it exactly like that, no cap 😭

🍓 ARGUMENTS 🍓

  • gnutls_srp_client_credentials_t res — this is a gnutls_srp_client_credentials_t type. yes bestie, the type is named in the description of the type, we love a self-referential moment 🙈
  • const char * username — it's the user's userid 👑
  • const char * password — it's the user's password 🔒 (do NOT leak it, periodt)

💜 DESCRIPTION 💜

so this function sets the username and password, inside a gnutls_srp_client_credentials_t type. those two things are gonna be used in SRP authentication, so like, they matter fr fr ✨

about username: it should be an ASCII string or a UTF-8 string. and if it is a UTF-8 string, it's recommended to follow the PRECIS framework for usernames (that's rfc8265, go read it, it's giving "standards girlie" 📚).

about the password: it can be in ASCII format, or normalized using gnutls_utf8_password_normalize(). pick your fighter 💅

⭐ RETURNS ⭐

on success you get GNUTLS_E_SUCCESS (which is 0) returned to you, like a little gift 🎁 — or, alternatively, an error code. that's it. that's the whole return story.

😭 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. slay, honestly 🫶

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

ok final vibe check: don't guess at behaviour, don't invent options, just set your username and password and let SRP do its thing 💖

and that's the whole page bestie, brought to you by gnutls 3.8.13 — mwah, catch you on the next manpage 🧚✨💅

📦 where this page comes from