Will Norris
3ec5be3f51
This file was never truly necessary and has never actually been used in the history of Tailscale's open source releases. A Brief History of AUTHORS files --- The AUTHORS file was a pattern developed at Google, originally for Chromium, then adopted by Go and a bunch of other projects. The problem was that Chromium originally had a copyright line only recognizing Google as the copyright holder. Because Google (and most open source projects) do not require copyright assignemnt for contributions, each contributor maintains their copyright. Some large corporate contributors then tried to add their own name to the copyright line in the LICENSE file or in file headers. This quickly becomes unwieldy, and puts a tremendous burden on anyone building on top of Chromium, since the license requires that they keep all copyright lines intact. The compromise was to create an AUTHORS file that would list all of the copyright holders. The LICENSE file and source file headers would then include that list by reference, listing the copyright holder as "The Chromium Authors". This also become cumbersome to simply keep the file up to date with a high rate of new contributors. Plus it's not always obvious who the copyright holder is. Sometimes it is the individual making the contribution, but many times it may be their employer. There is no way for the proejct maintainer to know. Eventually, Google changed their policy to no longer recommend trying to keep the AUTHORS file up to date proactively, and instead to only add to it when requested: https://opensource.google/docs/releasing/authors. They are also clear that: > Adding contributors to the AUTHORS file is entirely within the > project's discretion and has no implications for copyright ownership. It was primarily added to appease a small number of large contributors that insisted that they be recognized as copyright holders (which was entirely their right to do). But it's not truly necessary, and not even the most accurate way of identifying contributors and/or copyright holders. In practice, we've never added anyone to our AUTHORS file. It only lists Tailscale, so it's not really serving any purpose. It also causes confusion because Tailscalars put the "Tailscale Inc & AUTHORS" header in other open source repos which don't actually have an AUTHORS file, so it's ambiguous what that means. Instead, we just acknowledge that the contributors to Tailscale (whoever they are) are copyright holders for their individual contributions. We also have the benefit of using the DCO (developercertificate.org) which provides some additional certification of their right to make the contribution. The source file changes were purely mechanical with: git ls-files | xargs sed -i -e 's/\(Tailscale Inc &\) AUTHORS/\1 contributors/g' Updates #cleanup Change-Id: Ia101a4a3005adb9118051b3416f5a64a4a45987d Signed-off-by: Will Norris <will@tailscale.com>
98 lines
4.7 KiB
Go
98 lines
4.7 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
//go:build darwin
|
|
|
|
package cli
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
|
|
"github.com/peterbourgon/ff/v3/ffcli"
|
|
)
|
|
|
|
func init() {
|
|
maybeSysExtCmd = sysExtCmd
|
|
maybeVPNConfigCmd = vpnConfigCmd
|
|
}
|
|
|
|
// Functions in this file provide a dummy Exec function that only prints an error message for users of the open-source
|
|
// tailscaled distribution. On GUI builds, the Swift code in the macOS client handles these commands by not passing the
|
|
// flow of execution to the CLI.
|
|
|
|
// sysExtCmd returns a command for managing the Tailscale system extension on macOS
|
|
// (for the Standalone variant of the client only).
|
|
func sysExtCmd() *ffcli.Command {
|
|
return &ffcli.Command{
|
|
Name: "sysext",
|
|
ShortUsage: "tailscale configure sysext [activate|deactivate|status]",
|
|
ShortHelp: "Manage the system extension for macOS (Standalone variant)",
|
|
LongHelp: "The sysext set of commands provides a way to activate, deactivate, or manage the state of the Tailscale system extension on macOS. " +
|
|
"This is only relevant if you are running the Standalone variant of the Tailscale client for macOS. " +
|
|
"To access more detailed information about system extensions installed on this Mac, run 'systemextensionsctl list'.",
|
|
Subcommands: []*ffcli.Command{
|
|
{
|
|
Name: "activate",
|
|
ShortUsage: "tailscale configure sysext activate",
|
|
ShortHelp: "Register the Tailscale system extension with macOS.",
|
|
LongHelp: "This command registers the Tailscale system extension with macOS. To run Tailscale, you'll also need to install the VPN configuration separately (run `tailscale configure vpn-config install`). After running this command, you need to approve the extension in System Settings > Login Items and Extensions > Network Extensions.",
|
|
Exec: requiresStandalone,
|
|
},
|
|
{
|
|
Name: "deactivate",
|
|
ShortUsage: "tailscale configure sysext deactivate",
|
|
ShortHelp: "Deactivate the Tailscale system extension on macOS",
|
|
LongHelp: "This command deactivates the Tailscale system extension on macOS. To completely remove Tailscale, you'll also need to delete the VPN configuration separately (use `tailscale configure vpn-config uninstall`).",
|
|
Exec: requiresStandalone,
|
|
},
|
|
{
|
|
Name: "status",
|
|
ShortUsage: "tailscale configure sysext status",
|
|
ShortHelp: "Print the enablement status of the Tailscale system extension",
|
|
LongHelp: "This command prints the enablement status of the Tailscale system extension. If the extension is not enabled, run `tailscale sysext activate` to enable it.",
|
|
Exec: requiresStandalone,
|
|
},
|
|
},
|
|
Exec: requiresStandalone,
|
|
}
|
|
}
|
|
|
|
// vpnConfigCmd returns a command for managing the Tailscale VPN configuration on macOS
|
|
// (the entry that appears in System Settings > VPN).
|
|
func vpnConfigCmd() *ffcli.Command {
|
|
return &ffcli.Command{
|
|
Name: "mac-vpn",
|
|
ShortUsage: "tailscale configure mac-vpn [install|uninstall]",
|
|
ShortHelp: "Manage the VPN configuration on macOS (App Store and Standalone variants)",
|
|
LongHelp: "The vpn-config set of commands provides a way to add or remove the Tailscale VPN configuration from the macOS settings. This is the entry that appears in System Settings > VPN.",
|
|
Subcommands: []*ffcli.Command{
|
|
{
|
|
Name: "install",
|
|
ShortUsage: "tailscale configure mac-vpn install",
|
|
ShortHelp: "Write the Tailscale VPN configuration to the macOS settings",
|
|
LongHelp: "This command writes the Tailscale VPN configuration to the macOS settings. This is the entry that appears in System Settings > VPN. If you are running the Standalone variant of the client, you'll also need to install the system extension separately (run `tailscale configure sysext activate`).",
|
|
Exec: requiresGUI,
|
|
},
|
|
{
|
|
Name: "uninstall",
|
|
ShortUsage: "tailscale configure mac-vpn uninstall",
|
|
ShortHelp: "Delete the Tailscale VPN configuration from the macOS settings",
|
|
LongHelp: "This command removes the Tailscale VPN configuration from the macOS settings. This is the entry that appears in System Settings > VPN. If you are running the Standalone variant of the client, you'll also need to deactivate the system extension separately (run `tailscale configure sysext deactivate`).",
|
|
Exec: requiresGUI,
|
|
},
|
|
},
|
|
Exec: func(ctx context.Context, args []string) error {
|
|
return errors.New("unsupported command: requires a GUI build of the macOS client")
|
|
},
|
|
}
|
|
}
|
|
|
|
func requiresStandalone(ctx context.Context, args []string) error {
|
|
return errors.New("unsupported command: requires the Standalone (.pkg installer) GUI build of the client")
|
|
}
|
|
|
|
func requiresGUI(ctx context.Context, args []string) error {
|
|
return errors.New("unsupported command: requires a GUI build of the macOS client")
|
|
}
|