1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
/* eurephia-auth.c -- Main OpenVPN plug-in functions.
* The API level between OpenVPN and eurephia-auth
*
* GPLv2 only - Copyright (C) 2008 - 2010
* David Sommerseth <dazo@users.sourceforge.net>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; version 2
* of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* 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; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
/**
* @file eurephia-auth.c
* @author David Sommerseth <dazo@users.sourceforge.net>
* @date 2008-08-06
*
* @brief Implements the API which the OpenVPN plug-in interface requires
*
*/
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include "openvpn-plugin.h"
#define EUREPHIA_FWINTF
#include <eurephiafw_struct.h>
#include <eurephia_context.h>
#include <eurephiadb.h>
#include <eurephia.h>
#include <eurephia_nullsafe.h>
#include <environment.h>
#ifdef ENABLE_DEBUG /* To avoid compiler warnings when ENABLE_DEBUG is not defined */
/**
* Simple "converter" from OPENVPN_PLUGIN_* type IDs to string
*
* @param type int value, corresponding to an OPENVPN_PLUGIN_* type
*
* @return String containing the string version of the type
*/
static const char *plugin_type_name(const int type)
{
switch (type)
{
case OPENVPN_PLUGIN_UP:
return "PLUGIN_UP";
case OPENVPN_PLUGIN_DOWN:
return "PLUGIN_DOWN";
case OPENVPN_PLUGIN_ROUTE_UP:
return "PLUGIN_ROUTE_UP";
case OPENVPN_PLUGIN_IPCHANGE:
return "PLUGIN_IPCHANGE";
case OPENVPN_PLUGIN_TLS_VERIFY:
return "PLUGIN_TLS_VERIFY";
case OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY:
return "PLUGIN_AUTH_USER_PASS_VERIFY";
case OPENVPN_PLUGIN_CLIENT_CONNECT:
return "PLUGIN_CLIENT_CONNECT";
case OPENVPN_PLUGIN_CLIENT_DISCONNECT:
return "PLUGIN_CLIENT_DISCONNECT";
case OPENVPN_PLUGIN_LEARN_ADDRESS:
return "PLUGIN_LEARN_ADDRESS";
default:
return "(UNKNOWN PLUGIN CODE)";
}
}
/**
* Dumps the contents of the environmental table to the given FILE. This function is only available
* if DEBUG is defined during compilation. If SHOW_SECRETS is not defined, it will mask the contents
* of the password field, if found.
*
* @param f FILE * where the contents will be dumped
* @param prefix Adds a fixed prefix to each of the lines
* @param envp openvpn environmental table
*/
static void dump_env(FILE *f, const char *prefix, const char *envp[]) {
int i;
for (i = 0; envp[i]; i++) {
#ifdef SHOW_SECRETS
fprintf(f, "%s%s\n", prefix, envp[i]);
#else
fprintf(f, "%s%s\n", prefix ,
(strncmp(envp[i], "password=", 9) == 0) ? "password=xxxxxxx" : envp[i]);
#endif // SHOW_SECRETS
}
}
#endif // ENABLE_DEBUG
/**
* daemonize if "daemon" environment variable is set.
* preserves stderr access after being daemonized, but
* only if "daemon_log_direct" environment variable is set.
*
* @param envp openvpn environmental table
*/
static void daemonize(const char *envp[])
{
char *daemon_string = GETENV_DAEMON(envp);
if( daemon_string && daemon_string[0] == '1' ) {
char *log_redirect = GETENV_DAEMONLOGREDIR(envp);
int fd = -1;
if( log_redirect && log_redirect[0] == '1' ) {
fd = dup (2);
}
if( daemon(0, 0) < 0 ) {
fprintf(stderr, "eurephia-auth: daemonization failed\n");
} else if( fd >= 3 ) {
dup2(fd, 2);
close(fd);
}
free_nullsafe(NULL, log_redirect);
}
free_nullsafe(NULL, daemon_string);
}
/**
* Prepares a eurephiaCTX (context) for the openvpn process and tells openvpn which hooks eurephia
* will make use of.
*
* @param type_mask int pointer, containing the hooks eurephia will make use of
* @param argv arguments from the openvpn --plugin configuration option.
* @param envp openvpn environmental table
*
* @return Returns a pointer to the eurephiaCTX.
*/
OPENVPN_EXPORT openvpn_plugin_handle_t openvpn_plugin_open_v1(unsigned int *type_mask,
const char *argv[], const char *envp[])
{
eurephiaCTX *context = NULL;
#ifdef MEMWATCH
mwStatistics(3);
#warning MEMWATCH enabled
#endif
// Define what will trigger eurephia
*type_mask = OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY)
| OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_TLS_VERIFY)
| OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_CONNECT)
| OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_DISCONNECT)
| OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_LEARN_ADDRESS);
// Setup a eurephia context
context = eurephiaInit(argv);
// Daemonize if requested
daemonize(envp);
return (openvpn_plugin_handle_t) context;
}
/**
* On each hook defined in openvpn_plugin_open_v1(), this function will be called when
* openvpn reaches that phase.
*
* @param handle Contains a pointer to the eurephiaCTX
* @param type What kind of event is openvpn processing now
* @param argv openvpn arguments for the current event
* @param envp openvpn environmental table
*
* @return Returns OPENVPN_PLUGIN_FUNC_SUCCESS on success, otherwise OPENVPN_PLUGIN_FUNC_ERROR
*/
OPENVPN_EXPORT int openvpn_plugin_func_v1(openvpn_plugin_handle_t handle,
const int type,
const char *argv[], const char *envp[])
{
eurephiaCTX *ctx = (eurephiaCTX *) handle;
int result = 0;
if( (ctx == NULL) || (ctx->dbc == NULL) || (ctx->dbc->dbhandle == NULL) ) {
return OPENVPN_PLUGIN_FUNC_ERROR;
}
DEBUG(ctx, 10, "openvpn_plugin_func_v1(ctx, %s, ...)", plugin_type_name(type));
#ifdef ENABLE_DEBUG
if( (ctx->log->loglevel >= 30) && (ctx->log->logfile != NULL) ) {
dump_env(ctx->log->logfile, "ENV: ", envp);
dump_env(ctx->log->logfile, "ARG: ", argv);
}
#endif
switch( type ) {
case OPENVPN_PLUGIN_TLS_VERIFY: // Validate certificates
result = eurephia_tlsverify(ctx, envp, argv[1]);
break;
case OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY: // Validate user name and password
result = eurephia_userauth(ctx, envp);
break;
case OPENVPN_PLUGIN_CLIENT_CONNECT: // Register login
result = eurephia_connect(ctx, envp);
break;
case OPENVPN_PLUGIN_CLIENT_DISCONNECT: // Register logout
result = eurephia_disconnect(ctx, envp);
break;
case OPENVPN_PLUGIN_LEARN_ADDRESS: // Log IP address, MAC address and update firewall
result = eurephia_learn_address(ctx, argv[1], argv[2], envp);
break;
default: // This should normally not be reached at all
eurephia_log(ctx, LOG_FATAL, 0, "Unknown OPENVPN_PLUGIN type: %i", type);
break;
}
return (result == 1 ? OPENVPN_PLUGIN_FUNC_SUCCESS : OPENVPN_PLUGIN_FUNC_ERROR);
}
/**
* Called when openvpn is shutting down. This makes sure that eurephia disconnects,
* unloads drivers and frees the memory it has been using.
*
* @param handle Contains a pointer to the eurephiaCTX
*/
OPENVPN_EXPORT void openvpn_plugin_close_v1(openvpn_plugin_handle_t handle)
{
eurephiaCTX *ctx = (eurephiaCTX *) handle;
eurephiaShutdown(ctx);
}
|
