Remove support for PF (Packet Filter)
PATCH 1/1 Remove support for PF (Packet Filter)
OpenVPN shipped a small packet filtering tool called PF. It has never been straightforward as it required a plugin to work. On top of that, keeping PF support, makes the code more complicated and increases the maintenance cost of OpenVPN.
PF itself is not actually maintained at all and there is little motivation in keeping it alive.
Some years ago an IPv6 extension for PF was proposed, but it was never picked up for the reasons above.
External (and more appropriate) tools can still be used to implement packet filtering on the OpenVPN interface.
Drop PF support for good.
Note that IDs used for external communication (i.e. to the plugin or management interface) have been commented out, but not removed, as they should not be used in the future.
---
@Arne: can you please double check the change in plugin.c to make sure the logic was properly adapted? Thanks!
Note: the code was first pruned with:
unifdef -m -UMANAGEMENT_PF -UPLUGIN_PF -UENABLE_PF *.c *.h
and then cleaned up manually by removing all remaining bits.
configure.ac | 8 - doc/man-sections/generic-options.rst | 4 - include/openvpn-plugin.h.in | 91 +--- sample/sample-plugins/defer/simple.c | 150 +---- src/openvpn/Makefile.am | 1 - src/openvpn/errlevel.h | 4 - src/openvpn/forward.c | 8 - src/openvpn/init.c | 9 - src/openvpn/manage.c | 53 -- src/openvpn/manage.h | 18 +- src/openvpn/mroute.c | 70 --- src/openvpn/mroute.h | 6 +- src/openvpn/multi.c | 137 ----- src/openvpn/openvpn.h | 4 - src/openvpn/openvpn.vcxproj | 2 - src/openvpn/openvpn.vcxproj.filters | 6 - src/openvpn/options.c | 11 - src/openvpn/pf.c | 787 --------------------------- src/openvpn/pf.h | 147 ----- src/openvpn/plugin.c | 11 +- src/openvpn/ssl_common.h | 3 - src/openvpn/ssl_verify.c | 16 - src/openvpn/ssl_verify.h | 28 - src/openvpn/syshead.h | 13 - 24 files changed, 8 insertions(+), 1579 deletions(-) delete mode 100644 src/openvpn/pf.c delete mode 100644 src/openvpn/pf.h
configure.ac +0 -8
@@ -149,13 +149,6 @@ AC_ARG_ENABLE( [enable_iproute2="no"] ) -AC_ARG_ENABLE( - [pf], - [AS_HELP_STRING([--disable-pf], [disable internal packet filter @<:@default=yes@:>@])], - , - [enable_pf="yes"] -) - AC_ARG_ENABLE( [plugin-auth-pam], [AS_HELP_STRING([--disable-plugin-auth-pam], [disable auth-pam plugin @<:@default=platform specific@:>@])],
@@ -1146,7 +1139,6 @@ test "${enable_debug}" = "yes" && AC_DEFINE([ENABLE_DEBUG], [1], [Enable debuggi test "${enable_small}" = "yes" && AC_DEFINE([ENABLE_SMALL], [1], [Enable smaller executable size]) test "${enable_fragment}" = "yes" && AC_DEFINE([ENABLE_FRAGMENT], [1], [Enable internal fragmentation support]) test "${enable_port_share}" = "yes" && AC_DEFINE([ENABLE_PORT_SHARE], [1], [Enable TCP Server port sharing]) -test "${enable_pf}" = "yes" && AC_DEFINE([ENABLE_PF], [1], [Enable internal packet filter]) test "${enable_strict_options}" = "yes" && AC_DEFINE([ENABLE_STRICT_OPTIONS_CHECK], [1], [Enable strict options check between peers]) test "${enable_crypto_ofb_cfb}" = "yes" && AC_DEFINE([ENABLE_OFB_CFB_MODE], [1], [Enable OFB and CFB cipher modes])
doc/man-sections/generic-options.rst +0 -4
@@ -418,10 +418,6 @@ which mode OpenVPN is configured as. success/failure via :code:`auth_control_file` when using deferred auth method and pending authentification via :code:`pending_auth_file`. - - * :code:`OPENVPN_PLUGIN_ENABLE_PF` plugin hook to pass filtering rules - via ``pf_file`` - --use-prediction-resistance Enable prediction resistance on mbed TLS's RNG.
include/openvpn-plugin.h.in +3 -88
123 lines not on this page · raw message
sample/sample-plugins/defer/simple.c +1 -149
168 lines not on this page · raw message
src/openvpn/Makefile.am +0 -1
@@ -97,7 +97,6 @@ openvpn_SOURCES = \ otime.c otime.h \ packet_id.c packet_id.h \ perf.c perf.h \ - pf.c pf.h \ ping.c ping.h \ plugin.c plugin.h \ pool.c pool.h \
src/openvpn/errlevel.h +0 -4
@@ -90,7 +90,6 @@#define D_ROUTE_QUOTA LOGLEV(3, 42, 0)/* show route quota exceeded messages */ #define D_OSBUF LOGLEV(3, 43, 0)/* show socket/tun/tap buffer sizes */ #define D_PS_PROXY LOGLEV(3, 44, 0)/* messages related to --port-share option */ -#define D_PF_INFO LOGLEV(3, 45, 0)/* packet filter informational messages */ #define D_IFCONFIG LOGLEV(3, 0, 0)/* show ifconfig info (don't mute) */ #define D_SHOW_PARMS LOGLEV(4, 50, 0)/* show all parameters on program initiation */
@@ -99,7 +98,6 @@#define D_DHCP_OPT LOGLEV(4, 53, 0)/* show DHCP options binary string */ #define D_MBUF LOGLEV(4, 54, 0)/* mbuf.[ch] routines */ #define D_PACKET_TRUNC_ERR LOGLEV(4, 55, 0)/* PACKET_TRUNCATION_CHECK */ -#define D_PF_DROPPED LOGLEV(4, 56, 0)/* packet filter dropped a packet */ #define D_MULTI_DROPPED LOGLEV(4, 57, 0)/* show point-to-multipoint packet drops */ #define D_MULTI_MEDIUM LOGLEV(4, 58, 0)/* show medium frequency multi messages */ #define D_X509_ATTR LOGLEV(4, 59, 0)/* show x509-track attributes on connection */
@@ -145,8 +143,6 @@#define D_ARGV_PARSE_CMD LOGLEV(7, 70, M_DEBUG)/* show parse_line() errors in argv_parse_cmd */ #define D_CRYPTO_DEBUG LOGLEV(7, 70, M_DEBUG)/* show detailed info from crypto.c routines */ #define D_PID_DEBUG LOGLEV(7, 70, M_DEBUG)/* show packet-id debugging info */ -#define D_PF_DROPPED_BCAST LOGLEV(7, 71, M_DEBUG)/* packet filter dropped a broadcast packet */ -#define D_PF_DEBUG LOGLEV(7, 72, M_DEBUG)/* packet filter debugging, must also define PF_DEBUG in pf.h */ #define D_PUSH_DEBUG LOGLEV(7, 73, M_DEBUG)/* show push/pull debugging info */ #define D_VLAN_DEBUG LOGLEV(7, 74, M_DEBUG)/* show VLAN tagging/untagging debug info */
src/openvpn/forward.c +0 -8
@@ -36,7 +36,6 @@#include "mss.h" #include "event.h" #include "occ.h" -#include "pf.h" #include "ping.h" #include "ps.h" #include "dhcp.h"
@@ -634,13 +633,6 @@ process_coarse_timers(struct context *c)check_push_request (c); } -#ifdef PLUGIN_PF -if (c->c2.pf.enabled - &&event_timeout_trigger (&c->c2.pf.reload, &c->c2.timeval,ETT_DEFAULT )) - { -pf_check_reload (c); - } -#endif /* process --route options */ if (event_timeout_trigger (&c->c2.route_wakeup, &c->c2.timeval,ETT_DEFAULT ))
src/openvpn/init.c +0 -9
@@ -4347,12 +4347,6 @@ init_instance(struct context *c, const struct env_set *env, const unsigned int f }#endif -#ifdef ENABLE_PF -if (child) - { -pf_init_context (c); - } -#endif /* Check for signals */ if (IS_SIG (c))
@@ -4415,9 +4409,6 @@ close_instance(struct context *c) }#endif -#ifdef ENABLE_PF -pf_destroy_context (&c->c2.pf); -#endif #ifdef ENABLE_PLUGIN /* call plugin close functions and unload */
src/openvpn/manage.c +0 -53
77 lines not on this page · raw message
src/openvpn/manage.h +2 -16
@@ -176,11 +176,6 @@ struct management_callbackconst char *extra, unsigned int timeout);char *(*get_peer_info) (void *arg,const unsigned long cid); -#ifdef MANAGEMENT_PF -bool (*client_pf)(void *arg, -const unsigned long cid, -struct buffer_list *pf_config);/* ownership transferred */ -#endif bool (*proxy_cmd)(void *arg,const char **p);bool (*remote_cmd) (void *arg,const char **p);#ifdef TARGET_ANDROID
@@ -278,7 +273,7 @@ struct man_connection {#define IEC_UNDEF 0#define IEC_CLIENT_AUTH 1 -#define IEC_CLIENT_PF 2 +//#define IEC_CLIENT_PF 2 *NOT IMPLEMENTED* #define IEC_RSA_SIGN 3#define IEC_CERTIFICATE 4#define IEC_PK_SIGN 5
@@ -335,9 +330,7 @@ struct management *management_init(void);#define MF_FORGET_DISCONNECT (1<<4)#define MF_CONNECT_AS_CLIENT (1<<5)#define MF_CLIENT_AUTH (1<<6) -#ifdef MANAGEMENT_PF -#define MF_CLIENT_PF (1<<7) -#endif +//#define MF_CLIENT_PF (1<<7) *NOT IMPLEMENTED* #define MF_UNIX_SOCK (1<<8)#define MF_EXTERNAL_KEY (1<<9)#define MF_EXTERNAL_KEY_NOPADDING (1<<10)
@@ -460,13 +453,6 @@ management_query_proxy_enabled(const struct management *man)return BOOL_CAST (man->settings.flags &MF_QUERY_PROXY ); } -#ifdef MANAGEMENT_PF -static inline bool -management_enable_pf (const struct management *man) -{ -return man &&BOOL_CAST (man->settings.flags &MF_CLIENT_PF ); -} -#endif static inline bool management_enable_def_auth (const struct management *man)
src/openvpn/mroute.c +0 -70
88 lines not on this page · raw message
src/openvpn/mroute.h +1 -5
@@ -177,8 +177,6 @@ unsigned int mroute_extract_addr_ip(struct mroute_addr *src,unsigned int mroute_extract_addr_ether (struct mroute_addr *src,struct mroute_addr *dest, -struct mroute_addr *esrc, -struct mroute_addr *edest,uint16_t vid,const struct buffer *buf);
@@ -189,8 +187,6 @@ unsigned int mroute_extract_addr_ether(struct mroute_addr *src,static inline unsigned int mroute_extract_addr_from_packet (struct mroute_addr *src,struct mroute_addr *dest, -struct mroute_addr *esrc, -struct mroute_addr *edest,uint16_t vid,const struct buffer *buf,int tunnel_type)
@@ -203,7 +199,7 @@ mroute_extract_addr_from_packet(struct mroute_addr *src, }else if (tunnel_type ==DEV_TYPE_TAP ) { - ret =mroute_extract_addr_ether (src, dest, esrc, edest, vid, buf); + ret =mroute_extract_addr_ether (src, dest, vid, buf); }return ret; }
src/openvpn/multi.c +0 -137
226 lines not on this page · raw message
src/openvpn/openvpn.h +0 -4
@@ -42,7 +42,6 @@#include "sig.h" #include "misc.h" #include "mbuf.h" -#include "pf.h" #include "pool.h" #include "plugin.h" #include "manage.h"
@@ -437,9 +436,6 @@ struct context_2int scheduled_exit_signal;/* packet filter */ -#ifdef ENABLE_PF -struct pf_context pf; -#endif #ifdef ENABLE_MANAGEMENT struct man_def_auth_context mda_context;
src/openvpn/openvpn.vcxproj +0 -2
@@ -276,7 +276,6 @@ <ClCompile Include="otime.c" /> <ClCompile Include="packet_id.c" /> <ClCompile Include="perf.c" /> - <ClCompile Include="pf.c" /> <ClCompile Include="ping.c" /> <ClCompile Include="pkcs11.c" /> <ClCompile Include="pkcs11_openssl.c" />
@@ -362,7 +361,6 @@ <ClInclude Include="otime.h" /> <ClInclude Include="packet_id.h" /> <ClInclude Include="perf.h" /> - <ClInclude Include="pf.h" /> <ClInclude Include="ping.h" /> <ClInclude Include="pkcs11.h" /> <ClInclude Include="pkcs11_backend.h" />
src/openvpn/openvpn.vcxproj.filters +0 -6
@@ -129,9 +129,6 @@ <ClCompile Include="perf.c"> <Filter>Source Files</Filter> </ClCompile> - <ClCompile Include="pf.c"> - <Filter>Source Files</Filter> - </ClCompile> <ClCompile Include="ping.c"> <Filter>Source Files</Filter> </ClCompile>
@@ -392,9 +389,6 @@ <ClInclude Include="perf.h"> <Filter>Header Files</Filter> </ClInclude> - <ClInclude Include="pf.h"> - <Filter>Header Files</Filter> - </ClInclude> <ClInclude Include="ping.h"> <Filter>Header Files</Filter> </ClInclude>
src/openvpn/options.c +0 -11
@@ -391,10 +391,6 @@ static const char usage_message[] ="--management-client-auth : gives management interface client the responsibility\n" " to authenticate clients after their client certificate\n" " has been verified.\n" -#ifdef MANAGEMENT_PF -"--management-client-pf : management interface clients must specify a packet\n" - " filter file for each connecting client.\n" -#endif #endif /* ifdef ENABLE_MANAGEMENT */ #ifdef ENABLE_PLUGIN "--plugin m [str]: Load plug-in module m passing str as an argument\n"
@@ -5479,13 +5475,6 @@ add_option(struct options *options, options->management_flags |=MF_CLIENT_AUTH ; }#endif /* ifdef ENABLE_MANAGEMENT */ -#ifdef MANAGEMENT_PF - else if (streq(p[0], "management-client-pf") && !p[1]) - { -VERIFY_PERMISSION (OPT_P_GENERAL ); - options->management_flags |= (MF_CLIENT_PF |MF_CLIENT_AUTH ); - } -#endif else if (streq(p[0], "management-log-cache") && p[1] && !p[2]) {int cache;
src/openvpn/pf.c deleted +0 -787
787 lines not on this page · raw message
src/openvpn/pf.h deleted +0 -147
147 lines not on this page · raw message
src/openvpn/plugin.c +1 -10
@@ -119,9 +119,6 @@ plugin_type_name(const int type)case OPENVPN_PLUGIN_TLS_FINAL :return "PLUGIN_TLS_FINAL" ; -case OPENVPN_PLUGIN_ENABLE_PF : -return "PLUGIN_ENABLE_PF" ; -case OPENVPN_PLUGIN_ROUTE_PREDOWN :return "PLUGIN_ROUTE_PREDOWN" ;
@@ -804,7 +801,6 @@ plugin_call_ssl(const struct plugin_list *pl,int i;const char **envp;const int n =plugin_n (pl); -bool success = false;bool error = false;bool deferred = false;
@@ -825,7 +821,6 @@ plugin_call_ssl(const struct plugin_list *pl,switch (status) {case OPENVPN_PLUGIN_FUNC_SUCCESS : - success = true;break ;case OPENVPN_PLUGIN_FUNC_DEFERRED :
@@ -845,11 +840,7 @@ plugin_call_ssl(const struct plugin_list *pl,gc_free (&gc); -if (type ==OPENVPN_PLUGIN_ENABLE_PF && success) - { -return OPENVPN_PLUGIN_FUNC_SUCCESS ; - } -else if (error) +if (error) {return OPENVPN_PLUGIN_FUNC_ERROR ; }
src/openvpn/ssl_common.h +0 -3
@@ -464,9 +464,6 @@ struct tls_sessionstruct cert_hash_set *cert_hash_set; -#ifdef ENABLE_PF -uint32_t common_name_hashval; -#endif bool verified;/* true if peer certificate was verified against CA */
src/openvpn/ssl_verify.c +0 -16
@@ -95,27 +95,11 @@ set_common_name(struct tls_session *session, const char *common_name) {free (session->common_name); session->common_name =NULL ; -#ifdef ENABLE_PF - session->common_name_hashval =0 ; -#endif }if (common_name) {/* FIXME: Last alloc will never be freed */ session->common_name =string_alloc (common_name,NULL ); -#ifdef ENABLE_PF - { -const uint32_t len = (uint32_t )strlen (common_name); -if (len) - { - session->common_name_hashval =hash_func ((const uint8_t *)common_name, len+1 ,0 ); - } -else - { - session->common_name_hashval =0 ; - } - } -#endif } }
src/openvpn/ssl_verify.h +0 -28
@@ -161,34 +161,6 @@ const char *tls_username(const struct tls_multi *multi, const bool null);*/ bool cert_hash_compare (const struct cert_hash_set *chs1,const struct cert_hash_set *chs2); -#ifdef ENABLE_PF - -/** -* Retrieve the given tunnel's common name and its hash value. -* -* @param multi The tunnel to use -* @param cn Common name's string -* @param cn_hash Common name's hash value -* -* @return true if the common name was set, false otherwise. -*/ -static inline bool -tls_common_name_hash (const struct tls_multi *multi,const char **cn,uint32_t *cn_hash) -{ -if (multi) - { -const struct tls_session *s = &multi->session[TM_ACTIVE ]; -if (s->common_name && s->common_name[0 ] !='\0' ) - { - *cn = s->common_name; - *cn_hash = s->common_name_hashval; -return true; - } - } -return false; -} - -#endif /** * Verify the given username and password, using either an external script, a
src/openvpn/syshead.h +0 -13
@@ -475,19 +475,6 @@ socket_defined(const socket_descriptor_t sd)#define ENABLE_PREDICTION_RESISTANCE #endif /* ENABLE_CRYPTO_MBEDTLS */ -/* -* Enable packet filter? -*/ -#if defined(ENABLE_PF ) && defined(ENABLE_PLUGIN ) && defined(HAVE_STAT ) -#define PLUGIN_PF -#endif -#if defined(ENABLE_PF ) && defined(ENABLE_MANAGEMENT ) -#define MANAGEMENT_PF -#endif -#if !defined(PLUGIN_PF ) && !defined(MANAGEMENT_PF ) -#undef ENABLE_PF -#endif -/* * Do we support Unix domain sockets? */
Signature · 1 line
2.31.1
Quoted 16 lines
sample/sample-plugins/defer/simple.c +0
-8-} - OPENVPN_EXPORT int openvpn_plugin_func_v3(const int v3structver, struct openvpn_plugin_args_func_in const *args,@@ -496,21 +362,7 @@ openvpn_plugin_func_v3(const int v3structver,case OPENVPN_PLUGIN_TLS_FINAL :plugin_log (PLOG_NOTE ,MODULE ,"OPENVPN_PLUGIN_TLS_FINAL" ); -return tls_final (context, pcc, argv, envp); - -case OPENVPN_PLUGIN_ENABLE_PF : -plugin_log (PLOG_NOTE ,MODULE ,"OPENVPN_PLUGIN_ENABLE_PF" ); - -/* OpenVPN pre-creates the file, which gets in the way of
sample/sample-plugins/defer/simple.c openvpn_plugin_func_v3(const int v3structver, · line 365
Quoted 10 lines
sample/sample-plugins/defer/simple.c +1
-9-* deferred pf setup - so remove it here, and re-create -* it in the background handler (in tls_final()) when ready -*/ -const char *pff =get_env ("pf_file" , envp); -if (pff) - { - (void )unlink (pff); - } -return OPENVPN_PLUGIN_FUNC_SUCCESS ;/* must succeed */ +return OPENVPN_PLUGIN_FUNC_SUCCESS ;
This part looks incorrect as it changes the return of TLS_FINAL.
src/openvpn/forward.c process_coarse_timers(struct context *c) · line 643
Quoted 9 lines
src/openvpn/forward.c +0
-7-#ifdef PLUGIN_PF -if (c->c2.pf.enabled - &&event_timeout_trigger (&c->c2.pf.reload, &c->c2.timeval,ETT_DEFAULT )) - { -pf_check_reload (c); - } -#endif
Removal here leaves 2 blank lines and should only leave one (remove one more line)
Quoted 7 lines
/* process --route options */ if (event_timeout_trigger(&c->c2.route_wakeup, &c->c2.timeval, ETT_DEFAULT))src/openvpn/init.c +0
-0
src/openvpn/init.c init_instance(struct context *c, const struct env_set *env, const unsigned int f · line 4355
Quoted 9 lines
src/openvpn/init.c +0
-6@@ -4347,12 +4347,6 @@ init_instance(struct context *c, const struct env_set *env, const unsigned int f }#endif -#ifdef ENABLE_PF -if (child) - { -pf_init_context (c); - } -#endif
Same with the extra blank line.
src/openvpn/init.c close_instance(struct context *c) · line 4420
Quoted 9 lines
src/openvpn/init.c +0
-3/* Check for signals */ if (IS_SIG (c))@@ -4415,9 +4409,6 @@ close_instance(struct context *c) }#endif -#ifdef ENABLE_PF -pf_destroy_context (&c->c2.pf); -#endif
Here too.
src/openvpn/init.c close_instance(struct context *c)
Quoted 5 lines
src/openvpn/init.c +0
-5- in_extra_reset(mc, IER_NEW); - } -} - -#endif /* MANAGEMENT_PF */
Blank line again
Quoted 35 lines
static void
man_pk_sig(struct management *man, const char *cmd_name)src/openvpn/init.c +0
-9@@ -1567,15 +1523,6 @@ man_dispatch_command(struct management *man, struct status_output *so, const chaman_client_pending_auth (man, p[1 ], p[2 ], p[3 ]); } } -#ifdef MANAGEMENT_PF - else if (streq(p[0], "client-pf")) - { -if (man_need (man, p,1 ,0 )) - { -man_client_pf (man, p[1 ]); - } - } -#endif else if (streq (p[0 ],"rsa-sig" )) {man_pk_sig (man,"rsa-sig" );src/openvpn/manage.h +0
-5@@ -176,11 +176,6 @@ struct management_callbackconst char *extra, unsigned int timeout);char *(*get_peer_info) (void *arg,const unsigned long cid); -#ifdef MANAGEMENT_PF -bool (*client_pf)(void *arg, -const unsigned long cid, -struct buffer_list *pf_config);/* ownership transferred */ -#endif bool (*proxy_cmd)(void *arg,const char **p);bool (*remote_cmd) (void *arg,const char **p);#ifdef TARGET_ANDROID
src/openvpn/manage.h struct man_connection { · line 276
Quoted 5 lines
src/openvpn/manage.h +1
-1@@ -278,7 +273,7 @@ struct man_connection {#define IEC_UNDEF 0#define IEC_CLIENT_AUTH 1 -#define IEC_CLIENT_PF 2 +//#define IEC_CLIENT_PF 2 *NOT IMPLEMENTED*
Use /* */ in OpenVPN 2.x. I think there are two instances that need changing. I would also chagne *NOT IMPLEMENTED* to something like (removed feature)
Otherwise the patch looks good.
Arne
PATCH v2 1/1 Remove support for PF (Packet Filter)
In reply to Antonio QuartulliOpenVPN shipped a small packet filtering tool called PF. It has never been straightforward as it required a plugin to work. On top of that, keeping PF support, makes the code more complicated and increases the maintenance cost of OpenVPN.
PF itself is not actually maintained at all and there is little motivation in keeping it alive.
Some years ago an IPv6 extension for PF was proposed, but it was never picked up for the reasons above.
External (and more appropriate) tools can still be used to implement packet filtering on the OpenVPN interface.
Drop PF support for good.
Note that IDs used for external communication (i.e. to the plugin or management interface) have been commented out, but not removed, as they should not be used in the future.
v2:
* changed // to /* */
* changed "NOT IMPLEMENTED" to "REMOVED FEATURE"
* removed extra empty lines after removing ifdef blocks
* clarified on IRC that tls_final has to be removed and therefore that hunk is correct
* removed mi_prefix() function as it is now unused
--- configure.ac | 8 - doc/man-sections/generic-options.rst | 4 - include/openvpn-plugin.h.in | 91 +--- sample/sample-plugins/defer/simple.c | 150 +---- src/openvpn/Makefile.am | 1 - src/openvpn/errlevel.h | 4 - src/openvpn/forward.c | 9 - src/openvpn/init.c | 11 - src/openvpn/manage.c | 53 -- src/openvpn/manage.h | 18 +- src/openvpn/mroute.c | 70 --- src/openvpn/mroute.h | 6 +- src/openvpn/multi.c | 150 ----- src/openvpn/openvpn.h | 4 - src/openvpn/openvpn.vcxproj | 2 - src/openvpn/openvpn.vcxproj.filters | 6 - src/openvpn/options.c | 11 - src/openvpn/pf.c | 787 --------------------------- src/openvpn/pf.h | 147 ----- src/openvpn/plugin.c | 11 +- src/openvpn/ssl_common.h | 4 - src/openvpn/ssl_verify.c | 16 - src/openvpn/ssl_verify.h | 29 - src/openvpn/syshead.h | 13 - 24 files changed, 8 insertions(+), 1597 deletions(-) delete mode 100644 src/openvpn/pf.c delete mode 100644 src/openvpn/pf.h
configure.ac +0 -8
@@ -149,13 +149,6 @@ AC_ARG_ENABLE( [enable_iproute2="no"] ) -AC_ARG_ENABLE( - [pf], - [AS_HELP_STRING([--disable-pf], [disable internal packet filter @<:@default=yes@:>@])], - , - [enable_pf="yes"] -) - AC_ARG_ENABLE( [plugin-auth-pam], [AS_HELP_STRING([--disable-plugin-auth-pam], [disable auth-pam plugin @<:@default=platform specific@:>@])],
@@ -1152,7 +1145,6 @@ test "${enable_debug}" = "yes" && AC_DEFINE([ENABLE_DEBUG], [1], [Enable debuggi test "${enable_small}" = "yes" && AC_DEFINE([ENABLE_SMALL], [1], [Enable smaller executable size]) test "${enable_fragment}" = "yes" && AC_DEFINE([ENABLE_FRAGMENT], [1], [Enable internal fragmentation support]) test "${enable_port_share}" = "yes" && AC_DEFINE([ENABLE_PORT_SHARE], [1], [Enable TCP Server port sharing]) -test "${enable_pf}" = "yes" && AC_DEFINE([ENABLE_PF], [1], [Enable internal packet filter]) test "${enable_strict_options}" = "yes" && AC_DEFINE([ENABLE_STRICT_OPTIONS_CHECK], [1], [Enable strict options check between peers]) test "${enable_crypto_ofb_cfb}" = "yes" && AC_DEFINE([ENABLE_OFB_CFB_MODE], [1], [Enable OFB and CFB cipher modes])
doc/man-sections/generic-options.rst +0 -4
@@ -418,10 +418,6 @@ which mode OpenVPN is configured as. success/failure via :code:`auth_control_file` when using deferred auth method and pending authentification via :code:`pending_auth_file`. - - * :code:`OPENVPN_PLUGIN_ENABLE_PF` plugin hook to pass filtering rules - via ``pf_file`` - --use-prediction-resistance Enable prediction resistance on mbed TLS's RNG.
include/openvpn-plugin.h.in +3 -88
123 lines not on this page · raw message
sample/sample-plugins/defer/simple.c +1 -149
168 lines not on this page · raw message
src/openvpn/Makefile.am +0 -1
@@ -97,7 +97,6 @@ openvpn_SOURCES = \ otime.c otime.h \ packet_id.c packet_id.h \ perf.c perf.h \ - pf.c pf.h \ ping.c ping.h \ plugin.c plugin.h \ pool.c pool.h \
src/openvpn/errlevel.h +0 -4
@@ -90,7 +90,6 @@#define D_ROUTE_QUOTA LOGLEV(3, 42, 0)/* show route quota exceeded messages */ #define D_OSBUF LOGLEV(3, 43, 0)/* show socket/tun/tap buffer sizes */ #define D_PS_PROXY LOGLEV(3, 44, 0)/* messages related to --port-share option */ -#define D_PF_INFO LOGLEV(3, 45, 0)/* packet filter informational messages */ #define D_IFCONFIG LOGLEV(3, 0, 0)/* show ifconfig info (don't mute) */ #define D_SHOW_PARMS LOGLEV(4, 50, 0)/* show all parameters on program initiation */
@@ -99,7 +98,6 @@#define D_DHCP_OPT LOGLEV(4, 53, 0)/* show DHCP options binary string */ #define D_MBUF LOGLEV(4, 54, 0)/* mbuf.[ch] routines */ #define D_PACKET_TRUNC_ERR LOGLEV(4, 55, 0)/* PACKET_TRUNCATION_CHECK */ -#define D_PF_DROPPED LOGLEV(4, 56, 0)/* packet filter dropped a packet */ #define D_MULTI_DROPPED LOGLEV(4, 57, 0)/* show point-to-multipoint packet drops */ #define D_MULTI_MEDIUM LOGLEV(4, 58, 0)/* show medium frequency multi messages */ #define D_X509_ATTR LOGLEV(4, 59, 0)/* show x509-track attributes on connection */
@@ -145,8 +143,6 @@#define D_ARGV_PARSE_CMD LOGLEV(7, 70, M_DEBUG)/* show parse_line() errors in argv_parse_cmd */ #define D_CRYPTO_DEBUG LOGLEV(7, 70, M_DEBUG)/* show detailed info from crypto.c routines */ #define D_PID_DEBUG LOGLEV(7, 70, M_DEBUG)/* show packet-id debugging info */ -#define D_PF_DROPPED_BCAST LOGLEV(7, 71, M_DEBUG)/* packet filter dropped a broadcast packet */ -#define D_PF_DEBUG LOGLEV(7, 72, M_DEBUG)/* packet filter debugging, must also define PF_DEBUG in pf.h */ #define D_PUSH_DEBUG LOGLEV(7, 73, M_DEBUG)/* show push/pull debugging info */ #define D_VLAN_DEBUG LOGLEV(7, 74, M_DEBUG)/* show VLAN tagging/untagging debug info */
src/openvpn/forward.c +0 -9
@@ -36,7 +36,6 @@#include "mss.h" #include "event.h" #include "occ.h" -#include "pf.h" #include "ping.h" #include "ps.h" #include "dhcp.h"
@@ -634,14 +633,6 @@ process_coarse_timers(struct context *c)check_push_request (c); } -#ifdef PLUGIN_PF -if (c->c2.pf.enabled - &&event_timeout_trigger (&c->c2.pf.reload, &c->c2.timeval,ETT_DEFAULT )) - { -pf_check_reload (c); - } -#endif -/* process --route options */ if (event_timeout_trigger (&c->c2.route_wakeup, &c->c2.timeval,ETT_DEFAULT )) {
src/openvpn/init.c +0 -11
@@ -4347,13 +4347,6 @@ init_instance(struct context *c, const struct env_set *env, const unsigned int f }#endif -#ifdef ENABLE_PF -if (child) - { -pf_init_context (c); - } -#endif -/* Check for signals */ if (IS_SIG (c)) {
@@ -4415,10 +4408,6 @@ close_instance(struct context *c) }#endif -#ifdef ENABLE_PF -pf_destroy_context (&c->c2.pf); -#endif -#ifdef ENABLE_PLUGIN /* call plugin close functions and unload */ do_close_plugins (c);
src/openvpn/manage.c +0 -53
77 lines not on this page · raw message
src/openvpn/manage.h +2 -16
@@ -176,11 +176,6 @@ struct management_callbackconst char *extra, unsigned int timeout);char *(*get_peer_info) (void *arg,const unsigned long cid); -#ifdef MANAGEMENT_PF -bool (*client_pf)(void *arg, -const unsigned long cid, -struct buffer_list *pf_config);/* ownership transferred */ -#endif bool (*proxy_cmd)(void *arg,const char **p);bool (*remote_cmd) (void *arg,const char **p);#ifdef TARGET_ANDROID
@@ -278,7 +273,7 @@ struct man_connection {#define IEC_UNDEF 0#define IEC_CLIENT_AUTH 1 -#define IEC_CLIENT_PF 2 +/*#define IEC_CLIENT_PF 2 *REMOVED FEATURE* */ #define IEC_RSA_SIGN 3#define IEC_CERTIFICATE 4#define IEC_PK_SIGN 5
@@ -335,9 +330,7 @@ struct management *management_init(void);#define MF_FORGET_DISCONNECT (1<<4)#define MF_CONNECT_AS_CLIENT (1<<5)#define MF_CLIENT_AUTH (1<<6) -#ifdef MANAGEMENT_PF -#define MF_CLIENT_PF (1<<7) -#endif +//#define MF_CLIENT_PF (1<<7) *NOT IMPLEMENTED* #define MF_UNIX_SOCK (1<<8)#define MF_EXTERNAL_KEY (1<<9)#define MF_EXTERNAL_KEY_NOPADDING (1<<10)
@@ -460,13 +453,6 @@ management_query_proxy_enabled(const struct management *man)return BOOL_CAST (man->settings.flags &MF_QUERY_PROXY ); } -#ifdef MANAGEMENT_PF -static inline bool -management_enable_pf (const struct management *man) -{ -return man &&BOOL_CAST (man->settings.flags &MF_CLIENT_PF ); -} -#endif static inline bool management_enable_def_auth (const struct management *man)
src/openvpn/mroute.c +0 -70
88 lines not on this page · raw message
src/openvpn/mroute.h +1 -5
@@ -177,8 +177,6 @@ unsigned int mroute_extract_addr_ip(struct mroute_addr *src,unsigned int mroute_extract_addr_ether (struct mroute_addr *src,struct mroute_addr *dest, -struct mroute_addr *esrc, -struct mroute_addr *edest,uint16_t vid,const struct buffer *buf);
@@ -189,8 +187,6 @@ unsigned int mroute_extract_addr_ether(struct mroute_addr *src,static inline unsigned int mroute_extract_addr_from_packet (struct mroute_addr *src,struct mroute_addr *dest, -struct mroute_addr *esrc, -struct mroute_addr *edest,uint16_t vid,const struct buffer *buf,int tunnel_type)
@@ -203,7 +199,7 @@ mroute_extract_addr_from_packet(struct mroute_addr *src, }else if (tunnel_type ==DEV_TYPE_TAP ) { - ret =mroute_extract_addr_ether (src, dest, esrc, edest, vid, buf); + ret =mroute_extract_addr_ether (src, dest, vid, buf); }return ret; }
src/openvpn/multi.c +0 -150
245 lines not on this page · raw message
src/openvpn/openvpn.h +0 -4
@@ -42,7 +42,6 @@#include "sig.h" #include "misc.h" #include "mbuf.h" -#include "pf.h" #include "pool.h" #include "plugin.h" #include "manage.h"
@@ -437,9 +436,6 @@ struct context_2int scheduled_exit_signal;/* packet filter */ -#ifdef ENABLE_PF -struct pf_context pf; -#endif #ifdef ENABLE_MANAGEMENT struct man_def_auth_context mda_context;
src/openvpn/openvpn.vcxproj +0 -2
@@ -276,7 +276,6 @@ <ClCompile Include="otime.c" /> <ClCompile Include="packet_id.c" /> <ClCompile Include="perf.c" /> - <ClCompile Include="pf.c" /> <ClCompile Include="ping.c" /> <ClCompile Include="pkcs11.c" /> <ClCompile Include="pkcs11_openssl.c" />
@@ -362,7 +361,6 @@ <ClInclude Include="otime.h" /> <ClInclude Include="packet_id.h" /> <ClInclude Include="perf.h" /> - <ClInclude Include="pf.h" /> <ClInclude Include="ping.h" /> <ClInclude Include="pkcs11.h" /> <ClInclude Include="pkcs11_backend.h" />
src/openvpn/openvpn.vcxproj.filters +0 -6
@@ -129,9 +129,6 @@ <ClCompile Include="perf.c"> <Filter>Source Files</Filter> </ClCompile> - <ClCompile Include="pf.c"> - <Filter>Source Files</Filter> - </ClCompile> <ClCompile Include="ping.c"> <Filter>Source Files</Filter> </ClCompile>
@@ -392,9 +389,6 @@ <ClInclude Include="perf.h"> <Filter>Header Files</Filter> </ClInclude> - <ClInclude Include="pf.h"> - <Filter>Header Files</Filter> - </ClInclude> <ClInclude Include="ping.h"> <Filter>Header Files</Filter> </ClInclude>
src/openvpn/options.c +0 -11
@@ -391,10 +391,6 @@ static const char usage_message[] ="--management-client-auth : gives management interface client the responsibility\n" " to authenticate clients after their client certificate\n" " has been verified.\n" -#ifdef MANAGEMENT_PF -"--management-client-pf : management interface clients must specify a packet\n" - " filter file for each connecting client.\n" -#endif #endif /* ifdef ENABLE_MANAGEMENT */ #ifdef ENABLE_PLUGIN "--plugin m [str]: Load plug-in module m passing str as an argument\n"
@@ -5479,13 +5475,6 @@ add_option(struct options *options, options->management_flags |=MF_CLIENT_AUTH ; }#endif /* ifdef ENABLE_MANAGEMENT */ -#ifdef MANAGEMENT_PF - else if (streq(p[0], "management-client-pf") && !p[1]) - { -VERIFY_PERMISSION (OPT_P_GENERAL ); - options->management_flags |= (MF_CLIENT_PF |MF_CLIENT_AUTH ); - } -#endif else if (streq(p[0], "management-log-cache") && p[1] && !p[2]) {int cache;
src/openvpn/pf.c deleted +0 -787
787 lines not on this page · raw message
src/openvpn/pf.h deleted +0 -147
147 lines not on this page · raw message
src/openvpn/plugin.c +1 -10
@@ -119,9 +119,6 @@ plugin_type_name(const int type)case OPENVPN_PLUGIN_TLS_FINAL :return "PLUGIN_TLS_FINAL" ; -case OPENVPN_PLUGIN_ENABLE_PF : -return "PLUGIN_ENABLE_PF" ; -case OPENVPN_PLUGIN_ROUTE_PREDOWN :return "PLUGIN_ROUTE_PREDOWN" ;
@@ -804,7 +801,6 @@ plugin_call_ssl(const struct plugin_list *pl,int i;const char **envp;const int n =plugin_n (pl); -bool success = false;bool error = false;bool deferred = false;
@@ -825,7 +821,6 @@ plugin_call_ssl(const struct plugin_list *pl,switch (status) {case OPENVPN_PLUGIN_FUNC_SUCCESS : - success = true;break ;case OPENVPN_PLUGIN_FUNC_DEFERRED :
@@ -845,11 +840,7 @@ plugin_call_ssl(const struct plugin_list *pl,gc_free (&gc); -if (type ==OPENVPN_PLUGIN_ENABLE_PF && success) - { -return OPENVPN_PLUGIN_FUNC_SUCCESS ; - } -else if (error) +if (error) {return OPENVPN_PLUGIN_FUNC_ERROR ; }
src/openvpn/ssl_common.h +0 -4
@@ -464,10 +464,6 @@ struct tls_sessionstruct cert_hash_set *cert_hash_set; -#ifdef ENABLE_PF -uint32_t common_name_hashval; -#endif -bool verified;/* true if peer certificate was verified against CA */ /* not-yet-authenticated incoming client */
src/openvpn/ssl_verify.c +0 -16
@@ -95,27 +95,11 @@ set_common_name(struct tls_session *session, const char *common_name) {free (session->common_name); session->common_name =NULL ; -#ifdef ENABLE_PF - session->common_name_hashval =0 ; -#endif }if (common_name) {/* FIXME: Last alloc will never be freed */ session->common_name =string_alloc (common_name,NULL ); -#ifdef ENABLE_PF - { -const uint32_t len = (uint32_t )strlen (common_name); -if (len) - { - session->common_name_hashval =hash_func ((const uint8_t *)common_name, len+1 ,0 ); - } -else - { - session->common_name_hashval =0 ; - } - } -#endif } }
src/openvpn/ssl_verify.h +0 -29
@@ -161,35 +161,6 @@ const char *tls_username(const struct tls_multi *multi, const bool null);*/ bool cert_hash_compare (const struct cert_hash_set *chs1,const struct cert_hash_set *chs2); -#ifdef ENABLE_PF - -/** -* Retrieve the given tunnel's common name and its hash value. -* -* @param multi The tunnel to use -* @param cn Common name's string -* @param cn_hash Common name's hash value -* -* @return true if the common name was set, false otherwise. -*/ -static inline bool -tls_common_name_hash (const struct tls_multi *multi,const char **cn,uint32_t *cn_hash) -{ -if (multi) - { -const struct tls_session *s = &multi->session[TM_ACTIVE ]; -if (s->common_name && s->common_name[0 ] !='\0' ) - { - *cn = s->common_name; - *cn_hash = s->common_name_hashval; -return true; - } - } -return false; -} - -#endif -/** * Verify the given username and password, using either an external script, a * plugin, or the management interface.
src/openvpn/syshead.h +0 -13
@@ -475,19 +475,6 @@ socket_defined(const socket_descriptor_t sd)#define ENABLE_PREDICTION_RESISTANCE #endif /* ENABLE_CRYPTO_MBEDTLS */ -/* -* Enable packet filter? -*/ -#if defined(ENABLE_PF ) && defined(ENABLE_PLUGIN ) && defined(HAVE_STAT ) -#define PLUGIN_PF -#endif -#if defined(ENABLE_PF ) && defined(ENABLE_MANAGEMENT ) -#define MANAGEMENT_PF -#endif -#if !defined(PLUGIN_PF ) && !defined(MANAGEMENT_PF ) -#undef ENABLE_PF -#endif -/* * Do we support Unix domain sockets? */
Signature · 1 line
2.31.1
Am 27.08.21 um 21:00 schrieb Antonio Quartulli:
Quoted 14 lines
OpenVPN shipped a small packet filtering tool called PF. It has never been straightforward as it required a plugin to work. On top of that, keeping PF support, makes the code more complicated and increases the maintenance cost of OpenVPN.
PF itself is not actually maintained at all and there is little motivation in keeping it alive.
Some years ago an IPv6 extension for PF was proposed, but it was never picked up for the reasons above.
External (and more appropriate) tools can still be used to implement packet filtering on the OpenVPN interface.
Quoted 8 lines
Drop PF support for good.
Note that IDs used for external communication (i.e. to the plugin or management interface) have been commented out, but not removed, as they should not be used in the future.
v2:
* changed // to /* */
Aside from the comment formatting being incomplete, f. i. //#define MF_CLIENT_PF still has "//" - why the hassle?
Do we need to maintain C89 compatibility these days?
Hi,
Quoted 1 line · Matthias Andree
Do we need to maintain C89 compatibility these days?
No. C99 is fully acceptable.
gert
Signature · 6 lines
"If was one thing all people took for granted, was conviction that if you
feed honest figures into a computer, honest figures come out. Never doubted
it myself till I met a computer with a sense of humor."
Robert A. Heinlein, The Moon is a Harsh Mistress
Gert Doering - Munich, Germany [email protected]...Hi
Quoted 7 lines · Gert Doering
Hi,
Quoted 1 line · Matthias Andree
Do we need to maintain C89 compatibility these days?
No. C99 is fully acceptable.
But our coding style still has to be followed. That means /* */ comments only.
Selva
Hi,
Quoted 8 lines · Selva Nair
Quoted 3 lines · Gert Doering
Quoted 1 line · Matthias Andree
Do we need to maintain C89 compatibility these days?
No. C99 is fully acceptable.
But our coding style still has to be followed. That means /* */ comments only.
Ah. Seems I misunderstood the reason for Matthias' question.
Indeed, comments must be /* */ for coding style / consistency reasons, and for no other reason than we agreed to do it that way. And not use tabs for indenting (which I personally find cumbersome as "vi" really loves to auto-tab stuff :-) ).
And while the whitespace police can be really annoying at times, the overall readability of our code *has* improved quite a bit.
gert
Signature · 6 lines
"If was one thing all people took for granted, was conviction that if you
feed honest figures into a computer, honest figures come out. Never doubted
it myself till I met a computer with a sense of humor."
Robert A. Heinlein, The Moon is a Harsh Mistress
Gert Doering - Munich, Germany [email protected]...Am 27.08.21 um 21:00 schrieb Antonio Quartulli:
Quoted 28 lines
OpenVPN shipped a small packet filtering tool called PF. It has never been straightforward as it required a plugin to work. On top of that, keeping PF support, makes the code more complicated and increases the maintenance cost of OpenVPN.
PF itself is not actually maintained at all and there is little motivation in keeping it alive.
Some years ago an IPv6 extension for PF was proposed, but it was never picked up for the reasons above.
External (and more appropriate) tools can still be used to implement packet filtering on the OpenVPN interface.
Drop PF support for good.
Note that IDs used for external communication (i.e. to the plugin or management interface) have been commented out, but not removed, as they should not be used in the future.
v2:
* changed // to /* */
* changed "NOT IMPLEMENTED" to "REMOVED FEATURE"
* removed extra empty lines after removing ifdef blocks
* clarified on IRC thattls_finalhas to be removed and therefore that hunk is correct
* removedmi_prefix()function as it is now unused
Quoted 2 lines
Cc Arne Schwabe <[email protected]...>Signed-off-by Antonio Quartulli <[email protected]...>
Arne just reminded me that we also need some text for Changes.rst.
How about this?
68 PF (Packet Filtering) support has been removed
69 The built-in PF functionality has been definitely removed from
the code
70 base. This feature wasn't really easy to use and was long
unmaintained.
71 This implies that also ``--management-client-pf`` and any other
compiletime
72 or runtime related option does not exist any longer.
Gert could you please add this when applying this patch?
Thanks!
Quoted 40 lines · Arne Schwabe
Am 27.08.21 um 21:00 schrieb Antonio Quartulli:
Quoted 28 lines
OpenVPN shipped a small packet filtering tool called PF. It has never been straightforward as it required a plugin to work. On top of that, keeping PF support, makes the code more complicated and increases the maintenance cost of OpenVPN.
PF itself is not actually maintained at all and there is little motivation in keeping it alive.
Some years ago an IPv6 extension for PF was proposed, but it was never picked up for the reasons above.
External (and more appropriate) tools can still be used to implement packet filtering on the OpenVPN interface.
Drop PF support for good.
Note that IDs used for external communication (i.e. to the plugin or management interface) have been commented out, but not removed, as they should not be used in the future.
v2:
* changed // to /* */
* changed "NOT IMPLEMENTED" to "REMOVED FEATURE"
* removed extra empty lines after removing ifdef blocks
* clarified on IRC thattls_finalhas to be removed and therefore that hunk is correct
* removedmi_prefix()function as it is now unusedQuoted 2 lines
Cc Arne Schwabe <[email protected]...>Signed-off-by Antonio Quartulli <[email protected]...>Acked-by Arne Schwabe <[email protected]...>_______________________________________________
Openvpn-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openvpn-devel
Signature · 1 line
Antonio Quartulli
I have added an entry to Changes.rst, as requested.
I have changed the // comment in openvpn/manage.h to /* */ as pointed out by Matthias.
Code-wise, this is fairly straightforward (as it's mostly just "code inside #ifdef"), except for my nicely fixed-up plugin code :-) - but that one is good, too (and even had a comment on why it's "tls_final()").
NOTE: multi_process_incoming_link() now has an extra set of {} with indentation, due to the old construct of having an "else" as the last statement in the #endif (around line 3200) - we should fix this with a followup patch.
I have lightly tested this server/client side - I have no setup that actually makes use of pf, so nothing breaks :-) - but all the rest seems to work just fine.
Your patch has been applied to the master branch.
commit 1308ccec9f85418b088723bb870855c0a933311b
Author: Antonio Quartulli Date: Fri Aug 27 21:00:14 2021 +0200
Remove support for PF (Packet Filter)
Signed-off-by: Antonio Quartulli <[email protected]...>
Acked-by: Arne Schwabe <[email protected]...>
Message-Id: <[email protected]...>
URL: https://www.mail-archive.com/[email protected]/msg22780.html
Signed-off-by: Gert Doering <[email protected]...>--
kind regards,
Gert Doering