rsp2k/headscale
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

all: apply godoc [Name] link conventions across comments

Browse source 
Every Go-identifier reference in // and /* */ comments now uses
godoc's [Name] linking syntax so pkg.go.dev and `go doc` render
them as clickable cross-references. No behaviour change.

Pattern applied across the tree:
  In-package         [Foo], [Foo.Bar]
  Cross-package      [pkg.Foo], [pkg.Foo.Bar]
  Stdlib             [netip.Prefix], [errors.Is], [context.Context]
  Tailscale          [tailcfg.MapResponse], [tailcfg.Node.CapMap],
                     [tailcfg.NodeAttrSuggestExitNode]

Skip rules:
  - File:line refs left as plain text
  - HuJSON wire keys inside backtick raw strings untouched
  - ACL/policy syntax tokens (tag:foo, autogroup:self, ...) not Go
    symbols, left as plain text
  - JSON/OIDC wire keys, gorm tags, RFC IPv6 placeholders, markdown
    link tags, decorative dividers — all left as-is
This commit is contained in:
Kristoffer Dalby 2026-05-18 18:35:53 +00:00
parent 17236fd284
commit 4cca63155d
124 changed files with 1037 additions and 1011 deletions
Download patch file Download diff file Expand all files Collapse all files

10
hscontrol/util/zlog/maprequest.go
View file

@ -6,11 +6,11 @@ import (
"tailscale.com/tailcfg"
)
// SafeMapRequest wraps tailcfg.MapRequest for safe logging.
// SafeMapRequest wraps [tailcfg.MapRequest] for safe logging.
//
// SECURITY: This wrapper does not log sensitive information:
// - Endpoints: Client IP addresses and ports
// - Hostinfo: Device fingerprinting data (handled by SafeHostinfo)
// - Hostinfo: Device fingerprinting data (handled by [SafeHostinfo])
// - DERPForceWebsockets: Network configuration details
//
// Only safe fields are logged:
@ -23,12 +23,12 @@ type SafeMapRequest struct {
req *tailcfg.MapRequest
}
// MapRequest creates a SafeMapRequest wrapper for safe logging.
// MapRequest creates a [SafeMapRequest] wrapper for safe logging.
func MapRequest(req *tailcfg.MapRequest) SafeMapRequest {
return SafeMapRequest{req: req}
}
// MarshalZerologObject implements zerolog.LogObjectMarshaler.
// MarshalZerologObject implements [zerolog.LogObjectMarshaler].
func (s SafeMapRequest) MarshalZerologObject(e *zerolog.Event) {
if s.req == nil {
return
@ -46,6 +46,6 @@ func (s SafeMapRequest) MarshalZerologObject(e *zerolog.Event) {
// SECURITY: The following fields are intentionally NOT logged:
// - Endpoints: Client IP addresses and ports
// - Hostinfo: Device fingerprinting data (use SafeHostinfo separately if needed)
// - Hostinfo: Device fingerprinting data (use [SafeHostinfo] separately if needed)
// - DERPForceWebsockets: Network configuration details
}