[Openvpn-devel] [PATCH] Documentation, debug and const-correctness fixes

[Openvpn-devel] [PATCH] Documentation, debug and const-correctness fixes

[Steffan Karger]

Hi,

The following three patches contain a number of minor fixes.  They were
originally written by Gert van Dijk, but I have the honor to provide
them to you.  So I added the signed-off-by line.  All improvements are
Gert's, all bugs are my fault ;-)

-Steffan

[Openvpn-devel] [PATCH 1/3] Minor reliability layer documentation fixes

[Steffan Karger]

From: Gert van Dijk <gert.vandijk@...1435...>

Signed-off-by: Steffan Karger <steffan.karger@...1435...>
---
 doc/doxygen/doc_protocol_overview.h | 2 +-
 src/openvpn/ssl.c                   | 4 ++--
 src/openvpn/ssl.h                   | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/doxygen/doc_protocol_overview.h b/doc/doxygen/doc_protocol_overview.h
index db24d3b..3f48b18 100644
--- a/doc/doxygen/doc_protocol_overview.h
+++ b/doc/doxygen/doc_protocol_overview.h
@@ -134,7 +134,7 @@
  * without wasting resources on attempting a TLS handshake which will
  * ultimately fail.
  *
- * @subsection network_protocol_control_key_methods Control channel key methods and
+ * @subsection network_protocol_control_key_methods Control channel key methods
  *
  * Once the TLS session has been initialized and authenticated, the TLS
  * channel is used to exchange random %key material for bidirectional
diff --git a/src/openvpn/ssl.c b/src/openvpn/ssl.c
index 669f941..dcb5445 100644
--- a/src/openvpn/ssl.c
+++ b/src/openvpn/ssl.c
@@ -3660,8 +3660,8 @@ tls_pre_decrypt(struct tls_multi *multi,
             }
 
             /*
-             * We have an authenticated packet (if --tls-auth was set).
-             * Now pass to our reliability level which deals with
+             * We have an authenticated control channel packet (if --tls-auth was set).
+             * Now pass to our reliability layer which deals with
              * packet acknowledgements, retransmits, sequencing, etc.
              */
             {
diff --git a/src/openvpn/ssl.h b/src/openvpn/ssl.h
index a2501c9..72227d9 100644
--- a/src/openvpn/ssl.h
+++ b/src/openvpn/ssl.h
@@ -76,7 +76,7 @@
 /*
  * Define number of buffers for send and receive in the reliability layer.
  */
-#define TLS_RELIABLE_N_SEND_BUFFERS  4 /* also window size for reliablity layer */
+#define TLS_RELIABLE_N_SEND_BUFFERS  4 /* also window size for reliability layer */
 #define TLS_RELIABLE_N_REC_BUFFERS   8
 
 /*
-- 
2.7.4

[Openvpn-devel] [PATCH 2/3] Make second parameter to reliable_send_purge() const

[Steffan Karger]

From: Gert van Dijk <gert.vandijk@...1435...>

Signed-off-by: Steffan Karger <steffan.karger@...1435...>
---
 src/openvpn/reliable.c | 2 +-
 src/openvpn/reliable.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/openvpn/reliable.c b/src/openvpn/reliable.c
index b62ab54..d295076 100644
--- a/src/openvpn/reliable.c
+++ b/src/openvpn/reliable.c
@@ -352,7 +352,7 @@ reliable_empty(const struct reliable *rel)
 
 /* del acknowledged items from send buf */
 void
-reliable_send_purge(struct reliable *rel, struct reliable_ack *ack)
+reliable_send_purge(struct reliable *rel, const struct reliable_ack *ack)
 {
     int i, j;
     for (i = 0; i < ack->len; ++i)
diff --git a/src/openvpn/reliable.h b/src/openvpn/reliable.h
index 4d8fc37..688c65c 100644
--- a/src/openvpn/reliable.h
+++ b/src/openvpn/reliable.h
@@ -123,7 +123,7 @@ bool reliable_ack_read(struct reliable_ack *ack,
  * @param ack The acknowledgment structure containing received
  *     acknowledgments.
  */
-void reliable_send_purge(struct reliable *rel, struct reliable_ack *ack);
+void reliable_send_purge(struct reliable *rel, const struct reliable_ack *ack);
 
 /** @} name Functions for processing incoming acknowledgments */
 
-- 
2.7.4

[Openvpn-devel] [PATCH 3/3] Remove unneeded newline in debug message in reliable.c

[Steffan Karger]

From: Gert van Dijk <gert.vandijk@...1435...>

Signed-off-by: Steffan Karger <steffan.karger@...1435...>
---
 src/openvpn/reliable.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/openvpn/reliable.c b/src/openvpn/reliable.c
index d295076..a7f4ed9 100644
--- a/src/openvpn/reliable.c
+++ b/src/openvpn/reliable.c
@@ -462,7 +462,7 @@ reliable_wont_break_sequentiality(const struct reliable *rel, packet_id_type id)
              (packet_id_print_type)id, reliable_print_ids(rel, &gc));
     }
 
-    dmsg(D_REL_DEBUG, "ACK RWBS rel->size=%d rel->packet_id=%08x id=%08x ret=%d\n", rel->size, rel->packet_id, id, ret);
+    dmsg(D_REL_DEBUG, "ACK RWBS rel->size=%d rel->packet_id=%08x id=%08x ret=%d", rel->size, rel->packet_id, id, ret);
 
     gc_free(&gc);
     return ret;
-- 
2.7.4

[Openvpn-devel] [PATCH applied] Re: Minor reliability layer documentation fixes

[Gert Doering]

Acked-by: Gert Doering <gert@...1296...>

That was actually fairly easy as I did not have to understand anything,
just notice that there were typos, funny english, etc. :-)

Your patch has been applied to the master and release/2.4 branch.

commit df612f634a7e2e542e4393601520f7dbb0eb327f (master)
commit 52e6de50a67a968736f5ed3f4fa3d012ea583da8 (release/2.4)
Author: Gert van Dijk
Date:   Wed Jul 18 16:27:51 2018 +0200

     Minor reliability layer documentation fixes

     Signed-off-by: Steffan Karger <steffan.karger@...1435...>
     Acked-by: Gert Doering <gert@...1296...>
     Message-Id: <1531924073-29243-2-git-send-email-steffan.karger@...1435...>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg17260.html
     Signed-off-by: Gert Doering <gert@...1296...>


--
kind regards,

Gert Doering

[Openvpn-devel] [PATCH applied] Re: Make second parameter to reliable_send_purge() const

[Gert Doering]

Acked-by: Gert Doering <gert@...1296...>

Code doesn't modify *ack, so we can as well tell the compiler about it :)

Your patch has been applied to the master branch (this is not a bugfix
and not a long-term stability thing or documentation update, so it does 
not need to go to 2.4)

commit 0f83b5e33ed63fee9f8de384e46cf93b4687c508 (master)
Author: Gert van Dijk
Date:   Wed Jul 18 16:27:52 2018 +0200

     Make second parameter to reliable_send_purge() const

     Signed-off-by: Steffan Karger <steffan.karger@...1435...>
     Acked-by: Gert Doering <gert@...1296...>
     Message-Id: <1531924073-29243-3-git-send-email-steffan.karger@...1435...>
     URL: https://www.mail-archive.com/search?l=mid&q=1531924073-29243-3-git-send-email-steffan.karger@...1435...
     Signed-off-by: Gert Doering <gert@...1296...>


--
kind regards,

Gert Doering

[Openvpn-devel] [PATCH applied] Re: Remove unneeded newline in debug message in reliable.c

[Gert Doering]

Acked-by: Gert Doering <gert@...1296...>

"obvious fix", but if you're used to debugging with printf(), these
newlines slip in... :-) - thanks for fixing.

Your patch has been applied to the master branch.

commit 3e5561d34099f28a759865efff0523005116b6a1
Author: Gert van Dijk
Date:   Wed Jul 18 16:27:53 2018 +0200

     Remove unneeded newline in debug message in reliable.c

     Signed-off-by: Steffan Karger <steffan.karger@...1435...>
     Acked-by: Gert Doering <gert@...1296...>
     Message-Id: <1531924073-29243-4-git-send-email-steffan.karger@...1435...>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg17262.html
     Signed-off-by: Gert Doering <gert@...1296...>


--
kind regards,

Gert Doering