mirror of
https://github.com/tailscale/tailscale.git
synced 2026-02-09 17:52:57 +01: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>
76 lines
2.7 KiB
Go
76 lines
2.7 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
package packet
|
|
|
|
import (
|
|
"io"
|
|
"net/netip"
|
|
"time"
|
|
)
|
|
|
|
// Callback describes a function which is called to
|
|
// record packets when debugging packet-capture.
|
|
// Such callbacks must not take ownership of the
|
|
// provided data slice: it may only copy out of it
|
|
// within the lifetime of the function.
|
|
type CaptureCallback func(CapturePath, time.Time, []byte, CaptureMeta)
|
|
|
|
// CaptureSink is the minimal interface from [tailscale.com/feature/capture]'s
|
|
// Sink type that is needed by the core (magicsock/LocalBackend/wgengine/etc).
|
|
// This lets the relativel heavy feature/capture package be optionally linked.
|
|
type CaptureSink interface {
|
|
// Close closes
|
|
Close() error
|
|
|
|
// NumOutputs returns the number of outputs registered with the sink.
|
|
NumOutputs() int
|
|
|
|
// CaptureCallback returns a callback which can be used to
|
|
// write packets to the sink.
|
|
CaptureCallback() CaptureCallback
|
|
|
|
// WaitCh returns a channel which blocks until
|
|
// the sink is closed.
|
|
WaitCh() <-chan struct{}
|
|
|
|
// RegisterOutput connects an output to this sink, which
|
|
// will be written to with a pcap stream as packets are logged.
|
|
// A function is returned which unregisters the output when
|
|
// called.
|
|
//
|
|
// If w implements io.Closer, it will be closed upon error
|
|
// or when the sink is closed. If w implements http.Flusher,
|
|
// it will be flushed periodically.
|
|
RegisterOutput(w io.Writer) (unregister func())
|
|
}
|
|
|
|
// CaptureMeta contains metadata that is used when debugging.
|
|
type CaptureMeta struct {
|
|
DidSNAT bool // SNAT was performed & the address was updated.
|
|
OriginalSrc netip.AddrPort // The source address before SNAT was performed.
|
|
DidDNAT bool // DNAT was performed & the address was updated.
|
|
OriginalDst netip.AddrPort // The destination address before DNAT was performed.
|
|
}
|
|
|
|
// CapturePath describes where in the data path the packet was captured.
|
|
type CapturePath uint8
|
|
|
|
// CapturePath values
|
|
const (
|
|
// FromLocal indicates the packet was logged as it traversed the FromLocal path:
|
|
// i.e.: A packet from the local system into the TUN.
|
|
FromLocal CapturePath = 0
|
|
// FromPeer indicates the packet was logged upon reception from a remote peer.
|
|
FromPeer CapturePath = 1
|
|
// SynthesizedToLocal indicates the packet was generated from within tailscaled,
|
|
// and is being routed to the local machine's network stack.
|
|
SynthesizedToLocal CapturePath = 2
|
|
// SynthesizedToPeer indicates the packet was generated from within tailscaled,
|
|
// and is being routed to a remote Wireguard peer.
|
|
SynthesizedToPeer CapturePath = 3
|
|
|
|
// PathDisco indicates the packet is information about a disco frame.
|
|
PathDisco CapturePath = 254
|
|
)
|