gnutls_ocsp_req_add_cert ()

int
gnutls_ocsp_req_add_cert (gnutls_ocsp_req_t req,
                          gnutls_digest_algorithm_t digest,
                          gnutls_x509_crt_t issuer,
                          gnutls_x509_crt_t cert);

This function will add another request to the OCSP request for a particular certificate. The issuer name hash, issuer key hash, and serial number fields is populated as follows. The issuer name and the serial number is taken from cert . The issuer key is taken from issuer . The hashed values will be hashed using the digest algorithm, normally GNUTLS_DIG_SHA1.

gnutls_ocsp_req_add_cert_id ()

int
gnutls_ocsp_req_add_cert_id (gnutls_ocsp_req_t req,
                             gnutls_digest_algorithm_t digest,
                             const gnutls_datum_t *issuer_name_hash,
                             const gnutls_datum_t *issuer_key_hash,
                             const gnutls_datum_t *serial_number);

This function will add another request to the OCSP request for a particular certificate having the issuer name hash of issuer_name_hash and issuer key hash of issuer_key_hash (both hashed using digest ) and serial number serial_number .

The information needed corresponds to the CertID structure:

1
2
3
4
5

CertID	  ::=     SEQUENCE {
hashAlgorithm       AlgorithmIdentifier,
issuerNameHash      OCTET STRING, -- Hash of Issuer's DN
issuerKeyHash       OCTET STRING, -- Hash of Issuers public key
serialNumber	CertificateSerialNumber }

gnutls_ocsp_req_deinit ()

void
gnutls_ocsp_req_deinit (gnutls_ocsp_req_t req);

This function will deinitialize a OCSP request structure.

gnutls_ocsp_req_export ()

int
gnutls_ocsp_req_export (gnutls_ocsp_req_t req,
                        gnutls_datum_t *data);

This function will export the OCSP request to DER format.

gnutls_ocsp_req_get_cert_id ()

int
gnutls_ocsp_req_get_cert_id (gnutls_ocsp_req_t req,
                             unsigned  indx,
                             gnutls_digest_algorithm_t *digest,
                             gnutls_datum_t *issuer_name_hash,
                             gnutls_datum_t *issuer_key_hash,
                             gnutls_datum_t *serial_number);

This function will return the certificate information of the indx 'ed request in the OCSP request. The information returned corresponds to the CertID structure:

1
2
3
4
5

CertID	  ::=     SEQUENCE {
hashAlgorithm       AlgorithmIdentifier,
issuerNameHash      OCTET STRING, -- Hash of Issuer's DN
issuerKeyHash       OCTET STRING, -- Hash of Issuers public key
serialNumber	CertificateSerialNumber }

Each of the pointers to output variables may be NULL to indicate that the caller is not interested in that value.

gnutls_ocsp_req_get_extension ()

int
gnutls_ocsp_req_get_extension (gnutls_ocsp_req_t req,
                               unsigned  indx,
                               gnutls_datum_t *oid,
                               unsigned int *critical,
                               gnutls_datum_t *data);

This function will return all information about the requested extension in the OCSP request. The information returned is the OID, the critical flag, and the data itself. The extension OID will be stored as a string. Any of oid , critical , and data may be NULL which means that the caller is not interested in getting that information back.

The caller needs to deallocate memory by calling gnutls_free() on oid->data and data->data .

gnutls_ocsp_req_get_nonce ()

int
gnutls_ocsp_req_get_nonce (gnutls_ocsp_req_t req,
                           unsigned int *critical,
                           gnutls_datum_t *nonce);

This function will return the OCSP request nonce extension data.

The caller needs to deallocate memory by calling gnutls_free() on nonce->data .

gnutls_ocsp_req_get_version ()

int
gnutls_ocsp_req_get_version (gnutls_ocsp_req_t req);

This function will return the version of the OCSP request. Typically this is always 1 indicating version 1.

gnutls_ocsp_req_import ()

int
gnutls_ocsp_req_import (gnutls_ocsp_req_t req,
                        const gnutls_datum_t *data);

This function will convert the given DER encoded OCSP request to the native gnutls_ocsp_req_t format. The output will be stored in req .

gnutls_ocsp_req_init ()

int
gnutls_ocsp_req_init (gnutls_ocsp_req_t *req);

This function will initialize an OCSP request structure.

gnutls_ocsp_req_print ()

int
gnutls_ocsp_req_print (gnutls_ocsp_req_t req,
                       gnutls_ocsp_print_formats_t format,
                       gnutls_datum_t *out);

This function will pretty print a OCSP request, suitable for display to a human.

If the format is GNUTLS_OCSP_PRINT_FULL then all fields of the request will be output, on multiple lines.

The output out->data needs to be deallocate using gnutls_free().

gnutls_ocsp_req_randomize_nonce ()

int
gnutls_ocsp_req_randomize_nonce (gnutls_ocsp_req_t req);

This function will add or update an nonce extension to the OCSP request with a newly generated random value.

gnutls_ocsp_req_set_extension ()

int
gnutls_ocsp_req_set_extension (gnutls_ocsp_req_t req,
                               const char *oid,
                               unsigned int critical,
                               const gnutls_datum_t *data);

This function will add an extension to the OCSP request. Calling this function multiple times for the same OID will overwrite values from earlier calls.

gnutls_ocsp_req_set_nonce ()

int
gnutls_ocsp_req_set_nonce (gnutls_ocsp_req_t req,
                           unsigned int critical,
                           const gnutls_datum_t *nonce);

This function will add an nonce extension to the OCSP request. Calling this function multiple times will overwrite values from earlier calls.

gnutls_ocsp_resp_check_crt ()

int
gnutls_ocsp_resp_check_crt (gnutls_ocsp_resp_t resp,
                            unsigned int indx,
                            gnutls_x509_crt_t crt);

This function will check whether the OCSP response is about the provided certificate.

Since: 3.1.3

gnutls_ocsp_resp_deinit ()

void
gnutls_ocsp_resp_deinit (gnutls_ocsp_resp_t resp);

This function will deinitialize a OCSP response structure.

gnutls_ocsp_resp_export ()

int
gnutls_ocsp_resp_export (gnutls_ocsp_resp_t resp,
                         gnutls_datum_t *data);

This function will export the OCSP response to DER format.

gnutls_ocsp_resp_get_certs ()

int
gnutls_ocsp_resp_get_certs (gnutls_ocsp_resp_t resp,
                            gnutls_x509_crt_t **certs,
                            size_t *ncerts);

This function will extract the X.509 certificates found in the Basic OCSP Response. The certs output variable will hold a newly allocated zero-terminated array with X.509 certificates.

Every certificate in the array needs to be de-allocated with gnutls_x509_crt_deinit() and the array itself must be freed using gnutls_free().

Both the certs and ncerts variables may be NULL. Then the function will work as normal but will not return the NULL:d information. This can be used to get the number of certificates only, or to just get the certificate array without its size.

gnutls_ocsp_resp_get_extension ()

int
gnutls_ocsp_resp_get_extension (gnutls_ocsp_resp_t resp,
                                unsigned  indx,
                                gnutls_datum_t *oid,
                                unsigned int *critical,
                                gnutls_datum_t *data);

This function will return all information about the requested extension in the OCSP response. The information returned is the OID, the critical flag, and the data itself. The extension OID will be stored as a string. Any of oid , critical , and data may be NULL which means that the caller is not interested in getting that information back.

The caller needs to deallocate memory by calling gnutls_free() on oid->data and data->data .

gnutls_ocsp_resp_get_nonce ()

int
gnutls_ocsp_resp_get_nonce (gnutls_ocsp_resp_t resp,
                            unsigned int *critical,
                            gnutls_datum_t *nonce);

This function will return the Basic OCSP Response nonce extension data.

The caller needs to deallocate memory by calling gnutls_free() on nonce->data .

gnutls_ocsp_resp_get_produced ()

time_t
gnutls_ocsp_resp_get_produced (gnutls_ocsp_resp_t resp);

This function will return the time when the OCSP response was signed.

gnutls_ocsp_resp_get_responder ()

int
gnutls_ocsp_resp_get_responder (gnutls_ocsp_resp_t resp,
                                gnutls_datum_t *dn);

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

If the responder ID is not a name but a hash, this function will return zero and the dn elements will be set to NULL.

The caller needs to deallocate memory by calling gnutls_free() on dn->data .

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

gnutls_ocsp_resp_get_response ()

int
gnutls_ocsp_resp_get_response (gnutls_ocsp_resp_t resp,
                               gnutls_datum_t *response_type_oid,
                               gnutls_datum_t *response);

This function will extract the response type OID in and the response data from an OCSP response. Normally the response_type_oid is always "1.3.6.1.5.5.7.48.1.1" which means the response should be decoded as a Basic OCSP Response, but technically other response types could be used.

This function is typically only useful when you want to extract the response type OID of an response for diagnostic purposes. Otherwise gnutls_ocsp_resp_import() will decode the basic OCSP response part and the caller need not worry about that aspect.

gnutls_ocsp_resp_get_signature ()

int
gnutls_ocsp_resp_get_signature (gnutls_ocsp_resp_t resp,
                                gnutls_datum_t *sig);

This function will extract the signature field of a OCSP response.

gnutls_ocsp_resp_get_signature_algorithm ()

int
gnutls_ocsp_resp_get_signature_algorithm
                               (gnutls_ocsp_resp_t resp);

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

gnutls_ocsp_resp_get_single ()

int
gnutls_ocsp_resp_get_single (gnutls_ocsp_resp_t resp,
                             unsigned  indx,
                             gnutls_digest_algorithm_t *digest,
                             gnutls_datum_t *issuer_name_hash,
                             gnutls_datum_t *issuer_key_hash,
                             gnutls_datum_t *serial_number,
                             unsigned int *cert_status,
                             time_t *this_update,
                             time_t *next_update,
                             time_t *revocation_time,
                             unsigned int *revocation_reason);

This function will return the certificate information of the indx 'ed response in the Basic OCSP Response resp . The information returned corresponds to the OCSP SingleResponse structure except the final singleExtensions.

Each of the pointers to output variables may be NULL to indicate that the caller is not interested in that value.

gnutls_ocsp_resp_get_status ()

int
gnutls_ocsp_resp_get_status (gnutls_ocsp_resp_t resp);

This function will return the status of a OCSP response, an gnutls_ocsp_resp_status_t enumeration.

gnutls_ocsp_resp_get_version ()

int
gnutls_ocsp_resp_get_version (gnutls_ocsp_resp_t resp);

This function will return the version of the Basic OCSP Response. Typically this is always 1 indicating version 1.

gnutls_ocsp_resp_import ()

int
gnutls_ocsp_resp_import (gnutls_ocsp_resp_t resp,
                         const gnutls_datum_t *data);

This function will convert the given DER encoded OCSP response to the native gnutls_ocsp_resp_t format. It also decodes the Basic OCSP Response part, if any. The output will be stored in resp .

gnutls_ocsp_resp_init ()

int
gnutls_ocsp_resp_init (gnutls_ocsp_resp_t *resp);

This function will initialize an OCSP response structure.

gnutls_ocsp_resp_print ()

int
gnutls_ocsp_resp_print (gnutls_ocsp_resp_t resp,
                        gnutls_ocsp_print_formats_t format,
                        gnutls_datum_t *out);

This function will pretty print a OCSP response, suitable for display to a human.

If the format is GNUTLS_OCSP_PRINT_FULL then all fields of the response will be output, on multiple lines.

The output out->data needs to be deallocate using gnutls_free().

gnutls_ocsp_resp_verify ()

int
gnutls_ocsp_resp_verify (gnutls_ocsp_resp_t resp,
                         gnutls_x509_trust_list_t trustlist,
                         unsigned int *verify,
                         unsigned int flags);

Verify signature of the Basic OCSP Response against the public key in the certificate of a trusted signer. The trustlist should be populated with trust anchors. The function will extract the signer certificate from the Basic OCSP Response and will verify it against the trustlist . A trusted signer is a certificate that is either in trustlist , or it is signed directly by a certificate in trustlist and has the id-ad-ocspSigning Extended Key Usage bit set.

The output verify variable will hold verification status codes (e.g., GNUTLS_OCSP_VERIFY_SIGNER_NOT_FOUND, GNUTLS_OCSP_VERIFY_INSECURE_ALGORITHM) which are only valid if the function returned GNUTLS_E_SUCCESS.

Note that the function returns GNUTLS_E_SUCCESS even when verification failed. The caller must always inspect the verify variable to find out the verification status.

The flags variable should be 0 for now.

gnutls_ocsp_resp_verify_direct ()

int
gnutls_ocsp_resp_verify_direct (gnutls_ocsp_resp_t resp,
                                gnutls_x509_crt_t issuer,
                                unsigned int *verify,
                                unsigned int flags);

Verify signature of the Basic OCSP Response against the public key in the issuer certificate.

The output verify variable will hold verification status codes (e.g., GNUTLS_OCSP_VERIFY_SIGNER_NOT_FOUND, GNUTLS_OCSP_VERIFY_INSECURE_ALGORITHM) which are only valid if the function returned GNUTLS_E_SUCCESS.

Note that the function returns GNUTLS_E_SUCCESS even when verification failed. The caller must always inspect the verify variable to find out the verification status.

The flags variable should be 0 for now.

GNUTLS_OCSP_NONCE

#define GNUTLS_OCSP_NONCE "1.3.6.1.5.5.7.48.1.2"

enum gnutls_ocsp_cert_status_t

Enumeration of different OCSP response certificate status codes.

enum gnutls_ocsp_print_formats_t

Enumeration of different OCSP printing variants.

struct gnutls_ocsp_req_int

struct gnutls_ocsp_req_int;

gnutls_ocsp_req_t

typedef struct gnutls_ocsp_req_int *gnutls_ocsp_req_t;

struct gnutls_ocsp_resp_int

struct gnutls_ocsp_resp_int;

enum gnutls_ocsp_resp_status_t

Enumeration of different OCSP response status codes.

gnutls_ocsp_resp_t

typedef struct gnutls_ocsp_resp_int *gnutls_ocsp_resp_t;

enum gnutls_ocsp_verify_reason_t

Enumeration of OCSP verify status codes, used by gnutls_ocsp_resp_verify() and gnutls_ocsp_resp_verify_direct().

enum gnutls_x509_crl_reason_t

Enumeration of different reason codes. Note that this corresponds to the CRLReason ASN.1 enumeration type, and not the ReasonFlags ASN.1 bit string.