doc/gnutls.texi

   1 \input texinfo   @c -*-texinfo-*-
   2 @comment %**start of header
   3 @setfilename gnutls.info
   4 @include version.texi
   5 @settitle GnuTLS @value{VERSION}
   6 @c don't indent the paragraphs.
   7 @paragraphindent 0
   8
   9 @c Unify some of the indices.
  10 @syncodeindex tp fn
  11 @syncodeindex pg cp
  12
  13 @comment %**end of header
  14 @finalout
  15 @copying
  16 This manual is last updated @value{UPDATED} for version
  17 @value{VERSION} of GnuTLS.
  18
  19 Copyright @copyright{} 2001-2012 Free Software Foundation, Inc.
  20
  21 @quotation
  22 Permission is granted to copy, distribute and/or modify this document
  23 under the terms of the GNU Free Documentation License, Version 1.3 or
  24 any later version published by the Free Software Foundation; with no
  25 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
  26 copy of the license is included in the section entitled ``GNU Free
  27 Documentation License''.
  28 @end quotation
  29 @end copying
  30
  31 @dircategory Software libraries
  32 @direntry
  33 * GnuTLS: (gnutls).             GNU Transport Layer Security Library.
  34 @end direntry
  35
  36 @dircategory System Administration
  37 @direntry
  38 * certtool: (gnutls)Invoking certtool.  Manipulate certificates and keys.
  39 * gnutls-serv: (gnutls)Invoking gnutls-serv.    GnuTLS test server.
  40 * gnutls-cli: (gnutls)Invoking gnutls-cli.      GnuTLS test client.
  41 * gnutls-cli-debug: (gnutls)Invoking gnutls-cli-debug.  GnuTLS debug client.
  42 * psktool: (gnutls)Invoking psktool.    Simple TLS-Pre-Shared-Keys manager.
  43 * srptool: (gnutls)Invoking srptool.    Simple SRP password tool.
  44 @end direntry
  45
  46 @titlepage
  47 @title GnuTLS
  48 @subtitle Transport Layer Security Library for the GNU system
  49 @subtitle for version @value{VERSION}, @value{UPDATED}
  50 @sp 7
  51 @center @image{gnutls-logo,6cm,6cm}
  52 @author Nikos Mavrogiannopoulos
  53 @author Simon Josefsson (@email{bug-gnutls@@gnu.org})
  54 @page
  55 @vskip 0pt plus 1filll
  56 @insertcopying
  57 @end titlepage
  58
  59 @c reference to an internal function.
  60 @macro refint {func}
  61 @code{\func\}
  62 @end macro
  63
  64 @macro xcite{ref}
  65 [@emph{\ref\}]
  66 @end macro
  67
  68 @macro funcref{ref}
  69 @ref{\ref\}
  70 @end macro
  71
  72 @macro funcintref{ref}
  73 @code{\ref\}
  74 @end macro
  75
  76 @macro showfuncA{ref}
  77 @table @code
  78 @include functions/\ref\.short
  79 @end table
  80 @end macro
  81
  82 @macro showfuncB{ref1,ref2}
  83 @table @code
  84 @include functions/\ref1\.short
  85 @include functions/\ref2\.short
  86 @end table
  87 @end macro
  88
  89 @macro showfuncC{ref1,ref2,ref3}
  90 @table @code
  91 @include functions/\ref1\.short
  92 @include functions/\ref2\.short
  93 @include functions/\ref3\.short
  94 @end table
  95 @end macro
  96
  97 @macro showfuncD{ref1,ref2,ref3,ref4}
  98 @table @code
  99 @include functions/\ref1\.short
 100 @include functions/\ref2\.short
 101 @include functions/\ref3\.short
 102 @include functions/\ref4\.short
 103 @end table
 104 @end macro
 105
 106 @macro showfuncE{ref1,ref2,ref3,ref4,ref5}
 107 @table @code
 108 @include functions/\ref1\.short
 109 @include functions/\ref2\.short
 110 @include functions/\ref3\.short
 111 @include functions/\ref4\.short
 112 @include functions/\ref5\.short
 113 @end table
 114 @end macro
 115
 116 @macro showfuncF{ref1,ref2,ref3,ref4,ref5,ref6}
 117 @table @code
 118 @include functions/\ref1\.short
 119 @include functions/\ref2\.short
 120 @include functions/\ref3\.short
 121 @include functions/\ref4\.short
 122 @include functions/\ref5\.short
 123 @include functions/\ref6\.short
 124 @end table
 125 @end macro
 126
 127 @macro showfuncdesc{ref}
 128 @include functions/\ref\
 129 @end macro
 130
 131 @macro showenumdesc{ref,cap}
 132 @float Figure,\ref\
 133 @include enums/\ref\
 134 @caption{\cap\}
 135 @end float
 136 @end macro
 137
 138 @contents
 139
 140 @ifnottex
 141 @node Top
 142 @top GnuTLS
 143
 144 @insertcopying
 145 @end ifnottex
 146
 147 @menu
 148 * Preface::
 149 * Introduction to GnuTLS::
 150 * Introduction to TLS::
 151 * Certificate authentication::
 152 * Shared-key and anonymous authentication::
 153 * More on certificate authentication::
 154 * Hardware security modules and abstract key types::
 155 * How to use GnuTLS in applications::
 156 * GnuTLS application examples::
 157 * Using GnuTLS as a cryptographic library::
 158 * Other included programs::
 159 * Internal architecture of GnuTLS::
 160 * Upgrading from previous versions::
 161 * Support::
 162 * Error codes::
 163 * Supported ciphersuites::
 164 * API reference::
 165 * Copying Information::
 166 * Bibliography::
 167 * Function and Data Index::
 168 * Concept Index::
 169 @c * @mybibnode{}::
 170 @end menu
 171
 172 @include cha-preface.texi
 173
 174 @include cha-library.texi
 175
 176 @include cha-intro-tls.texi
 177
 178 @include cha-cert-auth.texi
 179
 180 @include cha-shared-key.texi
 181
 182 @include cha-cert-auth2.texi
 183
 184 @include cha-tokens.texi
 185
 186 @include cha-gtls-app.texi
 187
 188 @include cha-gtls-examples.texi
 189
 190 @include cha-crypto.texi
 191
 192 @include cha-programs.texi
 193
 194 @include cha-internals.texi
 195
 196 @c appendices
 197
 198 @include cha-upgrade.texi
 199
 200 @include cha-support.texi
 201
 202 @include cha-errors.texi
 203
 204 @include cha-ciphersuites.texi
 205
 206 @include cha-functions.texi
 207
 208 @include cha-copying.texi
 209
 210 @include cha-bib.texi
 211
 212 @node Function and Data Index
 213 @unnumbered Function and Data Index
 214
 215 @printindex fn
 216
 217 @node Concept Index
 218 @unnumbered Concept Index
 219
 220 @printindex cp
 221
 222 @bye