NAME

       gnutls_certificate_get_openpgp_key - API function

SYNOPSIS

       #include <gnutls/openpgp.h>

       int     gnutls_certificate_get_openpgp_key(gnutls_certificate_credentials_t    res,    unsigned    index,
       gnutls_openpgp_privkey_t * key);

ARGUMENTS

       gnutls_certificate_credentials_t res
                   is a gnutls_certificate_credentials_t type.

       unsigned index
                   The index of the key to obtain.

       gnutls_openpgp_privkey_t * key
                   Location to store the key.

DESCRIPTION

       Obtains   a   OpenPGP   private   key    that    has    been    stored    in     res    with    one    of
       gnutls_certificate_set_openpgp_key(),                          gnutls_certificate_set_openpgp_key_file(),
       gnutls_certificate_set_openpgp_key_file2(),         gnutls_certificate_set_openpgp_key_mem(),          or
       gnutls_certificate_set_openpgp_key_mem2().     The    returned    key    must    be    deallocated   with
       gnutls_openpgp_privkey_deinit() when no longer needed.

       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

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

SINCE

       3.4.0

REPORTING BUGS

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

COPYRIGHT

       Copyright © 2001-2021 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

       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/