From f7cb6630e7da38bc245431257a2b383eb2261c90 Mon Sep 17 00:00:00 2001
From: Brad Fitzpatrick <bradfitz@tailscale.com>
Date: Wed, 20 Apr 2022 20:10:04 -0700
Subject: [PATCH] tailcfg: document SSHPrincipal.PubKeys URL expansions

From f74ee80abe8819f3d3bfd9138056a46820f4fc54 which lacked docs.

Updates #3802

Change-Id: Ia7df05a486ae383cc6d9aca9dfe487b04e243ad5
Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
---
 tailcfg/tailcfg.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/tailcfg/tailcfg.go b/tailcfg/tailcfg.go
index d576251a7..dfe8d7b28 100644
--- a/tailcfg/tailcfg.go
+++ b/tailcfg/tailcfg.go
@@ -1706,6 +1706,10 @@ type SSHPrincipal struct {
 	//
 	// As a special case, if len(PubKeys) == 1 and PubKeys[0] starts
 	// with "https://", then it's fetched (like https://github.com/username.keys).
+	// In that case, the following variable expansions are also supported
+	// in the URL:
+	//   * $LOGINNAME_EMAIL ("foo@bar.com" or "foo@github")
+	//   * $LOGINNAME_LOCALPART (the "foo" from either of the above)
 	PubKeys []string `json:"pubKeys,omitempty"`
 }