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

FreeBSD Manual Pages

  
 
  

home | help
gnutls_hpke_init(3)		    gnutls		   gnutls_hpke_init(3)

NAME
       gnutls_hpke_init	- API function

SYNOPSIS
       #include	<gnutls/hpke.h>

       int  gnutls_hpke_init(gnutls_hpke_context_t  *  ctx, gnutls_hpke_mode_t
       mode, gnutls_hpke_role_t	role, gnutls_hpke_kem_t	kem, gnutls_hpke_kdf_t
       kdf, gnutls_hpke_aead_t aead);

ARGUMENTS
       gnutls_hpke_context_t * ctx
		   A pointer to	the HPKE context to initialize.

       gnutls_hpke_mode_t mode
		   The HPKE mode to use	(Base, PSK, Auth, or AuthPSK).

       gnutls_hpke_role_t role
		   The role of the context (Sender or Receiver).

       gnutls_hpke_kem_t kem
		   The KEM algorithm to	use (e.g., DHKEM(X25519)).

       gnutls_hpke_kdf_t kdf
		   The KDF algorithm to	use (e.g., HKDF-SHA256).

       gnutls_hpke_aead_t aead
		   The AEAD algorithm to use (e.g., AES-128-GCM).

DESCRIPTION
       This function initializes the HPKE context with the  specified  parame-
       ters.   It allocates memory for the context and sets the	initial	values
       for the fields based on the provided parameters.

       The context must	be deinitialized using gnutls_hpke_deinit() when it is
       no longer needed	to free	any allocated  resources  and  securely	 erase
       sensitive information.

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_init(3)

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

home | help