Skip to content
NCD scripting language, tun2socks proxifier, P2P VPN
C C++ PHP Yacc CMake Roff Other
Branch: shadowsocks-an…
Clone or download
Pull request Compare This branch is 20 commits ahead, 1 commit behind ambrop72:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
arpprobe Use badvpn_add_library for all internal libraries. Oct 15, 2014
base Merge branch 'master' into shadowsocks-android Feb 1, 2019
blog_generator port to compile with MSVC Jul 24, 2012
bproto port to compile with MSVC Jul 24, 2012
bproto_generator bproto_generator: fix aliasing issues Dec 30, 2012
client Assume that NSS headers are under nss/. Dec 30, 2018
cmake/modules Assume that NSS headers are under nss/. Dec 30, 2018
dhcpclient Use badvpn_add_library for all internal libraries. Oct 15, 2014
dostest add some programs for playing with DoS attacks on TCP Sep 3, 2012
examples ncd: Store the NCDStingIndex pointer in NCDValMem. May 8, 2015
flooder Use GNUInstallDirs for controlling install destinations May 24, 2016
flow compile PIC versions of internal libraries, to be used by NCD plugins Mar 13, 2013
flowextra Use badvpn_add_library for all internal libraries. Oct 15, 2014
generated ncd: Permit functions with have zero arguments. Jan 22, 2015
lemon Add NCD, the Network Configuration Daemon Dec 10, 2010
lime Initial import Oct 25, 2010
lwip Merge branch 'master' into shadowsocks-android Feb 1, 2019
misc Assume that NSS headers are under nss/. Dec 30, 2018
ncd-request
ncd NCD: Fix evdev event code names with newer headers. Aug 27, 2016
nspr_support Assume that NSS headers are under nss/. Dec 30, 2018
predicate Use badvpn_add_library for all internal libraries. Oct 15, 2014
protocol Use standard __ANDROID__ preprocessor macro May 16, 2017
random Use badvpn_add_library for all internal libraries. Oct 15, 2014
scripts scripts/copy_nss: copy programs too Jan 28, 2011
security Use badvpn_add_library for all internal libraries. Oct 15, 2014
server Assume that NSS headers are under nss/. Dec 30, 2018
server_connection Assume that NSS headers are under nss/. Dec 30, 2018
socksclient Use badvpn_add_library for all internal libraries. Oct 15, 2014
stringmap Use badvpn_add_library for all internal libraries. Oct 15, 2014
structure structure: Vector: Reduce interface. Nov 9, 2014
system Fixes for Visual Studio 2017. Dec 30, 2018
tests get rid of some warnings Sep 1, 2012
threadwork Fix possible compile error after switch to pthread_sigmask. Sep 6, 2016
tun2socks Indentify DNS query packets in tun2socks Apr 9, 2019
tuntap Fix TUN/TAP initialization with newer TAP-Windows. Nov 13, 2016
udevmonitor Use badvpn_add_library for all internal libraries. Oct 15, 2014
udpgw Use GNUInstallDirs for controlling install destinations May 24, 2016
udpgw_client Use badvpn_add_library for all internal libraries. Oct 15, 2014
BUILD-WINDOWS-VisualStudio.md New Windows build instructions using VS. Dec 30, 2018
BUILD-WINDOWS.md Replace windows build instructions with VS/CMake Jan 2, 2018
CMakeLists.txt Fixes for Visual Studio 2017. Dec 30, 2018
COPYING switch to using the New BSD License Jan 27, 2012
ChangeLog version 1.999.130 Apr 9, 2015
README.md New Windows build instructions using VS. Dec 30, 2018
badvpn-win32.nix Finishing Nix build method for Windows. Nov 18, 2016
badvpn.7 switch to using the New BSD License Jan 27, 2012
badvpn.nix Nix expressions: Separate the package function from the composition. Jan 24, 2015
blog_channels.txt
build-win32.nix Finishing Nix build method for Windows. Nov 18, 2016
build.nix Nix expressions: Separate the package function from the composition. Jan 24, 2015
compile-tun2socks.sh Fixup compile-tun2socks.sh, fix name Sep 26, 2017
compile-udpgw.sh Fix udpgw compile script as well Jul 27, 2017
fix_flex.php port to compile with MSVC Jul 24, 2012
generate_files ncd: rename NCDValue{Generator,Parser} to NCDVal{Generator,Parser} Oct 5, 2012

README.md

BadVPN

Introduction

In this project I host some of my open-source networking software. All of the software is written in C and utilizes a custom-developed framework for event-driven programming. The extensive code sharing is the reason all the software is packaged together. However, it is possible to compile only the required components to avoid extra dependencies.

NCD programming language

NCD (Network Configuration Daemon) is a daemon and programming/scripting language for configuration of network interfaces and other aspects of the operating system. It implements various functionalities as built-in modules, which may be used from an NCD program wherever and for whatever purpose the user needs them. This modularity makes NCD extremely flexible and extensible. It does a very good job with hotplugging in various forms, like USB network interfaces and link detection for wired devices. New features can be added by implementing statements as C-language modules using a straightforward interface.

Tun2socks network-layer proxifier

The tun2socks program "socksifes" TCP connections at the network layer. It implements a TUN device which accepts all incoming TCP connections (regardless of destination IP), and forwards the connections through a SOCKS server. This allows you to forward all connections through SOCKS, without any need for application support. It can be used, for example, to forward connections through a remote SSH server.

Peer-to-peer VPN

The VPN part of this project implements a Layer 2 (Ethernet) network between the peers (VPN nodes). The peers connect to a central server which acts as a communication proxy allowing the peers to establish direct connections between each other (data connections). These connections are used for transferring network data (Ethernet frames), and can be secured with a multitude of mechanisms. Notable features are:

  • UDP and TCP transport
  • Converges very quickly after a new peer joins
  • IGMP snooping to deliver multicasts efficiently (e.g. for IPTV)
  • Double SSL: if SSL is enabled, not only do peers connect to the server with SSL, but they use an additional layer of SSL when exchanging messages through the server
  • Features related to the NAT problem:
    • Can work with multiple layers of NAT (needs configuration)
    • Local peers inside a NAT can communicate directly
    • Relaying as a fallback (needs configuration)

Requirements

NCD only works on Linux. Tun2socks works on Linux and Windows. The P2P VPN works on Linux, Windows and FreeBSD (not tested often).

Installation

The build system is based on CMake. On Linux, the following commands can be used to build:

cd <badvpn-source-dir>
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=<install-dir>
make install

If you only need tun2socks or udpgw, then add the following arguments to the cmake command: -DBUILD_NOTHING_BY_DEFAULT=1 -DBUILD_TUN2SOCKS=1 -DBUILD_UDPGW=1. Otherwise (if you want the VPN software), you will first need to install the OpenSSL and NSS libraries and make sure that CMake can find them.

Windows builds are not provided. You can build from source code using Visual Studio by following the instructions in the file BUILD-WINDOWS-VisualStudio.md.

License

The BSD 3-clause license as shown below applies to most of the code.

Copyright (c) 2009, Ambroz Bizjak <ambrop7@gmail.com>
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. Neither the name of the author nor the
   names of its contributors may be used to endorse or promote products
   derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

List of third-party code included in the source:

  • lwIP - A Lightweight TCP/IP stack. License: lwip/COPYING
You can’t perform that action at this time.