Compare commits
8
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
50dce02746 | ||
|
|
c3bd128778 | ||
|
|
04e623daa1 | ||
|
|
0d16358617 | ||
|
|
540f4b85ac | ||
|
|
ee278848ee | ||
|
|
6f912dc137 | ||
|
|
5ec943ebff |
No files matched your search
+19
-1
@@ -106,6 +106,8 @@ All notable changes to Housecarl are documented here. The format follows
|
|||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
|
- `hc user delete` asks first, as every other delete does, and takes
|
||||||
|
`-y`/`--yes` not to; it deleted the user and their tokens at once.
|
||||||
- The ruleset's diff (Changes, `hc changeset diff`, `--dry-run`) names
|
- The ruleset's diff (Changes, `hc changeset diff`, `--dry-run`) names
|
||||||
the chain each part is in on its `@@` line (`@@ -40,6 +40,8 @@ chain
|
the chain each part is in on its `@@` line (`@@ -40,6 +40,8 @@ chain
|
||||||
forward`), as `git diff` names the function, so a rule added deep in a
|
forward`), as `git diff` names the function, so a rule added deep in a
|
||||||
@@ -117,7 +119,13 @@ All notable changes to Housecarl are documented here. The format follows
|
|||||||
this version.
|
this version.
|
||||||
- Negating a match is said first: the zone, From and To fields (rules
|
- Negating a match is said first: the zone, From and To fields (rules
|
||||||
and NAT) start with "any of" / "any but" instead of a checkbox under
|
and NAT) start with "any of" / "any but" instead of a checkbox under
|
||||||
the list, and an "any but" list is tinted red.
|
the list, shown once the list has an entry, and an "any but" list is
|
||||||
|
marked with a red bar. An empty list is never saved as negated (it
|
||||||
|
matched everything anyway, but would have negated what was added to
|
||||||
|
it later).
|
||||||
|
- docs/rules.md: "Matching everything but a few", on leaving some
|
||||||
|
addresses out with a zone and "any but", and what to do when the range
|
||||||
|
isn't a zone.
|
||||||
- The rule dialog shows only the zone fields its chain can use: no
|
- The rule dialog shows only the zone fields its chain can use: no
|
||||||
"Going out on" for input and early, no "Coming in on" for output
|
"Going out on" for input and early, no "Coming in on" for output
|
||||||
(they could only be refused). A zone left in a field the chain hides
|
(they could only be refused). A zone left in a field the chain hides
|
||||||
@@ -136,6 +144,16 @@ All notable changes to Housecarl are documented here. The format follows
|
|||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
|
- A history entry's ruleset diff showed the object it changed as moved:
|
||||||
|
stepping back put the old form at the end of its list, so updating
|
||||||
|
one port forward (turning hairpin off) also showed its forward and
|
||||||
|
DNAT lines moving down. The diff is now only what the change did, and
|
||||||
|
its sides are named `before N` and `after N` instead of `now`.
|
||||||
|
- Ruleset diffs numbered the hunks after one with a moved line too early
|
||||||
|
on the new side (`@@ -76,9 +74,9 @@` for `+76,9`), so the chain named
|
||||||
|
after `@@` could be the one before (`chain output` for a hunk in
|
||||||
|
`chain dstnat`). go-udiff miscounts them; Housecarl now numbers them
|
||||||
|
itself.
|
||||||
- The dashboard's bar for a per-address quota showed only the busiest
|
- The dashboard's bar for a per-address quota showed only the busiest
|
||||||
address, so one address that used up its allowance filled it (100%).
|
address, so one address that used up its allowance filled it (100%).
|
||||||
The bar is now all the addresses together, and the dashboard and the
|
The bar is now all the addresses together, and the dashboard and the
|
||||||
|
|||||||
@@ -128,7 +128,7 @@ The web UI is on `http://127.0.0.1:8070/` (see `listen` in
|
|||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
Housecarl 0.2.0 is in testing (0.2.0-rc.3+52e6a98): zones, address sets and
|
Housecarl 0.2.0 is in testing (0.2.0-rc.3+git64-c3bd128): zones, address sets and
|
||||||
services with ordered rules, IPv4 and IPv6, port forwards with hairpin NAT
|
services with ordered rules, IPv4 and IPv6, port forwards with hairpin NAT
|
||||||
and IPv6 pinholes, source NAT and redirects, built-ins, probation for
|
and IPv6 pinholes, source NAT and redirects, built-ins, probation for
|
||||||
network changes (confirmed by the client that made them), the ruleset
|
network changes (confirmed by the client that made them), the ruleset
|
||||||
|
|||||||
+8
-2
@@ -349,9 +349,13 @@ operator, log) or grants such as --grant config:read --grant sets:write:guests.
|
|||||||
f.BoolVar(&enable, "enable", false, "enable the user again")
|
f.BoolVar(&enable, "enable", false, "enable the user again")
|
||||||
f.StringVar(&comment, "comment", "", "a comment")
|
f.StringVar(&comment, "comment", "", "a comment")
|
||||||
cmd.AddCommand(update)
|
cmd.AddCommand(update)
|
||||||
cmd.AddCommand(&cobra.Command{
|
var yes bool
|
||||||
|
del := &cobra.Command{
|
||||||
Use: "delete USER", Short: "Delete a user and their tokens", Args: cobra.ExactArgs(1),
|
Use: "delete USER", Short: "Delete a user and their tokens", Args: cobra.ExactArgs(1),
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
if !confirm(fmt.Sprintf("Delete user %s and their tokens?", args[0]), yes) {
|
||||||
|
return fmt.Errorf("not deleted")
|
||||||
|
}
|
||||||
id, err := userID(args[0])
|
id, err := userID(args[0])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -365,7 +369,9 @@ operator, log) or grants such as --grant config:read --grant sets:write:guests.
|
|||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
})
|
}
|
||||||
|
del.Flags().BoolVarP(&yes, "yes", "y", false, "don't ask")
|
||||||
|
cmd.AddCommand(del)
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -135,6 +135,14 @@ As for Jarl and Steward:
|
|||||||
3. Run `make test && make e2e`.
|
3. Run `make test && make e2e`.
|
||||||
4. Commit as "Release X", tag it `git tag -a vX -m "Housecarl X"`, and push.
|
4. Commit as "Release X", tag it `git tag -a vX -m "Housecarl X"`, and push.
|
||||||
|
|
||||||
|
A fix to a release candidate may go out as a build of it rather than a
|
||||||
|
new candidate: `0.2.0-rc.3+git<count>-<commit>`, where `<commit>` is the
|
||||||
|
short ID of the last commit before "Release X" and `<count>` is `git
|
||||||
|
rev-list --count` of it. The count orders the builds (apt compares it as a
|
||||||
|
number; the ID alone would order them at random); each sorts after
|
||||||
|
`0.2.0-rc.3` and before `0.2.0-rc.4`. Debian writes it
|
||||||
|
`0.2.0~rc.3+git<count>~<commit>`.
|
||||||
|
|
||||||
The tag starts `.gitea/workflows/release.yml`, which checks the tag
|
The tag starts `.gitea/workflows/release.yml`, which checks the tag
|
||||||
against `VERSION` and the CHANGELOG, runs the tests, builds the tarballs,
|
against `VERSION` and the CHANGELOG, runs the tests, builds the tarballs,
|
||||||
the CLI for each OS and the `.deb`s, and publishes them
|
the CLI for each OS and the `.deb`s, and publishes them
|
||||||
|
|||||||
@@ -165,6 +165,40 @@ hc rule add forward --in wan --status dnat
|
|||||||
hc rule add forward --in wan -a drop
|
hc rule add forward --in wan -a drop
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Matching everything but a few
|
||||||
|
|
||||||
|
A field matches **any of** its entries, or with `--not-…` ("any but" in
|
||||||
|
the web UI) anything else; it can't do both. "The LAN except the NAS" is
|
||||||
|
still one rule: the zone says which network, and the addresses say which
|
||||||
|
of it to leave out, because zones and addresses are different fields and
|
||||||
|
a rule needs all of them to match.
|
||||||
|
|
||||||
|
| What you want | One rule |
|
||||||
|
|---|---|
|
||||||
|
| the LAN, except the NAS | `--in lan --from nas --not-from` |
|
||||||
|
| everyone on guest, except one device, has a quota | `--in guest --from tv --not-from --quota 10gbytes,over,daily` |
|
||||||
|
| the internet, except one host | `--out wan --to blocked --not-to` |
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Each device on the LAN: 50 GB a month, but not the NAS (its backups)
|
||||||
|
hc rule add forward --in lan --out wan --from nas --not-from --quota 50gbytes,over,per-source,monthly -a drop
|
||||||
|
```
|
||||||
|
|
||||||
|
Leaving part of an address range out ("10.0.0.0/8 except 10.0.5.0/24")
|
||||||
|
when it isn't a zone takes one of:
|
||||||
|
|
||||||
|
* **Two rules, the exception first**, when the exception gets the
|
||||||
|
opposite action: `--from 10.0.5.0/24 -a drop` above `--from
|
||||||
|
10.0.0.0/8`. There is no action that skips a rule and goes on, so this
|
||||||
|
doesn't work when the exception should just fall through to later
|
||||||
|
rules.
|
||||||
|
* **Ranges around the hole**: `--from 10.0.0.0-10.0.4.255 --from
|
||||||
|
10.0.6.0-10.255.255.255`.
|
||||||
|
* **A [raw rule](#raw-rules)**: `ip saddr 10.0.0.0/8 ip saddr != 10.0.5.0/24 accept`.
|
||||||
|
|
||||||
|
There's no need to leave a zone out of other zones: an interface belongs
|
||||||
|
to one zone, so "any of lan, guest" already leaves out everything else.
|
||||||
|
|
||||||
### Bandwidth and quotas
|
### Bandwidth and quotas
|
||||||
|
|
||||||
A **byte rate** limits bandwidth: `--limit 20mbytes/second,over,per-source
|
A **byte rate** limits bandwidth: `--limit 20mbytes/second,over,per-source
|
||||||
|
|||||||
@@ -335,6 +335,8 @@ func Rewind(st *model.State, h *model.HistoryEntry) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
// put appends what it brings back; its position puts it in place.
|
||||||
|
st.Sort()
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
package server
|
package server
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
@@ -70,3 +72,68 @@ func TestHistoryDiff(t *testing.T) {
|
|||||||
t.Errorf("unknown entry: %d", code)
|
t.Errorf("unknown entry: %d", code)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestHunkStarts: after a hunk with unchanged lines between its edits (a
|
||||||
|
// moved line), the later hunks' new sides start where they do.
|
||||||
|
func TestHunkStarts(t *testing.T) {
|
||||||
|
var a, b strings.Builder
|
||||||
|
for i := 1; i <= 20; i++ {
|
||||||
|
fmt.Fprintf(&a, "%d\n", i)
|
||||||
|
switch i {
|
||||||
|
case 4:
|
||||||
|
case 6:
|
||||||
|
b.WriteString("6\n4\n")
|
||||||
|
case 14:
|
||||||
|
default:
|
||||||
|
fmt.Fprintf(&b, "%d\n", i)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
diff := hunkStarts(udiff.Unified("a", "b", a.String(), b.String()))
|
||||||
|
var heads []string
|
||||||
|
for _, l := range strings.Split(diff, "\n") {
|
||||||
|
if strings.HasPrefix(l, "@@") {
|
||||||
|
heads = append(heads, l)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// diff -u: the move nets nothing, the deleted 14 one line.
|
||||||
|
if want := []string{"@@ -1,9 +1,9 @@", "@@ -11,7 +11,6 @@"}; strings.Join(heads, "|") != strings.Join(want, "|") {
|
||||||
|
t.Fatalf("hunk headers %q, want %q\n%s", heads, want, diff)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHistoryDiffUpdate: an update's diff is only what it changed; the
|
||||||
|
// object stepped back to its old form stays where it was.
|
||||||
|
func TestHistoryDiffUpdate(t *testing.T) {
|
||||||
|
e := newEnv(t)
|
||||||
|
e.call(e.token, "POST", "/zones", model.Zone{Name: "lan", Interfaces: []string{"eth1"}}, nil)
|
||||||
|
e.call(e.token, "POST", "/zones", model.Zone{Name: "wan", Interfaces: []string{"wan"}, External: true}, nil)
|
||||||
|
var ids []int64
|
||||||
|
for i, port := range []string{"8096", "443", "50300", "7777", "25"} {
|
||||||
|
var mr api.MutationResponse
|
||||||
|
e.call(e.token, "POST", "/forwards", map[string]any{"name": "f" + port, "ports": port, "to": fmt.Sprintf("10.0.10.%d", 30+i),
|
||||||
|
"public_addresses": []string{"203.0.113.1"}, "hairpin": true}, &mr)
|
||||||
|
var f model.PortForward
|
||||||
|
if err := json.Unmarshal(mr.Object, &f); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ids = append(ids, f.ID)
|
||||||
|
}
|
||||||
|
var mr api.MutationResponse
|
||||||
|
if code := e.call(e.token, "PATCH", "/forwards/"+itoa(ids[2]), map[string]any{"hairpin": false}, &mr); code != 200 {
|
||||||
|
t.Fatalf("update: %d", code)
|
||||||
|
}
|
||||||
|
var out struct{ Diff string }
|
||||||
|
if code := e.call(e.token, "GET", "/history/"+itoa(mr.HistoryID)+"/diff", nil, &out); code != 200 {
|
||||||
|
t.Fatalf("diff: %d", code)
|
||||||
|
}
|
||||||
|
var changed []string
|
||||||
|
for _, l := range strings.Split(out.Diff, "\n") {
|
||||||
|
if (strings.HasPrefix(l, "+") || strings.HasPrefix(l, "-")) && !strings.HasPrefix(l, "+++") && !strings.HasPrefix(l, "---") {
|
||||||
|
changed = append(changed, l)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(changed) != 1 || !strings.HasPrefix(changed[0], "-") || !strings.Contains(changed[0], "-hairpin") ||
|
||||||
|
!strings.Contains(out.Diff, "(before "+itoa(mr.HistoryID)+")") || !strings.Contains(out.Diff, "@@ chain srcnat") {
|
||||||
|
t.Errorf("entry %d's diff, want only the hairpin line gone, in chain srcnat:\n%s", mr.HistoryID, out.Diff)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,6 +3,7 @@ package server
|
|||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"sort"
|
"sort"
|
||||||
@@ -98,11 +99,71 @@ func (s *Server) respondChange(w http.ResponseWriter, r *http.Request, p *auth.P
|
|||||||
// rulesetDiff is the unified diff of the rulesets two configurations
|
// rulesetDiff is the unified diff of the rulesets two configurations
|
||||||
// make: the file housecarl-ruleset.service loads, now and after.
|
// make: the file housecarl-ruleset.service loads, now and after.
|
||||||
func (s *Server) rulesetDiff(before, after *model.State) string {
|
func (s *Server) rulesetDiff(before, after *model.State) string {
|
||||||
|
return s.labeledDiff(before, after, "now", "after")
|
||||||
|
}
|
||||||
|
|
||||||
|
// labeledDiff is rulesetDiff with its own names for the two sides.
|
||||||
|
func (s *Server) labeledDiff(before, after *model.State, from, to string) string {
|
||||||
if before == nil || after == nil {
|
if before == nil || after == nil {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
now, then := s.fw.Render(before).Text, s.fw.Render(after).Text
|
now, then := s.fw.Render(before).Text, s.fw.Render(after).Text
|
||||||
return blockHeaders(udiff.Unified("ruleset.nft (now)", "ruleset.nft (after)", now, then), now, then)
|
diff := hunkStarts(udiff.Unified("ruleset.nft ("+from+")", "ruleset.nft ("+to+")", now, then))
|
||||||
|
return blockHeaders(diff, now, then)
|
||||||
|
}
|
||||||
|
|
||||||
|
// hunkStarts numbers each hunk's new side again, from its old side and
|
||||||
|
// the lines the hunks before it added and removed. go-udiff (v0.4.1)
|
||||||
|
// leaves out of its count the unchanged lines between two edits of one
|
||||||
|
// hunk, so after a hunk like a moved line every later one started too
|
||||||
|
// early ("@@ -76,9 +74,9 @@" for "+76,9"), and blockHeaders named the
|
||||||
|
// chain before it.
|
||||||
|
func hunkStarts(diff string) string {
|
||||||
|
lines := strings.SplitAfter(diff, "\n")
|
||||||
|
delta := 0
|
||||||
|
for i := 0; i < len(lines); i++ {
|
||||||
|
f := strings.Fields(lines[i])
|
||||||
|
if !strings.HasPrefix(lines[i], "@@ ") || len(f) < 4 || f[3] != "@@" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
start, _, _ := strings.Cut(f[1][1:], ",")
|
||||||
|
from, err := strconv.Atoi(start)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
oldN, newN := 0, 0
|
||||||
|
for _, l := range lines[i+1:] {
|
||||||
|
if strings.HasPrefix(l, "@@ ") {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case strings.HasPrefix(l, "-"):
|
||||||
|
oldN++
|
||||||
|
case strings.HasPrefix(l, "+"):
|
||||||
|
newN++
|
||||||
|
case strings.HasPrefix(l, " "):
|
||||||
|
oldN++
|
||||||
|
newN++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// An empty side is numbered by the line before it.
|
||||||
|
first := from
|
||||||
|
if oldN == 0 {
|
||||||
|
first++
|
||||||
|
}
|
||||||
|
to := first + delta
|
||||||
|
if newN == 0 {
|
||||||
|
to--
|
||||||
|
}
|
||||||
|
side := "+" + strconv.Itoa(to)
|
||||||
|
if newN > 1 {
|
||||||
|
side += "," + strconv.Itoa(newN)
|
||||||
|
}
|
||||||
|
f[2] = side
|
||||||
|
lines[i] = strings.Join(f, " ") + "\n"
|
||||||
|
delta += newN - oldN
|
||||||
|
}
|
||||||
|
return strings.Join(lines, "")
|
||||||
}
|
}
|
||||||
|
|
||||||
// blockHeaders names, after each hunk's @@ line, the chain (or other
|
// blockHeaders names, after each hunk's @@ line, the chain (or other
|
||||||
@@ -705,7 +766,8 @@ func (s *Server) historyDiff(w http.ResponseWriter, r *http.Request, p *auth.Pri
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
writeJSON(w, http.StatusOK, map[string]string{"diff": s.rulesetDiff(st, after)})
|
before, done := fmt.Sprintf("before %d", id), fmt.Sprintf("after %d", id)
|
||||||
|
writeJSON(w, http.StatusOK, map[string]string{"diff": s.labeledDiff(st, after, before, done)})
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -382,7 +382,7 @@ pre.wrap { white-space: pre-wrap; word-break: break-all; font-size: 12px; }
|
|||||||
.negatable { display: flex; gap: 8px; align-items: flex-start; flex-wrap: wrap; }
|
.negatable { display: flex; gap: 8px; align-items: flex-start; flex-wrap: wrap; }
|
||||||
.negatable > .list-editor { flex: 1; min-width: 0; }
|
.negatable > .list-editor { flex: 1; min-width: 0; }
|
||||||
.negatable.negated > select { color: var(--err); border-color: var(--err); font-weight: 600; }
|
.negatable.negated > select { color: var(--err); border-color: var(--err); font-weight: 600; }
|
||||||
.negatable.negated .list-row input { background: var(--err-soft); color: var(--del-text); border-color: var(--err); }
|
.negatable.negated .list-rows { border-left: 3px solid var(--err); padding-left: 8px; }
|
||||||
input.short { width: 7em; }
|
input.short { width: 7em; }
|
||||||
.builtins { margin-bottom: 10px; line-height: 1.6; }
|
.builtins { margin-bottom: 10px; line-height: 1.6; }
|
||||||
.policy { margin-top: 10px; }
|
.policy { margin-top: 10px; }
|
||||||
|
|||||||
@@ -67,13 +67,23 @@ export function listEditor(values, opts = {}) {
|
|||||||
|
|
||||||
// negatable puts "any of" / "any but" in front of a list editor, so a
|
// negatable puts "any of" / "any but" in front of a list editor, so a
|
||||||
// field says first whether it matches its entries or everything else;
|
// field says first whether it matches its entries or everything else;
|
||||||
// "any but" tints the list. value() is the list, negated() the choice.
|
// "any but" marks the list. The choice shows once the list has a row
|
||||||
|
// (empty is "any"), and an empty list is never negated. value() is the
|
||||||
|
// list, negated() the choice.
|
||||||
function negatable(list, not) {
|
function negatable(list, not) {
|
||||||
const mode = select([["", "any of"], ["not", "any but"]], not ? "not" : "", { class: "inline", "aria-label": "match these, or everything but these" });
|
const mode = select([["", "any of"], ["not", "any but"]], not ? "not" : "", { class: "inline" });
|
||||||
const box = h("div", { class: "negatable" + (not ? " negated" : "") }, mode, list);
|
const box = h("div", { class: "negatable" }, mode, list);
|
||||||
mode.addEventListener("change", () => box.classList.toggle("negated", mode.value === "not"));
|
const rows = () => list.querySelector(".list-rows").children.length;
|
||||||
|
const update = () => {
|
||||||
|
mode.classList.toggle("hidden", rows() === 0);
|
||||||
|
box.classList.toggle("negated", mode.value === "not" && rows() > 0);
|
||||||
|
};
|
||||||
|
mode.addEventListener("change", update);
|
||||||
|
// Add and remove act on their own click first; this runs after.
|
||||||
|
list.addEventListener("click", update);
|
||||||
|
update();
|
||||||
box.value = list.value;
|
box.value = list.value;
|
||||||
box.negated = () => mode.value === "not";
|
box.negated = () => mode.value === "not" && list.value().length > 0;
|
||||||
return box;
|
return box;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user