✨ tailscale provider #5214

afiune · 2025-02-13T22:56:34Z

✨ Tailscale Provider

Use the tailscale provider to query devices, users, DNS namespaces, and more information about a Tailscale network,
known as a tailnet.

To authenticate using an API access token:

cnquery shell tailscale --token <access-token>

To authenticate using an OAuth client:

cnquery shell tailscale --client-id <id> --client-secret <secret>

You can also use the default environment variables TAILSCALE_OAUTH_CLIENT_ID, TAILSCALE_OAUTH_CLIENT_SECRET,
and TAILSCALE_TAILNET to provide your credentials.

If you are using an API access token instead of an OAuth client, use the TAILSCALE_API_KEY variable instead.

Examples

List all devices in a tailnet

cnquery> tailscale.devices()

Get information on a single device

cnquery> tailscale.device(id: "55161288425123456") {*}
tailscale.device: {
  id: "55161288425123456"
  isExternal: false
  os: "linux"
  created: 2021-06-25 12:34:34 -0700 PDT
  updateAvailable: true
  nodeKey: "nodekey:abc123"
  lastSeen: 2024-03-25 08:01:04 -0700 PDT
  user: "afiune@mondoo.com"
  hostname: "raspberrypi"
  clientVersion: "1.10.0-t766ae6c10-g3e6822772"
  authorized: true
  blocksIncomingConnections: false
  addresses: [
    0: "100.71.181.41"
    1: "abc1:abc1:a1e0:ab12:abc1:cd96:abc1:bf33"
  ]
  keyExpiryDisabled: true
  expires: 2022-08-02 18:55:39 -0700 PDT
  name: "raspberrypi.tail1a4a6.ts.net"
  machineKey: "mkey:abc123"
  tailnetLockKey: ""
  tailnetLockError: ""
}

List all users in a tailnet

cnquery> tailscale.users()

Get information on a single user

cnquery> tailscale.user(id: "uiR4AD141DAA") {*}
tailscale.user: {
  id: "uiR4AD141DAA"
  type: "member"
  deviceCount: 64
  createdAt: 2021-06-24 11:17:02.151878675 -0700 PDT
  loginName: "afiune@mondoo.com"
  status: "active"
  lastSeenAt: 2025-02-18 13:56:23.715800061 -0800 PST
  tailnetId: "12345678900012344"
  profilePicUrl: "https://lh3.googleusercontent.com/a/ACg8ocKPxpFdO4al-Si9YXhJz_iN9qnZ-8h5UorbQrKWxrS-uPutP6E=s96-c"
  role: "owner"
  displayName: "Salim Afiune Maya"
}

Advanced usage

Discover all devices (any computer or mobile device) that join the tailnet example.com

cnquery shell tailscale example.com --discover devices

github-actions · 2025-02-13T22:58:13Z

Test Results

3 335 tests ±0 3 331 ✅ ±0 1m 39s ⏱️ -14s
391 suites +6 4 💤 ±0
30 files +1 0 ❌ ±0

Results for commit 175517d. ± Comparison against base commit 097be40.

♻️ This comment has been updated with latest results.

Use the tailscale provider to query devices, DNS namespaces, and more information about a Tailscale network known as `tailnet`. To authenticate using an API access token: ``` cnquery shell tailscale --token <access-token> ``` To authenticate using an OAuth client: ``` cnquery shell tailscale --client-id <id> --client-secret <secret> ``` You can also use the default environment variables `TAILSCALE_OAUTH_CLIENT_ID`, `TAILSCALE_OAUTH_CLIENT_SECRET`, and `TAILSCALE_TAILNET` to provide your credentials. If you are using an API access token instead of an OAuth client, use the `TAILSCALE_API_KEY` variable instead. Examples **List all devices in a tailnet** ```shell cnquery> tailscale.devices() ``` **Show a single device information** ```shell cnquery> tailscale.device(id: "55161288425123456") {*} tailscale.device: { id: "55161288425123456" isExternal: false os: "linux" created: 2021-06-25 12:34:34 -0700 PDT updateAvailable: true nodeKey: "nodekey:abc123" lastSeen: 2024-03-25 08:01:04 -0700 PDT user: "afiune@mondoo.com" hostname: "raspberrypi" clientVersion: "1.10.0-t766ae6c10-g3e6822772" authorized: true blocksIncomingConnections: false addresses: [ 0: "100.71.181.41" 1: "abc1:abc1:a1e0:ab12:abc1:cd96:abc1:bf33" ] keyExpiryDisabled: true expires: 2022-08-02 18:55:39 -0700 PDT name: "raspberrypi.tail1a4a6.ts.net" machineKey: "mkey:abc123" tailnetLockKey: "" tailnetLockError: "" } ``` Advanced Usage Discover all devices (any computer or mobile device) that joins the tailnet `example.com`. ```shell cnquery shell tailscale example.com --discover devices ``` Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

chris-rock

@afiune Great first version for the tailscale provider! I added a few comments that we should address before we can merge it. Its close!

docs/development.md

providers/tailscale/README.md

providers/tailscale/resources/tailscale.lr

providers/tailscale/resources/tailscale.go

providers/tailscale/resources/tailscale.lr

chris-rock · 2025-02-14T10:30:41Z

providers/tailscale/resources/tailscale.lr

+option provider = "go.mondoo.com/cnquery/v11/providers/tailscale"
+option go_package = "go.mondoo.com/cnquery/v11/providers/tailscale/resources"
+
+// The Tailscale provider


I think this represents the tailscale organization

providers/tailscale/resources/tailscale.lr

chris-rock · 2025-02-14T10:35:20Z

providers/tailscale/resources/discovery.go

+	conf := conn.Asset().Connections[0]
+	assetList := []*inventory.Asset{}
+
+	cf, err := getMqlTailscale(runtime)


I think we want also discover the root asset (org/tailnet).

I don't think we can fetch this information.

.github/actions/spelling/expect.txt

Makefile

providers/tailscale/connection/connection.go

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

misterpantz

Really good docs in this PR, as always, superstar! I made some suggestions. On some of them you'll find question marks where I wasn't 100% confident. 😁

providers/tailscale/README.md

providers/tailscale/config/config.go

providers/tailscale/resources/tailscale.lr

misterpantz · 2025-02-18T15:29:59Z

providers/tailscale/resources/tailscale.lr

+  // The time the user joined their tailnet
+  createdAt time
+  // This time can be either:
+  // a) The last time any of the user's nodes were connected to the network


Suggested change

// a) The last time any of the user's nodes were connected to the network

// a) The last time any of the user's nodes were connected to the network

// or

providers/tailscale/resources/tailscale.lr

chris-rock · 2025-02-18T20:34:21Z

providers/tailscale/provider/provider.go

+	}
+}
+
+func (s *Service) ParseCLI(req *plugin.ParseCLIReq) (*plugin.ParseCLIRes, error) {


Using an empty token does not throw an error in the initial phase:

echo $TAILSCALE_API_KEY cnquery shell tailscale --token $TAILSCALE_API_KEY --discover devices → tailscale> authentication configured method=token → connected to Tailscale ___ _ __ __ _ _ _ ___ _ __ _ _ / __| '_ \ / _` | | | |/ _ \ '__| | | | | (__| | | | (_| | |_| | __/ | | |_| | \___|_| |_|\__, |\__,_|\___|_| \__, | mondoo™ |_| |___/ interactive shell cnquery> tailscale tailscale: tailscale id = devices cnquery> tailscale.devices API token invalid (401) tailscale.devices: no data available

I will add a verify step to fail fast, just like we do with the GitHub provider, good call! 💯

providers/tailscale/resources/tailscale.go

Co-authored-by: Letha <letha@mondoo.com>

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

afiune · 2025-02-18T22:07:08Z

Let's go!!!!

This comment has been minimized.

Sign in to view

afiune force-pushed the afiune/tailscale branch from 461a0ab to 891b7b2 Compare February 13, 2025 22:59

This comment has been minimized.

Sign in to view

afiune force-pushed the afiune/tailscale branch from 891b7b2 to 412dbb1 Compare February 14, 2025 00:33

This comment has been minimized.

Sign in to view

chris-rock approved these changes Feb 14, 2025

View reviewed changes

chris-rock self-requested a review February 14, 2025 11:19

tas50 reviewed Feb 14, 2025

View reviewed changes

.github/actions/spelling/expect.txt Outdated Show resolved Hide resolved

tas50 reviewed Feb 14, 2025

View reviewed changes

.github/actions/spelling/expect.txt Outdated Show resolved Hide resolved

tas50 reviewed Feb 14, 2025

View reviewed changes

Makefile Outdated Show resolved Hide resolved

tas50 reviewed Feb 14, 2025

View reviewed changes

providers/tailscale/connection/connection.go Outdated Show resolved Hide resolved

afiune added 2 commits February 18, 2025 06:22

✨ detect and display tailscale.tailnet

ca57e61

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

🧹 use suffix At for time fields

f8dc9c3

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

This comment has been minimized.

Sign in to view

afiune added 6 commits February 18, 2025 07:02

⭐️ fetch tailscale.users()

0d3b1fc

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

🧹 remove words added to global dir

85aaf3e

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

✨ add tailscale.nameservers()

d9670e3

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

🧹 remove cnquery binery

fce34fb

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

🎉 discover tailscale users

f0b6295

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

🧹 last cleanup

6ee3021

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

afiune force-pushed the afiune/tailscale branch from 1893fc9 to 6ee3021 Compare February 18, 2025 15:02

This comment has been minimized.

Sign in to view

misterpantz reviewed Feb 18, 2025

View reviewed changes

chris-rock reviewed Feb 18, 2025

View reviewed changes

🧹 apply suggestions from code review

52665b2

Co-authored-by: Letha <letha@mondoo.com>

This comment has been minimized.

Sign in to view

🎉 verify tailscale connection

175517d

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>

afiune requested review from misterpantz and tas50 February 18, 2025 22:06

chris-rock merged commit f6fb570 into main Feb 18, 2025
17 checks passed

chris-rock deleted the afiune/tailscale branch February 18, 2025 22:14

github-actions bot locked and limited conversation to collaborators Feb 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ tailscale provider #5214

✨ tailscale provider #5214

afiune commented Feb 13, 2025 •

edited

Loading

This comment has been minimized.

github-actions bot commented Feb 13, 2025 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

chris-rock left a comment

chris-rock Feb 14, 2025

chris-rock Feb 14, 2025

afiune Feb 18, 2025

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

misterpantz left a comment

misterpantz Feb 18, 2025

chris-rock Feb 18, 2025

afiune Feb 18, 2025

This comment has been minimized.

afiune commented Feb 18, 2025

	// a) The last time any of the user's nodes were connected to the network
	// a) The last time any of the user's nodes were connected to the network
	// or

✨ tailscale provider #5214

✨ tailscale provider #5214

Conversation

afiune commented Feb 13, 2025 • edited Loading

✨ Tailscale Provider

Examples

Advanced usage

This comment has been minimized.

github-actions bot commented Feb 13, 2025 • edited Loading

Test Results

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

chris-rock left a comment

Choose a reason for hiding this comment

chris-rock Feb 14, 2025

Choose a reason for hiding this comment

chris-rock Feb 14, 2025

Choose a reason for hiding this comment

afiune Feb 18, 2025

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

misterpantz left a comment

Choose a reason for hiding this comment

misterpantz Feb 18, 2025

Choose a reason for hiding this comment

chris-rock Feb 18, 2025

Choose a reason for hiding this comment

afiune Feb 18, 2025

Choose a reason for hiding this comment

This comment has been minimized.

afiune commented Feb 18, 2025

Let's go!!!!

afiune commented Feb 13, 2025 •

edited

Loading

github-actions bot commented Feb 13, 2025 •

edited

Loading