Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
gnutls_session_ext_register(3)	    gnutls	gnutls_session_ext_register(3)

NAME
       gnutls_session_ext_register - API function

SYNOPSIS
       #include	<gnutls/gnutls.h>

       int  gnutls_session_ext_register(gnutls_session_t session, const	char *
       name, int id, gnutls_ext_parse_type_t parse_point, gnutls_ext_recv_func
       recv_func,  gnutls_ext_send_func	send_func, gnutls_ext_deinit_data_func
       deinit_func, gnutls_ext_pack_func pack_func, gnutls_ext_unpack_func un-
       pack_func, unsigned flags);

ARGUMENTS
       gnutls_session_t	session
		   the session for which this extension	will be	set

       const char * name
		   the name of the extension to	register

       int id	   the numeric id of the extension

       gnutls_ext_parse_type_t parse_point
		   the	   parse     type     of     the     extension	  (see
		   gnutls_ext_parse_type_t)

       gnutls_ext_recv_func recv_func
		   a function to receive the data

       gnutls_ext_send_func send_func
		   a function to send the data

       gnutls_ext_deinit_data_func deinit_func
		   a function deinitialize any private data

       gnutls_ext_pack_func pack_func
		   a function which serializes the  extension's	 private  data
		   (used on session packing for	resumption)

       gnutls_ext_unpack_func unpack_func
		   a  function	which will deserialize the extension's private
		   data

       unsigned	flags
		   must	be zero	or flags from gnutls_ext_flags_t

DESCRIPTION
       This function will register a new extension type. The extension will be
       only usable within the registered session. If the extension type	is al-
       ready registered	then GNUTLS_E_ALREADY_REGISTERED will be returned, un-
       less  the flag GNUTLS_EXT_FLAG_OVERRIDE_INTERNAL	is specified. The lat-
       ter flag	when specified can be used to override certain extensions  in-
       troduced	 after	3.6.0. It is expected to be used by applications which
       handle custom extensions	that are not currently	supported  in  GnuTLS,
       but direct support for them may be added	in the future.

       Each registered extension can store temporary data into the gnutls_ses-
       sion_t structure	using gnutls_ext_set_data(), and they can be retrieved
       using gnutls_ext_get_data().

       The  validity of	the extension registered can be	given by the appropri-
       ate flags of gnutls_ext_flags_t.	If no validity is given, then the reg-
       istered	extension will be valid	for client and TLS1.2 server hello (or
       encrypted extensions for	TLS1.3).

RETURNS
       GNUTLS_E_SUCCESS	on success, otherwise a	negative error code.

SINCE
       3.5.5

REPORTING BUGS
       Report bugs to <bugs@gnutls.org>.
       Home page: https://www.gnutls.org

COPYRIGHT
       Copyright (C) 2001- 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 no-
       tice and	this notice are	preserved.

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

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

gnutls				    3.6.15	gnutls_session_ext_register(3)

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURNS | SINCE | REPORTING BUGS | COPYRIGHT | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=gnutls_session_ext_register&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help