summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_ocsp_req_get_cert_id.3
blob: 336c74d6fdd3a0306471192856a22331cc3c0c41 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_ocsp_req_get_cert_id" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_ocsp_req_get_cert_id \- API function
.SH SYNOPSIS
.B #include <gnutls/ocsp.h>
.sp
.BI "int gnutls_ocsp_req_get_cert_id(gnutls_ocsp_req_const_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 ");"
.SH ARGUMENTS
.IP "gnutls_ocsp_req_const_t req" 12
should contain a \fBgnutls_ocsp_req_t\fP type
.IP "unsigned indx" 12
Specifies which extension OID to get. Use (0) to get the first one.
.IP "gnutls_digest_algorithm_t * digest" 12
output variable with \fBgnutls_digest_algorithm_t\fP hash algorithm
.IP "gnutls_datum_t * issuer_name_hash" 12
output buffer with hash of issuer's DN
.IP "gnutls_datum_t * issuer_key_hash" 12
output buffer with hash of issuer's public key
.IP "gnutls_datum_t * serial_number" 12
output buffer with serial number of certificate to check
.SH "DESCRIPTION"
This function will return the certificate information of the
 \fIindx\fP 'ed request in the OCSP request.  The information returned
corresponds to the CertID structure:

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

Each of the pointers to output variables may be NULL to indicate
that the caller is not interested in that value.
.SH "RETURNS"
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a
negative error code is returned.  If you have reached the last
CertID available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be
returned.
.SH "REPORTING BUGS"
Report bugs to <bugs@gnutls.org>.
.br
Home page: https://www.gnutls.org

.SH COPYRIGHT
Copyright \(co 2001- Free Software Foundation, Inc., and others.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gnutls
is maintained as a Texinfo manual.
If the /usr/share/doc/gnutls/
directory does not contain the HTML form visit
.B
.IP https://www.gnutls.org/manual/
.PP