---
name: "gnutls_certificate_get_x509_key"
section: "3"
platform: "linux"
package: "gnutls"
version: "3.8.13-3"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/gnutls_certificate_get_x509_key"
---

# gnutls\_certificate\_get\_x509\_key(3)

API function

## NAME

gnutls\_certificate\_get\_x509\_key - API function

## SYNOPSIS

**#include \<gnutls/gnutls.h\>**

**int gnutls\_certificate\_get\_x509\_key(gnutls\_certificate\_credentials\_t** *res***, unsigned** *index***, gnutls\_x509\_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\_x509\_privkey\_t \* key

  Location to store the key.

## DESCRIPTION

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

**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: https://www.gnutls.org

## COPYRIGHT

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

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/