~ubuntu-branches/ubuntu/maverick/gnutls26/maverick-updates

« back to all changes in this revision

Viewing changes to doc/manpages/gnutls_x509_crq_get_subject_alt_name.3

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Metzler
  • Date: 2009-08-14 19:14:29 UTC
  • mfrom: (1.1.7 upstream) (12.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20090814191429-6hovzz3oaqq101rm
Tags: 2.8.3-1
* New upstream version.
  + Stops hardcoding a hard dependency on the versions of gcrypt and tasn it
    was built against. Closes: #540449
  + Fixes CVE-2009-2730, a vulnerability related to NUL bytes in X.509
    certificate name fields. Closes: #541439        GNUTLS-SA-2009-4
    http://lists.gnu.org/archive/html/help-gnutls/2009-08/msg00011.html
* Drop 15_chainverify_expiredcert.diff, included upstream.
* Urgency high, since 541439 applies to testing, too.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
 
2
.TH "gnutls_x509_crq_get_subject_alt_name" 3 "2.8.3" "gnutls" "gnutls"
 
3
.SH NAME
 
4
gnutls_x509_crq_get_subject_alt_name \- Get certificate's alternative name
 
5
.SH SYNOPSIS
 
6
.B #include <gnutls/x509.h>
 
7
.sp
 
8
.BI "int gnutls_x509_crq_get_subject_alt_name(gnutls_x509_crq_t " cert ", unsigned int " seq ", void * " ret ", size_t * " ret_size ", unsigned int * " ret_type ", unsigned int * " critical ");"
 
9
.SH ARGUMENTS
 
10
.IP "gnutls_x509_crq_t cert" 12
 
11
should contain a \fBgnutls_x509_crq_t\fP structure
 
12
.IP "unsigned int seq" 12
 
13
specifies the sequence number of the alt name, 0 for the
 
14
first one, 1 for the second etc.
 
15
.IP "void * ret" 12
 
16
is the place where the alternative name will be copied to
 
17
.IP "size_t * ret_size" 12
 
18
holds the size of ret.
 
19
.IP "unsigned int * ret_type" 12
 
20
holds the \fBgnutls_x509_subject_alt_name_t\fP name type
 
21
.IP "unsigned int * critical" 12
 
22
will be non zero if the extension is marked as critical
 
23
(may be null)
 
24
.SH "DESCRIPTION"
 
25
This function will return the alternative names, contained in the
 
26
given certificate.  It is the same as
 
27
\fBgnutls_x509_crq_get_subject_alt_name()\fP except for the fact that it
 
28
will return the type of the alternative name in \fIret_type\fP even if
 
29
the function fails for some reason (i.e.  the buffer provided is
 
30
not enough).
 
31
.SH "RETURNS"
 
32
the alternative subject name type on success, one of the
 
33
enumerated \fBgnutls_x509_subject_alt_name_t\fP.  It will return
 
34
\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if \fIret_size\fP is not large enough to
 
35
hold the value.  In that case \fIret_size\fP will be updated with the
 
36
required size.  If the certificate request does not have an
 
37
Alternative name with the specified sequence number then
 
38
\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned.
 
39
.SH "SINCE"
 
40
2.8.0
 
41
.SH "REPORTING BUGS"
 
42
Report bugs to <bug-gnutls@gnu.org>.
 
43
GnuTLS home page: http://www.gnu.org/software/gnutls/
 
44
General help using GNU software: http://www.gnu.org/gethelp/
 
45
.SH COPYRIGHT
 
46
Copyright \(co 2008 Free Software Foundation.
 
47
.br
 
48
Copying and distribution of this file, with or without modification,
 
49
are permitted in any medium without royalty provided the copyright
 
50
notice and this notice are preserved.
 
51
.SH "SEE ALSO"
 
52
The full documentation for
 
53
.B gnutls
 
54
is maintained as a Texinfo manual.  If the
 
55
.B info
 
56
and
 
57
.B gnutls
 
58
programs are properly installed at your site, the command
 
59
.IP
 
60
.B info gnutls
 
61
.PP
 
62
should give you access to the complete manual.