doc/cha-functions.texi

   1 @node API reference
   2 @appendix API reference
   3 @cindex API reference
   4
   5 @menu
   6 * Core TLS API::
   7 * Datagram TLS API::
   8 * X509 certificate API::
   9 * OCSP API::
  10 * OpenPGP API::
  11 * PKCS 12 API::
  12 * PKCS 11 API::
  13 * TPM API::
  14 * Abstract key API::
  15 * DANE API::
  16 * Cryptographic API::
  17 * Compatibility API::
  18 @end menu
  19
  20 @node Core TLS API
  21 @section Core TLS API
  22
  23 The prototypes for the following functions lie in
  24 @file{gnutls/gnutls.h}.
  25
  26 @include gnutls-api.texi
  27
  28 @node Datagram TLS API
  29 @section Datagram TLS API
  30
  31 The prototypes for the following functions lie in
  32 @file{gnutls/dtls.h}.
  33
  34 @include dtls-api.texi
  35
  36 @node X509 certificate API
  37 @section @acronym{X.509} certificate API
  38 @cindex X.509 Functions
  39
  40 The following functions are to be used for @acronym{X.509} certificate handling.
  41 Their prototypes lie in @file{gnutls/x509.h}.
  42
  43 @include x509-api.texi
  44
  45 @node OCSP API
  46 @section @acronym{OCSP} API
  47 @cindex OCSP Functions
  48
  49 The following functions are for @acronym{OCSP} certificate status
  50 checking.  Their prototypes lie in @file{gnutls/ocsp.h}.
  51
  52 @include ocsp-api.texi
  53
  54 @node OpenPGP API
  55 @section @acronym{OpenPGP} API
  56 @cindex OpenPGP API
  57
  58 The following functions are to be used for @acronym{OpenPGP}
  59 certificate handling.  Their prototypes lie in
  60 @file{gnutls/openpgp.h}.
  61
  62 @include pgp-api.texi
  63
  64 @node PKCS 12 API
  65 @section PKCS 12 API
  66
  67 The following functions are to be used for PKCS 12 handling.
  68 Their prototypes lie in @file{gnutls/pkcs12.h}.
  69
  70 @include pkcs12-api.texi
  71
  72 @node PKCS 11 API
  73 @section Hardware token via PKCS 11 API
  74
  75 The following functions are to be used for PKCS 11 handling.
  76 Their prototypes lie in @file{gnutls/pkcs11.h}.
  77
  78 @include pkcs11-api.texi
  79
  80 @node TPM API
  81 @section TPM API
  82
  83 The following functions are to be used for TPM handling.
  84 Their prototypes lie in @file{gnutls/tpm.h}.
  85
  86 @include tpm-api.texi
  87
  88 @node Abstract key API
  89 @section Abstract key API
  90
  91 The following functions are to be used for abstract key handling.
  92 Their prototypes lie in @file{gnutls/abstract.h}.
  93
  94 @include abstract-api.texi
  95
  96 @node DANE API
  97 @section DANE API
  98
  99 The following functions are to be used for DANE certificate verification.
 100 Their prototypes lie in @file{gnutls/dane.h}. Note that you need to link
 101 with the @code{libgnutls-dane} library to use them.
 102
 103 @include dane-api.texi
 104
 105 @node Cryptographic API
 106 @section Cryptographic API
 107
 108 The following functions are to be used for low-level cryptographic operations.
 109 Their prototypes lie in @file{gnutls/crypto.h}.
 110
 111 @include crypto-api.texi
 112
 113 @node Compatibility API
 114 @section Compatibility API
 115
 116 The following functions are carried over from old GnuTLS released. They might be removed at a later version.
 117 Their prototypes lie in @file{gnutls/compat.h}.
 118
 119 @include compat-api.texi