|
Packit |
549fdc |
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
|
|
Packit |
549fdc |
.TH "gnutls_x509_crt_get_subject_alt_othername_oid" 3 "3.6.2" "gnutls" "gnutls"
|
|
Packit |
549fdc |
.SH NAME
|
|
Packit |
549fdc |
gnutls_x509_crt_get_subject_alt_othername_oid \- API function
|
|
Packit |
549fdc |
.SH SYNOPSIS
|
|
Packit |
549fdc |
.B #include <gnutls/x509.h>
|
|
Packit |
549fdc |
.sp
|
|
Packit |
549fdc |
.BI "int gnutls_x509_crt_get_subject_alt_othername_oid(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " oid ", size_t * " oid_size ");"
|
|
Packit |
549fdc |
.SH ARGUMENTS
|
|
Packit |
549fdc |
.IP "gnutls_x509_crt_t cert" 12
|
|
Packit |
549fdc |
should contain a \fBgnutls_x509_crt_t\fP type
|
|
Packit |
549fdc |
.IP "unsigned int seq" 12
|
|
Packit |
549fdc |
specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
|
|
Packit |
549fdc |
.IP "void * oid" 12
|
|
Packit |
549fdc |
is the place where the otherName OID will be copied to
|
|
Packit |
549fdc |
.IP "size_t * oid_size" 12
|
|
Packit |
549fdc |
holds the size of ret.
|
|
Packit |
549fdc |
.SH "DESCRIPTION"
|
|
Packit |
549fdc |
This function will extract the type OID of an otherName Subject
|
|
Packit |
549fdc |
Alternative Name, contained in the given certificate, and return
|
|
Packit |
549fdc |
the type as an enumerated element.
|
|
Packit |
549fdc |
|
|
Packit |
549fdc |
This function is only useful if
|
|
Packit |
549fdc |
\fBgnutls_x509_crt_get_subject_alt_name()\fP returned
|
|
Packit |
549fdc |
\fBGNUTLS_SAN_OTHERNAME\fP.
|
|
Packit |
549fdc |
|
|
Packit |
549fdc |
If \fIoid\fP is null then only the size will be filled. The \fIoid\fP returned will be null terminated, although \fIoid_size\fP will not
|
|
Packit |
549fdc |
account for the trailing null.
|
|
Packit |
549fdc |
.SH "RETURNS"
|
|
Packit |
549fdc |
the alternative subject name type on success, one of the
|
|
Packit |
549fdc |
enumerated gnutls_x509_subject_alt_name_t. For supported OIDs, it
|
|
Packit |
549fdc |
will return one of the virtual (GNUTLS_SAN_OTHERNAME_*) types,
|
|
Packit |
549fdc |
e.g. \fBGNUTLS_SAN_OTHERNAME_XMPP\fP, and \fBGNUTLS_SAN_OTHERNAME\fP for
|
|
Packit |
549fdc |
unknown OIDs. It will return \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if
|
|
Packit |
549fdc |
\fIian_size\fP is not large enough to hold the value. In that case
|
|
Packit |
549fdc |
\fIian_size\fP will be updated with the required size. If the
|
|
Packit |
549fdc |
certificate does not have an Alternative name with the specified
|
|
Packit |
549fdc |
sequence number and with the otherName type then
|
|
Packit |
549fdc |
\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned.
|
|
Packit |
549fdc |
.SH "REPORTING BUGS"
|
|
Packit |
549fdc |
Report bugs to <bugs@gnutls.org>.
|
|
Packit |
549fdc |
.br
|
|
Packit |
549fdc |
Home page: http://www.gnutls.org
|
|
Packit |
549fdc |
|
|
Packit |
549fdc |
.SH COPYRIGHT
|
|
Packit |
549fdc |
Copyright \(co 2001-2018 Free Software Foundation, Inc., and others.
|
|
Packit |
549fdc |
.br
|
|
Packit |
549fdc |
Copying and distribution of this file, with or without modification,
|
|
Packit |
549fdc |
are permitted in any medium without royalty provided the copyright
|
|
Packit |
549fdc |
notice and this notice are preserved.
|
|
Packit |
549fdc |
.SH "SEE ALSO"
|
|
Packit |
549fdc |
The full documentation for
|
|
Packit |
549fdc |
.B gnutls
|
|
Packit |
549fdc |
is maintained as a Texinfo manual.
|
|
Packit |
549fdc |
If the /usr/share/doc/gnutls/
|
|
Packit |
549fdc |
directory does not contain the HTML form visit
|
|
Packit |
549fdc |
.B
|
|
Packit |
549fdc |
.IP http://www.gnutls.org/manual/
|
|
Packit |
549fdc |
.PP
|