Skip to content

Commit acce7b5

Browse files
syssecfsusyssecfsu
committed
WiP
1 parent 6f822bf commit acce7b5

File tree

7 files changed

+20
-66
lines changed

7 files changed

+20
-66
lines changed

‎content/docs/about.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: About
33
weight: 6
44
---
55

6-
## About WiTTY
6+
# About WiTTY
77

88
WiTTY is written in the [go programming language](https://go.dev/), using the
99
[Gin web framework](https://github.com/gin-gonic/gin), [gorilla/websocket](https://github.com/gorilla/websocket), [pty](https://github.com/creack/pty), and the wonderful [xterm.js](https://xtermjs.org/)!

‎content/docs/hidden.md‎

Lines changed: 0 additions & 52 deletions
This file was deleted.

‎content/docs/install.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Installation
33
weight: 1
44
---
5-
## Installation
5+
# Installation
66

7-
WiTTY runs on Linux (ARM and x86), macOS, and WSl (Windows subsystem for Linux, basically Linux). You can install from the pre-built binary or from the source code.
7+
WiTTY runs on Linux (ARM and x86), macOS, and WSL2 (Windows subsystem for Linux, basically Linux). You can install from the pre-built binary or from the source code.
88

99

1010
{{< tabs "install_method" >}}
@@ -13,7 +13,9 @@ WiTTY runs on Linux (ARM and x86), macOS, and WSl (Windows subsystem for Linux,
1313
2. Download the release for your system
1414
3. Decompress the binary with the following command at selected location.
1515

16-
```tar -xzvf releasevxxx_xxx.tar.gz```
16+
```tar -xzvf witty_vx.x.x_xxx.tar.gz```
17+
18+
>For example, use `tar -xzvf witty_v1.1.1_linux_amd64.tar.gz` to decompress release v1.1.1 for Linux on AMD64.
1719
1820
{{< /tab >}}
1921
{{< tab "From Source Code" >}}
@@ -43,7 +45,7 @@ WiTTY runs on Linux (ARM and x86), macOS, and WSl (Windows subsystem for Linux,
4345
{{< /tabs >}}
4446

4547

46-
## Post-installation Configuration
48+
# Post-installation Configuration
4749
1. WiTTY uses TLS to protect its traffic. You can request a free [Let's Encrypt](https://letsencrypt.org/) cert or use a self-signed cert. Here is how to create a self-signed cert in the ```tls``` sub-directory:
4850

4951
\# Generate a private key for a curve
@@ -81,7 +83,7 @@ WiTTY runs on Linux (ARM and x86), macOS, and WSl (Windows subsystem for Linux,
8183
```https://<witty_server_ip>:8080```
8284

8385

84-
## Example Use Case
86+
# Example Use Case
8587

8688
WiTTY doesn't support Windows because Windows doesn't have [PTY](https://en.wikipedia.org/wiki/Pseudoterminal). You can still use WiTTY to access Windows terminal through a proxy.
8789

‎content/docs/ui.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: User Interface
33
weight: 2
44
---
5-
## Sub-commands
5+
# Sub-commands
66

77
Similar to `git` and `apt`, WiTTY uses sub-commands for its various functions. WiTTY currently supports the following sub-commands: `adduser`, `deluser`, `listusers`, `replay`, `merge`, `run`.
88

@@ -33,7 +33,7 @@ Usage of run:
3333
Max wait time between outputs (default 1000)
3434
```
3535

36-
## User Authentication
36+
# User Authentication
3737

3838
WiTTY uses username/password based authentication. The user database is stored in ```user.db``` under the main directory of WiTTY. The passwords are salted with 64 bytes of random characters and then hashed using SHA256. In addition, passwords must be 12 bytes or longer. WiTTY provides three sub-commands to manage ```user.db```.
3939

@@ -43,7 +43,7 @@ WiTTY uses username/password based authentication. The user database is stored i
4343

4444
They are pretty self-explanatory. Just follow the instructions on screen.
4545

46-
## Web Interface (witty run)
46+
# Web Interface (witty run)
4747

4848
The web interface of WiTTY is mostly self-explanatory. After login, the user is presented with the main interface, as shown in this screenshot:
4949

‎content/docs/vm.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,21 @@ title: VirtualBox
33
weight: 5
44
---
55

6-
## Use WiTTY with SEED VM
6+
# Use WiTTY with SEED VM
77

88
The [SEED labs](https://seedsecuritylabs.org/Labs_20.04/) provides a number of security hands-on labs. It is a popular security lab course taught at many universities. The SEED labs use [VirtualBox](https://www.virtualbox.org/) to run its VMs (because VirtualBox is cross-platform.)
99

1010
By default, the SEED VM uses only NAT-based network, which means that the VM can access the Internet but not the host machine (i.e., the machine that runs VirtualBox is called the host, and the VM is often called the guest.) We need to add a second, host-only network adaptor in order to run WiTTY in the guest and access WiTTY from a browser in the host.
1111

12-
To do that, first open the `Host Network Manager` and create a host network if there is not one already, as shown below (on macOS):
12+
To do that, first open the `Host Network Manager` and create a host network if there is not one already, as shown below (on macOS.):
1313
![img](/static/img/host.png)
1414

1515
Then, open the setting for the SEED VM, go to the Network setting, and enable the second adaptor, choose the `host-only` adaptor. Leave the first adaptor as is.
1616

1717
![img](/static/img/adapter2.png)
1818

19-
After this, start the VM and list all the adaptors using the command `ifconfig` in a terminal. Look for the adaptor with an IP address starting with `192.168.`. You should be able to ssh into the guest using this IP address from the host.
19+
After this, start the VM and list all the adaptors using the command `ifconfig` in a terminal. Look for the adaptor with an IP address starting with `192.168.`. You should be able to ssh into the guest using this IP address from the host.
20+
21+
{{< hint info>}}
22+
If the host runs Windows, make sure virtualbox host adapter is not disabled in the Windows network settings if VirtualBox cannot find the host-only Ethernet adapter.
23+
{{< /hint >}}

‎resources/_gen/assets/scss/book.scss_50fc8c04e12a2f59027287995557ceff.content‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎resources/_gen/assets/scss/book.scss_50fc8c04e12a2f59027287995557ceff.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"Target":"book.min.c6cfeeb36c3b51db0cb2507353c4eecf17c0fdcf2758a3802adc1474fb105e1e.css","MediaType":"text/css","Data":{"Integrity":"sha256-xs/us2w7UdsMslBzU8TuzxfA/c8nWKOAKtwUdPsQXh4="}}
1+
{"Target":"book.min.97cfda4f5e3c9fa49a2bf8d401f4ddc0eec576c99cdcf6afbec19173200c37db.css","MediaType":"text/css","Data":{"Integrity":"sha256-l8/aT148n6SaK/jUAfTdwO7Fdsmc3PavvsGRcyAMN9s="}}

0 commit comments

Comments
 (0)