Blame doc/functions/gnutls_x509_crt_get_subject_alt_othername_oid

Packit aea12f
Packit aea12f
Packit aea12f
Packit aea12f
Packit aea12f
@deftypefun {int} {gnutls_x509_crt_get_subject_alt_othername_oid} (gnutls_x509_crt_t @var{cert}, unsigned int @var{seq}, void * @var{oid}, size_t * @var{oid_size})
Packit aea12f
@var{cert}: should contain a @code{gnutls_x509_crt_t}  type
Packit aea12f
Packit aea12f
@var{seq}: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
Packit aea12f
Packit aea12f
@var{oid}: is the place where the otherName OID will be copied to
Packit aea12f
Packit aea12f
@var{oid_size}: holds the size of ret.
Packit aea12f
Packit aea12f
This function will extract the type OID of an otherName Subject
Packit aea12f
Alternative Name, contained in the given certificate, and return
Packit aea12f
the type as an enumerated element.
Packit aea12f
Packit aea12f
This function is only useful if
Packit aea12f
@code{gnutls_x509_crt_get_subject_alt_name()}  returned
Packit aea12f
@code{GNUTLS_SAN_OTHERNAME} .
Packit aea12f
Packit aea12f
If  @code{oid} is null then only the size will be filled. The  @code{oid} returned will be null terminated, although  @code{oid_size} will not
Packit aea12f
account for the trailing null.
Packit aea12f
Packit aea12f
@strong{Returns:} the alternative subject name type on success, one of the
Packit aea12f
enumerated gnutls_x509_subject_alt_name_t.  For supported OIDs, it
Packit aea12f
will return one of the virtual (GNUTLS_SAN_OTHERNAME_*) types,
Packit aea12f
e.g. @code{GNUTLS_SAN_OTHERNAME_XMPP} , and @code{GNUTLS_SAN_OTHERNAME}  for
Packit aea12f
unknown OIDs.  It will return @code{GNUTLS_E_SHORT_MEMORY_BUFFER}  if
Packit aea12f
 @code{ian_size} is not large enough to hold the value.  In that case
Packit aea12f
 @code{ian_size} will be updated with the required size.  If the
Packit aea12f
certificate does not have an Alternative name with the specified
Packit aea12f
sequence number and with the otherName type then
Packit aea12f
@code{GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE}  is returned.
Packit aea12f
@end deftypefun