man7.org > Linux > man-pages

Linux/UNIX system programming training

gnutls_privkey_generate(3) — Linux manual page

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

gnutls_privkey_generate(3)       gnutls       gnutls_privkey_generate(3)

NAME         top

       gnutls_privkey_generate - API function

SYNOPSIS         top

       #include <gnutls/abstract.h>

       int gnutls_privkey_generate(gnutls_privkey_t pkey,
       gnutls_pk_algorithm_t algo, unsigned int bits, unsigned int
       flags);

ARGUMENTS         top

       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         top

       This function will generate a random private key. Note that this
       function must be called on an initialized private key.

       The flag GNUTLS_PRIVKEY_FLAG_PROVABLE instructs the key
       generation process to use algorithms like Shawe-Taylor (from FIPS
       PUB186-4) which generate provable parameters out of a seed for
       RSA and DSA keys. See gnutls_privkey_generate2() for more
       information.

       Note that when generating an elliptic curve key, the curve can be
       substituted 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 .

       See also gnutls_privkey_generate2().

RETURNS         top

       On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a
       negative error value.

SINCE         top

       3.3.0

REPORTING BUGS         top

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

COPYRIGHT         top

       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.

SEE ALSO         top

       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

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

COLOPHON         top

       This page is part of the GnuTLS (GnuTLS Transport Layer Security
       Library) project.  Information about the project can be found at
       ⟨http://www.gnutls.org/⟩.  If you have a bug report for this
       manual page, send it to bugs@gnutls.org.  This page was obtained
       from the tarball gnutls-3.8.5.tar.xz fetched from
       ⟨http://www.gnutls.org/download.html⟩ on 2024-06-14.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to man-pages@man7.org

gnutls                            3.8.5       gnutls_privkey_generate(3)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI