Google Git
Sign in
third-party-mirror / openvpn / 3c0616320807815c85256cecec57f7bed225f9d3 / . / src / openvpn / init.c
blob: 23c069267be963f80c25c78dbdedb0308a1acea8 [file] [log] [blame]
/*
* 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-2018 OpenVPN 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; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#elif defined(_MSC_VER)
#include "config-msvc.h"
#endif
#include "syshead.h"
#ifdef ENABLE_SYSTEMD
#include <systemd/sd-daemon.h>
#endif
#include "win32.h"
#include "init.h"
#include "run_command.h"
#include "sig.h"
#include "occ.h"
#include "list.h"
#include "otime.h"
#include "pool.h"
#include "gremlin.h"
#include "occ.h"
#include "pkcs11.h"
#include "ps.h"
#include "lladdr.h"
#include "ping.h"
#include "mstats.h"
#include "ssl_verify.h"
#include "ssl_ncp.h"
#include "tls_crypt.h"
#include "forward.h"
#include "auth_token.h"
#include "memdbg.h"
static struct context *static_context; /* GLOBAL */
static const char *saved_pid_file_name; /* GLOBAL */
/*
* Crypto initialization flags
*/
#define CF_LOAD_PERSISTED_PACKET_ID (1<<0)
#define CF_INIT_TLS_MULTI (1<<1)
#define CF_INIT_TLS_AUTH_STANDALONE (1<<2)
static void do_init_first_time(struct context *c);
void
context_clear(struct context *c)
{
CLEAR(*c);
}
void
context_clear_1(struct context *c)
{
CLEAR(c->c1);
}
void
context_clear_2(struct context *c)
{
CLEAR(c->c2);
}
void
context_clear_all_except_first_time(struct context *c)
{
const bool first_time_save = c->first_time;
const struct context_persist cpsave = c->persist;
context_clear(c);
c->first_time = first_time_save;
c->persist = cpsave;
}
/*
* Pass tunnel endpoint and MTU parms to a user-supplied script.
* Used to execute the up/down script/plugins.
*/
static void
run_up_down(const char *command,
const struct plugin_list *plugins,
int plugin_type,
const char *arg,
#ifdef _WIN32
DWORD adapter_index,
#endif
const char *dev_type,
int tun_mtu,
int link_mtu,
const char *ifconfig_local,
const char *ifconfig_remote,
const char *context,
const char *signal_text,
const char *script_type,
struct env_set *es)
{
struct gc_arena gc = gc_new();
if (signal_text)
{
setenv_str(es, "signal", signal_text);
}
setenv_str(es, "script_context", context);
setenv_int(es, "tun_mtu", tun_mtu);
setenv_int(es, "link_mtu", link_mtu);
setenv_str(es, "dev", arg);
if (dev_type)
{
setenv_str(es, "dev_type", dev_type);
}
#ifdef _WIN32
setenv_int(es, "dev_idx", adapter_index);
#endif
if (!ifconfig_local)
{
ifconfig_local = "";
}
if (!ifconfig_remote)
{
ifconfig_remote = "";
}
if (!context)
{
context = "";
}
if (plugin_defined(plugins, plugin_type))
{
struct argv argv = argv_new();
ASSERT(arg);
argv_printf(&argv,
"%s %d %d %s %s %s",
arg,
tun_mtu, link_mtu,
ifconfig_local, ifconfig_remote,
context);
if (plugin_call(plugins, plugin_type, &argv, NULL, es) != OPENVPN_PLUGIN_FUNC_SUCCESS)
{
msg(M_FATAL, "ERROR: up/down plugin call failed");
}
argv_free(&argv);
}
if (command)
{
struct argv argv = argv_new();
ASSERT(arg);
setenv_str(es, "script_type", script_type);
argv_parse_cmd(&argv, command);
argv_printf_cat(&argv, "%s %d %d %s %s %s", arg, tun_mtu, link_mtu,
ifconfig_local, ifconfig_remote, context);
argv_msg(M_INFO, &argv);
openvpn_run_script(&argv, es, S_FATAL, "--up/--down");
argv_free(&argv);
}
gc_free(&gc);
}
/*
* Should be called after options->ce is modified at the top
* of a SIGUSR1 restart.
*/
static void
update_options_ce_post(struct options *options)
{
#if P2MP
/*
* In pull mode, we usually import --ping/--ping-restart parameters from
* the server. However we should also set an initial default --ping-restart
* for the period of time before we pull the --ping-restart parameter
* from the server.
*/
if (options->pull
&& options->ping_rec_timeout_action == PING_UNDEF
&& proto_is_dgram(options->ce.proto))
{
options->ping_rec_timeout = PRE_PULL_INITIAL_PING_RESTART;
options->ping_rec_timeout_action = PING_RESTART;
}
#endif
}
#ifdef ENABLE_MANAGEMENT
static bool
management_callback_proxy_cmd(void *arg, const char **p)
{
struct context *c = arg;
struct connection_entry *ce = &c->options.ce;
struct gc_arena *gc = &c->c2.gc;
bool ret = false;
update_time();
if (streq(p[1], "NONE"))
{
ret = true;
}
else if (p[2] && p[3])
{
if (streq(p[1], "HTTP"))
{
struct http_proxy_options *ho;
if (ce->proto != PROTO_TCP && ce->proto != PROTO_TCP_CLIENT)
{
msg(M_WARN, "HTTP proxy support only works for TCP based connections");
return false;
}
ho = init_http_proxy_options_once(&ce->http_proxy_options, gc);
ho->server = string_alloc(p[2], gc);
ho->port = string_alloc(p[3], gc);
ho->auth_retry = (p[4] && streq(p[4], "nct") ? PAR_NCT : PAR_ALL);
ret = true;
}
else if (streq(p[1], "SOCKS"))
{
ce->socks_proxy_server = string_alloc(p[2], gc);
ce->socks_proxy_port = string_alloc(p[3], gc);
ret = true;
}
}
else
{
msg(M_WARN, "Bad proxy command");
}
ce->flags &= ~CE_MAN_QUERY_PROXY;
return ret;
}
static bool
ce_management_query_proxy(struct context *c)
{
const struct connection_list *l = c->options.connection_list;
struct connection_entry *ce = &c->options.ce;
struct gc_arena gc;
bool ret = true;
update_time();
if (management)
{
gc = gc_new();
{
struct buffer out = alloc_buf_gc(256, &gc);
buf_printf(&out, ">PROXY:%u,%s,%s", (l ? l->current : 0) + 1,
(proto_is_udp(ce->proto) ? "UDP" : "TCP"), np(ce->remote));
management_notify_generic(management, BSTR(&out));
management->persist.special_state_msg = BSTR(&out);
}
ce->flags |= CE_MAN_QUERY_PROXY;
while (ce->flags & CE_MAN_QUERY_PROXY)
{
management_event_loop_n_seconds(management, 1);
if (IS_SIG(c))
{
ret = false;
break;
}
}
management->persist.special_state_msg = NULL;
gc_free(&gc);
}
return ret;
}
/**
* This method sends a custom control channel message
*
* This will write the control message
*
* command parm1,parm2,..
* .
* to the control channel.
*
* @param arg The context struct
* @param command The command being sent
* @param parameters the parameters to the command
* @return if sending was successful
*/
static bool
management_callback_send_cc_message(void *arg,
const char *command,
const char *parameters)
{
struct context *c = (struct context *) arg;
size_t len = strlen(command) + 1 + strlen(parameters) + 1;
if (len > PUSH_BUNDLE_SIZE)
{
return false;
}
struct gc_arena gc = gc_new();
struct buffer buf = alloc_buf_gc(len, &gc);
ASSERT(buf_printf(&buf, "%s", command));
if (parameters)
{
ASSERT(buf_printf(&buf, ",%s", parameters));
}
bool status = send_control_channel_string(c, BSTR(&buf), D_PUSH);
gc_free(&gc);
return status;
}
static bool
management_callback_remote_cmd(void *arg, const char **p)
{
struct context *c = (struct context *) arg;
struct connection_entry *ce = &c->options.ce;
int ret = false;
if (p[1] && ((ce->flags>>CE_MAN_QUERY_REMOTE_SHIFT)&CE_MAN_QUERY_REMOTE_MASK) == CE_MAN_QUERY_REMOTE_QUERY)
{
int flags = 0;
if (!strcmp(p[1], "ACCEPT"))
{
flags = CE_MAN_QUERY_REMOTE_ACCEPT;
ret = true;
}
else if (!strcmp(p[1], "SKIP"))
{
flags = CE_MAN_QUERY_REMOTE_SKIP;
ret = true;
}
else if (!strcmp(p[1], "MOD") && p[2] && p[3])
{
if (strlen(p[2]) < RH_HOST_LEN && strlen(p[3]) < RH_PORT_LEN)
{
struct remote_host_store *rhs = c->options.rh_store;
if (!rhs)
{
ALLOC_OBJ_CLEAR_GC(rhs, struct remote_host_store, &c->options.gc);
c->options.rh_store = rhs;
}
strncpynt(rhs->host, p[2], RH_HOST_LEN);
strncpynt(rhs->port, p[3], RH_PORT_LEN);
ce->remote = rhs->host;
ce->remote_port = rhs->port;
flags = CE_MAN_QUERY_REMOTE_MOD;
ret = true;
}
}
if (ret)
{
ce->flags &= ~(CE_MAN_QUERY_REMOTE_MASK<<CE_MAN_QUERY_REMOTE_SHIFT);
ce->flags |= ((flags&CE_MAN_QUERY_REMOTE_MASK)<<CE_MAN_QUERY_REMOTE_SHIFT);
}
}
return ret;
}
static bool
ce_management_query_remote(struct context *c)
{
struct gc_arena gc = gc_new();
volatile struct connection_entry *ce = &c->options.ce;
int ce_changed = true; /* presume the connection entry will be changed */
update_time();
if (management)
{
struct buffer out = alloc_buf_gc(256, &gc);
buf_printf(&out, ">REMOTE:%s,%s,%s", np(ce->remote), ce->remote_port,
proto2ascii(ce->proto, ce->af, false));
management_notify_generic(management, BSTR(&out));
management->persist.special_state_msg = BSTR(&out);
ce->flags &= ~(CE_MAN_QUERY_REMOTE_MASK << CE_MAN_QUERY_REMOTE_SHIFT);
ce->flags |= (CE_MAN_QUERY_REMOTE_QUERY << CE_MAN_QUERY_REMOTE_SHIFT);
while (((ce->flags >> CE_MAN_QUERY_REMOTE_SHIFT)
& CE_MAN_QUERY_REMOTE_MASK) == CE_MAN_QUERY_REMOTE_QUERY)
{
management_event_loop_n_seconds(management, 1);
if (IS_SIG(c))
{
ce_changed = false; /* connection entry have not been set */
break;
}
}
management->persist.special_state_msg = NULL;
}
gc_free(&gc);
if (ce_changed)
{
/* If it is likely a connection entry was modified,
* check what changed in the flags and that it was not skipped
*/
const int flags = ((ce->flags >> CE_MAN_QUERY_REMOTE_SHIFT)
& CE_MAN_QUERY_REMOTE_MASK);
ce_changed = (flags != CE_MAN_QUERY_REMOTE_SKIP);
}
return ce_changed;
}
#endif /* ENABLE_MANAGEMENT */
/*
* Initialize and possibly randomize connection list.
*/
static void
init_connection_list(struct context *c)
{
struct connection_list *l = c->options.connection_list;
l->current = -1;
if (c->options.remote_random)
{
int i;
for (i = 0; i < l->len; ++i)
{
const int j = get_random() % l->len;
if (i != j)
{
struct connection_entry *tmp;
tmp = l->array[i];
l->array[i] = l->array[j];
l->array[j] = tmp;
}
}
}
}
/*
* Clear the remote address list
*/
static void
clear_remote_addrlist(struct link_socket_addr *lsa, bool free)
{
if (lsa->remote_list && free)
{
freeaddrinfo(lsa->remote_list);
}
lsa->remote_list = NULL;
lsa->current_remote = NULL;
}
/*
* Increment to next connection entry
*/
static void
next_connection_entry(struct context *c)
{
struct connection_list *l = c->options.connection_list;
bool ce_defined;
struct connection_entry *ce;
int n_cycles = 0;
do
{
ce_defined = true;
if (c->options.no_advance && l->current >= 0)
{
c->options.no_advance = false;
}
else
{
/* Check if there is another resolved address to try for
* the current connection */
if (c->c1.link_socket_addr.current_remote
&& c->c1.link_socket_addr.current_remote->ai_next)
{
c->c1.link_socket_addr.current_remote =
c->c1.link_socket_addr.current_remote->ai_next;
}
else
{
/* FIXME (schwabe) fix the persist-remote-ip option for real,
* this is broken probably ever since connection lists and multiple
* remote existed
*/
if (!c->options.persist_remote_ip)
{
/* Connection entry addrinfo objects might have been
* resolved earlier but the entry itself might have been
* skipped by management on the previous loop.
* If so, clear the addrinfo objects as close_instance does
*/
if (c->c1.link_socket_addr.remote_list)
{
clear_remote_addrlist(&c->c1.link_socket_addr,
!c->options.resolve_in_advance);
}
/* close_instance should have cleared the addrinfo objects */
ASSERT(c->c1.link_socket_addr.current_remote == NULL);
ASSERT(c->c1.link_socket_addr.remote_list == NULL);
}
else
{
c->c1.link_socket_addr.current_remote =
c->c1.link_socket_addr.remote_list;
}
/*
* Increase the number of connection attempts
* If this is connect-retry-max * size(l)
* OpenVPN will quit
*/
c->options.unsuccessful_attempts++;
if (++l->current >= l->len)
{
l->current = 0;
if (++n_cycles >= 2)
{
msg(M_FATAL, "No usable connection profiles are present");
}
}
}
}
ce = l->array[l->current];
if (ce->flags & CE_DISABLED)
{
ce_defined = false;
}
c->options.ce = *ce;
#ifdef ENABLE_MANAGEMENT
if (ce_defined && management && management_query_remote_enabled(management))
{
/* allow management interface to override connection entry details */
ce_defined = ce_management_query_remote(c);
if (IS_SIG(c))
{
break;
}
}
else if (ce_defined && management && management_query_proxy_enabled(management))
{
ce_defined = ce_management_query_proxy(c);
if (IS_SIG(c))
{
break;
}
}
#endif
} while (!ce_defined);
/* Check if this connection attempt would bring us over the limit */
if (c->options.connect_retry_max > 0
&& c->options.unsuccessful_attempts > (l->len * c->options.connect_retry_max))
{
msg(M_FATAL, "All connections have been connect-retry-max (%d) times unsuccessful, exiting",
c->options.connect_retry_max);
}
update_options_ce_post(&c->options);
}
/*
* Query for private key and auth-user-pass username/passwords
*/
void
init_query_passwords(const struct context *c)
{
/* Certificate password input */
if (c->options.key_pass_file)
{
pem_password_setup(c->options.key_pass_file);
}
#if P2MP
/* Auth user/pass input */
if (c->options.auth_user_pass_file)
{
#ifdef ENABLE_MANAGEMENT
auth_user_pass_setup(c->options.auth_user_pass_file, &c->options.sc_info);
#else
auth_user_pass_setup(c->options.auth_user_pass_file, NULL);
#endif
}
#endif
}
/*
* Initialize/Uninitialize HTTP or SOCKS proxy
*/
static void
uninit_proxy_dowork(struct context *c)
{
if (c->c1.http_proxy_owned && c->c1.http_proxy)
{
http_proxy_close(c->c1.http_proxy);
c->c1.http_proxy = NULL;
c->c1.http_proxy_owned = false;
}
if (c->c1.socks_proxy_owned && c->c1.socks_proxy)
{
socks_proxy_close(c->c1.socks_proxy);
c->c1.socks_proxy = NULL;
c->c1.socks_proxy_owned = false;
}
}
static void
init_proxy_dowork(struct context *c)
{
bool did_http = false;
uninit_proxy_dowork(c);
if (c->options.ce.http_proxy_options)
{
/* Possible HTTP proxy user/pass input */
c->c1.http_proxy = http_proxy_new(c->options.ce.http_proxy_options);
if (c->c1.http_proxy)
{
did_http = true;
c->c1.http_proxy_owned = true;
}
}
if (!did_http && c->options.ce.socks_proxy_server)
{
c->c1.socks_proxy = socks_proxy_new(c->options.ce.socks_proxy_server,
c->options.ce.socks_proxy_port,
c->options.ce.socks_proxy_authfile);
if (c->c1.socks_proxy)
{
c->c1.socks_proxy_owned = true;
}
}
}
static void
init_proxy(struct context *c)
{
init_proxy_dowork(c);
}
static void
uninit_proxy(struct context *c)
{
uninit_proxy_dowork(c);
}
/*
* Saves the initial state of NCP-regotiable
* options into a storage which persists over SIGUSR1.
*/
static void
save_ncp_options(struct context *c)
{
c->c1.ciphername = c->options.ciphername;
c->c1.authname = c->options.authname;
c->c1.keysize = c->options.keysize;
}
/* Restores NCP-negotiable options to original values */
static void
restore_ncp_options(struct context *c)
{
c->options.ciphername = c->c1.ciphername;
c->options.authname = c->c1.authname;
c->options.keysize = c->c1.keysize;
}
void
context_init_1(struct context *c)
{
context_clear_1(c);
packet_id_persist_init(&c->c1.pid_persist);
init_connection_list(c);
save_ncp_options(c);
#if defined(ENABLE_PKCS11)
if (c->first_time)
{
int i;
pkcs11_initialize(true, c->options.pkcs11_pin_cache_period);
for (i = 0; i<MAX_PARMS && c->options.pkcs11_providers[i] != NULL; i++)
{
pkcs11_addProvider(c->options.pkcs11_providers[i], c->options.pkcs11_protected_authentication[i],
c->options.pkcs11_private_mode[i], c->options.pkcs11_cert_private[i]);
}
}
#endif
#if 0 /* test get_user_pass with GET_USER_PASS_NEED_OK flag */
{
/*
* In the management interface, you can okay the request by entering "needok token-insertion-request ok"
*/
struct user_pass up;
CLEAR(up);
strcpy(up.username, "Please insert your cryptographic token"); /* put the high-level message in up.username */
get_user_pass(&up, NULL, "token-insertion-request", GET_USER_PASS_MANAGEMENT|GET_USER_PASS_NEED_OK);
msg(M_INFO, "RET:%s", up.password); /* will return the third argument to management interface
* 'needok' command, usually 'ok' or 'cancel'. */
}
#endif
#ifdef ENABLE_SYSTEMD
/* We can report the PID via getpid() to systemd here as OpenVPN will not
* do any fork due to daemon() a future call.
* See possibly_become_daemon() [init.c] for more details.
*/
sd_notifyf(0, "READY=1\nSTATUS=Pre-connection initialization successful\nMAINPID=%lu",
(unsigned long) getpid());
#endif
}
void
context_gc_free(struct context *c)
{
gc_free(&c->c2.gc);
gc_free(&c->options.gc);
gc_free(&c->gc);
}
#if PORT_SHARE
static void
close_port_share(void)
{
if (port_share)
{
port_share_close(port_share);
port_share = NULL;
}
}
static void
init_port_share(struct context *c)
{
if (!port_share && (c->options.port_share_host && c->options.port_share_port))
{
port_share = port_share_open(c->options.port_share_host,
c->options.port_share_port,
MAX_RW_SIZE_LINK(&c->c2.frame),
c->options.port_share_journal_dir);
if (port_share == NULL)
{
msg(M_FATAL, "Fatal error: Port sharing failed");
}
}
}
#endif /* if PORT_SHARE */
bool
init_static(void)
{
/* configure_path (); */
#if defined(DMALLOC)
crypto_init_dmalloc();
#endif
/*
* Initialize random number seed. random() is only used
* when "weak" random numbers are acceptable.
* SSL library routines are always used when cryptographically
* strong random numbers are required.
*/
struct timeval tv;
if (!gettimeofday(&tv, NULL))
{
const unsigned int seed = (unsigned int) tv.tv_sec ^ tv.tv_usec;
srandom(seed);
}
error_reset(); /* initialize error.c */
reset_check_status(); /* initialize status check code in socket.c */
#ifdef _WIN32
init_win32();
#endif
#ifdef OPENVPN_DEBUG_COMMAND_LINE
{
int i;
for (i = 0; i < argc; ++i)
{
msg(M_INFO, "argv[%d] = '%s'", i, argv[i]);
}
}
#endif
update_time();
init_ssl_lib();
/* init PRNG used for IV generation */
/* When forking, copy this to more places in the code to avoid fork
* random-state predictability */
prng_init(NULL, 0);
#ifdef PID_TEST
packet_id_interactive_test(); /* test the sequence number code */
return false;
#endif
#ifdef SCHEDULE_TEST
schedule_test();
return false;
#endif
#ifdef LIST_TEST
list_test();
return false;
#endif
#ifdef IFCONFIG_POOL_TEST
ifconfig_pool_test(0x0A010004, 0x0A0100FF);
return false;
#endif
#ifdef CHARACTER_CLASS_DEBUG
character_class_debug();
return false;
#endif
#ifdef EXTRACT_X509_FIELD_TEST
extract_x509_field_test();
return false;
#endif
#ifdef TIME_TEST
time_test();
return false;
#endif
#ifdef TEST_GET_DEFAULT_GATEWAY
{
struct route_gateway_info rgi;
struct route_ipv6_gateway_info rgi6;
get_default_gateway(&rgi);
get_default_gateway_ipv6(&rgi6, NULL);
print_default_gateway(M_INFO, &rgi, &rgi6);
return false;
}
#endif
#ifdef GEN_PATH_TEST
{
struct gc_arena gc = gc_new();
const char *fn = gen_path("foo",
"bar",
&gc);
printf("%s\n", fn);
gc_free(&gc);
}
return false;
#endif
#ifdef STATUS_PRINTF_TEST
{
struct gc_arena gc = gc_new();
const char *tmp_file = platform_create_temp_file("/tmp", "foo", &gc);
struct status_output *so = status_open(tmp_file, 0, -1, NULL, STATUS_OUTPUT_WRITE);
status_printf(so, "%s", "foo");
status_printf(so, "%s", "bar");
if (!status_close(so))
{
msg(M_WARN, "STATUS_PRINTF_TEST: %s: write error", tmp_file);
}
gc_free(&gc);
}
return false;
#endif
#ifdef PRNG_TEST
{
struct gc_arena gc = gc_new();
uint8_t rndbuf[8];
int i;
prng_init("sha1", 16);
/*prng_init (NULL, 0);*/
const int factor = 1;
for (i = 0; i < factor * 8; ++i)
{
#if 1
prng_bytes(rndbuf, sizeof(rndbuf));
#else
ASSERT(rand_bytes(rndbuf, sizeof(rndbuf)));
#endif
printf("[%d] %s\n", i, format_hex(rndbuf, sizeof(rndbuf), 0, &gc));
}
gc_free(&gc);
prng_uninit();
return false;
}
#endif /* ifdef PRNG_TEST */
#ifdef BUFFER_LIST_AGGREGATE_TEST
/* test buffer_list_aggregate function */
{
static const char *text[] = {
"It was a bright cold day in April, ",
"and the clocks were striking ",
"thirteen. ",
"Winston Smith, ",
"his chin nuzzled into his breast in an ",
"effort to escape the vile wind, ",
"slipped quickly through the glass doors ",
"of Victory Mansions, though not quickly ",
"enough to prevent a swirl of gritty dust from ",
"entering along with him."
};
int iter, listcap;
for (listcap = 0; listcap < 12; ++listcap)
{
for (iter = 0; iter < 512; ++iter)
{
struct buffer_list *bl = buffer_list_new(listcap);
{
int i;
for (i = 0; i < SIZE(text); ++i)
{
buffer_list_push(bl, (unsigned char *)text[i]);
}
}
printf("[cap=%d i=%d] *************************\n", listcap, iter);
if (!(iter & 8))
{
buffer_list_aggregate(bl, iter/2);
}
if (!(iter & 16))
{
buffer_list_push(bl, (unsigned char *)"Even more text...");
}
buffer_list_aggregate(bl, iter);
if (!(iter & 1))
{
buffer_list_push(bl, (unsigned char *)"More text...");
}
{
struct buffer *buf;
while ((buf = buffer_list_peek(bl)))
{
int c;
printf("'");
while ((c = buf_read_u8(buf)) >= 0)
{
putchar(c);
}
printf("'\n");
buffer_list_advance(bl, 0);
}
}
buffer_list_free(bl);
}
}
return false;
}
#endif /* ifdef BUFFER_LIST_AGGREGATE_TEST */
#ifdef MSTATS_TEST
{
int i;
mstats_open("/dev/shm/mstats.dat");
for (i = 0; i < 30; ++i)
{
mmap_stats->n_clients += 1;
mmap_stats->link_write_bytes += 8;
mmap_stats->link_read_bytes += 16;
sleep(1);
}
mstats_close();
return false;
}
#endif
return true;
}
void
uninit_static(void)
{
free_ssl_lib();
#ifdef ENABLE_PKCS11
pkcs11_terminate();
#endif
#if PORT_SHARE
close_port_share();
#endif
#if defined(MEASURE_TLS_HANDSHAKE_STATS)
show_tls_performance_stats();
#endif
}
void
init_verb_mute(struct context *c, unsigned int flags)
{
if (flags & IVM_LEVEL_1)
{
/* set verbosity and mute levels */
set_check_status(D_LINK_ERRORS, D_READ_WRITE);
set_debug_level(c->options.verbosity, SDL_CONSTRAIN);
set_mute_cutoff(c->options.mute);
}
/* special D_LOG_RW mode */
if (flags & IVM_LEVEL_2)
{
c->c2.log_rw = (check_debug_level(D_LOG_RW) && !check_debug_level(D_LOG_RW + 1));
}
}
/*
* Possibly set --dev based on --dev-node.
* For example, if --dev-node /tmp/foo/tun, and --dev undefined,
* set --dev to tun.
*/
void
init_options_dev(struct options *options)
{
if (!options->dev && options->dev_node)
{
char *dev_node = string_alloc(options->dev_node, NULL); /* POSIX basename() implementations may modify its arguments */
options->dev = basename(dev_node);
}
}
bool
print_openssl_info(const struct options *options)
{
/*
* OpenSSL info print mode?
*/
if (options->show_ciphers || options->show_digests || options->show_engines
|| options->show_tls_ciphers || options->show_curves)
{
if (options->show_ciphers)
{
show_available_ciphers();
}
if (options->show_digests)
{
show_available_digests();
}
if (options->show_engines)
{
show_available_engines();
}
if (options->show_tls_ciphers)
{
show_available_tls_ciphers(options->cipher_list,
options->cipher_list_tls13,
options->tls_cert_profile);
}
if (options->show_curves)
{
show_available_curves();
}
return true;
}
return false;
}
/*
* Static pre-shared key generation mode?
*/
bool
do_genkey(const struct options *options)
{
/* should we disable paging? */
if (options->mlock && (options->genkey))
{
platform_mlockall(true);
}
/*
* We do not want user to use --genkey with --secret. In the transistion
* phase we for secret.
*/
if (options->genkey && options->genkey_type != GENKEY_SECRET
&& options->shared_secret_file)
{
msg(M_USAGE, "Using --genkey type with --secret filename is "
"not supported. Use --genkey type filename instead.");
}
if (options->genkey && options->genkey_type == GENKEY_SECRET)
{
int nbits_written;
const char *genkey_filename = options->genkey_filename;
if (options->shared_secret_file && options->genkey_filename)
{
msg(M_USAGE, "You must provide a filename to either --genkey "
"or --secret, not both");
}
/*
* Copy filename from shared_secret_file to genkey_filename to support
* the old --genkey --secret foo.file syntax.
*/
if (options->shared_secret_file)
{
msg(M_WARN, "WARNING: Using --genkey --secret filename is "
"DEPRECATED. Use --genkey secret filename instead.");
genkey_filename = options->shared_secret_file;
}
nbits_written = write_key_file(2, genkey_filename);
if (nbits_written < 0)
{
msg(M_FATAL, "Failed to write key file");
}
msg(D_GENKEY | M_NOPREFIX,
"Randomly generated %d bit key written to %s", nbits_written,
options->shared_secret_file);
return true;
}
else if (options->genkey && options->genkey_type == GENKEY_TLS_CRYPTV2_SERVER)
{
tls_crypt_v2_write_server_key_file(options->genkey_filename);
return true;
}
else if (options->genkey && options->genkey_type == GENKEY_TLS_CRYPTV2_CLIENT)
{
if (!options->tls_crypt_v2_file)
{
msg(M_USAGE,
"--genkey tls-crypt-v2-client requires a server key to be set via --tls-crypt-v2 to create a client key");
}
tls_crypt_v2_write_client_key_file(options->genkey_filename,
options->genkey_extra_data, options->tls_crypt_v2_file,
options->tls_crypt_v2_file_inline);
return true;
}
else if (options->genkey && options->genkey_type == GENKEY_AUTH_TOKEN)
{
auth_token_write_server_key_file(options->genkey_filename);
return true;
}
else
{
return false;
}
}
/*
* Persistent TUN/TAP device management mode?
*/
bool
do_persist_tuntap(const struct options *options, openvpn_net_ctx_t *ctx)
{
if (options->persist_config)
{
/* sanity check on options for --mktun or --rmtun */
notnull(options->dev, "TUN/TAP device (--dev)");
if (options->ce.remote || options->ifconfig_local
|| options->ifconfig_remote_netmask
|| options->shared_secret_file
|| options->tls_server || options->tls_client
)
{
msg(M_FATAL|M_OPTERR,
"options --mktun or --rmtun should only be used together with --dev");
}
#ifdef ENABLE_FEATURE_TUN_PERSIST
tuncfg(options->dev, options->dev_type, options->dev_node,
options->persist_mode,
options->username, options->groupname, &options->tuntap_options,
ctx);
if (options->persist_mode && options->lladdr)
{
set_lladdr(options->dev, options->lladdr, NULL);
}
return true;
#else /* ifdef ENABLE_FEATURE_TUN_PERSIST */
msg( M_FATAL|M_OPTERR,
"options --mktun and --rmtun are not available on your operating "
"system. Please check 'man tun' (or 'tap'), whether your system "
"supports using 'ifconfig %s create' / 'destroy' to create/remove "
"persistent tunnel interfaces.", options->dev );
#endif
}
return false;
}
/*
* Should we become a daemon?
* Return true if we did it.
*/
bool
possibly_become_daemon(const struct options *options)
{
bool ret = false;
#ifdef ENABLE_SYSTEMD
/* return without forking if we are running from systemd */
if (sd_notify(0, "READY=0") > 0)
{
return ret;
}
#endif
if (options->daemon)
{
ASSERT(!options->inetd);
/* Don't chdir immediately, but the end of the init sequence, if needed */
if (daemon(1, options->log) < 0)
{
msg(M_ERR, "daemon() failed or unsupported");
}
restore_signal_state();
if (options->log)
{
set_std_files_to_null(true);
}
ret = true;
}
return ret;
}
/*
* Actually do UID/GID downgrade, chroot and SELinux context switching, if requested.
*/
static void
do_uid_gid_chroot(struct context *c, bool no_delay)
{
static const char why_not[] = "will be delayed because of --client, --pull, or --up-delay";
struct context_0 *c0 = c->c0;
if (c0 && !c0->uid_gid_chroot_set)
{
/* chroot if requested */
if (c->options.chroot_dir)
{
if (no_delay)
{
platform_chroot(c->options.chroot_dir);
}
else if (c->first_time)
{
msg(M_INFO, "NOTE: chroot %s", why_not);
}
}
/* set user and/or group if we want to setuid/setgid */
if (c0->uid_gid_specified)
{
if (no_delay)
{
platform_group_set(&c0->platform_state_group);
platform_user_set(&c0->platform_state_user);
}
else if (c->first_time)
{
msg(M_INFO, "NOTE: UID/GID downgrade %s", why_not);
}
}
#ifdef ENABLE_MEMSTATS
if (c->first_time && c->options.memstats_fn)
{
mstats_open(c->options.memstats_fn);
}
#endif
#ifdef ENABLE_SELINUX
/* Apply a SELinux context in order to restrict what OpenVPN can do
* to _only_ what it is supposed to do after initialization is complete
* (basically just network I/O operations). Doing it after chroot
* requires /proc to be mounted in the chroot (which is annoying indeed
* but doing it before requires more complex SELinux policies.
*/
if (c->options.selinux_context)
{
if (no_delay)
{
if (-1 == setcon(c->options.selinux_context))
{
msg(M_ERR, "setcon to '%s' failed; is /proc accessible?", c->options.selinux_context);
}
else
{
msg(M_INFO, "setcon to '%s' succeeded", c->options.selinux_context);
}
}
else if (c->first_time)
{
msg(M_INFO, "NOTE: setcon %s", why_not);
}
}
#endif
/* Privileges are going to be dropped by now (if requested), be sure
* to prevent any future privilege dropping attempts from now on.
*/
if (no_delay)
{
c0->uid_gid_chroot_set = true;
}
}
}
/*
* Return common name in a way that is formatted for
* prepending to msg() output.
*/
const char *
format_common_name(struct context *c, struct gc_arena *gc)
{
struct buffer out = alloc_buf_gc(256, gc);
if (c->c2.tls_multi)
{
buf_printf(&out, "[%s] ", tls_common_name(c->c2.tls_multi, false));
}
return BSTR(&out);
}
void
pre_setup(const struct options *options)
{
#ifdef _WIN32
if (options->exit_event_name)
{
win32_signal_open(&win32_signal,
WSO_FORCE_SERVICE,
options->exit_event_name,
options->exit_event_initial_state);
}
else
{
win32_signal_open(&win32_signal,
WSO_FORCE_CONSOLE,
NULL,
false);
/* put a title on the top window bar */
if (win32_signal.mode == WSO_MODE_CONSOLE)
{
window_title_save(&window_title);
window_title_generate(options->config);
}
}
#endif /* ifdef _WIN32 */
}
void
reset_coarse_timers(struct context *c)
{
c->c2.coarse_timer_wakeup = 0;
}
/*
* Initialise the server poll timeout timer
* This timer is used in the http/socks proxy setup so it needs to be setup
* before
*/
static void
do_init_server_poll_timeout(struct context *c)
{
update_time();
if (c->options.ce.connect_timeout)
{
event_timeout_init(&c->c2.server_poll_interval, c->options.ce.connect_timeout, now);
}
}
/*
* Initialize timers
*/
static void
do_init_timers(struct context *c, bool deferred)
{
update_time();
reset_coarse_timers(c);
/* initialize inactivity timeout */
if (c->options.inactivity_timeout)
{
event_timeout_init(&c->c2.inactivity_interval, c->options.inactivity_timeout, now);
}
/* initialize pings */
if (c->options.ping_send_timeout)
{
event_timeout_init(&c->c2.ping_send_interval, c->options.ping_send_timeout, 0);
}
if (c->options.ping_rec_timeout)
{
event_timeout_init(&c->c2.ping_rec_interval, c->options.ping_rec_timeout, now);
}
if (!deferred)
{
/* initialize connection establishment timer */
event_timeout_init(&c->c2.wait_for_connect, 1, now);
/* initialize occ timers */
if (c->options.occ
&& !TLS_MODE(c)
&& c->c2.options_string_local && c->c2.options_string_remote)
{
event_timeout_init(&c->c2.occ_interval, OCC_INTERVAL_SECONDS, now);
}
if (c->options.mtu_test)
{
event_timeout_init(&c->c2.occ_mtu_load_test_interval, OCC_MTU_LOAD_INTERVAL_SECONDS, now);
}
/* initialize packet_id persistence timer */
if (c->options.packet_id_file)
{
event_timeout_init(&c->c2.packet_id_persist_interval, 60, now);
}
/* initialize tmp_int optimization that limits the number of times we call
* tls_multi_process in the main event loop */
interval_init(&c->c2.tmp_int, TLS_MULTI_HORIZON, TLS_MULTI_REFRESH);
}
}
/*
* Initialize traffic shaper.
*/
static void
do_init_traffic_shaper(struct context *c)
{
#ifdef ENABLE_FEATURE_SHAPER
/* initialize traffic shaper (i.e. transmit bandwidth limiter) */
if (c->options.shaper)
{
shaper_init(&c->c2.shaper, c->options.shaper);
shaper_msg(&c->c2.shaper);
}
#endif
}
/*
* Allocate route list structures for IPv4 and IPv6
* (we do this for IPv4 even if no --route option has been seen, as other
* parts of OpenVPN might want to fill the route-list with info, e.g. DHCP)
*/
static void
do_alloc_route_list(struct context *c)
{
if (!c->c1.route_list)
{
ALLOC_OBJ_CLEAR_GC(c->c1.route_list, struct route_list, &c->gc);
}
if (c->options.routes_ipv6 && !c->c1.route_ipv6_list)
{
ALLOC_OBJ_CLEAR_GC(c->c1.route_ipv6_list, struct route_ipv6_list, &c->gc);
}
}
/*
* Initialize the route list, resolving any DNS names in route
* options and saving routes in the environment.
*/
static void
do_init_route_list(const struct options *options,
struct route_list *route_list,
const struct link_socket_info *link_socket_info,
struct env_set *es,
openvpn_net_ctx_t *ctx)
{
const char *gw = NULL;
int dev = dev_type_enum(options->dev, options->dev_type);
int metric = 0;
if (dev == DEV_TYPE_TUN && (options->topology == TOP_NET30 || options->topology == TOP_P2P))
{
gw = options->ifconfig_remote_netmask;
}
if (options->route_default_gateway)
{
gw = options->route_default_gateway;
}
if (options->route_default_metric)
{
metric = options->route_default_metric;
}
if (init_route_list(route_list,
options->routes,
gw,
metric,
link_socket_current_remote(link_socket_info),
es,
ctx))
{
/* copy routes to environment */
setenv_routes(es, route_list);
}
}
static void
do_init_route_ipv6_list(const struct options *options,
struct route_ipv6_list *route_ipv6_list,
const struct link_socket_info *link_socket_info,
struct env_set *es,
openvpn_net_ctx_t *ctx)
{
const char *gw = NULL;
int metric = -1; /* no metric set */
gw = options->ifconfig_ipv6_remote; /* default GW = remote end */
if (options->route_ipv6_default_gateway)
{
gw = options->route_ipv6_default_gateway;
}
if (options->route_default_metric)
{
metric = options->route_default_metric;
}
/* redirect (IPv6) gateway to VPN? if yes, add a few more specifics
*/
if (options->routes_ipv6->flags & RG_REROUTE_GW)
{
char *opt_list[] = { "::/3", "2000::/4", "3000::/4", "fc00::/7", NULL };
int i;
for (i = 0; opt_list[i]; i++)
{
add_route_ipv6_to_option_list( options->routes_ipv6,
string_alloc(opt_list[i], options->routes_ipv6->gc),
NULL, NULL );
}
}
if (init_route_ipv6_list(route_ipv6_list,
options->routes_ipv6,
gw,
metric,
link_socket_current_remote_ipv6(link_socket_info),
es,
ctx))
{
/* copy routes to environment */
setenv_routes_ipv6(es, route_ipv6_list);
}
}
/*
* Called after all initialization has been completed.
*/
void
initialization_sequence_completed(struct context *c, const unsigned int flags)
{
static const char message[] = "Initialization Sequence Completed";
/* Reset the unsuccessful connection counter on complete initialisation */
c->options.unsuccessful_attempts = 0;
/* If we delayed UID/GID downgrade or chroot, do it now */
do_uid_gid_chroot(c, true);
/*
* In some cases (i.e. when receiving auth-token via
* push-reply) the auth-nocache option configured on the
* client is overridden; for this reason we have to wait
* for the push-reply message before attempting to wipe
* the user/pass entered by the user
*/
if (c->options.mode == MODE_POINT_TO_POINT)
{
ssl_clean_user_pass();
}
/* Test if errors */
if (flags & ISC_ERRORS)
{
#ifdef _WIN32
show_routes(M_INFO|M_NOPREFIX);
show_adapters(M_INFO|M_NOPREFIX);
msg(M_INFO, "%s With Errors ( see http://openvpn.net/faq.html#dhcpclientserv )", message);
#else
#ifdef ENABLE_SYSTEMD
sd_notifyf(0, "STATUS=Failed to start up: %s With Errors\nERRNO=1", message);
#endif /* HAVE_SYSTEMD_SD_DAEMON_H */
msg(M_INFO, "%s With Errors", message);
#endif
}
else
{
#ifdef ENABLE_SYSTEMD
sd_notifyf(0, "STATUS=%s", message);
#endif
msg(M_INFO, "%s", message);
}
/* Flag that we initialized */
if ((flags & (ISC_ERRORS|ISC_SERVER)) == 0)
{
c->options.no_advance = true;
}
#ifdef _WIN32
fork_register_dns_action(c->c1.tuntap);
#endif
#ifdef ENABLE_MANAGEMENT
/* Tell management interface that we initialized */
if (management)
{
in_addr_t *tun_local = NULL;
struct in6_addr *tun_local6 = NULL;
struct openvpn_sockaddr local, remote;
struct link_socket_actual *actual;
socklen_t sa_len = sizeof(local);
const char *detail = "SUCCESS";
if (flags & ISC_ERRORS)
{
detail = "ERROR";
}
CLEAR(local);
actual = &get_link_socket_info(c)->lsa->actual;
remote = actual->dest;
getsockname(c->c2.link_socket->sd, &local.addr.sa, &sa_len);
#if ENABLE_IP_PKTINFO
if (!addr_defined(&local))
{
switch (local.addr.sa.sa_family)
{
case AF_INET:
#if defined(HAVE_IN_PKTINFO) && defined(HAVE_IPI_SPEC_DST)
local.addr.in4.sin_addr = actual->pi.in4.ipi_spec_dst;
#else
local.addr.in4.sin_addr = actual->pi.in4;
#endif
break;
case AF_INET6:
local.addr.in6.sin6_addr = actual->pi.in6.ipi6_addr;
break;
}
}
#endif
if (c->c1.tuntap)
{
tun_local = &c->c1.tuntap->local;
tun_local6 = &c->c1.tuntap->local_ipv6;
}
management_set_state(management,
OPENVPN_STATE_CONNECTED,
detail,
tun_local,
tun_local6,
&local,
&remote);
if (tun_local)
{
management_post_tunnel_open(management, *tun_local);
}
}
#endif /* ifdef ENABLE_MANAGEMENT */
}
/*
* Possibly add routes and/or call route-up script
* based on options.
*/
void
do_route(const struct options *options,
struct route_list *route_list,
struct route_ipv6_list *route_ipv6_list,
const struct tuntap *tt,
const struct plugin_list *plugins,
struct env_set *es,
openvpn_net_ctx_t *ctx)
{
if (!options->route_noexec && ( route_list || route_ipv6_list ) )
{
add_routes(route_list, route_ipv6_list, tt, ROUTE_OPTION_FLAGS(options),
es, ctx);
setenv_int(es, "redirect_gateway", route_did_redirect_default_gateway(route_list));
}
#ifdef ENABLE_MANAGEMENT
if (management)
{
management_up_down(management, "UP", es);
}
#endif
if (plugin_defined(plugins, OPENVPN_PLUGIN_ROUTE_UP))
{
if (plugin_call(plugins, OPENVPN_PLUGIN_ROUTE_UP, NULL, NULL, es) != OPENVPN_PLUGIN_FUNC_SUCCESS)
{
msg(M_WARN, "WARNING: route-up plugin call failed");
}
}
if (options->route_script)
{
struct argv argv = argv_new();
setenv_str(es, "script_type", "route-up");
argv_parse_cmd(&argv, options->route_script);
openvpn_run_script(&argv, es, 0, "--route-up");
argv_free(&argv);
}
#ifdef _WIN32
if (options->show_net_up)
{
show_routes(M_INFO|M_NOPREFIX);
show_adapters(M_INFO|M_NOPREFIX);
}
else if (check_debug_level(D_SHOW_NET))
{
show_routes(D_SHOW_NET|M_NOPREFIX);
show_adapters(D_SHOW_NET|M_NOPREFIX);
}
#endif
}
/*
* initialize tun/tap device object
*/
static void
do_init_tun(struct context *c)
{
c->c1.tuntap = init_tun(c->options.dev,
c->options.dev_type,
c->options.topology,
c->options.ifconfig_local,
c->options.ifconfig_remote_netmask,
c->options.ifconfig_ipv6_local,
c->options.ifconfig_ipv6_netbits,
c->options.ifconfig_ipv6_remote,
c->c1.link_socket_addr.bind_local,
c->c1.link_socket_addr.remote_list,
!c->options.ifconfig_nowarn,
c->c2.es,
&c->net_ctx);
#ifdef _WIN32
c->c1.tuntap->windows_driver = c->options.windows_driver;
#endif
init_tun_post(c->c1.tuntap,
&c->c2.frame,
&c->options.tuntap_options);
c->c1.tuntap_owned = true;
}
/*
* Open tun/tap device, ifconfig, call up script, etc.
*/
static bool
do_open_tun(struct context *c)
{
struct gc_arena gc = gc_new();
bool ret = false;
#ifndef TARGET_ANDROID
if (!c->c1.tuntap)
{
#endif
#ifdef TARGET_ANDROID
/* If we emulate persist-tun on android we still have to open a new tun and
* then close the old */
int oldtunfd = -1;
if (c->c1.tuntap)
{
oldtunfd = c->c1.tuntap->fd;
free(c->c1.tuntap);
c->c1.tuntap = NULL;
c->c1.tuntap_owned = false;
}
#endif
/* initialize (but do not open) tun/tap object */
do_init_tun(c);
#ifdef _WIN32
/* store (hide) interactive service handle in tuntap_options */
c->c1.tuntap->options.msg_channel = c->options.msg_channel;
msg(D_ROUTE, "interactive service msg_channel=%" PRIu64, (unsigned long long) c->options.msg_channel);
#endif
/* allocate route list structure */
do_alloc_route_list(c);
/* parse and resolve the route option list */
ASSERT(c->c2.link_socket);
if (c->options.routes && c->c1.route_list)
{
do_init_route_list(&c->options, c->c1.route_list,
&c->c2.link_socket->info, c->c2.es, &c->net_ctx);
}
if (c->options.routes_ipv6 && c->c1.route_ipv6_list)
{
do_init_route_ipv6_list(&c->options, c->c1.route_ipv6_list,
&c->c2.link_socket->info, c->c2.es,
&c->net_ctx);
}
/* do ifconfig */
if (!c->options.ifconfig_noexec
&& ifconfig_order() == IFCONFIG_BEFORE_TUN_OPEN)
{
/* guess actual tun/tap unit number that will be returned
* by open_tun */
const char *guess = guess_tuntap_dev(c->options.dev,
c->options.dev_type,
c->options.dev_node,
&gc);
do_ifconfig(c->c1.tuntap, guess, TUN_MTU_SIZE(&c->c2.frame), c->c2.es,
&c->net_ctx);
}
/* possibly add routes */
if (route_order() == ROUTE_BEFORE_TUN)
{
/* Ignore route_delay, would cause ROUTE_BEFORE_TUN to be ignored */
do_route(&c->options, c->c1.route_list, c->c1.route_ipv6_list,
c->c1.tuntap, c->plugins, c->c2.es, &c->net_ctx);
}
#ifdef TARGET_ANDROID
/* Store the old fd inside the fd so open_tun can use it */
c->c1.tuntap->fd = oldtunfd;
#endif
/* open the tun device */
open_tun(c->options.dev, c->options.dev_type, c->options.dev_node,
c->c1.tuntap);
/* set the hardware address */
if (c->options.lladdr)
{
set_lladdr(c->c1.tuntap->actual_name, c->options.lladdr, c->c2.es);
}
/* do ifconfig */
if (!c->options.ifconfig_noexec
&& ifconfig_order() == IFCONFIG_AFTER_TUN_OPEN)
{
do_ifconfig(c->c1.tuntap, c->c1.tuntap->actual_name,
TUN_MTU_SIZE(&c->c2.frame), c->c2.es, &c->net_ctx);
}
/* run the up script */
run_up_down(c->options.up_script,
c->plugins,
OPENVPN_PLUGIN_UP,
c->c1.tuntap->actual_name,
#ifdef _WIN32
c->c1.tuntap->adapter_index,
#endif
dev_type_string(c->options.dev, c->options.dev_type),
TUN_MTU_SIZE(&c->c2.frame),
EXPANDED_SIZE(&c->c2.frame),
print_in_addr_t(c->c1.tuntap->local, IA_EMPTY_IF_UNDEF, &gc),
print_in_addr_t(c->c1.tuntap->remote_netmask, IA_EMPTY_IF_UNDEF, &gc),
"init",
NULL,
"up",
c->c2.es);
#if defined(_WIN32)
if (c->options.block_outside_dns)
{
dmsg(D_LOW, "Blocking outside DNS");
if (!win_wfp_block_dns(c->c1.tuntap->adapter_index, c->options.msg_channel))
{
msg(M_FATAL, "Blocking DNS failed!");
}
}
#endif
/* possibly add routes */
if ((route_order() == ROUTE_AFTER_TUN) && (!c->options.route_delay_defined))
{
do_route(&c->options, c->c1.route_list, c->c1.route_ipv6_list,
c->c1.tuntap, c->plugins, c->c2.es, &c->net_ctx);
}
/*
* Did tun/tap driver give us an MTU?
*/
if (c->c1.tuntap->post_open_mtu)
{
frame_set_mtu_dynamic(&c->c2.frame,
c->c1.tuntap->post_open_mtu,
SET_MTU_TUN | SET_MTU_UPPER_BOUND);
}
ret = true;
static_context = c;
#ifndef TARGET_ANDROID
}
else
{
msg(M_INFO, "Preserving previous TUN/TAP instance: %s",
c->c1.tuntap->actual_name);
/* explicitly set the ifconfig_* env vars */
do_ifconfig_setenv(c->c1.tuntap, c->c2.es);
/* run the up script if user specified --up-restart */
if (c->options.up_restart)
{
run_up_down(c->options.up_script,
c->plugins,
OPENVPN_PLUGIN_UP,
c->c1.tuntap->actual_name,
#ifdef _WIN32
c->c1.tuntap->adapter_index,
#endif
dev_type_string(c->options.dev, c->options.dev_type),
TUN_MTU_SIZE(&c->c2.frame),
EXPANDED_SIZE(&c->c2.frame),
print_in_addr_t(c->c1.tuntap->local, IA_EMPTY_IF_UNDEF, &gc),
print_in_addr_t(c->c1.tuntap->remote_netmask, IA_EMPTY_IF_UNDEF, &gc),
"restart",
NULL,
"up",
c->c2.es);
}
#if defined(_WIN32)
if (c->options.block_outside_dns)
{
dmsg(D_LOW, "Blocking outside DNS");
if (!win_wfp_block_dns(c->c1.tuntap->adapter_index, c->options.msg_channel))
{
msg(M_FATAL, "Blocking DNS failed!");
}
}
#endif
}
#endif /* ifndef TARGET_ANDROID */
gc_free(&gc);
return ret;
}
/*
* Close TUN/TAP device
*/
static void
do_close_tun_simple(struct context *c)
{
msg(D_CLOSE, "Closing TUN/TAP interface");
if (c->c1.tuntap)
{
close_tun(c->c1.tuntap, &c->net_ctx);
c->c1.tuntap = NULL;
}
c->c1.tuntap_owned = false;
#if P2MP
CLEAR(c->c1.pulled_options_digest_save);
#endif
}
static void
do_close_tun(struct context *c, bool force)
{
struct gc_arena gc = gc_new();
if (c->c1.tuntap && c->c1.tuntap_owned)
{
const char *tuntap_actual = string_alloc(c->c1.tuntap->actual_name, &gc);
#ifdef _WIN32
DWORD adapter_index = c->c1.tuntap->adapter_index;
#endif
const in_addr_t local = c->c1.tuntap->local;
const in_addr_t remote_netmask = c->c1.tuntap->remote_netmask;
if (force || !(c->sig->signal_received == SIGUSR1 && c->options.persist_tun))
{
static_context = NULL;
#ifdef ENABLE_MANAGEMENT
/* tell management layer we are about to close the TUN/TAP device */
if (management)
{
management_pre_tunnel_close(management);
management_up_down(management, "DOWN", c->c2.es);
}
#endif
/* delete any routes we added */
if (c->c1.route_list || c->c1.route_ipv6_list)
{
run_up_down(c->options.route_predown_script,
c->plugins,
OPENVPN_PLUGIN_ROUTE_PREDOWN,
tuntap_actual,
#ifdef _WIN32
adapter_index,
#endif
NULL,
TUN_MTU_SIZE(&c->c2.frame),
EXPANDED_SIZE(&c->c2.frame),
print_in_addr_t(local, IA_EMPTY_IF_UNDEF, &gc),
print_in_addr_t(remote_netmask, IA_EMPTY_IF_UNDEF, &gc),
"init",
signal_description(c->sig->signal_received,
c->sig->signal_text),
"route-pre-down",
c->c2.es);
delete_routes(c->c1.route_list, c->c1.route_ipv6_list,
c->c1.tuntap, ROUTE_OPTION_FLAGS(&c->options),
c->c2.es, &c->net_ctx);
}
/* actually close tun/tap device based on --down-pre flag */
if (!c->options.down_pre)
{
do_close_tun_simple(c);
}
/* Run the down script -- note that it will run at reduced
* privilege if, for example, "--user nobody" was used. */
run_up_down(c->options.down_script,
c->plugins,
OPENVPN_PLUGIN_DOWN,
tuntap_actual,
#ifdef _WIN32
adapter_index,
#endif
NULL,
TUN_MTU_SIZE(&c->c2.frame),
EXPANDED_SIZE(&c->c2.frame),
print_in_addr_t(local, IA_EMPTY_IF_UNDEF, &gc),
print_in_addr_t(remote_netmask, IA_EMPTY_IF_UNDEF, &gc),
"init",
signal_description(c->sig->signal_received,
c->sig->signal_text),
"down",
c->c2.es);
#if defined(_WIN32)
if (c->options.block_outside_dns)
{
if (!win_wfp_uninit(adapter_index, c->options.msg_channel))
{
msg(M_FATAL, "Uninitialising WFP failed!");
}
}
#endif
/* actually close tun/tap device based on --down-pre flag */
if (c->options.down_pre)
{
do_close_tun_simple(c);
}
}
else
{
/* run the down script on this restart if --up-restart was specified */
if (c->options.up_restart)
{
run_up_down(c->options.down_script,
c->plugins,
OPENVPN_PLUGIN_DOWN,
tuntap_actual,
#ifdef _WIN32
adapter_index,
#endif
NULL,
TUN_MTU_SIZE(&c->c2.frame),
EXPANDED_SIZE(&c->c2.frame),
print_in_addr_t(local, IA_EMPTY_IF_UNDEF, &gc),
print_in_addr_t(remote_netmask, IA_EMPTY_IF_UNDEF, &gc),
"restart",
signal_description(c->sig->signal_received,
c->sig->signal_text),
"down",
c->c2.es);
}
#if defined(_WIN32)
if (c->options.block_outside_dns)
{
if (!win_wfp_uninit(adapter_index, c->options.msg_channel))
{
msg(M_FATAL, "Uninitialising WFP failed!");
}
}
#endif
}
}
gc_free(&gc);
}
void
tun_abort(void)
{
struct context *c = static_context;
if (c)
{
static_context = NULL;
do_close_tun(c, true);
}
}
/*
* Handle delayed tun/tap interface bringup due to --up-delay or --pull
*/
#if P2MP
/**
* Helper for do_up(). Take two option hashes and return true if they are not
* equal, or either one is all-zeroes.
*/
static bool
options_hash_changed_or_zero(const struct sha256_digest *a,
const struct sha256_digest *b)
{
const struct sha256_digest zero = {{0}};
return memcmp(a, b, sizeof(struct sha256_digest))
|| !memcmp(a, &zero, sizeof(struct sha256_digest));
}
#endif /* P2MP */
bool
do_up(struct context *c, bool pulled_options, unsigned int option_types_found)
{
if (!c->c2.do_up_ran)
{
reset_coarse_timers(c);
if (pulled_options)
{
if (!do_deferred_options(c, option_types_found))
{
msg(D_PUSH_ERRORS, "ERROR: Failed to apply push options");
return false;
}
}
/* if --up-delay specified, open tun, do ifconfig, and run up script now */
if (c->options.up_delay || PULL_DEFINED(&c->options))
{
c->c2.did_open_tun = do_open_tun(c);
update_time();
#if P2MP
/*
* Was tun interface object persisted from previous restart iteration,
* and if so did pulled options string change from previous iteration?
*/
if (!c->c2.did_open_tun
&& PULL_DEFINED(&c->options)
&& c->c1.tuntap
&& options_hash_changed_or_zero(&c->c1.pulled_options_digest_save,
&c->c2.pulled_options_digest))
{
/* if so, close tun, delete routes, then reinitialize tun and add routes */
msg(M_INFO, "NOTE: Pulled options changed on restart, will need to close and reopen TUN/TAP device.");
do_close_tun(c, true);
management_sleep(1);
c->c2.did_open_tun = do_open_tun(c);
update_time();
}
#endif
}
if (c->c2.did_open_tun)
{
#if P2MP
c->c1.pulled_options_digest_save = c->c2.pulled_options_digest;
#endif
/* if --route-delay was specified, start timer */
if ((route_order() == ROUTE_AFTER_TUN) && c->options.route_delay_defined)
{
event_timeout_init(&c->c2.route_wakeup, c->options.route_delay, now);
event_timeout_init(&c->c2.route_wakeup_expire, c->options.route_delay + c->options.route_delay_window, now);
if (c->c1.tuntap)
{
tun_standby_init(c->c1.tuntap);
}
}
else
{
initialization_sequence_completed(c, 0); /* client/p2p --route-delay undefined */
}
}
else if (c->options.mode == MODE_POINT_TO_POINT)
{
initialization_sequence_completed(c, 0); /* client/p2p restart with --persist-tun */
}
c->c2.do_up_ran = true;
}
return true;
}
/*
* These are the option categories which will be accepted by pull.
*/
unsigned int
pull_permission_mask(const struct context *c)
{
unsigned int flags =
OPT_P_UP
| OPT_P_ROUTE_EXTRAS
| OPT_P_SOCKBUF
| OPT_P_SOCKFLAGS
| OPT_P_SETENV
| OPT_P_SHAPER
| OPT_P_TIMER
| OPT_P_COMP
| OPT_P_PERSIST
| OPT_P_MESSAGES
| OPT_P_EXPLICIT_NOTIFY
| OPT_P_ECHO
| OPT_P_PULL_MODE
| OPT_P_PEER_ID;
if (!c->options.route_nopull)
{
flags |= (OPT_P_ROUTE | OPT_P_IPWIN32);
}
if (c->options.ncp_enabled)
{
flags |= OPT_P_NCP;
}
return flags;
}
/*
* Handle non-tun-related pulled options.
*/
bool
do_deferred_options(struct context *c, const unsigned int found)
{
if (found & OPT_P_MESSAGES)
{
init_verb_mute(c, IVM_LEVEL_1|IVM_LEVEL_2);
msg(D_PUSH, "OPTIONS IMPORT: --verb and/or --mute level changed");
}
if (found & OPT_P_TIMER)
{
do_init_timers(c, true);
msg(D_PUSH, "OPTIONS IMPORT: timers and/or timeouts modified");
}
if (found & OPT_P_EXPLICIT_NOTIFY)
{
if (!proto_is_udp(c->options.ce.proto) && c->options.ce.explicit_exit_notification)
{
msg(D_PUSH, "OPTIONS IMPORT: --explicit-exit-notify can only be used with --proto udp");
c->options.ce.explicit_exit_notification = 0;
}
else
{
msg(D_PUSH, "OPTIONS IMPORT: explicit notify parm(s) modified");
}
}
#ifdef USE_COMP
if (found & OPT_P_COMP)
{
msg(D_PUSH, "OPTIONS IMPORT: compression parms modified");
comp_uninit(c->c2.comp_context);
c->c2.comp_context = comp_init(&c->options.comp);
}
#endif
if (found & OPT_P_SHAPER)
{
msg(D_PUSH, "OPTIONS IMPORT: traffic shaper enabled");
do_init_traffic_shaper(c);
}
if (found & OPT_P_SOCKBUF)
{
msg(D_PUSH, "OPTIONS IMPORT: --sndbuf/--rcvbuf options modified");
link_socket_update_buffer_sizes(c->c2.link_socket, c->options.rcvbuf, c->options.sndbuf);
}
if (found & OPT_P_SOCKFLAGS)
{
msg(D_PUSH, "OPTIONS IMPORT: --socket-flags option modified");
link_socket_update_flags(c->c2.link_socket, c->options.sockflags);
}
if (found & OPT_P_PERSIST)
{
msg(D_PUSH, "OPTIONS IMPORT: --persist options modified");
}
if (found & OPT_P_UP)
{
msg(D_PUSH, "OPTIONS IMPORT: --ifconfig/up options modified");
}
if (found & OPT_P_ROUTE)
{
msg(D_PUSH, "OPTIONS IMPORT: route options modified");
}
if (found & OPT_P_ROUTE_EXTRAS)
{
msg(D_PUSH, "OPTIONS IMPORT: route-related options modified");
}
if (found & OPT_P_IPWIN32)
{
msg(D_PUSH, "OPTIONS IMPORT: --ip-win32 and/or --dhcp-option options modified");
}
if (found & OPT_P_SETENV)
{
msg(D_PUSH, "OPTIONS IMPORT: environment modified");
}
if (found & OPT_P_PEER_ID)
{
msg(D_PUSH, "OPTIONS IMPORT: peer-id set");
c->c2.tls_multi->use_peer_id = true;
c->c2.tls_multi->peer_id = c->options.peer_id;
frame_add_to_extra_frame(&c->c2.frame, +3); /* peer-id overhead */
if (!c->options.ce.link_mtu_defined)
{
frame_add_to_link_mtu(&c->c2.frame, +3);
msg(D_PUSH, "OPTIONS IMPORT: adjusting link_mtu to %d",
EXPANDED_SIZE(&c->c2.frame));
}
else
{
msg(M_WARN, "OPTIONS IMPORT: WARNING: peer-id set, but link-mtu"
" fixed by config - reducing tun-mtu to %d, expect"
" MTU problems", TUN_MTU_SIZE(&c->c2.frame) );
}
}
/* process (potentially pushed) crypto options */
if (c->options.pull)
{
if (!check_pull_client_ncp(c, found))
{
return false;
}
struct frame *frame_fragment = NULL;
#ifdef ENABLE_FRAGMENT
if (c->options.ce.fragment)
{
frame_fragment = &c->c2.frame_fragment;
}
#endif
struct tls_session *session = &c->c2.tls_multi->session[TM_ACTIVE];
if (!tls_session_update_crypto_params(session, &c->options, &c->c2.frame,
frame_fragment))
{
msg(D_TLS_ERRORS, "OPTIONS ERROR: failed to import crypto options");
return false;
}
}
return true;
}
/*
* Possible hold on initialization, holdtime is the
* time OpenVPN would wait without management
*/
static bool
do_hold(int holdtime)
{
#ifdef ENABLE_MANAGEMENT
if (management)
{
/* block until management hold is released */
if (management_hold(management, holdtime))
{
return true;
}
}
#endif
return false;
}
/*
* Sleep before restart.
*/
static void
socket_restart_pause(struct context *c)
{
int sec = 2;
int backoff = 0;
switch (c->options.ce.proto)
{
case PROTO_TCP_SERVER:
sec = 1;
break;
case PROTO_UDP:
case PROTO_TCP_CLIENT:
sec = c->options.ce.connect_retry_seconds;
break;
}
#ifdef ENABLE_DEBUG
if (GREMLIN_CONNECTION_FLOOD_LEVEL(c->options.gremlin))
{
sec = 0;
}
#endif
#if P2MP
if (auth_retry_get() == AR_NOINTERACT)
{
sec = 10;
}
#endif
/* Slow down reconnection after 5 retries per remote -- for tcp only in client mode */
if (c->options.ce.proto != PROTO_TCP_SERVER)
{
backoff = (c->options.unsuccessful_attempts / c->options.connection_list->len) - 4;
if (backoff > 0)
{
/* sec is less than 2^16; we can left shift it by up to 15 bits without overflow */
sec = max_int(sec, 1) << min_int(backoff, 15);
}
if (sec > c->options.ce.connect_retry_seconds_max)
{
sec = c->options.ce.connect_retry_seconds_max;
}
}
if (c->persist.restart_sleep_seconds > 0 && c->persist.restart_sleep_seconds > sec)
{
sec = c->persist.restart_sleep_seconds;
}
else if (c->persist.restart_sleep_seconds == -1)
{
sec = 0;
}
c->persist.restart_sleep_seconds = 0;
/* do management hold on context restart, i.e. second, third, fourth, etc. initialization */
if (do_hold(sec))
{
sec = 0;
}
if (sec)
{
msg(D_RESTART, "Restart pause, %d second(s)", sec);
management_sleep(sec);
}
}
/*
* Do a possible pause on context_2 initialization.
*/
static void
do_startup_pause(struct context *c)
{
if (!c->first_time)
{
socket_restart_pause(c);
}
else
{
do_hold(0); /* do management hold on first context initialization */
}
}
/*
* Finalize MTU parameters based on command line or config file options.
*/
static void
frame_finalize_options(struct context *c, const struct options *o)
{
if (!o)
{
o = &c->options;
}
/*
* Set adjustment factor for buffer alignment when no
* cipher is used.
*/
if (!CIPHER_ENABLED(c))
{
frame_align_to_extra_frame(&c->c2.frame);
frame_or_align_flags(&c->c2.frame,
FRAME_HEADROOM_MARKER_FRAGMENT
|FRAME_HEADROOM_MARKER_READ_LINK
|FRAME_HEADROOM_MARKER_READ_STREAM);
}
frame_add_to_extra_buffer(&c->c2.frame, PAYLOAD_ALIGN);
frame_finalize(&c->c2.frame,
o->ce.link_mtu_defined,
o->ce.link_mtu,
o->ce.tun_mtu_defined,
o->ce.tun_mtu);
}
/*
* Free a key schedule, including OpenSSL components.
*/
static void
key_schedule_free(struct key_schedule *ks, bool free_ssl_ctx)
{
free_key_ctx_bi(&ks->static_key);
if (tls_ctx_initialised(&ks->ssl_ctx) && free_ssl_ctx)
{
tls_ctx_free(&ks->ssl_ctx);
}
CLEAR(*ks);
}
static void
init_crypto_pre(struct context *c, const unsigned int flags)
{
if (c->options.engine)
{
crypto_init_lib_engine(c->options.engine);
}
if (flags & CF_LOAD_PERSISTED_PACKET_ID)
{
/* load a persisted packet-id for cross-session replay-protection */
if (c->options.packet_id_file)
{
packet_id_persist_load(&c->c1.pid_persist, c->options.packet_id_file);
}
}
#ifdef ENABLE_PREDICTION_RESISTANCE
if (c->options.use_prediction_resistance)
{
rand_ctx_enable_prediction_resistance();
}
#endif
}
/*
* Static Key Mode (using a pre-shared key)
*/
static void
do_init_crypto_static(struct context *c, const unsigned int flags)
{
const struct options *options = &c->options;
ASSERT(options->shared_secret_file);
init_crypto_pre(c, flags);
/* Initialize flags */
if (c->options.mute_replay_warnings)
{
c->c2.crypto_options.flags |= CO_MUTE_REPLAY_WARNINGS;
}
/* Initialize packet ID tracking */
if (options->replay)
{
packet_id_init(&c->c2.crypto_options.packet_id,
options->replay_window,
options->replay_time,
"STATIC", 0);
c->c2.crypto_options.pid_persist = &c->c1.pid_persist;
c->c2.crypto_options.flags |= CO_PACKET_ID_LONG_FORM;
packet_id_persist_load_obj(&c->c1.pid_persist,
&c->c2.crypto_options.packet_id);
}
if (!key_ctx_bi_defined(&c->c1.ks.static_key))
{
/* Get cipher & hash algorithms */
init_key_type(&c->c1.ks.key_type, options->ciphername, options->authname,
options->keysize, options->test_crypto, true);
/* Read cipher and hmac keys from shared secret file */
crypto_read_openvpn_key(&c->c1.ks.key_type, &c->c1.ks.static_key,
options->shared_secret_file,
options->shared_secret_file_inline,
options->key_direction, "Static Key Encryption",
"secret");
}
else
{
msg(M_INFO, "Re-using pre-shared static key");
}
/* Get key schedule */
c->c2.crypto_options.key_ctx_bi = c->c1.ks.static_key;
/* Compute MTU parameters */
crypto_adjust_frame_parameters(&c->c2.frame, &c->c1.ks.key_type,
options->replay, true);
/* Sanity check on sequence number, and cipher mode options */
check_replay_consistency(&c->c1.ks.key_type, options->replay);
}
/*
* Initialize the tls-auth/crypt key context
*/
static void
do_init_tls_wrap_key(struct context *c)
{
const struct options *options = &c->options;
/* TLS handshake authentication (--tls-auth) */
if (options->ce.tls_auth_file)
{
/* Initialize key_type for tls-auth with auth only */
CLEAR(c->c1.ks.tls_auth_key_type);
if (!streq(options->authname, "none"))
{
c->c1.ks.tls_auth_key_type.digest = md_kt_get(options->authname);
c->c1.ks.tls_auth_key_type.hmac_length =
md_kt_size(c->c1.ks.tls_auth_key_type.digest);
}
else
{
msg(M_FATAL, "ERROR: tls-auth enabled, but no valid --auth "
"algorithm specified ('%s')", options->authname);
}
crypto_read_openvpn_key(&c->c1.ks.tls_auth_key_type,
&c->c1.ks.tls_wrap_key,
options->ce.tls_auth_file,
options->ce.tls_auth_file_inline,
options->ce.key_direction,
"Control Channel Authentication", "tls-auth");
}
/* TLS handshake encryption+authentication (--tls-crypt) */
if (options->ce.tls_crypt_file)
{
tls_crypt_init_key(&c->c1.ks.tls_wrap_key,
options->ce.tls_crypt_file,
options->ce.tls_crypt_file_inline,
options->tls_server);
}
/* tls-crypt with client-specific keys (--tls-crypt-v2) */
if (options->ce.tls_crypt_v2_file)
{
if (options->tls_server)
{
tls_crypt_v2_init_server_key(&c->c1.ks.tls_crypt_v2_server_key,
true, options->ce.tls_crypt_v2_file,
options->ce.tls_crypt_v2_file_inline);
}
else
{
tls_crypt_v2_init_client_key(&c->c1.ks.tls_wrap_key,
&c->c1.ks.tls_crypt_v2_wkc,
options->ce.tls_crypt_v2_file,
options->ce.tls_crypt_v2_file_inline);
}
}
}
/*
* Initialise the auth-token key context
*/
static void
do_init_auth_token_key(struct context *c)
{
if (!c->options.auth_token_generate)
{
return;
}
auth_token_init_secret(&c->c1.ks.auth_token_key,
c->options.auth_token_secret_file,
c->options.auth_token_secret_file_inline);
}
/*
* Initialize the persistent component of OpenVPN's TLS mode,
* which is preserved across SIGUSR1 resets.
*/
static void
do_init_crypto_tls_c1(struct context *c)
{
const struct options *options = &c->options;
if (!tls_ctx_initialised(&c->c1.ks.ssl_ctx))
{
/*
* Initialize the OpenSSL library's global
* SSL context.
*/
init_ssl(options, &(c->c1.ks.ssl_ctx), c->c0 && c->c0->uid_gid_chroot_set);
if (!tls_ctx_initialised(&c->c1.ks.ssl_ctx))
{
#if P2MP
switch (auth_retry_get())
{
case AR_NONE:
msg(M_FATAL, "Error: private key password verification failed");
break;
case AR_INTERACT:
ssl_purge_auth(false);
case AR_NOINTERACT:
c->sig->signal_received = SIGUSR1; /* SOFT-SIGUSR1 -- Password failure error */
break;
default:
ASSERT(0);
}
c->sig->signal_text = "private-key-password-failure";
return;
#else /* if P2MP */
msg(M_FATAL, "Error: private key password verification failed");
#endif /* if P2MP */
}
/* Do not warn if we only have BF-CBC in options->ciphername
* because it is still the default cipher */
bool warn = !streq(options->ciphername, "BF-CBC")
|| options->enable_ncp_fallback;
/* Get cipher & hash algorithms */
init_key_type(&c->c1.ks.key_type, options->ciphername, options->authname,
options->keysize, true, warn);
/* Initialize PRNG with config-specified digest */
prng_init(options->prng_hash, options->prng_nonce_secret_len);
/* initialize tls-auth/crypt/crypt-v2 key */
do_init_tls_wrap_key(c);
/* initialise auth-token crypto support */
do_init_auth_token_key(c);
#if 0 /* was: #if ENABLE_INLINE_FILES -- Note that enabling this code will break restarts */
if (options->priv_key_file_inline)
{
string_clear(c->options.priv_key_file_inline);
c->options.priv_key_file_inline = NULL;
}
#endif
}
else
{
msg(D_INIT_MEDIUM, "Re-using SSL/TLS context");
/*
* tls-auth/crypt key can be configured per connection block, therefore
* we must reload it as it may have changed
*/
do_init_tls_wrap_key(c);
}
}
static void
do_init_crypto_tls(struct context *c, const unsigned int flags)
{
const struct options *options = &c->options;
struct tls_options to;
bool packet_id_long_form;
ASSERT(options->tls_server || options->tls_client);
ASSERT(!options->test_crypto);
init_crypto_pre(c, flags);
/* Make sure we are either a TLS client or server but not both */
ASSERT(options->tls_server == !options->tls_client);
/* initialize persistent component */
do_init_crypto_tls_c1(c);
if (IS_SIG(c))
{
return;
}
/* Sanity check on sequence number, and cipher mode options */
check_replay_consistency(&c->c1.ks.key_type, options->replay);
/* In short form, unique datagram identifier is 32 bits, in long form 64 bits */
packet_id_long_form = cipher_kt_mode_ofb_cfb(c->c1.ks.key_type.cipher);
/* Compute MTU parameters (postpone if we push/pull options) */
if (c->options.pull || c->options.mode == MODE_SERVER)
{
/* Account for worst-case crypto overhead before allocating buffers */
frame_add_to_extra_frame(&c->c2.frame, crypto_max_overhead());
}
else
{
crypto_adjust_frame_parameters(&c->c2.frame, &c->c1.ks.key_type,
options->replay, packet_id_long_form);
}
tls_adjust_frame_parameters(&c->c2.frame);
/* Set all command-line TLS-related options */
CLEAR(to);
if (options->mute_replay_warnings)
{
to.crypto_flags |= CO_MUTE_REPLAY_WARNINGS;
}
to.crypto_flags &= ~(CO_PACKET_ID_LONG_FORM);
if (packet_id_long_form)
{
to.crypto_flags |= CO_PACKET_ID_LONG_FORM;
}
to.ssl_ctx = c->c1.ks.ssl_ctx;
to.key_type = c->c1.ks.key_type;
to.server = options->tls_server;
to.replay = options->replay;
to.replay_window = options->replay_window;
to.replay_time = options->replay_time;
to.tcp_mode = link_socket_proto_connection_oriented(options->ce.proto);
to.config_ciphername = c->c1.ciphername;
to.config_ncp_ciphers = options->ncp_ciphers;
to.ncp_enabled = options->ncp_enabled;
to.transition_window = options->transition_window;
to.handshake_window = options->handshake_window;
to.packet_timeout = options->tls_timeout;
to.renegotiate_bytes = options->renegotiate_bytes;
to.renegotiate_packets = options->renegotiate_packets;
if (options->renegotiate_seconds_min < 0)
{
/* Add 10% jitter to reneg-sec by default (server side only) */
int auto_jitter = options->mode != MODE_SERVER ? 0 :
get_random() % max_int(options->renegotiate_seconds / 10, 1);
to.renegotiate_seconds = options->renegotiate_seconds - auto_jitter;
}
else
{
/* Add user-specified jitter to reneg-sec */
to.renegotiate_seconds = options->renegotiate_seconds
-(get_random() % max_int(options->renegotiate_seconds
- options->renegotiate_seconds_min, 1));
}
to.single_session = options->single_session;
to.mode = options->mode;
to.pull = options->pull;
if (options->push_peer_info) /* all there is */
{
to.push_peer_info_detail = 2;
}
else if (options->pull) /* pull clients send some details */
{
to.push_peer_info_detail = 1;
}
else /* default: no peer-info at all */
{
to.push_peer_info_detail = 0;
}
/* should we not xmit any packets until we get an initial
* response from client? */
if (to.server && options->ce.proto == PROTO_TCP_SERVER)
{
to.xmit_hold = true;
}
to.disable_occ = !options->occ;
to.verify_command = options->tls_verify;
to.verify_export_cert = options->tls_export_cert;
to.verify_x509_type = (options->verify_x509_type & 0xff);
to.verify_x509_name = options->verify_x509_name;
to.crl_file = options->crl_file;
to.crl_file_inline = options->crl_file_inline;
to.ssl_flags = options->ssl_flags;
to.ns_cert_type = options->ns_cert_type;
memmove(to.remote_cert_ku, options->remote_cert_ku, sizeof(to.remote_cert_ku));
to.remote_cert_eku = options->remote_cert_eku;
to.verify_hash = options->verify_hash;
to.verify_hash_algo = options->verify_hash_algo;
#ifdef ENABLE_X509ALTUSERNAME
to.x509_username_field = (char *) options->x509_username_field;
#else
to.x509_username_field = X509_USERNAME_FIELD_DEFAULT;
#endif
to.es = c->c2.es;
to.net_ctx = &c->net_ctx;
#ifdef ENABLE_DEBUG
to.gremlin = c->options.gremlin;
#endif
to.plugins = c->plugins;
#ifdef MANAGEMENT_DEF_AUTH
to.mda_context = &c->c2.mda_context;
#endif
to.auth_user_pass_verify_script = options->auth_user_pass_verify_script;
to.auth_user_pass_verify_script_via_file = options->auth_user_pass_verify_script_via_file;
to.tmp_dir = options->tmp_dir;
if (options->ccd_exclusive)
{
to.client_config_dir_exclusive = options->client_config_dir;
}
to.auth_user_pass_file = options->auth_user_pass_file;
to.auth_token_generate = options->auth_token_generate;
to.auth_token_lifetime = options->auth_token_lifetime;
to.auth_token_call_auth = options->auth_token_call_auth;
to.auth_token_key = c->c1.ks.auth_token_key;
to.x509_track = options->x509_track;
#if P2MP
#ifdef ENABLE_MANAGEMENT
to.sci = &options->sc_info;
#endif
#endif
#ifdef USE_COMP
to.comp_options = options->comp;
#endif
#ifdef HAVE_EXPORT_KEYING_MATERIAL
if (options->keying_material_exporter_label)
{
to.ekm_size = options->keying_material_exporter_length;
if (to.ekm_size < 16 || to.ekm_size > 4095)
{
to.ekm_size = 0;
}
to.ekm_label = options->keying_material_exporter_label;
to.ekm_label_size = strlen(to.ekm_label);
}
else
{
to.ekm_size = 0;
}
#endif /* HAVE_EXPORT_KEYING_MATERIAL */
/* TLS handshake authentication (--tls-auth) */
if (options->ce.tls_auth_file)
{
to.tls_wrap.mode = TLS_WRAP_AUTH;
to.tls_wrap.opt.key_ctx_bi = c->c1.ks.tls_wrap_key;
to.tls_wrap.opt.pid_persist = &c->c1.pid_persist;
to.tls_wrap.opt.flags |= CO_PACKET_ID_LONG_FORM;
crypto_adjust_frame_parameters(&to.frame, &c->c1.ks.tls_auth_key_type,
true, true);
}
/* TLS handshake encryption (--tls-crypt) */
if (options->ce.tls_crypt_file
|| (options->ce.tls_crypt_v2_file && options->tls_client))
{
to.tls_wrap.mode = TLS_WRAP_CRYPT;
to.tls_wrap.opt.key_ctx_bi = c->c1.ks.tls_wrap_key;
to.tls_wrap.opt.pid_persist = &c->c1.pid_persist;
to.tls_wrap.opt.flags |= CO_PACKET_ID_LONG_FORM;
tls_crypt_adjust_frame_parameters(&to.frame);
if (options->ce.tls_crypt_v2_file)
{
to.tls_wrap.tls_crypt_v2_wkc = &c->c1.ks.tls_crypt_v2_wkc;
}
}
if (options->ce.tls_crypt_v2_file)
{
to.tls_crypt_v2 = true;
if (options->tls_server)
{
to.tls_wrap.tls_crypt_v2_server_key = c->c1.ks.tls_crypt_v2_server_key;
to.tls_crypt_v2_verify_script = c->options.tls_crypt_v2_verify_script;
}
}
/* If we are running over TCP, allow for
* length prefix */
socket_adjust_frame_parameters(&to.frame, options->ce.proto);
/*
* Initialize OpenVPN's master TLS-mode object.
*/
if (flags & CF_INIT_TLS_MULTI)
{
c->c2.tls_multi = tls_multi_init(&to);
}
if (flags & CF_INIT_TLS_AUTH_STANDALONE)
{
c->c2.tls_auth_standalone = tls_auth_standalone_init(&to, &c->c2.gc);
}
}
static void
do_init_finalize_tls_frame(struct context *c)
{
if (c->c2.tls_multi)
{
tls_multi_init_finalize(c->c2.tls_multi, &c->c2.frame);
ASSERT(EXPANDED_SIZE(&c->c2.tls_multi->opt.frame) <=
EXPANDED_SIZE(&c->c2.frame));
frame_print(&c->c2.tls_multi->opt.frame, D_MTU_INFO,
"Control Channel MTU parms");
}
if (c->c2.tls_auth_standalone)
{
tls_auth_standalone_finalize(c->c2.tls_auth_standalone, &c->c2.frame);
frame_print(&c->c2.tls_auth_standalone->frame, D_MTU_INFO,
"TLS-Auth MTU parms");
}
}
/*
* No encryption or authentication.
*/
static void
do_init_crypto_none(const struct context *c)
{
ASSERT(!c->options.test_crypto);
msg(M_WARN,
"******* WARNING *******: All encryption and authentication features "
"disabled -- All data will be tunnelled as clear text and will not be "
"protected against man-in-the-middle changes. "
"PLEASE DO RECONSIDER THIS CONFIGURATION!");
}
static void
do_init_crypto(struct context *c, const unsigned int flags)
{
if (c->options.shared_secret_file)
{
do_init_crypto_static(c, flags);
}
else if (c->options.tls_server || c->options.tls_client)
{
do_init_crypto_tls(c, flags);
}
else /* no encryption or authentication. */
{
do_init_crypto_none(c);
}
}
static void
do_init_frame(struct context *c)
{
#ifdef USE_COMP
/*
* modify frame parameters if compression is enabled
*/
if (comp_enabled(&c->options.comp))
{
comp_add_to_extra_frame(&c->c2.frame);
#if !defined(ENABLE_LZ4)
/*
* Compression usage affects buffer alignment when non-swapped algs
* such as LZO is used.
* Newer algs like LZ4 and comp-stub with COMP_F_SWAP don't need
* any special alignment because of the control-byte swap approach.
* LZO alignment (on the other hand) is problematic because
* the presence of the control byte means that either the output of
* decryption must be written to an unaligned buffer, or the input
* to compression (or packet dispatch if packet is uncompressed)
* must be read from an unaligned buffer.
* This code tries to align the input to compression (or packet
* dispatch if packet is uncompressed) at the cost of requiring
* decryption output to be written to an unaligned buffer, so
* it's more of a tradeoff than an optimal solution and we don't
* include it when we are doing a modern build with LZ4.
* Strictly speaking, on the server it would be better to execute
* this code for every connection after we decide the compression
* method, but currently the frame code doesn't appear to be
* flexible enough for this, since the frame is already established
* before it is known which compression options will be pushed.
*/
if (comp_unswapped_prefix(&c->options.comp) && CIPHER_ENABLED(c))
{
frame_add_to_align_adjust(&c->c2.frame, COMP_PREFIX_LEN);
frame_or_align_flags(&c->c2.frame,
FRAME_HEADROOM_MARKER_FRAGMENT
|FRAME_HEADROOM_MARKER_DECRYPT);
}
#endif
#ifdef ENABLE_FRAGMENT
comp_add_to_extra_frame(&c->c2.frame_fragment_omit); /* omit compression frame delta from final frame_fragment */
#endif
}
#endif /* USE_COMP */
/*
* Adjust frame size for UDP Socks support.
*/
if (c->options.ce.socks_proxy_server)
{
socks_adjust_frame_parameters(&c->c2.frame, c->options.ce.proto);
}
/*
* Adjust frame size based on the --tun-mtu-extra parameter.
*/
if (c->options.ce.tun_mtu_extra_defined)
{
tun_adjust_frame_parameters(&c->c2.frame, c->options.ce.tun_mtu_extra);
}
/*
* Adjust frame size based on link socket parameters.
* (Since TCP is a stream protocol, we need to insert
* a packet length uint16_t in the buffer.)
*/
socket_adjust_frame_parameters(&c->c2.frame, c->options.ce.proto);
/*
* Fill in the blanks in the frame parameters structure,
* make sure values are rational, etc.