summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2012-11-08 23:29:57 +0100
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2012-11-08 23:29:57 +0100
commit5f9d3a2b2f618e4369d7851b6c0ec0806e5162c2 (patch)
tree2da3d85b69c0c218544f6f1ce578a0cd436afbe5
parentd3af4aada3a0f170535a2f90e2ec3121b34b9a85 (diff)
downloadgnutls-5f9d3a2b2f618e4369d7851b6c0ec0806e5162c2.tar.gz
doc updates
-rw-r--r--doc/cha-gtls-app.texi16
-rw-r--r--doc/cha-intro-tls.texi2
-rw-r--r--doc/latex/gnutls.bib11
3 files changed, 22 insertions, 7 deletions
diff --git a/doc/cha-gtls-app.texi b/doc/cha-gtls-app.texi
index 85c758a7d4..b6ad475dbe 100644
--- a/doc/cha-gtls-app.texi
+++ b/doc/cha-gtls-app.texi
@@ -19,6 +19,11 @@
@node Introduction to the library
@section Introduction
+This chapter tries to explain the basic functionality of the current GnuTLS
+library. Note that there may be additional functionality not discussed here
+but included in the library. Checking the header files in @file{/usr/include/gnutls/}
+and the manpages is recommended.
+
@menu
* General idea::
* Error handling::
@@ -31,16 +36,17 @@
@node General idea
@subsection General idea
-A brief description of how @acronym{GnuTLS} works internally is shown
-at @ref{fig:gnutls-design}. This section may become more clear after
-having read the rest of this section.
+A brief description of how @acronym{GnuTLS} sessions operate is shown
+at @ref{fig:gnutls-design}. This section will become more clear when it
+is completely read.
As shown in the figure, there is a read-only global state that is
initialized once by the global initialization function. This global
structure, among others, contains the memory allocation functions
-used, and structures needed for the @acronym{ASN.1} parser. This
+used, structures needed for the @acronym{ASN.1} parser and depending
+on the system's CPU, pointers to hardware accelerated encryption functions. This
structure is never modified by any @acronym{GnuTLS} function, except
for the deinitialization function which frees all allocated memory
-and is called after the program has permanently
+and must be called after the program has permanently
finished using @acronym{GnuTLS}.
@float Figure,fig:gnutls-design
diff --git a/doc/cha-intro-tls.texi b/doc/cha-intro-tls.texi
index a83c0f721f..9674fb4972 100644
--- a/doc/cha-intro-tls.texi
+++ b/doc/cha-intro-tls.texi
@@ -371,7 +371,7 @@ established keys, meaning the server needs to store the state of established
connections (unless session tickets are used -- @ref{Session tickets}).
Session resumption is an integral part of @acronym{GnuTLS}, and
-@ref{Session resumption} and @ref{ex:resume-client} illustrate typical
+@ref{Session resumption}, @ref{ex:resume-client} illustrate typical
uses of it.
@node TLS Extensions
diff --git a/doc/latex/gnutls.bib b/doc/latex/gnutls.bib
index 74a4915bf1..40ac460bf6 100644
--- a/doc/latex/gnutls.bib
+++ b/doc/latex/gnutls.bib
@@ -7,7 +7,16 @@
url = "http://tools.ietf.org/html/draft-ietf-websec-key-pinning-01"
}
-@Misc{ RFC2246,
+@Misc{ RFC5764,
+ author = "David McGrew and Eric Rescorla",
+ title = "{Datagram Transport Layer Security (DTLS) Extension to Establish Keys for the Secure Real-time Transport Protocol (SRTP)}",
+ month = "May",
+ year = "2010",
+ note = "Available from \url{http://www.ietf.org/rfc/rfc5764}",
+ url = "http://www.ietf.org/rfc/rfc5764 "
+}
+
+@Misc{ RFC2246 ,
author = "Tim Dierks and Christopher Allen",
title = "{The TLS Protocol Version 1.0}",
month = "January",