This patch changes the way the client-connect helper functions communicate with
the main function. Instead of updating cc_succeeded and cc_succeeded_count,
they now return either CC_RET_SUCCEEDED, CC_RET_FAILED or CC_RET_SKIPPED.
In addition, the client-connect helpers are now called in completely identical
ways. This is in preparation of handling the helpers as simple call-backs.
Signed-off-by: Fabian Knittel <fabian.knit...@lettink.de>
---
src/openvpn/multi.c | 122 +++++++++++++++++++++++++++++++---------------------
src/openvpn/multi.h | 11 ++++-
2 files changed, 82 insertions(+), 51 deletions(-)
diff --git a/src/openvpn/multi.c b/src/openvpn/multi.c
index a34f985..4ead41e 100644
--- a/src/openvpn/multi.c
+++ b/src/openvpn/multi.c
@@ -1519,13 +1519,12 @@ multi_client_connect_post_plugin (struct multi_context
*m,
/*
* Called to load management-derived client-connect config
*/
-static void
+static enum client_connect_return
multi_client_connect_mda (struct multi_context *m,
struct multi_instance *mi,
- unsigned int *option_types_found,
- int *cc_succeeded,
- int *cc_succeeded_count)
+ unsigned int *option_types_found)
{
+ enum client_connect_return ret = CC_RET_SKIPPED;
#ifdef MANAGEMENT_DEF_AUTH
if (mi->cc_config)
{
@@ -1551,9 +1550,10 @@ multi_client_connect_mda (struct multi_context *m,
multi_select_virtual_addr (m, mi);
multi_set_virtual_addr_env (m, mi);
- ++*cc_succeeded_count;
+ ret = CC_RET_SUCCEEDED;
}
#endif
+ return ret;
}
static void
@@ -1630,38 +1630,59 @@ multi_connection_established (struct multi_context *m,
struct multi_instance *mi
unsigned int option_types_found = 0;
int cc_succeeded = true; /* client connect script status */
int cc_succeeded_count = 0;
+ enum client_connect_return ret;
multi_client_connect_early_setup (m, mi);
- multi_client_connect_source_ccd (m, mi, &option_types_found);
+ if (cc_succeeded)
+ {
+ ret = multi_client_connect_source_ccd (m, mi, &option_types_found);
+ if (ret == CC_RET_SUCCEEDED)
+ ++cc_succeeded_count;
+ else if (ret == CC_RET_FAILED)
+ cc_succeeded = false;
+ }
- multi_client_connect_call_plugin_v1 (m, mi, &option_types_found,
- &cc_succeeded, &cc_succeeded_count);
+ if (cc_succeeded)
+ {
+ ret = multi_client_connect_call_plugin_v1 (m, mi,
+ &option_types_found);
+ if (ret == CC_RET_SUCCEEDED)
+ ++cc_succeeded_count;
+ else if (ret == CC_RET_FAILED)
+ cc_succeeded = false;
+ }
- multi_client_connect_call_plugin_v2 (m, mi, &option_types_found,
- &cc_succeeded, &cc_succeeded_count);
+ if (cc_succeeded)
+ {
+ ret = multi_client_connect_call_plugin_v2 (m, mi,
+ &option_types_found);
+ if (ret == CC_RET_SUCCEEDED)
+ ++cc_succeeded_count;
+ else if (ret == CC_RET_FAILED)
+ cc_succeeded = false;
+ }
- /*
- * Run --client-connect script.
- */
if (cc_succeeded)
{
- multi_client_connect_call_script (m, mi, &option_types_found,
- &cc_succeeded,
- &cc_succeeded_count);
+ ret = multi_client_connect_call_script (m, mi, &option_types_found);
+ if (ret == CC_RET_SUCCEEDED)
+ ++cc_succeeded_count;
+ else if (ret == CC_RET_FAILED)
+ cc_succeeded = false;
}
- /*
- * Check for client-connect script left by management interface client
- */
if (cc_succeeded)
{
- multi_client_connect_mda (m, mi, &option_types_found,
- &cc_succeeded, &cc_succeeded_count);
+ ret = multi_client_connect_mda (m, mi, &option_types_found);
+ if (ret == CC_RET_SUCCEEDED)
+ ++cc_succeeded_count;
+ else if (ret == CC_RET_FAILED)
+ cc_succeeded = false;
}
- multi_client_connect_late_setup (m, mi, option_types_found,
- cc_succeeded, cc_succeeded_count);
+ multi_client_connect_late_setup (m, mi, option_types_found, cc_succeeded,
+ cc_succeeded_count);
/* set flag so we don't get called again */
mi->connection_established_flag = true;
@@ -1701,11 +1722,13 @@ multi_client_connect_early_setup (struct multi_context
*m,
* Try to source a dynamic config file from the
* --client-config-dir directory.
*/
-static void
+static enum client_connect_return
multi_client_connect_source_ccd (struct multi_context *m,
struct multi_instance *mi,
unsigned int *option_types_found)
{
+ enum client_connect_return ret = CC_RET_SKIPPED;
+
if (mi->context.options.client_config_dir)
{
struct gc_arena gc = gc_new ();
@@ -1743,10 +1766,14 @@ multi_client_connect_source_ccd (struct multi_context
*m,
*/
multi_select_virtual_addr (m, mi);
multi_set_virtual_addr_env (m, mi);
+
+ ret = CC_RET_SUCCEEDED;
}
gc_free (&gc);
}
+
+ return ret;
}
/*
@@ -1754,19 +1781,16 @@ multi_client_connect_source_ccd (struct multi_context
*m,
*
* deprecated callback, use a file for passing back return info
*/
-static void
+static enum client_connect_return
multi_client_connect_call_plugin_v1 (struct multi_context *m,
struct multi_instance *mi,
- unsigned int *option_types_found,
- int *cc_succeeded,
- int *cc_succeeded_count)
+ unsigned int *option_types_found)
{
+ enum client_connect_return ret = CC_RET_SKIPPED;
#ifdef ENABLE_PLUGIN
ASSERT (m);
ASSERT (mi);
ASSERT (option_types_found);
- ASSERT (cc_succeeded);
- ASSERT (cc_succeeded_count);
if (plugin_defined (mi->context.plugins, OPENVPN_PLUGIN_CLIENT_CONNECT))
{
@@ -1777,7 +1801,7 @@ multi_client_connect_call_plugin_v1 (struct multi_context
*m,
if (!dc_file)
{
- *cc_succeeded = false;
+ ret = CC_RET_FAILED;
goto script_depr_failed;
}
@@ -1790,17 +1814,18 @@ multi_client_connect_call_plugin_v1 (struct
multi_context *m,
if (plug_ret != OPENVPN_PLUGIN_FUNC_SUCCESS)
{
msg (M_WARN, "WARNING: client-connect plugin call failed");
- *cc_succeeded = false;
+ ret = CC_RET_FAILED;
}
else
{
multi_client_connect_post (m, mi, dc_file, option_types_found);
- ++*cc_succeeded_count;
+ ret = CC_RET_SUCCEEDED;
}
script_depr_failed:
gc_free (&gc);
}
#endif
+ return ret;
}
/*
@@ -1808,19 +1833,16 @@ script_depr_failed:
*
* V2 callback, use a plugin_return struct for passing back return info
*/
-static void
+static enum client_connect_return
multi_client_connect_call_plugin_v2 (struct multi_context *m,
struct multi_instance *mi,
- unsigned int *option_types_found,
- int *cc_succeeded,
- int *cc_succeeded_count)
+ unsigned int *option_types_found)
{
+ enum client_connect_return ret = CC_RET_SKIPPED;
#ifdef ENABLE_PLUGIN
ASSERT (m);
ASSERT (mi);
ASSERT (option_types_found);
- ASSERT (cc_succeeded);
- ASSERT (cc_succeeded_count);
if (plugin_defined (mi->context.plugins, OPENVPN_PLUGIN_CLIENT_CONNECT_V2))
{
@@ -1835,31 +1857,29 @@ multi_client_connect_call_plugin_v2 (struct
multi_context *m,
if (plug_ret != OPENVPN_PLUGIN_FUNC_SUCCESS)
{
msg (M_WARN, "WARNING: client-connect-v2 plugin call failed");
- *cc_succeeded = false;
+ ret = CC_RET_FAILED;
}
else
{
multi_client_connect_post_plugin (m, mi, &pr, option_types_found);
- ++*cc_succeeded_count;
+ ret = CC_RET_SUCCEEDED;
}
plugin_return_free (&pr);
}
#endif
+ return ret;
}
-static void
+static enum client_connect_return
multi_client_connect_call_script (struct multi_context *m,
struct multi_instance *mi,
- unsigned int *option_types_found,
- int *cc_succeeded,
- int *cc_succeeded_count)
+ unsigned int *option_types_found)
{
+ enum client_connect_return ret = CC_RET_SKIPPED;
ASSERT (m);
ASSERT (mi);
ASSERT (option_types_found);
- ASSERT (cc_succeeded);
- ASSERT (cc_succeeded_count);
if (mi->context.options.client_connect_script)
{
@@ -1872,7 +1892,7 @@ multi_client_connect_call_script (struct multi_context *m,
dc_file = create_temp_file (mi->context.options.tmp_dir, "cc", &gc);
if (!dc_file)
{
- cc_succeeded = false;
+ ret = CC_RET_FAILED;
goto script_failed;
}
@@ -1883,14 +1903,16 @@ multi_client_connect_call_script (struct multi_context
*m,
if (openvpn_run_script (&argv, mi->context.c2.es, 0, "--client-connect"))
{
multi_client_connect_post (m, mi, dc_file, option_types_found);
- ++cc_succeeded_count;
+ ret = CC_RET_SUCCEEDED;
}
else
- cc_succeeded = false;
+ ret = CC_RET_FAILED;
+
script_failed:
argv_reset (&argv);
gc_free (&gc);
}
+ return ret;
}
static void
diff --git a/src/openvpn/multi.h b/src/openvpn/multi.h
index fc2ffb2..0adcd47 100644
--- a/src/openvpn/multi.h
+++ b/src/openvpn/multi.h
@@ -105,7 +105,6 @@ struct multi_instance {
* for this VPN tunnel. */
};
-
/**
* Main OpenVPN server state structure.
*
@@ -169,6 +168,16 @@ struct multi_context {
struct event_timeout stale_routes_check_et;
};
+/**
+ * Return values used by the client connect call-back functions.
+ */
+enum client_connect_return
+{
+ CC_RET_FAILED,
+ CC_RET_SUCCEEDED,
+ CC_RET_SKIPPED
+};
+
/*
* Host route
*/
--
2.1.1
