simple.c File Reference

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "openvpn-plugin.h"

Include dependency graph for simple.c:

Go to the source code of this file.

Data Structures
struct	plugin_context

Functions
static const char *	get_env (const char *name, const char *envp[])
OPENVPN_EXPORT openvpn_plugin_handle_t	openvpn_plugin_open_v1 (unsigned int *type_mask, const char *argv[], const char *envp[])
OPENVPN_EXPORT int	openvpn_plugin_func_v1 (openvpn_plugin_handle_t handle, const int type, const char *argv[], const char *envp[])
	This function is called by OpenVPN each time the OpenVPN reaches a point where plug-in calls should happen. More...
OPENVPN_EXPORT void	openvpn_plugin_close_v1 (openvpn_plugin_handle_t handle)
	This cleans up the last part of the plug-in, allows it to shut down cleanly and release the plug-in global context buffer. More...

Function Documentation

get_env()

static const char* get_env ( const char *  name, const char *  envp[]  )

static

Definition at line 53 of file simple.c.

References OPENVPN_EXPORT.

Referenced by openvpn_plugin_func_v1().

openvpn_plugin_close_v1()

OPENVPN_EXPORT void openvpn_plugin_close_v1

(

openvpn_plugin_handle_t

handle

)

This cleans up the last part of the plug-in, allows it to shut down cleanly and release the plug-in global context buffer.

Parameters

handle

Pointer to the plug-in global context buffer, which need to be released by this function

Definition at line 126 of file simple.c.

References free.

openvpn_plugin_func_v1()

OPENVPN_EXPORT int openvpn_plugin_func_v1	(	openvpn_plugin_handle_t	handle,
		const int	type,
		const char *	argv[],
		const char *	envp[]
	)

This function is called by OpenVPN each time the OpenVPN reaches a point where plug-in calls should happen.

It only happens for those plug-in hooks enabled in openvpn_plugin_open_v3().

For the arguments, see the include/openvpn-plugin.h file for details on the function parameters

Parameters

args	Pointer to a struct with details about the plug-in call from the main OpenVPN process.
returndata	Pointer to a struct where the plug-in can provide information back to OpenVPN to be processed

Returns

Must return OPENVPN_PLUGIN_FUNC_SUCCESS or OPENVPN_PLUGIN_FUNC_DEFERRED on success. Otherwise it should return OPENVPN_FUNC_ERROR, which will stop and reject the client session from progressing.

Definition at line 105 of file simple.c.

References get_env(), OPENVPN_EXPORT, OPENVPN_PLUGIN_FUNC_ERROR, OPENVPN_PLUGIN_FUNC_SUCCESS, plugin_context::password, and plugin_context::username.

openvpn_plugin_open_v1()

OPENVPN_EXPORT openvpn_plugin_handle_t openvpn_plugin_open_v1	(	unsigned int *	type_mask,
		const char *	argv[],
		const char *	envp[]
	)

Definition at line 75 of file simple.c.

References OPENVPN_EXPORT, OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY, OPENVPN_PLUGIN_MASK, plugin_context::password, and plugin_context::username.