diff --git a/.cargo/config b/.cargo/config index f799a0b..9fdfc12 100644 --- a/.cargo/config +++ b/.cargo/config @@ -1,5 +1,9 @@ [target.armv7-unknown-linux-gnueabihf] linker = "arm-linux-gnueabihf-gcc" +objcopy = { path = "arm-linux-gnueabihf-objcopy" } +strip = { path = "arm-linux-gnueabihf-strip" } [target.arm-unknown-linux-gnueabihf] linker = "arm-linux-gnueabihf-gcc" +objcopy = { path = "arm-linux-gnueabihf-objcopy" } +strip = { path = "arm-linux-gnueabihf-strip" } diff --git a/Cargo.toml b/Cargo.toml index 19532c1..be48b6a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -46,3 +46,19 @@ lto = false [profile.test] lto = false + +[package.metadata.deb] +extended-description = """\ + VpnCloud is a simple VPN over UDP. It creates a virtual network interface on + the host and forwards all received data via UDP to the destination. VpnCloud + establishes a fully-meshed VPN network in a peer-to-peer manner. It can work + on TUN devices (IP based) and TAP devices (Ethernet based).""" +license-file = ["LICENSE.md", "1"] +changelog = "assets/changelog.txt" +section = "net" +assets = [ + ["target/release/vpncloud", "/usr/bin/vpncloud", "755"], + ["assets/example.net.disabled", "/etc/vpncloud/example.net.disabled", "600"], + ["assets/vpncloud@.service", "/lib/systemd/system/vpncloud@.service", "644"], + ["target/vpncloud.1.gz", "/usr/share/man/man1/vpncloud.1.gz", "644"] +] diff --git a/README.md b/README.md index 3f02652..6793bcc 100644 --- a/README.md +++ b/README.md @@ -36,29 +36,46 @@ somewhat stable state. VpnCloud features the following functionality: ### Installing -##### Compiling from source -Prerequisites: Git, [Cargo](https://www.rust-lang.org/install.html), - Full C build environment including autotools (for building libsodium) +#### Compiling from source +Prerequisites: Git, [Cargo](https://www.rust-lang.org/install.html), Ronn + +The checked-out code can be compiled with ``cargo build`` or ``cargo build --release`` (release version). The binary could then be found in `target/release/vpncloud`. -The checked-out code can be compiled with ``make``. -The binary could then be found in `target/release/vpncloud`. The tests can be run via ``cargo test``. -##### Debian / Ubuntu +#### Cross-Compiling +This software can be cross-compiled for a number of different architectures. +Please also see the [extended rust cross compilation docs](https://github.com/japaric/rust-cross). + +##### ARMv7 (e.g. Raspberry Pi) +1. Install the Cargo target + + $> rustup target add armv7-unknown-linux-gnueabihf + +2. Install the required build environment (on Ubuntu) + + $> sudo apt-get install -qq gcc-arm-linux-gnueabihf + +3. Build the software + + $> cargo build --release --target=armv7-unknown-linux-gnueabihf + +#### Debian / Ubuntu Deb packages for each release can be found in the [releases](https://github.com/dswd/vpncloud/releases) section. Currently only packages for amd64 are available (I am accepting help on building and packaging for other platforms). +Debian packages can be built using [cargo-deb](https://github.com/mmstick/cargo-deb): ``cargo deb`` -##### Arch Linux (AUR) + +#### Arch Linux (AUR) There is a [VpnCloud package for Arch Linux](https://aur.archlinux.org/packages/vpncloud/) thanks to Oscar Rainford (fourbytes). ### Contributions welcome - There are several areas in which still some work has to be done and where contributions are very welcome: @@ -72,7 +89,6 @@ contributions are very welcome: ### Semantic Versioning - This project uses [semantic versioning](http://semver.org). Currently that means that everything can change between versions before 1.0 is finally released. However I am considering to release 1.0 soon. diff --git a/deb/vpncloud/debian/changelog b/assets/changelog.txt similarity index 100% rename from deb/vpncloud/debian/changelog rename to assets/changelog.txt diff --git a/deb/vpncloud/example.net.disabled b/assets/example.net.disabled similarity index 100% rename from deb/vpncloud/example.net.disabled rename to assets/example.net.disabled diff --git a/assets/vpncloud.1 b/assets/vpncloud.1 new file mode 100644 index 0000000..ccc69a5 --- /dev/null +++ b/assets/vpncloud.1 @@ -0,0 +1,414 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "VPNCLOUD" "1" "February 2019" "" "" +. +.SH "NAME" +\fBvpncloud\fR \- Peer\-to\-peer VPN +. +.SH "SYNOPSIS" +\fBvpncloud [options] [\-\-config ] [\-t ] [\-d ] [\-l ] [\-c \.\.\.]\fR +. +.SH "OPTIONS" +. +.TP +\fB\-\-config \fR: +. +.IP +Read configuration options from the specified file\. Please see the section \fBCONFIG FILES\fR for documentation on the file format\. If the same option is defined in the config file and as a parameter, the parameter overrides the config file\. +. +.TP +\fB\-t \fR, \fB\-\-type \fR: +. +.IP +Set the type of network\. There are two options: \fBtap\fR devices process Ethernet frames \fBtun\fR devices process IP packets\. [default: \fBtap\fR] +. +.TP +\fB\-d \fR, \fB\-\-device \fR: +. +.IP +Name of the virtual device\. Any \fB%d\fR will be filled with a free number\. [default: \fBvpncloud%d\fR] +. +.TP +\fB\-\-device\-path \fR: +. +.IP +The path of the base device inode, e\.g\. /dev/net/run\. +. +.TP +\fB\-m \fR, \fB\-\-mode \fR: +. +.IP +The mode of the VPN\. The VPN can like a router, a switch or a hub\. A \fBhub\fR will send all data always to all peers\. A \fBswitch\fR will learn addresses from incoming data and only send data to all peers when the address is unknown\. A \fBrouter\fR will send data according to known subnets of the peers and ignore them otherwise\. The \fBnormal\fR mode is switch for tap devices and router for tun devices\. [default: \fBnormal\fR] +. +.TP +\fB\-l \fR, \fB\-\-listen \fR: +. +.IP +The port number on which to listen for data\. [default: \fB3210\fR] +. +.TP +\fB\-c \fR, \fB\-\-connect \fR: +. +.IP +Address of a peer to connect to\. The address should be in the form \fBaddr:port\fR\. If the node is not started, the connection will be retried periodically\. This parameter can be repeated to connect to multiple peers\. +. +.TP +\fB\-s \fR, \fB\-\-subnet \fR: +. +.IP +The local subnets to use\. This parameter should be in the form \fBaddress/prefixlen\fR where address is an IPv4 address, an IPv6 address, or a MAC address\. The prefix length is the number of significant front bits that distinguish the subnet from other subnets\. Example: \fB10\.1\.1\.0/24\fR\. +. +.TP +\fB\-\-shared\-key \fR: +. +.IP +An optional shared key to encrypt the VPN data\. If this option is not set, the traffic will be sent unencrypted\. +. +.TP +\fB\-\-crypto \fR: +. +.IP +The encryption method to use ("aes256", or "chacha20")\. Most current CPUs have special support for AES256 so this should be faster\. For older computers lacking this support, only CHACHA20 is supported\. [default: \fBchacha20\fR] +. +.TP +\fB\-\-magic \fR: +. +.IP +Override the 4\-byte magic header of each packet\. This header identifies the network and helps to distinguish it from other networks and other applications\. The id can either be a 4 byte / 8 character hexadecimal string or an arbitrary string prefixed with "hash:" which will then be hashed into 4 bytes\. +. +.TP +\fB\-\-peer\-timeout \fR: +. +.IP +Peer timeout in seconds\. The peers will exchange information periodically and drop peers that are silent for this period of time\. [default: \fB1800\fR] +. +.TP +\fB\-\-dst\-timeout \fR: +. +.IP +Switch table entry timeout in seconds\. This parameter is only used in switch mode\. Addresses that have not been seen for the given period of time will be forgotten\. [default: \fB300\fR] +. +.TP +\fB\-\-ifup \fR: +. +.IP +A command to setup the network interface\. The command will be run (as parameter to \fBsh \-c\fR) when the device has been created to configure it\. The name of the allocated device will be available via the environment variable \fBIFNAME\fR\. Please note that this command is executed with the full permissions of the caller\. +. +.TP +\fB\-\-ifdown \fR: +. +.IP +A command to bring down the network interface\. The command will be run (as parameter to \fBsh \-c\fR) to remove any configuration from the device\. The name of the allocated device will be available via the environment variable \fBIFNAME\fR\. Please note that this command is executed with the (limited) permissions of the user and group given as \fB\-\-user\fR and \fB\-\-group\fR\. +. +.TP +\fB\-\-pid\-file \fR: +. +.IP +Store the process id in this file when running in the background\. If set, the given file will be created containing the process id of the new background process\. This option is only used when running in background\. +. +.TP +\fB\-\-user \fR: + +. +.TP +\fB\-\-group \fR: +. +.IP +Change the user and/or group of the process once all the setup has been done and before spawning the background process\. This option is only used when running in background\. +. +.TP +\fB\-\-log\-file \fR: +. +.IP +If set, print logs also to the given file\. The file will be created and truncated if is exists\. +. +.TP +\fB\-\-stats\-file \fR: +. +.IP +If set, periodically write statistics on peers and current traffic to the given file\. The file will be periodically overwritten with new data\. +. +.TP +\fB\-\-daemon\fR: +. +.IP +Spawn a background process instead of running the process in the foreground\. If this flag is set, the process will first carry out all the initialization, then drop permissions if \fB\-\-user\fR or \fB\-\-group\fR is used and then spawn a background process and write its process id to a file if \fB\-\-pid\-file\fR is set\. Then, the main process will exit and the background process continues to provide the VPN\. At the time, when the main process exits, the interface exists and is properly configured to be used\. +. +.TP +\fB\-\-no\-port\-forwarding\fR: +. +.IP +Disable automatic port forward\. If this option is not set, VpnCloud tries to detect a NAT router and automatically add a port forwarding to it\. +. +.TP +\fB\-v\fR, \fB\-\-verbose\fR: +. +.IP +Print debug information, including information for data being received and sent\. +. +.TP +\fB\-q\fR, \fB\-\-quiet\fR: +. +.IP +Only print errors and warnings\. +. +.TP +\fB\-h\fR, \fB\-\-help\fR: +. +.IP +Display the help\. +. +.SH "DESCRIPTION" +\fBVpnCloud\fR is a simple VPN over UDP\. It creates a virtual network interface on the host and forwards all received data via UDP to the destination\. It can work in 3 different modes: +. +.IP "\(bu" 4 +\fBSwitch mode\fR: In this mode, the VPN will dynamically learn addresses as they are used as source addresses and use them to forward data to its destination\. Addresses that have not been seen for some time (option \fBdst_timeout\fR) will be forgotten\. Data for unknown addresses will be broadcast to all peers\. This mode is the default mode for TAP devices that process Ethernet frames but it can also be used with TUN devices and IP packets\. +. +.IP "\(bu" 4 +\fBHub mode\fR: In this mode, all data will always be broadcast to all peers\. This mode uses lots of bandwidth and should only be used in special cases\. +. +.IP "\(bu" 4 +\fBRouter mode\fR: In this mode, data will be forwarded based on preconfigured address ranges ("subnets")\. Data for unknown nodes will be silently ignored\. This mode is the default mode for TUN devices that work with IP packets but it can also be used with TAP devices and Ethernet frames\. +. +.IP "" 0 +. +.P +All connected VpnCloud nodes will form a peer\-to\-peer network and cross\-connect automatically until the network is fully connected\. The nodes will periodically exchange information with the other nodes to signal that they are still active and to allow the automatic cross\-connect behavior\. There are some important things to note: +. +.IP "\(bu" 4 +To avoid that different networks that reuse each others addresses merge due to the cross\-connect behavior, the \fBmagic\fR option can be used and set to any unique string to identify the network\. The \fBmagic\fR must be the same on all nodes of the same VPN network\. +. +.IP "\(bu" 4 +The cross\-connect behavior can be able to connect nodes that are behind firewalls or NATs as it can function as hole\-punching\. +. +.IP "\(bu" 4 +The management traffic will increase with the peer number quadratically\. It should still be reasonably small for high node numbers (below 10 KiB/s for 10\.000 nodes)\. A longer \fBpeer_timeout\fR can be used to reduce the traffic further\. For high node numbers, router mode should be used as it never broadcasts data\. +. +.IP "" 0 +. +.P +VpnCloud does not implement any loop\-avoidance\. Since data received on the UDP socket will only be sent to the local network interface and vice versa, VpnCloud cannot produce loops on its own\. On the TAP device, however STP data can be transported to avoid loops caused by other network components\. +. +.P +For TAP devices, IEEE 802\.1q frames (VLAN tagged) are detected and forwarded based on separate MAC tables\. Any nested tags (Q\-in\-Q) will be ignored\. +. +.SH "EXAMPLES" +. +.SS "Switched TAP scenario" +In the example scenario, a simple layer 2 network tunnel is established\. Most likely those commands need to be run as \fBroot\fR using \fBsudo\fR\. +. +.P +First, VpnCloud need to be started on both nodes (the address after \fB\-c\fR is the address of the remote node and the the \fBX\fR in the interface address must be unique among all nodes, e\.g\. 0, 1, 2, \.\.\.): +. +.IP "" 4 +. +.nf + +vpncloud \-c REMOTE_HOST:PORT \-\-ifup \'ifconfig $IFNAME 10\.0\.0\.X/24 mtu 1400 up\' +. +.fi +. +.IP "" 0 +. +.P +Afterwards, the interface can be used to communicate\. +. +.SS "Routed TUN example" +In this example, 2 nodes and their subnets should communicate using IP\. First, VpnCloud need to be started on both nodes: +. +.IP "" 4 +. +.nf + +vpncloud \-t tun \-c REMOTE_HOST:PORT \-\-subnet 10\.0\.X\.0/24 \-\-ifup \'ifconfig $IFNAME 10\.0\.X\.1/16 mtu 1400 up\' +. +.fi +. +.IP "" 0 +. +.P +It is important to configure the interface in a way that all addresses on the VPN can be reached directly\. E\.g\. if subnets 10\.0\.1\.0/24, 10\.0\.2\.0/24 and so on are used, the interface needs to be configured as 10\.0\.1\.1/16\. For TUN devices, this means that the prefix length of the subnets (/24 in this example) must be different than the prefix length that the interface is configured with (/16 in this example)\. +. +.SS "Important notes" +. +.IP "\(bu" 4 +VpnCloud can be used to connect two separate networks\. TAP networks can be bridged using \fBbrctl\fR and TUN networks must be routed\. It is very important to be careful when setting up such a scenario in order to avoid network loops, security issues, DHCP issues and many more problems\. +. +.IP "\(bu" 4 +TAP devices will forward DHCP data\. If done intentionally, this can be used to assign unique addresses to all participants\. If this happens accidentally, it can conflict with DHCP servers of the local network and can have severe side effects\. +. +.IP "\(bu" 4 +VpnCloud is not designed for high security use cases\. Although the used crypto primitives are expected to be very secure, their application has not been reviewed\. The shared key is hashed using \fIScryptSalsa208Sha256\fR to derive a key, which is used to encrypt the payload of messages using \fIChaCha20Poly1305\fR or \fIAES256\-GCM\fR\. The encryption includes an authentication that also protects the header\. This method does only protect against attacks on single messages but not against attacks that manipulate the message series itself (i\.e\. suppress messages, reorder them, or duplicate them)\. +. +.IP "" 0 +. +.SH "CONFIG FILES" +The config file is a YAML file that contains configuration values\. All entries are optional and override the defaults\. Please see the section \fBOPTIONS\fR for detailed descriptions of the options\. +. +.IP "\(bu" 4 +\fBdevice_type\fR: Set the type of network\. Same as \fB\-\-type\fR +. +.IP "\(bu" 4 +\fBdevice_name\fR: Name of the virtual device\. Same as \fB\-\-device\fR +. +.IP "\(bu" 4 +\fBdevice_path\fR: Set the path of the base device\. Same as \fB\-\-device\-path\fR +. +.IP "\(bu" 4 +\fBifup\fR: A command to setup the network interface\. Same as \fB\-\-ifup\fR +. +.IP "\(bu" 4 +\fBifdown\fR: A command to bring down the network interface\. Same as \fB\-\-ifdown\fR +. +.IP "\(bu" 4 +\fBcrypto\fR: The encryption method to use\. Same as \fB\-\-crypto\fR +. +.IP "\(bu" 4 +\fBshared_key\fR: The shared key to encrypt all traffic\. Same as \fB\-\-shared\-key\fR +. +.IP "\(bu" 4 +\fBmagic\fR: Override the 4\-byte magic header of each packet\. Same as \fB\-\-magic\fR +. +.IP "\(bu" 4 +\fBport\fR: The port number on which to listen for data\. Same as \fB\-\-listen\fR +. +.IP "\(bu" 4 +\fBpeers\fR: A list of addresses to connect to\. See \fB\-\-connect\fR +. +.IP "\(bu" 4 +\fBpeer_timeout\fR: Peer timeout in seconds\. Same as\fB\-\-peer\-timeout\fR +. +.IP "\(bu" 4 +\fBmode\fR: The mode of the VPN\. Same as \fB\-\-mode\fR +. +.IP "\(bu" 4 +\fBdst_timeout\fR: Switch table entry timeout in seconds\. Same as \fB\-\-dst\-timeout\fR +. +.IP "\(bu" 4 +\fBsubnets\fR: A list of local subnets to use\. See \fB\-\-subnet\fR +. +.IP "\(bu" 4 +\fBport_forwarding\fR: Whether to activate port forwardig\. See \fB\-\-no\-port\-forwarding\fR +. +.IP "\(bu" 4 +\fBuser\fR: The name of a user to run the background process under\. See \fB\-\-user\fR +. +.IP "\(bu" 4 +\fBgroup\fR: The name of a group to run the background process under\. See \fB\-\-group\fR +. +.IP "\(bu" 4 +\fBpid_file\fR: The path of the pid file to create\. See \fB\-\-pid\-file\fR +. +.IP "\(bu" 4 +\fBstats_file\fR: The path of the statistics file\. See \fB\-\-stats\-file\fR +. +.IP "" 0 +. +.SS "Example" +device_type: tun device_name: vpncloud%d ifup: ifconfig $IFNAME 10\.0\.1\.1/16 mtu 1400 up crypto: aes256 shared_key: mysecret port: 3210 peers: \- remote\.machine\.foo:3210 \- remote\.machine\.bar:3210 peer_timeout: 1800 mode: normal subnets: \- 10\.0\.1\.0/24 port_forwarding: true user: nobody group: nogroup pid_file: /run/vpncloud\.pid +. +.SH "NETWORK PROTOCOL" +The protocol of VpnCloud is kept as simple as possible to allow other implementations and to maximize the performance\. +. +.P +Every packet sent over UDP contains the following header (in order): +. +.IP "\(bu" 4 +4 bytes \fBmagic\fR +. +.IP +This field is used to identify the packet and to sort out packets that do not belong\. The default is \fB[0x76, 0x70, 0x6e, 0x01]\fR ("vpn\ex01")\. This field can be used to identify VpnCloud packets and might be set to something different to hide the protocol\. +. +.IP "\(bu" 4 +1 byte \fBcrypto method\fR +. +.IP +This field specifies the method that must be used to decrypt the rest of the data\. The currently supported methods are: +. +.IP "\(bu" 4 +Method \fB0\fR, \fBNo encryption\fR: Rest of the data can be read without decrypting it\. +. +.IP "\(bu" 4 +Method \fB1\fR, \fBChaCha20\fR: The header is followed by a 12 byte \fInonce\fR\. The rest of the data is encrypted with the \fBlibsodium::crypto_aead_chacha20poly1305_ietf\fR method, using the 8 byte header as additional data\. +. +.IP "\(bu" 4 +Method \fB2\fR, \fBAES256\fR: The header is followed by a 12 byte \fInonce\fR\. The rest of the data is encrypted with the \fBlibsodium::crypto_aead_aes256gcm\fR method, using the 8 byte header as additional data\. +. +.IP "" 0 + +. +.IP "\(bu" 4 +2 \fBreserved bytes\fR that are currently unused and set to 0 +. +.IP "\(bu" 4 +1 byte for the \fBmessage type\fR +. +.IP +This byte specifies the type of message that follows\. Currently the following message types are supported: +. +.IP "\(bu" 4 +Type 0: Data packet +. +.IP "\(bu" 4 +Type 1: Peer list +. +.IP "\(bu" 4 +Type 2: Initial message +. +.IP "\(bu" 4 +Type 3: Closing message +. +.IP "" 0 + +. +.IP "" 0 +. +.P +After this 8 byte header, the rest of the message follows\. It is encrypted using the method specified in the header\. +. +.P +In the decrypted data, the message as specified in the \fBmessage type\fR field will follow: +. +.IP "\(bu" 4 +\fBData packet\fR (message type 0): This packet contains payload\. The format of the data depends on the device type\. For TUN devices, this data contains an IP packet\. For TAP devices it contains an Ethernet frame\. The data starts right after the header and ends at the end of the packet\. If it is an Ethernet frame, it will start with the destination MAC and end with the payload\. It does not contain the preamble, SFD, padding, and CRC fields\. +. +.IP "\(bu" 4 +\fBPeer list\fR (message type 1): This packet contains the peer list of the sender\. The first byte after the switch byte contains the number of IPv4 addresses that follow\. After that, the specified number of addresses follow, where each address is encoded in 6 bytes\. The first 4 bytes are the IPv4 address and the later 2 bytes are port number (both in network byte order)\. After those addresses, the next byte contains the number of IPv6 addresses that follow\. After that, the specified number of addresses follow, where each address is encoded in 18 bytes\. The first 16 bytes are the IPv6 address and the later 2 bytes are port number (both in network byte order)\. +. +.IP "\(bu" 4 +\fBInitial message\fR (message type 2): This packet contains the following information: +. +.IP "\(bu" 4 +The stage of the initialization process +. +.IP "\(bu" 4 +A random node id to distinguish different nodes +. +.IP "\(bu" 4 +All the local subnets claimed by the nodes +. +.IP "" 0 +. +.IP +Its first byte marks the stage of the initial handshake process\. The next 16 bytes contain the unique node id\. After that, the list of local subnets follows\. The subnet list is encoded in the following way: Its first byte of data contains the number of encoded subnets that follow\. After that, the given number of encoded subnets follow\. For each subnet, the first byte is the length of bytes in the base address and is followed by the given number of base address bytes and one additional byte that is the prefix length of the subnet\. The addresses for the subnet will be encoded like they are encoded in their native protocol (4 bytes for IPv4, 16 bytes for IPv6, and 6 bytes for a MAC address) with the exception of MAC addresses in a VLan which will be encoded in 8 bytes where the first 2 bytes are the VLan number in network byte order and the later 6 bytes are the MAC address\. +. +.IP "\(bu" 4 +\fBClosing message\fR (message type 3): This packet does not contain any more data\. +. +.IP "" 0 +. +.P +Nodes are expected to send an \fBinitial message\fR with stage 0 whenever they connect to a node they were not connected to before\. As a reply to this message, another initial should be sent with stage 1\. Also a \fBpeer list\fR message should be sent as a reply\. +. +.P +When connected, nodes should periodically send their \fBpeer list\fR to all of their peers to spread this information and to avoid peer timeouts\. To avoid the cubic growth of management traffic, nodes should at a certain network size start sending partial peer lists instead of the full list\. A reasonable number would be about 20 peers\. The subsets should be selected randomly\. +. +.P +Nodes should remove peers from their peer list after a certain period of inactivity or when receiving a \fBclosing message\fR\. Before shutting down, nodes should send the closing message to all of their peers in order to avoid receiving further data until the timeout is reached\. +. +.P +Nodes should only add nodes to their peer list after receiving an initial message from them instead of adding them right from the peer list of another peer\. This is necessary to avoid the case of a large network keeping dead nodes alive\. +. +.SH "COPYRIGHT" +Copyright (C) 2015\-2019 Dennis Schwerdel This software is licensed under GPL\-3 or newer (see LICENSE\.md) diff --git a/deb/vpncloud/vpncloud@.service b/assets/vpncloud@.service similarity index 100% rename from deb/vpncloud/vpncloud@.service rename to assets/vpncloud@.service diff --git a/build.rs b/build.rs index 11687a3..5db73d6 100644 --- a/build.rs +++ b/build.rs @@ -1,9 +1,25 @@ // VpnCloud - Peer-to-Peer VPN -// Copyright (C) 2015-2017 Dennis Schwerdel +// Copyright (C) 2015-2019 Dennis Schwerdel // This software is licensed under GPL-3 or newer (see LICENSE.md) extern crate cc; +use std::process::Command; +use std::env; +use std::path::Path; +use std::fs; + fn main() { + let out_dir = env::var("OUT_DIR").unwrap(); + + // Compile tun/tap C code + println!("rerun-if-changed=src/c/tuntap.c"); cc::Build::new().file("src/c/tuntap.c").include("src").compile("libtuntap.a"); + + // Process manpage using ronn command + println!("rerun-if-changed=vpncloud.md"); + fs::copy("vpncloud.md", Path::new(&out_dir).join("vpncloud.1.ronn")).unwrap(); + Command::new("ronn").args(&["-r", "vpncloud.1.ronn"]).current_dir(&Path::new(&out_dir)).status().expect("Failed to process manpage, ronn command missing?"); + Command::new("gzip").args(&["vpncloud.1"]).current_dir(&Path::new(&out_dir)).status().unwrap(); + fs::copy(Path::new(&out_dir).join("vpncloud.1.gz"), "target/vpncloud.1.gz").unwrap(); } diff --git a/deb/.gitignore b/deb/.gitignore deleted file mode 100644 index be0a54e..0000000 --- a/deb/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -vpncloud/debian/files -vpncloud/debian/vpncloud -vpncloud/debian/debhelper* -vpncloud/vpncloud -*.deb -*.build -*.changes -*.debhelper* -*.substvars diff --git a/deb/Makefile b/deb/Makefile deleted file mode 100644 index 22942dd..0000000 --- a/deb/Makefile +++ /dev/null @@ -1,25 +0,0 @@ -PACKAGE=vpncloud -DEPENDENCIES=debhelper devscripts - -.PHONY: default -default: clean build - -.PHONY: build -build: $(PACKAGE)_*.deb -$(PACKAGE)_*.deb: $(PACKAGE)/vpncloud.1.ronn $(PACKAGE)/vpncloud - (cd $(PACKAGE); make clean; debuild -b -us -uc; cd ..) - -.PHONY: clean -clean: - (cd $(PACKAGE); debuild -- clean; cd ..) - rm -rf $(PACKAGE)_* - rm -f ../target/release/vpncloud - -$(PACKAGE)/vpncloud.1.ronn: ../vpncloud.md - cp ../vpncloud.md $(PACKAGE)/vpncloud.1.ronn - -$(PACKAGE)/vpncloud: ../target/release/vpncloud - cp ../target/release/vpncloud $(PACKAGE)/vpncloud - -../target/release/vpncloud: ../src/*.rs ../Cargo.toml - (cd ..; cargo build --release) diff --git a/deb/vpncloud/Makefile b/deb/vpncloud/Makefile deleted file mode 100644 index dbb132f..0000000 --- a/deb/vpncloud/Makefile +++ /dev/null @@ -1,15 +0,0 @@ -build: vpncloud.1 - -vpncloud.1: vpncloud.1.ronn - ronn -r vpncloud.1.ronn - -install: - install -d $(DESTDIR)/etc/vpncloud - install -m 600 example.net.disabled $(DESTDIR)/etc/vpncloud/example.net.disabled - install -d $(DESTDIR)/var/log - install -d $(DESTDIR)/run - install -d $(DESTDIR)/usr/bin - install -m 755 vpncloud $(DESTDIR)/usr/bin/vpncloud - install -m 755 vpncloud-control $(DESTDIR)/usr/bin/vpncloud-control - install -d $(DESTDIR)/lib/systemd/system - install -m 644 vpncloud@.service $(DESTDIR)/lib/systemd/system/vpncloud@.service diff --git a/deb/vpncloud/debian/compat b/deb/vpncloud/debian/compat deleted file mode 100644 index ec63514..0000000 --- a/deb/vpncloud/debian/compat +++ /dev/null @@ -1 +0,0 @@ -9 diff --git a/deb/vpncloud/debian/control b/deb/vpncloud/debian/control deleted file mode 100644 index d1871a5..0000000 --- a/deb/vpncloud/debian/control +++ /dev/null @@ -1,15 +0,0 @@ -Source: vpncloud -Section: misc -Priority: optional -Maintainer: Dennis Schwerdel -Build-Depends: debhelper (>= 9), ruby-ronn -Standards-Version: 3.8.3 - -Package: vpncloud -Architecture: amd64 -Depends: ${shlibs:Depends}, ${misc:Depends} -Description: Peer-to-peer VPN - VpnCloud is a simple VPN over UDP. It creates a virtual network interface on - the host and forwards all received data via UDP to the destination. VpnCloud - establishes a fully-meshed VPN network in a peer-to-peer manner. It can work - on TUN devices (IP based) and TAP devices (Ethernet based). diff --git a/deb/vpncloud/debian/copyright b/deb/vpncloud/debian/copyright deleted file mode 100644 index 0ea8a2f..0000000 --- a/deb/vpncloud/debian/copyright +++ /dev/null @@ -1,31 +0,0 @@ -Upstream Author: - - Dennis Schwerdel - -Copyright: - - Copyright (C) 2015 Dennis Schwerdel, University of Kaiserslautern - -License: - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This package 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, see . - -On Debian systems, the complete text of the GNU General -Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". - -The Debian packaging is: - - Copyright (C) 2015 Dennis Schwerdel, University of Kaiserslautern - -and is licensed under the GPL version 3, see above. diff --git a/deb/vpncloud/debian/manpages b/deb/vpncloud/debian/manpages deleted file mode 100644 index 6a85aae..0000000 --- a/deb/vpncloud/debian/manpages +++ /dev/null @@ -1 +0,0 @@ -vpncloud.1 diff --git a/deb/vpncloud/debian/rules b/deb/vpncloud/debian/rules deleted file mode 100755 index cbe925d..0000000 --- a/deb/vpncloud/debian/rules +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/make -f -%: - dh $@ diff --git a/deb/vpncloud/debian/vpncloud.default b/deb/vpncloud/debian/vpncloud.default deleted file mode 100644 index b805940..0000000 --- a/deb/vpncloud/debian/vpncloud.default +++ /dev/null @@ -1,4 +0,0 @@ -# Warning: This file is ignored on systemd systems -# Please use instantiated services (vpncloud@NAME) instead - -NETWORKS="default" diff --git a/deb/vpncloud/debian/vpncloud.init b/deb/vpncloud/debian/vpncloud.init deleted file mode 100755 index 65815ae..0000000 --- a/deb/vpncloud/debian/vpncloud.init +++ /dev/null @@ -1,86 +0,0 @@ -#!/bin/sh -### BEGIN INIT INFO -# Provides: vpncloud -# Required-Start: $network $remote_fs -# Required-Stop: $remote_fs -# Default-Start: 2 3 4 5 -# Default-Stop: 0 1 6 -# Short-Description: VpnCloud -# Description: VpnCloud - Peer-to-Peer VPN -### END INIT INFO - -# Author: Dennis Schwerdel -# Copyright (C) 2015-2016 Dennis Schwerdel -# This software is licensed unter GPL-3 or newer (see LICENSE.md) - - -# PATH should only include /usr/* if it runs after the mountnfs.sh script -PATH=/sbin:/usr/sbin:/bin:/usr/bin -DESC="VpnCloud" # Introduce a short description here -NAME=vpncloud # Introduce the short server's name here -SCRIPTNAME=/etc/init.d/$NAME -NETCONFIGS=/etc/vpncloud - -# default settings -USER=root -GROUP=root -UMASK=022 - -CONTROL=$(which $NAME-control) - -# Exit if the package is not installed -[ -x $CONTROL ] || exit 0 - -# Read configuration variable file if it is present -[ -r /etc/default/$NAME ] && . /etc/default/$NAME - -# Load the VERBOSE setting and other rcS variables -. /lib/init/vars.sh - -# Define LSB log_* functions. -# Depend on lsb-base (>= 3.0-6) to ensure that this file is present. -. /lib/lsb/init-functions - -case "$1" in - start) - log_begin_msg "Starting $DESC" "$NAME" - $CONTROL start - case "$?" in - 0|1) log_end_msg 0 ;; - 2) log_end_msg 1 ;; - esac - ;; - stop) - log_begin_msg "Stopping $DESC" "$NAME" - $CONTROL stop - case "$?" in - 0|1) log_end_msg 0; exit 0 ;; - 2) log_end_msg 1; exit 2 ;; - esac - ;; - status) - $CONTROL status - ;; - restart|force-reload) - log_begin_msg "Restarting $DESC" "$NAME" - $CONTROL stop - case "$?" in - 0|1) - $CONTROL start - case "$?" in - 0) log_end_msg 0 ;; - 1) log_end_msg 1 ;; # Old process is still running - *) log_end_msg 1 ;; # Failed to start - esac - ;; - *) - # Failed to stop - log_end_msg 1 - ;; - esac - ;; - *) - echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2 - exit 3 - ;; -esac diff --git a/deb/vpncloud/debian/vpncloud.service b/deb/vpncloud/debian/vpncloud.service deleted file mode 100644 index e7d4cbf..0000000 --- a/deb/vpncloud/debian/vpncloud.service +++ /dev/null @@ -1,10 +0,0 @@ -[Unit] -Description=VpnCloud -Before=systemd-user-sessions.service - -[Service] -ExecStartPre=/bin/echo "Please use instantiated services (vpncloud@NAME) instead." -ExecStart=/bin/false - -[Install] -WantedBy= diff --git a/deb/vpncloud/vpncloud-control b/deb/vpncloud/vpncloud-control deleted file mode 100755 index 6c68f36..0000000 --- a/deb/vpncloud/vpncloud-control +++ /dev/null @@ -1,74 +0,0 @@ -#!/bin/bash - -NAME=vpncloud -NETCONFIGS=/etc/vpncloud - -# default settings -USER=root -GROUP=root -UMASK=022 - -NETWORKS=$(for net in $(ls $NETCONFIGS); do basename $net .net; done); - -DAEMON=$(which $NAME) - -# Exit if the package is not installed -[ -x $DAEMON ] || exit 0 - -# Read configuration variable file if it is present -[ -r /etc/default/$NAME ] && . /etc/default/$NAME - -status() { - echo "Network status" - for net in $NETWORKS; do - [ -f "$NETCONFIGS/$net.net" ] || continue - echo -en "\t$net: " - if start-stop-daemon --status --pidfile /run/$NAME-$net.pid --name $NAME; then - echo "running" - else - echo "not running" - fi - done -} - -start() { - # Return - # 0 if daemon has been started - # 1 if daemon was already running - # 2 if daemon could not be started - for net in $NETWORKS; do - [ -f "$NETCONFIGS/$net.net" ] || continue - start-stop-daemon --start --pidfile /run/$NAME-$net.pid --name $NAME -- "$DAEMON --daemon --config $NETCONFIGS/$net.net --log-file /var/log/$NAME-$net.log --ststs-file /var/log/$NAME-$net.stats --pid-file /run/$NAME-$net.pid" - done - return 0 -} - -stop() { - # Return - # 0 if daemon has been stopped - # 1 if daemon was already stopped - # 2 if daemon could not be stopped - # other if a failure occurred - for net in $NETWORKS; do - [ -f "$NETCONFIGS/$net.net" ] || continue - start-stop-daemon --stop --quiet --pidfile /run/$NAME-$net.pid --retry 60 - rm -f /run/$NAME-$net.pid - done - return 0 -} - -case "$1" in - start) - start - ;; - stop) - stop - ;; - status) - status - ;; - *) - echo "Unsupported action: '$1'" >&2 - exit 3 - ;; -esac diff --git a/gpl-3.txt b/gpl-3.txt deleted file mode 100644 index a737dcf..0000000 --- a/gpl-3.txt +++ /dev/null @@ -1,675 +0,0 @@ - - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - 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, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -.