gnutls_server_name_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_server_name_get(3) 💖

okay bestie, welcome to the gnutls manual, page gnutls_server_name_get(3). this one's a lil baddie that lets you peek at the server name a client sent you. let's get into it 🫶

✨ NAME ✨

gnutls_server_name_get — an API function, and honestly? a whole vibe.

🌸 SYNOPSIS 🌸

#include <gnutls/gnutls.h>

int gnutls_server_name_get(gnutls_session_t session, void * data, size_t
      * data_length, unsigned int * type, unsigned int indx);

🎀 ARGUMENTS 🎀

  • gnutls_session_t session — it's a gnutls_session_t type. that's the session, your main character.
  • void * data — this is gonna hold the data. the goods. the tea. ✨
  • size_t * data_length — will hold the data length. heads up: it must hold the maximum size of data when you pass it in.
  • unsigned int * type — will hold the server name indicator type.
  • unsigned int indx — the index of the server_name. like, which one you want.

🦋 DESCRIPTION 🦋

so this function lets you get the name indication (if there even is one, no cap) that a client has sent. and that name indication can be any of the enumeration gnutls_server_name_type_t. slay.

if type is GNUTLS_NAME_DNS, then this function is meant to be used by servers that support virtual hosting, and the data you get back will be a null terminated IDNA ACE string. important lore: prior to GnuTLS 3.4.0 it was a UTF-8 string instead. so if you're on ancient GnuTLS, adjust accordingly, bestie.

if data doesn't have enough size to hold the server name, you get GNUTLS_E_SHORT_MEMORY_BUFFER back, and data_length will hold the required size. so like, it tells you how much room to give it next time. iconic of it, honestly. 💅

indx is how you retrieve more than one server name, in case the client sent several. the first server name has an index of 0, the second 1, and so on and so forth. and if no name with the given index exists, you get GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE returned. 😭

⭐ RETURNS ⭐

on success, GNUTLS_E_SUCCESS (0) is returned. if there's a UTF-8 decoding error, GNUTLS_E_IDNA_ERROR is returned. otherwise, you get a negative error code. that's it, that's the vibe check.

🙈 REPORTING BUGS 🙈

found a bug? don't be shy, report it to <bugs@gnutls.org>.

home page: https://www.gnutls.org

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. periodt. 💅

🌈 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, go visit:

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

okay that's the whole page bestie, you ate it 🍓💜 this was gnutls version 3.8.13, page gnutls_server_name_get(3), and yeah the date lives in that footer too — consider yourself fully caught up. go forth and read those server names. ✨🧚

📦 where this page comes from