[Openvpn-devel,3/3] Improve the comments related to auth-token-hmac patches

Message ID 20190927224536.27480-4-davids@openvpn.net
State Accepted
Headers show
Series Last-minute fixes to auth-token-hmac patch series | expand

Commit Message

David Sommerseth Sept. 27, 2019, 12:45 p.m. UTC
A couple of places the documentation was not clear enough or not even
correct.  Just improve this to avoid confusion later on.

Signed-off-by: David Sommerseth <davids@openvpn.net>
 src/openvpn/auth_token.h | 2 --
 src/openvpn/ssl_common.h | 2 +-
 2 files changed, 1 insertion(+), 3 deletions(-)


Gert Doering Oct. 1, 2019, 1:17 a.m. UTC | #1
Acked-by: Gert Doering <gert@greenie.muc.de>

Not sure if it really enables anyone outside ovpn tech to understand the
comment about OVPN3 any better, but at least the first hunk is easy to
verify & correct :-)

Your patch has been applied to the master branch.

commit 48a4c81b91bb5978cf21213fe5a85b80962025ee
Author: David Sommerseth
Date:   Sat Sep 28 00:45:36 2019 +0200

     Improve the comments related to auth-token-hmac patches

     Signed-off-by: David Sommerseth <davids@openvpn.net>
     Acked-by: Gert Doering <gert@greenie.muc.de>
     Message-Id: <20190927224536.27480-4-davids@openvpn.net>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg18874.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>

kind regards,

Gert Doering


diff --git a/src/openvpn/auth_token.h b/src/openvpn/auth_token.h
index c10afde9..4b014d44 100644
--- a/src/openvpn/auth_token.h
+++ b/src/openvpn/auth_token.h
@@ -61,8 +61,6 @@  generate_auth_token(const struct user_pass *up, struct tls_multi *multi);
  * Verifies the auth token to be in the format that generate_auth_token
  * create and checks if the token is valid.
- * Also calls generate_auth_token to update the auth-token to extend
- * its validity
 verify_auth_token(struct user_pass *up, struct tls_multi *multi,
diff --git a/src/openvpn/ssl_common.h b/src/openvpn/ssl_common.h
index 5e21009e..8dd08862 100644
--- a/src/openvpn/ssl_common.h
+++ b/src/openvpn/ssl_common.h
@@ -559,7 +559,7 @@  struct tls_multi
      * Auth-token is only valid for an empty username
      * and not the username actually supplied from the client
-     * OpenVPN 3 clients sometimes the empty username with a
+     * OpenVPN 3 clients sometimes wipes or replaces the username with a
      * username hint from their config.
     int auth_token_state_flags;