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