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

FreeBSD Manual Pages

  
 
  

home | help
gnutls_hpke_export(3)		    gnutls		 gnutls_hpke_export(3)

NAME
       gnutls_hpke_export - API	function

SYNOPSIS
       #include	<gnutls/hpke.h>

       int  gnutls_hpke_export(gnutls_hpke_context_t ctx, const	gnutls_datum_t
       * exporter_context, size_t length, gnutls_datum_t * secret);

ARGUMENTS
       gnutls_hpke_context_t ctx
		   The HPKE context to use for exporting the secret.

       const gnutls_datum_t * exporter_context
		   The application-specific context to be included in the  ex-
		   port.

       size_t length
		   The requested length	in bytes of the	secret to be exported.

       gnutls_datum_t *	secret
		   A  pointer to a gnutls_datum_t structure where the exported
		   secret will be stored.

DESCRIPTION
       This function performs the export operation of HPKE. It derives	a  se-
       cret of	length bytes from the exporter secret in the HPKE context, us-
       ing  the	provided application-specific context and the KDF specified in
       the context. The	resulting secret is stored in
	secret . The function checks that the provided	parameters  are	 valid
       and  that  the context is properly initialized and that there is	an ex-
       porter secret available in the context.

	length should be a positive integer that does not exceed  the  maximum
       allowed size for	HPKE exports.

       The  function  will allocate memory for	secret , and the caller	is re-
       sponsible for freeing this memory using gnutls_free()  when  it	is  no
       longer needed.

RETURNS
       0 on success, or	a negative error code on failure

SINCE
       3.8.13

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

COPYRIGHT
       Copyright (C) 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  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.8.13		 gnutls_hpke_export(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=gnutls_hpke_export&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help