mirror of
https://github.com/tailscale/tailscale.git
synced 2026-02-13 09:21:47 -05:00
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>
101 lines
4.3 KiB
Go
101 lines
4.3 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
//go:build !ios && !js
|
|
|
|
package magicsock
|
|
|
|
import (
|
|
"log"
|
|
"net/netip"
|
|
"strings"
|
|
"sync"
|
|
|
|
"tailscale.com/envknob"
|
|
)
|
|
|
|
// Various debugging and experimental tweakables, set by environment
|
|
// variable.
|
|
var (
|
|
// debugDisco prints verbose logs of active discovery events as
|
|
// they happen.
|
|
debugDisco = envknob.RegisterBool("TS_DEBUG_DISCO")
|
|
// debugPeerMap prints verbose logs of changes to the peermap.
|
|
debugPeerMap = envknob.RegisterBool("TS_DEBUG_MAGICSOCK_PEERMAP")
|
|
// debugOmitLocalAddresses removes all local interface addresses
|
|
// from magicsock's discovered local endpoints. Used in some tests.
|
|
debugOmitLocalAddresses = envknob.RegisterBool("TS_DEBUG_OMIT_LOCAL_ADDRS")
|
|
// logDerpVerbose logs all received DERP packets, including their
|
|
// full payload.
|
|
logDerpVerbose = envknob.RegisterBool("TS_DEBUG_DERP")
|
|
// debugReSTUNStopOnIdle unconditionally enables the "shut down
|
|
// STUN if magicsock is idle" behavior that normally only triggers
|
|
// on mobile devices, lowers the shutdown interval, and logs more
|
|
// verbosely about idle measurements.
|
|
debugReSTUNStopOnIdle = envknob.RegisterBool("TS_DEBUG_RESTUN_STOP_ON_IDLE")
|
|
// debugAlwaysDERP disables the use of UDP, forcing all peer communication over DERP.
|
|
debugAlwaysDERP = envknob.RegisterBool("TS_DEBUG_ALWAYS_USE_DERP")
|
|
// debugDERPAddr sets the derp address manually, overriding the DERP map from control.
|
|
debugUseDERPAddr = envknob.RegisterString("TS_DEBUG_USE_DERP_ADDR")
|
|
// debugDERPUseHTTP tells clients to connect to DERP via HTTP on port 3340 instead of
|
|
// HTTPS on 443.
|
|
debugUseDERPHTTP = envknob.RegisterBool("TS_DEBUG_USE_DERP_HTTP")
|
|
// debugEnableSilentDisco disables the use of heartbeatTimer on the endpoint struct
|
|
// and attempts to handle disco silently. See issue #540 for details.
|
|
debugEnableSilentDisco = envknob.RegisterBool("TS_DEBUG_ENABLE_SILENT_DISCO")
|
|
// debugSendCallMeUnknownPeer sends a CallMeMaybe to a non-existent destination every
|
|
// time we send a real CallMeMaybe to test the PeerGoneNotHere logic.
|
|
debugSendCallMeUnknownPeer = envknob.RegisterBool("TS_DEBUG_SEND_CALLME_UNKNOWN_PEER")
|
|
// debugBindSocket prints extra debugging about socket rebinding in magicsock.
|
|
debugBindSocket = envknob.RegisterBool("TS_DEBUG_MAGICSOCK_BIND_SOCKET")
|
|
// debugRingBufferMaxSizeBytes overrides the default size of the endpoint
|
|
// history ringbuffer.
|
|
debugRingBufferMaxSizeBytes = envknob.RegisterInt("TS_DEBUG_MAGICSOCK_RING_BUFFER_MAX_SIZE_BYTES")
|
|
// debugEnablePMTUD enables the peer MTU feature, which does path MTU
|
|
// discovery on UDP connections between peers. Currently (2023-09-05)
|
|
// this only turns on the don't fragment bit for the magicsock UDP
|
|
// sockets.
|
|
//
|
|
//lint:ignore U1000 used on Linux/Darwin only
|
|
debugEnablePMTUD = envknob.RegisterOptBool("TS_DEBUG_ENABLE_PMTUD")
|
|
// debugPMTUD prints extra debugging about peer MTU path discovery.
|
|
//
|
|
//lint:ignore U1000 used on Linux/Darwin only
|
|
debugPMTUD = envknob.RegisterBool("TS_DEBUG_PMTUD")
|
|
// debugNeverDirectUDP disables the use of direct UDP connections, forcing
|
|
// all peer communication over DERP or peer relay.
|
|
debugNeverDirectUDP = envknob.RegisterBool("TS_DEBUG_NEVER_DIRECT_UDP")
|
|
// Hey you! Adding a new debugknob? Make sure to stub it out in the
|
|
// debugknobs_stubs.go file too.
|
|
)
|
|
|
|
// inTest reports whether the running program is a test that set the
|
|
// IN_TS_TEST environment variable.
|
|
//
|
|
// Unlike the other debug tweakables above, this one needs to be
|
|
// checked every time at runtime, because tests set this after program
|
|
// startup.
|
|
func inTest() bool { return envknob.Bool("IN_TS_TEST") }
|
|
|
|
// pretendpoints returns TS_DEBUG_PRETENDPOINT as []AddrPort, if set.
|
|
// See https://github.com/tailscale/tailscale/issues/12578 and
|
|
// https://github.com/tailscale/tailscale/pull/12735.
|
|
//
|
|
// It can be between 0 and 3 comma-separated AddrPorts.
|
|
var pretendpoints = sync.OnceValue(func() (ret []netip.AddrPort) {
|
|
all := envknob.String("TS_DEBUG_PRETENDPOINT")
|
|
const max = 3
|
|
remain := all
|
|
for remain != "" && len(ret) < max {
|
|
var s string
|
|
s, remain, _ = strings.Cut(remain, ",")
|
|
ap, err := netip.ParseAddrPort(s)
|
|
if err != nil {
|
|
log.Printf("ignoring invalid AddrPort %q in TS_DEBUG_PRETENDPOINT %q: %v", s, all, err)
|
|
continue
|
|
}
|
|
ret = append(ret, ap)
|
|
}
|
|
return
|
|
})
|