Merge commit '86cc97e55fe346502462284d2e636a2b3708163e' as 'Sources/OpenVPN3'

This commit is contained in:
Sergey Abramchuk
2020-02-24 14:43:11 +03:00
655 changed files with 146468 additions and 0 deletions
@@ -0,0 +1,99 @@
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2017 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
//
#pragma once
#include <openvpn/asio/scoped_asio_stream.hpp>
#include <openvpn/tun/client/tunbase.hpp>
#include <openvpn/tun/client/tunprop.hpp>
#include <openvpn/tun/persist/tunpersist.hpp>
#include <openvpn/tun/win/client/tunsetup.hpp>
namespace openvpn {
namespace TunWin {
// These types manage the underlying TAP driver HANDLE
typedef openvpn_io::windows::stream_handle TAPStream;
typedef ScopedAsioStream<TAPStream> ScopedTAPStream;
struct TunPersistState {
TunProp::State::Ptr state;
RingBuffer::Ptr ring_buffer;
void reset()
{
state.reset();
ring_buffer.reset();
}
};
typedef TunPersistTemplate<ScopedTAPStream, TunPersistState> TunPersist;
class ClientConfig : public TunClientFactory
{
friend class Client; // accesses wfp
public:
typedef RCPtr<ClientConfig> Ptr;
TunProp::Config tun_prop;
int n_parallel = 8; // number of parallel async reads on tun socket
bool wintun = false;
Frame::Ptr frame;
SessionStats::Ptr stats;
Stop* stop = nullptr;
TunPersist::Ptr tun_persist;
TunWin::SetupFactory::Ptr tun_setup_factory;
TunWin::SetupBase::Ptr new_setup_obj(openvpn_io::io_context& io_context)
{
if (tun_setup_factory)
return tun_setup_factory->new_setup_obj(io_context, wintun);
else
return new TunWin::Setup(io_context, wintun);
}
static Ptr new_obj()
{
return new ClientConfig;
}
virtual TunClient::Ptr new_tun_client_obj(openvpn_io::io_context& io_context,
TunClientParent& parent,
TransportClient* transcli) override;
virtual void finalize(const bool disconnected) override
{
if (disconnected)
tun_persist.reset();
}
virtual bool layer_2_supported() const override
{
return true;
}
};
}
}
@@ -0,0 +1,78 @@
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2017 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
//
// Client tun setup base class for Windows
#ifndef OPENVPN_TUN_WIN_CLIENT_SETUPBASE_H
#define OPENVPN_TUN_WIN_CLIENT_SETUPBASE_H
#include <windows.h> // for HANDLE
#include <functional>
#include <openvpn/io/io.hpp>
#include <openvpn/common/destruct.hpp>
#include <openvpn/common/stop.hpp>
#include <openvpn/tun/builder/capture.hpp>
#include <openvpn/tun/win/ringbuffer.hpp>
namespace openvpn {
namespace TunWin {
struct SetupBase : public DestructorBase
{
typedef RCPtr<SetupBase> Ptr;
OPENVPN_EXCEPTION(tun_win_setup);
virtual HANDLE establish(const TunBuilderCapture& pull,
const std::wstring& openvpn_app_path,
Stop* stop,
std::ostream& os,
RingBuffer::Ptr rings) = 0;
virtual bool l2_ready(const TunBuilderCapture& pull) = 0;
virtual void l2_finish(const TunBuilderCapture& pull,
Stop* stop,
std::ostream& os) = 0;
virtual void confirm()
{
}
virtual void set_service_fail_handler(std::function<void()>&& handler)
{
}
};
struct SetupFactory : public RC<thread_unsafe_refcount>
{
typedef RCPtr<SetupFactory> Ptr;
virtual SetupBase::Ptr new_setup_obj(openvpn_io::io_context& io_context, bool wintun) = 0;
};
}
}
#endif
@@ -0,0 +1,410 @@
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2017 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
// Client tun interface for Windows
#ifndef OPENVPN_TUN_WIN_CLIENT_TUNCLI_H
#define OPENVPN_TUN_WIN_CLIENT_TUNCLI_H
#include <string>
#include <sstream>
#include <memory>
#include <openvpn/common/to_string.hpp>
#include <openvpn/asio/scoped_asio_stream.hpp>
#include <openvpn/common/cleanup.hpp>
#include <openvpn/time/asiotimer.hpp>
#include <openvpn/tun/client/tunbase.hpp>
#include <openvpn/tun/client/tunprop.hpp>
#include <openvpn/tun/client/dhcp_capture.hpp>
#include <openvpn/tun/persist/tunpersist.hpp>
#include <openvpn/tun/persist/tunwrapasio.hpp>
#include <openvpn/tun/tunio.hpp>
#include <openvpn/tun/win/client/clientconfig.hpp>
#include <openvpn/tun/win/client/tunsetup.hpp>
#include <openvpn/win/modname.hpp>
#include <openvpn/tun/win/client/wintun.hpp>
namespace openvpn {
namespace TunWin {
OPENVPN_EXCEPTION(tun_win_error);
// struct used to pass received tun packets
struct PacketFrom
{
typedef std::unique_ptr<PacketFrom> SPtr;
BufferAllocated buf;
};
// tun interface wrapper for Windows
template <typename ReadHandler, typename TunPersist>
class Tun : public TunIO<ReadHandler, PacketFrom, TunWrapAsioStream<TunPersist> >
{
typedef TunIO<ReadHandler, PacketFrom, TunWrapAsioStream<TunPersist> > Base;
public:
typedef RCPtr<Tun> Ptr;
Tun(const typename TunPersist::Ptr& tun_persist,
const std::string& name,
const bool retain_stream,
ReadHandler read_handler,
const Frame::Ptr& frame,
const SessionStats::Ptr& stats)
: Base(read_handler, frame, stats, Frame::READ_TUN)
{
Base::name_ = name;
Base::retain_stream = retain_stream;
Base::stream = new TunWrapAsioStream<TunPersist>(tun_persist);
}
};
class Client : public TunClient
{
friend class ClientConfig; // calls constructor
friend class TunIO<Client*, PacketFrom, TunWrapAsioStream<TunPersist> >; // calls tun_read_handler
typedef Tun<Client*, TunPersist> TunImpl;
public:
typedef RCPtr<Client> Ptr;
virtual void tun_start(const OptionList& opt, TransportClient& transcli, CryptoDCSettings&) override
{
if (!impl)
{
halt = false;
if (config->tun_persist)
tun_persist = config->tun_persist; // long-term persistent
else
tun_persist.reset(new TunPersist(false, false, nullptr)); // short-term
try {
const IP::Addr server_addr = transcli.server_endpoint_addr();
// Check if persisted tun session matches properties of to-be-created session
if (tun_persist->use_persisted_tun(server_addr, config->tun_prop, opt))
{
state = tun_persist->state().state;
OPENVPN_LOG("TunPersist: reused tun context");
}
else
{
// notify parent
parent.tun_pre_tun_config();
// close old TAP handle if persisted
tun_persist->close();
// parse pushed options
TunBuilderCapture::Ptr po(new TunBuilderCapture());
TunProp::configure_builder(po.get(),
state.get(),
config->stats.get(),
server_addr,
config->tun_prop,
opt,
nullptr,
false);
OPENVPN_LOG("CAPTURED OPTIONS:" << std::endl << po->to_string());
// create new tun setup object
tun_setup = config->new_setup_obj(io_context);
// open/config TAP
HANDLE th;
{
std::ostringstream os;
auto os_print = Cleanup([&os](){ OPENVPN_LOG_STRING(os.str()); });
th = tun_setup->establish(*po, Win::module_name(), config->stop, os, NULL);
}
// create ASIO wrapper for HANDLE
TAPStream* ts = new TAPStream(io_context, th);
// persist tun settings state
if (tun_persist->persist_tun_state(ts, { state, nullptr }))
OPENVPN_LOG("TunPersist: saving tun context:" << std::endl << tun_persist->options());
// setup handler for external tun close
tun_setup->set_service_fail_handler([self=Ptr(this)]() {
if (!self->halt)
self->parent.tun_error(Error::TUN_IFACE_DISABLED, "service failure");
});
// enable tun_setup destructor
tun_persist->add_destructor(tun_setup);
// assert ownership over TAP device handle
tun_setup->confirm();
// if layer 2, set up to capture DHCP messages over the tunnel
if (config->tun_prop.layer() == Layer::OSI_LAYER_2)
dhcp_capture.reset(new DHCPCapture(po));
}
// configure tun interface packet forwarding
impl.reset(new TunImpl(tun_persist,
"TUN_WIN",
true,
this,
config->frame,
config->stats));
impl->start(config->n_parallel);
if (!dhcp_capture)
parent.tun_connected(); // signal that we are connected
}
catch (const std::exception& e)
{
if (tun_persist)
tun_persist->close();
stop();
Error::Type err = Error::TUN_SETUP_FAILED;
const ExceptionCode *ec = dynamic_cast<const ExceptionCode *>(&e);
if (ec && ec->code_defined())
err = ec->code();
parent.tun_error(err, e.what());
}
}
}
virtual bool tun_send(BufferAllocated& buf) override
{
return send(buf);
}
virtual std::string tun_name() const override
{
if (impl)
return impl->name();
else
return "UNDEF_TUN";
}
virtual std::string vpn_ip4() const override
{
if (state->vpn_ip4_addr.specified())
return state->vpn_ip4_addr.to_string();
else
return "";
}
virtual std::string vpn_ip6() const override
{
if (state->vpn_ip6_addr.specified())
return state->vpn_ip6_addr.to_string();
else
return "";
}
virtual std::string vpn_gw4() const override
{
if (state->vpn_ip4_gw.specified())
return state->vpn_ip4_gw.to_string();
else
return "";
}
virtual std::string vpn_gw6() const override
{
if (state->vpn_ip6_gw.specified())
return state->vpn_ip6_gw.to_string();
else
return "";
}
virtual void set_disconnect() override
{
}
virtual void stop() override { stop_(); }
virtual ~Client() { stop_(); }
private:
Client(openvpn_io::io_context& io_context_arg,
ClientConfig* config_arg,
TunClientParent& parent_arg)
: io_context(io_context_arg),
config(config_arg),
parent(parent_arg),
state(new TunProp::State()),
l2_timer(io_context_arg),
halt(false),
frame_context((*config_arg->frame)[Frame::READ_TUN])
{
}
bool send(Buffer& buf)
{
if (impl)
{
if (dhcp_capture)
dhcp_inspect(buf);
return impl->write(buf);
}
else
return false;
#ifdef OPENVPN_DEBUG_TAPWIN
tap_process_logging();
#endif
}
void tun_read_handler(PacketFrom::SPtr& pfp) // called by TunImpl
{
parent.tun_recv(pfp->buf);
#ifdef OPENVPN_DEBUG_TAPWIN
tap_process_logging();
#endif
}
void tun_error_handler(const Error::Type errtype, // called by TunImpl
const openvpn_io::error_code* error)
{
if (errtype == Error::TUN_READ_ERROR && error && error->value() == 995)
parent.tun_error(Error::TUN_IFACE_DISABLED, "TAP adapter is disabled");
else
parent.tun_error(Error::TUN_ERROR, "TUN I/O error");
}
void stop_()
{
if (!halt)
{
halt = true;
l2_timer.cancel();
// stop tun
if (impl)
impl->stop();
tun_persist.reset();
}
}
HANDLE tap_handle()
{
if (tun_persist)
{
TAPStream* stream = tun_persist->obj();
if (stream)
return stream->native_handle();
}
return Win::Handle::undefined();
}
void tap_process_logging()
{
HANDLE h = tap_handle();
if (Win::Handle::defined(h))
Util::tap_process_logging(h);
}
void dhcp_inspect(Buffer& buf)
{
try {
if (dhcp_capture->mod_reply(buf))
{
OPENVPN_LOG("DHCP PROPS:" << std::endl << dhcp_capture->get_props().to_string());
layer_2_schedule_timer(1);
}
}
catch (const std::exception& e)
{
stop();
parent.tun_error(Error::TUN_SETUP_FAILED, std::string("L2 exception: ") + e.what());
}
}
void layer_2_schedule_timer(const unsigned int seconds)
{
l2_timer.expires_after(Time::Duration::seconds(seconds));
l2_timer.async_wait([self=Ptr(this)](const openvpn_io::error_code& error)
{
OPENVPN_ASYNC_HANDLER;
if (!error && !self->halt)
self->layer_2_timer_callback();
});
}
// Normally called once per second by l2_timer while we are waiting
// for layer 2 DHCP handshake to complete.
void layer_2_timer_callback()
{
try {
if (dhcp_capture && tun_setup)
{
if (tun_setup->l2_ready(dhcp_capture->get_props()))
{
std::ostringstream os;
tun_setup->l2_finish(dhcp_capture->get_props(), config->stop, os);
OPENVPN_LOG_STRING(os.str());
parent.tun_connected();
dhcp_capture.reset();
}
else
{
OPENVPN_LOG("L2: Waiting for DHCP handshake...");
layer_2_schedule_timer(1);
}
}
}
catch (const std::exception& e)
{
stop();
parent.tun_error(Error::TUN_SETUP_FAILED, std::string("L2 exception: ") + e.what());
}
}
openvpn_io::io_context& io_context;
TunPersist::Ptr tun_persist; // contains the TAP device HANDLE
ClientConfig::Ptr config;
TunClientParent& parent;
TunImpl::Ptr impl;
TunProp::State::Ptr state;
TunWin::SetupBase::Ptr tun_setup;
// Layer 2 DHCP stuff
std::unique_ptr<DHCPCapture> dhcp_capture;
AsioTimer l2_timer;
Frame::Context& frame_context;
bool halt;
};
inline TunClient::Ptr ClientConfig::new_tun_client_obj(openvpn_io::io_context& io_context,
TunClientParent& parent,
TransportClient* transcli)
{
if (wintun)
return TunClient::Ptr(new WintunClient(io_context, this, parent));
else
return TunClient::Ptr(new Client(io_context, this, parent));
}
}
} // namespace openvpn
#endif
@@ -0,0 +1,921 @@
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2017 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
//
// Client tun setup for Windows
#ifndef OPENVPN_TUN_WIN_CLIENT_TUNSETUP_H
#define OPENVPN_TUN_WIN_CLIENT_TUNSETUP_H
#include <string>
#include <sstream>
#include <ostream>
#include <memory>
#include <utility>
#include <thread>
#include <openvpn/common/exception.hpp>
#include <openvpn/common/rc.hpp>
#include <openvpn/common/string.hpp>
#include <openvpn/common/size.hpp>
#include <openvpn/common/arraysize.hpp>
#include <openvpn/error/excode.hpp>
#include <openvpn/time/time.hpp>
#include <openvpn/tun/proxy.hpp>
#include <openvpn/tun/win/tunutil.hpp>
#include <openvpn/tun/win/winproxy.hpp>
#include <openvpn/tun/win/client/setupbase.hpp>
#include <openvpn/win/scoped_handle.hpp>
#include <openvpn/win/cmd.hpp>
#if _WIN32_WINNT >= 0x0600 // Vista+
#include <openvpn/tun/win/nrpt.hpp>
#include <openvpn/tun/win/wfp.hpp>
#endif
#include <versionhelpers.h>
namespace openvpn {
namespace TunWin {
class Setup : public SetupBase
{
public:
typedef RCPtr<Setup> Ptr;
Setup(openvpn_io::io_context& io_context_arg, bool wintun_arg=false)
: delete_route_timer(io_context_arg),
wintun(wintun_arg) {}
// Set up the TAP device
virtual HANDLE establish(const TunBuilderCapture& pull,
const std::wstring& openvpn_app_path,
Stop* stop,
std::ostream& os,
RingBuffer::Ptr ring_buffer) override // defined by SetupBase
{
// close out old remove cmds, if they exist
destroy(os);
// enumerate available TAP adapters
Util::TapNameGuidPairList guids(wintun);
os << "TAP ADAPTERS:" << std::endl << guids.to_string() << std::endl;
// open TAP device handle
std::string path_opened;
Util::TapNameGuidPair tap;
Win::ScopedHANDLE th(Util::tap_open(guids, path_opened, tap, wintun));
const std::string msg = "Open TAP device \"" + tap.name + "\" PATH=\"" + path_opened + '\"';
if (!th.defined())
{
os << msg << " FAILED" << std::endl;
throw ErrorCode(Error::TUN_IFACE_CREATE, true, "cannot acquire TAP handle");
}
os << msg << " SUCCEEDED" << std::endl;
if (!wintun)
{
Util::TAPDriverVersion version(th());
os << version.to_string() << std::endl;
}
// create ActionLists for setting up and removing adapter properties
ActionList::Ptr add_cmds(new ActionList());
remove_cmds.reset(new ActionList());
// populate add/remove lists with actions
switch (pull.layer())
{
case Layer::OSI_LAYER_3:
adapter_config(th(), openvpn_app_path, tap, pull, false, *add_cmds, *remove_cmds, os);
break;
case Layer::OSI_LAYER_2:
adapter_config_l2(th(), openvpn_app_path, tap, pull, *add_cmds, *remove_cmds, os);
break;
default:
throw tun_win_setup("layer undefined");
}
// execute the add actions
add_cmds->execute(os);
// now that the add actions have succeeded,
// enable the remove actions
remove_cmds->enable_destroy(true);
// if layer 2, save state
if (pull.layer() == Layer::OSI_LAYER_2)
l2_state.reset(new L2State(tap, openvpn_app_path));
if (ring_buffer)
register_rings(th(), ring_buffer);
return th.release();
}
// In layer 2 mode, return true route_delay seconds after
// the adapter properties matches the data given in pull.
// This method is usually called once per second until it
// returns true.
virtual bool l2_ready(const TunBuilderCapture& pull) override
{
const unsigned int route_delay = 5;
if (l2_state)
{
if (l2_state->props_ready.defined())
{
if (Time::now() >= l2_state->props_ready)
return true;
}
else
{
const Util::IPNetmask4 vpn_addr(pull, "VPN IP");
const Util::IPAdaptersInfo ai;
if (ai.is_up(l2_state->tap.index, vpn_addr))
l2_state->props_ready = Time::now() + Time::Duration::seconds(route_delay);
}
}
return false;
}
// Finish the layer 2 configuration, should be called
// after l2_ready() returns true.
virtual void l2_finish(const TunBuilderCapture& pull,
Stop* stop,
std::ostream& os) override
{
std::unique_ptr<L2State> l2s(std::move(l2_state));
if (l2s)
{
Win::ScopedHANDLE nh;
ActionList::Ptr add_cmds(new ActionList());
adapter_config(nh(), l2s->openvpn_app_path, l2s->tap, pull, true, *add_cmds, *remove_cmds, os);
add_cmds->execute(os);
}
}
virtual void destroy(std::ostream& os) override // defined by DestructorBase
{
// l2_state
l2_state.reset();
// l2_thread
if (l2_thread)
{
try {
l2_thread->join();
}
catch (...)
{
}
l2_thread.reset();
}
// remove_cmds
if (remove_cmds)
{
remove_cmds->destroy(os);
remove_cmds.reset();
}
delete_route_timer.cancel();
}
virtual ~Setup()
{
std::ostringstream os;
destroy(os);
}
static void add_bypass_route(const std::string& route,
bool ipv6,
ActionList& add_cmds,
ActionList& remove_cmds_bypass_gw)
{
const Util::DefaultGateway gw;
if (!ipv6)
{
add_cmds.add(new WinCmd("netsh interface ip add route " + route + "/32 " + to_string(gw.interface_index()) + ' ' + gw.gateway_address() + " store=active"));
remove_cmds_bypass_gw.add(new WinCmd("netsh interface ip delete route " + route + "/32 " + to_string(gw.interface_index()) + ' ' + gw.gateway_address() + " store=active"));
}
}
private:
struct L2State
{
L2State(const Util::TapNameGuidPair& tap_arg,
const std::wstring& openvpn_app_path_arg)
: tap(tap_arg),
openvpn_app_path(openvpn_app_path_arg)
{
}
Util::TapNameGuidPair tap;
std::wstring openvpn_app_path;
Time props_ready;
};
class UseDNS
{
public:
UseDNS() {}
UseDNS(const TunBuilderCapture& pull)
{
for (auto &ds : pull.dns_servers)
add(ds, pull);
}
static bool enabled(const TunBuilderCapture::DNSServer& ds,
const TunBuilderCapture& pull)
{
if (ds.ipv6 && pull.block_ipv6)
return false;
return true;
}
int add(const TunBuilderCapture::DNSServer& ds,
const TunBuilderCapture& pull)
{
if (enabled(ds, pull))
return indices[ds.ipv6 ? 1 : 0]++;
else
return -1;
}
int ipv4() const { return indices[0]; }
int ipv6() const { return indices[1]; }
private:
int indices[2] = {0, 0};
};
void register_rings(HANDLE handle, RingBuffer::Ptr ring_buffer)
{
TUN_REGISTER_RINGS rings;
ZeroMemory(&rings, sizeof(rings));
rings.receive.ring = ring_buffer->receive_ring();
rings.receive.tail_moved = ring_buffer->receive_ring_tail_moved();
rings.receive.ring_size = sizeof(rings.receive.ring->data);
rings.send.ring = ring_buffer->send_ring();
rings.send.tail_moved = ring_buffer->send_ring_tail_moved();
rings.send.ring_size = sizeof(rings.send.ring->data);
{
Win::Impersonate imp(true);
DWORD len;
if (!DeviceIoControl(handle, TUN_IOCTL_REGISTER_RINGS, &rings, sizeof(rings), NULL, NULL, &len, NULL))
{
const Win::LastError err;
throw ErrorCode(Error::TUN_REGISTER_RINGS_ERROR, true, "Error registering ring buffers: " + err.message());
}
}
}
#if _WIN32_WINNT >= 0x0600
// Configure TAP adapter on Vista and higher
void adapter_config(HANDLE th,
const std::wstring& openvpn_app_path,
const Util::TapNameGuidPair& tap,
const TunBuilderCapture& pull,
const bool l2_post,
ActionList& create,
ActionList& destroy,
std::ostream& os)
{
// Windows interface index
const std::string tap_index_name = tap.index_or_name();
// special IPv6 next-hop recognized by TAP driver (magic)
const std::string ipv6_next_hop = "fe80::8";
// get default gateway
const Util::DefaultGateway gw;
// set local4 and local6 to point to IPv4/6 route configurations
const TunBuilderCapture::RouteAddress* local4 = pull.vpn_ipv4();
const TunBuilderCapture::RouteAddress* local6 = pull.vpn_ipv6();
if (!l2_post)
{
// set TAP media status to CONNECTED
if (!wintun)
Util::tap_set_media_status(th, true);
// try to delete any stale routes on interface left over from previous session
create.add(new Util::ActionDeleteAllRoutesOnInterface(tap.index));
}
// Set IPv4 Interface
//
// Usage: set address [name=]<string>
// [[source=]dhcp|static]
// [[address=]<IPv4 address>[/<integer>] [[mask=]<IPv4 mask>]
// [[gateway=]<IPv4 address>|none [gwmetric=]<integer>]
// [[type=]unicast|anycast]
// [[subinterface=]<string>]
// [[store=]active|persistent]
// Usage: delete address [name=]<string> [[address=]<IPv4 address>]
// [[gateway=]<IPv4 address>|all]
// [[store=]active|persistent]
if (local4)
{
// Process ifconfig and topology
if (!l2_post)
{
// set lowest interface metric to make Windows use pushed DNS search domain
create.add(new WinCmd("netsh interface ip set interface " + tap_index_name + " metric=1"));
const std::string metric = route_metric_opt(pull, *local4, MT_IFACE);
const std::string netmask = IPv4::Addr::netmask_from_prefix_len(local4->prefix_length).to_string();
const IP::Addr localaddr = IP::Addr::from_string(local4->address);
if (!wintun)
{
if (local4->net30)
Util::tap_configure_topology_net30(th, localaddr, local4->prefix_length);
else
Util::tap_configure_topology_subnet(th, localaddr, local4->prefix_length);
}
create.add(new WinCmd("netsh interface ip set address " + tap_index_name + " static " + local4->address + ' ' + netmask + " gateway=" + local4->gateway + metric + " store=active"));
destroy.add(new WinCmd("netsh interface ip delete address " + tap_index_name + ' ' + local4->address + " gateway=all store=active"));
// specifying 'gateway' when setting ip address makes Windows add unnecessary route 0.0.0.0/0,
// which might cause routing conflicts, so we have to delete it after a small delay.
// If route is deleted before profile is created, then profile won't be created at all (OVPN-135)
WinCmd::Ptr cmd = new WinCmd("netsh interface ip delete route 0.0.0.0/0 " + tap_index_name + ' ' + local4->gateway + " store=active");
delete_route_timer.expires_after(Time::Duration::seconds(5));
delete_route_timer.async_wait([self=Ptr(this), cmd=std::move(cmd)](const openvpn_io::error_code& error)
{
if (!error)
{
std::ostringstream os;
cmd->execute(os);
}
});
}
}
// Should we block IPv6?
if (pull.block_ipv6)
{
static const char *const block_ipv6_net[] = {
"2000::/4",
"3000::/4",
"fc00::/7",
};
for (size_t i = 0; i < array_size(block_ipv6_net); ++i)
{
create.add(new WinCmd("netsh interface ipv6 add route " + std::string(block_ipv6_net[i]) + " interface=1 store=active"));
destroy.add(new WinCmd("netsh interface ipv6 delete route " + std::string(block_ipv6_net[i]) + " interface=1 store=active"));
}
}
// Set IPv6 Interface
//
// Usage: set address [interface=]<string> [address=]<IPv6 address>
// [[type=]unicast|anycast]
// [[validlifetime=]<integer>|infinite]
// [[preferredlifetime=]<integer>|infinite]
// [[store=]active|persistent]
//Usage: delete address [interface=]<string> [address=]<IPv6 address>
// [[store=]active|persistent]
if (local6 && !pull.block_ipv6 && !l2_post)
{
create.add(new WinCmd("netsh interface ipv6 set address " + tap_index_name + ' ' + local6->address + " store=active"));
destroy.add(new WinCmd("netsh interface ipv6 delete address " + tap_index_name + ' ' + local6->address + " store=active"));
create.add(new WinCmd("netsh interface ipv6 add route " + local6->gateway + '/' + to_string(local6->prefix_length) + ' ' + tap_index_name + ' ' + ipv6_next_hop + " store=active"));
destroy.add(new WinCmd("netsh interface ipv6 delete route " + local6->gateway + '/' + to_string(local6->prefix_length) + ' ' + tap_index_name + ' ' + ipv6_next_hop + " store=active"));
}
// Process Routes
//
// Usage: add route [prefix=]<IPv4 address>/<integer> [interface=]<string>
// [[nexthop=]<IPv4 address>] [[siteprefixlength=]<integer>]
// [[metric=]<integer>] [[publish=]no|age|yes]
// [[validlifetime=]<integer>|infinite]
// [[preferredlifetime=]<integer>|infinite]
// [[store=]active|persistent]
// Usage: delete route [prefix=]<IPv4 address>/<integer> [interface=]<string>
// [[nexthop=]<IPv4 address>]
// [[store=]active|persistent]
//
// Usage: add route [prefix=]<IPv6 address>/<integer> [interface=]<string>
// [[nexthop=]<IPv6 address>] [[siteprefixlength=]<integer>]
// [[metric=]<integer>] [[publish=]no|age|yes]
// [[validlifetime=]<integer>|infinite]
// [[preferredlifetime=]<integer>|infinite]
// [[store=]active|persistent]
// Usage: delete route [prefix=]<IPv6 address>/<integer> [interface=]<string>
// [[nexthop=]<IPv6 address>]
// [[store=]active|persistent]
{
for (auto &route : pull.add_routes)
{
const std::string metric = route_metric_opt(pull, route, MT_NETSH);
if (route.ipv6)
{
if (!pull.block_ipv6)
{
create.add(new WinCmd("netsh interface ipv6 add route " + route.address + '/' + to_string(route.prefix_length) + ' ' + tap_index_name + ' ' + ipv6_next_hop + metric + " store=active"));
destroy.add(new WinCmd("netsh interface ipv6 delete route " + route.address + '/' + to_string(route.prefix_length) + ' ' + tap_index_name + ' ' + ipv6_next_hop + " store=active"));
}
}
else
{
if (local4)
{
create.add(new WinCmd("netsh interface ip add route " + route.address + '/' + to_string(route.prefix_length) + ' ' + tap_index_name + ' ' + local4->gateway + metric + " store=active"));
destroy.add(new WinCmd("netsh interface ip delete route " + route.address + '/' + to_string(route.prefix_length) + ' ' + tap_index_name + ' ' + local4->gateway + " store=active"));
}
else
throw tun_win_setup("IPv4 routes pushed without IPv4 ifconfig");
}
}
}
// Process exclude routes
if (!pull.exclude_routes.empty())
{
if (gw.defined())
{
bool ipv6_error = false;
for (auto &route : pull.exclude_routes)
{
const std::string metric = route_metric_opt(pull, route, MT_NETSH);
if (route.ipv6)
{
ipv6_error = true;
}
else
{
create.add(new WinCmd("netsh interface ip add route " + route.address + '/' + to_string(route.prefix_length) + ' ' + to_string(gw.interface_index()) + ' ' + gw.gateway_address() + metric + " store=active"));
destroy.add(new WinCmd("netsh interface ip delete route " + route.address + '/' + to_string(route.prefix_length) + ' ' + to_string(gw.interface_index()) + ' ' + gw.gateway_address() + " store=active"));
}
}
if (ipv6_error)
os << "NOTE: exclude IPv6 routes not currently supported" << std::endl;
}
else
os << "NOTE: exclude routes error: cannot detect default gateway" << std::endl;
}
// Process IPv4 redirect-gateway
if (pull.reroute_gw.ipv4)
{
// add server bypass route
if (gw.defined())
{
if (!pull.remote_address.ipv6)
{
create.add(new WinCmd("netsh interface ip add route " + pull.remote_address.address + "/32 " + to_string(gw.interface_index()) + ' ' + gw.gateway_address() + " store=active"));
destroy.add(new WinCmd("netsh interface ip delete route " + pull.remote_address.address + "/32 " + to_string(gw.interface_index()) + ' ' + gw.gateway_address() + " store=active"));
}
}
else
throw tun_win_setup("redirect-gateway error: cannot detect default gateway");
create.add(new WinCmd("netsh interface ip add route 0.0.0.0/1 " + tap_index_name + ' ' + local4->gateway + " store=active"));
create.add(new WinCmd("netsh interface ip add route 128.0.0.0/1 " + tap_index_name + ' ' + local4->gateway + " store=active"));
destroy.add(new WinCmd("netsh interface ip delete route 0.0.0.0/1 " + tap_index_name + ' ' + local4->gateway + " store=active"));
destroy.add(new WinCmd("netsh interface ip delete route 128.0.0.0/1 " + tap_index_name + ' ' + local4->gateway + " store=active"));
}
// Process IPv6 redirect-gateway
if (pull.reroute_gw.ipv6 && !pull.block_ipv6)
{
create.add(new WinCmd("netsh interface ipv6 add route 0::/1 " + tap_index_name + ' ' + ipv6_next_hop + " store=active"));
create.add(new WinCmd("netsh interface ipv6 add route 8000::/1 " + tap_index_name + ' ' + ipv6_next_hop + " store=active"));
destroy.add(new WinCmd("netsh interface ipv6 delete route 0::/1 " + tap_index_name + ' ' + ipv6_next_hop + " store=active"));
destroy.add(new WinCmd("netsh interface ipv6 delete route 8000::/1 " + tap_index_name + ' ' + ipv6_next_hop + " store=active"));
}
// Process DNS Servers
//
// Usage: set dnsservers [name=]<string> [source=]dhcp|static
// [[address=]<IP address>|none]
// [[register=]none|primary|both]
// [[validate=]yes|no]
// Usage: add dnsservers [name=]<string> [address=]<IPv4 address>
// [[index=]<integer>] [[validate=]yes|no]
// Usage: delete dnsservers [name=]<string> [[address=]<IP address>|all] [[validate=]yes|no]
//
// Usage: set dnsservers [name=]<string> [source=]dhcp|static
// [[address=]<IPv6 address>|none]
// [[register=]none|primary|both]
// [[validate=]yes|no]
// Usage: add dnsservers [name=]<string> [address=]<IPv6 address>
// [[index=]<integer>] [[validate=]yes|no]
// Usage: delete dnsservers [name=]<string> [[address=]<IPv6 address>|all] [[validate=]yes|no]
{
// fix for vista and dnsserver vs win7+ dnsservers
std::string dns_servers_cmd = "dnsservers";
std::string validate_cmd = " validate=no";
if (IsWindowsVistaOrGreater() && !IsWindows7OrGreater()) {
dns_servers_cmd = "dnsserver";
validate_cmd = "";
}
#if 1
// normal production setting
const bool use_nrpt = IsWindows8OrGreater();
const bool use_wfp = IsWindows8OrGreater();
const bool add_netsh_rules = true;
#else
// test NRPT registry settings on pre-Win8
const bool use_nrpt = true;
const bool use_wfp = true;
const bool add_netsh_rules = true;
#endif
// determine IPv4/IPv6 DNS redirection
const UseDNS dns(pull);
// will DNS requests be split between VPN DNS server and local?
const bool split_dns = (!pull.search_domains.empty()
&& !(pull.reroute_gw.ipv4 && dns.ipv4())
&& !(pull.reroute_gw.ipv6 && dns.ipv6()));
// add DNS servers via netsh
if (add_netsh_rules && !(use_nrpt && split_dns) && !l2_post)
{
UseDNS dc;
for (auto &ds : pull.dns_servers)
{
// 0-based index for specific IPv4/IPv6 protocol, or -1 if disabled
const int count = dc.add(ds, pull);
if (count >= 0)
{
const std::string proto = ds.ipv6 ? "ipv6" : "ip";
if (count)
create.add(new WinCmd("netsh interface " + proto + " add " + dns_servers_cmd + " " + tap_index_name + ' ' + ds.address + " " + to_string(count+1) + validate_cmd));
else
{
create.add(new WinCmd("netsh interface " + proto + " set " + dns_servers_cmd + " " + tap_index_name + " static " + ds.address + " register=primary" + validate_cmd));
destroy.add(new WinCmd("netsh interface " + proto + " delete " + dns_servers_cmd + " " + tap_index_name + " all" + validate_cmd));
}
}
}
}
// If NRPT enabled and at least one IPv4 or IPv6 DNS
// server was added, add NRPT registry entries to
// route DNS through the tunnel.
// Also consider selective DNS routing using domain
// suffix list from pull.search_domains as set by
// "dhcp-option DOMAIN ..." directives.
if (use_nrpt && (dns.ipv4() || dns.ipv6()))
{
// domain suffix list
std::vector<std::string> dsfx;
// Only add DNS routing suffixes if not rerouting gateway.
// Otherwise, route all DNS requests with wildcard (".").
if (split_dns)
{
for (const auto &sd : pull.search_domains)
{
std::string dom = sd.domain;
if (!dom.empty())
{
// each DNS suffix must begin with '.'
if (dom[0] != '.')
dom = "." + dom;
dsfx.push_back(std::move(dom));
}
}
}
if (dsfx.empty())
dsfx.emplace_back(".");
// DNS server list
std::vector<std::string> dserv;
for (const auto &ds : pull.dns_servers)
dserv.push_back(ds.address);
create.add(new NRPT::ActionCreate(dsfx, dserv));
destroy.add(new NRPT::ActionDelete);
}
// Use WFP for DNS leak protection.
// If we added DNS servers, block DNS on all interfaces except
// the TAP adapter.
if (use_wfp && !split_dns && !openvpn_app_path.empty() && (dns.ipv4() || dns.ipv6()))
{
create.add(new ActionWFP(openvpn_app_path, tap.index, true, wfp));
destroy.add(new ActionWFP(openvpn_app_path, tap.index, false, wfp));
}
}
// Set a default TAP-adapter domain suffix using
// "dhcp-option ADAPTER_DOMAIN_SUFFIX mycompany.com" directive.
if (!pull.adapter_domain_suffix.empty())
{
// Only the first search domain is used
create.add(new Util::ActionSetAdapterDomainSuffix(pull.adapter_domain_suffix, tap.guid));
destroy.add(new Util::ActionSetAdapterDomainSuffix("", tap.guid));
}
// Process WINS Servers
//
// Usage: set winsservers [name=]<string> [source=]dhcp|static
// [[address=]<IP address>|none]
// Usage: add winsservers [name=]<string> [address=]<IP address> [[index=]<integer>]
// Usage: delete winsservers [name=]<string> [[address=]<IP address>|all]
{
for (size_t i = 0; i < pull.wins_servers.size(); ++i)
{
const TunBuilderCapture::WINSServer& ws = pull.wins_servers[i];
if (i)
create.add(new WinCmd("netsh interface ip add winsservers " + tap_index_name + ' ' + ws.address + ' ' + to_string(i+1)));
else
{
create.add(new WinCmd("netsh interface ip set winsservers " + tap_index_name + " static " + ws.address));
destroy.add(new WinCmd("netsh interface ip delete winsservers " + tap_index_name + " all"));
}
}
}
OPENVPN_LOG("proxy_auto_config_url " << pull.proxy_auto_config_url.url);
if (pull.proxy_auto_config_url.defined())
ProxySettings::add_actions<WinProxySettings>(pull, create, destroy);
// flush DNS cache
create.add(new WinCmd("ipconfig /flushdns"));
destroy.add(new WinCmd("ipconfig /flushdns"));
}
#else
// Configure TAP adapter for pre-Vista
// Currently we don't support IPv6 on pre-Vista
void adapter_config(HANDLE th,
const std::wstring& openvpn_app_path,
const Util::TapNameGuidPair& tap,
const TunBuilderCapture& pull,
const bool l2_post,
ActionList& create,
ActionList& destroy,
std::ostream& os)
{
// Windows interface index
const std::string tap_index_name = tap.index_or_name();
// get default gateway
const Util::DefaultGateway gw;
// set local4 to point to IPv4 route configurations
const TunBuilderCapture::RouteAddress* local4 = pull.vpn_ipv4();
// This section skipped on layer 2 post-config
if (!l2_post)
{
// Make sure the TAP adapter is set for DHCP
{
const Util::IPAdaptersInfo ai;
if (!ai.is_dhcp_enabled(tap.index))
{
os << "TAP: DHCP is disabled, attempting to enable" << std::endl;
ActionList::Ptr cmds(new ActionList());
cmds->add(new Util::ActionEnableDHCP(tap));
cmds->execute(os);
}
}
// Set IPv4 Interface
if (local4)
{
// Process ifconfig and topology
const std::string netmask = IPv4::Addr::netmask_from_prefix_len(local4->prefix_length).to_string();
const IP::Addr localaddr = IP::Addr::from_string(local4->address);
if (local4->net30)
Util::tap_configure_topology_net30(th, localaddr, local4->prefix_length);
else
Util::tap_configure_topology_subnet(th, localaddr, local4->prefix_length);
}
// On pre-Vista, set up TAP adapter DHCP masquerade for
// configuring adapter properties.
{
os << "TAP: configure DHCP masquerade" << std::endl;
Util::TAPDHCPMasquerade dhmasq;
dhmasq.init_from_capture(pull);
dhmasq.ioctl(th);
}
// set TAP media status to CONNECTED
if (!wintun)
Util::tap_set_media_status(th, true);
// ARP
Util::flush_arp(tap.index, os);
// DHCP release/renew
{
const Util::InterfaceInfoList ii;
Util::dhcp_release(ii, tap.index, os);
Util::dhcp_renew(ii, tap.index, os);
}
// Wait for TAP adapter to come up
{
bool succeed = false;
const Util::IPNetmask4 vpn_addr(pull, "VPN IP");
for (int i = 1; i <= 30; ++i)
{
os << '[' << i << "] waiting for TAP adapter to receive DHCP settings..." << std::endl;
const Util::IPAdaptersInfo ai;
if (ai.is_up(tap.index, vpn_addr))
{
succeed = true;
break;
}
::Sleep(1000);
}
if (!succeed)
throw tun_win_setup("TAP adapter DHCP handshake failed");
}
// Pre route-add sleep
os << "Sleeping 5 seconds prior to adding routes..." << std::endl;
::Sleep(5000);
}
// Process routes
for (auto &route : pull.add_routes)
{
const std::string metric = route_metric_opt(pull, route, MT_ROUTE);
if (!route.ipv6)
{
if (local4)
{
const std::string netmask = IPv4::Addr::netmask_from_prefix_len(route.prefix_length).to_string();
create.add(new WinCmd("route ADD " + route.address + " MASK " + netmask + ' ' + local4->gateway + metric));
destroy.add(new WinCmd("route DELETE " + route.address + " MASK " + netmask + ' ' + local4->gateway));
}
else
throw tun_win_setup("IPv4 routes pushed without IPv4 ifconfig");
}
}
// Process exclude routes
if (!pull.exclude_routes.empty())
{
if (gw.defined())
{
for (auto &route : pull.exclude_routes)
{
const std::string metric = route_metric_opt(pull, route, MT_ROUTE);
if (!route.ipv6)
{
const std::string netmask = IPv4::Addr::netmask_from_prefix_len(route.prefix_length).to_string();
create.add(new WinCmd("route ADD " + route.address + " MASK " + netmask + ' ' + gw.gateway_address() + metric));
destroy.add(new WinCmd("route DELETE " + route.address + " MASK " + netmask + ' ' + gw.gateway_address()));
}
}
}
else
os << "NOTE: exclude routes error: cannot detect default gateway" << std::endl;
}
// Process IPv4 redirect-gateway
if (pull.reroute_gw.ipv4)
{
// add server bypass route
if (gw.defined())
{
if (!pull.remote_address.ipv6)
{
create.add(new WinCmd("route ADD " + pull.remote_address.address + " MASK 255.255.255.255 " + gw.gateway_address()));
destroy.add(new WinCmd("route DELETE " + pull.remote_address.address + " MASK 255.255.255.255 " + gw.gateway_address()));
}
}
else
throw tun_win_setup("redirect-gateway error: cannot detect default gateway");
create.add(new WinCmd("route ADD 0.0.0.0 MASK 128.0.0.0 " + local4->gateway));
create.add(new WinCmd("route ADD 128.0.0.0 MASK 128.0.0.0 " + local4->gateway));
destroy.add(new WinCmd("route DELETE 0.0.0.0 MASK 128.0.0.0 " + local4->gateway));
destroy.add(new WinCmd("route DELETE 128.0.0.0 MASK 128.0.0.0 " + local4->gateway));
}
// flush DNS cache
//create.add(new WinCmd("net stop dnscache"));
//create.add(new WinCmd("net start dnscache"));
create.add(new WinCmd("ipconfig /flushdns"));
//create.add(new WinCmd("ipconfig /registerdns"));
destroy.add(new WinCmd("ipconfig /flushdns"));
}
#endif
void adapter_config_l2(HANDLE th,
const std::wstring& openvpn_app_path,
const Util::TapNameGuidPair& tap,
const TunBuilderCapture& pull,
ActionList& create,
ActionList& destroy,
std::ostream& os)
{
// Make sure the TAP adapter is set for DHCP
{
const Util::IPAdaptersInfo ai;
if (!ai.is_dhcp_enabled(tap.index))
{
os << "TAP: DHCP is disabled, attempting to enable" << std::endl;
ActionList::Ptr cmds(new ActionList());
cmds->add(new Util::ActionEnableDHCP(tap));
cmds->execute(os);
}
}
// set TAP media status to CONNECTED
Util::tap_set_media_status(th, true);
// ARP
Util::flush_arp(tap.index, os);
// We must do DHCP release/renew in a background thread
// so the foreground can forward the DHCP negotiation packets
// over the tunnel.
l2_thread.reset(new std::thread([this, logwrap=Log::Context::Wrapper(), tap]() {
Log::Context logctx(logwrap);
::Sleep(250);
const Util::InterfaceInfoList ii;
{
std::ostringstream os;
Util::dhcp_release(ii, tap.index, os);
OPENVPN_LOG_STRING(os.str());
}
::Sleep(250);
{
std::ostringstream os;
Util::dhcp_renew(ii, tap.index, os);
OPENVPN_LOG_STRING(os.str());
}
}));
}
enum MetricType {
MT_ROUTE,
MT_NETSH,
MT_IFACE,
};
static std::string route_metric_opt(const TunBuilderCapture& pull,
const TunBuilderCapture::RouteBase& route,
const MetricType mt)
{
int metric = pull.route_metric_default;
if (route.metric >= 0)
metric = route.metric;
if (metric >= 0)
{
switch (mt)
{
case MT_ROUTE:
return " METRIC " + std::to_string(metric); // route command form
case MT_NETSH:
return " metric=" + std::to_string(metric); // "netsh interface ip[v6] add route" form
case MT_IFACE:
return " gwmetric=" + std::to_string(metric); // "netsh interface ip set address" form
}
}
return "";
}
#if _WIN32_WINNT >= 0x0600 // Vista+
TunWin::WFPContext::Ptr wfp{new TunWin::WFPContext};
#endif
std::unique_ptr<std::thread> l2_thread;
std::unique_ptr<L2State> l2_state;
ActionList::Ptr remove_cmds;
AsioTimer delete_route_timer;
bool wintun = false;
};
}
}
#endif
@@ -0,0 +1,318 @@
#pragma once
#include <openvpn/tun/client/tunbase.hpp>
#include <openvpn/tun/persist/tunpersist.hpp>
#include <openvpn/tun/win/client/setupbase.hpp>
#include <openvpn/tun/win/client/clientconfig.hpp>
#include <openvpn/win/modname.hpp>
namespace openvpn {
namespace TunWin {
class WintunClient : public TunClient
{
typedef RCPtr<WintunClient> Ptr;
public:
WintunClient(openvpn_io::io_context& io_context_arg,
ClientConfig* config_arg,
TunClientParent& parent_arg)
: io_context(io_context_arg),
config(config_arg),
parent(parent_arg),
state(new TunProp::State()),
frame(config_arg->frame)
{
}
// Inherited via TunClient
void tun_start(const OptionList& opt, TransportClient& transcli, CryptoDCSettings&) override
{
halt = false;
if (config->tun_persist)
tun_persist = config->tun_persist; // long-term persistent
else
tun_persist.reset(new TunPersist(false, false, nullptr)); // short-term
try {
const IP::Addr server_addr = transcli.server_endpoint_addr();
// Check if persisted tun session matches properties of to-be-created session
if (tun_persist->use_persisted_tun(server_addr, config->tun_prop, opt))
{
state = tun_persist->state().state;
ring_buffer = tun_persist->state().ring_buffer;
OPENVPN_LOG("TunPersist: reused tun context");
}
else
{
// notify parent
parent.tun_pre_tun_config();
// close old TAP handle if persisted
tun_persist->close();
// parse pushed options
TunBuilderCapture::Ptr po(new TunBuilderCapture());
TunProp::configure_builder(po.get(),
state.get(),
config->stats.get(),
server_addr,
config->tun_prop,
opt,
nullptr,
false);
OPENVPN_LOG("CAPTURED OPTIONS:" << std::endl << po->to_string());
// create new tun setup object
tun_setup = config->new_setup_obj(io_context);
ring_buffer.reset(new RingBuffer(io_context));
// open/config TAP
HANDLE th;
{
std::ostringstream os;
auto os_print = Cleanup([&os]() { OPENVPN_LOG_STRING(os.str()); });
th = tun_setup->establish(*po, Win::module_name(), config->stop, os, ring_buffer);
}
// create ASIO wrapper for HANDLE
TAPStream* ts = new TAPStream(io_context, th);
// persist tun settings state
if (tun_persist->persist_tun_state(ts, { state, ring_buffer }))
OPENVPN_LOG("TunPersist: saving tun context:" << std::endl << tun_persist->options());
// enable tun_setup destructor
tun_persist->add_destructor(tun_setup);
// assert ownership over TAP device handle
tun_setup->confirm();
}
openvpn_io::post(io_context, [self=Ptr(this)](){
self->read();
});
parent.tun_connected(); // signal that we are connected
}
catch (const std::exception& e)
{
stop();
Error::Type err = Error::TUN_SETUP_FAILED;
const ExceptionCode* ec = dynamic_cast<const ExceptionCode*>(&e);
if (ec && ec->code_defined())
err = ec->code();
parent.tun_error(err, e.what());
}
}
void stop() override
{
if (!halt)
{
halt = true;
tun_persist.reset();
}
}
void set_disconnect() override
{
}
bool tun_send(BufferAllocated& buf) override
{
TUN_RING* receive_ring = ring_buffer->receive_ring();
ULONG head = receive_ring->head.load(std::memory_order_acquire);
if (head > WINTUN_RING_CAPACITY)
{
if (head == 0xFFFFFFFF)
parent.tun_error(Error::TUN_WRITE_ERROR, "invalid ring head/tail or bogus packet received");
return false;
}
ULONG tail = receive_ring->tail.load(std::memory_order_acquire);
if (tail >= WINTUN_RING_CAPACITY)
return false;
ULONG aligned_packet_size = packet_align(sizeof(TUN_PACKET_HEADER) + buf.size());
ULONG buf_space = wrap(head - tail - WINTUN_PACKET_ALIGN);
if (aligned_packet_size > buf_space)
{
OPENVPN_LOG("ring is full");
return false;
}
// copy packet size and data into ring
TUN_PACKET* packet = (TUN_PACKET*)& receive_ring->data[tail];
packet->size = buf.size();
std::memcpy(packet->data, buf.data(), buf.size());
// move ring tail
receive_ring->tail.store(wrap(tail + aligned_packet_size), std::memory_order_release);
if (receive_ring->alertable.load(std::memory_order_acquire) != 0)
SetEvent(ring_buffer->receive_ring_tail_moved());
return true;
}
std::string tun_name() const override
{
return "wintun";
}
std::string vpn_ip4() const override
{
if (state->vpn_ip4_addr.specified())
return state->vpn_ip4_addr.to_string();
else
return "";
}
std::string vpn_ip6() const override
{
if (state->vpn_ip6_addr.specified())
return state->vpn_ip6_addr.to_string();
else
return "";
}
std::string vpn_gw4() const override
{
if (state->vpn_ip4_gw.specified())
return state->vpn_ip4_gw.to_string();
else
return "";
}
std::string vpn_gw6() const override
{
if (state->vpn_ip6_gw.specified())
return state->vpn_ip6_gw.to_string();
else
return "";
}
private:
void read()
{
TUN_RING* send_ring = ring_buffer->send_ring();
if (halt)
return;
ULONG head = send_ring->head.load(std::memory_order_acquire);
if (head >= WINTUN_RING_CAPACITY)
{
parent.tun_error(Error::TUN_ERROR, "ring head exceeds ring capacity");
return;
}
ULONG tail = send_ring->tail.load(std::memory_order_acquire);
if (tail >= WINTUN_RING_CAPACITY)
{
parent.tun_error(Error::TUN_ERROR, "ring tail exceeds ring capacity");
return;
}
while (true)
{
// tail has moved?
if (head == tail)
{
ring_buffer->send_tail_moved_asio_event().async_wait([self = Ptr(this)](const openvpn_io::error_code& error) {
if (!error)
self->read();
else
{
if (!self->halt)
self->parent.tun_error(Error::TUN_ERROR, "error waiting on ring send tail moved");
}
});
return;
}
// read buffer content
ULONG content_len = wrap(tail - head);
if (content_len < sizeof(TUN_PACKET_HEADER))
{
parent.tun_error(Error::TUN_ERROR, "incomplete packet header in send ring");
return;
}
TUN_PACKET* packet = (TUN_PACKET *)&send_ring->data[head];
if (packet->size > WINTUN_MAX_PACKET_SIZE)
{
parent.tun_error(Error::TUN_ERROR, "packet too big in send ring");
return;
}
ULONG aligned_packet_size = packet_align(sizeof(TUN_PACKET_HEADER) + packet->size);
if (aligned_packet_size > content_len)
{
parent.tun_error(Error::TUN_ERROR, "incomplete packet in send ring");
return;
}
frame->prepare(Frame::READ_TUN, buf);
buf.write(packet->data, packet->size);
head = wrap(head + aligned_packet_size);
send_ring->head.store(head, std::memory_order_release);
parent.tun_recv(buf);
if (halt)
return;
}
}
struct TUN_PACKET_HEADER
{
uint32_t size;
};
struct TUN_PACKET
{
uint32_t size;
UCHAR data[WINTUN_MAX_PACKET_SIZE];
};
ULONG packet_align(ULONG size)
{
return (size + (WINTUN_PACKET_ALIGN - 1)) & ~(WINTUN_PACKET_ALIGN - 1);
}
ULONG wrap(ULONG value)
{
return value & (WINTUN_RING_CAPACITY - 1);
}
openvpn_io::io_context& io_context;
TunPersist::Ptr tun_persist; // contains the TAP device HANDLE
ClientConfig::Ptr config;
TunClientParent& parent;
TunProp::State::Ptr state;
TunWin::SetupBase::Ptr tun_setup;
TUN_RING* receive_ring = nullptr;
TUN_RING* send_ring = nullptr;
BufferAllocated buf;
Frame::Ptr frame;
bool halt = false;
ScopedHANDLE driver_handle;
RingBuffer::Ptr ring_buffer;
};
}
}
+198
View File
@@ -0,0 +1,198 @@
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2018 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
//
// Name Resolution Policy Table (NRPT) utilities for Windows
#ifndef OPENVPN_TUN_WIN_NRPT_H
#define OPENVPN_TUN_WIN_NRPT_H
#include <string>
#include <sstream>
#include <vector>
#include <openvpn/common/exception.hpp>
#include <openvpn/common/string.hpp>
#include <openvpn/common/wstring.hpp>
#include <openvpn/common/action.hpp>
#include <openvpn/win/reg.hpp>
#include <openvpn/win/winerr.hpp>
namespace openvpn {
namespace TunWin {
// NRPT rules described here: https://msdn.microsoft.com/en-us/library/ff957356.aspx
class NRPT
{
public:
OPENVPN_EXCEPTION(nrpt_error);
static void create_rule(const std::vector<std::string> names, const std::vector<std::string> dns_servers)
{
Win::RegKey key;
for (auto i = 0; i < names.size(); ++ i)
{
// open/create the key
{
std::ostringstream ss;
ss << dnsPolicyConfig() << "\\" << policyPrefix() << "-" << i;
auto key_name = ss.str();
const LONG status = ::RegCreateKeyA(HKEY_LOCAL_MACHINE, key_name.c_str(), key.ref());
check_reg_error<nrpt_error>(status, key_name);
}
// Name
{
std::wstring name(wstring::from_utf8(names[i]));
name += L'\0';
const LONG status = ::RegSetValueExW(key(),
L"Name",
0,
REG_MULTI_SZ,
(const BYTE *)name.c_str(),
(name.length()+1)*2);
check_reg_error<nrpt_error>(status, "Name");
}
// GenericDNSServers
{
const std::wstring dns_servers_joined = wstring::from_utf8(string::join(dns_servers, ";"));
const LONG status = ::RegSetValueExW(key(),
L"GenericDNSServers",
0,
REG_SZ,
(const BYTE *)dns_servers_joined.c_str(),
(dns_servers_joined.length()+1)*2);
check_reg_error<nrpt_error>(status, "GenericDNSServers");
}
// ConfigOptions
{
const DWORD value = 0x8; // Only the Generic DNS server option (that is, the option defined in section 2.2.2.13) is specified.
const LONG status = ::RegSetValueExW(key(),
L"ConfigOptions",
0,
REG_DWORD,
(const BYTE *)&value,
sizeof(value));
check_reg_error<nrpt_error>(status, "ConfigOptions");
}
// Version
{
const DWORD value = 0x2;
const LONG status = ::RegSetValueExW(key(),
L"Version",
0,
REG_DWORD,
(const BYTE *)&value,
sizeof(value));
check_reg_error<nrpt_error>(status, "Version");
}
}
}
static bool delete_rule()
{
Win::RegKeyEnumerator keys(HKEY_LOCAL_MACHINE, dnsPolicyConfig());
for (const auto& key : keys)
{
// remove only own policies
if (key.find(policyPrefix()) == std::string::npos)
continue;
std::ostringstream ss;
ss << dnsPolicyConfig() << "\\" << key;
auto path = ss.str();
::RegDeleteTreeA(HKEY_LOCAL_MACHINE, path.c_str());
}
return true;
}
private:
static const char *dnsPolicyConfig()
{
static const char subkey[] = "SYSTEM\\CurrentControlSet\\Services\\Dnscache\\Parameters\\DnsPolicyConfig";
return subkey;
}
static const char *policyPrefix()
{
static const char prefix[] = "OpenVPNDNSRouting";
return prefix;
}
public:
class ActionCreate : public Action
{
public:
ActionCreate(const std::vector<std::string>& names_arg,
const std::vector<std::string>& dns_servers_arg)
: names(names_arg),
dns_servers(dns_servers_arg)
{
}
virtual void execute(std::ostream& log) override
{
log << to_string() << std::endl;
create_rule(names, dns_servers);
}
virtual std::string to_string() const override
{
std::ostringstream os;
os << "NRPT::ActionCreate"
<< " names=[" << string::join(names, ",") << "]"
<< " dns_servers=[" << string::join(dns_servers, ",") << "]";
return os.str();
}
private:
const std::vector<std::string> names;
const std::vector<std::string> dns_servers;
};
class ActionDelete : public Action
{
public:
virtual void execute(std::ostream& log) override
{
log << to_string() << std::endl;
delete_rule();
}
virtual std::string to_string() const override
{
return "NRPT::ActionDelete";
}
};
};
}
}
#endif
@@ -0,0 +1,172 @@
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2017 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
//
#pragma once
#include <Windows.h>
#include <string>
#include <type_traits>
#include <openvpn/buffer/bufhex.hpp>
#include <openvpn/common/rc.hpp>
#include <openvpn/win/scoped_handle.hpp>
#include <openvpn/win/event.hpp>
#define TUN_IOCTL_REGISTER_RINGS CTL_CODE(51820U, 0x970U, METHOD_BUFFERED, FILE_READ_DATA | FILE_WRITE_DATA)
#define TUN_IOCTL_FORCE_CLOSE_HANDLES CTL_CODE(51820U, 0x971U, METHOD_NEITHER, FILE_READ_DATA | FILE_WRITE_DATA)
#define WINTUN_RING_CAPACITY 0x800000
#define WINTUN_RING_TRAILING_BYTES 0x10000
#define WINTUN_RING_FRAMING_SIZE 12
#define WINTUN_MAX_PACKET_SIZE 0xffff
#define WINTUN_PACKET_ALIGN 4
namespace openvpn
{
namespace TunWin
{
struct TUN_RING {
std::atomic_ulong head;
std::atomic_ulong tail;
std::atomic_long alertable;
UCHAR data[WINTUN_RING_CAPACITY + WINTUN_RING_TRAILING_BYTES + WINTUN_RING_FRAMING_SIZE];
};
struct TUN_REGISTER_RINGS
{
struct
{
ULONG ring_size;
TUN_RING* ring;
HANDLE tail_moved;
} send, receive;
};
typedef openvpn_io::windows::object_handle AsioEvent;
class RingBuffer : public RC<thread_unsafe_refcount>
{
public:
typedef RCPtr<RingBuffer> Ptr;
RingBuffer(openvpn_io::io_context& io_context)
: send_ring_hmem(CreateFileMapping(INVALID_HANDLE_VALUE, NULL, PAGE_READWRITE, 0, sizeof(TUN_RING), NULL)),
receive_ring_hmem(CreateFileMapping(INVALID_HANDLE_VALUE, NULL, PAGE_READWRITE, 0, sizeof(TUN_RING), NULL)),
send_tail_moved_asio_event_(io_context)
{
// sanity checks
static_assert((sizeof(TUN_RING) - sizeof(TUN_RING::data)) == 12, "sizeof(TUN_RING) is expected to be 12");
#if !defined(ATOMIC_LONG_LOCK_FREE) || (ATOMIC_LONG_LOCK_FREE != 2)
#error Atomic long is expected to be always lock-free
#endif
send_ring_ = (TUN_RING*)MapViewOfFile(send_ring_hmem(), FILE_MAP_ALL_ACCESS, 0, 0, sizeof(TUN_RING));
receive_ring_ = (TUN_RING*)MapViewOfFile(receive_ring_hmem(), FILE_MAP_ALL_ACCESS, 0, 0, sizeof(TUN_RING));
send_tail_moved_asio_event_.assign(send_ring_tail_moved_());
}
RingBuffer(openvpn_io::io_context& io_context,
HANDLE client_process,
const std::string& send_ring_hmem_hex,
const std::string& receive_ring_hmem_hex,
const std::string& send_ring_tail_moved_hex,
const std::string& receive_ring_tail_moved_hex)
: send_tail_moved_asio_event_(io_context)
{
HANDLE remote_handle = BufHex::parse<HANDLE>(send_ring_hmem_hex, "send_ring_hmem");
HANDLE handle;
DuplicateHandle(client_process, remote_handle, GetCurrentProcess(), &handle, 0, FALSE, DUPLICATE_SAME_ACCESS);
send_ring_hmem.reset(handle);
remote_handle = BufHex::parse<HANDLE>(receive_ring_hmem_hex, "receive_ring_hmem");
DuplicateHandle(client_process, remote_handle, GetCurrentProcess(), &handle, 0, FALSE, DUPLICATE_SAME_ACCESS);
receive_ring_hmem.reset(handle);
remote_handle = BufHex::parse<HANDLE>(send_ring_tail_moved_hex, "send_ring_tail_moved");
DuplicateHandle(client_process, remote_handle, GetCurrentProcess(), &handle, 0, FALSE, DUPLICATE_SAME_ACCESS);
send_ring_tail_moved_.reset(handle);
remote_handle = BufHex::parse<HANDLE>(receive_ring_tail_moved_hex, "receive_ring_tail_moved");
DuplicateHandle(client_process, remote_handle, GetCurrentProcess(), &handle, 0, FALSE, DUPLICATE_SAME_ACCESS);
receive_ring_tail_moved_.reset(handle);
send_ring_ = (TUN_RING*)MapViewOfFile(send_ring_hmem(), FILE_MAP_ALL_ACCESS, 0, 0, sizeof(TUN_RING));
receive_ring_ = (TUN_RING*)MapViewOfFile(receive_ring_hmem(), FILE_MAP_ALL_ACCESS, 0, 0, sizeof(TUN_RING));
}
RingBuffer(RingBuffer const&) = delete;
RingBuffer& operator=(RingBuffer const&) = delete;
~RingBuffer()
{
UnmapViewOfFile(send_ring_);
UnmapViewOfFile(receive_ring_);
}
HANDLE send_ring_tail_moved()
{
return send_ring_tail_moved_();
}
HANDLE receive_ring_tail_moved()
{
return receive_ring_tail_moved_();
}
TUN_RING* send_ring()
{
return send_ring_;
}
TUN_RING* receive_ring()
{
return receive_ring_;
}
AsioEvent& send_tail_moved_asio_event()
{
return send_tail_moved_asio_event_;
}
#ifdef HAVE_JSON
void serialize(Json::Value& json)
{
json["send_ring_hmem"] = BufHex::render(send_ring_hmem());
json["receive_ring_hmem"] = BufHex::render(receive_ring_hmem());
json["send_ring_tail_moved"] = BufHex::render(send_ring_tail_moved());
json["receive_ring_tail_moved"] = BufHex::render(receive_ring_tail_moved());
}
#endif
protected:
Win::ScopedHANDLE send_ring_hmem;
Win::ScopedHANDLE receive_ring_hmem;
Win::Event send_ring_tail_moved_{FALSE};
Win::Event receive_ring_tail_moved_{FALSE};
AsioEvent send_tail_moved_asio_event_;
TUN_RING* send_ring_ = nullptr;
TUN_RING* receive_ring_ = nullptr;
};
}
}
File diff suppressed because it is too large Load Diff
+314
View File
@@ -0,0 +1,314 @@
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2017 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
#ifndef OPENVPN_TUN_WIN_WFP_H
#define OPENVPN_TUN_WIN_WFP_H
#include <ostream>
#include <openvpn/common/rc.hpp>
#include <openvpn/common/wstring.hpp>
#include <openvpn/common/action.hpp>
#include <openvpn/buffer/bufstr.hpp>
#include <openvpn/tun/win/tunutil.hpp>
#include <openvpn/win/winerr.hpp>
#include <fwpmu.h>
#include <fwpmtypes.h>
#include <iphlpapi.h>
namespace openvpn {
namespace TunWin {
class WFP : public RC<thread_unsafe_refcount>
{
public:
typedef RCPtr<WFP> Ptr;
OPENVPN_EXCEPTION(wfp_error);
// Block DNS from all apps except openvpn_app_path and
// from all interfaces except tap_index.
// Derived from https://github.com/ValdikSS/openvpn-with-patches/commit/3bd4d503d21aa34636e4f97b3e32ae0acca407f0
void block_dns(const std::wstring& openvpn_app_path,
const NET_IFINDEX tap_index,
std::ostream& log)
{
// WFP filter/conditions
FWPM_FILTER0 filter = {0};
FWPM_FILTER_CONDITION0 condition[2] = {0};
UINT64 filterid = 0;
// Get NET_LUID object for adapter
NET_LUID tap_luid = adapter_index_to_luid(tap_index);
// Get app ID
unique_ptr_del<FWP_BYTE_BLOB> openvpn_app_id_blob = get_app_id_blob(openvpn_app_path);
// Populate packet filter layer information
{
FWPM_SUBLAYER0 subLayer = {0};
subLayer.subLayerKey = subLayerGUID;
subLayer.displayData.name = L"OpenVPN";
subLayer.displayData.description = L"OpenVPN";
subLayer.flags = 0;
subLayer.weight = 0x100;
// Add packet filter to interface
const DWORD status = ::FwpmSubLayerAdd0(engineHandle(), &subLayer, NULL);
if (status != ERROR_SUCCESS)
OPENVPN_THROW(wfp_error, "FwpmSubLayerAdd0 failed with status=0x" << std::hex << status);
}
// Prepare filter
filter.subLayerKey = subLayerGUID;
filter.displayData.name = L"OpenVPN";
filter.weight.type = FWP_UINT8;
filter.weight.uint8 = 0xF;
filter.filterCondition = condition;
// Filter #1 -- permit IPv4 DNS requests from OpenVPN app
filter.layerKey = FWPM_LAYER_ALE_AUTH_CONNECT_V4;
filter.action.type = FWP_ACTION_PERMIT;
filter.numFilterConditions = 2;
condition[0].fieldKey = FWPM_CONDITION_IP_REMOTE_PORT;
condition[0].matchType = FWP_MATCH_EQUAL;
condition[0].conditionValue.type = FWP_UINT16;
condition[0].conditionValue.uint16 = 53;
condition[1].fieldKey = FWPM_CONDITION_ALE_APP_ID;
condition[1].matchType = FWP_MATCH_EQUAL;
condition[1].conditionValue.type = FWP_BYTE_BLOB_TYPE;
condition[1].conditionValue.byteBlob = openvpn_app_id_blob.get();
add_filter(&filter, NULL, &filterid);
log << "permit IPv4 DNS requests from OpenVPN app" << std::endl;
// Filter #2 -- permit IPv6 DNS requests from OpenVPN app
filter.layerKey = FWPM_LAYER_ALE_AUTH_CONNECT_V6;
add_filter(&filter, NULL, &filterid);
log << "permit IPv6 DNS requests from OpenVPN app" << std::endl;
// Filter #3 -- block IPv4 DNS requests from other apps
filter.layerKey = FWPM_LAYER_ALE_AUTH_CONNECT_V4;
filter.action.type = FWP_ACTION_BLOCK;
filter.weight.type = FWP_EMPTY;
filter.numFilterConditions = 1;
add_filter(&filter, NULL, &filterid);
log << "block IPv4 DNS requests from other apps" << std::endl;
// Filter #4 -- block IPv6 DNS requests from other apps
filter.layerKey = FWPM_LAYER_ALE_AUTH_CONNECT_V6;
add_filter(&filter, NULL, &filterid);
log << "block IPv6 DNS requests from other apps" << std::endl;
// Filter #5 -- allow IPv4 traffic from TAP
filter.layerKey = FWPM_LAYER_ALE_AUTH_CONNECT_V4;
filter.action.type = FWP_ACTION_PERMIT;
filter.numFilterConditions = 2;
condition[1].fieldKey = FWPM_CONDITION_IP_LOCAL_INTERFACE;
condition[1].matchType = FWP_MATCH_EQUAL;
condition[1].conditionValue.type = FWP_UINT64;
condition[1].conditionValue.uint64 = &tap_luid.Value;
add_filter(&filter, NULL, &filterid);
log << "allow IPv4 traffic from TAP" << std::endl;
// Filter #6 -- allow IPv6 traffic from TAP
filter.layerKey = FWPM_LAYER_ALE_AUTH_CONNECT_V6;
add_filter(&filter, NULL, &filterid);
log << "allow IPv6 traffic from TAP" << std::endl;
}
void reset(std::ostream& log)
{
engineHandle.reset(&log);
}
private:
class WFPEngine
{
public:
WFPEngine()
{
FWPM_SESSION0 session = {0};
// delete all filters when engine handle is closed
session.flags = FWPM_SESSION_FLAG_DYNAMIC;
const DWORD status = ::FwpmEngineOpen0(NULL, RPC_C_AUTHN_WINNT, NULL, &session, &handle);
if (status != ERROR_SUCCESS)
OPENVPN_THROW(wfp_error, "FwpmEngineOpen0 failed with status=0x" << std::hex << status);
}
void reset(std::ostream* log)
{
if (defined())
{
const DWORD status = ::FwpmEngineClose0(handle);
handle = NULL;
if (log)
{
if (status != ERROR_SUCCESS)
*log << "FwpmEngineClose0 failed, status=" << status << std::endl;
else
*log << "WFPEngine closed" << std::endl;
}
}
}
~WFPEngine()
{
reset(nullptr);
}
bool defined() const
{
return Win::Handle::defined(handle);
}
HANDLE operator()() const
{
return handle;
}
private:
WFPEngine(const WFPEngine&) = delete;
WFPEngine& operator=(const WFPEngine&) = delete;
HANDLE handle = NULL;
};
static GUID new_guid()
{
UUID ret;
const RPC_STATUS status = ::UuidCreate(&ret);
if (status != RPC_S_OK && status != RPC_S_UUID_LOCAL_ONLY)
throw wfp_error("UuidCreate failed");
return ret;
}
static NET_LUID adapter_index_to_luid(const NET_IFINDEX index)
{
NET_LUID tap_luid;
const NETIO_STATUS ret = ::ConvertInterfaceIndexToLuid(index, &tap_luid);
if (ret != NO_ERROR)
throw wfp_error("ConvertInterfaceIndexToLuid failed");
return tap_luid;
}
static unique_ptr_del<FWP_BYTE_BLOB> get_app_id_blob(const std::wstring& app_path)
{
FWP_BYTE_BLOB *blob;
const DWORD status = ::FwpmGetAppIdFromFileName0(app_path.c_str(), &blob);
if (status != ERROR_SUCCESS)
OPENVPN_THROW(wfp_error, "FwpmGetAppIdFromFileName0 failed, status=0x" << std::hex << status);
return unique_ptr_del<FWP_BYTE_BLOB>(blob, [](FWP_BYTE_BLOB* blob) {
::FwpmFreeMemory0((void**)&blob);
});
}
void add_filter(const FWPM_FILTER0 *filter,
PSECURITY_DESCRIPTOR sd,
UINT64 *id)
{
const DWORD status = ::FwpmFilterAdd0(engineHandle(), filter, sd, id);
if (status != ERROR_SUCCESS)
OPENVPN_THROW(wfp_error, "FwpmFilterAdd0 failed, status=0x" << std::hex << status);
}
const GUID subLayerGUID{new_guid()};
WFPEngine engineHandle;
};
class WFPContext : public RC<thread_unsafe_refcount>
{
public:
typedef RCPtr<WFPContext> Ptr;
private:
friend class ActionWFP;
void block(const std::wstring& openvpn_app_path,
const NET_IFINDEX tap_index,
std::ostream& log)
{
unblock(log);
wfp.reset(new WFP());
wfp->block_dns(openvpn_app_path, tap_index, log);
}
void unblock(std::ostream& log)
{
if (wfp)
{
wfp->reset(log);
wfp.reset();
}
}
WFP::Ptr wfp;
};
class ActionWFP : public Action
{
public:
ActionWFP(const std::wstring& openvpn_app_path_arg,
const NET_IFINDEX tap_index_arg,
const bool enable_arg,
const WFPContext::Ptr& wfp_arg)
: openvpn_app_path(openvpn_app_path_arg),
tap_index(tap_index_arg),
enable(enable_arg),
wfp(wfp_arg)
{
}
virtual void execute(std::ostream& log) override
{
log << to_string() << std::endl;
if (enable)
wfp->block(openvpn_app_path, tap_index, log);
else
wfp->unblock(log);
}
virtual std::string to_string() const override
{
return "ActionWFP openvpn_app_path=" + wstring::to_utf8(openvpn_app_path) + " tap_index=" + std::to_string(tap_index) + " enable=" + std::to_string(enable);
}
private:
const std::wstring openvpn_app_path;
const NET_IFINDEX tap_index;
const bool enable;
WFPContext::Ptr wfp;
};
}
}
#endif
@@ -0,0 +1,182 @@
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2017 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
//
// proxy settings for Windows
#pragma once
#include <WinInet.h>
#include <openvpn\win\impersonate.hpp>
#include <openvpn\tun\proxy.hpp>
#include <openvpn\win\reg.hpp>
using namespace openvpn::Win;
namespace openvpn {
namespace TunWin {
class WinProxySettings : public ProxySettings {
public:
typedef RCPtr<WinProxySettings> Ptr;
WinProxySettings(const TunBuilderCapture::ProxyAutoConfigURL& config_arg)
: ProxySettings(config_arg) { }
void set_proxy(bool del) override
{
Impersonate imp{false};
LONG status;
RegKey hkcu;
RegKey key;
status = ::RegOpenCurrentUser(KEY_QUERY_VALUE | KEY_SET_VALUE, hkcu.ref());
check_reg_error<proxy_error>(status, "RegOpenCurrentUser");
status = ::RegCreateKeyExA(hkcu(), key_name, 0, NULL, 0, KEY_QUERY_VALUE | KEY_SET_VALUE, NULL, key.ref(), NULL);
check_reg_error<proxy_error>(status, key_name);
if (!del)
{
save_key(key, "AutoConfigURL", config.url, true);
save_key(key, "ProxyEnable", "0", false);
}
else
{
restore_key(key, "AutoConfigURL", true);
restore_key(key, "ProxyEnable", false);
}
// WinInet API cannot be called from service, even via impersonation
if (!imp.is_local_system())
{
OPENVPN_LOG("Refresh proxy settings");
InternetSetOptionA(NULL, INTERNET_OPTION_SETTINGS_CHANGED, NULL, 0);
InternetSetOptionA(NULL, INTERNET_OPTION_REFRESH, NULL, 0);
}
}
private:
void restore_key(Win::RegKey& regkey, const std::string& key, bool str)
{
LONG status;
char prev_val_str[1024] = { 0 }; // should be enough to fit proxy URL
DWORD prev_val_dword;
DWORD prev_buf_size = str ? sizeof(prev_val_str) : sizeof(prev_val_dword);
bool del = false;
Win::RegKey hkcu;
status = ::RegOpenCurrentUser(KEY_QUERY_VALUE | KEY_SET_VALUE, hkcu.ref());
check_reg_error<proxy_error>(status, "RegOpenCurrentUser");
// get previous value
std::string prev_key_name = sname + key;
status = ::RegGetValueA(hkcu(),
key_name,
prev_key_name.c_str(),
str ? RRF_RT_REG_SZ : RRF_RT_REG_DWORD,
NULL,
str ? (PVOID)prev_val_str : (PVOID)&prev_val_dword,
&prev_buf_size);
check_reg_error<proxy_error>(status, prev_key_name);
RegDeleteValueA(regkey(), prev_key_name.c_str());
// check if previous value needs to be deleted
if (str)
del = strcmp(delete_value_str, prev_val_str) == 0;
else
del = prev_val_dword == delete_value_dword;
if (del)
::RegDeleteValueA(regkey(), key.c_str());
else
::RegSetValueExA(regkey(),
key.c_str(),
0,
str ? REG_SZ : REG_DWORD,
str ? (const BYTE *)prev_val_str : (CONST BYTE *)&prev_val_dword,
str ? strlen(prev_val_str) + 1 : sizeof(prev_val_dword));
}
void save_key(Win::RegKey& regkey, const std::string& key, const std::string& value, bool str)
{
LONG status;
char prev_val_str[1024] = { 0 }; // should be enought to fit proxy URL
DWORD prev_val_dword;
DWORD prev_buf_size = str ? sizeof(prev_val_str) : sizeof(prev_val_dword);
Win::RegKey hkcu;
status = ::RegOpenCurrentUser(KEY_QUERY_VALUE | KEY_SET_VALUE, hkcu.ref());
check_reg_error<proxy_error>(status, "RegOpenCurrentUser");
// get original value
status = ::RegGetValueA(hkcu(),
key_name,
key.c_str(),
str ? RRF_RT_REG_SZ : RRF_RT_REG_DWORD,
NULL,
str ? (PVOID)prev_val_str : (PVOID)&prev_val_dword,
&prev_buf_size);
switch (status)
{
case ERROR_FILE_NOT_FOUND:
// mark that original value doesn't exist
strcpy(prev_val_str, delete_value_str);
prev_val_dword = delete_value_dword;
case ERROR_SUCCESS:
break;
default:
check_reg_error<proxy_error>(status, key);
break;
}
// save original value
std::string prev_key_name = sname + key;
status = ::RegSetValueExA(regkey(),
prev_key_name.c_str(),
0,
str ? REG_SZ : REG_DWORD,
str ? (const BYTE *)prev_val_str : (CONST BYTE *)&prev_val_dword,
str ? strlen(prev_val_str) + 1 : sizeof(DWORD));
check_reg_error<proxy_error>(status, prev_key_name);
// save new value
DWORD val_dword = 0;
if (!str)
val_dword = std::atol(value.c_str());
status = ::RegSetValueExA(regkey(),
key.c_str(),
0,
str ? REG_SZ : REG_DWORD,
str ? (const BYTE *)value.c_str() : (CONST BYTE *)&val_dword,
str ? value.length() + 1 : sizeof(val_dword));
check_reg_error<proxy_error>(status, key);
}
const char* key_name = "Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings";
const char* delete_value_str = "DeleteValue";
const DWORD delete_value_dword = 0xCAFEBABE;
};
}
}