From ff8fd8a8fce4af70beb51ea6f60a583531d859d2 Mon Sep 17 00:00:00 2001 From: Nikos Mavrogiannopoulos Date: Sat, 13 Aug 2011 10:14:06 +0200 Subject: do not use capitals in index names. --- doc/cha-auth.texi | 2 +- doc/cha-cert-auth.texi | 15 ++++++++------- doc/cha-ciphersuites.texi | 2 +- doc/cha-errors.texi | 2 +- doc/cha-functions.texi | 2 +- doc/cha-gtls-app.texi | 19 ++++++++++--------- doc/cha-internals.texi | 2 +- doc/cha-intro-tls.texi | 31 ++++++++++++++++--------------- doc/cha-library.texi | 2 +- doc/cha-support.texi | 10 +++++----- 10 files changed, 45 insertions(+), 42 deletions(-) (limited to 'doc') diff --git a/doc/cha-auth.texi b/doc/cha-auth.texi index f42fba2154..92bb12ccdb 100644 --- a/doc/cha-auth.texi +++ b/doc/cha-auth.texi @@ -184,7 +184,7 @@ algorithm. @node Anonymous authentication @section Anonymous authentication -@cindex Anonymous authentication +@cindex anonymous authentication The anonymous key exchange performs encryption but there is no indication of the identity of the peer. This kind of authentication diff --git a/doc/cha-cert-auth.texi b/doc/cha-cert-auth.texi index c918c7b9df..cce8acc97f 100644 --- a/doc/cha-cert-auth.texi +++ b/doc/cha-cert-auth.texi @@ -1,6 +1,6 @@ @node More on certificate authentication @chapter More on certificate authentication -@cindex Certificate authentication +@cindex certificate authentication @menu * X.509 certificates:: @@ -140,7 +140,7 @@ demonstrate the @acronym{X.509} parsing capabilities can be found at @node Verifying X.509 certificate paths @subsection Verifying @acronym{X.509} certificate paths -@cindex Verifying certificate paths +@cindex verifying certificate paths Verifying certificate paths is important in @acronym{X.509} authentication. For this purpose the following functions are @@ -166,7 +166,7 @@ This purpose is served by the functions @funcref{gnutls_x509_trust_list_add_name @node Verifying a certificate in the context of TLS session @subsection Verifying a certificate in the context of TLS session -@cindex Verifying certificate paths +@cindex verifying certificate paths @tindex gnutls_certificate_verify_flags When operating in the context of a TLS session, the trusted certificate @@ -268,7 +268,7 @@ consult @xcite{RFC2818} and section @ref{ex:verify} for an example. @node Certificate requests @subsection @acronym{PKCS} #10 certificate requests -@cindex Certificate requests +@cindex certificate requests @cindex @acronym{PKCS} #10 A certificate request is a structure, which contain information about @@ -445,7 +445,8 @@ to verify the signatures in the certificate sent by the peer. @node Hardware tokens @section Hardware tokens @cindex PKCS #11 tokens -@cindex Hardware tokens +@cindex hardware tokens +@cindex smart cards @subsection Introduction This section copes with hardware token support in @acronym{GnuTLS} using @@ -595,7 +596,7 @@ certificates by specifying a PKCS #11 URL instead of a filename. @node Abstract key types @section Abstract key types -@cindex Abstract types +@cindex abstract types Since there are many forms of a public or private keys supported by @acronym{GnuTLS} such as @acronym{X.509}, @acronym{OpenPGP}, or @acronym{PKCS} #11 it is desirable to allow common operations @@ -697,7 +698,7 @@ key abstractions. @node Digital signatures @section Digital signatures -@cindex Digital signatures +@cindex digital signatures In this section we will provide some information about digital signatures, how they work, and give the rationale for disabling some diff --git a/doc/cha-ciphersuites.texi b/doc/cha-ciphersuites.texi index 916c2abae1..fcf650a3ee 100644 --- a/doc/cha-ciphersuites.texi +++ b/doc/cha-ciphersuites.texi @@ -1,7 +1,7 @@ @node Supported ciphersuites in GnuTLS @appendix Supported Ciphersuites in @acronym{GnuTLS} @anchor{ciphersuites} -@cindex Ciphersuites +@cindex ciphersuites @include algorithms.texi diff --git a/doc/cha-errors.texi b/doc/cha-errors.texi index 84d23361eb..0948d0552d 100644 --- a/doc/cha-errors.texi +++ b/doc/cha-errors.texi @@ -1,6 +1,6 @@ @node Error codes @appendix Error Codes and Descriptions -@cindex Error codes +@cindex error codes The error codes used throughout the library are described below. The return code @code{GNUTLS_E_SUCCESS} indicate successful operation, and diff --git a/doc/cha-functions.texi b/doc/cha-functions.texi index 56e36fca01..c671fcbbb2 100644 --- a/doc/cha-functions.texi +++ b/doc/cha-functions.texi @@ -1,6 +1,6 @@ @node Function reference @appendix Function Reference -@cindex Function reference +@cindex function reference @menu * Core functions:: diff --git a/doc/cha-gtls-app.texi b/doc/cha-gtls-app.texi index a00ded33fb..d7df236e5c 100644 --- a/doc/cha-gtls-app.texi +++ b/doc/cha-gtls-app.texi @@ -1,7 +1,8 @@ @node How to use GnuTLS in applications @chapter How to use @acronym{GnuTLS} in applications @anchor{examples} -@cindex Example programs +@cindex example programs +@cindex examples @menu * Preparation:: @@ -653,8 +654,8 @@ information about it. @node Parameter generation @subsection Parameter generation -@cindex Parameter generation -@cindex Generating parameters +@cindex parameter generation +@cindex generating parameters Several TLS ciphersuites require additional parameters that need to be generated or provided by the application. The @@ -695,8 +696,8 @@ an alternative interface is available using a callback function. @node Keying Material Exporters @subsection Keying material exporters -@cindex Keying material exporters -@cindex Exporting keying material +@cindex keying material exporters +@cindex exporting keying material The TLS PRF can be used by other protocols to derive data. The API to use is @funcref{gnutls_prf}. The function needs to be provided with the @@ -721,7 +722,7 @@ low-level TLS PRF interface called @funcref{gnutls_prf_raw}. @node Channel Bindings @subsection Channel bindings -@cindex Channel bindings +@cindex channel bindings In user authentication protocols (e.g., EAP or SASL mechanisms) it is useful to have a unique string that identifies the secure channel that @@ -799,7 +800,7 @@ to the random number generation. @node Symmetric cryptography @subsection Symmetric cryptography -@cindex Symmetric cryptography +@cindex symmetric cryptography The available functions to access symmetric crypto algorithms operations are shown below. The supported algorithms are the algorithms required by the TLS protocol. @@ -814,7 +815,7 @@ functions are provided to set the associated data and retrieve the authenticatio @node Hash and HMAC functions @subsection Hash and HMAC functions -@cindex Hash functions +@cindex hash functions @cindex HMAC functions The available operations to access hash functions and hash-MAC (HMAC) algorithms @@ -829,7 +830,7 @@ are the same as the HMAC algorithms. @node Random number generation @subsection Random number generation -@cindex Random numbers +@cindex random numbers Access to the random number generator is provided using the @funcref{gnutls_rnd} function. diff --git a/doc/cha-internals.texi b/doc/cha-internals.texi index 30bc70b887..f752b9eac6 100644 --- a/doc/cha-internals.texi +++ b/doc/cha-internals.texi @@ -1,6 +1,6 @@ @node Internal architecture of GnuTLS @chapter Internal Architecture of GnuTLS -@cindex Internal architecture +@cindex internal architecture This chapter is to give a brief description of the way @acronym{GnuTLS} works. The focus is to give an idea diff --git a/doc/cha-intro-tls.texi b/doc/cha-intro-tls.texi index 7575ab719c..ae22d5790a 100644 --- a/doc/cha-intro-tls.texi +++ b/doc/cha-intro-tls.texi @@ -58,8 +58,8 @@ protocol. The protocol layering in TLS is shown in @ref{fig:tls-layers}. @node The transport layer @section The transport layer -@cindex Transport protocol -@cindex Transport layer +@cindex transport protocol +@cindex transport layer @acronym{TLS} is not limited to any transport layer and can be used above any transport layer, as long as it is a reliable one. @acronym{DTLS} @@ -106,7 +106,7 @@ will use the Berkeley sockets. @node The TLS record protocol @section The TLS record protocol -@cindex Record protocol +@cindex record protocol The record protocol is the secure communications provider. Its purpose is to encrypt, authenticate and ---optionally--- compress packets. @@ -143,7 +143,7 @@ just after the handshake protocol has finished. @node Encryption algorithms used in the record layer @subsection Encryption algorithms used in the record layer -@cindex Symmetric encryption algorithms +@cindex symmetric encryption algorithms Confidentiality in the record layer is achieved by using symmetric block encryption algorithms like @code{3DES}, @code{AES} @@ -218,7 +218,7 @@ GCM, is in use. @node Compression algorithms used in the record layer @subsection Compression algorithms used in the record layer -@cindex Compression algorithms +@cindex compression algorithms The TLS record layer also supports compression. The algorithms implemented in @acronym{GnuTLS} can be found in the table below. @@ -270,8 +270,8 @@ see the archives of the TLS Working Group mailing list and @xcite{CBCATT}. @node On Record Padding @subsection On record padding -@cindex Record padding -@cindex Bad record MAC +@cindex record padding +@cindex bad_record_mac The TLS protocol allows for random padding of records, to prevent statistical analysis based on the length of exchanged messages (see @xcite{RFC5246} section 6.2.3.2). @@ -303,7 +303,7 @@ different incoming IP addresses. @node The TLS Alert Protocol @section The TLS alert protocol @anchor{The Alert Protocol} -@cindex Alert protocol +@cindex alert protocol The alert protocol is there to allow signals to be sent between peers. These signals are mostly used to inform the peer about the cause of a @@ -334,7 +334,7 @@ protocol are shown below. @node The TLS Handshake Protocol @section The TLS handshake protocol @anchor{The Handshake Protocol} -@cindex Handshake protocol +@cindex handshake protocol The handshake protocol is responsible for the ciphersuite negotiation, the initial key exchange, and the authentication of the two peers. @@ -381,7 +381,7 @@ All the supported ciphersuites are listed in @ref{ciphersuites}. @node Client Authentication @subsection Client authentication -@cindex Client Certificate authentication +@cindex client certificate authentication In the case of ciphersuites that use certificate authentication, the authentication of the client is optional in @acronym{TLS}. A server @@ -408,7 +408,8 @@ signed by server's acceptable signers. @node Resuming Sessions @subsection Resuming sessions @anchor{resume} -@cindex Resuming sessions +@cindex resuming sessions +@cindex session resuming The @funcref{gnutls_handshake} function, is expensive since a lot of calculations are performed. In order to support many fast connections @@ -501,7 +502,7 @@ and they will be discussed in the subsections that follow. @subsection Maximum fragment length negotiation @cindex TLS extensions -@cindex Maximum fragment length +@cindex maximum fragment length This extension allows a @acronym{TLS} implementation to negotiate a smaller value for record packet maximum length. This extension may be @@ -515,7 +516,7 @@ below can be used to control this extension. @subsection Server name indication @anchor{serverind} @cindex TLS extensions -@cindex Server name indication +@cindex server name indication A common problem in @acronym{HTTPS} servers is the fact that the @acronym{TLS} protocol is not aware of the hostname that a client @@ -535,8 +536,8 @@ client. @subsection Session tickets @cindex TLS extensions -@cindex Session tickets -@cindex Ticket +@cindex session tickets +@cindex tickets To resume a TLS session the server normally store some state. This complicates deployment, and typical situations the client can cache diff --git a/doc/cha-library.texi b/doc/cha-library.texi index 23020c4538..c199439d49 100644 --- a/doc/cha-library.texi +++ b/doc/cha-library.texi @@ -193,7 +193,7 @@ int main() @node Callback functions @section Callback functions -@cindex Callback functions +@cindex callback functions There are several cases where @acronym{GnuTLS} may need out of band input from your program. This is now implemented using some diff --git a/doc/cha-support.texi b/doc/cha-support.texi index 835482feca..7c171d9d0f 100644 --- a/doc/cha-support.texi +++ b/doc/cha-support.texi @@ -60,8 +60,8 @@ be mentioned here, contact the authors. @node Downloading and Installing @section Downloading and Installing -@cindex Installation -@cindex Download +@cindex installation +@cindex download GnuTLS is available for download at: @url{http://www.gnutls.org/download.html} @@ -111,7 +111,7 @@ For the complete list, refer to the output from @code{configure --help}. @node Bug Reports @section Bug Reports -@cindex Reporting Bugs +@cindex reporting bugs If you think you have found a bug in GnuTLS, please investigate it and report it. @@ -152,8 +152,8 @@ Send your bug report to: @node Contributing @section Contributing -@cindex Contributing -@cindex Hacking +@cindex contributing +@cindex hacking If you want to submit a patch for inclusion -- from solving a typo you discovered, up to adding support for a new feature -- you should -- cgit v1.2.1