GNUTLS_OID_X520_COUNTRY_NAME

#define GNUTLS_OID_X520_COUNTRY_NAME		"2.5.4.6"

GNUTLS_OID_X520_ORGANIZATION_NAME

#define GNUTLS_OID_X520_ORGANIZATION_NAME "2.5.4.10"

GNUTLS_OID_X520_ORGANIZATIONAL_UNIT_NAME

#define GNUTLS_OID_X520_ORGANIZATIONAL_UNIT_NAME "2.5.4.11"

GNUTLS_OID_X520_COMMON_NAME

#define GNUTLS_OID_X520_COMMON_NAME		"2.5.4.3"

GNUTLS_OID_X520_LOCALITY_NAME

#define GNUTLS_OID_X520_LOCALITY_NAME		"2.5.4.7"

GNUTLS_OID_X520_STATE_OR_PROVINCE_NAME

#define GNUTLS_OID_X520_STATE_OR_PROVINCE_NAME "2.5.4.8"

GNUTLS_OID_X520_INITIALS

#define GNUTLS_OID_X520_INITIALS		"2.5.4.43"

GNUTLS_OID_X520_GENERATION_QUALIFIER

#define GNUTLS_OID_X520_GENERATION_QUALIFIER "2.5.4.44"

GNUTLS_OID_X520_SURNAME

#define GNUTLS_OID_X520_SURNAME			"2.5.4.4"

GNUTLS_OID_X520_GIVEN_NAME

#define GNUTLS_OID_X520_GIVEN_NAME		"2.5.4.42"

GNUTLS_OID_X520_TITLE

#define GNUTLS_OID_X520_TITLE			"2.5.4.12"

GNUTLS_OID_X520_DN_QUALIFIER

#define GNUTLS_OID_X520_DN_QUALIFIER		"2.5.4.46"

GNUTLS_OID_X520_PSEUDONYM

#define GNUTLS_OID_X520_PSEUDONYM		"2.5.4.65"

GNUTLS_OID_X520_POSTALCODE

#define GNUTLS_OID_X520_POSTALCODE              "2.5.4.17"

GNUTLS_OID_X520_NAME

#define GNUTLS_OID_X520_NAME                    "2.5.4.41"

GNUTLS_OID_LDAP_DC

#define GNUTLS_OID_LDAP_DC			"0.9.2342.19200300.100.1.25"

GNUTLS_OID_LDAP_UID

#define GNUTLS_OID_LDAP_UID			"0.9.2342.19200300.100.1.1"

GNUTLS_OID_PKCS9_EMAIL

#define GNUTLS_OID_PKCS9_EMAIL			"1.2.840.113549.1.9.1"

GNUTLS_OID_PKIX_DATE_OF_BIRTH

#define GNUTLS_OID_PKIX_DATE_OF_BIRTH		"1.3.6.1.5.5.7.9.1"

GNUTLS_OID_PKIX_PLACE_OF_BIRTH

#define GNUTLS_OID_PKIX_PLACE_OF_BIRTH		"1.3.6.1.5.5.7.9.2"

GNUTLS_OID_PKIX_GENDER

#define GNUTLS_OID_PKIX_GENDER			"1.3.6.1.5.5.7.9.3"

GNUTLS_OID_PKIX_COUNTRY_OF_CITIZENSHIP

#define GNUTLS_OID_PKIX_COUNTRY_OF_CITIZENSHIP "1.3.6.1.5.5.7.9.4"

GNUTLS_OID_PKIX_COUNTRY_OF_RESIDENCE

#define GNUTLS_OID_PKIX_COUNTRY_OF_RESIDENCE "1.3.6.1.5.5.7.9.5"

GNUTLS_KP_TLS_WWW_SERVER

#define GNUTLS_KP_TLS_WWW_SERVER		"1.3.6.1.5.5.7.3.1"

GNUTLS_KP_TLS_WWW_CLIENT

#define GNUTLS_KP_TLS_WWW_CLIENT                "1.3.6.1.5.5.7.3.2"

GNUTLS_KP_CODE_SIGNING

#define GNUTLS_KP_CODE_SIGNING			"1.3.6.1.5.5.7.3.3"

GNUTLS_KP_EMAIL_PROTECTION

#define GNUTLS_KP_EMAIL_PROTECTION		"1.3.6.1.5.5.7.3.4"

GNUTLS_KP_TIME_STAMPING

#define GNUTLS_KP_TIME_STAMPING			"1.3.6.1.5.5.7.3.8"

GNUTLS_KP_OCSP_SIGNING

#define GNUTLS_KP_OCSP_SIGNING			"1.3.6.1.5.5.7.3.9"

GNUTLS_KP_ANY

#define GNUTLS_KP_ANY				"2.5.29.37.0"

GNUTLS_FSAN_SET

#define GNUTLS_FSAN_SET 0

GNUTLS_FSAN_APPEND

#define GNUTLS_FSAN_APPEND 1

enum gnutls_certificate_import_flags

typedef enum {
    GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED = 1,
    GNUTLS_X509_CRT_LIST_FAIL_IF_UNSORTED = 2
} gnutls_certificate_import_flags;

Enumeration of different certificate import flags.

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

gnutls_x509_crt_get_issuer_dn_oid ()

int                 gnutls_x509_crt_get_issuer_dn_oid   (gnutls_x509_crt_t cert,
                                                         int 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,
                                                         int 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.

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

gnutls_x509_crt_get_dn_oid ()

int                 gnutls_x509_crt_get_dn_oid          (gnutls_x509_crt_t cert,
                                                         int 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,
                                                         int 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 ()

int                 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 RFC2818 (HTTPS), which takes into account wildcards, and the DNSName/IPAddress subject alternative name PKIX extension.

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.

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_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_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_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_CRL_REASON_SUPERSEEDED

#define GNUTLS_CRL_REASON_SUPERSEEDED GNUTLS_CRL_REASON_SUPERSEDED,

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

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_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_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_dn_oid_known ()

int                 gnutls_x509_dn_oid_known            (const char *oid);

This function will inform about known DN OIDs. This is useful since functions like gnutls_x509_crt_set_dn_by_oid() use the information on known OIDs to properly encode their input. Object Identifiers that are not known are not encoded by these functions, and their input is stored directly into the ASN.1 structure. In that case of unknown OIDs, you have the responsibility of DER encoding your data.

gnutls_x509_crt_get_extension_oid ()

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

This function will return the requested extension OID in the certificate. The extension OID will be stored as a string in the provided buffer.

The oid returned will be null terminated, although oid_size will not account for the trailing null.

gnutls_x509_crt_get_extension_by_oid ()

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

This function will return the extension specified by the OID in the certificate. The extensions will be returned as binary data DER encoded, in the provided buffer.

gnutls_x509_crt_get_extension_info ()

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

This function will return the requested extension OID in the certificate, and the critical flag for it. The extension OID will be stored as a string in the provided buffer. Use gnutls_x509_crt_get_extension_data() to extract the data.

If the buffer provided is not long enough to hold the output, then oid_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned. The oid returned will be null terminated, although oid_size will not account for the trailing null.

gnutls_x509_crt_get_extension_data ()

int                 gnutls_x509_crt_get_extension_data  (gnutls_x509_crt_t cert,
                                                         int indx,
                                                         void *data,
                                                         size_t *sizeof_data);

This function will return the requested extension data in the certificate. The extension data will be stored as a string in the provided buffer.

Use gnutls_x509_crt_get_extension_info() to extract the OID and critical flag. Use gnutls_x509_crt_get_extension_by_oid() instead, if you want to get data indexed by the extension OID rather than sequence.

gnutls_x509_crt_set_extension_by_oid ()

int                 gnutls_x509_crt_set_extension_by_oid
                                                        (gnutls_x509_crt_t crt,
                                                         const char *oid,
                                                         const void *buf,
                                                         size_t sizeof_buf,
                                                         unsigned int critical);

This function will set an the extension, by the specified OID, in the certificate. The extension data should be binary data DER encoded.

gnutls_x509_crt_set_dn_by_oid ()

int                 gnutls_x509_crt_set_dn_by_oid       (gnutls_x509_crt_t crt,
                                                         const char *oid,
                                                         unsigned int raw_flag,
                                                         const void *name,
                                                         unsigned int sizeof_name);

This function will set the part of the name of the Certificate subject, specified by the given OID. The input string should be ASCII or UTF-8 encoded.

Some helper macros with popular OIDs can be found in gnutls/x509.h With this function you can only set the known OIDs. You can test for known OIDs using gnutls_x509_dn_oid_known(). For OIDs that are not known (by gnutls) you should properly DER encode your data, and call this function with raw_flag set.

gnutls_x509_crt_set_issuer_dn_by_oid ()

int                 gnutls_x509_crt_set_issuer_dn_by_oid
                                                        (gnutls_x509_crt_t crt,
                                                         const char *oid,
                                                         unsigned int raw_flag,
                                                         const void *name,
                                                         unsigned int sizeof_name);

This function will set the part of the name of the Certificate issuer, specified by the given OID. The input string should be ASCII or UTF-8 encoded.

Some helper macros with popular OIDs can be found in gnutls/x509.h With this function you can only set the known OIDs. You can test for known OIDs using gnutls_x509_dn_oid_known(). For OIDs that are not known (by gnutls) you should properly DER encode your data, and call this function with raw_flag set.

Normally you do not need to call this function, since the signing operation will copy the signer's name as the issuer of the certificate.

gnutls_x509_crt_set_version ()

int                 gnutls_x509_crt_set_version         (gnutls_x509_crt_t crt,
                                                         unsigned int version);

This function will set the version of the certificate. This must be one for X.509 version 1, and so on. Plain certificates without extensions must have version set to one.

To create well-formed certificates, you must specify version 3 if you use any certificate extensions. Extensions are created by functions such as gnutls_x509_crt_set_subject_alt_name() or gnutls_x509_crt_set_key_usage().

gnutls_x509_crt_set_key ()

int                 gnutls_x509_crt_set_key             (gnutls_x509_crt_t crt,
                                                         gnutls_x509_privkey_t key);

This function will set the public parameters from the given private key to the certificate. Only RSA keys are currently supported.

gnutls_x509_crt_set_ca_status ()

int                 gnutls_x509_crt_set_ca_status       (gnutls_x509_crt_t crt,
                                                         unsigned int ca);

This function will set the basicConstraints certificate extension. Use gnutls_x509_crt_set_basic_constraints() if you want to control the pathLenConstraint field too.

gnutls_x509_crt_set_basic_constraints ()

int                 gnutls_x509_crt_set_basic_constraints
                                                        (gnutls_x509_crt_t crt,
                                                         unsigned int ca,
                                                         int pathLenConstraint);

This function will set the basicConstraints certificate extension.

gnutls_x509_crt_set_subject_alternative_name ()

int                 gnutls_x509_crt_set_subject_alternative_name
                                                        (gnutls_x509_crt_t crt,
                                                         gnutls_x509_subject_alt_name_t type,
                                                         const char *data_string);

This function will set the subject alternative name certificate extension. This function assumes that data can be expressed as a null terminated string.

The name of the function is unfortunate since it is incosistent with gnutls_x509_crt_get_subject_alt_name().

gnutls_x509_crt_set_subject_alt_name ()

int                 gnutls_x509_crt_set_subject_alt_name
                                                        (gnutls_x509_crt_t crt,
                                                         gnutls_x509_subject_alt_name_t type,
                                                         const void *data,
                                                         unsigned int data_size,
                                                         unsigned int flags);

This function will set the subject alternative name certificate extension. It can set the following types:

GNUTLS_SAN_DNSNAME: as a text string

GNUTLS_SAN_RFC822NAME: as a text string

GNUTLS_SAN_URI: as a text string

GNUTLS_SAN_IPADDRESS: as a binary IP address (4 or 16 bytes)

Other values can be set as binary values with the proper DER encoding.

Since 2.6.0

gnutls_x509_crt_sign ()

int                 gnutls_x509_crt_sign                (gnutls_x509_crt_t crt,
                                                         gnutls_x509_crt_t issuer,
                                                         gnutls_x509_privkey_t issuer_key);

This function is the same a gnutls_x509_crt_sign2() with no flags, and SHA1 as the hash algorithm.

gnutls_x509_crt_sign2 ()

int                 gnutls_x509_crt_sign2               (gnutls_x509_crt_t crt,
                                                         gnutls_x509_crt_t issuer,
                                                         gnutls_x509_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.

gnutls_x509_crt_set_activation_time ()

int                 gnutls_x509_crt_set_activation_time (gnutls_x509_crt_t cert,
                                                         time_t act_time);

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

gnutls_x509_crt_set_expiration_time ()

int                 gnutls_x509_crt_set_expiration_time (gnutls_x509_crt_t cert,
                                                         time_t exp_time);

This function will set the time this Certificate will expire.

gnutls_x509_crt_set_serial ()

int                 gnutls_x509_crt_set_serial          (gnutls_x509_crt_t cert,
                                                         const void *serial,
                                                         size_t serial_size);

This function will set the X.509 certificate's serial number. 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_crt_set_subject_key_id ()

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

This function will set the X.509 certificate's subject key ID extension.

gnutls_x509_crt_set_proxy_dn ()

int                 gnutls_x509_crt_set_proxy_dn        (gnutls_x509_crt_t crt,
                                                         gnutls_x509_crt_t eecrt,
                                                         unsigned int raw_flag,
                                                         const void *name,
                                                         unsigned int sizeof_name);

This function will set the subject in crt to the end entity's eecrt subject name, and add a single Common Name component name of size sizeof_name. This corresponds to the required proxy certificate naming style. Note that if name is NULL, you MUST set it later by using gnutls_x509_crt_set_dn_by_oid() or similar.

gnutls_x509_crt_set_proxy ()

int                 gnutls_x509_crt_set_proxy           (gnutls_x509_crt_t crt,
                                                         int pathLenConstraint,
                                                         const char *policyLanguage,
                                                         const char *policy,
                                                         size_t sizeof_policy);

This function will set the proxyCertInfo extension.

gnutls_x509_crt_print ()

int                 gnutls_x509_crt_print               (gnutls_x509_crt_t cert,
                                                         gnutls_certificate_print_formats_t format,
                                                         gnutls_datum_t *out);

This function will pretty print a X.509 certificate, suitable for display to a human.

If the format is GNUTLS_CRT_PRINT_FULL then all fields of the certificate will be output, on multiple lines. The GNUTLS_CRT_PRINT_ONELINE format will generate one line with some selected fields, which is useful for logging purposes.

The output out needs to be deallocated using gnutls_free().

gnutls_x509_crl_print ()

int                 gnutls_x509_crl_print               (gnutls_x509_crl_t crl,
                                                         gnutls_certificate_print_formats_t format,
                                                         gnutls_datum_t *out);

This function will pretty print a X.509 certificate revocation list, suitable for display to a human.

The output out needs to be deallocated using gnutls_free().

gnutls_x509_crt_get_raw_issuer_dn ()

int                 gnutls_x509_crt_get_raw_issuer_dn   (gnutls_x509_crt_t cert,
                                                         gnutls_datum_t *start);

This function will return a pointer to the DER encoded DN structure and the length. This points to allocated data that must be free'd using gnutls_free().

gnutls_x509_crt_get_raw_dn ()

int                 gnutls_x509_crt_get_raw_dn          (gnutls_x509_crt_t cert,
                                                         gnutls_datum_t *start);

This function will return a pointer to the DER encoded DN structure and the length. This points to allocated data that must be free'd using gnutls_free().

gnutls_x509_rdn_get ()

int                 gnutls_x509_rdn_get                 (const gnutls_datum_t *idn,
                                                         char *buf,
                                                         size_t *sizeof_buf);

This function will return the name of the given RDN sequence. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC4514.

gnutls_x509_rdn_get_oid ()

int                 gnutls_x509_rdn_get_oid             (const gnutls_datum_t *idn,
                                                         int indx,
                                                         void *buf,
                                                         size_t *sizeof_buf);

This function will return the specified Object identifier, of the RDN sequence.

Since 2.4.0

gnutls_x509_rdn_get_by_oid ()

int                 gnutls_x509_rdn_get_by_oid          (const gnutls_datum_t *idn,
                                                         const char *oid,
                                                         int indx,
                                                         unsigned int raw_flag,
                                                         void *buf,
                                                         size_t *sizeof_buf);

This function will return the name of the given Object identifier, of the RDN sequence. The name will be encoded using the rules from RFC4514.

gnutls_x509_dn_t

  typedef void *gnutls_x509_dn_t;

gnutls_x509_crt_get_subject ()

int                 gnutls_x509_crt_get_subject         (gnutls_x509_crt_t cert,
                                                         gnutls_x509_dn_t *dn);

Return the Certificate's Subject DN as a gnutls_x509_dn_t data type, that can be decoded using gnutls_x509_dn_get_rdn_ava().

Note that dn should be treated as constant. Because it points into the cert object, you should not use dn after cert is deallocated.

gnutls_x509_crt_get_issuer ()

int                 gnutls_x509_crt_get_issuer          (gnutls_x509_crt_t cert,
                                                         gnutls_x509_dn_t *dn);

Return the Certificate's Issuer DN as a gnutls_x509_dn_t data type, that can be decoded using gnutls_x509_dn_get_rdn_ava().

Note that dn should be treated as constant. Because it points into the cert object, you should not use dn after cert is deallocated.

gnutls_x509_dn_get_rdn_ava ()

int                 gnutls_x509_dn_get_rdn_ava          (gnutls_x509_dn_t dn,
                                                         int irdn,
                                                         int iava,
                                                         gnutls_x509_ava_st *ava);

Get pointers to data within the DN. The format of the ava structure is shown below.

struct gnutls_x509_ava_st { gnutls_datum_t oid; gnutls_datum_t value; unsigned long value_tag; };

The X.509 distinguished name is a sequence of sequences of strings and this is what the irdn and iava indexes model.

Note that ava will contain pointers into the dn structure, so you should not modify any data or deallocate it. Note also that the DN in turn points into the original certificate structure, and thus you may not deallocate the certificate and continue to access dn.

gnutls_x509_dn_init ()

int                 gnutls_x509_dn_init                 (gnutls_x509_dn_t *dn);

This function initializes a gnutls_x509_dn_t structure.

The object returned must be deallocated using gnutls_x509_dn_deinit().

Since 2.4.0

gnutls_x509_dn_import ()

int                 gnutls_x509_dn_import               (gnutls_x509_dn_t dn,
                                                         const gnutls_datum_t *data);

This function parses an RDN sequence and stores the result to a gnutls_x509_dn_t structure. The structure must have been initialized with gnutls_x509_dn_init(). You may use gnutls_x509_dn_get_rdn_ava() to decode the DN.

Since 2.4.0

gnutls_x509_dn_export ()

int                 gnutls_x509_dn_export               (gnutls_x509_dn_t dn,
                                                         gnutls_x509_crt_fmt_t format,
                                                         void *output_data,
                                                         size_t *output_data_size);

This function will export the DN 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 NAME".

gnutls_x509_dn_deinit ()

void                gnutls_x509_dn_deinit               (gnutls_x509_dn_t dn);

This function deallocates the DN object as returned by gnutls_x509_dn_import().

Since 2.4.0

gnutls_x509_crl_init ()

int                 gnutls_x509_crl_init                (gnutls_x509_crl_t *crl);

This function will initialize a CRL structure. CRL stands for Certificate Revocation List. A revocation list usually contains lists of certificate serial numbers that have been revoked by an Authority. The revocation lists are always signed with the authority's private key.