Blame doc/cha-functions.texi

Packit Service 4684c1
@node API reference
Packit Service 4684c1
@appendix API reference
Packit Service 4684c1
@cindex API reference
Packit Service 4684c1
Packit Service 4684c1
@menu
Packit Service 4684c1
* Core TLS API::
Packit Service 4684c1
* Datagram TLS API::
Packit Service 4684c1
* X509 certificate API::
Packit Service 4684c1
* PKCS 7 API::
Packit Service 4684c1
* OCSP API::
Packit Service 4684c1
* PKCS 12 API::
Packit Service 4684c1
* PKCS 11 API::
Packit Service 4684c1
* TPM API::
Packit Service 4684c1
* Abstract key API::
Packit Service 4684c1
* Socket specific API::
Packit Service 4684c1
* DANE API::
Packit Service 4684c1
* Cryptographic API::
Packit Service 4684c1
* Compatibility API::
Packit Service 4684c1
@end menu
Packit Service 4684c1
Packit Service 4684c1
@node Core TLS API
Packit Service 4684c1
@section Core TLS API
Packit Service 4684c1
Packit Service 4684c1
The prototypes for the following functions lie in
Packit Service 4684c1
@file{gnutls/gnutls.h}.
Packit Service 4684c1
Packit Service 4684c1
@include gnutls-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node Datagram TLS API
Packit Service 4684c1
@section Datagram TLS API
Packit Service 4684c1
Packit Service 4684c1
The prototypes for the following functions lie in
Packit Service 4684c1
@file{gnutls/dtls.h}.
Packit Service 4684c1
Packit Service 4684c1
@include dtls-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node X509 certificate API
Packit Service 4684c1
@section @acronym{X.509} certificate API
Packit Service 4684c1
@cindex X.509 Functions
Packit Service 4684c1
Packit Service 4684c1
The following functions are to be used for @acronym{X.509} certificate handling.
Packit Service 4684c1
Their prototypes lie in @file{gnutls/x509.h}.
Packit Service 4684c1
Packit Service 4684c1
@include x509-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node PKCS 7 API
Packit Service 4684c1
@section @acronym{PKCS} 7 API
Packit Service 4684c1
Packit Service 4684c1
The following functions are to be used for PKCS 7 structures handling.
Packit Service 4684c1
Their prototypes lie in @file{gnutls/pkcs7.h}.
Packit Service 4684c1
Packit Service 4684c1
@include pkcs7-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node OCSP API
Packit Service 4684c1
@section @acronym{OCSP} API
Packit Service 4684c1
@cindex OCSP Functions
Packit Service 4684c1
Packit Service 4684c1
The following functions are for @acronym{OCSP} certificate status
Packit Service 4684c1
checking.  Their prototypes lie in @file{gnutls/ocsp.h}.
Packit Service 4684c1
Packit Service 4684c1
@include ocsp-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node PKCS 12 API
Packit Service 4684c1
@section PKCS 12 API
Packit Service 4684c1
Packit Service 4684c1
The following functions are to be used for PKCS 12 handling.
Packit Service 4684c1
Their prototypes lie in @file{gnutls/pkcs12.h}.
Packit Service 4684c1
Packit Service 4684c1
@include pkcs12-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node PKCS 11 API
Packit Service 4684c1
@section Hardware token via PKCS 11 API
Packit Service 4684c1
Packit Service 4684c1
The following functions are to be used for PKCS 11 handling.
Packit Service 4684c1
Their prototypes lie in @file{gnutls/pkcs11.h}.
Packit Service 4684c1
Packit Service 4684c1
@include pkcs11-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node TPM API
Packit Service 4684c1
@section TPM API
Packit Service 4684c1
Packit Service 4684c1
The following functions are to be used for TPM handling.
Packit Service 4684c1
Their prototypes lie in @file{gnutls/tpm.h}.
Packit Service 4684c1
Packit Service 4684c1
@include tpm-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node Abstract key API
Packit Service 4684c1
@section Abstract key API
Packit Service 4684c1
Packit Service 4684c1
The following functions are to be used for abstract key handling.
Packit Service 4684c1
Their prototypes lie in @file{gnutls/abstract.h}.
Packit Service 4684c1
Packit Service 4684c1
@include abstract-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node Socket specific API
Packit Service 4684c1
@section Socket specific API
Packit Service 4684c1
Packit Service 4684c1
The prototypes for the following functions lie in
Packit Service 4684c1
@file{gnutls/socket.h}.
Packit Service 4684c1
@include socket-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node DANE API
Packit Service 4684c1
@section DANE API
Packit Service 4684c1
Packit Service 4684c1
The following functions are to be used for DANE certificate verification.
Packit Service 4684c1
Their prototypes lie in @file{gnutls/dane.h}. Note that you need to link
Packit Service 4684c1
with the @code{libgnutls-dane} library to use them.
Packit Service 4684c1
Packit Service 4684c1
@include dane-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node Cryptographic API
Packit Service 4684c1
@section Cryptographic API
Packit Service 4684c1
Packit Service 4684c1
The following functions are to be used for low-level cryptographic operations.
Packit Service 4684c1
Their prototypes lie in @file{gnutls/crypto.h}.
Packit Service 4684c1
Packit Service 4684c1
Note that due to historic reasons several functions, (e.g.
Packit Service 4684c1
@funcref{gnutls_mac_list}, @funcref{gnutls_mac_get_name}) of this API are part
Packit Service 4684c1
of the @ref{Core TLS API}.
Packit Service 4684c1
Packit Service 4684c1
@include crypto-api.texi
Packit Service 4684c1
Packit Service 4684c1
@node Compatibility API
Packit Service 4684c1
@section Compatibility API
Packit Service 4684c1
Packit Service 4684c1
The following functions are carried over from old GnuTLS released. They might be removed at a later version.
Packit Service 4684c1
Their prototypes lie in @file{gnutls/compat.h}.
Packit Service 4684c1
Packit Service 4684c1
@include compat-api.texi