diff options
Diffstat (limited to 'include/openvpn-plugin.h.in')
| -rw-r--r-- | include/openvpn-plugin.h.in | 37 |
1 files changed, 28 insertions, 9 deletions
diff --git a/include/openvpn-plugin.h.in b/include/openvpn-plugin.h.in index 0b30352..f29b3a0 100644 --- a/include/openvpn-plugin.h.in +++ b/include/openvpn-plugin.h.in @@ -16,10 +16,9 @@ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program (see the file COPYING included with this - * distribution); if not, write to the Free Software Foundation, Inc., - * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #ifndef OPENVPN_PLUGIN_H_ @@ -44,6 +43,7 @@ typedef X509 openvpn_x509_cert_t; #endif #include <stdarg.h> +#include <stddef.h> #ifdef __cplusplus extern "C" { @@ -199,7 +199,8 @@ struct openvpn_plugin_string_list /* openvpn_plugin_{open,func}_v3() related structs */ -/* Defines version of the v3 plugin argument structs +/** + * Defines version of the v3 plugin argument structs * * Whenever one or more of these structs are modified, this constant * must be updated. A changelog should be appended in this comment @@ -218,8 +219,10 @@ struct openvpn_plugin_string_list * 3 Added ovpn_version, ovpn_version_major, ovpn_version_minor * and ovpn_version_patch to provide the runtime version of * OpenVPN to plug-ins. + * + * 4 Exported secure_memzero() as plugin_secure_memzero() */ -#define OPENVPN_PLUGINv3_STRUCTVER 3 +#define OPENVPN_PLUGINv3_STRUCTVER 4 /** * Definitions needed for the plug-in callback functions. @@ -255,10 +258,19 @@ typedef void (*plugin_vlog_t)(openvpn_plugin_log_flags_t flags, const char *plugin_name, const char *format, va_list arglist) _ovpn_chk_fmt (3, 0); - #undef _ovpn_chk_fmt /** + * Export of secure_memzero() to be used inside plug-ins + * + * @param data Pointer to data to zeroise + * @param len Length of data, in bytes + * + */ +typedef void (*plugin_secure_memzero_t)(void *data, size_t len); + + +/** * Used by the openvpn_plugin_open_v3() function to pass callback * function pointers to the plug-in. * @@ -267,11 +279,18 @@ typedef void (*plugin_vlog_t)(openvpn_plugin_log_flags_t flags, * Messages will only be displayed if the plugin_name parameter * is set. PLOG_DEBUG messages will only be displayed with plug-in * debug log verbosity (at the time of writing that's verb >= 7). + * + * plugin_secure_memzero + * : Use this function to securely wipe sensitive information from + * memory. This function is declared in a way that the compiler + * will not remove these function calls during the compiler + * optimization phase. */ struct openvpn_plugin_callbacks { plugin_log_t plugin_log; plugin_vlog_t plugin_vlog; + plugin_secure_memzero_t plugin_secure_memzero; }; /** @@ -328,12 +347,12 @@ struct openvpn_plugin_args_open_in * * STRUCT MEMBERS * - * *type_mask : The plug-in should set this value to the logical OR of all script + * type_mask : The plug-in should set this value to the logical OR of all script * types which the plug-in wants to intercept. For example, if the * script wants to intercept the client-connect and client-disconnect * script types: * - * *type_mask = OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_CONNECT) + * type_mask = OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_CONNECT) * | OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_DISCONNECT) * * *handle : Pointer to a global plug-in context, created by the plug-in. This pointer |