summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_x509_crt_get_extension_info.3
blob: 8d743ed110f0d212b71e4ec91e3cf7fbbcc5fe34 (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
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_x509_crt_get_extension_info" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_x509_crt_get_extension_info \- API function
.SH SYNOPSIS
.B #include <gnutls/x509.h>
.sp
.BI "int gnutls_x509_crt_get_extension_info(gnutls_x509_crt_t " cert ", unsigned " indx ", void * " oid ", size_t * " oid_size ", unsigned int * " critical ");"
.SH ARGUMENTS
.IP "gnutls_x509_crt_t cert" 12
should contain a \fBgnutls_x509_crt_t\fP type
.IP "unsigned indx" 12
Specifies which extension OID to send. Use (0) to get the first one.
.IP "void * oid" 12
a pointer to a structure to hold the OID
.IP "size_t * oid_size" 12
initially holds the maximum size of  \fIoid\fP , on return
holds actual size of  \fIoid\fP .
.IP "unsigned int * critical" 12
output variable with critical flag, may be NULL.
.SH "DESCRIPTION"
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
\fBgnutls_x509_crt_get_extension()\fP to extract the data.

If the buffer provided is not long enough to hold the output, then
 \fIoid_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be
returned. The  \fIoid\fP returned will be null terminated, although
 \fIoid_size\fP will not account for the trailing null (the latter is not
true for GnuTLS prior to 3.6.0).
.SH "RETURNS"
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned,
otherwise a negative error code is returned.  If you have reached the
last extension 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