Fix CVE-2017-6891 in minitasn1 code
[platform/upstream/gnutls.git] / doc / functions / gnutls_ocsp_req_add_cert_id
1
2
3
4
5 @deftypefun {int} {gnutls_ocsp_req_add_cert_id} (gnutls_ocsp_req_t @var{req}, gnutls_digest_algorithm_t @var{digest}, const gnutls_datum_t * @var{issuer_name_hash}, const gnutls_datum_t * @var{issuer_key_hash}, const gnutls_datum_t * @var{serial_number})
6 @var{req}: should contain a @code{gnutls_ocsp_req_t}  structure
7
8 @var{digest}: hash algorithm, a @code{gnutls_digest_algorithm_t}  value
9
10 @var{issuer_name_hash}: hash of issuer's DN
11
12 @var{issuer_key_hash}: hash of issuer's public key
13
14 @var{serial_number}: serial number of certificate to check
15
16 This function will add another request to the OCSP request for a
17 particular certificate having the issuer name hash of
18  @code{issuer_name_hash} and issuer key hash of  @code{issuer_key_hash} (both
19 hashed using  @code{digest} ) and serial number  @code{serial_number} .
20
21 The information needed corresponds to the CertID structure:
22
23 <informalexample><programlisting>
24 CertID          ::=     SEQUENCE @{
25 hashAlgorithm       AlgorithmIdentifier,
26 issuerNameHash      OCTET STRING, -- Hash of Issuer's DN
27 issuerKeyHash       OCTET STRING, -- Hash of Issuers public key
28 serialNumber        CertificateSerialNumber @}
29 </programlisting></informalexample>
30
31 @strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned, otherwise a
32 negative error code is returned.
33 @end deftypefun