gnutls_x509_crt_init ()

int
gnutls_x509_crt_init (gnutls_x509_crt_t *cert);

This function will initialize an X.509 certificate structure.

gnutls_x509_crt_deinit ()

void
gnutls_x509_crt_deinit (gnutls_x509_crt_t cert);

This function will deinitialize a certificate structure.

gnutls_x509_crt_set_flags ()

void
gnutls_x509_crt_set_flags (gnutls_x509_crt_t cert,
                           unsigned  flags);

This function will set flags for the specified certificate. Currently this is useful for the GNUTLS_X509_CRT_FLAG_IGNORE_SANITY which allows importing certificates even if they have known issues.

Since: 3.6.0

gnutls_x509_crt_equals ()

unsigned
gnutls_x509_crt_equals (gnutls_x509_crt_t cert1,
                        gnutls_x509_crt_t cert2);

gnutls_x509_crt_equals2 ()

unsigned
gnutls_x509_crt_equals2 (gnutls_x509_crt_t cert1,
                         const gnutls_datum_t *der);

gnutls_x509_crt_import ()

int
gnutls_x509_crt_import (gnutls_x509_crt_t cert,
                        const gnutls_datum_t *data,
                        gnutls_x509_crt_fmt_t format);

This function will convert the given DER or PEM encoded Certificate to the native gnutls_x509_crt_t format. The output will be stored in cert .

If the Certificate is PEM encoded it should have a header of "X509 CERTIFICATE", or "CERTIFICATE".

gnutls_x509_crt_list_import2 ()

int
gnutls_x509_crt_list_import2 (gnutls_x509_crt_t **certs,
                              unsigned int *size,
                              const gnutls_datum_t *data,
                              gnutls_x509_crt_fmt_t format,
                              unsigned int flags);

This function will convert the given PEM encoded certificate list to the native gnutls_x509_crt_t format. The output will be stored in certs which will be allocated and initialized.

If the Certificate is PEM encoded it should have a header of "X509 CERTIFICATE", or "CERTIFICATE".

To deinitialize certs , you need to deinitialize each crt structure independently, and use gnutls_free() at certs .

Since: 3.0

gnutls_x509_crt_list_import ()

int
gnutls_x509_crt_list_import (gnutls_x509_crt_t *certs,
                             unsigned int *cert_max,
                             const gnutls_datum_t *data,
                             gnutls_x509_crt_fmt_t format,
                             unsigned int flags);

This function will convert the given PEM encoded certificate list to the native gnutls_x509_crt_t format. The output will be stored in certs . They will be automatically initialized.

The flag GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED will cause import to fail if the certificates in the provided buffer are more than the available structures. The GNUTLS_X509_CRT_LIST_FAIL_IF_UNSORTED flag will cause the function to fail if the provided list is not sorted from subject to issuer.

If the Certificate is PEM encoded it should have a header of "X509 CERTIFICATE", or "CERTIFICATE".

gnutls_x509_crt_import_url ()

int
gnutls_x509_crt_import_url (gnutls_x509_crt_t crt,
                            const char *url,
                            unsigned int flags);

This function will import a certificate present in a PKCS11 token or any type of back-end that supports URLs.

In previous versions of gnutls this function was named gnutls_x509_crt_import_pkcs11_url, and the old name is an alias to this one.

Since: 3.4.0

gnutls_x509_crt_list_import_url ()

int
gnutls_x509_crt_list_import_url (gnutls_x509_crt_t **certs,
                                 unsigned int *size,
                                 const char *url,
                                 gnutls_pin_callback_t pin_fn,
                                 void *pin_fn_userdata,
                                 unsigned int flags);

This function will import a certificate chain present in a PKCS11 token or any type of back-end that supports URLs. The certificates must be deinitialized afterwards using gnutls_x509_crt_deinit() and the returned pointer must be freed using gnutls_free().

The URI provided must be the first certificate in the chain; subsequent certificates will be retrieved using gnutls_pkcs11_get_raw_issuer() or equivalent functionality for the supported URI.

Since: 3.6.3

gnutls_x509_crt_export ()

int
gnutls_x509_crt_export (gnutls_x509_crt_t cert,
                        gnutls_x509_crt_fmt_t format,
                        void *output_data,
                        size_t *output_data_size);

This function will export the certificate to DER or PEM format.

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".

gnutls_x509_crt_export2 ()

int
gnutls_x509_crt_export2 (gnutls_x509_crt_t cert,
                         gnutls_x509_crt_fmt_t format,
                         gnutls_datum_t *out);

This function will export the certificate to DER or PEM format. The output buffer is allocated using gnutls_malloc().

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

Since: 3.1.3

gnutls_x509_crt_get_private_key_usage_period ()

int
gnutls_x509_crt_get_private_key_usage_period
                               (gnutls_x509_crt_t cert,
                                time_t *activation,
                                time_t *expiration,
                                unsigned int *critical);

This function will return the expiration and activation times of the private key of the certificate. It relies on the PKIX extension 2.5.29.16 being present.

gnutls_x509_crt_get_issuer_dn ()

int
gnutls_x509_crt_get_issuer_dn (gnutls_x509_crt_t cert,
                               char *buf,
                               size_t *buf_size);

This function will copy the name of the Certificate issuer in the provided buffer. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC4514. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.

If buf is null then only the size will be filled.

This function does not output a fully RFC4514 compliant string, if that is required see gnutls_x509_crt_get_issuer_dn3().

gnutls_x509_crt_get_issuer_dn2 ()

int
gnutls_x509_crt_get_issuer_dn2 (gnutls_x509_crt_t cert,
                                gnutls_datum_t *dn);

This function will allocate buffer and copy the name of issuer of the Certificate. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC4514. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.

This function does not output a fully RFC4514 compliant string, if that is required see gnutls_x509_crt_get_issuer_dn3().

Since: 3.1.10

gnutls_x509_crt_get_issuer_dn3 ()

int
gnutls_x509_crt_get_issuer_dn3 (gnutls_x509_crt_t cert,
                                gnutls_datum_t *dn,
                                unsigned  flags);

This function will allocate buffer and copy the name of issuer of the Certificate. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC4514. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.

When the flag GNUTLS_X509_DN_FLAG_COMPAT is specified, the output format will match the format output by previous to 3.5.6 versions of GnuTLS which was not not fully RFC4514-compliant.

Since: 3.5.7

gnutls_x509_crt_get_issuer_dn_oid ()

int
gnutls_x509_crt_get_issuer_dn_oid (gnutls_x509_crt_t cert,
                                   unsigned  indx,
                                   void *oid,
                                   size_t *oid_size);

This function will extract the OIDs of the name of the Certificate issuer specified by the given index.

If oid is null then only the size will be filled. The oid returned will be null terminated, although oid_size will not account for the trailing null.

gnutls_x509_crt_get_issuer_dn_by_oid ()

int
gnutls_x509_crt_get_issuer_dn_by_oid (gnutls_x509_crt_t cert,
                                      const char *oid,
                                      unsigned  indx,
                                      unsigned int raw_flag,
                                      void *buf,
                                      size_t *buf_size);

This function will extract the part of the name of the Certificate issuer specified by the given OID. The output, if the raw flag is not used, will be encoded as described in RFC4514. Thus a string that is ASCII or UTF-8 encoded, depending on the certificate data.

Some helper macros with popular OIDs can be found in gnutls/x509.h If raw flag is (0), this function will only return known OIDs as text. Other OIDs will be DER encoded, as described in RFC4514 -- in hex format with a '#' prefix. You can check about known OIDs using gnutls_x509_dn_oid_known().

If buf is null then only the size will be filled. If the raw_flag is not specified the output is always null terminated, although the buf_size will not include the null character.

gnutls_x509_crt_get_dn ()

int
gnutls_x509_crt_get_dn (gnutls_x509_crt_t cert,
                        char *buf,
                        size_t *buf_size);

This function will copy the name of the Certificate in the provided buffer. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC4514. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.

The buf returned will be null terminated and the buf_size will account for the trailing null. If buf is null then only the size will be filled.

This function does not output a fully RFC4514 compliant string, if that is required see gnutls_x509_crt_get_dn3().

gnutls_x509_crt_get_dn2 ()

int
gnutls_x509_crt_get_dn2 (gnutls_x509_crt_t cert,
                         gnutls_datum_t *dn);

This function will allocate buffer and copy the name of the Certificate. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC4514. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.

This function does not output a fully RFC4514 compliant string, if that is required see gnutls_x509_crt_get_dn3().

Since: 3.1.10

gnutls_x509_crt_get_dn3 ()

int
gnutls_x509_crt_get_dn3 (gnutls_x509_crt_t cert,
                         gnutls_datum_t *dn,
                         unsigned  flags);

This function will allocate buffer and copy the name of the Certificate. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC4514. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.

When the flag GNUTLS_X509_DN_FLAG_COMPAT is specified, the output format will match the format output by previous to 3.5.6 versions of GnuTLS which was not not fully RFC4514-compliant.

Since: 3.5.7

gnutls_x509_crt_get_dn_oid ()

int
gnutls_x509_crt_get_dn_oid (gnutls_x509_crt_t cert,
                            unsigned  indx,
                            void *oid,
                            size_t *oid_size);

This function will extract the OIDs of the name of the Certificate subject specified by the given index.

If oid is null then only the size will be filled. The oid returned will be null terminated, although oid_size will not account for the trailing null.

gnutls_x509_crt_get_dn_by_oid ()

int
gnutls_x509_crt_get_dn_by_oid (gnutls_x509_crt_t cert,
                               const char *oid,
                               unsigned  indx,
                               unsigned int raw_flag,
                               void *buf,
                               size_t *buf_size);

This function will extract the part of the name of the Certificate subject specified by the given OID. The output, if the raw flag is not used, will be encoded as described in RFC4514. Thus a string that is ASCII or UTF-8 encoded, depending on the certificate data.

Some helper macros with popular OIDs can be found in gnutls/x509.h If raw flag is (0), this function will only return known OIDs as text. Other OIDs will be DER encoded, as described in RFC4514 -- in hex format with a '#' prefix. You can check about known OIDs using gnutls_x509_dn_oid_known().

If buf is null then only the size will be filled. If the raw_flag is not specified the output is always null terminated, although the buf_size will not include the null character.

gnutls_x509_crt_check_hostname ()

unsigned
gnutls_x509_crt_check_hostname (gnutls_x509_crt_t cert,
                                const char *hostname);

This function will check if the given certificate's subject matches the given hostname. This is a basic implementation of the matching described in RFC6125, and takes into account wildcards, and the DNSName/IPAddress subject alternative name PKIX extension.

For details see also gnutls_x509_crt_check_hostname2().

gnutls_x509_crt_check_hostname2 ()

unsigned
gnutls_x509_crt_check_hostname2 (gnutls_x509_crt_t cert,
                                 const char *hostname,
                                 unsigned int flags);

This function will check if the given certificate's subject matches the given hostname. This is a basic implementation of the matching described in RFC6125, and takes into account wildcards, and the DNSName/IPAddress subject alternative name PKIX extension.

IPv4 addresses are accepted by this function in the dotted-decimal format (e.g, ddd.ddd.ddd.ddd), and IPv6 addresses in the hexadecimal x:x:x:x:x:x:x:x format. For them the IPAddress subject alternative name extension is consulted. Previous versions to 3.6.0 of GnuTLS in case of a non-match would consult (in a non-standard extension) the DNSname and CN fields. This is no longer the case.

When the flag GNUTLS_VERIFY_DO_NOT_ALLOW_WILDCARDS is specified no wildcards are considered. Otherwise they are only considered if the domain name consists of three components or more, and the wildcard starts at the leftmost position.

When the flag GNUTLS_VERIFY_DO_NOT_ALLOW_IP_MATCHES is specified, the input will be treated as a DNS name, and matching of textual IP addresses against the IPAddress part of the alternative name will not be allowed.

The function gnutls_x509_crt_check_ip() is available for matching IP addresses.

Since: 3.3.0

gnutls_x509_crt_check_email ()

unsigned
gnutls_x509_crt_check_email (gnutls_x509_crt_t cert,
                             const char *email,
                             unsigned int flags);

This function will check if the given certificate's subject matches the given email address.

gnutls_x509_crt_check_ip ()

unsigned
gnutls_x509_crt_check_ip (gnutls_x509_crt_t cert,
                          const unsigned char *ip,
                          unsigned int ip_size,
                          unsigned int flags);

This function will check if the IP allowed IP addresses in the certificate's subject alternative name match the provided IP address.

gnutls_x509_crt_get_signature_algorithm ()

int
gnutls_x509_crt_get_signature_algorithm
                               (gnutls_x509_crt_t cert);

This function will return a value of the gnutls_sign_algorithm_t enumeration that is the signature algorithm that has been used to sign this certificate.

Since 3.6.0 this function never returns a negative error code. Error cases and unknown/unsupported signature algorithms are mapped to GNUTLS_SIGN_UNKNOWN.

gnutls_x509_crt_get_signature ()

int
gnutls_x509_crt_get_signature (gnutls_x509_crt_t cert,
                               char *sig,
                               size_t *sizeof_sig);

This function will extract the signature field of a certificate.

gnutls_x509_crt_get_version ()

int
gnutls_x509_crt_get_version (gnutls_x509_crt_t cert);

This function will return the version of the specified Certificate.

gnutls_x509_crt_get_pk_oid ()

int
gnutls_x509_crt_get_pk_oid (gnutls_x509_crt_t cert,
                            char *oid,
                            size_t *oid_size);

This function will return the OID of the public key algorithm on that certificate. This is function is useful in the case gnutls_x509_crt_get_pk_algorithm() returned GNUTLS_PK_UNKNOWN.

Since: 3.5.0

gnutls_x509_crt_get_signature_oid ()

int
gnutls_x509_crt_get_signature_oid (gnutls_x509_crt_t cert,
                                   char *oid,
                                   size_t *oid_size);

This function will return the OID of the signature algorithm that has been used to sign this certificate. This is function is useful in the case gnutls_x509_crt_get_signature_algorithm() returned GNUTLS_SIGN_UNKNOWN.

Since: 3.5.0

gnutls_x509_crt_get_key_id ()

int
gnutls_x509_crt_get_key_id (gnutls_x509_crt_t crt,
                            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 private 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.

gnutls_x509_crt_set_private_key_usage_period ()

int
gnutls_x509_crt_set_private_key_usage_period
                               (gnutls_x509_crt_t crt,
                                time_t activation,
                                time_t expiration);

This function will set the private key usage period extension (2.5.29.16).

gnutls_x509_crt_set_authority_key_id ()

int
gnutls_x509_crt_set_authority_key_id (gnutls_x509_crt_t cert,
                                      const void *id,
                                      size_t id_size);

This function will set the X.509 certificate's authority key ID extension. Only the keyIdentifier field can be set with this function.

gnutls_x509_crt_get_authority_key_id ()

int
gnutls_x509_crt_get_authority_key_id (gnutls_x509_crt_t cert,
                                      void *id,
                                      size_t *id_size,
                                      unsigned int *critical);

This function will return the X.509v3 certificate authority's key identifier. This is obtained by the X.509 Authority Key identifier extension field (2.5.29.35). Note that this function only returns the keyIdentifier field of the extension and GNUTLS_E_X509_UNSUPPORTED_EXTENSION, if the extension contains the name and serial number of the certificate. In that case gnutls_x509_crt_get_authority_key_gn_serial() may be used.

gnutls_x509_crt_get_authority_key_gn_serial ()

int
gnutls_x509_crt_get_authority_key_gn_serial
                               (gnutls_x509_crt_t cert,
                                unsigned int seq,
                                void *alt,
                                size_t *alt_size,
                                unsigned int *alt_type,
                                void *serial,
                                size_t *serial_size,
                                unsigned int *critical);

This function will return the X.509 authority key identifier when stored as a general name (authorityCertIssuer) and serial number.

Because more than one general names might be stored seq can be used as a counter to request them all until GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE is returned.

Since: 3.0

gnutls_x509_crt_get_subject_key_id ()

int
gnutls_x509_crt_get_subject_key_id (gnutls_x509_crt_t cert,
                                    void *ret,
                                    size_t *ret_size,
                                    unsigned int *critical);

This function will return the X.509v3 certificate's subject key identifier. This is obtained by the X.509 Subject Key identifier extension field (2.5.29.14).

gnutls_x509_crt_get_subject_unique_id ()

int
gnutls_x509_crt_get_subject_unique_id (gnutls_x509_crt_t crt,
                                       char *buf,
                                       size_t *buf_size);

This function will extract the subjectUniqueID value (if present) for the given certificate.

If the user allocated memory buffer is not large enough to hold the full subjectUniqueID, then a GNUTLS_E_SHORT_MEMORY_BUFFER error will be returned, and buf_size will be set to the actual length.

This function had a bug prior to 3.4.8 that prevented the setting of NULL buf to discover the buf_size . To use this function safely with the older versions the buf must be a valid buffer that can hold at least a single byte if buf_size is zero.

gnutls_x509_crt_get_issuer_unique_id ()

int
gnutls_x509_crt_get_issuer_unique_id (gnutls_x509_crt_t crt,
                                      char *buf,
                                      size_t *buf_size);

This function will extract the issuerUniqueID value (if present) for the given certificate.

If the user allocated memory buffer is not large enough to hold the full subjectUniqueID, then a GNUTLS_E_SHORT_MEMORY_BUFFER error will be returned, and buf_size will be set to the actual length.

This function had a bug prior to 3.4.8 that prevented the setting of NULL buf to discover the buf_size . To use this function safely with the older versions the buf must be a valid buffer that can hold at least a single byte if buf_size is zero.

Since: 2.12.0

gnutls_x509_crt_set_pin_function ()

void
gnutls_x509_crt_set_pin_function (gnutls_x509_crt_t crt,
                                  gnutls_pin_callback_t fn,
                                  void *userdata);

This function will set a callback function to be used when it is required to access a protected object. This function overrides the global function set using gnutls_pkcs11_set_pin_function().

Note that this callback is currently used only during the import of a PKCS 11 certificate with gnutls_x509_crt_import_url().

Since: 3.1.0

gnutls_x509_crt_get_authority_info_access ()

int
gnutls_x509_crt_get_authority_info_access
                               (gnutls_x509_crt_t crt,
                                unsigned int seq,
                                int what,
                                gnutls_datum_t *data,
                                unsigned int *critical);

Note that a simpler API to access the authority info data is provided by gnutls_x509_aia_get() and gnutls_x509_ext_import_aia().

This function extracts the Authority Information Access (AIA) extension, see RFC 5280 section 4.2.2.1 for more information. The AIA extension holds a sequence of AccessDescription (AD) data.

The seq input parameter is used to indicate which member of the sequence the caller is interested in. The first member is 0, the second member 1 and so on. When the seq value is out of bounds, GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE is returned.

The type of data returned in data is specified via what which should be gnutls_info_access_what_t values.

If what is GNUTLS_IA_ACCESSMETHOD_OID then data will hold the accessMethod OID (e.g., "1.3.6.1.5.5.7.48.1").

If what is GNUTLS_IA_ACCESSLOCATION_GENERALNAME_TYPE, data will hold the accessLocation GeneralName type (e.g., "uniformResourceIdentifier").

If what is GNUTLS_IA_URI, data will hold the accessLocation URI data. Requesting this what value leads to an error if the accessLocation is not of the "uniformResourceIdentifier" type.

If what is GNUTLS_IA_OCSP_URI, data will hold the OCSP URI. Requesting this what value leads to an error if the accessMethod is not 1.3.6.1.5.5.7.48.1 aka OCSP, or if accessLocation is not of the "uniformResourceIdentifier" type. In that case GNUTLS_E_UNKNOWN_ALGORITHM will be returned, and seq should be increased and this function called again.

If what is GNUTLS_IA_CAISSUERS_URI, data will hold the caIssuers URI. Requesting this what value leads to an error if the accessMethod is not 1.3.6.1.5.5.7.48.2 aka caIssuers, or if accessLocation is not of the "uniformResourceIdentifier" type. In that case handle as in GNUTLS_IA_OCSP_URI.

More what values may be allocated in the future as needed.

If data is NULL, the function does the same without storing the output data, that is, it will set critical and do error checking as usual.

The value of the critical flag is returned in *critical . Supply a NULL critical if you want the function to make sure the extension is non-critical, as required by RFC 5280.

Since: 3.0

gnutls_x509_name_constraints_check ()

unsigned
gnutls_x509_name_constraints_check (gnutls_x509_name_constraints_t nc,
                                    gnutls_x509_subject_alt_name_t type,
                                    const gnutls_datum_t *name);

This function will check the provided name against the constraints in nc using the RFC5280 rules. Currently this function is limited to DNS names, emails and IP addresses (of type GNUTLS_SAN_DNSNAME, GNUTLS_SAN_RFC822NAME and GNUTLS_SAN_IPADDRESS).

Since: 3.3.0

gnutls_x509_name_constraints_check_crt ()

unsigned
gnutls_x509_name_constraints_check_crt
                               (gnutls_x509_name_constraints_t nc,
                                gnutls_x509_subject_alt_name_t type,
                                gnutls_x509_crt_t crt);

This function will check the provided certificate names against the constraints in nc using the RFC5280 rules. It will traverse all the certificate's names and alternative names.

Currently this function is limited to DNS names and emails (of type GNUTLS_SAN_DNSNAME and GNUTLS_SAN_RFC822NAME).

Since: 3.3.0

gnutls_x509_name_constraints_init ()

int
gnutls_x509_name_constraints_init (gnutls_x509_name_constraints_t *nc);

This function will initialize a name constraints type.

Since: 3.3.0

gnutls_x509_name_constraints_deinit ()

void
gnutls_x509_name_constraints_deinit (gnutls_x509_name_constraints_t nc);

This function will deinitialize a name constraints type.

Since: 3.3.0

gnutls_x509_crt_get_name_constraints ()

int
gnutls_x509_crt_get_name_constraints (gnutls_x509_crt_t crt,
                                      gnutls_x509_name_constraints_t nc,
                                      unsigned int flags,
                                      unsigned int *critical);

This function will return an intermediate type containing the name constraints of the provided CA certificate. That structure can be used in combination with gnutls_x509_name_constraints_check() to verify whether a server's name is in accordance with the constraints.

When the flags is set to GNUTLS_EXT_FLAG_APPEND, then if the nc structure is empty this function will behave identically as if the flag was not set. Otherwise if there are elements in the nc structure then the constraints will be merged with the existing constraints following RFC5280 p6.1.4 (excluded constraints will be appended, permitted will be intersected).

Note that nc must be initialized prior to calling this function.

Since: 3.3.0

gnutls_x509_name_constraints_add_permitted ()

int
gnutls_x509_name_constraints_add_permitted
                               (gnutls_x509_name_constraints_t nc,
                                gnutls_x509_subject_alt_name_t type,
                                const gnutls_datum_t *name);

This function will add a name constraint to the list of permitted constraints. The constraints type can be any of the following types: GNUTLS_SAN_DNSNAME, GNUTLS_SAN_RFC822NAME, GNUTLS_SAN_DN, GNUTLS_SAN_URI, GNUTLS_SAN_IPADDRESS. For the latter, an IP address in network byte order is expected, followed by its network mask.

Since: 3.3.0

gnutls_x509_name_constraints_add_excluded ()

int
gnutls_x509_name_constraints_add_excluded
                               (gnutls_x509_name_constraints_t nc,
                                gnutls_x509_subject_alt_name_t type,
                                const gnutls_datum_t *name);

This function will add a name constraint to the list of excluded constraints. The constraints type can be any of the following types: GNUTLS_SAN_DNSNAME, GNUTLS_SAN_RFC822NAME, GNUTLS_SAN_DN, GNUTLS_SAN_URI, GNUTLS_SAN_IPADDRESS. For the latter, an IP address in network byte order is expected, followed by its network mask (which is 4 bytes in IPv4 or 16-bytes in IPv6).

Since: 3.3.0

gnutls_x509_crt_set_name_constraints ()

int
gnutls_x509_crt_set_name_constraints (gnutls_x509_crt_t crt,
                                      gnutls_x509_name_constraints_t nc,
                                      unsigned int critical);

This function will set the provided name constraints to the certificate extension list. This extension is always marked as critical.

Since: 3.3.0

gnutls_x509_name_constraints_get_permitted ()

int
gnutls_x509_name_constraints_get_permitted
                               (gnutls_x509_name_constraints_t nc,
                                unsigned  idx,
                                unsigned *type,
                                gnutls_datum_t *name);

This function will return an intermediate type containing the name constraints of the provided CA certificate. That structure can be used in combination with gnutls_x509_name_constraints_check() to verify whether a server's name is in accordance with the constraints.

The name should be treated as constant and valid for the lifetime of nc .

Since: 3.3.0

gnutls_x509_name_constraints_get_excluded ()

int
gnutls_x509_name_constraints_get_excluded
                               (gnutls_x509_name_constraints_t nc,
                                unsigned  idx,
                                unsigned *type,
                                gnutls_datum_t *name);

This function will return an intermediate type containing the name constraints of the provided CA certificate. That structure can be used in combination with gnutls_x509_name_constraints_check() to verify whether a server's name is in accordance with the constraints.

The name should be treated as constant and valid for the lifetime of nc .

Since: 3.3.0

gnutls_x509_cidr_to_rfc5280 ()

int
gnutls_x509_cidr_to_rfc5280 (const char *cidr,
                             gnutls_datum_t *cidr_rfc5280);

This function will convert text CIDR range with prefix (such as '10.0.0.0/8') to RFC5280 (IP address in network byte order followed by its network mask). Works for both IPv4 and IPv6.

The resulting object is directly usable for IP name constraints usage, for example in functions gnutls_x509_name_constraints_add_permitted or gnutls_x509_name_constraints_add_excluded.

The data in datum needs to be deallocated using gnutls_free().

Since: 3.5.4

gnutls_x509_crt_get_crl_dist_points ()

int
gnutls_x509_crt_get_crl_dist_points (gnutls_x509_crt_t cert,
                                     unsigned int seq,
                                     void *ret,
                                     size_t *ret_size,
                                     unsigned int *reason_flags,
                                     unsigned int *critical);

This function retrieves the CRL distribution points (2.5.29.31), contained in the given certificate in the X509v3 Certificate Extensions.

gnutls_x509_crt_set_crl_dist_points2 ()

int
gnutls_x509_crt_set_crl_dist_points2 (gnutls_x509_crt_t crt,
                                      gnutls_x509_subject_alt_name_t type,
                                      const void *data,
                                      unsigned int data_size,
                                      unsigned int reason_flags);

This function will set the CRL distribution points certificate extension.

Since: 2.6.0

gnutls_x509_crt_set_crl_dist_points ()

int
gnutls_x509_crt_set_crl_dist_points (gnutls_x509_crt_t crt,
                                     gnutls_x509_subject_alt_name_t type,
                                     const void *data_string,
                                     unsigned int reason_flags);

This function will set the CRL distribution points certificate extension.

gnutls_x509_crt_cpy_crl_dist_points ()

int
gnutls_x509_crt_cpy_crl_dist_points (gnutls_x509_crt_t dst,
                                     gnutls_x509_crt_t src);

This function will copy the CRL distribution points certificate extension, from the source to the destination certificate. This may be useful to copy from a CA certificate to issued ones.

gnutls_x509_crl_sign ()

int
gnutls_x509_crl_sign (gnutls_x509_crl_t crl,
                      gnutls_x509_crt_t issuer,
                      gnutls_x509_privkey_t issuer_key);

This function is the same a gnutls_x509_crl_sign2() with no flags, and an appropriate hash algorithm. The hash algorithm used may vary between versions of GnuTLS, and it is tied to the security level of the issuer's public key.

gnutls_x509_crl_sign2 ()

int
gnutls_x509_crl_sign2 (gnutls_x509_crl_t crl,
                       gnutls_x509_crt_t issuer,
                       gnutls_x509_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_crt_get_activation_time ()

time_t
gnutls_x509_crt_get_activation_time (gnutls_x509_crt_t cert);

This function will return the time this Certificate was or will be activated.

gnutls_x509_crt_get_expiration_time ()

time_t
gnutls_x509_crt_get_expiration_time (gnutls_x509_crt_t cert);

This function will return the time this certificate was or will be expired.

gnutls_x509_crt_get_serial ()

int
gnutls_x509_crt_get_serial (gnutls_x509_crt_t cert,
                            void *result,
                            size_t *result_size);

This function will return the X.509 certificate's serial number. This is obtained by the X509 Certificate serialNumber field. Serial is not always a 32 or 64bit number. Some CAs use large serial numbers, thus it may be wise to handle it as something uint8_t.

gnutls_x509_spki_init ()

int
gnutls_x509_spki_init (gnutls_x509_spki_t *spki);

This function will initialize a SubjectPublicKeyInfo structure used in PKIX. The structure is used to set additional parameters in the public key information field of a certificate.

Since: 3.6.0

gnutls_x509_spki_deinit ()

void
gnutls_x509_spki_deinit (gnutls_x509_spki_t spki);

This function will deinitialize a SubjectPublicKeyInfo structure.

Since: 3.6.0

gnutls_x509_spki_get_rsa_pss_params ()

int
gnutls_x509_spki_get_rsa_pss_params (gnutls_x509_spki_t spki,
                                     gnutls_digest_algorithm_t *dig,
                                     unsigned int *salt_size);

This function will get the public key algorithm parameters of RSA-PSS type.

Since: 3.6.0

gnutls_x509_spki_set_rsa_pss_params ()

void
gnutls_x509_spki_set_rsa_pss_params (gnutls_x509_spki_t spki,
                                     gnutls_digest_algorithm_t dig,
                                     unsigned int salt_size);

This function will set the public key parameters for an RSA-PSS algorithm, in the SubjectPublicKeyInfo structure.

Since: 3.6.0

gnutls_x509_crt_get_pk_algorithm ()

int
gnutls_x509_crt_get_pk_algorithm (gnutls_x509_crt_t cert,
                                  unsigned int *bits);

This function will return the public key algorithm of an X.509 certificate.

If bits is non null, it should have enough size to hold the parameters size in bits. For RSA the bits returned is the modulus. For DSA the bits returned are of the public exponent.

Unknown/unsupported algorithms are mapped to GNUTLS_PK_UNKNOWN.

gnutls_x509_crt_set_spki ()

int
gnutls_x509_crt_set_spki (gnutls_x509_crt_t crt,
                          const gnutls_x509_spki_t spki,
                          unsigned int flags);

This function will set the certificate's subject public key information explicitly. This is intended to be used in the cases where a single public key (e.g., RSA) can be used for multiple signature algorithms (RSA PKCS1-1.5, and RSA-PSS).

To export the public key (i.e., the SubjectPublicKeyInfo part), check gnutls_pubkey_import_x509().

Since: 3.6.0

gnutls_x509_crt_get_spki ()

int
gnutls_x509_crt_get_spki (gnutls_x509_crt_t cert,
                          gnutls_x509_spki_t spki,
                          unsigned int flags);

This function will return the public key information of an X.509 certificate. The provided spki must be initialized.

Since: 3.6.0

gnutls_x509_crt_get_pk_rsa_raw ()

int
gnutls_x509_crt_get_pk_rsa_raw (gnutls_x509_crt_t crt,
                                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.

gnutls_x509_crt_get_pk_dsa_raw ()

int
gnutls_x509_crt_get_pk_dsa_raw (gnutls_x509_crt_t crt,
                                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.

gnutls_x509_crt_get_pk_ecc_raw ()

int
gnutls_x509_crt_get_pk_ecc_raw (gnutls_x509_crt_t crt,
                                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 certificate. 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.4.1

gnutls_x509_crt_get_pk_gost_raw ()

int
gnutls_x509_crt_get_pk_gost_raw (gnutls_x509_crt_t crt,
                                 gnutls_ecc_curve_t *curve,
                                 gnutls_digest_algorithm_t *digest,
                                 gnutls_gost_paramset_t *paramset,
                                 gnutls_datum_t *x,
                                 gnutls_datum_t *y);

This function will export the GOST 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.6.3

gnutls_x509_crt_get_subject_alt_name ()

int
gnutls_x509_crt_get_subject_alt_name (gnutls_x509_crt_t cert,
                                      unsigned int seq,
                                      void *san,
                                      size_t *san_size,
                                      unsigned int *critical);

This function retrieves the Alternative Name (2.5.29.17), contained in the given certificate in the X509v3 Certificate Extensions.

When the SAN type is otherName, it will extract the data in the otherName's value field, and GNUTLS_SAN_OTHERNAME is returned. You may use gnutls_x509_crt_get_subject_alt_othername_oid() to get the corresponding OID and the "virtual" SAN types (e.g., GNUTLS_SAN_OTHERNAME_XMPP).

If an otherName OID is known, the data will be decoded. Otherwise the returned data will be DER encoded, and you will have to decode it yourself. Currently, only the RFC 3920 id-on-xmppAddr SAN is recognized.

gnutls_x509_crt_get_subject_alt_name2 ()

int
gnutls_x509_crt_get_subject_alt_name2 (gnutls_x509_crt_t cert,
                                       unsigned int seq,
                                       void *san,
                                       size_t *san_size,
                                       unsigned int *san_type,
                                       unsigned int *critical);

This function will return the alternative names, contained in the given certificate. It is the same as gnutls_x509_crt_get_subject_alt_name() except for the fact that it will return the type of the alternative name in san_type even if the function fails for some reason (i.e. the buffer provided is not enough).

gnutls_x509_crt_get_subject_alt_othername_oid ()

int
gnutls_x509_crt_get_subject_alt_othername_oid
                               (gnutls_x509_crt_t cert,
                                unsigned int seq,
                                void *oid,
                                size_t *oid_size);

This function will extract the type OID of an otherName Subject Alternative Name, contained in the given certificate, and return the type as an enumerated element.

This function is only useful if gnutls_x509_crt_get_subject_alt_name() returned GNUTLS_SAN_OTHERNAME.

If oid is null then only the size will be filled. The oid returned will be null terminated, although oid_size will not account for the trailing null.

gnutls_x509_crt_get_issuer_alt_name ()

int
gnutls_x509_crt_get_issuer_alt_name (gnutls_x509_crt_t cert,
                                     unsigned int seq,
                                     void *ian,
                                     size_t *ian_size,
                                     unsigned int *critical);

This function retrieves the Issuer Alternative Name (2.5.29.18), contained in the given certificate in the X509v3 Certificate Extensions.

When the SAN type is otherName, it will extract the data in the otherName's value field, and GNUTLS_SAN_OTHERNAME is returned. You may use gnutls_x509_crt_get_subject_alt_othername_oid() to get the corresponding OID and the "virtual" SAN types (e.g., GNUTLS_SAN_OTHERNAME_XMPP).

If an otherName OID is known, the data will be decoded. Otherwise the returned data will be DER encoded, and you will have to decode it yourself. Currently, only the RFC 3920 id-on-xmppAddr Issuer AltName is recognized.

Since: 2.10.0

gnutls_x509_crt_get_issuer_alt_name2 ()

int
gnutls_x509_crt_get_issuer_alt_name2 (gnutls_x509_crt_t cert,
                                      unsigned int seq,
                                      void *ian,
                                      size_t *ian_size,
                                      unsigned int *ian_type,
                                      unsigned int *critical);

This function will return the alternative names, contained in the given certificate. It is the same as gnutls_x509_crt_get_issuer_alt_name() except for the fact that it will return the type of the alternative name in ian_type even if the function fails for some reason (i.e. the buffer provided is not enough).

Since: 2.10.0

gnutls_x509_crt_get_issuer_alt_othername_oid ()

int
gnutls_x509_crt_get_issuer_alt_othername_oid
                               (gnutls_x509_crt_t cert,
                                unsigned int seq,
                                void *ret,
                                size_t *ret_size);

This function will extract the type OID of an otherName Subject Alternative Name, contained in the given certificate, and return the type as an enumerated element.

If oid is null then only the size will be filled. The oid returned will be null terminated, although oid_size will not account for the trailing null.

This function is only useful if gnutls_x509_crt_get_issuer_alt_name() returned GNUTLS_SAN_OTHERNAME.

Since: 2.10.0

gnutls_x509_crt_get_ca_status ()

int
gnutls_x509_crt_get_ca_status (gnutls_x509_crt_t cert,
                               unsigned int *critical);

This function will return certificates CA status, by reading the basicConstraints X.509 extension (2.5.29.19). If the certificate is a CA a positive value will be returned, or (0) if the certificate does not have CA flag set.

Use gnutls_x509_crt_get_basic_constraints() if you want to read the pathLenConstraint field too.

gnutls_x509_crt_get_basic_constraints ()

int
gnutls_x509_crt_get_basic_constraints (gnutls_x509_crt_t cert,
                                       unsigned int *critical,
                                       unsigned int *ca,
                                       int *pathlen);

This function will read the certificate's basic constraints, and return the certificates CA status. It reads the basicConstraints X.509 extension (2.5.29.19).

gnutls_x509_crt_get_key_usage ()

int
gnutls_x509_crt_get_key_usage (gnutls_x509_crt_t cert,
                               unsigned int *key_usage,
                               unsigned int *critical);

This function will return certificate's key usage, by reading the keyUsage X.509 extension (2.5.29.15). The key usage value will ORed values of the: GNUTLS_KEY_DIGITAL_SIGNATURE, GNUTLS_KEY_NON_REPUDIATION, GNUTLS_KEY_KEY_ENCIPHERMENT, GNUTLS_KEY_DATA_ENCIPHERMENT, GNUTLS_KEY_KEY_AGREEMENT, GNUTLS_KEY_KEY_CERT_SIGN, GNUTLS_KEY_CRL_SIGN, GNUTLS_KEY_ENCIPHER_ONLY, GNUTLS_KEY_DECIPHER_ONLY.

gnutls_x509_crt_set_key_usage ()

int
gnutls_x509_crt_set_key_usage (gnutls_x509_crt_t crt,
                               unsigned int usage);

This function will set the keyUsage certificate extension.

gnutls_x509_crt_set_authority_info_access ()

int
gnutls_x509_crt_set_authority_info_access
                               (gnutls_x509_crt_t crt,
                                int what,
                                gnutls_datum_t *data);

This function sets the Authority Information Access (AIA) extension, see RFC 5280 section 4.2.2.1 for more information.

The type of data stored in data is specified via what which should be gnutls_info_access_what_t values.

If what is GNUTLS_IA_OCSP_URI, data will hold the OCSP URI. If what is GNUTLS_IA_CAISSUERS_URI, data will hold the caIssuers URI.

Since: 3.0

gnutls_x509_crt_get_inhibit_anypolicy ()

int
gnutls_x509_crt_get_inhibit_anypolicy (gnutls_x509_crt_t cert,
                                       unsigned int *skipcerts,
                                       unsigned int *critical);

This function will return certificate's value of the SkipCerts, i.e., the Inhibit anyPolicy X.509 extension (2.5.29.54).

The returned value is the number of additional certificates that may appear in the path before the anyPolicy is no longer acceptable.

Since: 3.6.0

gnutls_x509_crt_set_inhibit_anypolicy ()

int
gnutls_x509_crt_set_inhibit_anypolicy (gnutls_x509_crt_t crt,
                                       unsigned int skipcerts);

This function will set the Inhibit anyPolicy certificate extension.

gnutls_x509_crt_get_proxy ()

int
gnutls_x509_crt_get_proxy (gnutls_x509_crt_t cert,
                           unsigned int *critical,
                           int *pathlen,
                           char **policyLanguage,
                           char **policy,
                           size_t *sizeof_policy);

This function will get information from a proxy certificate. It reads the ProxyCertInfo X.509 extension (1.3.6.1.5.5.7.1.14).

gnutls_x509_tlsfeatures_init ()

int
gnutls_x509_tlsfeatures_init (gnutls_x509_tlsfeatures_t *features);

This function will initialize a X.509 TLS features extension structure

Since: 3.5.1

gnutls_x509_tlsfeatures_deinit ()

void
gnutls_x509_tlsfeatures_deinit (gnutls_x509_tlsfeatures_t Param1);

This function will deinitialize a X.509 TLS features extension structure

Since: 3.5.1

gnutls_x509_tlsfeatures_get ()

int
gnutls_x509_tlsfeatures_get (gnutls_x509_tlsfeatures_t f,
                             unsigned  idx,
                             unsigned int *feature);

This function will get a feature from the X.509 TLS features extension structure.

Since: 3.5.1

gnutls_x509_crt_set_tlsfeatures ()

int
gnutls_x509_crt_set_tlsfeatures (gnutls_x509_crt_t crt,
                                 gnutls_x509_tlsfeatures_t features);

This function will set the certificates X.509 TLS extension from the given structure.

Since: 3.5.1

gnutls_x509_crt_get_tlsfeatures ()

int
gnutls_x509_crt_get_tlsfeatures (gnutls_x509_crt_t cert,
                                 gnutls_x509_tlsfeatures_t features,
                                 unsigned int flags,
                                 unsigned int *critical);

This function will get the X.509 TLS features extension structure from the certificate. The returned structure needs to be freed using gnutls_x509_tlsfeatures_deinit().

When the flags is set to GNUTLS_EXT_FLAG_APPEND, then if the features structure is empty this function will behave identically as if the flag was not set. Otherwise if there are elements in the features structure then they will be merged with.

Note that features must be initialized prior to calling this function.