summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_x509_crt_get_dn.3
blob: b1c709f988dc726efffbd422d789e45977d52caf (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
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_x509_crt_get_dn" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_x509_crt_get_dn \- API function
.SH SYNOPSIS
.B #include <gnutls/x509.h>
.sp
.BI "int gnutls_x509_crt_get_dn(gnutls_x509_crt_t " cert ", char * " buf ", size_t * " buf_size ");"
.SH ARGUMENTS
.IP "gnutls_x509_crt_t cert" 12
should contain a \fBgnutls_x509_crt_t\fP type
.IP "char * buf" 12
a pointer to a structure to hold the name (may be null)
.IP "size_t * buf_size" 12
initially holds the size of  \fIbuf\fP 
.SH "DESCRIPTION"
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.

The  \fIbuf\fP returned will be null terminated and the  \fIbuf_size\fP will account
for the trailing null. If  \fIbuf\fP is null then only the size will be filled.

This function does not output a fully RFC4514 compliant string, if
that is required see \fBgnutls_x509_crt_get_dn3()\fP.
.SH "RETURNS"
\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is not
long enough, and in that case the  \fIbuf_size\fP will be updated
with the required size. \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP if
the DN does not exist, or another error value on error. On success 0 is 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