From 3aa6468c63792834c6effbf61eb27ea2f8147bd3 Mon Sep 17 00:00:00 2001
From: Maisem Ali <maisem@tailscale.com>
Date: Mon, 11 Dec 2023 20:54:57 +0500
Subject: [PATCH] cmd/tailscale/cli: add whois subcommand

Initial implementation of a `tailscale whois` subcommand
which allows users to observe metadata associated with a
Tailscale IP. It also has a `--json` flag to allow consumption
programmatically.

Updates #4217

Signed-off-by: Maisem Ali <maisem@tailscale.com>
---
 cmd/tailscale/cli/cli.go   |  1 +
 cmd/tailscale/cli/whois.go | 90 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 91 insertions(+)
 create mode 100644 cmd/tailscale/cli/whois.go

diff --git a/cmd/tailscale/cli/cli.go b/cmd/tailscale/cli/cli.go
index db3f2fb05..cb50cbcff 100644
--- a/cmd/tailscale/cli/cli.go
+++ b/cmd/tailscale/cli/cli.go
@@ -131,6 +131,7 @@ change in the future.
 			licensesCmd,
 			exitNodeCmd,
 			updateCmd,
+			whoisCmd,
 		},
 		FlagSet:   rootfs,
 		Exec:      func(context.Context, []string) error { return flag.ErrHelp },
diff --git a/cmd/tailscale/cli/whois.go b/cmd/tailscale/cli/whois.go
new file mode 100644
index 000000000..6c3c69da7
--- /dev/null
+++ b/cmd/tailscale/cli/whois.go
@@ -0,0 +1,90 @@
+// Copyright (c) Tailscale Inc & AUTHORS
+// SPDX-License-Identifier: BSD-3-Clause
+
+package cli
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"flag"
+	"fmt"
+	"os"
+	"strings"
+	"text/tabwriter"
+
+	"github.com/peterbourgon/ff/v3/ffcli"
+)
+
+var whoisCmd = &ffcli.Command{
+	Name:       "whois",
+	ShortUsage: "whois [--json] [ip|ip:port]",
+	ShortHelp:  "Show the machine and user associated with a Tailscale IP (v4 or v6)",
+	LongHelp: strings.TrimSpace(`
+	'tailscale whois' shows the machine and user associated with a Tailscale IP (v4 or v6).
+	`),
+	UsageFunc: usageFunc,
+	Exec:      runWhoIs,
+	FlagSet: func() *flag.FlagSet {
+		fs := newFlagSet("whois")
+		fs.BoolVar(&whoIsArgs.json, "json", false, "output in JSON format")
+		return fs
+	}(),
+}
+
+var whoIsArgs struct {
+	json bool // output in JSON format
+}
+
+func runWhoIs(ctx context.Context, args []string) error {
+	if len(args) > 1 {
+		return errors.New("too many arguments, expected at most one peer")
+	} else if len(args) == 0 {
+		return errors.New("missing argument, expected one peer")
+	}
+	who, err := localClient.WhoIs(ctx, args[0])
+	if err != nil {
+		return err
+	}
+	if whoIsArgs.json {
+		ec := json.NewEncoder(Stdout)
+		ec.SetIndent("", "  ")
+		ec.Encode(who)
+		return nil
+	}
+
+	w := tabwriter.NewWriter(os.Stdout, 10, 5, 5, ' ', 0)
+	fmt.Fprintf(w, "Machine:\n")
+	fmt.Fprintf(w, "  Name:\t%s\n", strings.TrimSuffix(who.Node.Name, "."))
+	fmt.Fprintf(w, "  ID:\t%s\n", who.Node.StableID)
+	fmt.Fprintf(w, "  Addresses:\t%s\n", who.Node.Addresses)
+	if len(who.Node.AllowedIPs) > 2 {
+		fmt.Fprintf(w, "  AllowedIPs:\t%s\n", who.Node.AllowedIPs[2:])
+	}
+	if who.Node.IsTagged() {
+		fmt.Fprintf(w, "  Tags:\t%s\n", strings.Join(who.Node.Tags, ", "))
+	} else {
+		fmt.Fprintln(w, "User:")
+		fmt.Fprintf(w, "  Name:\t%s\n", who.UserProfile.LoginName)
+		fmt.Fprintf(w, "  ID:\t%d\n", who.UserProfile.ID)
+	}
+	w.Flush()
+	w = nil // avoid accidental use
+
+	if cm := who.CapMap; len(cm) > 0 {
+		printf("Capabilities:\n")
+		for cap, vals := range cm {
+			// To make the output more readable, we have to reindent the JSON
+			// values so they line up with the cap name.
+			if len(vals) > 0 {
+				v, _ := json.MarshalIndent(vals, "      ", "  ")
+
+				printf("  - %s:\n", cap)
+				printf("      %s\n", v)
+			} else {
+				printf("  - %s\n", cap)
+			}
+		}
+	}
+	return nil
+}