From 4b6010d63d3512094c7cef4a119a8d45cb1a7b18 Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Sun, 31 Jan 2016 14:16:27 +0300 Subject: [PATCH] [DOC] Refactoring and more russian translation Signed-off-by: Sergey Matveev --- NEWS.RU | 1 + THANKS | 7 +- TODO | 2 +- doc/Makefile | 8 +- doc/about.ru.texi | 17 +-- doc/about.texi | 15 +- doc/client.texi | 20 +-- doc/contacts.texi | 5 - doc/cpr.texi | 4 +- doc/developer.texi | 3 - doc/download.texi | 39 +++-- doc/egd.texi | 11 +- doc/encless.texi | 7 - doc/example.texi | 30 ++-- doc/faq.ru.texi | 138 ++++++++++------- doc/faq.texi | 154 +++++++++++-------- doc/handshake.texi | 15 -- doc/identity.texi | 2 - doc/{govpn.texi => index.texi} | 16 +- doc/installation.texi | 27 ++-- doc/integrity.texi | 6 +- doc/media.texi | 2 - doc/mtu.texi | 2 - doc/netproto.texi | 4 - doc/news.ru.texi | 267 +++++++++++++++++++++++++++++++++ doc/news.texi | 185 ++++++++++++----------- doc/noise.texi | 4 +- doc/pake.texi | 2 - doc/precautions.texi | 4 +- doc/proxy.texi | 9 +- doc/russian.texi | 12 ++ doc/server.texi | 23 +-- doc/sources.texi | 10 +- doc/stats.texi | 4 +- doc/style.css | 13 ++ doc/thanks.texi | 23 +-- doc/timeout.texi | 1 - doc/timesync.texi | 6 +- doc/todo.texi | 7 - doc/transport.texi | 8 - doc/user.texi | 3 - doc/verifier.texi | 16 +- doc/verifierstruct.texi | 4 - 43 files changed, 681 insertions(+), 455 deletions(-) create mode 120000 NEWS.RU mode change 120000 => 100644 THANKS mode change 120000 => 100644 TODO rename doc/{govpn.texi => index.texi} (81%) create mode 100644 doc/news.ru.texi create mode 100644 doc/russian.texi delete mode 100644 doc/todo.texi diff --git a/NEWS.RU b/NEWS.RU new file mode 120000 index 0000000..85f9daf --- /dev/null +++ b/NEWS.RU @@ -0,0 +1 @@ +doc/news.ru.texi \ No newline at end of file diff --git a/THANKS b/THANKS deleted file mode 120000 index 7862103..0000000 --- a/THANKS +++ /dev/null @@ -1 +0,0 @@ -doc/thanks.texi \ No newline at end of file diff --git a/THANKS b/THANKS new file mode 100644 index 0000000..740d6b3 --- /dev/null +++ b/THANKS @@ -0,0 +1,6 @@ +* Applied Cryptography (https://www.schneier.com/books/applied_cryptography/) (C) 1996 Bruce Schneier. +* Strong Password-Only Authenticated Key Exchange (http://tnlandforms.us/cns05/speke.pdf) (C) 1996 David P. Jablon. +* Augmented Encrypted Key Exchange (https://www.cs.columbia.edu/~smb/papers/aeke.pdf): a Password-Based Protocol Secure Against Dictionary Attacks and Password File Compromise (C) Steven M. Belloving, Michael Merrit. +* Watson Ladd for suggestion of Elligator (http://elligator.cr.yp.to/) encoding. +* Password Hashing Competition for Argon2 (https://password-hashing.net/#argon2). +* Chaffing and Winnowing: Confidentiality without Encryption (http://people.csail.mit.edu/rivest/chaffing-980701.txt) (C) Ronald L. Rivest diff --git a/TODO b/TODO deleted file mode 120000 index e8b79ff..0000000 --- a/TODO +++ /dev/null @@ -1 +0,0 @@ -doc/todo.texi \ No newline at end of file diff --git a/TODO b/TODO new file mode 100644 index 0000000..2ecafb0 --- /dev/null +++ b/TODO @@ -0,0 +1 @@ +* Randomize ports usage diff --git a/doc/Makefile b/doc/Makefile index e68437a..d51a843 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -6,8 +6,12 @@ handshake.utxt: handshake.txt plantuml -tutxt handshake.txt govpn.info: *.texi handshake.utxt - $(MAKEINFO) govpn.texi + $(MAKEINFO) index.texi govpn.html: *.texi handshake.utxt rm -f govpn.html/*.html - $(MAKEINFO) --html --css-include=style.css -o govpn.html govpn.texi + $(MAKEINFO) --html \ + --css-include=style.css \ + --set-customization-variable SHOW_TITLE=0 \ + --set-customization-variable DATE_IN_HEADER=1 \ + -o govpn.html index.texi diff --git a/doc/about.ru.texi b/doc/about.ru.texi index f24725c..5bb7995 100644 --- a/doc/about.ru.texi +++ b/doc/about.ru.texi @@ -1,10 +1,5 @@ @node О демоне -@cindex About (russian) -@cindex Description (russian) -@cindex О демоне -@cindex Описание -@cindex Вступление -@unnumbered Подробнее о демоне GoVPN +@section Подробнее о демоне GoVPN GoVPN это простой демон виртуальных частных сетей, код которого нацелен на лёгкость чтения и анализа, безопасность, устойчивость к DPI/цензуре. @@ -12,8 +7,10 @@ GoVPN это простой демон виртуальных частных с @itemize @item -Свободное программное обеспечение, копилефт: лицензировано под условиями -@url{https://www.gnu.org/licenses/gpl-3.0.ru.html, GPLv3+}. +@url{https://www.gnu.org/philosophy/free-sw.ru.html, Свободное программное +обеспечение}, @url{https://www.gnu.org/philosophy/pragmatic.ru.html, копилефт}: +лицензировано под условиями @url{https://www.gnu.org/licenses/gpl-3.0.ru.html, +GPLv3+}. @item Быстрый сильный @ref{PAKE, аутентифицируемый по парольной фразе} @@ -22,7 +19,7 @@ GoVPN это простой демон виртуальных частных с A-EKE (Diffie-Hellman Augmented Encrypted Key Exchange)). @item -@ref{Verifier structure, Несбалансированные аутентификационные токены} +@ref{Verifier structure, Несбалансированные верификаторы} устойчивые к внесетевым (offline) атакам по словарю. Используют усиленный по CPU и памяти алгоритм хэширования. Злоумышленник не может замаскироваться под клиента даже скомпрометировав базу данных токенов @@ -50,7 +47,7 @@ A-EKE (Diffie-Hellman Augmented Encrypted Key Exchange)). @item Защита от атак повторного воспроизведения (replay) (используя -одноразовые MAC и опциональное условие синхронизации времени). +одноразовые MAC и опциональное условие @ref{Timesync, синхронизации времени}). @item Встроенные функции пересогласования ключей (ротация сессионных ключей) и diff --git a/doc/about.texi b/doc/about.texi index 25f0f12..a3ed945 100644 --- a/doc/about.texi +++ b/doc/about.texi @@ -1,16 +1,15 @@ -@cindex About -@cindex Description -@cindex Introduction - GoVPN is simple free software virtual private network daemon, aimed to be reviewable, secure and @url{https://en.wikipedia.org/wiki/Deep_packet_inspection, DPI}/censorship-resistant. +See also this page @ref{О демоне, on russian}. + @itemize @item -Copylefted free software: licenced under -@url{https://www.gnu.org/licenses/gpl-3.0.html, GPLv3+}. +@url{https://www.gnu.org/philosophy/pragmatic.html, Copylefted} +@url{https://www.gnu.org/philosophy/free-sw.html, free software}: +licenced under @url{https://www.gnu.org/licenses/gpl-3.0.html, GPLv3+}. @item Fast strong @ref{PAKE, passphrase authenticated} augmented @@ -44,8 +43,8 @@ indistinguishable from the noise with optionally hidden packets length. property. @item -Replay attack protection (using one-time MACs and optional time -synchronization requirement). +Replay attack protection (using one-time MACs and optional +@ref{Timesync, time synchronization} requirement). @item Built-in rehandshake (session key rotation) and heartbeat features. diff --git a/doc/client.texi b/doc/client.texi index 654ec98..5b0ae2b 100644 --- a/doc/client.texi +++ b/doc/client.texi @@ -1,22 +1,16 @@ @node Client -@cindex Client -@cindex Client part -@cindex Client configuration -@cindex Client side -@cindex Configuring client -@cindex govpn-client @section Client part -Except for common @code{-stats}, @code{-egd} options client has the -following ones: +Except for common @ref{Stats, -stats}, @ref{EGD, -egd} options client +has the following ones: -@table @code +@table @option @item -mtu Expected TAP interface @ref{MTU}. @item -proto -@ref{Network, network protocol} to use. Can be either @emph{udp} +@ref{Network, Network protocol} to use. Can be either @emph{udp} (default) or @emph{tcp}. @item -proxy @@ -61,7 +55,7 @@ Optional path to script that will be executed after connection is established. Interface name will be given to it as a first argument. @item -down -Same as @code{-up} above, but it is executed when connection is lost, +Same as @option{-up} above, but it is executed when connection is lost, when we exit. @end table @@ -69,11 +63,11 @@ when we exit. Example up-script that calls DHCP client and IPv6 advertisement solicitation: -@example +@verbatim client% cat > up.sh <