happyDomain/checker-srv
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Include rules section

Browse source
This commit is contained in:
nemunaire 2026-04-30 08:46:46 +07:00
commit 0941d89716
1 changed files with 12 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

70
README.md
View file

@ -64,53 +64,19 @@ make docker CHECKER_VERSION=1.2.3
Set the `endpoint` admin option for the SRV checker to the URL of the running checker-srv server (e.g., `http://checker-srv:8080`). happyDomain will delegate observation collection to this endpoint. Set the `endpoint` admin option for the SRV checker to the URL of the running checker-srv server (e.g., `http://checker-srv:8080`). happyDomain will delegate observation collection to this endpoint.
## Protocol ## Rules
### POST /collect | Code | Description | Severity |
|-------------------------------|---------------------------------------------------------------------------------------------------|---------------------|
Request: | `srv_records_present` | At least one SRV record is published for this service. | CRITICAL |
```json | `srv_null_target` | Detects SRV records with target `.`, signaling the service is intentionally not available. | WARNING |
{ | `srv_target_not_cname` | RFC 2782: SRV targets must resolve directly to A/AAAA, not through a CNAME. | WARNING |
"key": "srv_records", | `srv_targets_resolve` | Every SRV target resolves to at least one A/AAAA address. | CRITICAL |
"target": {"userId": "...", "domainId": "...", "serviceId": "..."}, | `srv_port_valid` | SRV records advertise a non-zero port that clients can actually connect to. | CRITICAL |
"options": { | `srv_priority_weight_sanity` | Priority/weight values follow RFC 2782 conventions (failover present, weights meaningful). | WARNING |
"service": {"_svctype": "svcs.UnknownSRV", "Service": {"srv": [ /* dns.SRV records */ ]}}, | `srv_tcp_reachable` | Every TCP SRV `target:port` accepts a TCP connection. | CRITICAL |
"subdomain": "_sip._tcp", | `srv_udp_reachable` | UDP SRV targets do not return ICMP port-unreachable. | WARNING |
"domain": "example.com", | `srv_redundancy` | At least two distinct SRV targets exist (avoids single point of failure). | INFO |
"tcpTimeout": 3000,
"udpTimeout": 2000
}
}
```
Response:
```json
{
"data": {
"serviceDomain": "_sip._tcp.example.com",
"records": [
{
"service": "sip",
"proto": "tcp",
"owner": "_sip._tcp.example.com",
"target": "sip1.example.com",
"port": 5061,
"priority": 10,
"weight": 20,
"addresses": ["203.0.113.5"],
"probes": [
{
"address": "203.0.113.5:5061",
"proto": "tcp",
"connected": true,
"latencyMs": 12.4
}
]
}
]
}
}
```
## Discovered TLS endpoints ## Discovered TLS endpoints
@ -132,18 +98,6 @@ so that the TLS checker can probe the targets without re-parsing SRV data:
Null targets (`.`) and unknown service names are skipped. SNI is set to Null targets (`.`) and unknown service names are skipped. SNI is set to
the SRV target hostname. the SRV target hostname.
## Rules
| Name | Description |
|---|---|
| `srv_records_present` | At least one SRV record is published. |
| `srv_null_target` | Detects `"."` targets (RFC 2782, service intentionally unavailable). |
| `srv_target_not_cname` | Warns when an SRV target is a CNAME (RFC 2782 violation). |
| `srv_targets_resolve` | Every target resolves to at least one A/AAAA. |
| `srv_tcp_reachable` | Every `_tcp` SRV `target:port` accepts a TCP connection. |
| `srv_udp_reachable` | UDP targets do not return ICMP port-unreachable. |
| `srv_redundancy` | At least two distinct targets exist (no single point of failure). |
## License & licensing roadmap ## License & licensing roadmap
This project is currently licensed under the **GNU Affero General Public This project is currently licensed under the **GNU Affero General Public