From f5a14bf320d8c8bd011a7aff067ffa6f1cea45c7 Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Tue, 5 Jan 2016 21:05:40 +0300 Subject: [PATCH] [DOC] Create glossary in user manual and move pages to it Signed-off-by: Sergey Matveev --- doc/cpr.texi | 4 ++-- doc/egd.texi | 2 +- doc/glossary.texi | 28 ++++++++++++++++++++++++++++ doc/identity.texi | 2 +- doc/mtu.texi | 2 +- doc/netproto.texi | 2 +- doc/noise.texi | 2 +- doc/pake.texi | 2 +- doc/proxy.texi | 2 +- doc/stats.texi | 2 +- doc/timeout.texi | 2 +- doc/user.texi | 24 ++---------------------- doc/verifier.texi | 2 +- 13 files changed, 42 insertions(+), 34 deletions(-) create mode 100644 doc/glossary.texi diff --git a/doc/cpr.texi b/doc/cpr.texi index 5256a81..5ea5717 100644 --- a/doc/cpr.texi +++ b/doc/cpr.texi @@ -1,5 +1,5 @@ @node CPR -@section Constant Packet Rate +@subsection Constant Packet Rate Constant Packet Rate is used to hide fact of underlying payload packets appearance. In this mode daemon inserts necessary dummy packets and @@ -7,4 +7,4 @@ delays other ones. This mode is turned by @code{-cpr} option, where you specify desired outgoing traffic rate in KiB/sec (kibibytes per second). This option also -@strong{forces} using of the @ref{Noise}! It is turned off by default. +@strong{forces} using of the @ref{Noise, noise}! It is turned off by default. diff --git a/doc/egd.texi b/doc/egd.texi index 62d1d87..c0006db 100644 --- a/doc/egd.texi +++ b/doc/egd.texi @@ -1,5 +1,5 @@ @node EGD -@section Entropy Gathering Daemon +@subsection Entropy Gathering Daemon Overall security mainly depends on client side: @ref{PAKE, good passphrase} and cryprographically good pseudo random diff --git a/doc/glossary.texi b/doc/glossary.texi new file mode 100644 index 0000000..8d1158f --- /dev/null +++ b/doc/glossary.texi @@ -0,0 +1,28 @@ +@node Glossary +@section Glossary + +@menu +* Entropy gathering daemon: EGD. +* Identity:: +* Password Authenticated Key Agreement: PAKE. +* Timeout:: +* Network transport: Network. +* Proxy:: +* Maximum Transmission Unit: MTU. +* Statistics: Stats. +* Noise:: +* Constant Packet Rate: CPR. +* Verifier:: +@end menu + +@include egd.texi +@include identity.texi +@include pake.texi +@include timeout.texi +@include netproto.texi +@include proxy.texi +@include mtu.texi +@include stats.texi +@include noise.texi +@include cpr.texi +@include verifier.texi diff --git a/doc/identity.texi b/doc/identity.texi index 3153abd..3a37790 100644 --- a/doc/identity.texi +++ b/doc/identity.texi @@ -1,5 +1,5 @@ @node Identity -@section Identity +@subsection Identity Client's identity is 128-bit string. It is not secret, so can be transmitted and stored in the clear. However handshake applies PRP on it diff --git a/doc/mtu.texi b/doc/mtu.texi index 9c958cd..f847166 100644 --- a/doc/mtu.texi +++ b/doc/mtu.texi @@ -1,5 +1,5 @@ @node MTU -@section Maximum Transmission Unit +@subsection Maximum Transmission Unit MTU option tells what maximum transmission unit is expected to get from TAP interface. It is per-user configuration. If the program gets bigger diff --git a/doc/netproto.texi b/doc/netproto.texi index d033656..d57edb3 100644 --- a/doc/netproto.texi +++ b/doc/netproto.texi @@ -1,5 +1,5 @@ @node Network -@section Network transport +@subsection Network transport You can use either UDP or TCP underlying network transport protocols. diff --git a/doc/noise.texi b/doc/noise.texi index 06ee1de..9cd03d2 100644 --- a/doc/noise.texi +++ b/doc/noise.texi @@ -1,5 +1,5 @@ @node Noise -@section Noise +@subsection Noise So-called noise is used to hide underlying payload packets lengths. Without it GoVPN provides confidentiality and authenticity of messages, diff --git a/doc/pake.texi b/doc/pake.texi index fa8a322..b80f569 100644 --- a/doc/pake.texi +++ b/doc/pake.texi @@ -1,5 +1,5 @@ @node PAKE -@section Password Authenticated Key Agreement +@subsection Password Authenticated Key Agreement Previously we used pre-shared high-entropy long-term static key for client-server authentication. Is is secure, but not convenient for some diff --git a/doc/proxy.texi b/doc/proxy.texi index 0e99035..b0f08fc 100644 --- a/doc/proxy.texi +++ b/doc/proxy.texi @@ -1,5 +1,5 @@ @node Proxy -@section Proxy +@subsection Proxy You can proxy your requests through HTTP using CONNECT method. This can help if you are only allowed to access outside world through HTTP proxy diff --git a/doc/stats.texi b/doc/stats.texi index f6284e0..c543137 100644 --- a/doc/stats.texi +++ b/doc/stats.texi @@ -1,5 +1,5 @@ @node Stats -@section Stats +@subsection Statistics Both client and server has ability to show statistics about known connected peers. You retrieve them by downloading JSON from built-in diff --git a/doc/timeout.texi b/doc/timeout.texi index 0f2e2db..89dd5b0 100644 --- a/doc/timeout.texi +++ b/doc/timeout.texi @@ -1,5 +1,5 @@ @node Timeout -@section Timeout +@subsection Timeout Because of stateless UDP nature there is no way to reliably know if remote peer is alive. That is why timeouts are necessary. If no packets diff --git a/doc/user.texi b/doc/user.texi index 73214da..d2118b3 100644 --- a/doc/user.texi +++ b/doc/user.texi @@ -14,33 +14,13 @@ What network performance can user expect? For example single with @emph{Go 1.5.1} gives 786 Mbps (UDP transport) throughput. @menu -* EGD:: Entropy gathering daemon -* Identity:: -* PAKE:: Password Authenticated Key Agreement -* Timeout:: -* Network transport: Network. -* Proxy:: -* MTU:: Maximum Transmission Unit -* Stats:: -* Noise:: -* CPR:: Constant Packet Rate -* Verifier:: +* Glossary:: * Client part: Client. * Server part: Server. * Example usage: Example. @end menu -@include egd.texi -@include identity.texi -@include pake.texi -@include timeout.texi -@include netproto.texi -@include proxy.texi -@include mtu.texi -@include stats.texi -@include noise.texi -@include cpr.texi -@include verifier.texi +@include glossary.texi @include client.texi @include server.texi @include example.texi diff --git a/doc/verifier.texi b/doc/verifier.texi index 74c6149..bb364d7 100644 --- a/doc/verifier.texi +++ b/doc/verifier.texi @@ -1,5 +1,5 @@ @node Verifier -@section Verifier +@subsection Verifier Verifier is created using @code{govpn-verifier} utility. But currently Go does not provide native instruments to read passwords without echoing -- 2.44.0