man7.org > Linux > man-pages

Linux/UNIX system programming training

gnutls_certificate_get_x509_key(3) — Linux manual page

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

gnutls_certif...e_get_x509_key(3) gnutlsgnutls_certif...e_get_x509_key(3)

NAME         top

       gnutls_certificate_get_x509_key - API function

SYNOPSIS         top

       #include <gnutls/gnutls.h>

       int
       gnutls_certificate_get_x509_key(gnutls_certificate_credentials_t
       res, unsigned index, gnutls_x509_privkey_t * key);

ARGUMENTS         top

       gnutls_certificate_credentials_t res
                   is a gnutls_certificate_credentials_t type.

       unsigned index
                   The index of the key to obtain.

       gnutls_x509_privkey_t * key
                   Location to store the key.

DESCRIPTION         top

       Obtains a X.509 private key that has been stored in  res with one
       of gnutls_certificate_set_x509_key(),
       gnutls_certificate_set_key(),
       gnutls_certificate_set_x509_key_file(),
       gnutls_certificate_set_x509_key_file2(),
       gnutls_certificate_set_x509_key_mem(), or
       gnutls_certificate_set_x509_key_mem2(). The returned key must be
       deallocated with gnutls_x509_privkey_deinit() when no longer
       needed.

       The  index matches the return value of
       gnutls_certificate_set_x509_key() and friends functions, when the
       GNUTLS_CERTIFICATE_API_V2 flag is set.

       If there is no key with the given index,
       GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE is returned. If the key with
       the given index is not a X.509 key, GNUTLS_E_INVALID_REQUEST is
       returned.

RETURNS         top

       GNUTLS_E_SUCCESS (0) on success, or a negative error code.

SINCE         top

       3.4.0

REPORTING BUGS         top

       Report bugs to <[email protected]>.
       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 [email protected].  This page was obtained
       from the tarball fetched from
       ⟨https://www.gnupg.org/ftp/gcrypt/gnutls/⟩ on 2025-08-11.  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 [email protected]

gnutls                            3.8.10gnutls_certif...e_get_x509_key(3)

HTML rendering created 2025-09-06 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