summaryrefslogtreecommitdiff
path: root/doc/cha-functions.texi
blob: 29e8d3a3d3f6fc1e7904936e47d9ff579541881f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
@node API reference
@appendix API reference
@cindex API reference

@menu
* Core TLS API::
* Datagram TLS API::
* X509 certificate API::
* PKCS 7 API::
* OCSP API::
* PKCS 12 API::
* PKCS 11 API::
* TPM API::
* Abstract key API::
* Socket specific API::
* DANE API::
* Cryptographic API::
* Compatibility API::
@end menu

@node Core TLS API
@section Core TLS API

The prototypes for the following functions lie in
@file{gnutls/gnutls.h}.

@include gnutls-api.texi

@node Datagram TLS API
@section Datagram TLS API

The prototypes for the following functions lie in
@file{gnutls/dtls.h}.

@include dtls-api.texi

@node X509 certificate API
@section @acronym{X.509} certificate API
@cindex X.509 Functions

The following functions are to be used for @acronym{X.509} certificate handling.
Their prototypes lie in @file{gnutls/x509.h}.

@include x509-api.texi

@node PKCS 7 API
@section @acronym{PKCS} 7 API

The following functions are to be used for PKCS 7 structures handling.
Their prototypes lie in @file{gnutls/pkcs7.h}.

@include pkcs7-api.texi

@node OCSP API
@section @acronym{OCSP} API
@cindex OCSP Functions

The following functions are for @acronym{OCSP} certificate status
checking.  Their prototypes lie in @file{gnutls/ocsp.h}.

@include ocsp-api.texi

@node PKCS 12 API
@section PKCS 12 API

The following functions are to be used for PKCS 12 handling.
Their prototypes lie in @file{gnutls/pkcs12.h}.

@include pkcs12-api.texi

@node PKCS 11 API
@section Hardware token via PKCS 11 API

The following functions are to be used for PKCS 11 handling.
Their prototypes lie in @file{gnutls/pkcs11.h}.

@include pkcs11-api.texi

@node TPM API
@section TPM API

The following functions are to be used for TPM handling.
Their prototypes lie in @file{gnutls/tpm.h}.

@include tpm-api.texi

@node Abstract key API
@section Abstract key API

The following functions are to be used for abstract key handling.
Their prototypes lie in @file{gnutls/abstract.h}.

@include abstract-api.texi

@node Socket specific API
@section Socket specific API

The prototypes for the following functions lie in
@file{gnutls/socket.h}.
@include socket-api.texi

@node DANE API
@section DANE API

The following functions are to be used for DANE certificate verification.
Their prototypes lie in @file{gnutls/dane.h}. Note that you need to link
with the @code{libgnutls-dane} library to use them.

@include dane-api.texi

@node Cryptographic API
@section Cryptographic API

The following functions are to be used for low-level cryptographic operations.
Their prototypes lie in @file{gnutls/crypto.h}.

Note that due to historic reasons several functions, (e.g.
@funcref{gnutls_mac_list}, @funcref{gnutls_mac_get_name}) of this API are part
of the @ref{Core TLS API}.

@include crypto-api.texi

@node Compatibility API
@section Compatibility API

The following functions are carried over from old GnuTLS released. They might be removed at a later version.
Their prototypes lie in @file{gnutls/compat.h}.

@include compat-api.texi