mirror of
https://github.com/tailscale/tailscale.git
synced 2026-02-10 02:02:15 +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>
77 lines
3.5 KiB
Go
77 lines
3.5 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
// Package status contains types relating to the status of peer relay sessions
|
|
// between peer relay client nodes via a peer relay server.
|
|
package status
|
|
|
|
import (
|
|
"net/netip"
|
|
)
|
|
|
|
// ServerStatus contains the listening UDP port and active sessions (if any) for
|
|
// this node's peer relay server at a point in time.
|
|
type ServerStatus struct {
|
|
// UDPPort is the UDP port number that the peer relay server forwards over,
|
|
// as configured by the user with 'tailscale set --relay-server-port=<PORT>'.
|
|
// If the port has not been configured, UDPPort will be nil. A non-nil zero
|
|
// value signifies the user has opted for a random unused port.
|
|
UDPPort *uint16
|
|
// Sessions is a slice of detailed status information about each peer
|
|
// relay session that this node's peer relay server is involved with. It
|
|
// may be empty.
|
|
Sessions []ServerSession
|
|
}
|
|
|
|
// ClientInfo contains status-related information about a single peer relay
|
|
// client involved in a single peer relay session.
|
|
type ClientInfo struct {
|
|
// Endpoint is the [netip.AddrPort] of this peer relay client's underlay
|
|
// endpoint participating in the session, or a zero value if the client
|
|
// has not completed a handshake.
|
|
Endpoint netip.AddrPort
|
|
// ShortDisco is a string representation of this peer relay client's disco
|
|
// public key.
|
|
//
|
|
// TODO: disco keys are pretty meaningless to end users, and they are also
|
|
// ephemeral. We really need node keys (or translation to first ts addr),
|
|
// but those are not fully plumbed into the [udprelay.Server]. Disco keys
|
|
// can also be ambiguous to a node key, but we could add node key into a
|
|
// [disco.AllocateUDPRelayEndpointRequest] in similar fashion to
|
|
// [disco.Ping]. There's also the problem of netmap trimming, where we
|
|
// can't verify a node key maps to a disco key.
|
|
ShortDisco string
|
|
// PacketsTx is the number of packets this peer relay client has sent to
|
|
// the other client via the relay server after completing a handshake. This
|
|
// is identical to the number of packets that the peer relay server has
|
|
// received from this client.
|
|
PacketsTx uint64
|
|
// BytesTx is the total overlay bytes this peer relay client has sent to
|
|
// the other client via the relay server after completing a handshake. This
|
|
// is identical to the total overlay bytes that the peer relay server has
|
|
// received from this client.
|
|
BytesTx uint64
|
|
}
|
|
|
|
// ServerSession contains status information for a single session between two
|
|
// peer relay clients, which are relayed via one peer relay server. This is the
|
|
// status as seen by the peer relay server; each client node may have a
|
|
// different view of the session's current status based on connectivity and
|
|
// where the client is in the peer relay endpoint setup (allocation, binding,
|
|
// pinging, active).
|
|
type ServerSession struct {
|
|
// VNI is the Virtual Network Identifier for this peer relay session, which
|
|
// comes from the Geneve header and is unique to this session.
|
|
VNI uint32
|
|
// Client1 contains status information about one of the two peer relay
|
|
// clients involved in this session. Note that 'Client1' does NOT mean this
|
|
// was/wasn't the allocating client, or the first client to bind, etc; this
|
|
// is just one client of two.
|
|
Client1 ClientInfo
|
|
// Client2 contains status information about one of the two peer relay
|
|
// clients involved in this session. Note that 'Client2' does NOT mean this
|
|
// was/wasn't the allocating client, or the second client to bind, etc; this
|
|
// is just one client of two.
|
|
Client2 ClientInfo
|
|
}
|