# btun

**Repository Path**: mirrors_Gottox/btun

## Basic Information

- **Project Name**: btun
- **Description**: bidirectional tunnel through a webbrowser
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-03-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

BTUN 1 "May 2015" btun-0.1 "User Commands"
==========================================

NAME
----

btun - bidirectional tunnel through a webbrowser

SYNOPSIS
--------

**btun** [**-d**] [**-l** *local*] [**-s** *remote*] [**-t** *tundev*] [**-p** *port*][**-b** *bind_address*] *keyfile*

**btun** [**-v**]

DESCRIPTION
-----------

**btun** establishes a bidirectional connection between two hosts
using one or more browsers as mediators.

	       host1        mediator       host2
	      +------+    +---------+    +------+
	  +---| btun |----| browser |----| btun |---+
	  |   +------+    +---------+    +------+   |
	 tunX                                      tunX

If multiple browsers are connected, every package is sent to all
mediators. The receiver takes the first package and drops the rest.

OPTIONS
-------

**-d**
prints debug messages

**-l** *local*
sets the local address for a websocket connection. If unspecified
Javascript tries to guess an address. This option has no effect
if **-s** is not specified

**-s** *remote*
enables server mode: an index is delivered which connects the
browser via websocket to *local* and *remote*. *local* is guessed
but can be set explicitly via the **-l** option.

**-t** *tundev*
sets the name of the tun device

**-p** *port*
sets the port. Default: 8000.

**-b** *bind_address*
sets the bind address. Default is to listen on all interfaces.

EXAMPLES
--------

	host1 # btun -s ws://host2:8000 keyfile.pem
	host1 # ifconfig tun0 10.0.111.1 dstaddr 10.0.111.2

	host2 # btun keyfile.pem
	host2 # ifconfig tun0 10.0.111.2 dstaddr 10.0.111.1

Point your browser to http://host1:8000. As long as the browser has a connection
both hosts, the connection between both hosts is established.

DIAGNOSTICS
-----------

Use tcpdump(1), the **-d** flag, and the debug tools of your browser to debug
network problems.

BUGS
----

Currently **btun** does not encrypt any data. Both, a passive attacker
and the mediator can read any data sent through btun.