gnutls_privkey_sign_func ()

int
(*gnutls_privkey_sign_func) (gnutls_privkey_t key,
                             void *userdata,
                             const gnutls_datum_t *raw_data,
                             gnutls_datum_t *signature);

gnutls_privkey_decrypt_func ()

int
(*gnutls_privkey_decrypt_func) (gnutls_privkey_t key,
                                void *userdata,
                                const gnutls_datum_t *ciphertext,
                                gnutls_datum_t *plaintext);

gnutls_privkey_decrypt_func2 ()

int
(*gnutls_privkey_decrypt_func2) (gnutls_privkey_t key,
                                 void *userdata,
                                 const gnutls_datum_t *ciphertext,
                                 unsigned char *plaintext,
                                 size_t plaintext_size);

gnutls_privkey_sign_hash_func ()

int
(*gnutls_privkey_sign_hash_func) (gnutls_privkey_t key,
                                  gnutls_sign_algorithm_t algo,
                                  void *userdata,
                                  unsigned int flags,
                                  const gnutls_datum_t *hash,
                                  gnutls_datum_t *signature);

gnutls_privkey_sign_data_func ()

int
(*gnutls_privkey_sign_data_func) (gnutls_privkey_t key,
                                  gnutls_sign_algorithm_t algo,
                                  void *userdata,
                                  unsigned int flags,
                                  const gnutls_datum_t *data,
                                  gnutls_datum_t *signature);

gnutls_privkey_deinit_func ()

void
(*gnutls_privkey_deinit_func) (gnutls_privkey_t key,
                               void *userdata);

GNUTLS_SIGN_ALGO_TO_FLAGS()

#define GNUTLS_SIGN_ALGO_TO_FLAGS(sig) (unsigned int)((sig) << 20)

GNUTLS_FLAGS_TO_SIGN_ALGO()

#define GNUTLS_FLAGS_TO_SIGN_ALGO(flags) (unsigned int)((flags) >> 20)

gnutls_privkey_info_func ()

int
(*gnutls_privkey_info_func) (gnutls_privkey_t key,
                             unsigned int flags,
                             void *userdata);

gnutls_pubkey_init ()

int
gnutls_pubkey_init (gnutls_pubkey_t *key);

This function will initialize a public key.

Since: 2.12.0

gnutls_pubkey_deinit ()

void
gnutls_pubkey_deinit (gnutls_pubkey_t key);

This function will deinitialize a public key structure.

Since: 2.12.0

gnutls_pubkey_verify_params ()

int
gnutls_pubkey_verify_params (gnutls_pubkey_t key);

This function will verify the public key parameters.

Since: 3.3.0

gnutls_pubkey_set_pin_function ()

void
gnutls_pubkey_set_pin_function (gnutls_pubkey_t key,
                                gnutls_pin_callback_t fn,
                                void *userdata);

This function will set a callback function to be used when required to access the object. This function overrides any other global PIN functions.

Note that this function must be called right after initialization to have effect.

Since: 3.1.0

gnutls_pubkey_get_pk_algorithm ()

int
gnutls_pubkey_get_pk_algorithm (gnutls_pubkey_t key,
                                unsigned int *bits);

This function will return the public key algorithm of a public key and if possible will return a number of bits that indicates the security parameter of the key.

Since: 2.12.0

gnutls_pubkey_set_spki ()

int
gnutls_pubkey_set_spki (gnutls_pubkey_t key,
                        const gnutls_x509_spki_t spki,
                        unsigned int flags);

This function will set the public key information. The provided spki must be initialized.

Since: 3.6.0

gnutls_pubkey_get_spki ()

int
gnutls_pubkey_get_spki (gnutls_pubkey_t key,
                        const gnutls_x509_spki_t spki,
                        unsigned int flags);

This function will return the public key information if available. The provided spki must be initialized.

Since: 3.6.0

gnutls_pubkey_import_x509 ()

int
gnutls_pubkey_import_x509 (gnutls_pubkey_t key,
                           gnutls_x509_crt_t crt,
                           unsigned int flags);

This function will import the given public key to the abstract gnutls_pubkey_t type.

Since: 2.12.0

gnutls_pubkey_import_x509_crq ()

int
gnutls_pubkey_import_x509_crq (gnutls_pubkey_t key,
                               gnutls_x509_crq_t crq,
                               unsigned int flags);

This function will import the given public key to the abstract gnutls_pubkey_t type.

Since: 3.1.5

gnutls_pubkey_import_pkcs11 ()

int
gnutls_pubkey_import_pkcs11 (gnutls_pubkey_t key,
                             gnutls_pkcs11_obj_t obj,
                             unsigned int flags);

Imports a public key from a pkcs11 key. This function will import the given public key to the abstract gnutls_pubkey_t type.

Since: 2.12.0

gnutls_pubkey_import_openpgp ()

int
gnutls_pubkey_import_openpgp (gnutls_pubkey_t key,
                              gnutls_openpgp_crt_t crt,
                              unsigned int flags);

This function is no-op.

Since: 2.12.0

gnutls_pubkey_import_openpgp_raw ()

int
gnutls_pubkey_import_openpgp_raw (gnutls_pubkey_t pkey,
                                  const gnutls_datum_t *data,
                                  gnutls_openpgp_crt_fmt_t format,
                                  const gnutls_openpgp_keyid_t keyid,
                                  unsigned int flags);

This function is no-op.

Since: 3.1.3

gnutls_pubkey_import_x509_raw ()

int
gnutls_pubkey_import_x509_raw (gnutls_pubkey_t pkey,
                               const gnutls_datum_t *data,
                               gnutls_x509_crt_fmt_t format,
                               unsigned int flags);

This function will import the given public key to the abstract gnutls_pubkey_t type.

Since: 3.1.3

gnutls_pubkey_import_privkey ()

int
gnutls_pubkey_import_privkey (gnutls_pubkey_t key,
                              gnutls_privkey_t pkey,
                              unsigned int usage,
                              unsigned int flags);

Imports the public key from a private. This function will import the given public key to the abstract gnutls_pubkey_t type.

Note that in certain keys this operation may not be possible, e.g., in other than RSA PKCS11 keys.

Since: 2.12.0

gnutls_pubkey_import_tpm_url ()

int
gnutls_pubkey_import_tpm_url (gnutls_pubkey_t pkey,
                              const char *url,
                              const char *srk_password,
                              unsigned int flags);

This function will import the given private key to the abstract gnutls_privkey_t type.

Note that unless GNUTLS_PUBKEY_DISABLE_CALLBACKS is specified, if incorrect (or NULL) passwords are given the PKCS11 callback functions will be used to obtain the correct passwords. Otherwise if the SRK password is wrong GNUTLS_E_TPM_SRK_PASSWORD_ERROR is returned.

Since: 3.1.0

gnutls_pubkey_import_url ()

int
gnutls_pubkey_import_url (gnutls_pubkey_t key,
                          const char *url,
                          unsigned int flags);

This function will import a public key from the provided URL.

Since: 3.1.0

gnutls_pubkey_import_tpm_raw ()

int
gnutls_pubkey_import_tpm_raw (gnutls_pubkey_t pkey,
                              const gnutls_datum_t *fdata,
                              gnutls_tpmkey_fmt_t format,
                              const char *srk_password,
                              unsigned int flags);

This function will import the public key from the provided TPM key structure.

With respect to passwords the same as in gnutls_pubkey_import_tpm_url() apply.

Since: 3.1.0

gnutls_pubkey_get_preferred_hash_algorithm ()

int
gnutls_pubkey_get_preferred_hash_algorithm
                               (gnutls_pubkey_t key,
                                gnutls_digest_algorithm_t *hash,
                                unsigned int *mand);

This function will read the certificate and return the appropriate digest algorithm to use for signing with this certificate. Some certificates (i.e. DSA might not be able to sign without the preferred algorithm).

To get the signature algorithm instead of just the hash use gnutls_pk_to_sign() with the algorithm of the certificate/key and the provided hash .

Since: 2.12.0

gnutls_pubkey_export_rsa_raw ()

int
gnutls_pubkey_export_rsa_raw (gnutls_pubkey_t key,
                              gnutls_datum_t *m,
                              gnutls_datum_t *e);

This function will export the RSA public key's parameters found in the given structure. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

This function allows for NULL parameters since 3.4.1.

Since: 3.3.0

gnutls_pubkey_export_rsa_raw2 ()

int
gnutls_pubkey_export_rsa_raw2 (gnutls_pubkey_t key,
                               gnutls_datum_t *m,
                               gnutls_datum_t *e,
                               unsigned  flags);

This function will export the RSA public key's parameters found in the given structure. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

This function allows for NULL parameters since 3.4.1.

Since: 3.6.0

gnutls_pubkey_export_dsa_raw ()

int
gnutls_pubkey_export_dsa_raw (gnutls_pubkey_t key,
                              gnutls_datum_t *p,
                              gnutls_datum_t *q,
                              gnutls_datum_t *g,
                              gnutls_datum_t *y);

This function will export the DSA public key's parameters found in the given certificate. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

This function allows for NULL parameters since 3.4.1.

Since: 3.3.0

gnutls_pubkey_export_dsa_raw2 ()

int
gnutls_pubkey_export_dsa_raw2 (gnutls_pubkey_t key,
                               gnutls_datum_t *p,
                               gnutls_datum_t *q,
                               gnutls_datum_t *g,
                               gnutls_datum_t *y,
                               unsigned  flags);

This function will export the DSA public key's parameters found in the given certificate. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

This function allows for NULL parameters since 3.4.1.

Since: 3.6.0

gnutls_pubkey_export_dh_raw ()

int
gnutls_pubkey_export_dh_raw (gnutls_pubkey_t key,
                             gnutls_dh_params_t params,
                             gnutls_datum_t *y,
                             unsigned  flags);

This function will export the Diffie-Hellman public key parameter found in the given public key. The new parameter will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

To retrieve other parameters common in both public key and private key, use gnutls_dh_params_export_raw().

This function allows for NULL parameters since 3.4.1.

Since: 3.8.2

gnutls_pubkey_export_ecc_raw2 ()

int
gnutls_pubkey_export_ecc_raw2 (gnutls_pubkey_t key,
                               gnutls_ecc_curve_t *curve,
                               gnutls_datum_t *x,
                               gnutls_datum_t *y,
                               unsigned  flags);

This function will export the ECC public key's parameters found in the given key. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

In EdDSA curves the y parameter will be NULL and the other parameters will be in the native format for the curve.

This function allows for NULL parameters since 3.4.1.

Since: 3.6.0

gnutls_pubkey_export_gost_raw2 ()

int
gnutls_pubkey_export_gost_raw2 (gnutls_pubkey_t key,
                                gnutls_ecc_curve_t *curve,
                                gnutls_digest_algorithm_t *digest,
                                gnutls_gost_paramset_t *paramset,
                                gnutls_datum_t *x,
                                gnutls_datum_t *y,
                                unsigned int flags);

This function will export the GOST public key's parameters found in the given key. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

Note: parameters will be stored with least significant byte first. On version 3.6.3 this was incorrectly returned in big-endian format.

Since: 3.6.3

gnutls_pubkey_export_ecc_raw ()

int
gnutls_pubkey_export_ecc_raw (gnutls_pubkey_t key,
                              gnutls_ecc_curve_t *curve,
                              gnutls_datum_t *x,
                              gnutls_datum_t *y);

This function will export the ECC public key's parameters found in the given key. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

In EdDSA curves the y parameter will be NULL and the other parameters will be in the native format for the curve.

This function allows for NULL parameters since 3.4.1.

Since: 3.0

gnutls_pubkey_export_ecc_x962 ()

int
gnutls_pubkey_export_ecc_x962 (gnutls_pubkey_t key,
                               gnutls_datum_t *parameters,
                               gnutls_datum_t *ecpoint);

This function will export the ECC public key's parameters found in the given certificate. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

Since: 3.3.0

gnutls_pubkey_export ()

int
gnutls_pubkey_export (gnutls_pubkey_t key,
                      gnutls_x509_crt_fmt_t format,
                      void *output_data,
                      size_t *output_data_size);

This function will export the public key to DER or PEM format. The contents of the exported data is the SubjectPublicKeyInfo X.509 structure.

If the buffer provided is not long enough to hold the output, then *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.

If the structure is PEM encoded, it will have a header of "BEGIN CERTIFICATE".

Since: 2.12.0

gnutls_pubkey_export2 ()

int
gnutls_pubkey_export2 (gnutls_pubkey_t key,
                       gnutls_x509_crt_fmt_t format,
                       gnutls_datum_t *out);

This function will export the public key to DER or PEM format. The contents of the exported data is the SubjectPublicKeyInfo X.509 structure.

The output buffer will be allocated using gnutls_malloc().

If the structure is PEM encoded, it will have a header of "BEGIN CERTIFICATE".

Since: 3.1.3

gnutls_pubkey_get_key_id ()

int
gnutls_pubkey_get_key_id (gnutls_pubkey_t key,
                          unsigned int flags,
                          unsigned char *output_data,
                          size_t *output_data_size);

This function will return a unique ID that depends on the public key parameters. This ID can be used in checking whether a certificate corresponds to the given public key.

If the buffer provided is not long enough to hold the output, then *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned. The output will normally be a SHA-1 hash output, which is 20 bytes.

Since: 2.12.0

gnutls_pubkey_get_openpgp_key_id ()

int
gnutls_pubkey_get_openpgp_key_id (gnutls_pubkey_t key,
                                  unsigned int flags,
                                  unsigned char *output_data,
                                  size_t *output_data_size,
                                  unsigned int *subkey);

gnutls_pubkey_get_key_usage ()

int
gnutls_pubkey_get_key_usage (gnutls_pubkey_t key,
                             unsigned int *usage);

This function will return the key usage of the public key.

Since: 2.12.0

gnutls_pubkey_set_key_usage ()

int
gnutls_pubkey_set_key_usage (gnutls_pubkey_t key,
                             unsigned int usage);

This function will set the key usage flags of the public key. This is only useful if the key is to be exported to a certificate or certificate request.

Since: 2.12.0

gnutls_pubkey_import ()

int
gnutls_pubkey_import (gnutls_pubkey_t key,
                      const gnutls_datum_t *data,
                      gnutls_x509_crt_fmt_t format);

This function will import the provided public key in a SubjectPublicKeyInfo X.509 structure to a native gnutls_pubkey_t type. The output will be stored in key . If the public key is PEM encoded it should have a header of "PUBLIC KEY".

Since: 2.12.0

gnutls_pubkey_import_pkcs11_url()

#define             gnutls_pubkey_import_pkcs11_url(key, url, flags)

This function will import a PKCS 11 certificate to a gnutls_pubkey_t structure.

Since: 2.12.0

gnutls_pubkey_import_dsa_raw ()

int
gnutls_pubkey_import_dsa_raw (gnutls_pubkey_t key,
                              const gnutls_datum_t *p,
                              const gnutls_datum_t *q,
                              const gnutls_datum_t *g,
                              const gnutls_datum_t *y);

This function will convert the given DSA raw parameters to the native gnutls_pubkey_t format. The output will be stored in key .

Since: 2.12.0

gnutls_pubkey_import_dh_raw ()

int
gnutls_pubkey_import_dh_raw (gnutls_pubkey_t key,
                             const gnutls_dh_params_t params,
                             const gnutls_datum_t *y);

This function will convert the given Diffie-Hellman raw parameters to the native gnutls_pubkey_t format. The output will be stored in key .

Since: 3.8.2

gnutls_pubkey_import_rsa_raw ()

int
gnutls_pubkey_import_rsa_raw (gnutls_pubkey_t key,
                              const gnutls_datum_t *m,
                              const gnutls_datum_t *e);

This function will replace the parameters in the given structure. The new parameters should be stored in the appropriate gnutls_datum.

Since: 2.12.0

gnutls_pubkey_import_ecc_x962 ()

int
gnutls_pubkey_import_ecc_x962 (gnutls_pubkey_t key,
                               const gnutls_datum_t *parameters,
                               const gnutls_datum_t *ecpoint);

This function will convert the given elliptic curve parameters to a gnutls_pubkey_t. The output will be stored in key .

Since: 3.0

gnutls_pubkey_import_ecc_raw ()

int
gnutls_pubkey_import_ecc_raw (gnutls_pubkey_t key,
                              gnutls_ecc_curve_t curve,
                              const gnutls_datum_t *x,
                              const gnutls_datum_t *y);

This function will convert the given elliptic curve parameters to a gnutls_pubkey_t. The output will be stored in key .

In EdDSA curves the y parameter should be NULL and the x parameter must be the value in the native format for the curve.

Since: 3.0

gnutls_pubkey_import_gost_raw ()

int
gnutls_pubkey_import_gost_raw (gnutls_pubkey_t key,
                               gnutls_ecc_curve_t curve,
                               gnutls_digest_algorithm_t digest,
                               gnutls_gost_paramset_t paramset,
                               const gnutls_datum_t *x,
                               const gnutls_datum_t *y);

This function will convert the given GOST public key's parameters to a gnutls_pubkey_t. The output will be stored in key . digest should be one of GNUTLS_DIG_GOSR_94, GNUTLS_DIG_STREEBOG_256 or GNUTLS_DIG_STREEBOG_512. If paramset is set to GNUTLS_GOST_PARAMSET_UNKNOWN default one will be selected depending on digest .

Note: parameters should be stored with least significant byte first. On version 3.6.3 big-endian format was used incorrectly.

Since: 3.6.3

gnutls_pubkey_encrypt_data ()

int
gnutls_pubkey_encrypt_data (gnutls_pubkey_t key,
                            unsigned int flags,
                            const gnutls_datum_t *plaintext,
                            gnutls_datum_t *ciphertext);

This function will encrypt the given data, using the public key. On success the ciphertext will be allocated using gnutls_malloc().

Since: 3.0

gnutls_x509_crt_set_pubkey ()

int
gnutls_x509_crt_set_pubkey (gnutls_x509_crt_t crt,
                            gnutls_pubkey_t key);

This function will set the public parameters from the given public key to the certificate. The key can be deallocated after that.

Since: 2.12.0

gnutls_x509_crq_set_pubkey ()

int
gnutls_x509_crq_set_pubkey (gnutls_x509_crq_t crq,
                            gnutls_pubkey_t key);

This function will set the public parameters from the given public key to the request. The key can be deallocated after that.

Since: 2.12.0

gnutls_pubkey_verify_hash2 ()

int
gnutls_pubkey_verify_hash2 (gnutls_pubkey_t key,
                            gnutls_sign_algorithm_t algo,
                            unsigned int flags,
                            const gnutls_datum_t *hash,
                            const gnutls_datum_t *signature);

This function will verify the given signed digest, using the parameters from the public key. Note that unlike gnutls_privkey_sign_hash(), this function accepts a signature algorithm instead of a digest algorithm. You can use gnutls_pk_to_sign() to get the appropriate value.

Since: 3.0

gnutls_pubkey_verify_data2 ()

int
gnutls_pubkey_verify_data2 (gnutls_pubkey_t pubkey,
                            gnutls_sign_algorithm_t algo,
                            unsigned int flags,
                            const gnutls_datum_t *data,
                            const gnutls_datum_t *signature);

This function will verify the given signed data, using the parameters from the certificate.

Since: 3.0

gnutls_privkey_init ()

int
gnutls_privkey_init (gnutls_privkey_t *key);

This function will initialize a private key object. The object can be used to generate, import, and perform cryptographic operations on the associated private key.

Note that when the underlying private key is a PKCS11 key (i.e., when imported with a PKCS11 URI), the limitations of gnutls_pkcs11_privkey_init() apply to this object as well. In versions of GnuTLS later than 3.5.11 the object is protected using locks and a single gnutls_privkey_t can be re-used by many threads. However, for performance it is recommended to utilize one object per key per thread.

Since: 2.12.0

gnutls_privkey_deinit ()

void
gnutls_privkey_deinit (gnutls_privkey_t key);

This function will deinitialize a private key structure.

Since: 2.12.0

GNUTLS_SUBGROUP_TO_BITS()

#define             GNUTLS_SUBGROUP_TO_BITS(group, subgroup)

GNUTLS_BITS_TO_SUBGROUP()

#define GNUTLS_BITS_TO_SUBGROUP(bits) ((bits >> 16) & 0xFFFF)

GNUTLS_BITS_TO_GROUP()

#define GNUTLS_BITS_TO_GROUP(bits) (bits & 0xFFFF)

GNUTLS_BITS_HAVE_SUBGROUP()

#define GNUTLS_BITS_HAVE_SUBGROUP(bits) ((bits)&0xFFFF0000)

gnutls_privkey_generate ()

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

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().

Since: 3.3.0

gnutls_privkey_generate2 ()

int
gnutls_privkey_generate2 (gnutls_privkey_t pkey,
                          gnutls_pk_algorithm_t algo,
                          unsigned int bits,
                          unsigned int flags,
                          const gnutls_keygen_data_st *data,
                          unsigned  data_size);

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. On DSA keys the PQG parameters are generated using the seed, while on RSA the two primes. To specify an explicit seed (by default a random seed is used), use the data with a GNUTLS_KEYGEN_SEED type.

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.

To export the generated keys in memory or in files it is recommended to use the PKCS#8 form as it can handle all key types, and can store additional parameters such as the seed, in case of provable RSA or DSA keys. Generated keys can be exported in memory using gnutls_privkey_export_x509(), and then with gnutls_x509_privkey_export2_pkcs8().

If key generation is part of your application, avoid setting the number of bits directly, and instead use gnutls_sec_param_to_pk_bits(). That way the generated keys will adapt to the security levels of the underlying GnuTLS library.

Since: 3.5.0

gnutls_privkey_set_spki ()

int
gnutls_privkey_set_spki (gnutls_privkey_t key,
                         const gnutls_x509_spki_t spki,
                         unsigned int flags);

This function will set the public key information. The provided spki must be initialized.

Since: 3.6.0

gnutls_privkey_get_spki ()

int
gnutls_privkey_get_spki (gnutls_privkey_t key,
                         const gnutls_x509_spki_t spki,
                         unsigned int flags);

This function will return the public key information if available. The provided spki must be initialized.

Since: 3.6.0

gnutls_privkey_verify_seed ()

int
gnutls_privkey_verify_seed (gnutls_privkey_t key,
                            gnutls_digest_algorithm_t Param2,
                            const void *seed,
                            size_t seed_size);

This function will verify that the given private key was generated from the provided seed.

Since: 3.5.0

gnutls_privkey_get_seed ()

int
gnutls_privkey_get_seed (gnutls_privkey_t key,
                         gnutls_digest_algorithm_t *Param2,
                         void *seed,
                         size_t *seed_size);

This function will return the seed that was used to generate the given private key. That function will succeed only if the key was generated as a provable key.

Since: 3.5.0

gnutls_privkey_verify_params ()

int
gnutls_privkey_verify_params (gnutls_privkey_t key);

This function will verify the private key parameters.

Since: 3.3.0

gnutls_privkey_set_flags ()

void
gnutls_privkey_set_flags (gnutls_privkey_t key,
                          unsigned int flags);

This function will set flags for the specified private key, after it is generated. Currently this is useful for the GNUTLS_PRIVKEY_FLAG_EXPORT_COMPAT to allow exporting a "provable" private key in backwards compatible way.

Since: 3.5.0

gnutls_privkey_set_pin_function ()

void
gnutls_privkey_set_pin_function (gnutls_privkey_t key,
                                 gnutls_pin_callback_t fn,
                                 void *userdata);

This function will set a callback function to be used when required to access the object. This function overrides any other global PIN functions.

Note that this function must be called right after initialization to have effect.

Since: 3.1.0

gnutls_privkey_get_pk_algorithm ()

int
gnutls_privkey_get_pk_algorithm (gnutls_privkey_t key,
                                 unsigned int *bits);

This function will return the public key algorithm of a private key and if possible will return a number of bits that indicates the security parameter of the key.

Since: 2.12.0

gnutls_privkey_status ()

int
gnutls_privkey_status (gnutls_privkey_t key);

Checks the status of the private key token. This function is an actual wrapper over gnutls_pkcs11_privkey_status(), and if the private key is a PKCS 11 token it will check whether it is inserted or not.

Since: 3.1.10

gnutls_privkey_import_pkcs11 ()

int
gnutls_privkey_import_pkcs11 (gnutls_privkey_t pkey,
                              gnutls_pkcs11_privkey_t key,
                              unsigned int flags);

This function will import the given private key to the abstract gnutls_privkey_t type.

The gnutls_pkcs11_privkey_t object must not be deallocated during the lifetime of this structure.

flags might be zero or one of GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE and GNUTLS_PRIVKEY_IMPORT_COPY.

Since: 2.12.0

gnutls_privkey_import_x509 ()

int
gnutls_privkey_import_x509 (gnutls_privkey_t pkey,
                            gnutls_x509_privkey_t key,
                            unsigned int flags);

This function will import the given private key to the abstract gnutls_privkey_t type.

The gnutls_x509_privkey_t object must not be deallocated during the lifetime of this structure.

flags might be zero or one of GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE and GNUTLS_PRIVKEY_IMPORT_COPY.

Since: 2.12.0

gnutls_privkey_import_openpgp ()

int
gnutls_privkey_import_openpgp (gnutls_privkey_t pkey,
                               gnutls_openpgp_privkey_t key,
                               unsigned int flags);

This function is no-op.

Since: 2.12.0

gnutls_privkey_export_x509 ()

int
gnutls_privkey_export_x509 (gnutls_privkey_t pkey,
                            gnutls_x509_privkey_t *key);

Converts the given abstract private key to a gnutls_x509_privkey_t type. The abstract key must be of type GNUTLS_PRIVKEY_X509. The input key must not be initialized. The key returned in key should be deinitialized using gnutls_x509_privkey_deinit().

Since: 3.4.0

gnutls_privkey_export_openpgp ()

int
gnutls_privkey_export_openpgp (gnutls_privkey_t pkey,
                               gnutls_openpgp_privkey_t *key);

This function is no-op.

Since: 3.4.0

gnutls_privkey_export_pkcs11 ()

int
gnutls_privkey_export_pkcs11 (gnutls_privkey_t pkey,
                              gnutls_pkcs11_privkey_t *key);

Converts the given abstract private key to a gnutls_pkcs11_privkey_t type. The key must be of type GNUTLS_PRIVKEY_PKCS11. The key returned in key must be deinitialized with gnutls_pkcs11_privkey_deinit().

Since: 3.4.0

gnutls_privkey_import_openpgp_raw ()

int
gnutls_privkey_import_openpgp_raw (gnutls_privkey_t pkey,
                                   const gnutls_datum_t *data,
                                   gnutls_openpgp_crt_fmt_t format,
                                   const gnutls_openpgp_keyid_t keyid,
                                   const char *password);

This function is no-op.

Since: 3.1.0

gnutls_privkey_import_x509_raw ()

int
gnutls_privkey_import_x509_raw (gnutls_privkey_t pkey,
                                const gnutls_datum_t *data,
                                gnutls_x509_crt_fmt_t format,
                                const char *password,
                                unsigned int flags);

This function will import the given private key to the abstract gnutls_privkey_t type.

The supported formats are basic unencrypted key, PKCS8, PKCS12, TSS2, and the openssl format.

Since: 3.1.0

gnutls_privkey_import_tpm_raw ()

int
gnutls_privkey_import_tpm_raw (gnutls_privkey_t pkey,
                               const gnutls_datum_t *fdata,
                               gnutls_tpmkey_fmt_t format,
                               const char *srk_password,
                               const char *key_password,
                               unsigned int flags);

This function will import the given private key to the abstract gnutls_privkey_t type.

With respect to passwords the same as in gnutls_privkey_import_tpm_url() apply.

Since: 3.1.0

gnutls_privkey_import_tpm_url ()

int
gnutls_privkey_import_tpm_url (gnutls_privkey_t pkey,
                               const char *url,
                               const char *srk_password,
                               const char *key_password,
                               unsigned int flags);

This function will import the given private key to the abstract gnutls_privkey_t type.

Note that unless GNUTLS_PRIVKEY_DISABLE_CALLBACKS is specified, if incorrect (or NULL) passwords are given the PKCS11 callback functions will be used to obtain the correct passwords. Otherwise if the SRK password is wrong GNUTLS_E_TPM_SRK_PASSWORD_ERROR is returned and if the key password is wrong or not provided then GNUTLS_E_TPM_KEY_PASSWORD_ERROR is returned.

Since: 3.1.0

gnutls_privkey_import_url ()

int
gnutls_privkey_import_url (gnutls_privkey_t key,
                           const char *url,
                           unsigned int flags);

This function will import a PKCS11 or TPM URL as a private key. The supported URL types can be checked using gnutls_url_is_supported().

Since: 3.1.0

gnutls_privkey_import_pkcs11_url ()

int
gnutls_privkey_import_pkcs11_url (gnutls_privkey_t key,
                                  const char *url);

This function will import a PKCS 11 private key to a gnutls_privkey_t type.

Since: 3.1.0

gnutls_privkey_import_ext ()

int
gnutls_privkey_import_ext (gnutls_privkey_t pkey,
                           gnutls_pk_algorithm_t pk,
                           void *userdata,
                           gnutls_privkey_sign_func sign_func,
                           gnutls_privkey_decrypt_func decrypt_func,
                           unsigned int flags);

This function will associate the given callbacks with the gnutls_privkey_t type. At least one of the two callbacks must be non-null.

Note that the signing function is supposed to "raw" sign data, i.e., without any hashing or preprocessing. In case of RSA the DigestInfo will be provided, and the signing function is expected to do the PKCS #1 1.5 padding and the exponentiation.

See also gnutls_privkey_import_ext3().

Since: 3.0

gnutls_privkey_import_ext2 ()

int
gnutls_privkey_import_ext2 (gnutls_privkey_t pkey,
                            gnutls_pk_algorithm_t pk,
                            void *userdata,
                            gnutls_privkey_sign_func sign_func,
                            gnutls_privkey_decrypt_func decrypt_func,
                            gnutls_privkey_deinit_func deinit_func,
                            unsigned int flags);

This function will associate the given callbacks with the gnutls_privkey_t type. At least one of the two callbacks must be non-null. If a deinitialization function is provided then flags is assumed to contain GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE.

Note that the signing function is supposed to "raw" sign data, i.e., without any hashing or preprocessing. In case of RSA the DigestInfo will be provided, and the signing function is expected to do the PKCS #1 1.5 padding and the exponentiation.

See also gnutls_privkey_import_ext3().

Since: 3.1

gnutls_privkey_import_ext3 ()

int
gnutls_privkey_import_ext3 (gnutls_privkey_t pkey,
                            void *userdata,
                            gnutls_privkey_sign_func sign_func,
                            gnutls_privkey_decrypt_func decrypt_func,
                            gnutls_privkey_deinit_func deinit_func,
                            gnutls_privkey_info_func info_func,
                            unsigned int flags);

This function will associate the given callbacks with the gnutls_privkey_t type. At least one of the two callbacks must be non-null. If a deinitialization function is provided then flags is assumed to contain GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE.

Note that the signing function is supposed to "raw" sign data, i.e., without any hashing or preprocessing. In case of RSA the DigestInfo will be provided, and the signing function is expected to do the PKCS #1 1.5 padding and the exponentiation.

The info_fn must provide information on the algorithms supported by this private key, and should support the flags GNUTLS_PRIVKEY_INFO_PK_ALGO and GNUTLS_PRIVKEY_INFO_SIGN_ALGO. It must return -1 on unknown flags.

Since: 3.4.0

gnutls_privkey_import_ext4 ()

int
gnutls_privkey_import_ext4 (gnutls_privkey_t pkey,
                            void *userdata,
                            gnutls_privkey_sign_data_func sign_data_func,
                            gnutls_privkey_sign_hash_func sign_hash_func,
                            gnutls_privkey_decrypt_func decrypt_func,
                            gnutls_privkey_deinit_func deinit_func,
                            gnutls_privkey_info_func info_func,
                            unsigned int flags);

This function will associate the given callbacks with the gnutls_privkey_t type. At least one of the callbacks must be non-null. If a deinitialization function is provided then flags is assumed to contain GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE.

Note that in contrast with the signing function of gnutls_privkey_import_ext3(), the signing functions provided to this function take explicitly the signature algorithm as parameter and different functions are provided to sign the data and hashes.

The sign_hash_fn is to be called to sign pre-hashed data. The input to the callback is the output of the hash (such as SHA256) corresponding to the signature algorithm. For RSA PKCS#1 signatures, the signature algorithm can be set to GNUTLS_SIGN_RSA_RAW, and in that case the data should be handled as if they were an RSA PKCS#1 DigestInfo structure.

The sign_data_fn is to be called to sign data. The input data will be he data to be signed (and hashed), with the provided signature algorithm. This function is to be used for signature algorithms like Ed25519 which cannot take pre-hashed data as input.

When both sign_data_fn and sign_hash_fn functions are provided they must be able to operate on all the supported signature algorithms, unless prohibited by the type of the algorithm (e.g., as with Ed25519).

The info_fn must provide information on the signature algorithms supported by this private key, and should support the flags GNUTLS_PRIVKEY_INFO_PK_ALGO, GNUTLS_PRIVKEY_INFO_HAVE_SIGN_ALGO and GNUTLS_PRIVKEY_INFO_PK_ALGO_BITS. It must return -1 on unknown flags.

Since: 3.6.0

gnutls_privkey_import_dsa_raw ()

int
gnutls_privkey_import_dsa_raw (gnutls_privkey_t key,
                               const gnutls_datum_t *p,
                               const gnutls_datum_t *q,
                               const gnutls_datum_t *g,
                               const gnutls_datum_t *y,
                               const gnutls_datum_t *x);

This function will convert the given DSA raw parameters to the native gnutls_privkey_t format. The output will be stored in key .

gnutls_privkey_import_dh_raw ()

int
gnutls_privkey_import_dh_raw (gnutls_privkey_t key,
                              const gnutls_dh_params_t params,
                              const gnutls_datum_t *y,
                              const gnutls_datum_t *x);

This function will convert the given Diffie-Hellman raw parameters to the native gnutls_privkey_t format. The output will be stored in key .

Since: 3.8.2

gnutls_privkey_import_rsa_raw ()

int
gnutls_privkey_import_rsa_raw (gnutls_privkey_t key,
                               const gnutls_datum_t *m,
                               const gnutls_datum_t *e,
                               const gnutls_datum_t *d,
                               const gnutls_datum_t *p,
                               const gnutls_datum_t *q,
                               const gnutls_datum_t *u,
                               const gnutls_datum_t *e1,
                               const gnutls_datum_t *e2);

This function will convert the given RSA raw parameters to the native gnutls_privkey_t format. The output will be stored in key .

gnutls_privkey_import_ecc_raw ()

int
gnutls_privkey_import_ecc_raw (gnutls_privkey_t key,
                               gnutls_ecc_curve_t curve,
                               const gnutls_datum_t *x,
                               const gnutls_datum_t *y,
                               const gnutls_datum_t *k);

This function will convert the given elliptic curve parameters to the native gnutls_privkey_t format. The output will be stored in key .

In EdDSA curves the y parameter should be NULL and the x and k parameters must be in the native format for the curve.

Since: 3.0

gnutls_privkey_import_gost_raw ()

int
gnutls_privkey_import_gost_raw (gnutls_privkey_t key,
                                gnutls_ecc_curve_t curve,
                                gnutls_digest_algorithm_t digest,
                                gnutls_gost_paramset_t paramset,
                                const gnutls_datum_t *x,
                                const gnutls_datum_t *y,
                                const gnutls_datum_t *k);

This function will convert the given GOST private key's parameters to the native gnutls_privkey_t format. The output will be stored in key . digest should be one of GNUTLS_DIG_GOSR_94, GNUTLS_DIG_STREEBOG_256 or GNUTLS_DIG_STREEBOG_512. If paramset is set to GNUTLS_GOST_PARAMSET_UNKNOWN default one will be selected depending on digest .

Note: parameters should be stored with least significant byte first. On version 3.6.3 big-endian format was used incorrectly.

Since: 3.6.3

gnutls_privkey_sign_data ()

int
gnutls_privkey_sign_data (gnutls_privkey_t signer,
                          gnutls_digest_algorithm_t hash,
                          unsigned int flags,
                          const gnutls_datum_t *data,
                          gnutls_datum_t *signature);

This function will sign the given data using a signature algorithm supported by the private key. Signature algorithms are always used together with a hash functions. Different hash functions may be used for the RSA algorithm, but only the SHA family for the DSA keys.

You may use gnutls_pubkey_get_preferred_hash_algorithm() to determine the hash algorithm.

Since: 2.12.0

gnutls_privkey_sign_data2 ()

int
gnutls_privkey_sign_data2 (gnutls_privkey_t signer,
                           gnutls_sign_algorithm_t algo,
                           unsigned int flags,
                           const gnutls_datum_t *data,
                           gnutls_datum_t *signature);

This function will sign the given data using the specified signature algorithm. This function is an enhancement of gnutls_privkey_sign_data(), as it allows utilizing a alternative signature algorithm where possible (e.g, use an RSA key with RSA-PSS).

Since: 3.6.0

gnutls_privkey_sign_raw_data()

#define             gnutls_privkey_sign_raw_data(key, flags, data, sig)

gnutls_privkey_sign_hash ()

int
gnutls_privkey_sign_hash (gnutls_privkey_t signer,
                          gnutls_digest_algorithm_t hash_algo,
                          unsigned int flags,
                          const gnutls_datum_t *hash_data,
                          gnutls_datum_t *signature);

This function will sign the given hashed data using a signature algorithm supported by the private key. Signature algorithms are always used together with a hash functions. Different hash functions may be used for the RSA algorithm, but only SHA-XXX for the DSA keys.

You may use gnutls_pubkey_get_preferred_hash_algorithm() to determine the hash algorithm.

The flags may be GNUTLS_PRIVKEY_SIGN_FLAG_TLS1_RSA or GNUTLS_PRIVKEY_SIGN_FLAG_RSA_PSS. In the former case this function will ignore hash_algo and perform a raw PKCS1 signature, and in the latter an RSA-PSS signature will be generated.

Note that, not all algorithm support signing already hashed data. When signing with Ed25519, gnutls_privkey_sign_data() should be used.

Since: 2.12.0

gnutls_privkey_sign_hash2 ()

int
gnutls_privkey_sign_hash2 (gnutls_privkey_t signer,
                           gnutls_sign_algorithm_t algo,
                           unsigned int flags,
                           const gnutls_datum_t *hash_data,
                           gnutls_datum_t *signature);

This function will sign the given hashed data using the specified signature algorithm. This function is an enhancement of gnutls_privkey_sign_hash(), as it allows utilizing a alternative signature algorithm where possible (e.g, use an RSA key with RSA-PSS).

The flags may be GNUTLS_PRIVKEY_SIGN_FLAG_TLS1_RSA. In that case this function will ignore hash_algo and perform a raw PKCS1 signature. Note that this flag is supported since 3.6.9.

Note also that, not all algorithm support signing already hashed data. When signing with Ed25519, gnutls_privkey_sign_data2() should be used instead.

Since: 3.6.0

gnutls_privkey_decrypt_data ()

int
gnutls_privkey_decrypt_data (gnutls_privkey_t key,
                             unsigned int flags,
                             const gnutls_datum_t *ciphertext,
                             gnutls_datum_t *plaintext);

This function will decrypt the given data using the algorithm supported by the private key.

Since: 2.12.0

gnutls_privkey_decrypt_data2 ()

int
gnutls_privkey_decrypt_data2 (gnutls_privkey_t key,
                              unsigned int flags,
                              const gnutls_datum_t *ciphertext,
                              unsigned char *plaintext,
                              size_t plaintext_size);

This function will decrypt the given data using the algorithm supported by the private key. Unlike with gnutls_privkey_decrypt_data() this function operates in constant time and constant memory access.

Since: 3.6.5

gnutls_privkey_export_rsa_raw ()

int
gnutls_privkey_export_rsa_raw (gnutls_privkey_t key,
                               gnutls_datum_t *m,
                               gnutls_datum_t *e,
                               gnutls_datum_t *d,
                               gnutls_datum_t *p,
                               gnutls_datum_t *q,
                               gnutls_datum_t *u,
                               gnutls_datum_t *e1,
                               gnutls_datum_t *e2);

This function will export the RSA private key's parameters found in the given structure. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum. For EdDSA keys, the y value should be NULL.

Since: 3.3.0

gnutls_privkey_export_rsa_raw2 ()

int
gnutls_privkey_export_rsa_raw2 (gnutls_privkey_t key,
                                gnutls_datum_t *m,
                                gnutls_datum_t *e,
                                gnutls_datum_t *d,
                                gnutls_datum_t *p,
                                gnutls_datum_t *q,
                                gnutls_datum_t *u,
                                gnutls_datum_t *e1,
                                gnutls_datum_t *e2,
                                unsigned  flags);

This function will export the RSA private key's parameters found in the given structure. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

Since: 3.6.0

gnutls_privkey_export_dsa_raw ()

int
gnutls_privkey_export_dsa_raw (gnutls_privkey_t key,
                               gnutls_datum_t *p,
                               gnutls_datum_t *q,
                               gnutls_datum_t *g,
                               gnutls_datum_t *y,
                               gnutls_datum_t *x);

This function will export the DSA private key's parameters found in the given structure. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

Since: 3.3.0

gnutls_privkey_export_dsa_raw2 ()

int
gnutls_privkey_export_dsa_raw2 (gnutls_privkey_t key,
                                gnutls_datum_t *p,
                                gnutls_datum_t *q,
                                gnutls_datum_t *g,
                                gnutls_datum_t *y,
                                gnutls_datum_t *x,
                                unsigned  flags);

This function will export the DSA private key's parameters found in the given structure. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

Since: 3.6.0

gnutls_privkey_export_dh_raw ()

int
gnutls_privkey_export_dh_raw (gnutls_privkey_t key,
                              gnutls_dh_params_t params,
                              gnutls_datum_t *y,
                              gnutls_datum_t *x,
                              unsigned int flags);

This function will export the Diffie-Hellman private key parameter found in the given gnutls_privkey_t structure. The new parameter will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

To retrieve other parameters common in both public key and private key, use gnutls_dh_params_export_raw().

Since: 3.8.2

gnutls_privkey_export_ecc_raw ()

int
gnutls_privkey_export_ecc_raw (gnutls_privkey_t key,
                               gnutls_ecc_curve_t *curve,
                               gnutls_datum_t *x,
                               gnutls_datum_t *y,
                               gnutls_datum_t *k);

This function will export the ECC private key's parameters found in the given structure. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

In EdDSA curves the y parameter will be NULL and the other parameters will be in the native format for the curve.

Since: 3.3.0

gnutls_privkey_export_ecc_raw2 ()

int
gnutls_privkey_export_ecc_raw2 (gnutls_privkey_t key,
                                gnutls_ecc_curve_t *curve,
                                gnutls_datum_t *x,
                                gnutls_datum_t *y,
                                gnutls_datum_t *k,
                                unsigned  flags);

This function will export the ECC private key's parameters found in the given structure. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

In EdDSA curves the y parameter will be NULL and the other parameters will be in the native format for the curve.

Since: 3.6.0

gnutls_privkey_export_gost_raw2 ()

int
gnutls_privkey_export_gost_raw2 (gnutls_privkey_t key,
                                 gnutls_ecc_curve_t *curve,
                                 gnutls_digest_algorithm_t *digest,
                                 gnutls_gost_paramset_t *paramset,
                                 gnutls_datum_t *x,
                                 gnutls_datum_t *y,
                                 gnutls_datum_t *k,
                                 unsigned  flags);

This function will export the GOST private key's parameters found in the given structure. The new parameters will be allocated using gnutls_malloc() and will be stored in the appropriate datum.

Note: parameters will be stored with least significant byte first. On version 3.6.3 this was incorrectly returned in big-endian format.

Since: 3.6.3

gnutls_privkey_derive_secret ()

int
gnutls_privkey_derive_secret (gnutls_privkey_t privkey,
                              gnutls_pubkey_t pubkey,
                              const gnutls_datum_t *nonce,
                              gnutls_datum_t *secret,
                              unsigned int flags);

This function will calculate a shared secret from our privkey and peer's pubkey . The result will be stored in secret , whose data member should be freed after use using gnutls_free(). privkey and pubkey must be backed by the X.509 keys.

Since: 3.8.2

gnutls_x509_crt_privkey_sign ()

int
gnutls_x509_crt_privkey_sign (gnutls_x509_crt_t crt,
                              gnutls_x509_crt_t issuer,
                              gnutls_privkey_t issuer_key,
                              gnutls_digest_algorithm_t dig,
                              unsigned int flags);

This function will sign the certificate with the issuer's private key, and will copy the issuer's information into the certificate.

This must be the last step in a certificate generation since all the previously set parameters are now signed.

A known limitation of this function is, that a newly-signed certificate will not be fully functional (e.g., for signature verification), until it is exported an re-imported.

After GnuTLS 3.6.1 the value of dig may be GNUTLS_DIG_UNKNOWN, and in that case, a suitable but reasonable for the key algorithm will be selected.

gnutls_x509_crl_privkey_sign ()

int
gnutls_x509_crl_privkey_sign (gnutls_x509_crl_t crl,
                              gnutls_x509_crt_t issuer,
                              gnutls_privkey_t issuer_key,
                              gnutls_digest_algorithm_t dig,
                              unsigned int flags);

This function will sign the CRL with the issuer's private key, and will copy the issuer's information into the CRL.

This must be the last step in a certificate CRL since all the previously set parameters are now signed.

A known limitation of this function is, that a newly-signed CRL will not be fully functional (e.g., for signature verification), until it is exported an re-imported.

After GnuTLS 3.6.1 the value of dig may be GNUTLS_DIG_UNKNOWN, and in that case, a suitable but reasonable for the key algorithm will be selected.

gnutls_x509_crq_privkey_sign ()

int
gnutls_x509_crq_privkey_sign (gnutls_x509_crq_t crq,
                              gnutls_privkey_t key,
                              gnutls_digest_algorithm_t dig,
                              unsigned int flags);

This function will sign the certificate request with a private key. This must be the same key as the one used in gnutls_x509_crt_set_key() since a certificate request is self signed.

This must be the last step in a certificate request generation since all the previously set parameters are now signed.

A known limitation of this function is, that a newly-signed request will not be fully functional (e.g., for signature verification), until it is exported an re-imported.

After GnuTLS 3.6.1 the value of dig may be GNUTLS_DIG_UNKNOWN, and in that case, a suitable but reasonable for the key algorithm will be selected.

Since: 2.12.0

gnutls_pcert_import_x509 ()

int
gnutls_pcert_import_x509 (gnutls_pcert_st *pcert,
                          gnutls_x509_crt_t crt,
                          unsigned int flags);

This convenience function will import the given certificate to a gnutls_pcert_st structure. The structure must be deinitialized afterwards using gnutls_pcert_deinit();

Since: 3.0

gnutls_pcert_import_x509_list ()

int
gnutls_pcert_import_x509_list (gnutls_pcert_st *pcert,
                               gnutls_x509_crt_t *crt,
                               unsigned *ncrt,
                               unsigned int flags);

This convenience function will import the given certificates to an already allocated set of gnutls_pcert_st structures. The structures must be deinitialized afterwards using gnutls_pcert_deinit(). pcert_list should contain space for at least ncrt elements.

In the case GNUTLS_X509_CRT_LIST_SORT is specified and that function cannot sort the list, GNUTLS_E_CERTIFICATE_LIST_UNSORTED will be returned. Currently sorting can fail if the list size exceeds an internal constraint (16).

Since: 3.4.0

gnutls_pcert_export_x509 ()

int
gnutls_pcert_export_x509 (gnutls_pcert_st *pcert,
                          gnutls_x509_crt_t *crt);