[Openvpn-devel] Correct the declaration of handle in 'struct openvpn_plugin_args_open_return'

Message ID 1511228605-23207-1-git-send-email-selva.nair@gmail.com
State Accepted
Headers show
Series
  • [Openvpn-devel] Correct the declaration of handle in 'struct openvpn_plugin_args_open_return'
Related show

Commit Message

Selva Nair Nov. 21, 2017, 1:43 a.m.
From: Selva Nair <selva.nair@gmail.com>

- This is an opaque pointer so the change should not affect
  existing plugins. But it makes the code consistent and clears up
  the documentation as the handle pointer is treated as of type
  "openvpn_plugin_handle_t" in the rest of the code.

Signed-off-by: Selva Nair <selva.nair@gmail.com>
---
 v2: no change

 include/openvpn-plugin.h.in | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Antonio Quartulli July 31, 2018, 5:21 p.m. | #1
Hi,

On 21/11/17 09:43, selva.nair@gmail.com wrote:
> From: Selva Nair <selva.nair@gmail.com>
> 
> - This is an opaque pointer so the change should not affect
>   existing plugins. But it makes the code consistent and clears up
>   the documentation as the handle pointer is treated as of type
>   "openvpn_plugin_handle_t" in the rest of the code.
> 
> Signed-off-by: Selva Nair <selva.nair@gmail.com>

Will make some noise during application (git pw patch apply 87), such as:
"Falling back to patching base and 3-way merge..."

But it won't generate any conflict.

Acked-by: Antonio Quartulli <a@unstable.cc>
Gert Doering July 31, 2018, 8:19 p.m. | #2
Hi,

On Wed, Aug 01, 2018 at 01:21:35AM +0800, Antonio Quartulli wrote:
> On 21/11/17 09:43, selva.nair@gmail.com wrote:
> > From: Selva Nair <selva.nair@gmail.com>
> > 
> > - This is an opaque pointer so the change should not affect
> >   existing plugins. But it makes the code consistent and clears up
> >   the documentation as the handle pointer is treated as of type
> >   "openvpn_plugin_handle_t" in the rest of the code.
> > 
> > Signed-off-by: Selva Nair <selva.nair@gmail.com>
> 
> Will make some noise during application (git pw patch apply 87), such as:
> "Falling back to patching base and 3-way merge..."
> 
> But it won't generate any conflict.
> 
> Acked-by: Antonio Quartulli <a@unstable.cc>

Oh, we had the patch on the list already.  Thanks for finding it & ACK.

I'll apply tomorrow or thursday, on the road right now.

gert
Gert Doering Aug. 5, 2018, 6:59 p.m. | #3
Your patch has been applied to the master and release/2.4 branch (bugfix).

The "git complains" part was due to patch context still talking about 
ENABLE_CRYPTO, which doesn't exist anymore in master - easily workarounded.

commit a2f43c2d6f086e7aa8b6160793f0c462ee9d6aa7 (master)
commit 359e66bcb17c856a74cada9136ae1b8f411a2493 (release/2.4)
Author: Selva Nair
Date:   Mon Nov 20 20:43:25 2017 -0500

     Correct the declaration of handle in 'struct openvpn_plugin_args_open_return'

     Signed-off-by: Selva Nair <selva.nair@gmail.com>
     Acked-by: Antonio Quartulli <antonio@openvpn.net>
     Message-Id: <1511228605-23207-1-git-send-email-selva.nair@gmail.com>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg15908.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot

Patch

diff --git a/include/openvpn-plugin.h.in b/include/openvpn-plugin.h.in
index f29b3a0..dfc8e1e 100644
--- a/include/openvpn-plugin.h.in
+++ b/include/openvpn-plugin.h.in
@@ -355,7 +355,7 @@  struct openvpn_plugin_args_open_in
  *              type_mask = OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_CONNECT)
  *                         | OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_DISCONNECT)
  *
- * *handle :    Pointer to a global plug-in context, created by the plug-in.  This pointer
+ * handle :     Pointer to a global plug-in context, created by the plug-in.  This pointer
  *              is passed on to the other plug-in calls.
  *
  * return_list : used to return data back to OpenVPN.
@@ -364,7 +364,7 @@  struct openvpn_plugin_args_open_in
 struct openvpn_plugin_args_open_return
 {
     int type_mask;
-    openvpn_plugin_handle_t *handle;
+    openvpn_plugin_handle_t handle;
     struct openvpn_plugin_string_list **return_list;
 };
 
@@ -386,9 +386,9 @@  struct openvpn_plugin_args_open_return
  *        these variables are not actually written to the "official"
  *        environmental variable store of the process.
  *
- * *handle : Pointer to a global plug-in context, created by the plug-in's openvpn_plugin_open_v3().
+ * handle : Pointer to a global plug-in context, created by the plug-in's openvpn_plugin_open_v3().
  *
- * *per_client_context : the per-client context pointer which was returned by
+ * per_client_context : the per-client context pointer which was returned by
  *        openvpn_plugin_client_constructor_v1, if defined.
  *
  * current_cert_depth : Certificate depth of the certificate being passed over (only if compiled with ENABLE_CRYPTO defined)