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 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
|
/*
* OpenVPN -- An application to securely tunnel IP networks
* over a single TCP/UDP port, with support for SSL/TLS-based
* session authentication and key exchange,
* packet encryption, packet authentication, and
* packet compression.
*
* Copyright (C) 2002-2008 Telethra, Inc. <sales@openvpn.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2
* as published by the Free Software Foundation.
*
* 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 (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
*/
#include "syshead.h"
#include "buffer.h"
#include "error.h"
#include "win32.h"
#include "init.h"
#include "status.h"
#include "sig.h"
#include "occ.h"
#include "manage.h"
#include "openvpn.h"
#include "memdbg.h"
/* Handle signals */
struct signal_info siginfo_static; /* GLOBAL */
struct signame {
int value;
const char *upper;
const char *lower;
};
static const struct signame signames[] = {
{ SIGINT, "SIGINT", "sigint"},
{ SIGTERM, "SIGTERM", "sigterm" },
{ SIGHUP, "SIGHUP", "sighup" },
{ SIGUSR1, "SIGUSR1", "sigusr1" },
{ SIGUSR2, "SIGUSR2", "sigusr2" }
};
int
parse_signal (const char *signame)
{
int i;
for (i = 0; i < (int)SIZE (signames); ++i)
{
if (!strcmp (signame, signames[i].upper))
return signames[i].value;
}
return -1;
}
const char *
signal_name (const int sig, const bool upper)
{
int i;
for (i = 0; i < (int)SIZE (signames); ++i)
{
if (sig == signames[i].value)
return upper ? signames[i].upper : signames[i].lower;
}
return "UNKNOWN";
}
const char *
signal_description (const int signum, const char *sigtext)
{
if (sigtext)
return sigtext;
else
return signal_name (signum, false);
}
void
throw_signal (const int signum)
{
siginfo_static.signal_received = signum;
siginfo_static.hard = true;
}
void
throw_signal_soft (const int signum, const char *signal_text)
{
siginfo_static.signal_received = signum;
siginfo_static.hard = false;
siginfo_static.signal_text = signal_text;
}
static void
signal_reset (struct signal_info *si)
{
if (si)
{
si->signal_received = 0;
si->signal_text = NULL;
si->hard = false;
}
}
void
print_signal (const struct signal_info *si, const char *title, int msglevel)
{
if (si)
{
const char *hs = (si->hard ? "hard" : "soft");
const char *type = (si->signal_text ? si->signal_text : "");
const char *t = (title ? title : "process");
switch (si->signal_received)
{
case SIGINT:
case SIGTERM:
msg (msglevel, "%s[%s,%s] received, %s exiting",
signal_name (si->signal_received, true), hs, type, t);
break;
case SIGHUP:
case SIGUSR1:
msg (msglevel, "%s[%s,%s] received, %s restarting",
signal_name (si->signal_received, true), hs, type, t);
break;
default:
msg (msglevel, "Unknown signal %d [%s,%s] received by %s", si->signal_received, hs, type, t);
break;
}
}
else
msg (msglevel, "Unknown signal received");
}
/*
* Call management interface with restart info
*/
void
signal_restart_status (const struct signal_info *si)
{
#ifdef ENABLE_MANAGEMENT
if (management)
{
int state = -1;
switch (si->signal_received)
{
case SIGINT:
case SIGTERM:
state = OPENVPN_STATE_EXITING;
break;
case SIGHUP:
case SIGUSR1:
state = OPENVPN_STATE_RECONNECTING;
break;
}
if (state >= 0)
management_set_state (management,
state,
si->signal_text ? si->signal_text : signal_name (si->signal_received, true),
(in_addr_t)0,
(in_addr_t)0);
}
#endif
}
#ifdef HAVE_SIGNAL_H
/* normal signal handler, when we are in event loop */
static void
signal_handler (const int signum)
{
throw_signal (signum);
signal (signum, signal_handler);
}
/* temporary signal handler, before we are fully initialized */
static void
signal_handler_exit (const int signum)
{
msg (M_FATAL,
"Signal %d (%s) received during initialization, exiting",
signum, signal_description (signum, NULL));
}
#endif
/* set handlers for unix signals */
#ifdef HAVE_SIGNAL_H
#define SM_UNDEF 0
#define SM_PRE_INIT 1
#define SM_POST_INIT 2
static int signal_mode; /* GLOBAL */
#endif
void
pre_init_signal_catch (void)
{
#ifdef HAVE_SIGNAL_H
signal_mode = SM_PRE_INIT;
signal (SIGINT, signal_handler);
signal (SIGTERM, signal_handler);
signal (SIGHUP, SIG_IGN);
signal (SIGUSR1, SIG_IGN);
signal (SIGUSR2, SIG_IGN);
signal (SIGPIPE, SIG_IGN);
#endif /* HAVE_SIGNAL_H */
}
void
post_init_signal_catch (void)
{
#ifdef HAVE_SIGNAL_H
signal_mode = SM_POST_INIT;
signal (SIGINT, signal_handler);
signal (SIGTERM, signal_handler);
signal (SIGHUP, signal_handler);
signal (SIGUSR1, signal_handler);
signal (SIGUSR2, signal_handler);
signal (SIGPIPE, SIG_IGN);
#endif /* HAVE_SIGNAL_H */
}
/* called after daemonization to retain signal settings */
void
restore_signal_state (void)
{
#ifdef HAVE_SIGNAL_H
if (signal_mode == SM_PRE_INIT)
pre_init_signal_catch ();
else if (signal_mode == SM_POST_INIT)
post_init_signal_catch ();
#endif
}
/*
* Print statistics.
*
* Triggered by SIGUSR2 or F2 on Windows.
*/
void
print_status (const struct context *c, struct status_output *so)
{
struct gc_arena gc = gc_new ();
status_reset (so);
status_printf (so, PACKAGE_NAME " STATISTICS");
status_printf (so, "Updated,%s", time_string (0, 0, false, &gc));
status_printf (so, "TUN/TAP read bytes," counter_format, c->c2.tun_read_bytes);
status_printf (so, "TUN/TAP write bytes," counter_format, c->c2.tun_write_bytes);
status_printf (so, "TCP/UDP read bytes," counter_format, c->c2.link_read_bytes);
status_printf (so, "TCP/UDP write bytes," counter_format, c->c2.link_write_bytes);
status_printf (so, "Auth read bytes," counter_format, c->c2.link_read_bytes_auth);
#ifdef USE_LZO
if (lzo_defined (&c->c2.lzo_compwork))
lzo_print_stats (&c->c2.lzo_compwork, so);
#endif
#ifdef PACKET_TRUNCATION_CHECK
status_printf (so, "TUN read truncations," counter_format, c->c2.n_trunc_tun_read);
status_printf (so, "TUN write truncations," counter_format, c->c2.n_trunc_tun_write);
status_printf (so, "Pre-encrypt truncations," counter_format, c->c2.n_trunc_pre_encrypt);
status_printf (so, "Post-decrypt truncations," counter_format, c->c2.n_trunc_post_decrypt);
#endif
#ifdef WIN32
if (tuntap_defined (c->c1.tuntap))
status_printf (so, "TAP-WIN32 driver status,\"%s\"",
tap_win32_getinfo (c->c1.tuntap, &gc));
#endif
status_printf (so, "END");
status_flush (so);
gc_free (&gc);
}
#ifdef ENABLE_OCC
/*
* Handle the triggering and time-wait of explicit
* exit notification.
*/
static void
process_explicit_exit_notification_init (struct context *c)
{
msg (M_INFO, "SIGTERM received, sending exit notification to peer");
event_timeout_init (&c->c2.explicit_exit_notification_interval, 1, 0);
reset_coarse_timers (c);
signal_reset (c->sig);
halt_non_edge_triggered_signals ();
c->c2.explicit_exit_notification_time_wait = now;
}
void
process_explicit_exit_notification_timer_wakeup (struct context *c)
{
if (event_timeout_trigger (&c->c2.explicit_exit_notification_interval,
&c->c2.timeval,
ETT_DEFAULT))
{
ASSERT (c->c2.explicit_exit_notification_time_wait && c->options.explicit_exit_notification);
if (now >= c->c2.explicit_exit_notification_time_wait + c->options.explicit_exit_notification)
{
event_timeout_clear (&c->c2.explicit_exit_notification_interval);
c->sig->signal_received = SIGTERM;
c->sig->signal_text = "exit-with-notification";
}
else
{
c->c2.occ_op = OCC_EXIT;
}
}
}
#endif
/*
* Process signals
*/
void
remap_signal (struct context *c)
{
if (c->sig->signal_received == SIGUSR1 && c->options.remap_sigusr1)
c->sig->signal_received = c->options.remap_sigusr1;
}
static void
process_sigusr2 (const struct context *c)
{
struct status_output *so = status_open (NULL, 0, M_INFO, NULL, 0);
print_status (c, so);
status_close (so);
signal_reset (c->sig);
}
static bool
process_sigterm (struct context *c)
{
bool ret = true;
#ifdef ENABLE_OCC
if (c->options.explicit_exit_notification
&& !c->c2.explicit_exit_notification_time_wait)
{
process_explicit_exit_notification_init (c);
ret = false;
}
#endif
return ret;
}
bool
process_signal (struct context *c)
{
bool ret = true;
if (c->sig->signal_received == SIGTERM || c->sig->signal_received == SIGINT)
{
ret = process_sigterm (c);
}
else if (c->sig->signal_received == SIGUSR2)
{
process_sigusr2 (c);
ret = false;
}
return ret;
}
|