Blame doc/functions/gnutls_x509_crt_get_subject_alt_othername_oid

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