gnutls_x509_crt_get_authority_info_access(3)

1gnutls_x509_crt_get_authority_info_gancgucnteulstssl_(sx35)09_crt_get_authority_info_access(3)
2
3
4

NAME

6       gnutls_x509_crt_get_authority_info_access - API function
7

SYNOPSIS

9       #include <gnutls/x509.h>
10
11       int   gnutls_x509_crt_get_authority_info_access(gnutls_x509_crt_t  crt,
12       unsigned int seq, int what, gnutls_datum_t * data, unsigned int * crit‐
13       ical);
14

ARGUMENTS

16       gnutls_x509_crt_t crt
17                   Holds the certificate
18
19       unsigned int seq
20                   specifies  the  sequence number of the access descriptor (0
21                   for the first one, 1 for the second etc.)
22
23       int what    what data to get, a gnutls_info_access_what_t type.
24
25       gnutls_datum_t * data
26                   output data to be freed with gnutls_free().
27
28       unsigned int * critical
29                   pointer to output integer that is set to  non-zero  if  the
30                   extension is marked as critical (may be NULL)
31

DESCRIPTION

33       Note  that  a simpler API to access the authority info data is provided
34       by gnutls_x509_aia_get() and gnutls_x509_ext_import_aia().
35
36       This function extracts the Authority Information  Access  (AIA)  exten‐
37       sion,  see  RFC  5280  section  4.2.2.1  for more information.  The AIA
38       extension holds a sequence of AccessDescription (AD) data.
39
40       The  seq input parameter is  used  to  indicate  which  member  of  the
41       sequence  the caller is interested in.  The first member is 0, the sec‐
42       ond member 1 and so  on.   When  the   seq  value  is  out  of  bounds,
43       GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE is returned.
44
45       The  type of data returned in  data is specified via  what which should
46       be gnutls_info_access_what_t values.
47
48       If  what is GNUTLS_IA_ACCESSMETHOD_OID then  data will hold the access‐
49       Method OID (e.g., "1.3.6.1.5.5.7.48.1").
50
51       If   what is GNUTLS_IA_ACCESSLOCATION_GENERALNAME_TYPE,  data will hold
52       the  accessLocation  GeneralName  type  (e.g.,  "uniformResourceIdenti‐
53       fier").
54
55       If  what is GNUTLS_IA_URI,  data will hold the accessLocation URI data.
56       Requesting this  what value leads to an error if the accessLocation  is
57       not of the "uniformResourceIdentifier" type.
58
59       If  what is GNUTLS_IA_OCSP_URI,  data will hold the OCSP URI.  Request‐
60       ing this  what value leads to an  error  if  the  accessMethod  is  not
61       1.3.6.1.5.5.7.48.1  aka  OCSP, or if accessLocation is not of the "uni‐
62       formResourceIdentifier" type. In that  case  GNUTLS_E_UNKNOWN_ALGORITHM
63       will be returned, and  seq should be increased and this function called
64       again.
65
66       If  what is GNUTLS_IA_CAISSUERS_URI,  data will hold the caIssuers URI.
67       Requesting  this   what  value leads to an error if the accessMethod is
68       not 1.3.6.1.5.5.7.48.2 aka caIssuers, or if accessLocation  is  not  of
69       the  "uniformResourceIdentifier"  type.   In  that  case  handle  as in
70       GNUTLS_IA_OCSP_URI.
71
72       More  what values may be allocated in the future as needed.
73
74       If  data is NULL, the function does the same without storing the output
75       data, that is, it will set  critical and do error checking as usual.
76
77       The  value  of  the critical flag is returned in * critical .  Supply a
78       NULL  critical if you want the function to make sure the  extension  is
79       non-critical, as required by RFC 5280.
80

RETURNS

82       GNUTLS_E_SUCCESS on success, GNUTLS_E_INVALID_REQUEST on invalid  crt ,
83       GNUTLS_E_CONSTRAINT_ERROR if the extension  is  incorrectly  marked  as
84       critical (use a non-NULL  critical to override), GNUTLS_E_UNKNOWN_ALGO‐
85       RITHM  if  the  requested  OID  does  not  match  (e.g.,   when   using
86       GNUTLS_IA_OCSP_URI), otherwise a negative error code.
87

SINCE

89       3.0
90

REPORTING BUGS

92       Report bugs to <bugs@gnutls.org>.
93       Home page: https://www.gnutls.org
94
95

COPYRIGHT

97       Copyright © 2001-2019 Free Software Foundation, Inc., and others.
98       Copying  and  distribution  of this file, with or without modification,
99       are permitted in any medium  without  royalty  provided  the  copyright
100       notice and this notice are preserved.
101