https://github.com/SimplyMinimal/tailscale-network-topology-mapper

A visual way to view your ACL rules for Tailscale
https://github.com/SimplyMinimal/tailscale-network-topology-mapper

Last synced: 6 days ago
JSON representation

A visual way to view your ACL rules for Tailscale

• Host: GitHub
• URL: https://github.com/SimplyMinimal/tailscale-network-topology-mapper
• Owner: SimplyMinimal
• License: apache-2.0
• Created: 2024-04-08T22:02:01.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-07-04T15:59:15.000Z (4 months ago)
• Last Synced: 2024-08-01T19:45:07.280Z (3 months ago)
• Language: HTML
• Size: 543 KB
• Stars: 80
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tailscale Network Topology Mapper

### A visual way to view your ACL rules for Tailscale

I occasionally find myself just wanting to get a glance of how my ACL rules look without reading through the code. This is also useful for showing how our policies are set up to people who are not devs by trade.

![alt text](./images/Animation.gif)

# Initial Set Up

0. You will need Python3 and git installed.

1. `git clone https://github.com/SimplyMinimal/tailscale-network-topology-mapper`

2. `cd tailscale-network-topology-mapper`

3. `pip install -r requirements.txt`

4. Copy your ACL policy  into the contents of the example `policy.hujson` 

5. Edit `create-network-map.py` and change `COMPANY_DOMAIN="example.com"` to your actual company domain 

# Execution

6. Run `python create-network-map.py` to generate your network map. It should produce an updated `network_topology.html` file that you can open in your browser.

You can filter down to specific groups or nodes using the filter bar at the top or by clicking on a node on the graph.

### Github Action Workflow

If you would like to have the network map be automatically updated whenever you push an update to your ACL file then take a look at this example workflow:

[.github/workflows/tailscale.yml](https://github.com/SimplyMinimal/tailscale-network-topology-mapper/blob/main/.github/workflows/tailscale.yml)

## Limitations

* This project is in an early alpha stage.

* It can only map what is available in the ACL policy file. It is not an active scanning tool that will seek out other hosts.

* It only focuses on the ACL rules themselves but eventually this may start capturing ALL the available valid ACL sections.

Pull requests welcome! :) 

## Experimental Ideas and TODOs

* Use `tailscale debug netmap` to build a more in-depth map

* Allow switching between layers such as port level, host level, user/group level