Skip to content

Commit

Permalink
Docs: Add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BornToBeRoot committed Jan 4, 2024
1 parent ea2f47a commit 08fdbd2
Show file tree
Hide file tree
Showing 26 changed files with 429 additions and 6 deletions.
26 changes: 26 additions & 0 deletions Website/docs/application/arp-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,29 @@ sidebar_position: 25
---

# ARP Table

The **ARP table** shows you the IP address and MAC address of all devices on your network with which the computer has already established a connection.

:::info

ARP (Address Resolution Protocol) is a layer 2 protocol for mapping IP addresses to MAC addresses. The ARP table is a list of all IP addresses and the corresponding MAC addresses of the devices on the network. When a device needs to send data to a specific IP address, it first checks its ARP table to see if it already has the MAC address for that IP address. If the MAC address is not found in the ARP table, the device will send a broadcast message called an ARP request to the network asking which device owns that IP address. The device that owns the IP address will then respond with its MAC address, and the requesting device will update its ARP table with the new mapping. ARP cache poisoning attacks can manipulate the contents of the ARP table, leading to security issues.

:::

![ARP Table](./img/arp-table.png)

:::note

In addition, further actions can be performed using the buttons at the bottom left:

- **Add entry...** - Opens a dialog to add an entry to the ARP table.
- **Delete entry** - Delete the currently selected entry from the ARP table.
- **Delete table** - Delete all entries from the ARP table.

:::

:::note

Right-click on the result to copy or export the information.

:::
25 changes: 25 additions & 0 deletions Website/docs/application/bit-calculator.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,28 @@ sidebar_position: 21
---

# Bit Calculator

With the **Bit Calculator** different data units can be converted. Based on the input number and the selected unit the different units like bits, bytes, kilobits, kilobytes, megabits, megabytes, etc. are calculated.

![Bit Calculator](./img/bit-calculator.png)

:::note

Right-click on the result to copy the information.

:::

## Settings

### Notation

Notation which should be used for the calculation.

**Type:** `NETworkManager.Models.Network.BitCaluclatorNotation`

**Default:** `Binary`

**Possible values:**

- `Binary` (1024)
- `Decimal` (1000)
16 changes: 16 additions & 0 deletions Website/docs/application/connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,19 @@ sidebar_position: 23
---

# Connections

In **Connections** you can see all connections with source and destination IP endpoint (IP address and port) and with the associated process that are currently running on your computer.

:::info

The data shown is similar to the output of the `netstat` command.

:::

![Connections](./img/connections.png)

:::note

Right-click on the result to copy or export the information.

:::
26 changes: 25 additions & 1 deletion Website/docs/application/discovery-protocol.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
---
sidebar_position: 17
sidebar_position: 16
---

# Discovery Protocol

In **Discovery Protocol** you can capture for LLDP (Link Layer Discovery Protocol) and/or CDP (Cisco Discovery Protocol) frames to see to which switch or router your device is connected. The information such as device name, port, VLAN, etc. are displayed in a table.

:::info

The Link Layer Discovery Protocol (LLDP) is a vendor-neutral Layer 2 network protocol used by network devices, especially switches, to advertise their identity, capabilities, and neighbors on an IEEE 802 Local Area Network (LAN). If configured, LLDP messages are sent out periodically as frames with the destination MAC address of `01:80:c2:00:00:0e`. The default time interval is 30 seconds.

The Cisco Discovery Protocol (CDP) is a proprietary Layer 2 protocol used by Cisco Systems to exchange information about network devices. If configured, CDP messages are sent out periodically as frames with the destination MAC address `01:00:0c:cc:cc`. The default time interval is 60 seconds.

:::

:::warning

If you are using a hypervisor like Hyper-V with a virtual switch configured as "External network" which is shared with host where NETworkManager is running, you may not receive any packets. This is because the virtual switch does not forward the LLDP or CDP frames to the host. You may temporarily change the virtual switch to "Internal network" or "Private network", if you want to use the Discovery Protocol to see which switch or router your device is connected to. You can also verify this behavior by using Wireshark.

:::

![Discovery Protocol](./img/discovery-protocol.png)

:::note

Right-click on the result to copy the information.

:::
Binary file added Website/docs/application/img/arp-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Website/docs/application/img/bit-calculator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Website/docs/application/img/connections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Website/docs/application/img/listeners.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Website/docs/application/img/lookup--oui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Website/docs/application/img/lookup--port.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Website/docs/application/img/sntp-lookup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Website/docs/application/img/wake-on-lan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Website/docs/application/img/whois.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions Website/docs/application/ip-geolocation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
sidebar_position: 19
---

# IP Geolocation

With **IP Geolocation** you can retrieve geolocation information for a fully qualified domain name (FQDN) or a public IP address.

:::info

IP geolocation data is provided by [ip-api.com](https://ip-api.com/) and the API endpoint `http://ip-api.com/json/<host>` is queried when the information is requested. The free API endpoint is limited to 45 requests per minute, supports only the `http` protocol and is available for non-commercial use only.

:::

Example inputs:

- `borntoberoot.net`
- `1.1.1.1`

![IPGeolocation](20_IPGeolocation.png)

:::note

Right-click on the result to copy the information.

:::

## Profile

### Inherit host from general

Inherit the host from the general settings.

**Type:** `Boolean`

**Default:** `Enabled`

:::note

If this option is enabled, the [host](#host) is overwritten by the host from the general settings and the [host](#host) is disabled.

:::

### Host

Host (FQDN or public IP address) to query for IP geolocation information.

**Type:** `String`

**Default:** `Empty`

**Example:**

- `borntoberoot.net`
- `1.1.1.1`
10 changes: 10 additions & 0 deletions Website/docs/application/listeners.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,13 @@ sidebar_position: 24
---

# Listeners

In **Listeners** you can see all the listeners with IP addresses and port that are currently running on your computer.

![Listeners](./img/listeners.png)

:::note

Right-click on the result to copy or export the information.

:::
38 changes: 38 additions & 0 deletions Website/docs/application/lookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,41 @@ sidebar_position: 22
---

# Lookup

In **Lookup** you can search for information about [OUIs](#oui) (Organizationally Unique Identifiers) and [ports](#port).

## OUI

On the **OUI** tab, you can search the manufacturer of a network interface card (NIC) by entering the first 24 bits of the MAC address. You can also search by vendor name to get all registered MAC addresses of the vendor.

:::info

The OUI (Organizationally Unique Identifier) is a 24-bit number that is assigned to a network interface card (NIC) by the IEEE Registration Authority. The OUI is used to identify the manufacturer of a network interface card. The OUI is the first 24 bits of the MAC address.

:::

![Lookup - OUI](./img/lookup--oui.png)

:::note

Right-click on the result to copy or export the information.

:::

## Port

On the **Port** tab, you can search for a port number to get information about the service and the protocol used by the port. You can also search by service name to get all registered port numbers of the service.

:::info

A port is a logical construct that identifies a specific process to which network traffic is to be forwarded. Ports are identified by a 16-bit number, known as a port number. Port numbers range from 0 to 65535, but only ports numbers 0 to 1023 are designated as well-known ports. Well-known ports are those registered with IANA for common services such as HTTP (port 80), HTTPS (port 443), FTP (port 21), and SSH (port 22).

:::

![Lookup - Port](./img/lookup--port.png)

:::note

Right-click on the result to copy or export the information.

:::
6 changes: 5 additions & 1 deletion Website/docs/application/network-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ In **Network Interface** you can see all network adapters of the computer with t

On the **Information** tab, you can see all the important details of the selected network adapter such as the configured IP addresses, DNS servers, MAC address, and more. If information such as IPv6 configuration is not available, it is hidden in the view.

![Network Interface - Information](./img/network-interface--information.png)

:::note

In addition, further actions can be performed using the buttons at the bottom left:

- **Network connections...** - Opens the `Control Panel > Network and Internet > Network Connections` window.
Expand All @@ -25,7 +29,7 @@ In addition, further actions can be performed using the buttons at the bottom le
- **Release** - Releases the current IPv6 addresses obtained via DHCPv6 for the _selected_ network adapter that is configured to automatically obtain an IPv6 address (`ipconfig /release6 <ADAPTER>`).
- **Renew** - Renews the current IPv6 address via DHCPv6 for the _selected_ network adapter that is configured to automatically obtain an IPv6 address (`ipconfig /renew6 <ADAPTER>`).

![Network Interface - Information](./img/network-interface--information.png)
:::

:::note

Expand Down
2 changes: 1 addition & 1 deletion Website/docs/application/snmp.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 15
sidebar_position: 14
---

# SNMP
Expand Down
50 changes: 49 additions & 1 deletion Website/docs/application/sntp-lookup.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,53 @@
---
sidebar_position: 16
sidebar_position: 15
---

# SNTP Lookup

With **SNTP Lookup** you can query one or more SNTP servers to get the current network time.
SNTP server and get the network current time. It will also show the offset to the local time.

:::info

SNTP (Simple Network Time Protocol) is a protocol used for synchronizing time between computer systems on a network. It is a simplified version of the Network Time Protocol (NTP) that is widely used for time synchronization. SNTP is designed to provide a basic level of accuracy and is used when precise timing is not critical. SNTP servers typically obtain their time from other NTP or SNTP servers and distribute the time to client devices on the network. SNTP operates over the User Datagram Protocol (UDP) and typically uses port 123. It is widely supported by many operating systems and network devices and is an important component of network infrastructure.

:::

![SNTP Lookup](./img/sntp-lookup.png)

:::note

Right-click on the result to copy or export the information.

:::

## Settings

### SNTP servers

List of SNTP server profiles. A profile can contain one or more SNTP servers with host/IP address and port.

**Type:** `List<NETworkManager.Models.Network.ServerConnectionInfoProfile>`

**Default:**

| Name | Server(s) |
| ----------------- | ------------------------------------------------------------------------------------------------------------- |
| Cloudflare | `time.cloudflare.com:123` |
| Google Public NTP | `time.google.com:123; time1.google.com:123; time2.google.com:123; time3.google.com:123; time4.google.com:123` |
| Microsoft | `time.windows.com:123` |
| pool.ntp.org | `0.pool.ntp.org:123; 1.pool.ntp.org:123; 2.pool.ntp.org:123; 3.pool.ntp.org:123` |

:::note

At least one SNTP server profile must exist.

:::

### Timeout (ms)

Timeout in milliseconds after the SNTP request is canceled.

**Type:** `Integer` [Min `100`, Max `15000`]

**Default:** `4000`
65 changes: 65 additions & 0 deletions Website/docs/application/subnet-calculator.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,68 @@ sidebar_position: 20
---

# Subnet Calculator

With the **Subnet Calculator** you can [calculate a subnet](#calculator), [split subnets](#subnetting) and create a [wide subnet](#wide-subnet). Both IPv4 and IPv6 are supported.

## Calculator

On the **Calculator** tab, you can calculate a subnet by entering the IP address and the subnet mask. The subnet mask can be entered in CIDR notation.

Example inputs:

- `10.0.0.0/16`
- `192.168.0.0/255.255.255.0`
- `2001:db8::/32`

![Subnet Calculator - Calculator](./img/subnet-calculator--calculator.png)

:::note

Right-click on the result to copy the information.

:::

## Subnetting

On the **Subnetting** tab, you can split a subnet into smaller subnets. The subnet mask can be entered in CIDR notation.

Example inputs:

| Subnet | New subnet mask |
| --------------------------- | ----------------- |
| `10.0.0.0/16` | `/18` |
| `192.168.0.0/255.255.255.0` | `255.255.255.128` |
| `2001:db8::/32` | `/48` |

![Subnet Calculator - Subnetting](./img/subnet-calculator--subnetting.png)

:::note

Right-click on the result to copy or export the information.

:::

## Wide Subnet

On the **Wide Subnet** tab, you can create a wide subnet that includes both given subnets. The subnet mask can be entered in CIDR notation.

Example inputs:

| Subnet 1 | Subnet 2 |
| --------------------------- | ---------------- |
| `10.0.0.0/16` | `10.2.0.0/16` |
| `192.168.0.0/255.255.255.0` | `192.168.4.0/23` |

:::note

IPv6 is not supported.

:::

![Subnet Calculator - Wide Subnet](./img/subnet-calculator--wide-subnet.png)

:::note

Right-click on the result to copy the information.

:::
Loading

0 comments on commit 08fdbd2

Please sign in to comment.