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

FreeBSD Manual Pages

  
 
  

home | help
gnutls_privkey_generate(3)	    gnutls	    gnutls_privkey_generate(3)

NAME
       gnutls_privkey_generate - API function

SYNOPSIS
       #include	<gnutls/abstract.h>

       int   gnutls_privkey_generate(gnutls_privkey_t	pkey,  gnutls_pk_algo-
       rithm_t algo, unsigned int bits,	unsigned int flags);

ARGUMENTS
       gnutls_privkey_t	pkey
		   An initialized private key

       gnutls_pk_algorithm_t algo
		   is one of the algorithms in gnutls_pk_algorithm_t.

       unsigned	int bits
		   the size of the parameters to generate

       unsigned	int flags
		   Must	be zero	or flags from gnutls_privkey_flags_t.

DESCRIPTION
       This function will generate a random private key. Note that this	 func-
       tion   must   be	  called   on	an   empty   private   key.  The  flag
       GNUTLS_PRIVKEY_FLAG_PROVABLE instructs the key  generation  process  to
       use algorithms which generate provable parameters out of	a seed.

       Note  that when generating an elliptic curve key, the curve can be sub-
       stituted	  in   the   place   of	  the	bits   parameter   using   the
       GNUTLS_CURVE_TO_BITS()  macro. The input	to the macro is	any curve from
       gnutls_ecc_curve_t.

       For DSA keys, if	the subgroup size needs	 to  be	 specified  check  the
       GNUTLS_SUBGROUP_TO_BITS() macro.

       It  is  recommended  to	do  not	 set the number	of  bits directly, use
       gnutls_sec_param_to_pk_bits() instead .

RETURNS
       On success, GNUTLS_E_SUCCESS (0)	is returned, otherwise a negative  er-
       ror value.

SINCE
       3.3.0

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

COPYRIGHT
       Copyright (C) 2001-2017 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/share/doc/gnutls/ directory does not	contain	the HTML  form
       visit

       http://www.gnutls.org/manual/

gnutls				    3.5.12	    gnutls_privkey_generate(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_privkey_generate&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help