From: "mrbff (Code Review)" Date: Thu, 21 Nov 2024 18:24:42 +0000 In-Reply-To: References: Reply-To: marco@...2726..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641... Message-ID: <18343c107bc9d2012a06fde0dcbf95934390f55e-EmailReplacePatchSet-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="oLJduotlyEE="; charset=UTF-8 Subject: [Openvpn-devel] [L] Change in openvpn[master]: PUSH_UPDATE: Allow OpenVPN in client mode to receive and handle PUSH ... List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: plaisthos , flichtenheld Cc: openvpn-devel --oLJduotlyEE= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: flichtenheld, mrbff, plaisthos. Hello flichtenheld, plaisthos, I'd like you to reexamine a change. Please visit http://gerrit.openvpn.net/c/openvpn/+/808?usp=3Demail to look at the new patch set (#2). The following approvals got outdated and were removed: Code-Review-1 by flichtenheld Change subject: PUSH_UPDATE: Allow OpenVPN in client mode to receive and ha= ndle PUSH UPDATE control messages to allow options updating at runtime. ...................................................................... PUSH_UPDATE: Allow OpenVPN in client mode to receive and handle PUSH UPDATE= control messages to allow options updating at runtime. * Added IV_PROTO_PUSH_UPDATE flag bit to support push-updates. * Added process_incoming_push_update(), in a separate file to create tests = more easily. * Modified incoming_push_message(), process_incoming_push_msg(), apply_push= _options(), apply_pull_filter() to process also push-update messages. * Added the check_push_update_option_flags() function used in apply_pull_fi= lter() to check options formatting inside push-update messages, if the options are = updatables and to check for '?' and '-' flags that may be present in front of the op= tions. The '-' flag is used to indicate that the option in question should be re= moved, while the '?' indicates that the option is optional and to do not generate errors if the client cannot update that option. For more info you can read the RFC at https://github.com/OpenVPN/openvpn-= rfc . * Created some unit tests for the push-update message handling in test_push= _update_msg.c. Change-Id: I6ecd4cb47571cc8c20e46de8595c742aeec6064a Signed-off-by: Marco Baffo --- M CMakeLists.txt M src/openvpn/Makefile.am M src/openvpn/forward.c M src/openvpn/init.c M src/openvpn/options.c M src/openvpn/options.h M src/openvpn/options_util.c M src/openvpn/options_util.h M src/openvpn/push.c M src/openvpn/push.h A src/openvpn/push_util.c M src/openvpn/ssl.c M src/openvpn/ssl.h M tests/unit_tests/openvpn/Makefile.am A tests/unit_tests/openvpn/test_push_update_msg.c 15 files changed, 612 insertions(+), 112 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/08/808/2 diff --git a/CMakeLists.txt b/CMakeLists.txt index 5db207d..9dd67bb 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -496,6 +496,7 @@ src/openvpn/ps.c src/openvpn/ps.h src/openvpn/push.c + src/openvpn/push_util.c src/openvpn/push.h src/openvpn/pushlist.h src/openvpn/reflect_filter.c diff --git a/src/openvpn/Makefile.am b/src/openvpn/Makefile.am index ecb2bcf..55ec565 100644 --- a/src/openvpn/Makefile.am +++ b/src/openvpn/Makefile.am @@ -114,7 +114,7 @@ proto.c proto.h \ proxy.c proxy.h \ ps.c ps.h \ - push.c push.h \ + push.c push_util.c push.h \ pushlist.h \ reflect_filter.c reflect_filter.h \ reliable.c reliable.h \ diff --git a/src/openvpn/forward.c b/src/openvpn/forward.c index d50b24c..2c75953 100644 --- a/src/openvpn/forward.c +++ b/src/openvpn/forward.c @@ -2031,7 +2031,7 @@ } /* check for incoming control messages on the control channel like - * push request/reply, or authentication failure and 2FA messages */ + * push request/reply/update, or authentication failure and 2FA messag= es */ if (tls_test_payload_len(c->c2.tls_multi) > 0) { check_incoming_control_channel(c); diff --git a/src/openvpn/init.c b/src/openvpn/init.c index 9371024..f8d9d06 100644 --- a/src/openvpn/init.c +++ b/src/openvpn/init.c @@ -2030,8 +2030,8 @@ /* possibly add routes */ if ((route_order(c->c1.tuntap) =3D=3D ROUTE_AFTER_TUN) && (!c->opt= ions.route_delay_defined)) { - int status =3D do_route(&c->options, c->c1.route_list, c->c1.r= oute_ipv6_list, - c->c1.tuntap, c->plugins, c->c2.es, &c->= net_ctx); + bool status =3D do_route(&c->options, c->c1.route_list, c->c1.= route_ipv6_list, + c->c1.tuntap, c->plugins, c->c2.es, &c-= >net_ctx); *error_flags |=3D (status ? 0 : ISC_ROUTE_ERRORS); } diff --git a/src/openvpn/options.c b/src/openvpn/options.c index 61f6285..8dea578 100644 --- a/src/openvpn/options.c +++ b/src/openvpn/options.c @@ -63,6 +63,7 @@ #include #include "memdbg.h" +#include "options_util.h" const char title_string[] =3D PACKAGE_STRING @@ -927,24 +928,6 @@ } } -struct pull_filter -{ -#define PUF_TYPE_UNDEF 0 /** undefined filter type */ -#define PUF_TYPE_ACCEPT 1 /** filter type to accept a matching option */ -#define PUF_TYPE_IGNORE 2 /** filter type to ignore a matching option */ -#define PUF_TYPE_REJECT 3 /** filter type to reject and trigger SIGUSR1= */ - int type; - int size; - char *pattern; - struct pull_filter *next; -}; - -struct pull_filter_list -{ - struct pull_filter *head; - struct pull_filter *tail; -}; - #ifndef ENABLE_SMALL static const char * @@ -5469,84 +5452,6 @@ } } -/** - * Filter an option line by all pull filters. - * - * If a match is found, the line is modified depending on - * the filter type, and returns true. If the filter type is - * reject, SIGUSR1 is triggered and the return value is false. - * In that case the caller must end the push processing. - */ -static bool -apply_pull_filter(const struct options *o, char *line) -{ - struct pull_filter *f; - - if (!o->pull_filter_list) - { - return true; - } - - /* skip leading spaces matching the behaviour of parse_line */ - while (isspace(*line)) - { - line++; - } - - for (f =3D o->pull_filter_list->head; f; f =3D f->next) - { - if (f->type =3D=3D PUF_TYPE_ACCEPT && strncmp(line, f->pattern, f-= >size) =3D=3D 0) - { - msg(D_LOW, "Pushed option accepted by filter: '%s'", line); - return true; - } - else if (f->type =3D=3D PUF_TYPE_IGNORE && strncmp(line, f->patter= n, f->size) =3D=3D 0) - { - msg(D_PUSH, "Pushed option removed by filter: '%s'", line); - *line =3D '\0'; - return true; - } - else if (f->type =3D=3D PUF_TYPE_REJECT && strncmp(line, f->patter= n, f->size) =3D=3D 0) - { - msg(M_WARN, "Pushed option rejected by filter: '%s'. Restartin= g.", line); - *line =3D '\0'; - throw_signal_soft(SIGUSR1, "Offending option received from ser= ver"); - return false; - } - } - return true; -} - -bool -apply_push_options(struct options *options, - struct buffer *buf, - unsigned int permission_mask, - unsigned int *option_types_found, - struct env_set *es) -{ - char line[OPTION_PARM_SIZE]; - int line_num =3D 0; - const char *file =3D "[PUSH-OPTIONS]"; - const int msglevel =3D D_PUSH_ERRORS|M_OPTERR; - - while (buf_parse(buf, ',', line, sizeof(line))) - { - char *p[MAX_PARMS+1]; - CLEAR(p); - ++line_num; - if (!apply_pull_filter(options, line)) - { - return false; /* Cause push/pull error and stop push processin= g */ - } - if (parse_line(line, p, SIZE(p)-1, file, line_num, msglevel, &opti= ons->gc)) - { - add_option(options, p, false, file, line_num, 0, msglevel, - permission_mask, option_types_found, es); - } - } - return true; -} - void options_server_import(struct options *o, const char *filename, @@ -5680,6 +5585,44 @@ return options->forward_compatible ? M_WARN : msglevel; } +bool +apply_push_options(struct context *c, + struct options *options, + struct buffer *buf, + unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es, + bool is_update) +{ + char line[OPTION_PARM_SIZE]; + int line_num =3D 0; + const char *file =3D "[PUSH-OPTIONS]"; + const int msglevel =3D D_PUSH_ERRORS|M_OPTERR; + + while (buf_parse(buf, ',', line, sizeof(line))) + { + char *p[MAX_PARMS+1]; + CLEAR(p); + ++line_num; + unsigned int push_update_option_flags =3D 0; + + if (!apply_pull_filter(options, line, is_update, &push_update_opti= on_flags)) + { + throw_signal_soft(SIGUSR1, "Offending option received from ser= ver"); + return false; /* Cause push/pull error and stop push processin= g */ + } + if (parse_line(line, p, SIZE(p)-1, file, line_num, msglevel, &opti= ons->gc)) + { + if (!is_update) + { + add_option(options, p, false, file, line_num, 0, msglevel, + permission_mask, option_types_found, es); + } + } + } + return true; +} + static void set_user_script(struct options *options, const char **script, diff --git a/src/openvpn/options.h b/src/openvpn/options.h index ee39dbb..5125f79 100644 --- a/src/openvpn/options.h +++ b/src/openvpn/options.h @@ -777,6 +777,33 @@ #define MAN_CLIENT_AUTH_ENABLED(opt) (false) #endif +/* + * some PUSH_UPDATE options + */ +#define OPT_P_U_ROUTE (1<<0) +#define OPT_P_U_ROUTE6 (1<<1) +#define OPT_P_U_DNS (1<<2) +#define OPT_P_U_DHCP (1<<3) +#define OPT_P_U_REDIR_GATEWAY (1<<4) + +struct pull_filter +{ +#define PUF_TYPE_UNDEF 0 /** undefined filter type */ +#define PUF_TYPE_ACCEPT 1 /** filter type to accept a matching option */ +#define PUF_TYPE_IGNORE 2 /** filter type to ignore a matching option */ +#define PUF_TYPE_REJECT 3 /** filter type to reject and trigger SIGUSR1= */ + int type; + int size; + char *pattern; + struct pull_filter *next; +}; + +struct pull_filter_list +{ + struct pull_filter *head; + struct pull_filter *tail; +}; + void parse_argv(struct options *options, const int argc, char *argv[], @@ -845,11 +872,13 @@ void pre_connect_restore(struct options *o, struct gc_arena *gc); -bool apply_push_options(struct options *options, +bool apply_push_options(struct context *c, + struct options *options, struct buffer *buf, unsigned int permission_mask, unsigned int *option_types_found, - struct env_set *es); + struct env_set *es, + bool is_update); void options_detach(struct options *o); diff --git a/src/openvpn/options_util.c b/src/openvpn/options_util.c index a9e020a..87282c3 100644 --- a/src/openvpn/options_util.c +++ b/src/openvpn/options_util.c @@ -30,6 +30,8 @@ #include "options_util.h" +#include "push.h" + const char * parse_auth_failed_temp(struct options *o, const char *reason) { @@ -98,3 +100,176 @@ gc_free(&gc); return message; } + +static const char *updatable_options[] =3D { + "block-ipv6", + "block-outside-dns", + "dhcp-option", + "dns", + "ifconfig", + "ifconfig-ipv6", + "push-continuation", + "redirect-gateway", + "redirect-private", + "route", + "route-gateway", + "route-ipv6", + "route-metric", + "topology", + "tun-mtu", + "keepalive" +}; + +static bool +check_push_update_option_flags(char **line, unsigned int *flags) +{ + if (!line || !*line || !**line) + { + return false; + } + *flags =3D 0; + bool opt_is_updatable =3D false; + char *str =3D *line; + char c =3D **line; + + if (c =3D=3D '?') + { + *flags |=3D PUSH_OPT_OPTIONAL; + if (str[1]) + { + c =3D *(++str); + } + else + { + return false; + } + } + else if (c =3D=3D '-') + { + *flags |=3D PUSH_OPT_TO_REMOVE; + if (str[1]) + { + c =3D *(++str); + } + else + { + return false; + } + } + + if (c =3D=3D '-' && !(*flags & PUSH_OPT_TO_REMOVE)) + { + *flags |=3D PUSH_OPT_TO_REMOVE; + if (str[1]) + { + c =3D *(++str); + } + else + { + return false; + } + } + + /* Skip '?' and '-' if they are present */ + size_t len =3D strlen(str); + memmove(*line, str, len); + (*line)[len] =3D '\0'; + str =3D *line; + + int count =3D sizeof(updatable_options)/sizeof(char *); + for (int i =3D 0; i < count; ++i) + { + size_t opt_len =3D strlen(updatable_options[i]); + if (len < opt_len) + { + continue; + } + if (!strncmp(str, updatable_options[i], opt_len) + && (!str[opt_len] || str[opt_len] =3D=3D ' ')) + { + opt_is_updatable =3D true; + break; + } + } + + if (!opt_is_updatable) + { + if (*flags & PUSH_OPT_OPTIONAL) + { + msg(D_PUSH, "Pushed option is not updatable: '%s'", *line); + return true; + } + else + { + msg(M_WARN, "Pushed option is not updatable: '%s'. Restarting.= ", *line); + return false; + } + } + + return true; +} + +/** + * Filter an option line by all pull filters. + * + * If a match is found, the line is modified depending on + * the filter type, and returns true. If the filter type is + * reject, SIGUSR1 is triggered and the return value is false. + * In that case the caller must end the push processing. + */ +bool +apply_pull_filter(const struct options *o, char *line, bool is_update, uns= igned int *push_update_option_flags) +{ + struct pull_filter *f; + + if (!o->pull_filter_list && !(is_update)) + { + return true; + } + + /* skip leading spaces matching the behaviour of parse_line */ + while (isspace(*line)) + { + line++; + } + + if (is_update) + { + if (!check_push_update_option_flags(&line, push_update_option_flag= s)) + { + return false; + } + if (!o->pull_filter_list) + { + return true; + } + } + + for (f =3D o->pull_filter_list->head; f; f =3D f->next) + { + if (f->type =3D=3D PUF_TYPE_ACCEPT && strncmp(line, f->pattern, f-= >size) =3D=3D 0) + { + msg(D_LOW, "Pushed option accepted by filter: '%s'", line); + return true; + } + else if (f->type =3D=3D PUF_TYPE_IGNORE && strncmp(line, f->patter= n, f->size) =3D=3D 0) + { + msg(D_PUSH, "Pushed option removed by filter: '%s'", line); + return true; + } + else if (f->type =3D=3D PUF_TYPE_REJECT && strncmp(line, f->patter= n, f->size) =3D=3D 0) + { + if (is_update && (*push_update_option_flags & PUSH_OPT_OPTIONA= L)) + { + msg(D_PUSH, "Pushed option removed by filter: '%s'", line); + return true; + } + else + { + msg(M_WARN, "Pushed option rejected by filter: '%s'. Resta= rting.", line); + return false; + } + } + } + return true; +} diff --git a/src/openvpn/options_util.h b/src/openvpn/options_util.h index 29bc9dc..64ee0d6 100644 --- a/src/openvpn/options_util.h +++ b/src/openvpn/options_util.h @@ -30,4 +30,10 @@ const char * parse_auth_failed_temp(struct options *o, const char *reason); +bool +apply_pull_filter(const struct options *o, + char *line, + bool is_update, + unsigned int *push_update_option_flags); + #endif diff --git a/src/openvpn/push.c b/src/openvpn/push.c index 6c06374..71a0372 100644 --- a/src/openvpn/push.c +++ b/src/openvpn/push.c @@ -39,8 +39,6 @@ #include "ssl_util.h" #include "options_util.h" -static char push_reply_cmd[] =3D "PUSH_REPLY"; - /* * Auth username/password * @@ -519,21 +517,31 @@ { msg(D_PUSH_ERRORS, "WARNING: Received bad push/pull message: %s", = sanitize_control_message(BSTR(buffer), &gc)); } - else if (status =3D=3D PUSH_MSG_REPLY || status =3D=3D PUSH_MSG_CONTIN= UATION) + else if (status =3D=3D PUSH_MSG_REPLY || status =3D=3D PUSH_MSG_UPDATE= || status =3D=3D PUSH_MSG_CONTINUATION) { c->options.push_option_types_found |=3D option_types_found; /* delay bringing tun/tap up until --push parms received from remo= te */ - if (status =3D=3D PUSH_MSG_REPLY) + if (status =3D=3D PUSH_MSG_REPLY || status =3D=3D PUSH_MSG_UPDATE) { if (!options_postprocess_pull(&c->options, c->c2.es)) { goto error; } - if (!do_up(c, true, c->options.push_option_types_found)) + if (status =3D=3D PUSH_MSG_REPLY) { - msg(D_PUSH_ERRORS, "Failed to open tun/tap interface"); - goto error; + if (!do_up(c, true, c->options.push_option_types_found)) + { + msg(D_PUSH_ERRORS, "Failed to open tun/tap interface"); + goto error; + } + } + else + { + if (!option_types_found) + { + msg(M_WARN, "No option found"); + } } } event_timeout_clear(&c->c2.push_request_interval); @@ -1048,11 +1056,13 @@ md_ctx_init(c->c2.pulled_options_state, "SHA256"); c->c2.pulled_options_digest_init_done =3D true; } - if (apply_push_options(&c->options, + if (apply_push_options(c, + &c->options, buf, permission_mask, option_types_found, - c->c2.es)) + c->c2.es, + false)) { push_update_digest(c->c2.pulled_options_state, &buf_orig, &c->options); @@ -1103,6 +1113,12 @@ return process_incoming_push_reply(c, permission_mask, option_types_found, &buf); } + else if (honor_received_options + && buf_string_compare_advance(&buf, push_update_cmd)) + { + return process_incoming_push_update(c, permission_mask, + option_types_found, &buf); + } else { return PUSH_MSG_ERROR; diff --git a/src/openvpn/push.h b/src/openvpn/push.h index 4a13327..52ca715 100644 --- a/src/openvpn/push.h +++ b/src/openvpn/push.h @@ -33,9 +33,22 @@ #define PUSH_MSG_AUTH_FAILURE 4 #define PUSH_MSG_CONTINUATION 5 #define PUSH_MSG_ALREADY_REPLIED 6 +#define PUSH_MSG_UPDATE 7 + +#define push_reply_cmd "PUSH_REPLY" +#define push_update_cmd "PUSH_UPDATE" + +/* Push-update options flags */ +#define PUSH_OPT_TO_REMOVE (1<<0) +#define PUSH_OPT_OPTIONAL (1<<1) =20 int process_incoming_push_request(struct context *c); +int process_incoming_push_update(struct context *c, + unsigned int permission_mask, + unsigned int *option_types_found, + struct buffer *buf); + int process_incoming_push_msg(struct context *c, const struct buffer *buffer, bool honor_received_options, diff --git a/src/openvpn/push_util.c b/src/openvpn/push_util.c new file mode 100644 index 0000000..b4d1e8b --- /dev/null +++ b/src/openvpn/push_util.c @@ -0,0 +1,44 @@ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include "push.h" + +int +process_incoming_push_update(struct context *c, + unsigned int permission_mask, + unsigned int *option_types_found, + struct buffer *buf) +{ + int ret =3D PUSH_MSG_ERROR; + const uint8_t ch =3D buf_read_u8(buf); + if (ch =3D=3D ',') + { + if (apply_push_options(c, + &c->options, + buf, + permission_mask, + option_types_found, + c->c2.es, + true)) + { + switch (c->options.push_continuation) + { + case 0: + case 1: + ret =3D PUSH_MSG_UPDATE; + break; + + case 2: + ret =3D PUSH_MSG_CONTINUATION; + break; + } + } + } + else if (ch =3D=3D '\0') + { + ret =3D PUSH_MSG_UPDATE; + } + + return ret; +} diff --git a/src/openvpn/ssl.c b/src/openvpn/ssl.c index 8040e7b..b006917 100644 --- a/src/openvpn/ssl.c +++ b/src/openvpn/ssl.c @@ -1947,6 +1947,9 @@ /* support for exit notify via control channel */ iv_proto |=3D IV_PROTO_CC_EXIT_NOTIFY; + /* support push-updates */ + iv_proto |=3D IV_PROTO_PUSH_UPDATE; + if (session->opt->pull) { /* support for receiving push_reply before sending diff --git a/src/openvpn/ssl.h b/src/openvpn/ssl.h index eea1323..53b7f2c 100644 --- a/src/openvpn/ssl.h +++ b/src/openvpn/ssl.h @@ -110,6 +110,9 @@ /** Supports the --dns option after all the incompatible changes */ #define IV_PROTO_DNS_OPTION_V2 (1<<11) +/** Supports push-update */ +#define IV_PROTO_PUSH_UPDATE (1<<12) + /* Default field in X509 to be username */ #define X509_USERNAME_FIELD_DEFAULT "CN" diff --git a/tests/unit_tests/openvpn/Makefile.am b/tests/unit_tests/openvp= n/Makefile.am index a4e6235..1b2414c 100644 --- a/tests/unit_tests/openvpn/Makefile.am +++ b/tests/unit_tests/openvpn/Makefile.am @@ -11,7 +11,7 @@ endif test_binaries +=3D crypto_testdriver packet_id_testdriver auth_token_testd= river ncp_testdriver misc_testdriver \ - pkt_testdriver ssl_testdriver user_pass_testdriver + pkt_testdriver ssl_testdriver user_pass_testdriver push_update_msg_testdr= iver if HAVE_LD_WRAP_SUPPORT if !WIN32 @@ -307,3 +307,25 @@ $(top_srcdir)/src/openvpn/win32-util.c \ $(top_srcdir)/src/openvpn/platform.c \ $(top_srcdir)/src/openvpn/list.c + +push_update_msg_testdriver_CFLAGS =3D -I$(top_srcdir)/src/openvpn \ + -I$(top_srcdir)/src/compat \ + -I$(top_srcdir)/tests/unit_tests/openvpn \ + -ffunction-sections \ + @TEST_CFLAGS@ \ + @CMOCKA_CFLAGS@ + +push_update_msg_testdriver_LDFLAGS =3D \ + @TEST_LDFLAGS@ \ + @CMOCKA_LIBS@ \ + -L$(top_srcdir)/src/openvpn \ + $(OPTIONAL_CRYPTO_LIBS) + +push_update_msg_testdriver_SOURCES =3D test_push_update_msg.c \ + mock_msg.c \ + mock_get_random.c \ + $(top_srcdir)/src/openvpn/buffer.c \ + $(top_srcdir)/src/openvpn/platform.c \ + $(top_srcdir)/src/openvpn/push_util.c \ + $(top_srcdir)/src/openvpn/options_util.c \ + $(top_srcdir)/src/openvpn/otime.c \ No newline at end of file diff --git a/tests/unit_tests/openvpn/test_push_update_msg.c b/tests/unit_t= ests/openvpn/test_push_update_msg.c new file mode 100644 index 0000000..8574855 --- /dev/null +++ b/tests/unit_tests/openvpn/test_push_update_msg.c @@ -0,0 +1,245 @@ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include +#include +#include +#include +#include "push.h" +#include "options_util.h" + +/* mocks */ + +unsigned int +pull_permission_mask(const struct context *c) +{ + unsigned int flags =3D + OPT_P_UP + | OPT_P_ROUTE_EXTRAS + | OPT_P_SOCKBUF + | OPT_P_SOCKFLAGS + | OPT_P_SETENV + | OPT_P_SHAPER + | OPT_P_TIMER + | OPT_P_COMP + | OPT_P_PERSIST + | OPT_P_MESSAGES + | OPT_P_EXPLICIT_NOTIFY + | OPT_P_ECHO + | OPT_P_PULL_MODE + | OPT_P_PEER_ID + | OPT_P_NCP + | OPT_P_PUSH_MTU + | OPT_P_ROUTE + | OPT_P_DHCPDNS; + return flags; +} + +bool +apply_push_options(struct context *c, + struct options *options, + struct buffer *buf, + unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es, + bool is_update) +{ + char line[OPTION_PARM_SIZE]; + + while (buf_parse(buf, ',', line, sizeof(line))) + { + unsigned int push_update_option_flags =3D 0; + + if (!apply_pull_filter(options, line, is_update, &push_update_opti= on_flags)) + { + msg(M_WARN, "Offending option received from server"); + return false; + } + /* + * No need to test also the application part here + * (add_option/remove_option/update_option) + */ + } + return true; +} + +int +process_incoming_push_msg(struct context *c, + const struct buffer *buffer, + bool honor_received_options, + unsigned int permission_mask, + unsigned int *option_types_found) +{ + struct buffer buf =3D *buffer; + + if (buf_string_compare_advance(&buf, "PUSH_REQUEST")) + { + return PUSH_MSG_REQUEST; + } + else if (honor_received_options + && buf_string_compare_advance(&buf, push_reply_cmd)) + { + return PUSH_MSG_REPLY; + } + else if (honor_received_options + && buf_string_compare_advance(&buf, push_update_cmd)) + { + return process_incoming_push_update(c, permission_mask, + option_types_found, &buf); + } + else + { + return PUSH_MSG_ERROR; + } +} + +/* tests */ + +static void +test_incoming_push_message_basic(void **state) +{ + struct context *c =3D *state; + struct buffer buf =3D alloc_buf(256); + const char *update_msg =3D "PUSH_UPDATE,dhcp-option DNS 8.8.8.8, route= 0.0.0.0 0.0.0.0 10.10.10.1"; + buf_write(&buf, update_msg, strlen(update_msg)); + unsigned int option_types_found =3D 0; + + assert_int_equal(process_incoming_push_msg(c, &buf, c->options.pull, p= ull_permission_mask(c), &option_types_found), PUSH_MSG_UPDATE); + + free_buf(&buf); +} + +static void +test_incoming_push_message_error1(void **state) +{ + struct context *c =3D *state; + struct buffer buf =3D alloc_buf(256); + const char *update_msg =3D "PUSH_UPDATEerr,dhcp-option DNS 8.8.8.8"; + buf_write(&buf, update_msg, strlen(update_msg)); + unsigned int option_types_found =3D 0; + + assert_int_equal(process_incoming_push_msg(c, &buf, c->options.pull, p= ull_permission_mask(c), &option_types_found), PUSH_MSG_ERROR); + + free_buf(&buf); +} + + +static void +test_incoming_push_message_error2(void **state) +{ + struct context *c =3D *state; + struct buffer buf =3D alloc_buf(256); + const char *update_msg =3D "PUSH_UPDATE ,dhcp-option DNS 8.8.8.8"; + buf_write(&buf, update_msg, strlen(update_msg)); + unsigned int option_types_found =3D 0; + + assert_int_equal(process_incoming_push_msg(c, &buf, c->options.pull, p= ull_permission_mask(c), &option_types_found), PUSH_MSG_ERROR); + + free_buf(&buf); +} + +static void +test_incoming_push_message_1(void **state) +{ + struct context *c =3D *state; + struct buffer buf =3D alloc_buf(256); + const char *update_msg =3D "PUSH_UPDATE, ?-dns, route something, ?dhcp= -option DNS 8.8.8.8"; + buf_write(&buf, update_msg, strlen(update_msg)); + unsigned int option_types_found =3D 0; + + assert_int_equal(process_incoming_push_msg(c, &buf, c->options.pull, p= ull_permission_mask(c), &option_types_found), PUSH_MSG_UPDATE); + + free_buf(&buf); +} + +static void +test_incoming_push_message_bad_format(void **state) +{ + struct context *c =3D *state; + struct buffer buf =3D alloc_buf(256); + const char *update_msg =3D "PUSH_UPDATE, -dhcp-option, -?dns"; + buf_write(&buf, update_msg, strlen(update_msg)); + unsigned int option_types_found =3D 0; + + assert_int_equal(process_incoming_push_msg(c, &buf, c->options.pull, p= ull_permission_mask(c), &option_types_found), PUSH_MSG_ERROR); + + free_buf(&buf); +} + +static void +test_incoming_push_message_not_updatable_option(void **state) +{ + struct context *c =3D *state; + struct buffer buf =3D alloc_buf(256); + const char *update_msg =3D "PUSH_UPDATE, dev tun"; + buf_write(&buf, update_msg, strlen(update_msg)); + unsigned int option_types_found =3D 0; + + assert_int_equal(process_incoming_push_msg(c, &buf, c->options.pull, p= ull_permission_mask(c), &option_types_found), PUSH_MSG_ERROR); + + free_buf(&buf); +} + +static void +test_incoming_push_message_mix(void **state) +{ + struct context *c =3D *state; + struct buffer buf =3D alloc_buf(256); + const char *update_msg =3D "PUSH_UPDATE,-dhcp-option, route 10.10.10.0= , dhcp-option DNS 1.1.1.1, route 10.11.12.0, dhcp-option DOMAIN corp.local,= keepalive 10 60"; + buf_write(&buf, update_msg, strlen(update_msg)); + unsigned int option_types_found =3D 0; + + assert_int_equal(process_incoming_push_msg(c, &buf, c->options.pull, p= ull_permission_mask(c), &option_types_found), PUSH_MSG_UPDATE); + + free_buf(&buf); +} + +static void +test_incoming_push_message_mix2(void **state) +{ + struct context *c =3D *state; + struct buffer buf =3D alloc_buf(256); + const char *update_msg =3D "PUSH_UPDATE,-dhcp-option,dhcp-option DNS 8= .8.8.8,redirect-gateway local,route 192.168.1.0 255.255.255.0"; + buf_write(&buf, update_msg, strlen(update_msg)); + unsigned int option_types_found =3D 0; + + assert_int_equal(process_incoming_push_msg(c, &buf, c->options.pull, p= ull_permission_mask(c), &option_types_found), PUSH_MSG_UPDATE); + + free_buf(&buf); +} + +static int +setup(void **state) +{ + struct context *c =3D calloc(1, sizeof(struct context)); + c->options.pull =3D true; + c->options.route_nopull =3D false; + *state =3D c; + return 0; +} + +static int +teardown(void **state) +{ + struct context *c =3D *state; + free(c); + return 0; +} + +int +main(void) +{ + const struct CMUnitTest tests[] =3D { + cmocka_unit_test_setup_teardown(test_incoming_push_message_basic, = setup, teardown), + cmocka_unit_test_setup_teardown(test_incoming_push_message_error1,= setup, teardown), + cmocka_unit_test_setup_teardown(test_incoming_push_message_error2,= setup, teardown), + cmocka_unit_test_setup_teardown(test_incoming_push_message_not_upd= atable_option, setup, teardown), + cmocka_unit_test_setup_teardown(test_incoming_push_message_1, setu= p, teardown), + cmocka_unit_test_setup_teardown(test_incoming_push_message_bad_for= mat, setup, teardown), + cmocka_unit_test_setup_teardown(test_incoming_push_message_mix, se= tup, teardown), + cmocka_unit_test_setup_teardown(test_incoming_push_message_mix2, s= etup, teardown) + }; + + return cmocka_run_group_tests(tests, NULL, NULL); +} -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/808?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: I6ecd4cb47571cc8c20e46de8595c742aeec6064a Gerrit-Change-Number: 808 Gerrit-PatchSet: 2 Gerrit-Owner: mrbff Gerrit-Reviewer: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-Attention: flichtenheld Gerrit-Attention: mrbff Gerrit-MessageType: newpatchset --oLJduotlyEE= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: flichtenheld, mrbff, plaisthos. <= /p>

mrbff uploaded patch set #2 to this change.

View Change

The following approvals got outdated and were removed: Code-Review-1 by flichtenheld

PUSH_UPDATE: Allow OpenVPN in client mode to =
receive and handle PUSH UPDATE control messages to allow options updating a=
t runtime.

* Added IV_PROTO_PUSH_UPDATE flag bit to support push-upd= ates.
* Added process_incoming_push_update(), in a separate file to crea= te tests more easily.
* Modified incoming_push_message(), process_incomi= ng_push_msg(), apply_push_options(),
apply_pull_filter() to process al= so push-update messages.
* Added the check_push_update_option_flags() fu= nction used in apply_pull_filter() to
check options formatting inside = push-update messages, if the options are updatables
and to check for &= #39;?' and '-' flags that may be present in front of the option= s.
The '-' flag is used to indicate that the option in questio= n should be removed,
while the '?' indicates that the option i= s optional and to do not generate
errors if the client cannot update t= hat option.
For more info you can read the RFC at https://github.com/O= penVPN/openvpn-rfc .
* Created some unit tests for the push-update messa= ge handling in test_push_update_msg.c.

Change-Id: I6ecd4cb47571cc8c2= 0e46de8595c742aeec6064a
Signed-off-by: Marco Baffo <marco@...2726...&= gt;
---
M CMakeLists.txt
M src/openvpn/Makefile.am
M src/openvp= n/forward.c
M src/openvpn/init.c
M src/openvpn/options.c
M src/ope= nvpn/options.h
M src/openvpn/options_util.c
M src/openvpn/options_uti= l.h
M src/openvpn/push.c
M src/openvpn/push.h
A src/openvpn/push_u= til.c
M src/openvpn/ssl.c
M src/openvpn/ssl.h
M tests/unit_tests/o= penvpn/Makefile.am
A tests/unit_tests/openvpn/test_push_update_msg.c
= 15 files changed, 612 insertions(+), 112 deletions(-)

git pull ss=
h://gerrit.openvpn.net:29418/openvpn refs/changes/08/808/2
diff --=
git a/CMakeLists.txt b/CMakeLists.txt
index 5db207d..9dd67b= b 100644
--- a/CMakeLists.txt
+++ b/CMakeLi= sts.txt
@@ -496,6 +496,7 @@
src/openvp= n/ps.c
src/openvpn/ps.h
src/openv= pn/push.c
+ src/op= envpn/push_util.c
src/openvpn/push.h
= src/openvpn/pushlist.h
src/openvpn/reflect_filter.= c
diff --git a/src/openvpn/Makefile.am b/src/openvpn/Makefi= le.am
index ecb2bcf..55ec565 100644
--- a/s= rc/openvpn/Makefile.am
+++ b/src/openvpn/Makefile.am=
@@ -114,7 +114,7 @@
proto.c proto.h \ proxy.c proxy.h \
ps.c ps.h \
- push.c push.h \
+ push.c push_util.c push.h \
pushlist.h \
reflect_filter.c reflect_filter.h \

reliable.c reliable.h \
diff --git a/src/op= envpn/forward.c b/src/openvpn/forward.c
index d50b24c..2c75= 953 100644
--- a/src/openvpn/forward.c
+++ = b/src/openvpn/forward.c
@@ -2031,7 +2031,7 @@
}

/* check for incoming cont= rol messages on the control channel like
- * push request/reply, or authentication failure and= 2FA messages */
+ = * push request/reply/update, or authentication failure and 2FA messages *= /
if (tls_test_payload_len(c->c2.tls_multi) > 0)=
{
check_incoming_control_cha= nnel(c);
diff --git a/src/openvpn/init.c b/src/openvpn/init= .c
index 9371024..f8d9d06 100644
--- a/src/= openvpn/init.c
+++ b/src/openvpn/init.c
@@ = -2030,8 +2030,8 @@
/* possibly add routes */
if ((route_order(c->c1.tuntap) =3D=3D ROUTE_AFTER_TU= N) && (!c->options.route_delay_defined))
= {
- int st= atus =3D do_route(&c->options, c->c1.route_list, c->c1.route_i= pv6_list,
- = c->c1.tuntap, c->plugins, c->c2.es, &c-&= gt;net_ctx);
+ = bool status =3D do_route(&c->options, c->c1.route_list, c-&g= t;c1.route_ipv6_list,
+ c->c1.tuntap, c->plugins, c->= c2.es, &c->net_ctx);
*error_flags |=3D = (status ? 0 : ISC_ROUTE_ERRORS);
}

diff --git a/src/openvpn/options.c b/src/openvpn/options= .c
index 61f6285..8dea578 100644
--- a/src/= openvpn/options.c
+++ b/src/openvpn/options.c
@@ -63,6 +63,7 @@
#include <ctype.h>

#include "memdbg.h"
+#include "options_util.h"

const char title_string[] =3D
PACKAGE_STRING

@@ -927,24 +928,6 @@
= }
}

-struct pull_filter
-{
-#d= efine PUF_TYPE_UNDEF 0 /** undefined filter type */
-#define PUF_TYPE_ACCEPT 1 /** filter t= ype to accept a matching option */
-#define PUF_TYPE_IGNORE 2 /** filter type to ignore a match= ing option */
-#define = PUF_TYPE_REJECT 3 /** filter type to reject and trigger SIGUSR1 */
- int type;
- int size;

- char *pattern;
- struct pull_filter *next;
-};
-
-str= uct pull_filter_list
-{=
- struct pull_filte= r *head;
- struct pu= ll_filter *tail;
-};

-
#ifnde= f ENABLE_SMALL

static const char *
@@ -5469,84 +5452,6 @@
}
}=

-/**=
- * Filter an option l= ine by all pull filters.
- * If a match is= found, the line is modified depending on
- * the filter type, and returns true. If the filter typ= e is
- * reject, SIGUSR= 1 is triggered and the return value is false.
- * In that case the caller must end the push proces= sing.
- */
-static bool

-apply_pull_filter(const struct options *o, = char *line)
-{- struct pull_filter *f;

-
- if (!o->pull_filter_list)
- {
- return true;
- }
-
- /* skip le= ading spaces matching the behaviour of parse_line */
- while (isspace(*line))
- {
- line++;
- }
-<= /span>
- for (f =3D o->p= ull_filter_list->head; f; f =3D f->next)
- {
- if (f->type =3D=3D PUF_TYPE_ACCEPT && strncmp(l= ine, f->pattern, f->size) =3D=3D 0)
- {
- msg(D_LOW, "Pushed option accepted by filter: '= ;%s'", line);
= - return true;
- }
- = else if (f->type =3D=3D PUF_TYPE_IGNORE && strncmp(line, f->p= attern, f->size) =3D=3D 0)
- {
- = msg(D_PUSH, "Pushed option removed by filter: '%s'&quo= t;, line);
- = *line =3D '\0';
- }
- = else if (f->type =3D=3D PUF_TYPE_REJECT && strncmp(line, f->= ;pattern, f->size) =3D=3D 0)
- {
- = msg(M_WARN, "Pushed option rejected by filter: '%s'.= Restarting.", line);
- *line =3D '\0';
- throw_signal_soft(SIGUSR1, "Offending o= ption received from server");
- return false;
- }
- }
- return = true;
-}
-

-bool
= -apply_push_options(struct options *options,
- struct buffer *buf,
- unsigned int per= mission_mask,
- = unsigned int *option_types_found,
- struct env_set *es)
-{
- char line[OPTION_PARM_SIZE];
- int line_num =3D 0;
- const char *file =3D "[PUSH-OPTI= ONS]";
- const = int msglevel =3D D_PUSH_ERRORS|M_OPTERR;
-
- = while (buf_parse(buf, ',', line, sizeof(line)))
- {
- char *p[MAX_PARMS+1];
- CLEAR(p);
- ++line_num;
- if (!apply_pull_filter(options, line))=
- {
- return false; /* Cause push/= pull error and stop push processing */
- }
- if (parse_line(line, p, SIZE(p)-1, file, line_num, msglevel, &= amp;options->gc))
- = {
- a= dd_option(options, p, false, file, line_num, 0, msglevel,
- permission_mask,= option_types_found, es);
- }
- }
- return true;<= br>-}
-
void
options_s= erver_import(struct options *o,
cons= t char *filename,
@@ -5680,6 +5585,44 @@
= return options->forward_compatible ? M_WARN : msglevel;
}


+bool
+apply_push_= options(struct context *c,
+ struct options *options,
+ struct buffer *buf,
+ unsign= ed int permission_mask,
+ unsigned int *option_types_found,
+ struct env_set *es,=
+ = bool is_update)
+{
+ char line[OPTION_P= ARM_SIZE];
+ int l= ine_num =3D 0;
+ c= onst char *file =3D "[PUSH-OPTIONS]";
+ const int msglevel =3D D_PUSH_ERRORS|M_OPTE= RR;
+
+ while (buf_parse(buf, ',= 9;, line, sizeof(line)))

+ {
+ c= har *p[MAX_PARMS+1];
= + CLEAR(p);
+ = ++line_num;
+ = unsigned int push_update_option_flags =3D 0;
+
+ if (!apply_pull_filter(options, line, is_update, &am= p;push_update_option_flags))
+ {
+ = throw_signal_soft(SIGUSR1, "Offending option received from = server");
+ = return false; /* Cause push/pull error and stop push processing */
+ }
<= span style=3D"color: hsl(120, 100%, 40%);">+ if (parse_line(line, p,= SIZE(p)-1, file, line_num, msglevel, &options->gc))

+ {

+ if (!is_update)
+ {
+ add_option(options, p, fa= lse, file, line_num, 0, msglevel,
+ permission_mask, option_types_foun= d, es);
+ = }
+ }+ }
+ return true;
+}
+
static void
set_user_script= (struct options *options,
const char **scr= ipt,
diff --git a/src/openvpn/options.h b/src/openvpn/optio= ns.h
index ee39dbb..5125f79 100644
--- a/sr= c/openvpn/options.h
+++ b/src/openvpn/options.h
<= span>@@ -777,6 +777,33 @@
#define MAN_CLIENT_AUTH_ENABLED(= opt) (false)
#endif

+/*
+ * some PUSH_UPDATE options
+ */
+#define OPT_P_U_ROUTE (1<<0)
+#define OPT_P_U_ROUTE6 (1<&l= t;1)
+#define OPT_P_U= _DNS (1<<2)
+#define OPT_P_U_DHCP (1<<3)
+#define OPT_P_U_REDIR_GATEWAY (1<&l= t;4)
+
+struct pull_filter
+{
+#define PUF_TYPE_UNDEF 0 /** undefined filter typ= e */
+#define PUF_TYP= E_ACCEPT 1 /** filter type to accept a matching option */
+#define PUF_TYPE_IGNORE 2 /** f= ilter type to ignore a matching option */
+#define PUF_TYPE_REJECT 3 /** filter type to rejec= t and trigger SIGUSR1 */
+ int type;
+ = int size;
+ cha= r *pattern;
+ stru= ct pull_filter *next;
+};
+
+struct pull_filter_list
= +{
+ struct pull_filter *head;
+ struct pull_filter *tail;+};
+
void parse_argv(struct opti= ons *options,
const int argc,
char *argv[],
@@ -845,11 +872,13 @@


void pre_connect_restore(struct options *o= , struct gc_arena *gc);

-bool apply_push_options(struct options *options,=
+bool apply_push_options(st= ruct context *c,
+ = struct options *options,
= struct buffer *buf,
un= signed int permission_mask,
unsign= ed int *option_types_found,
- struct env_set *es);
+ struct env_set *es,<= /span>
+ = bool is_update);

void options_detach= (struct options *o);

diff --git a/src/ope= nvpn/options_util.c b/src/openvpn/options_util.c
index a9e0= 20a..87282c3 100644
--- a/src/openvpn/options_util.c=
+++ b/src/openvpn/options_util.c
@@ -30,6 +30,8 @= @

#include "options_util.h"

+#inc= lude "push.h"
+
const char *
parse_auth_failed_temp(= struct options *o, const char *reason)
{
@= @ -98,3 +100,176 @@
gc_free(&gc);
= return message;
}
+
= +static const char *updatable_options[] =3D {
+ "block-ipv6",
+ "block-outside-dns",=
+ "dhcp-option"= ;,
+ "dns&quo= t;,
+ "ifconf= ig",
+ "= ifconfig-ipv6",
= + "push-continuation",
+ "redirect-gateway",
+ "redirect-private",
<= span style=3D"color: hsl(120, 100%, 40%);">+ "route",
+ "route-gateway"= ;,
+ "route-i= pv6",
+ "= ;route-metric",
= + "topology",
+ "tun-mtu",
+ "keepalive"
+};
= +
+static bool=
+check_push_update_option_f= lags(char **line, unsigned int *flags)
+{
= + if (!line || !*line || !**line)
+ {
+ }
+ *flag= s =3D 0;
+ bool op= t_is_updatable =3D false;
+ char *str =3D *line;
+ char c =3D **line;
+
+ i= f (c =3D=3D '?')
+ {
+ *= flags |=3D PUSH_OPT_OPTIONAL;
+ if (str[1])
+ {
+= c =3D *(++str);
+ }
+ = else
+ {=
+ return = false;
+ }

+ }
+ else if (c =3D=3D '-')
+ {
+ *flags |=3D PUSH_OPT_TO_REMO= VE;
+ if (str[= 1])
+ {=
+ c =3D *(++str)= ;
+ }+ else
+ {

+ return false;
+ }
+ }
+
+ if = (c =3D=3D '-' && !(*flags & PUSH_OPT_TO_REMOVE))=
+ {
+ *flags |=3D PUSH_OPT_TO_REMOVE;<= /span>
+ if (str[1])<= /span>
+ {
= + c =3D *(++str);
+ }
+ else

+ {
+ return false;
+ }
+ }
+
+ /* Sk= ip '?' and '-' if they are present */
+ size_t len =3D strlen(str);+ memmove(*line, str, len);=
+ (*line)[len] = =3D '\0';
+ = str =3D *line;
+
+ int count =3D size= of(updatable_options)/sizeof(char *);
+ for (int i =3D 0; i < count; ++i)
+ {
+ size_t opt_len =3D strlen(updatable_option= s[i]);
+ if (l= en < opt_len)
+ = {
+ c= ontinue;
+ }
+ if (!strncmp(= str, updatable_options[i], opt_len)
+ && (!str[opt_len] || str[opt_len] =3D= =3D ' '))
+ = {
+ = opt_is_updatable =3D true;
+ break;
+ }
+ = }
+
+ if (!opt_is_updatable)
= + {
+ if (*flags & PUSH_OPT_OPTIONAL)<= /span>
+ {
= + msg(D_PUSH, "= Pushed option is not updatable: '%s'", *line);
+ return true;

= + }
+ else
+ {
+ msg(M_WARN, "Pushed option is not updata= ble: '%s'. Restarting.", *line);
+ return false;
+ }
+ }
+
+ retur= n true;
+}
= +
+/**
+ * Filter an option line by all pull filters.
+ *
+ * If a match is found, the line is modified depending o= n
+ * the filter type= , and returns true. If the filter type is
+ * reject, SIGUSR1 is triggered and the return value = is false.
+ * In that= case the caller must end the push processing.
+ */
+bool
+appl= y_pull_filter(const struct options *o, char *line, bool is_update, unsigned= int *push_update_option_flags)
+{
+ st= ruct pull_filter *f;
= +
+ if (!o->pul= l_filter_list && !(is_update))
+ {
+ return true;
+ }
+<= br>+ /* skip leading spaces = matching the behaviour of parse_line */
+ while (isspace(*line))
+ {
+ line++;
+ }
+
+ if (is_update)
+ {
+ if (!check_push_update_option_f= lags(&line, push_update_option_flags))
+ {
+ return false;
+ }
+ if (!o->pull_filter_list)
+ {
+ return true;
+ }
+ }
+
+ for (f =3D o->p= ull_filter_list->head; f; f =3D f->next)
+ {
+ if (f->type =3D=3D PUF_TYPE_ACCEPT && strnc= mp(line, f->pattern, f->size) =3D=3D 0)
+ {
+ msg(D_LOW, "Pushed option accepted by filt= er: '%s'", line);
+ return true;
+ }
+ else if (f->type =3D=3D PUF_TYPE_IGNORE && strncmp= (line, f->pattern, f->size) =3D=3D 0)
+ {
+ msg(D_PUSH, "Pushed option removed by filter= : '%s'", line);
+ return true;
+ }
+ else if (f->type =3D=3D PUF_TYPE_REJECT && strncmp(l= ine, f->pattern, f->size) =3D=3D 0)
+ {
+ if (is_update && (*push_update_option_flags= & PUSH_OPT_OPTIONAL))
+ {
= + msg(D_PUSH, "Pushed option removed by filter: '%s= '", line);
+= return true;
+ }
+= {
+ = msg(M_WARN, "Pushed option rejected by filter: '%s'.= Restarting.", line);
+ return false;
+ }
+ }
= + }
+ return tr= ue;
+}
diff --git a/src/openvpn/options_util.h b/src/openvpn/options_util.h
index 29bc9dc..64ee0d6 100644
--- a/src/openvpn= /options_util.h
+++ b/src/openvpn/options_util.h
= @@ -30,4 +30,10 @@
const char *
par= se_auth_failed_temp(struct options *o, const char *reason);

+bool
+apply_pull_filter(const struct o= ptions *o,

+ = char *line,
= + bool is_update,
+ unsigned int *push_update_option_flags);
+
#en= dif
diff --git a/src/openvpn/push.c b/src/openvpn/push.c
index 6c06374..71a0372 100644
--- a/src/openv= pn/push.c
+++ b/src/openvpn/push.c
@@ -39,8= +39,6 @@
#include "ssl_util.h"
= #include "options_util.h"

-static char push_reply_cmd[] =3D "PUS= H_REPLY";
-=
/*
* Auth username/password
= *
@@ -519,21 +517,31 @@
{
msg(D_PUSH_ERRORS, "WARNING: Received bad push/pull messa= ge: %s", sanitize_control_message(BSTR(buffer), &gc));

<= span> }

- else i= f (status =3D=3D PUSH_MSG_REPLY || status =3D=3D PUSH_MSG_CONTINUATION)

+ else if (status =3D= =3D PUSH_MSG_REPLY || status =3D=3D PUSH_MSG_UPDATE || status =3D=3D PUSH_M= SG_CONTINUATION)
{
c->opti= ons.push_option_types_found |=3D option_types_found;

/* delay bringing tun/tap up until --push parms receiv= ed from remote */
- = if (status =3D=3D PUSH_MSG_REPLY)
+ if (status =3D=3D PUSH_MSG_REPLY || status =3D=3D= PUSH_MSG_UPDATE)
{
i= f (!options_postprocess_pull(&c->options, c->c2.es))
{

goto error;
<= span> }
- = if (!do_up(c, true, c->options.push_option_types_found))
+ if (status = =3D=3D PUSH_MSG_REPLY)
{
- msg(D_PUSH_ERRORS, "Fa= iled to open tun/tap interface");
- goto error;
+ if (!do_up(c, true, c->options.= push_option_types_found))
+ {
+ msg(D_PUSH_ERRORS, "Failed to open tun/tap int= erface");
+ = goto error;
+ }
+ }
+ = else
+ = {
+ = if (!option_types_found)
+ {
+ msg(M_WARN, "No option found");
+ }=
}
}
= event_timeout_clear(&c->c2.push_request_interval);
@@ -1048,11 +1056,13 @@

md_ctx_init(c->c2.= pulled_options_state, "SHA256");
c-&= gt;c2.pulled_options_digest_init_done =3D true;
}<= /span>
- if (apply_push= _options(&c->options,
+ if (apply_push_options(c,
+ &c->options,
buf,
= permission_mask,
= option_types_found,
- c->c2.es))
+ c->= c2.es,
+ = false))
{
= push_update_digest(c->c2.pulled_options_state, &buf_orig,

&c->options);@@ -1103,6 +1113,12 @@
return process_incom= ing_push_reply(c, permission_mask,
= option_types_found, &buf);
}
+ else if (honor_re= ceived_options
+ = && buf_string_compare_advance(&buf, push_update_cmd))
+ {
+ return process_incoming_pus= h_update(c, permission_mask,

+ option_types_found, &a= mp;buf);
+ }
else
{
return= PUSH_MSG_ERROR;
diff --git a/src/openvpn/push.h b/src/open= vpn/push.h
index 4a13327..52ca715 100644
--= - a/src/openvpn/push.h
+++ b/src/openvpn/push.h
<= span>@@ -33,9 +33,22 @@

#define PUSH_MSG_AUTH_FAILURE = 4
#define PUSH_MSG_CONTINUATION 5
#de= fine PUSH_MSG_ALREADY_REPLIED 6
+#define PUSH_MSG_UPDATE 7
+
+#define push_reply_cmd "PUSH_REPLY"
+#define push_update_cmd "PUSH_UPDA= TE"
+
= +/* Push-update options flags *= /
+#define PUSH_OPT_T= O_REMOVE (1<<0)
+#define PUSH_OPT_OPTIONAL (1<<1)

= int process_incoming_push_request(struct context *c);

+int process_incoming_p= ush_update(struct context *c,
+ unsigned int permission_mask,
+ = unsigned int *option_types_found,
+ struct buffer *bu= f);
+
int process_incoming_push_msg(struct context *c,

= const struct buffer *buffer,
= bool honor_received_options,
diff -= -git a/src/openvpn/push_util.c b/src/openvpn/push_util.c
ne= w file mode 100644
index 0000000..b4d1e8b
-= -- /dev/null
+++ b/src/openvpn/push_util.c
= @@ -0,0 +1,44 @@
+#if= def HAVE_CONFIG_H
+#i= nclude "config.h"
+#endif
+
+#include "push.h&qu= ot;
+
+int

+process_incoming_push_update(struct context *c,

+ = unsigned int permission_mask,
+ unsigned int *option_types_fou= nd,
+ = struct buffer *buf)
+{
+ i= nt ret =3D PUSH_MSG_ERROR;
+ const uint8_t ch =3D buf_read_u8(buf);
+ if (ch =3D=3D ',')
+ {
+ if (apply_push_options(c,
+ &am= p;c->options,
+ = buf,
+ permission_mask,
+ opt= ion_types_found,
+ = c->c2.es,
+ true))
+ {
+ switch (c->options.push_continu= ation)
+ {=
+ cas= e 0:
+ = case 1:
+ = ret =3D PUSH_MSG_UPDATE;
+ break;
+
+ case 2:
+ ret =3D PUSH_MSG_CONTINUATION;
+ break;
<= span style=3D"color: hsl(120, 100%, 40%);">+ }
+ }
+ }
+ else if (ch =3D=3D '\0')
+ {
+ ret =3D PUSH_MSG_UPDATE;
+ }
+
+ = return ret;
+}
diff --git a/src/openvpn/ssl.c b/src/openvpn/ssl.c
index 8040e7b..b006917 100644

--- a/src/openvpn/ssl.c
+++ b/src/openvpn/ssl.c
@@ -1947,6 +1947,9 @@=
/* support for exit notify via control channel */=
iv_proto |=3D IV_PROTO_CC_EXIT_NOTIFY;
=
+ /* s= upport push-updates */
+
if (session->opt-&g= t;pull)
{
/* support = for receiving push_reply before sending
diff --git a/src/op= envpn/ssl.h b/src/openvpn/ssl.h
index eea1323..53b7f2c 1006= 44
--- a/src/openvpn/ssl.h
+++ b/src/openvp= n/ssl.h
@@ -110,6 +110,9 @@
/** Supports t= he --dns option after all the incompatible changes */
#def= ine IV_PROTO_DNS_OPTION_V2 (1<<11)

+/** Supports push-update */
=
+#define IV_PROTO_PUSH_UPDA= TE (1<<12)
= +
/* Default field in X509 to be username */
#define X509_USERNAME_FIELD_DEFAULT "CN"

diff --git a/tests/unit_tests/openvpn/Makefile.am b/tests/uni= t_tests/openvpn/Makefile.am
index a4e6235..1b2414c 100644
--- a/tests/unit_tests/openvpn/Makefile.am
+= ++ b/tests/unit_tests/openvpn/Makefile.am
@@ -11,7 +11,7 @@=
endif

test_binaries += =3D crypto_testdriver packet_id_testdriver auth_token_testdriver ncp_testdr= iver misc_testdriver \
= - pkt_testdriver ssl_testdriver user_pass_testdriver
+ pkt_testdriver ssl_testdriver user_pass_= testdriver push_update_msg_testdriver

if= HAVE_LD_WRAP_SUPPORT
if !WIN32
@@ -307,3 = +307,25 @@
$(top_srcdir)/src/openvpn/win32-util.c \
$(top_srcdir)/src/openvpn/platform.c \
$(top= _srcdir)/src/openvpn/list.c
+
+push_update= _msg_testdriver_CFLAGS =3D -I$(top_srcdir)/src/openvpn \
+ -I$(top_srcdir)/src/compat \+ -I$(top_srcdir)/tests/unit_= tests/openvpn \
+ -ff= unction-sections \
+ = @TEST_CFLAGS@ \
+ @CM= OCKA_CFLAGS@
+=
+push_update_msg_testdriver= _LDFLAGS =3D \
+ @TES= T_LDFLAGS@ \
+ @CMOCK= A_LIBS@ \
+ -L$(top_s= rcdir)/src/openvpn \
= + $(OPTIONAL_CRYPTO_LIBS)
+
+push_update_m= sg_testdriver_SOURCES =3D test_push_update_msg.c \
+ mock_msg.c \
+ mock_get_random.c \
+ $(top_srcdir)/src/openvpn/buffer.c \
<= span style=3D"color: hsl(120, 100%, 40%);">+ $(top_srcdir)/src/openvpn/plat= form.c \

+ $(top_srcd= ir)/src/openvpn/push_util.c \
+ $(top_srcdir)/src/openvpn/options_util.c \
+ $(top_srcdir)/src/openvpn/otime.c=
\ No newline at end of file
diff --git a/tests/un= it_tests/openvpn/test_push_update_msg.c b/tests/unit_tests/openvpn/test_pus= h_update_msg.c
new file mode 100644
index 0= 000000..8574855
--- /dev/null
+++ b/tests/u= nit_tests/openvpn/test_push_update_msg.c
@@ -0,0 +1,245 @@<= /span>
+#ifdef HAVE_CONFIG_H=
+#include "conf= ig.h"
+#endif
+
+#include <stdlib.h>
+#include <stdarg.h>
+#include <setjmp.h>

+#include <cmocka.h&g= t;
+#include "pu= sh.h"
+#include = "options_util.h"
+
+/* mocks */<= /span>
+
+unsigned int
+pull_permission_mask(const struct context *c)<= /span>
+{
+ unsigned int flags =3D
<= span style=3D"color: hsl(120, 100%, 40%);">+ OPT_P_UP

+ | OPT_P_ROUTE_EXTRAS
+ | OPT_P_SOCKBUF
+ | OPT_P_SOCKF= LAGS
+ | OPT_P= _SETENV
+ | OP= T_P_SHAPER
+ |= OPT_P_TIMER
+ = | OPT_P_COMP
+ = | OPT_P_PERSIST
+ = | OPT_P_MESSAGES
+ | OPT_P_ECHO
+ | OPT_P_PULL_MODE
+ | OPT_P_PEER_ID
+ | OPT_P_NCP
+ | OPT_P_PUSH_MTU
+ | OPT_P_ROUTE
+ | OPT_P_DHCPDNS;
+ return flags;
+}
+
+= bool
+apply_push_opti= ons(struct context *c,
+ struct buffer *buf,+ unsigned i= nt permission_mask,
+= unsigned int *option_types_found,
+ struct env_set *es,
+ boo= l is_update)
+{
+ char line[OPTION_PARM= _SIZE];
+
<= span style=3D"color: hsl(120, 100%, 40%);">+ while (buf_parse(buf, '= ,', line, sizeof(line)))

+ {
+ = unsigned int push_update_option_flags =3D 0;
+
+ if (!apply_pull_filter(options, line, is_update, &push= _update_option_flags))
+ = msg(M_WARN, "Offending option received from server");=
+ return false;<= /span>
+ }
= + /*
+ * No need to test also the app= lication part here
+ = * (add_option/remove_option/update_option)
+ */
+ }
+ return true;
+}
+
<= span style=3D"color: hsl(120, 100%, 40%);">+int

+process_incoming_push_msg(struct context *c,
+ = const struct buffer *buffer,
+ bool honor_received_options,<= br>+ u= nsigned int permission_mask,
+ unsigned int *option_types_found)=
+{
+ struct buffer buf =3D *buffer;+
+ if (buf_string_compare_advance(&buf, &qu= ot;PUSH_REQUEST"))
+ {
+ re= turn PUSH_MSG_REQUEST;
+ else if= (honor_received_options
+ && buf_string_compare_advance(&buf, push_repl= y_cmd))
+ {=
+ return PUSH_MSG_RE= PLY;
+ }+ else if (honor_received_o= ptions
+ = && buf_string_compare_advance(&buf, push_update_cmd))+ {
+ return process_incoming_push_upda= te(c, permission_mask,
+ }
<= span style=3D"color: hsl(120, 100%, 40%);">+ else

+ {
+ return PUSH_MSG_ERROR;
+ }
+}
+<= /span>
+/* tests */+
+static void
+test_incoming_push_message_basic(void **state)+{
+ struct context *c =3D *state;
+ struct buffer buf =3D alloc_= buf(256);

+ const = char *update_msg =3D "PUSH_UPDATE,dhcp-option DNS 8.8.8.8, route 0.0.0= .0 0.0.0.0 10.10.10.1";
+ buf_write(&buf, update_msg, strlen(update_msg));+ unsigned int option_types= _found =3D 0;
+
+ assert_int_equal(proc= ess_incoming_push_msg(c, &buf, c->options.pull, pull_permission_mask= (c), &option_types_found), PUSH_MSG_UPDATE);
+
+ free_buf(&buf);
+}
+
+static void
<= span style=3D"color: hsl(120, 100%, 40%);">+test_incoming_push_message_erro= r1(void **state)

+{
+ struct context *c= =3D *state;
+ str= uct buffer buf =3D alloc_buf(256);
+ const char *update_msg =3D "PUSH_UPDATEerr,dhcp-opt= ion DNS 8.8.8.8";
+ unsigned int option_types_found= =3D 0;
+
<= span style=3D"color: hsl(120, 100%, 40%);">+ assert_int_equal(process_in= coming_push_msg(c, &buf, c->options.pull, pull_permission_mask(c), &= amp;option_types_found), PUSH_MSG_ERROR);

+
+}
+
= +
+static void
+test_incoming_push_message_error2(void **state)+{
+ struct context *c =3D *state;
+ struct buffer buf =3D alloc_b= uf(256);

+ const c= har *update_msg =3D "PUSH_UPDATE ,dhcp-option DNS 8.8.8.8";
+ buf_write(&buf, u= pdate_msg, strlen(update_msg));
+ unsigned int option_types_found =3D 0;
+
+ assert_int_equal(process_incoming_push_msg(c, &buf,= c->options.pull, pull_permission_mask(c), &option_types_found), PUS= H_MSG_ERROR);
+
+ free_buf(&buf);
+}
+
+static void
+test_incoming_push_message_1(void **state)
+{
+ struct context *c =3D *state;
+ struct buffer buf =3D alloc_buf(256);
+ const char *update_= msg =3D "PUSH_UPDATE, ?-dns, route something, ?dhcp-option DNS 8.8.8.8= ";
+ buf_writ= e(&buf, update_msg, strlen(update_msg));
+ unsigned int option_types_found =3D 0;<= br>+
+ assert_int_equal(process_incoming_push_msg= (c, &buf, c->options.pull, pull_permission_mask(c), &option_type= s_found), PUSH_MSG_UPDATE);
+
+ free_bu= f(&buf);
+}
+
+static void
+test_incoming_push_message_bad_format(void **state)<= /span>
+{
+ struct context *c =3D *state;

+ struct buffer buf = =3D alloc_buf(256);
+= const char *update_msg =3D "PUSH_UPDATE, -dhcp-option, -?dns"= ;
+ buf_write(&= ;buf, update_msg, strlen(update_msg));
+ unsigned int option_types_found =3D 0;
+

+ assert_int_equal(process_incoming_push_msg(c, &a= mp;buf, c->options.pull, pull_permission_mask(c), &option_types_foun= d), PUSH_MSG_ERROR);
= +
+ free_buf(&= buf);
+}
+
+static void
+test_incoming_push_message_not_updatable_option(void **stat= e)
+{
+ struct context *c =3D *state;
+ struct buffer buf= =3D alloc_buf(256);
= + const char *update_msg =3D "PUSH_UPDATE, dev tun";+ buf_write(&buf, updat= e_msg, strlen(update_msg));
+ unsigned int option_types_found =3D 0;
+
+ assert_int_equal(process_incoming_push_msg(c, &buf, c-&= gt;options.pull, pull_permission_mask(c), &option_types_found), PUSH_MS= G_ERROR);
++ free_buf(&buf);

+}
+
+static void
+test_incoming_push_message_mix(void **state)
+{
+ struct context *c =3D *state;
+ struct buffer buf =3D alloc_buf(256);
+ const char *update_= msg =3D "PUSH_UPDATE,-dhcp-option, route 10.10.10.0, dhcp-option DNS 1= .1.1.1, route 10.11.12.0, dhcp-option DOMAIN corp.local, keepalive 10 60&qu= ot;;
+ buf_write(&= amp;buf, update_msg, strlen(update_msg));
+ unsigned int option_types_found =3D 0;
= +
+ assert_int_equal(process_incoming_push_msg(c,= &buf, c->options.pull, pull_permission_mask(c), &option_types_f= ound), PUSH_MSG_UPDATE);
+
+ free_buf(&= amp;buf);
+}+
+static void
+test_incoming_push_message_mix2(void **state)+{
+ struct context *c =3D *state;
+ struct buffer buf =3D alloc_b= uf(256);

+ const c= har *update_msg =3D "PUSH_UPDATE,-dhcp-option,dhcp-option DNS 8.8.8.8,= redirect-gateway local,route 192.168.1.0 255.255.255.0";
+ buf_write(&buf, update_ms= g, strlen(update_msg));
+ unsigned int option_types_found =3D 0;
+
+ assert_int_equal(process_incoming_push_msg(c, &buf, c->o= ptions.pull, pull_permission_mask(c), &option_types_found), PUSH_MSG_UP= DATE);
+
+ free_buf(&buf);+}
+
+static int
= +setup(void **state)
= +{
+ struct contex= t *c =3D calloc(1, sizeof(struct context));
+ c->options.pull =3D true;
+ c->options.route_nopull =3D fal= se;
+ *state =3D c= ;
+ return 0;

+}
+
+static int
+teardown(void **state)
+{
+ struc= t context *c =3D *state;
+ free(c);
+ = return 0;
+}=
+
+int
+main(void)
+{
+ const str= uct CMUnitTest tests[] =3D {
+ cmocka_unit_test_setup_teardown(test_incoming_push_message= _basic, setup, teardown),
+ cmocka_unit_test_setup_teardown(test_incoming_push_message_er= ror1, setup, teardown),
+ cmocka_unit_test_setup_teardown(test_incoming_push_message_erro= r2, setup, teardown),
+ cmocka_unit_test_setup_teardown(test_incoming_push_message_not_up= datable_option, setup, teardown),
+ cmocka_unit_test_setup_teardown(test_incoming_push_me= ssage_1, setup, teardown),
+ cmocka_unit_test_setup_teardown(test_incoming_push_message_b= ad_format, setup, teardown),
+ cmocka_unit_test_setup_teardown(test_incoming_push_message= _mix, setup, teardown),
+ cmocka_unit_test_setup_teardown(test_incoming_push_message_mix2= , setup, teardown)
+ = };
+
+ return cmocka_run_group_tests= (tests, NULL, NULL);
= +}

To view, visit change 808. To unsubscribe= , or for help writing mail filters, visit settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I6ecd4cb47571cc8c20e46de8595= c742aeec6064a
Gerrit-Change-Number: 808
Gerrit-PatchSet: 2
Gerrit-Owner: mrbff <marco@...2726...> <= /div>
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-Attention: flichtenheld <frank@...2375...= 41...>
Gerrit-Attention: mrbff <marco@...2726...&g= t;
Gerrit-MessageType: newpatchset
--oLJduotlyEE=--