checker-ping/checker/rules_ipv6.go
Pierre-Olivier Mercier 2aa596afd5 Address publication review feedback
Add the AGPL LICENSE file and a deployment-security note in the README
to clarify that the unauthenticated /collect endpoint must run on a
trusted network.

Fix the IPv6 reachability rule so it consults the IP actually probed:
PingTargetResult now carries ResolvedIP populated from pinger.IPAddr(),
which lets the rule classify hostname targets correctly instead of
always reporting "No IPv6 target pinged".

Tighten error handling: ipsFromService now propagates JSON errors,
ExtractMetrics wraps decode failures, the count option returns an
explicit error when out of range instead of silently clamping, and the
"all pings failed" message no longer concatenates every per-target
error. Threshold validation is factored into validateThresholdPair and
shared between the RTT and packet-loss rules.

Add unit tests covering address resolution, threshold validation, and
each rule's evaluation paths.
2026-04-26 18:05:47 +07:00

81 lines
2.4 KiB
Go

// This file is part of the happyDomain (R) project.
// Copyright (c) 2020-2026 happyDomain
// Authors: Pierre-Olivier Mercier, et al.
//
// This program is offered under a commercial and under the AGPL license.
// For commercial licensing, contact us at <contact@happydomain.org>.
//
// For AGPL licensing:
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package checker
import (
"context"
sdk "git.happydns.org/checker-sdk-go/checker"
)
// ipv6ReachabilityRule verifies at least one IPv6 target replied to a probe.
// The rule is skipped (StatusUnknown) when no IPv6 target was pinged, which
// is expected for IPv4-only hosts.
type ipv6ReachabilityRule struct{}
func (r *ipv6ReachabilityRule) Name() string { return "ping.ipv6_reachable" }
func (r *ipv6ReachabilityRule) Description() string {
return "Verifies that at least one IPv6 target replied to an ICMP probe."
}
func (r *ipv6ReachabilityRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, _ sdk.CheckerOptions) []sdk.CheckState {
data, errSt := loadPingData(ctx, obs)
if errSt != nil {
return []sdk.CheckState{*errSt}
}
var ipv6Total, ipv6Reachable int
for _, t := range data.Targets {
probed := t.ResolvedIP
if probed == "" {
probed = t.Address
}
if !isIPv6(probed) {
continue
}
ipv6Total++
if t.Received > 0 {
ipv6Reachable++
}
}
switch {
case ipv6Total == 0:
return []sdk.CheckState{{
Status: sdk.StatusUnknown,
Message: "No IPv6 target pinged.",
Code: "ping.ipv6_reachable.skipped",
}}
case ipv6Reachable == 0:
return []sdk.CheckState{{
Status: sdk.StatusWarn,
Message: "No IPv6 target replied to ICMP probes.",
Code: "ping.ipv6_reachable.unreachable",
}}
default:
return []sdk.CheckState{{
Status: sdk.StatusOK,
Message: "At least one IPv6 target is reachable.",
Code: "ping.ipv6_reachable.ok",
}}
}
}