← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gnutls28/quantal

« back to all changes in this revision

Viewing changes to doc/manpages/gnutls_x509_crt_get_basic_constraints.3

  • Committer: Package Import Robot
  • Author(s): Andreas Metzler
  • Date: 2011-12-17 11:41:19 UTC
  • mfrom: (10.1.1 experimental)
  • Revision ID: package-import@ubuntu.com-20111217114119-sp3ixi00tjajm52g
Tags: 3.0.9-2
* [20_test-select.diff] Do not run gnulib test-select test anymore. The
  test fails on kfreebsd-i386, the gnutls library does not use select().
* [30_correctly-set-the-odd-bits.patch] Post release fix from GIT head.
* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpages/gnutls_x509_crt_get_basic_constraints.3
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
 
2
.TH "gnutls_x509_crt_get_basic_constraints" 3 "3.0.9" "gnutls" "gnutls"
 
3
.SH NAME
 
4
gnutls_x509_crt_get_basic_constraints \- API function
 
5
.SH SYNOPSIS
 
6
.B #include <gnutls/x509.h>
 
7
.sp
 
8
.BI "int gnutls_x509_crt_get_basic_constraints(gnutls_x509_crt_t " cert ", unsigned int * " critical ", unsigned int * " ca ", int * " pathlen ");"
 
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 * critical" 12
 
13
will be non (0) if the extension is marked as critical
 
14
.IP "unsigned int * ca" 12
 
15
pointer to output integer indicating CA status, may be NULL,
 
16
value is 1 if the certificate CA flag is set, 0 otherwise.
 
17
.IP "int * pathlen" 12
 
18
pointer to output integer indicating path length (may be
 
19
NULL), non\-negative error codes indicate a present pathLenConstraint
 
20
field and the actual value, \-1 indicate that the field is absent.
 
21
.SH "DESCRIPTION"
 
22
This function will read the certificate's basic constraints, and
 
23
return the certificates CA status.  It reads the basicConstraints
 
24
X.509 extension (2.5.29.19).
 
25
.SH "RETURNS"
 
26
If the certificate is a CA a positive value will be
 
27
returned, or (0) if the certificate does not have CA flag set.  A
 
28
negative error code may be returned in case of errors.  If the
 
29
certificate does not contain the basicConstraints extension
 
30
GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
 
31
.SH "REPORTING BUGS"
 
32
Report bugs to <bug-gnutls@gnu.org>.
 
33
GnuTLS home page: http://www.gnu.org/software/gnutls/
 
34
General help using GNU software: http://www.gnu.org/gethelp/
 
35
.SH COPYRIGHT
 
36
Copyright \(co 2011 Free Software Foundation.
 
37
.br
 
38
Copying and distribution of this file, with or without modification,
 
39
are permitted in any medium without royalty provided the copyright
 
40
notice and this notice are preserved.
 
41
.SH "SEE ALSO"
 
42
The full documentation for
 
43
.B gnutls
 
44
is maintained as a Texinfo manual.  If the
 
45
.B info
 
46
and
 
47
.B gnutls
 
48
programs are properly installed at your site, the command
 
49
.IP
 
50
.B info gnutls
 
51
.PP
 
52
should give you access to the complete manual.