doc/manpages/gnutls_x509_crt_get_issuer_alt_name.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_x509_crt_get_issuer_alt_name" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_x509_crt_get_issuer_alt_name \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/x509.h>
   7 .sp
   8 .BI "int gnutls_x509_crt_get_issuer_alt_name(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " ret ", size_t * " ret_size ", unsigned int * " critical ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_x509_crt_t cert" 12
  11 should contain a \fBgnutls_x509_crt_t\fP structure
  12 .IP "unsigned int seq" 12
  13 specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
  14 .IP "void * ret" 12
  15 is the place where the alternative name will be copied to
  16 .IP "size_t * ret_size" 12
  17 holds the size of ret.
  18 .IP "unsigned int * critical" 12
  19 will be non zero if the extension is marked as critical (may be null)
  20 .SH "DESCRIPTION"
  21 This function retrieves the Issuer Alternative Name (2.5.29.18),
  22 contained in the given certificate in the X509v3 Certificate
  23 Extensions.
  24
  25 When the SAN type is otherName, it will extract the data in the
  26 otherName's value field, and \fBGNUTLS_SAN_OTHERNAME\fP is returned.
  27 You may use \fBgnutls_x509_crt_get_subject_alt_othername_oid()\fP to get
  28 the corresponding OID and the "virtual" SAN types (e.g.,
  29 \fBGNUTLS_SAN_OTHERNAME_XMPP\fP).
  30
  31 If an otherName OID is known, the data will be decoded.  Otherwise
  32 the returned data will be DER encoded, and you will have to decode
  33 it yourself.  Currently, only the RFC 3920 id\-on\-xmppAddr Issuer
  34 AltName is recognized.
  35 .SH "RETURNS"
  36 the alternative issuer name type on success, one of the
  37 enumerated \fBgnutls_x509_subject_alt_name_t\fP.  It will return
  38 \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if \fIret_size\fP is not large enough
  39 to hold the value.  In that case \fIret_size\fP will be updated with
  40 the required size.  If the certificate does not have an
  41 Alternative name with the specified sequence number then
  42 \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned.
  43 .SH "SINCE"
  44 2.10.0
  45 .SH "REPORTING BUGS"
  46 Report bugs to <bug-gnutls@gnu.org>.
  47 GnuTLS home page: http://www.gnu.org/software/gnutls/
  48 General help using GNU software: http://www.gnu.org/gethelp/
  49 .SH COPYRIGHT
  50 Copyright \(co 2008 Free Software Foundation.
  51 .br
  52 Copying and distribution of this file, with or without modification,
  53 are permitted in any medium without royalty provided the copyright
  54 notice and this notice are preserved.
  55 .SH "SEE ALSO"
  56 The full documentation for
  57 .B gnutls
  58 is maintained as a Texinfo manual.  If the
  59 .B info
  60 and
  61 .B gnutls
  62 programs are properly installed at your site, the command
  63 .IP
  64 .B info gnutls
  65 .PP
  66 should give you access to the complete manual.