Compare commits
103
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8f7ce7df50 | ||
|
|
419c682a71 | ||
|
|
3804c33669 | ||
|
|
d9060a6eb7 | ||
|
|
a039fcaafc | ||
|
|
7418a9b77a | ||
|
|
9848ffc2bc | ||
|
|
8326040d31 | ||
|
|
fdbb39d994 | ||
|
|
b68d25067b | ||
|
|
ce2c58840e | ||
|
|
0651f595a4 | ||
|
|
bd5c360651 | ||
|
|
037312905b | ||
|
|
1f348e742c | ||
|
|
828c03eff6 | ||
|
|
ee1b6646e4 | ||
|
|
02d867e978 | ||
|
|
09f2becef0 | ||
|
|
1eacce0b08 | ||
|
|
925f543e22 | ||
|
|
dad8a00ad8 | ||
|
|
8156900d78 | ||
|
|
f288c8b357 | ||
|
|
cc9ec58fd1 | ||
|
|
ae074494c2 | ||
|
|
5273cb3a88 | ||
|
|
410c6f1999 | ||
|
|
cd95e9e54d | ||
|
|
7995c6ccfc | ||
|
|
0c5d3b8c65 | ||
|
|
e16aa73e5a | ||
|
|
e266c411b5 | ||
|
|
edc9229268 | ||
|
|
ba880fdc30 | ||
|
|
3f217e841b | ||
|
|
7749dd2e2f | ||
|
|
f2179f2d5c | ||
|
|
9ab9a0fbee | ||
|
|
bde3bd14fd | ||
|
|
4fa8fb0238 | ||
|
|
6701ebb2a2 | ||
|
|
204a65f7e5 | ||
|
|
b69a11b6c9 | ||
|
|
027e5e3142 | ||
|
|
b40f57b061 | ||
|
|
0ca12d6569 | ||
|
|
119f0e8260 | ||
|
|
07857d78fe | ||
|
|
d26e51bf94 | ||
|
|
3fc70aade0 | ||
|
|
bef3a89610 | ||
|
|
9560d838f8 | ||
|
|
a81ddb8dbb | ||
|
|
8a29ee9c9b | ||
|
|
ef63fa998a | ||
|
|
4439c97fe1 | ||
|
|
e0f84c9215 | ||
|
|
a4d3b9100f | ||
|
|
7805e24974 | ||
|
|
88e0d440e3 | ||
|
|
f35307a3b5 | ||
|
|
d22c65e235 | ||
|
|
0ca2941272 | ||
|
|
3401969c20 | ||
|
|
5ad6f409b6 | ||
|
|
cfab83b28f | ||
|
|
074c67d48b | ||
|
|
a0c5b3958f | ||
|
|
5c67fb4472 | ||
|
|
00cf54515c | ||
|
|
a47fc3f413 | ||
|
|
e776d7d081 | ||
|
|
27020522cb | ||
|
|
68be32f8e3 | ||
|
|
6f738407ba | ||
|
|
3f82701af1 | ||
|
|
13cb706a4c | ||
|
|
3601188daa | ||
|
|
74b194703f | ||
|
|
b747fc3224 | ||
|
|
8e850b8e2f | ||
|
|
16314525b2 | ||
|
|
d7dd232677 | ||
|
|
499de93965 | ||
|
|
b8023e40b4 | ||
|
|
8d1afa5659 | ||
|
|
855b664496 | ||
|
|
4630e46261 | ||
|
|
f1b8f628c7 | ||
|
|
019a667385 | ||
|
|
0451a13b49 | ||
|
|
8088e32071 | ||
|
|
7813c4c17a | ||
|
|
a4837b2437 | ||
|
|
c18e6254dc | ||
|
|
15fa605b62 | ||
|
|
22737a989b | ||
|
|
391e17cbe8 | ||
|
|
2c67380340 | ||
|
|
18d485eb85 | ||
|
|
350fa5def0 | ||
|
|
1762b90def |
No files matched your search
@@ -0,0 +1,33 @@
|
|||||||
|
name: Test
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v7
|
||||||
|
|
||||||
|
- uses: actions/setup-go@v7
|
||||||
|
with:
|
||||||
|
go-version-file: go.mod
|
||||||
|
cache: true
|
||||||
|
|
||||||
|
- name: Check formatting
|
||||||
|
run: |
|
||||||
|
unformatted=$(gofmt -l .)
|
||||||
|
if [ -n "$unformatted" ]; then
|
||||||
|
echo "gofmt needed for:"
|
||||||
|
echo "$unformatted"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Vet
|
||||||
|
run: go vet ./...
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: go test -race ./...
|
||||||
+17
-1
@@ -1,6 +1,22 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## Unreleased
|
## v0.0.29
|
||||||
|
|
||||||
|
- Add `ssh.pre_connect`: a shell command run locally before every connection (ssh, sftp, scp, tunnel), e.g. to check a VPN. A non-zero exit aborts the connection. Layered like `proxy_jump` (global → instance or static host → rules, `none` disables an inherited hook); the host is passed as `NETSSH_HOST`, `NETSSH_TARGET`, `NETSSH_INSTANCE`, `NETSSH_IP`, `NETSSH_KIND`, `NETSSH_TAGS`, `NETSSH_CLIENT`. Editable in `netssh configure`, also `NETSSH_SSH_PRE_CONNECT`. `--dry-run` shows it without running it.
|
||||||
|
- Add `shortcuts.show`: shows each host's shortcut alias (e.g. `fsnbx1` for `fsn1-bx1.hoster.de`) in the TUI and as an `ALIAS` column in `netssh cache list` and `netssh hosts list`, and offers shortcuts in Tab completion even when the full name matches. `--aliases` shows the column for a single call. Editable in `netssh configure`, also `NETSSH_SHORTCUTS_SHOW`.
|
||||||
|
|
||||||
|
## v0.0.25
|
||||||
|
|
||||||
|
- Security: `netssh.yaml` is read from the user config directory only. A file of that name in the working directory (e.g. of a cloned repository) was loaded when no user config existed, and could set ssh options such as `ProxyCommand` or a NetBox URL.
|
||||||
|
- Security: an address from NetBox or the cache that is neither an IP address nor a hostname is refused. A value such as `-oProxyCommand=…` was passed to ssh as an option.
|
||||||
|
- The resolver chain stops at an API failure instead of trying the next strategy. Before, a NetBox error in `management_subnet` or `interface_name` connected to the primary IP and cached it. A strategy that finds no address (including a missing interface) still falls through. Note: a token without permission to read IP addresses now gives an error instead of silently using `primary_ip`.
|
||||||
|
- `netssh --help` and `netssh -h` show netssh's help instead of `unknown option --help` and ssh's usage.
|
||||||
|
- Background cache refreshes are started at most every 5 minutes. While NetBox was unreachable, every command and every new shell started another one.
|
||||||
|
- `netbox.url` is validated like the URLs of named instances (HTTP or HTTPS, no query or fragment).
|
||||||
|
- Hosts with more than 100 IP addresses: all pages are read, so `management_subnet` no longer misses addresses.
|
||||||
|
- CI: tests, `go vet`, and a format check run on pull requests and pushes to `main`.
|
||||||
|
|
||||||
|
## v0.0.24
|
||||||
|
|
||||||
- Fix the `interface_name` resolver strategy: it sent filter names that NetBox ignores and therefore returned the host's first IP address instead of the named interface's. It now uses NetBox's `interface` and `vminterface` filters; a missing interface falls through to the next strategy.
|
- Fix the `interface_name` resolver strategy: it sent filter names that NetBox ignores and therefore returned the host's first IP address instead of the named interface's. It now uses NetBox's `interface` and `vminterface` filters; a missing interface falls through to the next strategy.
|
||||||
- Fix `netssh sftp` and `netssh scp` with instance-qualified hosts (`prod/web01:/path`), which were taken for local paths.
|
- Fix `netssh sftp` and `netssh scp` with instance-qualified hosts (`prod/web01:/path`), which were taken for local paths.
|
||||||
|
|||||||
@@ -21,7 +21,8 @@ The same lookup drives `netssh sftp`, `netssh scp`, and `netssh tunnel`, the int
|
|||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Quick start](#quick-start)
|
- [Quick start](#quick-start)
|
||||||
- [Configuration](#configuration) — [wizard](#interactive-wizard), [manual config](#manual-config), [reference](#configuration-reference), [environment variables](#environment-variables), [files](#files-and-directories), [multiple instances](#multiple-netbox-instances)
|
- [Configuration](#configuration) — [wizard](#interactive-wizard), [manual config](#manual-config), [reference](#configuration-reference), [environment variables](#environment-variables), [files](#files-and-directories), [multiple instances](#multiple-netbox-instances)
|
||||||
- [Usage](#usage) — [command overview](#command-overview), [SSH options](#ssh-options), [SFTP & SCP](#sftp-and-scp), [port forwarding](#port-forwarding), [static hosts](#static-hosts), [multiple servers](#multiple-servers-in-one-window), [shortcuts](#host-shortcuts), [TUI](#interactive-tui), [notes](#server-notes), [cache](#cache-management)
|
- [Usage](#usage) — [command overview](#command-overview), [SSH options](#ssh-options), [pre-connect hook](#pre-connect-hook), [SFTP & SCP](#sftp-and-scp), [port forwarding](#port-forwarding), [static hosts](#static-hosts), [multiple servers](#multiple-servers-in-one-window), [shortcuts](#host-shortcuts), [TUI](#interactive-tui), [notes](#server-notes), [cache](#cache-management)
|
||||||
|
- [Hotkey cheat sheet](#hotkey-cheat-sheet) — search, editors, tmux and zellij
|
||||||
- [Recipes](#recipes)
|
- [Recipes](#recipes)
|
||||||
- [IP Resolution Strategies](#ip-resolution-strategies)
|
- [IP Resolution Strategies](#ip-resolution-strategies)
|
||||||
- [Shell Completion](#shell-completion) and [Shell Hook](#shell-hook)
|
- [Shell Completion](#shell-completion) and [Shell Hook](#shell-hook)
|
||||||
@@ -147,12 +148,12 @@ A menu then gives access to every other setting; open only the sections you want
|
|||||||
| Section | Settings |
|
| Section | Settings |
|
||||||
|---|---|
|
|---|---|
|
||||||
| SSH defaults | `ssh.default_user`, `ssh.default_port` |
|
| SSH defaults | `ssh.default_user`, `ssh.default_port` |
|
||||||
| SSH options | `proxy_jump`, `host_key_checking`, `target`, `address_family`, `extra_args` (one per line), `options` (`Key=Value` per line), `forwards` (`NAME L\|R\|D SPEC` per line) |
|
| SSH options | `proxy_jump`, `host_key_checking`, `target`, `address_family`, `extra_args` (one per line), `options` (`Key=Value` per line), `forwards` (`NAME L\|R\|D SPEC` per line), `pre_connect` |
|
||||||
| SSH rules | add, edit, remove `ssh.rules` — match by tag, instance, kind, name pattern, each with its own SSH options |
|
| SSH rules | add, edit, remove `ssh.rules` — match by tag, instance, kind, name pattern, each with its own SSH options |
|
||||||
| Static hosts | add, edit, remove hosts that are not in NetBox, each with user, port, tags, and SSH options |
|
| Static hosts | add, edit, remove hosts that are not in NetBox, each with user, port, tags, and SSH options |
|
||||||
| Multi-session | multiplexer (auto, tmux, zellij), panes per window, tmux keys for broadcast and excluding a pane, groups (`NAME: sel1, sel2` per line) |
|
| Multi-session | multiplexer (auto, tmux, zellij), panes per window, tmux keys for broadcast and excluding a pane, groups (`NAME: sel1, sel2` per line) |
|
||||||
| Resolver & cache | strategies, management subnets, interface name, hostname domain, cache TTL, cache file |
|
| Resolver & cache | strategies, management subnets, interface name, hostname domain, cache TTL, cache file |
|
||||||
| Shortcuts & command alias | domain suffixes, hyphen stripping, rewrite rules (`REGEX => REPLACEMENT` per line), `shell.alias` |
|
| Shortcuts & command alias | domain suffixes, hyphen stripping, rewrite rules (`REGEX => REPLACEMENT` per line), show shortcuts (`shortcuts.show`), `shell.alias` |
|
||||||
| Completion | `completion.max_results` |
|
| Completion | `completion.max_results` |
|
||||||
|
|
||||||
The result is validated and saved to `~/.config/netssh.yaml`; Ctrl+C cancels without writing.
|
The result is validated and saved to `~/.config/netssh.yaml`; Ctrl+C cancels without writing.
|
||||||
@@ -200,7 +201,7 @@ shortcuts:
|
|||||||
|
|
||||||
Single-instance and shared settings can be overridden with environment variables (`NETSSH_NETBOX_URL`, `NETSSH_NETBOX_TOKEN`, etc.; see [Environment variables](#environment-variables)).
|
Single-instance and shared settings can be overridden with environment variables (`NETSSH_NETBOX_URL`, `NETSSH_NETBOX_TOKEN`, etc.; see [Environment variables](#environment-variables)).
|
||||||
|
|
||||||
netssh reads `netssh.yaml` from the user config directory and, if none exists there, from the current working directory. Unknown keys are ignored; invalid values (an unknown strategy, a bad regex, an invalid SSH option) stop netssh with an error that names the key.
|
netssh reads `netssh.yaml` from the user config directory only; a file of that name in the working directory is ignored. Unknown keys are ignored; invalid values (an unknown strategy, a bad regex, an invalid SSH option) stop netssh with an error that names the key.
|
||||||
|
|
||||||
### Configuration reference
|
### Configuration reference
|
||||||
|
|
||||||
@@ -211,7 +212,7 @@ Every key, its default, and the section that explains it. Keys marked *layered*
|
|||||||
| `netbox.url` | string | — | NetBox base URL (single instance). Use either `netbox` or `netboxes`. |
|
| `netbox.url` | string | — | NetBox base URL (single instance). Use either `netbox` or `netboxes`. |
|
||||||
| `netbox.token` | string | — | API token; `nbt_…` is v2, anything else v1. |
|
| `netbox.token` | string | — | API token; `nbt_…` is v2, anything else v1. |
|
||||||
| `netbox.token_version` | 1 \| 2 | auto | Detected from the token prefix. |
|
| `netbox.token_version` | 1 \| 2 | auto | Detected from the token prefix. |
|
||||||
| `netboxes[]` | list | — | Named instances with `name`, `url`, `token`, `token_version`, `ssh` — see [Multiple NetBox instances](#multiple-netbox-instances). |
|
| `netboxes[]` | list | — | Named instances with `name`, `url`, `token`, `token_version`, `disable_prefix`, `ssh` — see [Multiple NetBox instances](#multiple-netbox-instances). |
|
||||||
| `resolver.strategies` | list | `[management_subnet, primary_ip]` | Tried in order, first IP wins — see [IP Resolution Strategies](#ip-resolution-strategies). The wizard suggests `primary_ip`. |
|
| `resolver.strategies` | list | `[management_subnet, primary_ip]` | Tried in order, first IP wins — see [IP Resolution Strategies](#ip-resolution-strategies). The wizard suggests `primary_ip`. |
|
||||||
| `resolver.management_subnets` | list of CIDR | `[]` | Used by `management_subnet`. |
|
| `resolver.management_subnets` | list of CIDR | `[]` | Used by `management_subnet`. |
|
||||||
| `resolver.interface_name` | string | — | Used by `interface_name`, e.g. `mgmt0`. |
|
| `resolver.interface_name` | string | — | Used by `interface_name`, e.g. `mgmt0`. |
|
||||||
@@ -227,10 +228,12 @@ Every key, its default, and the section that explains it. Keys marked *layered*
|
|||||||
| `ssh.extra_args` | list | `[]` | *Layered.* Extra ssh arguments; accumulate across layers; ssh only. |
|
| `ssh.extra_args` | list | `[]` | *Layered.* Extra ssh arguments; accumulate across layers; ssh only. |
|
||||||
| `ssh.options` | map | `{}` | *Layered.* `-o Key=Value`; per key, the more specific layer wins. |
|
| `ssh.options` | map | `{}` | *Layered.* `-o Key=Value`; per key, the more specific layer wins. |
|
||||||
| `ssh.forwards` | map | `{}` | *Layered.* Named port forwards (`local`, `remote`, `dynamic`) — see [Port forwarding](#port-forwarding). |
|
| `ssh.forwards` | map | `{}` | *Layered.* Named port forwards (`local`, `remote`, `dynamic`) — see [Port forwarding](#port-forwarding). |
|
||||||
|
| `ssh.pre_connect` | string | — | *Layered.* Shell command run locally before connecting; a non-zero exit aborts; `none` disables an inherited one — see [Pre-connect hook](#pre-connect-hook). |
|
||||||
| `ssh.rules[]` | list | `[]` | `match` (`tag`, `instance`, `kind`, `name`) plus any layered key. |
|
| `ssh.rules[]` | list | `[]` | `match` (`tag`, `instance`, `kind`, `name`) plus any layered key. |
|
||||||
| `shortcuts.domains` | list | `[]` | Suffixes stripped for shortcuts and tried when expanding a short name. |
|
| `shortcuts.domains` | list | `[]` | Suffixes stripped for shortcuts and tried when expanding a short name. |
|
||||||
| `shortcuts.strip_hyphens` | bool | `false` | Ignore hyphens when matching shortcuts. |
|
| `shortcuts.strip_hyphens` | bool | `false` | Ignore hyphens when matching shortcuts. |
|
||||||
| `shortcuts.rewrites[]` | list | `[]` | `pattern` (Go regex) and `replace` — see [Host shortcuts](#host-shortcuts). |
|
| `shortcuts.rewrites[]` | list | `[]` | `pattern` (Go regex) and `replace` — see [Host shortcuts](#host-shortcuts). |
|
||||||
|
| `shortcuts.show` | bool | `false` | Show each host's shortcut alias in the TUI, `netssh cache list` and `netssh hosts list`, and offer shortcuts in Tab completion even when the full name matches — see [Showing shortcuts](#showing-shortcuts). |
|
||||||
| `completion.max_results` | int | `0` | Hostnames offered per `<Tab>`; `0` = unlimited. |
|
| `completion.max_results` | int | `0` | Hostnames offered per `<Tab>`; `0` = unlimited. |
|
||||||
| `shell.alias` | string | — | Short command name for netssh, e.g. `j` — see [Short command alias](#short-command-alias). |
|
| `shell.alias` | string | — | Short command name for netssh, e.g. `j` — see [Short command alias](#short-command-alias). |
|
||||||
| `hosts[]` | list | `[]` | Static hosts with `name`, `address`, `user`, `port`, `tags`, `ssh` — see [Static hosts](#static-hosts). |
|
| `hosts[]` | list | `[]` | Static hosts with `name`, `address`, `user`, `port`, `tags`, `ssh` — see [Static hosts](#static-hosts). |
|
||||||
@@ -249,8 +252,8 @@ These variables override the file. Lists are comma-separated (`NETSSH_SHORTCUTS_
|
|||||||
| `NETSSH_RESOLVER_STRATEGIES`, `NETSSH_RESOLVER_MANAGEMENT_SUBNETS`, `NETSSH_RESOLVER_INTERFACE_NAME`, `NETSSH_RESOLVER_HOSTNAME_DOMAIN` | `resolver.*` |
|
| `NETSSH_RESOLVER_STRATEGIES`, `NETSSH_RESOLVER_MANAGEMENT_SUBNETS`, `NETSSH_RESOLVER_INTERFACE_NAME`, `NETSSH_RESOLVER_HOSTNAME_DOMAIN` | `resolver.*` |
|
||||||
| `NETSSH_CACHE_TTL`, `NETSSH_CACHE_PATH` | `cache.*` |
|
| `NETSSH_CACHE_TTL`, `NETSSH_CACHE_PATH` | `cache.*` |
|
||||||
| `NETSSH_SSH_DEFAULT_USER`, `NETSSH_SSH_DEFAULT_PORT` | `ssh.default_*` |
|
| `NETSSH_SSH_DEFAULT_USER`, `NETSSH_SSH_DEFAULT_PORT` | `ssh.default_*` |
|
||||||
| `NETSSH_SSH_PROXY_JUMP`, `NETSSH_SSH_HOST_KEY_CHECKING`, `NETSSH_SSH_TARGET`, `NETSSH_SSH_ADDRESS_FAMILY` | global `ssh.*` options |
|
| `NETSSH_SSH_PROXY_JUMP`, `NETSSH_SSH_HOST_KEY_CHECKING`, `NETSSH_SSH_TARGET`, `NETSSH_SSH_ADDRESS_FAMILY`, `NETSSH_SSH_PRE_CONNECT` | global `ssh.*` options |
|
||||||
| `NETSSH_SHORTCUTS_DOMAINS`, `NETSSH_SHORTCUTS_STRIP_HYPHENS` | `shortcuts.*` |
|
| `NETSSH_SHORTCUTS_DOMAINS`, `NETSSH_SHORTCUTS_STRIP_HYPHENS`, `NETSSH_SHORTCUTS_SHOW` | `shortcuts.*` |
|
||||||
| `NETSSH_COMPLETION_MAX_RESULTS` | `completion.max_results` |
|
| `NETSSH_COMPLETION_MAX_RESULTS` | `completion.max_results` |
|
||||||
| `NETSSH_MULTI_MULTIPLEXER`, `NETSSH_MULTI_PANES_PER_WINDOW` | `multi.*` |
|
| `NETSSH_MULTI_MULTIPLEXER`, `NETSSH_MULTI_PANES_PER_WINDOW` | `multi.*` |
|
||||||
| `NETSSH_SHELL_ALIAS` | `shell.alias` |
|
| `NETSSH_SHELL_ALIAS` | `shell.alias` |
|
||||||
@@ -305,7 +308,41 @@ netssh notes show lab/web01 --netbox --kind device
|
|||||||
|
|
||||||
For direct connections without an instance prefix, every instance must be reachable to verify uniqueness. A qualified target queries only its own instance and can use a fresh cached IP while other instances are offline. Qualified shortcuts such as `office/web01` also support configured domain suffixes and hyphen folding.
|
For direct connections without an instance prefix, every instance must be reachable to verify uniqueness. A qualified target queries only its own instance and can use a fresh cached IP while other instances are offline. Qualified shortcuts such as `office/web01` also support configured domain suffixes and hyphen folding.
|
||||||
|
|
||||||
Cache entries and generated aliases retain the instance name (`office_web01` and `lab_web01`). Named-instance caches live in a configuration-specific subdirectory beneath the configured cache path, so changing an endpoint cannot reuse another server's cached IPs. Run `netssh cache refresh` after adding or changing instances. A failed full refresh leaves the cache and its refresh timestamp unchanged; a per-instance refresh preserves the other instances and does not mark the whole cache as refreshed.
|
Cache entries retain the instance name. Generated aliases include it by default (`office_web01` and `lab_web01`). Named-instance caches live in a configuration-specific subdirectory beneath the configured cache path, so changing an endpoint cannot reuse another server's cached IPs. Run `netssh cache refresh` after adding or changing instances. A failed full refresh leaves the cache and its refresh timestamp unchanged; a per-instance refresh preserves the other instances and does not mark the whole cache as refreshed.
|
||||||
|
|
||||||
|
**Aliases and TUI names without an instance prefix.** Set `disable_prefix: true`
|
||||||
|
on individual instances, or enable **Hide instance prefix in aliases and TUI?**
|
||||||
|
when editing an instance in `netssh configure`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
netboxes:
|
||||||
|
- name: office
|
||||||
|
url: https://netbox.office.example
|
||||||
|
token: nbt_office-token
|
||||||
|
disable_prefix: true
|
||||||
|
- name: lab
|
||||||
|
url: https://netbox.lab.example
|
||||||
|
token: nbt_lab-token
|
||||||
|
```
|
||||||
|
|
||||||
|
With the appropriate domain shortcut, this generates `web01` for
|
||||||
|
`office/web01.example.com` and `lab_web01` for the lab host. The default is
|
||||||
|
`false`. The alias command still contains the full `instance/hostname`, so it
|
||||||
|
connects to the selected instance even when another instance has the same host
|
||||||
|
name. Domain stripping, rewrites and hyphen folding still apply.
|
||||||
|
|
||||||
|
If a bare alias conflicts with another generated alias, a reserved qualified
|
||||||
|
alias, `netssh`, or your configured command alias, the instance prefix is kept.
|
||||||
|
It is also kept if the bare name is not a valid shell alias (e.g. starts with a digit).
|
||||||
|
The TUI result list also hides the prefix for this instance; duplicate visible
|
||||||
|
names keep their prefixes to remain distinguishable. Selection, autocomplete,
|
||||||
|
connection editors, notes and cache identities still use the full target.
|
||||||
|
Completion already offers unique hostnames
|
||||||
|
without an instance prefix.
|
||||||
|
|
||||||
|
Open a new shell with the installed netssh hook to regenerate and load aliases.
|
||||||
|
No cache refresh is needed for this setting. Existing aliases in an already open
|
||||||
|
shell remain until removed or the shell is replaced.
|
||||||
|
|
||||||
Local notes remain keyed by the NetBox URL, host kind, and canonical hostname. Migrating a single instance or renaming it preserves its notes. Use `instance/hostname` and `--kind` for uncached local notes; these operations work offline. NetBox comments and interface/IP lookups always use the selected instance's credentials.
|
Local notes remain keyed by the NetBox URL, host kind, and canonical hostname. Migrating a single instance or renaming it preserves its notes. Use `instance/hostname` and `--kind` for uncached local notes; these operations work offline. NetBox comments and interface/IP lookups always use the selected instance's credentials.
|
||||||
|
|
||||||
@@ -473,7 +510,7 @@ Tags and kind are taken from the cache or the NetBox answer, so rules work offli
|
|||||||
|
|
||||||
**How layers combine.** netssh merges global → instance (or the static host's own `ssh`) → matching rules:
|
**How layers combine.** netssh merges global → instance (or the static host's own `ssh`) → matching rules:
|
||||||
|
|
||||||
- single values (`proxy_jump`, `host_key_checking`, `target`, `address_family`) — the most specific non-empty value wins;
|
- single values (`proxy_jump`, `host_key_checking`, `target`, `address_family`, `pre_connect`) — the most specific non-empty value wins;
|
||||||
- `options` and `forwards` — merged per key or name, the more specific layer wins;
|
- `options` and `forwards` — merged per key or name, the more specific layer wins;
|
||||||
- `extra_args` — collected from all layers.
|
- `extra_args` — collected from all layers.
|
||||||
|
|
||||||
@@ -484,6 +521,46 @@ $ netssh --dry-run fw01.dmz.example.com
|
|||||||
ssh -A -l admin -J dmz-jump.example.com -o StrictHostKeyChecking=accept-new -o serveraliveinterval=60 192.0.2.10
|
ssh -A -l admin -J dmz-jump.example.com -o StrictHostKeyChecking=accept-new -o serveraliveinterval=60 192.0.2.10
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Pre-connect hook
|
||||||
|
|
||||||
|
`pre_connect` runs a shell command (`sh -c`) on your machine right before netssh
|
||||||
|
starts ssh, sftp, scp, or a tunnel — for example to check or bring up a VPN, or
|
||||||
|
to log connections. If the command exits non-zero, netssh prints an error and
|
||||||
|
does not connect.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
ssh:
|
||||||
|
pre_connect: 'wg show wg0 >/dev/null 2>&1 || { echo "VPN wg0 is down" >&2; exit 1; }'
|
||||||
|
rules:
|
||||||
|
- match: {tag: public}
|
||||||
|
pre_connect: none # no VPN needed for these hosts
|
||||||
|
netboxes:
|
||||||
|
- name: lab
|
||||||
|
url: "https://netbox-lab.example.com"
|
||||||
|
ssh:
|
||||||
|
pre_connect: 'lab-vpn up' # this instance needs its own VPN
|
||||||
|
```
|
||||||
|
|
||||||
|
It is a layered setting like `proxy_jump`: global → instance or static host →
|
||||||
|
matching rules, the most specific non-empty value wins, and `none` disables an
|
||||||
|
inherited hook. The hook gets the target in environment variables:
|
||||||
|
|
||||||
|
| Variable | Value |
|
||||||
|
|---|---|
|
||||||
|
| `NETSSH_HOST` | Hostname without instance prefix (`web01.example.com`) |
|
||||||
|
| `NETSSH_TARGET` | Name with instance prefix if any (`prod/web01.example.com`) |
|
||||||
|
| `NETSSH_INSTANCE` | NetBox instance, empty for a single NetBox or static hosts |
|
||||||
|
| `NETSSH_IP` | Resolved address netssh connects to |
|
||||||
|
| `NETSSH_KIND` | `device`, `vm`, or `static` |
|
||||||
|
| `NETSSH_TAGS` | Comma-separated tags |
|
||||||
|
| `NETSSH_CLIENT` | `ssh`, `sftp`, or `scp` |
|
||||||
|
|
||||||
|
The hook's output goes to stderr, so it never mixes with the output of a remote
|
||||||
|
command or an scp transfer; it can read from the terminal (e.g. a VPN password
|
||||||
|
prompt). `--dry-run` prints the hook without running it. `netssh multi` runs it
|
||||||
|
once per pane. It runs only for connections made through netssh, not for a plain
|
||||||
|
`ssh` call.
|
||||||
|
|
||||||
### SFTP and SCP
|
### SFTP and SCP
|
||||||
|
|
||||||
`netssh sftp` and `netssh scp` look up the host exactly like a connection does: cache, shortcuts and rewrite rules, `instance/host`, default user and port, SSH options and rules, `--jump`/`--no-jump`, and `--dry-run`.
|
`netssh sftp` and `netssh scp` look up the host exactly like a connection does: cache, shortcuts and rewrite rules, `instance/host`, default user and port, SSH options and rules, `--jump`/`--no-jump`, and `--dry-run`.
|
||||||
@@ -597,7 +674,9 @@ multi:
|
|||||||
| Exclude one pane | `Ctrl+b e` (again: include) or `netssh sync --pane` | not possible — zellij syncs whole tabs |
|
| Exclude one pane | `Ctrl+b e` (again: include) or `netssh sync --pane` | not possible — zellij syncs whole tabs |
|
||||||
| Shown in the border | `[SYNC]` receives broadcast, `[SOLO]` excluded | `(SYNC)` in the tab name |
|
| Shown in the border | `[SYNC]` receives broadcast, `[SOLO]` excluded | `(SYNC)` in the tab name |
|
||||||
|
|
||||||
**Keys in tmux.** `S` and `e` are free in a default tmux (`E` would be "spread panes evenly"). netssh binds them after your prefix when it opens panes, but only if your own `tmux.conf` does not already use them — then it keeps your binding and says so. They act only in windows opened by `netssh multi`; elsewhere they just show a message. Change or turn them off with `multi.sync_key` / `multi.solo_key` (`none`), e.g. `sync_key: C-s` for `prefix Ctrl+s`.
|
**Keys in tmux.** The active pane border keeps the available broadcast/solo keys visible after attaching. See the [hotkey cheat sheet](#hotkey-cheat-sheet) for navigation and editor keys.
|
||||||
|
|
||||||
|
`S` and `e` are free in a default tmux (`E` would be "spread panes evenly"). netssh binds them after your prefix when it opens panes, but only if your own `tmux.conf` does not already use them — then it keeps your binding and says so. They act only in windows opened by `netssh multi`; elsewhere they just show a message. Change or turn them off with `multi.sync_key` / `multi.solo_key` (`none`), e.g. `sync_key: C-s` for `prefix Ctrl+s`.
|
||||||
|
|
||||||
**In the TUI**, mark hosts with `Space` (or all listed hosts with `Ctrl+A`) and press `Enter` to open them together.
|
**In the TUI**, mark hosts with `Space` (or all listed hosts with `Ctrl+A`) and press `Enter` to open them together.
|
||||||
|
|
||||||
@@ -671,6 +750,27 @@ Domains may be configured with or without a leading dot. If several cached hosts
|
|||||||
| `fsn1web01` | `domains: [.example.com]`, `strip_hyphens: true` | `fsn1-web01.example.com` (cache only) |
|
| `fsn1web01` | `domains: [.example.com]`, `strip_hyphens: true` | `fsn1-web01.example.com` (cache only) |
|
||||||
| `fsnbx1` | `domains: [.hoster.de]`, rewrite `^([a-z]+)[0-9]+-` → `$1` | `fsn1-bx1.hoster.de` (cache only) |
|
| `fsnbx1` | `domains: [.hoster.de]`, rewrite `^([a-z]+)[0-9]+-` → `$1` | `fsn1-bx1.hoster.de` (cache only) |
|
||||||
|
|
||||||
|
#### Showing shortcuts
|
||||||
|
|
||||||
|
By default shortcuts work but stay out of sight. Set `shortcuts.show: true`
|
||||||
|
(or **Show shortcuts** in `netssh configure`, or `NETSSH_SHORTCUTS_SHOW=true`)
|
||||||
|
to see them:
|
||||||
|
|
||||||
|
- **TUI** — each host shows its alias next to the name: `fsn1-bx1.hoster.de → fsnbx1 10.0.0.5`.
|
||||||
|
- **Lists** — `netssh cache list` and `netssh hosts list` get an `ALIAS` column. Without the setting, `--aliases` shows it for one call.
|
||||||
|
- **Tab completion** — shortcuts are offered even when the full name matches what you typed: `fsn<Tab>` lists `fsn1-bx1.hoster.de` and `fsnbx1`.
|
||||||
|
|
||||||
|
The alias shown is the shell alias netssh generates for the host (see [Shell
|
||||||
|
aliases](#shell-aliases)), so you can type it directly. Hosts whose alias would
|
||||||
|
only replace dots (`web01_example_com`) show none.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ netssh cache list --aliases
|
||||||
|
NAME ALIAS IP KIND CACHED AT
|
||||||
|
fsn1-bx1.hoster.de fsnbx1 10.0.0.5 device 2026-11-17T07:30:00+01:00
|
||||||
|
web01.other.de - 10.0.0.9 vm 2026-11-17T07:30:00+01:00
|
||||||
|
```
|
||||||
|
|
||||||
### Shell aliases
|
### Shell aliases
|
||||||
|
|
||||||
Generate shell aliases for all cached hosts based on the shortcut settings:
|
Generate shell aliases for all cached hosts based on the shortcut settings:
|
||||||
@@ -714,21 +814,7 @@ netssh
|
|||||||
|
|
||||||
The TUI opens with your 10 most-recently-connected hosts. Start typing to search all cached hosts or query NetBox live.
|
The TUI opens with your 10 most-recently-connected hosts. Start typing to search all cached hosts or query NetBox live.
|
||||||
|
|
||||||
| Key | Action |
|
See the [hotkey cheat sheet](#hotkey-cheat-sheet) for all search and editor keys.
|
||||||
|-----|--------|
|
|
||||||
| type | filter hosts (300 ms debounce → NetBox query) |
|
|
||||||
| `Tab` | autocomplete top result into the search field |
|
|
||||||
| `↑` / `↓` | navigate results |
|
|
||||||
| `Enter` | connect to selected host |
|
|
||||||
| `Space` | mark/unmark the host; with marks, `Enter` opens them side by side (`netssh multi`) |
|
|
||||||
| `Ctrl+A` | mark all listed hosts (again: unmark all) |
|
|
||||||
| `Ctrl+O` | open an SFTP session to the selected host |
|
|
||||||
| `Ctrl+T` | start a tunnel: enter forward names or specs (`web, 8080:localhost:80`) |
|
|
||||||
| `Ctrl+E` | open inline editor to override user/port before connecting |
|
|
||||||
| `Ctrl+N` | edit local notes for the selected server |
|
|
||||||
| `Ctrl+B` | edit NetBox comments for the selected server |
|
|
||||||
| `Ctrl+F` | open/close tag and kind filter (`tag:prod kind:vm`) |
|
|
||||||
| `Esc` / `Ctrl+C` | quit (or close filter/edit if open) |
|
|
||||||
|
|
||||||
**Tag and kind filter** — press `Ctrl+F` to open a second input line:
|
**Tag and kind filter** — press `Ctrl+F` to open a second input line:
|
||||||
|
|
||||||
@@ -785,6 +871,7 @@ See the [NetBox REST API documentation](https://netbox.readthedocs.io/en/stable/
|
|||||||
|
|
||||||
```sh
|
```sh
|
||||||
netssh cache list # show all cached entries
|
netssh cache list # show all cached entries
|
||||||
|
netssh cache list --aliases # … with each host's shortcut alias
|
||||||
netssh cache refresh # re-fetch ALL hosts from NetBox (paginated)
|
netssh cache refresh # re-fetch ALL hosts from NetBox (paginated)
|
||||||
netssh cache refresh --tag prod # only hosts with the "prod" tag
|
netssh cache refresh --tag prod # only hosts with the "prod" tag
|
||||||
netssh cache refresh --kind vm # only virtual machines
|
netssh cache refresh --kind vm # only virtual machines
|
||||||
@@ -817,6 +904,100 @@ The hook is a no-op when the cache is fresh — it adds no measurable delay to y
|
|||||||
netssh search app- # prints matching hostnames, one per line
|
netssh search app- # prints matching hostnames, one per line
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Hotkey cheat sheet
|
||||||
|
|
||||||
|
Keys depend on the current screen: for example, `Ctrl+B` opens NetBox comments
|
||||||
|
in the search, while tmux uses `Ctrl+b` as its default prefix.
|
||||||
|
“Then” means release the first combination before pressing the next key;
|
||||||
|
`S` is uppercase (`Shift+s`).
|
||||||
|
|
||||||
|
### Search and host selection
|
||||||
|
|
||||||
|
| Key | Action |
|
||||||
|
|-----|--------|
|
||||||
|
| type | filter hosts (300 ms debounce → NetBox query) |
|
||||||
|
| `Tab` | autocomplete top result into the search field |
|
||||||
|
| `↑` / `↓` | navigate results |
|
||||||
|
| `PageUp` / `PageDown` | previous/next results page |
|
||||||
|
| `Home` / `End` | first/last result (also moves the search cursor) |
|
||||||
|
| `Enter` | connect to selected host |
|
||||||
|
| `Space` | mark/unmark the host; with marks, `Enter` opens them side by side (`netssh multi`) |
|
||||||
|
| `Ctrl+A` | mark all listed hosts (again: unmark all) |
|
||||||
|
| `Ctrl+O` | open an SFTP session to the selected host |
|
||||||
|
| `Ctrl+T` | start a tunnel: enter forward names or specs (`web, 8080:localhost:80`) |
|
||||||
|
| `Ctrl+E` | open inline editor to override user/port before connecting |
|
||||||
|
| `Ctrl+N` | edit local notes for the selected server |
|
||||||
|
| `Ctrl+B` | edit NetBox comments for the selected server |
|
||||||
|
| `Ctrl+F` | open/close tag and kind filter (`tag:prod kind:vm`) |
|
||||||
|
| `Esc` | quit search |
|
||||||
|
| `Ctrl+C` | quit from any TUI mode, including editors |
|
||||||
|
|
||||||
|
### Filters, connection/tunnel editors and notes
|
||||||
|
|
||||||
|
| Screen | Key | Action |
|
||||||
|
|---|---|---|
|
||||||
|
| Filter (`Ctrl+F`) | `Enter` | apply filter and return to results |
|
||||||
|
| Filter | `Esc` / `Ctrl+F` | close and clear the filter |
|
||||||
|
| User/port editor (`Ctrl+E`) | `Enter` | connect using the edited user/port |
|
||||||
|
| Tunnel editor (`Ctrl+T`) | `Enter` | start the requested forwards |
|
||||||
|
| User/port or tunnel editor | `Esc` | cancel and return to results |
|
||||||
|
| Local notes / NetBox comments | `Enter` | insert a new line |
|
||||||
|
| Local notes / NetBox comments | `Ctrl+S` | save |
|
||||||
|
| Local notes / NetBox comments | `Esc` | cancel and discard unsaved edits (when not loading/saving) |
|
||||||
|
| Any TUI screen | `Ctrl+C` | quit, discarding unsaved edits |
|
||||||
|
|
||||||
|
Text fields also support their standard cursor movement and editing keys.
|
||||||
|
|
||||||
|
### Multi-mode: tmux
|
||||||
|
|
||||||
|
The active pane's top border shows the configured broadcast/solo shortcuts
|
||||||
|
throughout the session. A narrow pane may clip the legend; zoom it with
|
||||||
|
`Ctrl+b` then `z` to make more room. `[SYNC]` means the pane receives broadcast;
|
||||||
|
`[SOLO]` means it is excluded.
|
||||||
|
|
||||||
|
The following uses tmux's default prefix `Ctrl+b`. Use your own prefix if
|
||||||
|
changed in `tmux.conf`; netssh's legend reads the configured prefix.
|
||||||
|
Navigation keys below are tmux defaults and can be remapped by your configuration.
|
||||||
|
|
||||||
|
| Key | Action |
|
||||||
|
|---|---|
|
||||||
|
| `Ctrl+b` then `S` | toggle broadcast for the current window (netssh default) |
|
||||||
|
| `Ctrl+b` then `e` | exclude/include the active pane in broadcast (netssh default) |
|
||||||
|
| `Ctrl+b` then arrow key | focus the pane in that direction |
|
||||||
|
| `Ctrl+b` then `o` | focus the next pane |
|
||||||
|
| `Ctrl+b` then `z` | zoom/unzoom the active pane |
|
||||||
|
| `Ctrl+b` then `n` / `p` | next/previous window |
|
||||||
|
| `Ctrl+b` then `w` | choose a window |
|
||||||
|
| `Ctrl+b` then `d` | detach; sessions keep running |
|
||||||
|
| `Ctrl+b` then `?` | show all current tmux bindings |
|
||||||
|
| `Enter` after a failed connection | close the pane displaying the error |
|
||||||
|
|
||||||
|
Change broadcast/solo keys with `multi.sync_key` and `multi.solo_key`;
|
||||||
|
`none` disables a binding. Existing user bindings take precedence and are
|
||||||
|
reported in the legend. Command alternatives are `netssh sync` and
|
||||||
|
`netssh sync --pane` (run locally inside the multiplexer).
|
||||||
|
Solo excludes a pane from broadcast; it does not toggle zoom.
|
||||||
|
|
||||||
|
### Multi-mode: zellij
|
||||||
|
|
||||||
|
Zellij's bottom status bar shows the keys for the current mode. These are
|
||||||
|
standard bindings; custom presets may differ.
|
||||||
|
|
||||||
|
| Key | Action |
|
||||||
|
|---|---|
|
||||||
|
| `Ctrl+t` then `s` | toggle broadcast for the entire tab |
|
||||||
|
| `Ctrl+p` then arrow key | move pane focus in pane mode |
|
||||||
|
| `Ctrl+p` then `f` | toggle fullscreen for the focused pane |
|
||||||
|
| `Ctrl+t` then left/right arrow | switch tabs in tab mode |
|
||||||
|
| `Enter` / `Esc` in a control mode | return to normal mode |
|
||||||
|
| `Ctrl+o` then `d` | detach; session keeps running |
|
||||||
|
| `Ctrl+g` | toggle locked mode to pass control keys to the remote application |
|
||||||
|
|
||||||
|
Zellij cannot exclude individual panes from broadcast. `netssh sync` toggles
|
||||||
|
the whole tab. When starting a new zellij session, enable broadcast manually
|
||||||
|
with `Ctrl+t` then `s`; `--sync` is applied automatically only inside an
|
||||||
|
existing zellij session.
|
||||||
|
|
||||||
## Recipes
|
## Recipes
|
||||||
|
|
||||||
**Everything through a bastion, except the bastion itself**
|
**Everything through a bastion, except the bastion itself**
|
||||||
|
|||||||
+26
-5
@@ -14,27 +14,32 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func hostsCmd() *cobra.Command {
|
func hostsCmd() *cobra.Command {
|
||||||
|
var showAliases bool
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "hosts",
|
Use: "hosts",
|
||||||
Short: "Manage static hosts that are not in NetBox",
|
Short: "Manage static hosts that are not in NetBox",
|
||||||
Long: `Static hosts are defined under hosts: in the config. They are found before
|
Long: `Static hosts are defined under hosts: in the config. They are found before
|
||||||
NetBox, work offline, and support shortcuts, rules (kind: static), aliases,
|
NetBox, work offline, and support shortcuts, rules (kind: static), aliases,
|
||||||
completion, sftp, scp, and tunnels like NetBox hosts.`,
|
completion, sftp, scp, and tunnels like NetBox hosts.`,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error { return listHosts() },
|
RunE: func(cmd *cobra.Command, args []string) error { return listHosts(showAliases) },
|
||||||
}
|
}
|
||||||
cmd.AddCommand(hostsListCmd(), hostsAddCmd(), hostsRemoveCmd())
|
cmd.AddCommand(hostsListCmd(), hostsAddCmd(), hostsRemoveCmd())
|
||||||
|
cmd.Flags().BoolVar(&showAliases, "aliases", false, "Show each host's shortcut alias (always on with shortcuts.show)")
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
func hostsListCmd() *cobra.Command {
|
func hostsListCmd() *cobra.Command {
|
||||||
return &cobra.Command{
|
var showAliases bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
Use: "list",
|
Use: "list",
|
||||||
Short: "List static hosts",
|
Short: "List static hosts",
|
||||||
RunE: func(cmd *cobra.Command, args []string) error { return listHosts() },
|
RunE: func(cmd *cobra.Command, args []string) error { return listHosts(showAliases) },
|
||||||
}
|
}
|
||||||
|
cmd.Flags().BoolVar(&showAliases, "aliases", false, "Show each host's shortcut alias (always on with shortcuts.show)")
|
||||||
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
func listHosts() error {
|
func listHosts(showAliases bool) error {
|
||||||
cfg, err := config.Load()
|
cfg, err := config.Load()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -43,13 +48,29 @@ func listHosts() error {
|
|||||||
fmt.Println("No static hosts. Add one with: netssh hosts add NAME ADDRESS")
|
fmt.Println("No static hosts. Add one with: netssh hosts add NAME ADDRESS")
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
withAliases := showAliases || cfg.Shortcuts.Show
|
||||||
|
var aliases map[string]string
|
||||||
|
if withAliases {
|
||||||
|
// Aliases are unique across all hosts, so compute them with the cache.
|
||||||
|
c := newCache(cfg)
|
||||||
|
_ = c.Load()
|
||||||
|
aliases = shortcutAliases(c.All(), *cfg)
|
||||||
|
}
|
||||||
w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
|
w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
|
||||||
fmt.Fprintln(w, "NAME\tADDRESS\tUSER\tPORT\tTAGS")
|
if withAliases {
|
||||||
|
fmt.Fprintln(w, "NAME\tALIAS\tADDRESS\tUSER\tPORT\tTAGS")
|
||||||
|
} else {
|
||||||
|
fmt.Fprintln(w, "NAME\tADDRESS\tUSER\tPORT\tTAGS")
|
||||||
|
}
|
||||||
for _, host := range cfg.Hosts {
|
for _, host := range cfg.Hosts {
|
||||||
port := ""
|
port := ""
|
||||||
if host.Port > 0 {
|
if host.Port > 0 {
|
||||||
port = fmt.Sprint(host.Port)
|
port = fmt.Sprint(host.Port)
|
||||||
}
|
}
|
||||||
|
if withAliases {
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\n", host.Name, orDash(aliases[strings.ToLower(host.Name)]), host.Address, host.User, port, strings.Join(host.Tags, ","))
|
||||||
|
continue
|
||||||
|
}
|
||||||
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\n", host.Name, host.Address, host.User, port, strings.Join(host.Tags, ","))
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\n", host.Name, host.Address, host.User, port, strings.Join(host.Tags, ","))
|
||||||
}
|
}
|
||||||
return w.Flush()
|
return w.Flush()
|
||||||
|
|||||||
+40
-1
@@ -6,6 +6,7 @@ import (
|
|||||||
|
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/hook"
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/shortcuts"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/shortcuts"
|
||||||
)
|
)
|
||||||
@@ -29,6 +30,28 @@ func newNetBoxClient(cfg *config.Config) *netbox.Client {
|
|||||||
return netbox.NewClient(cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
|
return netbox.NewClient(cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// shortcutAliases maps each target (lowercased) to the shell alias generated for
|
||||||
|
// it, but only where shortcuts actually shorten the displayed name: an alias that
|
||||||
|
// merely replaces dots with underscores ("web01_example_com") adds nothing.
|
||||||
|
// The aliases are the same ones netssh alias and the shell hook define.
|
||||||
|
func shortcutAliases(entries []cache.Entry, cfg config.Config) map[string]string {
|
||||||
|
out := make(map[string]string)
|
||||||
|
if !cfg.Shortcuts.Enabled() {
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
plain := strings.NewReplacer(".", "_", "/", "_")
|
||||||
|
for _, alias := range hook.BuildAliasEntries(append([]cache.Entry(nil), entries...), cfg) {
|
||||||
|
if alias.Host == "" {
|
||||||
|
continue // the command alias for netssh itself
|
||||||
|
}
|
||||||
|
if alias.Name == plain.Replace(strings.ToLower(cfg.HostLabel(alias.Host))) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
out[strings.ToLower(alias.Host)] = alias.Name
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
func normalizeTarget(cfg config.ShortcutsConfig, qualified bool) func(string) string {
|
func normalizeTarget(cfg config.ShortcutsConfig, qualified bool) func(string) string {
|
||||||
return func(target string) string {
|
return func(target string) string {
|
||||||
source, name := netbox.SplitTarget(target)
|
source, name := netbox.SplitTarget(target)
|
||||||
@@ -48,6 +71,9 @@ func normalizeTarget(cfg config.ShortcutsConfig, qualified bool) func(string) st
|
|||||||
// Names present in several instances stay qualified ("prod/web01").
|
// Names present in several instances stay qualified ("prod/web01").
|
||||||
// Hosts whose full name does not match are offered by their configured
|
// Hosts whose full name does not match are offered by their configured
|
||||||
// shortcut instead ("fsnb" → "fsnbx1" for fsn1-bx1.example.com).
|
// shortcut instead ("fsnb" → "fsnbx1" for fsn1-bx1.example.com).
|
||||||
|
//
|
||||||
|
// With shortcuts.show, shortcuts are also offered for hosts whose full name
|
||||||
|
// matches, so "fsn" lists both fsn1-bx1.example.com and fsnbx1.
|
||||||
func hostCompletions(entries []cache.Entry, toComplete string, sc config.ShortcutsConfig) []string {
|
func hostCompletions(entries []cache.Entry, toComplete string, sc config.ShortcutsConfig) []string {
|
||||||
prefix := strings.ToLower(toComplete)
|
prefix := strings.ToLower(toComplete)
|
||||||
qualifiedInput := strings.Contains(prefix, "/")
|
qualifiedInput := strings.Contains(prefix, "/")
|
||||||
@@ -75,7 +101,20 @@ func hostCompletions(entries []cache.Entry, toComplete string, sc config.Shortcu
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
if sc.Enabled() {
|
if sc.Enabled() {
|
||||||
names = append(names, shortcutCompletions(entries, unmatched, prefix, sc)...)
|
candidates := unmatched
|
||||||
|
if sc.Show {
|
||||||
|
candidates = entries
|
||||||
|
}
|
||||||
|
offered := make(map[string]bool, len(names))
|
||||||
|
for _, name := range names {
|
||||||
|
offered[strings.ToLower(name)] = true
|
||||||
|
}
|
||||||
|
for _, name := range shortcutCompletions(entries, candidates, prefix, sc) {
|
||||||
|
if !offered[name] {
|
||||||
|
offered[name] = true
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
sort.Strings(names)
|
sort.Strings(names)
|
||||||
return names
|
return names
|
||||||
|
|||||||
+49
-4
@@ -62,6 +62,16 @@ func main() {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ssh has neither option, so both can only mean netssh's own help.
|
||||||
|
if args[0] == "--help" || args[0] == "-h" {
|
||||||
|
root := rootCmd()
|
||||||
|
root.SetArgs([]string{"help"})
|
||||||
|
if err := root.Execute(); err != nil {
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
if managedSubcommands[args[0]] {
|
if managedSubcommands[args[0]] {
|
||||||
if err := rootCmd().Execute(); err != nil {
|
if err := rootCmd().Execute(); err != nil {
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
@@ -320,6 +330,9 @@ func findSSHHost(ctx context.Context, client *netbox.Client, name string, domain
|
|||||||
|
|
||||||
// connectHost applies the SSH options configured for the host and execs the client.
|
// connectHost applies the SSH options configured for the host and execs the client.
|
||||||
func connectHost(cfg *config.Config, client internalssh.Client, flags internalssh.WrapperFlags, host resolvedHost, dests []int, args []string) {
|
func connectHost(cfg *config.Config, client internalssh.Client, flags internalssh.WrapperFlags, host resolvedHost, dests []int, args []string) {
|
||||||
|
if !internalssh.ValidAddress(host.IP) {
|
||||||
|
fatalf("refusing address %q for %s: not an IP address or hostname (check NetBox, or run netssh cache clear)", host.IP, host.Name)
|
||||||
|
}
|
||||||
opts := hostOptions(cfg, host)
|
opts := hostOptions(cfg, host)
|
||||||
if len(flags.Forwards) > 0 {
|
if len(flags.Forwards) > 0 {
|
||||||
forwardArgs, err := internalssh.ForwardArgs(flags.Forwards, opts.Forwards)
|
forwardArgs, err := internalssh.ForwardArgs(flags.Forwards, opts.Forwards)
|
||||||
@@ -335,6 +348,9 @@ func connectHost(cfg *config.Config, client internalssh.Client, flags internalss
|
|||||||
}
|
}
|
||||||
fatalf("name a forward or a spec such as 8080:localhost:80; forwards for %s: %s", host.Name, available)
|
fatalf("name a forward or a spec such as 8080:localhost:80; forwards for %s: %s", host.Name, available)
|
||||||
}
|
}
|
||||||
|
if err := runPreConnect(opts.PreConnectCommand(), host, client.Name, flags.DryRun); err != nil {
|
||||||
|
fatalf("%v", err)
|
||||||
|
}
|
||||||
_, name := netbox.SplitTarget(host.Name)
|
_, name := netbox.SplitTarget(host.Name)
|
||||||
execClient(client, client.Apply(args, dests, internalssh.Host{Name: name, IP: host.IP}, opts, flags), flags)
|
execClient(client, client.Apply(args, dests, internalssh.Host{Name: name, IP: host.IP}, opts, flags), flags)
|
||||||
}
|
}
|
||||||
@@ -373,6 +389,11 @@ func runTUI() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
m := tui.New(nbClient, c, cfg.SSH.DefaultUser, cfg.SSH.DefaultPort)
|
m := tui.New(nbClient, c, cfg.SSH.DefaultUser, cfg.SSH.DefaultPort)
|
||||||
|
m.SetHostLabel(cfg.HostLabel)
|
||||||
|
if cfg.Shortcuts.Show {
|
||||||
|
aliases := shortcutAliases(c.All(), *cfg)
|
||||||
|
m.SetAliases(func(target string) string { return aliases[strings.ToLower(target)] })
|
||||||
|
}
|
||||||
m.SetNotes(notes.New(cfg.NetBox.URL, nbClient))
|
m.SetNotes(notes.New(cfg.NetBox.URL, nbClient))
|
||||||
m.SetForwards(func(name, kind string, tags []string) []string {
|
m.SetForwards(func(name, kind string, tags []string) []string {
|
||||||
return forwardNames(hostOptions(cfg, resolvedHost{Name: name, Kind: kind, Tags: tags}))
|
return forwardNames(hostOptions(cfg, resolvedHost{Name: name, Kind: kind, Tags: tags}))
|
||||||
@@ -655,7 +676,8 @@ func cacheCmd() *cobra.Command {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func cacheListCmd() *cobra.Command {
|
func cacheListCmd() *cobra.Command {
|
||||||
return &cobra.Command{
|
var showAliases bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
Use: "list",
|
Use: "list",
|
||||||
Short: "Show all cached entries",
|
Short: "Show all cached entries",
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
@@ -671,13 +693,31 @@ func cacheListCmd() *cobra.Command {
|
|||||||
sort.Slice(entries, func(i, j int) bool { return entries[i].Name < entries[j].Name })
|
sort.Slice(entries, func(i, j int) bool { return entries[i].Name < entries[j].Name })
|
||||||
|
|
||||||
w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
|
w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
|
||||||
fmt.Fprintln(w, "NAME\tIP\tKIND\tCACHED AT")
|
if !showAliases && !cfg.Shortcuts.Show {
|
||||||
|
fmt.Fprintln(w, "NAME\tIP\tKIND\tCACHED AT")
|
||||||
|
for _, e := range entries {
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\n", e.Name, e.IP, e.Kind, e.CachedAt.Format(time.RFC3339))
|
||||||
|
}
|
||||||
|
return w.Flush()
|
||||||
|
}
|
||||||
|
aliases := shortcutAliases(entries, *cfg)
|
||||||
|
fmt.Fprintln(w, "NAME\tALIAS\tIP\tKIND\tCACHED AT")
|
||||||
for _, e := range entries {
|
for _, e := range entries {
|
||||||
fmt.Fprintf(w, "%s\t%s\t%s\t%s\n", e.Name, e.IP, e.Kind, e.CachedAt.Format(time.RFC3339))
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\n", e.Name, orDash(aliases[strings.ToLower(e.Name)]), e.IP, e.Kind, e.CachedAt.Format(time.RFC3339))
|
||||||
}
|
}
|
||||||
return w.Flush()
|
return w.Flush()
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
cmd.Flags().BoolVar(&showAliases, "aliases", false, "Show each host's shortcut alias (always on with shortcuts.show)")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// orDash keeps empty table cells visible.
|
||||||
|
func orDash(s string) string {
|
||||||
|
if s == "" {
|
||||||
|
return "-"
|
||||||
|
}
|
||||||
|
return s
|
||||||
}
|
}
|
||||||
|
|
||||||
func cacheClearCmd() *cobra.Command {
|
func cacheClearCmd() *cobra.Command {
|
||||||
@@ -1000,6 +1040,9 @@ func hookUninstallCmd() *cobra.Command {
|
|||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// refreshRetryInterval is the pause between background refresh attempts.
|
||||||
|
const refreshRetryInterval = 5 * time.Minute
|
||||||
|
|
||||||
// maybeBackgroundRefresh starts a background `netssh cache refresh` if the cache
|
// maybeBackgroundRefresh starts a background `netssh cache refresh` if the cache
|
||||||
// has not been fully refreshed within the last 24 hours.
|
// has not been fully refreshed within the last 24 hours.
|
||||||
func maybeBackgroundRefresh(cfg *config.Config, c *cache.Cache) {
|
func maybeBackgroundRefresh(cfg *config.Config, c *cache.Cache) {
|
||||||
@@ -1007,7 +1050,9 @@ func maybeBackgroundRefresh(cfg *config.Config, c *cache.Cache) {
|
|||||||
if !cfg.HasNetBox() || os.Getenv("NETSSH_NO_REFRESH") != "" {
|
if !cfg.HasNetBox() || os.Getenv("NETSSH_NO_REFRESH") != "" {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if !c.NeedsRefresh(24 * time.Hour) {
|
// While NetBox is unreachable the cache stays stale; without the retry
|
||||||
|
// interval every command and every new shell would start another refresh.
|
||||||
|
if !c.ClaimRefresh(24*time.Hour, refreshRetryInterval) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
self, err := os.Executable()
|
self, err := os.Executable()
|
||||||
|
|||||||
@@ -0,0 +1,54 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
|
)
|
||||||
|
|
||||||
|
// preConnectRunner runs the hook; tests replace it to avoid spawning a shell.
|
||||||
|
var preConnectRunner = runPreConnectCommand
|
||||||
|
|
||||||
|
// preConnectEnv describes the host to the hook through environment variables.
|
||||||
|
func preConnectEnv(host resolvedHost, clientName string) []string {
|
||||||
|
instance, name := netbox.SplitTarget(host.Name)
|
||||||
|
return []string{
|
||||||
|
"NETSSH_HOST=" + name,
|
||||||
|
"NETSSH_TARGET=" + host.Name,
|
||||||
|
"NETSSH_INSTANCE=" + instance,
|
||||||
|
"NETSSH_IP=" + host.IP,
|
||||||
|
"NETSSH_KIND=" + host.Kind,
|
||||||
|
"NETSSH_TAGS=" + strings.Join(host.Tags, ","),
|
||||||
|
"NETSSH_CLIENT=" + clientName,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// runPreConnect runs the configured pre_connect hook for host. Its output goes
|
||||||
|
// to stderr so it never mixes with the output of a remote command or scp.
|
||||||
|
// A failing hook returns an error and the connection must not be opened.
|
||||||
|
func runPreConnect(command string, host resolvedHost, clientName string, dryRun bool) error {
|
||||||
|
if command == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if dryRun {
|
||||||
|
fmt.Fprintf(os.Stderr, "# pre_connect (skipped in --dry-run): %s\n", command)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := preConnectRunner(command, preConnectEnv(host, clientName), os.Stdin, os.Stderr); err != nil {
|
||||||
|
return fmt.Errorf("pre_connect hook for %s failed: %w", host.Name, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runPreConnectCommand(command string, env []string, stdin io.Reader, out io.Writer) error {
|
||||||
|
cmd := exec.Command("sh", "-c", command)
|
||||||
|
cmd.Env = append(os.Environ(), env...)
|
||||||
|
cmd.Stdin = stdin
|
||||||
|
cmd.Stdout = out
|
||||||
|
cmd.Stderr = out
|
||||||
|
return cmd.Run()
|
||||||
|
}
|
||||||
@@ -0,0 +1,112 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
internalssh "git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/ssh"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRunPreConnectPassesHostAndStopsOnFailure(t *testing.T) {
|
||||||
|
host := resolvedHost{Name: "prod/web01", Kind: "vm", IP: "10.0.0.5", Tags: []string{"dmz", "web"}}
|
||||||
|
var gotCommand string
|
||||||
|
var gotEnv []string
|
||||||
|
fail := false
|
||||||
|
preConnectRunner = func(command string, env []string, _ io.Reader, _ io.Writer) error {
|
||||||
|
gotCommand, gotEnv = command, env
|
||||||
|
if fail {
|
||||||
|
return errors.New("exit status 1")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { preConnectRunner = runPreConnectCommand })
|
||||||
|
|
||||||
|
if err := runPreConnect("vpn-check", host, "sftp", false); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := []string{"NETSSH_HOST=web01", "NETSSH_TARGET=prod/web01", "NETSSH_INSTANCE=prod", "NETSSH_IP=10.0.0.5", "NETSSH_KIND=vm", "NETSSH_TAGS=dmz,web", "NETSSH_CLIENT=sftp"}
|
||||||
|
if gotCommand != "vpn-check" || !reflect.DeepEqual(gotEnv, want) {
|
||||||
|
t.Fatalf("got %q %v", gotCommand, gotEnv)
|
||||||
|
}
|
||||||
|
|
||||||
|
fail = true
|
||||||
|
if err := runPreConnect("vpn-check", host, "ssh", false); err == nil || !strings.Contains(err.Error(), "prod/web01") {
|
||||||
|
t.Fatalf("failure not reported: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
gotCommand = ""
|
||||||
|
if err := runPreConnect("vpn-check", host, "ssh", true); err != nil || gotCommand != "" {
|
||||||
|
t.Fatalf("dry-run ran the hook: %v %q", err, gotCommand)
|
||||||
|
}
|
||||||
|
if err := runPreConnect("", host, "ssh", false); err != nil || gotCommand != "" {
|
||||||
|
t.Fatalf("empty hook ran: %v %q", err, gotCommand)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunPreConnectCommandUsesShell(t *testing.T) {
|
||||||
|
var out bytes.Buffer
|
||||||
|
err := runPreConnectCommand(`echo "$NETSSH_HOST via $NETSSH_CLIENT"`, []string{"NETSSH_HOST=web01", "NETSSH_CLIENT=ssh"}, strings.NewReader(""), &out)
|
||||||
|
if err != nil || out.String() != "web01 via ssh\n" {
|
||||||
|
t.Fatalf("got %q, %v", out.String(), err)
|
||||||
|
}
|
||||||
|
if err := runPreConnectCommand("exit 3", nil, strings.NewReader(""), io.Discard); err == nil {
|
||||||
|
t.Fatal("non-zero exit not reported")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --dry-run only prints the ssh command: it must not run the hook, which may
|
||||||
|
// have side effects (bringing up a VPN, logging).
|
||||||
|
func TestConnectHostDryRunSkipsPreConnect(t *testing.T) {
|
||||||
|
ran := 0
|
||||||
|
preConnectRunner = func(string, []string, io.Reader, io.Writer) error { ran++; return nil }
|
||||||
|
t.Cleanup(func() { preConnectRunner = runPreConnectCommand })
|
||||||
|
cfg := &config.Config{SSH: config.SSHConfig{SSHOptions: config.SSHOptions{PreConnect: "hook"}}}
|
||||||
|
stdout := os.Stdout
|
||||||
|
r, w, _ := os.Pipe()
|
||||||
|
os.Stdout = w
|
||||||
|
connectHost(cfg, internalssh.SSH, internalssh.WrapperFlags{DryRun: true}, resolvedHost{Name: "web01", IP: "10.0.0.1"}, []int{0}, []string{"web01"})
|
||||||
|
w.Close()
|
||||||
|
os.Stdout = stdout
|
||||||
|
printed, _ := io.ReadAll(r)
|
||||||
|
if ran != 0 || !strings.Contains(string(printed), "10.0.0.1") {
|
||||||
|
t.Fatalf("dry-run: ran=%d printed=%q", ran, printed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestShortcutAliasesOnlyWhenShortened(t *testing.T) {
|
||||||
|
cfg := config.Config{Shell: config.ShellConfig{Alias: "j"}, Shortcuts: fsnRewrite}
|
||||||
|
entries := []cache.Entry{{Name: "fsn1-bx1.hoster.de"}, {Name: "web01.other.de"}, {Name: "db01.hoster.de"}}
|
||||||
|
got := shortcutAliases(entries, cfg)
|
||||||
|
want := map[string]string{"fsn1-bx1.hoster.de": "fsnbx1", "db01.hoster.de": "db01"}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %v, want %v", got, want)
|
||||||
|
}
|
||||||
|
if got := shortcutAliases(entries, config.Config{}); len(got) != 0 {
|
||||||
|
t.Fatalf("aliases without shortcuts: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHostCompletionsShowShortcutsForMatchingNames(t *testing.T) {
|
||||||
|
entries := []cache.Entry{{Name: "fsn1-bx1.hoster.de"}, {Name: "fsn1-db1.hoster.de"}}
|
||||||
|
if got := hostCompletions(entries, "fsn", fsnRewrite); !reflect.DeepEqual(got, []string{"fsn1-bx1.hoster.de", "fsn1-db1.hoster.de"}) {
|
||||||
|
t.Fatalf("without show: %v", got)
|
||||||
|
}
|
||||||
|
show := fsnRewrite
|
||||||
|
show.Show = true
|
||||||
|
want := []string{"fsn1-bx1.hoster.de", "fsn1-db1.hoster.de", "fsnbx1", "fsndb1"}
|
||||||
|
if got := hostCompletions(entries, "fsn", show); !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("with show: got %v, want %v", got, want)
|
||||||
|
}
|
||||||
|
// A shortcut equal to an offered name is not repeated.
|
||||||
|
plain := []cache.Entry{{Name: "web01"}}
|
||||||
|
if got := hostCompletions(plain, "web", show); !reflect.DeepEqual(got, []string{"web01"}) {
|
||||||
|
t.Fatalf("duplicate: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -71,6 +71,7 @@ func buildUninstallPlan(cfg *config.Config, keepConfig bool) uninstallPlan {
|
|||||||
addPath(path)
|
addPath(path)
|
||||||
addPath(path + ".lock")
|
addPath(path + ".lock")
|
||||||
addPath(filepath.Join(filepath.Dir(path), "last_refresh"))
|
addPath(filepath.Join(filepath.Dir(path), "last_refresh"))
|
||||||
|
addPath(filepath.Join(filepath.Dir(path), "refresh_attempt"))
|
||||||
if strings.HasPrefix(filepath.Base(filepath.Dir(path)), "instances-") {
|
if strings.HasPrefix(filepath.Base(filepath.Dir(path)), "instances-") {
|
||||||
addPath(filepath.Dir(path))
|
addPath(filepath.Dir(path))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ require (
|
|||||||
charm.land/bubbles/v2 v2.2.1
|
charm.land/bubbles/v2 v2.2.1
|
||||||
charm.land/bubbletea/v2 v2.1.1
|
charm.land/bubbletea/v2 v2.1.1
|
||||||
charm.land/huh/v2 v2.0.3
|
charm.land/huh/v2 v2.0.3
|
||||||
charm.land/lipgloss/v2 v2.1.0
|
charm.land/lipgloss/v2 v2.1.1
|
||||||
github.com/spf13/cobra v1.10.2
|
github.com/spf13/cobra v1.10.2
|
||||||
github.com/spf13/viper v1.21.0
|
github.com/spf13/viper v1.21.0
|
||||||
golang.org/x/sys v0.50.0
|
golang.org/x/sys v0.50.0
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ charm.land/bubbletea/v2 v2.1.1 h1:S1S9l37pCZGrj1JexBcr9x4Nr3MVeM42InqCYM/tDpU=
|
|||||||
charm.land/bubbletea/v2 v2.1.1/go.mod h1:xWHeyxIX9/wiFU2kgPW04ojOZyTzrWf+8lGjUCaftiU=
|
charm.land/bubbletea/v2 v2.1.1/go.mod h1:xWHeyxIX9/wiFU2kgPW04ojOZyTzrWf+8lGjUCaftiU=
|
||||||
charm.land/huh/v2 v2.0.3 h1:2cJsMqEPwSywGHvdlKsJyQKPtSJLVnFKyFbsYZTlLkU=
|
charm.land/huh/v2 v2.0.3 h1:2cJsMqEPwSywGHvdlKsJyQKPtSJLVnFKyFbsYZTlLkU=
|
||||||
charm.land/huh/v2 v2.0.3/go.mod h1:93eEveeeqn47MwiC3tf+2atZ2l7Is88rAtmZNZ8x9Wc=
|
charm.land/huh/v2 v2.0.3/go.mod h1:93eEveeeqn47MwiC3tf+2atZ2l7Is88rAtmZNZ8x9Wc=
|
||||||
charm.land/lipgloss/v2 v2.1.0 h1:RLCNLhSQST+NPOmvUSbRWZ3UFOXsf3ZXFmJ5E/2tHEU=
|
charm.land/lipgloss/v2 v2.1.1 h1:F+vKWis9Kz3MFRsbICSDFtT1ZwVL+8f+36Dtg+OpKwc=
|
||||||
charm.land/lipgloss/v2 v2.1.0/go.mod h1:wwfOgrNqUA9yjL8nmG6BIO0qQnmkEgJ8ISptbme83gI=
|
charm.land/lipgloss/v2 v2.1.1/go.mod h1:k79y/56yThpkJvbwyrcHr8MyZF42e84Q5fW9Ibu6LFc=
|
||||||
github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ=
|
github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ=
|
||||||
github.com/MakeNowJust/heredoc v1.0.0/go.mod h1:mG5amYoWBHf8vpLOuehzbGGw0EHxpZZ6lCpQ4fNJ8LE=
|
github.com/MakeNowJust/heredoc v1.0.0/go.mod h1:mG5amYoWBHf8vpLOuehzbGGw0EHxpZZ6lCpQ4fNJ8LE=
|
||||||
github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
|
github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
|
||||||
|
|||||||
Vendored
+20
@@ -83,6 +83,26 @@ func (c *Cache) NeedsRefresh(d time.Duration) bool {
|
|||||||
return time.Since(t) >= d
|
return time.Since(t) >= d
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ClaimRefresh reports whether a background refresh should start now: the last
|
||||||
|
// full refresh is older than d and no attempt was claimed within retry. It
|
||||||
|
// records the attempt, so parallel shells and repeated commands start one
|
||||||
|
// refresh per retry interval instead of one each.
|
||||||
|
func (c *Cache) ClaimRefresh(d, retry time.Duration) bool {
|
||||||
|
if !c.NeedsRefresh(d) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
attempt := filepath.Join(filepath.Dir(c.refreshStamp), "refresh_attempt")
|
||||||
|
if info, err := os.Stat(attempt); err == nil && time.Since(info.ModTime()) < retry {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if err := os.MkdirAll(filepath.Dir(attempt), 0o755); err != nil {
|
||||||
|
return true // cannot record the attempt; refreshing is still right
|
||||||
|
}
|
||||||
|
// Best effort: two processes racing here may both refresh once.
|
||||||
|
_ = os.WriteFile(attempt, nil, 0o600)
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
// SetRefreshed records the current time as the last successful full refresh.
|
// SetRefreshed records the current time as the last successful full refresh.
|
||||||
func (c *Cache) SetRefreshed() error {
|
func (c *Cache) SetRefreshed() error {
|
||||||
if c.refreshStamp == "" {
|
if c.refreshStamp == "" {
|
||||||
|
|||||||
Vendored
+20
@@ -557,3 +557,23 @@ func TestStaticHosts(t *testing.T) {
|
|||||||
t.Fatalf("removed static host still on disk:\n%s", data)
|
t.Fatalf("removed static host still on disk:\n%s", data)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestClaimRefreshThrottlesAttempts(t *testing.T) {
|
||||||
|
c := New(filepath.Join(t.TempDir(), "netssh", "hosts.json"), 60)
|
||||||
|
if !c.ClaimRefresh(24*time.Hour, time.Minute) {
|
||||||
|
t.Fatal("a never refreshed cache must claim a refresh")
|
||||||
|
}
|
||||||
|
// NetBox is down: the stamp stays stale, but the attempt is remembered.
|
||||||
|
if c.ClaimRefresh(24*time.Hour, time.Minute) {
|
||||||
|
t.Error("a second refresh within the retry interval must not start")
|
||||||
|
}
|
||||||
|
if !c.ClaimRefresh(24*time.Hour, 0) {
|
||||||
|
t.Error("after the retry interval a refresh must start again")
|
||||||
|
}
|
||||||
|
if err := c.SetRefreshed(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if c.ClaimRefresh(24*time.Hour, 0) {
|
||||||
|
t.Error("a freshly refreshed cache must not claim a refresh")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -30,11 +30,12 @@ type ShellConfig struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type NetBoxConfig struct {
|
type NetBoxConfig struct {
|
||||||
Name string `mapstructure:"name"`
|
DisablePrefix bool `mapstructure:"disable_prefix"`
|
||||||
URL string `mapstructure:"url"`
|
Name string `mapstructure:"name"`
|
||||||
Token string `mapstructure:"token"`
|
URL string `mapstructure:"url"`
|
||||||
TokenVersion int `mapstructure:"token_version"`
|
Token string `mapstructure:"token"`
|
||||||
SSH SSHOptions `mapstructure:"ssh"`
|
TokenVersion int `mapstructure:"token_version"`
|
||||||
|
SSH SSHOptions `mapstructure:"ssh"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type ResolverConfig struct {
|
type ResolverConfig struct {
|
||||||
@@ -66,6 +67,9 @@ type ShortcutsConfig struct {
|
|||||||
Domains []string `mapstructure:"domains"`
|
Domains []string `mapstructure:"domains"`
|
||||||
StripHyphens bool `mapstructure:"strip_hyphens"`
|
StripHyphens bool `mapstructure:"strip_hyphens"`
|
||||||
Rewrites []ShortcutRewrite `mapstructure:"rewrites"`
|
Rewrites []ShortcutRewrite `mapstructure:"rewrites"`
|
||||||
|
// Show displays each host's shortcut alias in the TUI and in host lists, and
|
||||||
|
// offers shortcuts in Tab completion even when the full name matches.
|
||||||
|
Show bool `mapstructure:"show"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ShortcutRewrite replaces every match of Pattern (Go regexp syntax) with
|
// ShortcutRewrite replaces every match of Pattern (Go regexp syntax) with
|
||||||
@@ -113,14 +117,15 @@ func Load() (*Config, error) {
|
|||||||
if err == nil {
|
if err == nil {
|
||||||
v.SetConfigName("netssh")
|
v.SetConfigName("netssh")
|
||||||
v.SetConfigType("yaml")
|
v.SetConfigType("yaml")
|
||||||
v.AddConfigPath(filepath.Join(configDir))
|
// Only the user's own directory: a netssh.yaml in the working directory
|
||||||
v.AddConfigPath(".")
|
// (e.g. of a cloned repository) could inject ssh options and a NetBox URL.
|
||||||
|
v.AddConfigPath(configDir)
|
||||||
}
|
}
|
||||||
|
|
||||||
v.SetEnvPrefix("NETSSH")
|
v.SetEnvPrefix("NETSSH")
|
||||||
v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
|
v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
|
||||||
v.AutomaticEnv()
|
v.AutomaticEnv()
|
||||||
for _, key := range []string{"netbox.url", "netbox.token", "netbox.token_version", "resolver.strategies", "resolver.management_subnets", "resolver.interface_name", "resolver.hostname_domain", "cache.ttl", "cache.path", "ssh.default_user", "ssh.default_port", "shortcuts.domains", "shortcuts.strip_hyphens", "shell.alias", "ssh.proxy_jump", "ssh.host_key_checking", "ssh.target", "ssh.address_family", "completion.max_results", "multi.multiplexer", "multi.panes_per_window"} {
|
for _, key := range []string{"netbox.url", "netbox.token", "netbox.token_version", "resolver.strategies", "resolver.management_subnets", "resolver.interface_name", "resolver.hostname_domain", "cache.ttl", "cache.path", "ssh.default_user", "ssh.default_port", "shortcuts.domains", "shortcuts.strip_hyphens", "shortcuts.show", "shell.alias", "ssh.proxy_jump", "ssh.pre_connect", "ssh.host_key_checking", "ssh.target", "ssh.address_family", "completion.max_results", "multi.multiplexer", "multi.panes_per_window"} {
|
||||||
if err := v.BindEnv(key); err != nil {
|
if err := v.BindEnv(key); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -196,3 +196,27 @@ func TestLoad_InvalidShortcutRewrite(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A netssh.yaml in the working directory (e.g. of a cloned repository) must
|
||||||
|
// not be loaded: it could inject ssh options such as ProxyCommand.
|
||||||
|
func TestLoad_IgnoresConfigInWorkingDirectory(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
t.Setenv("NETSSH_NETBOX_URL", "")
|
||||||
|
t.Chdir(writeConfig(t, "hosts:\n - name: evil\n address: 10.0.0.1\nssh:\n options:\n ProxyCommand: touch /tmp/pwned\n"))
|
||||||
|
cfg, err := Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Load: %v", err)
|
||||||
|
}
|
||||||
|
if len(cfg.Hosts) != 0 || len(cfg.SSH.Options) != 0 {
|
||||||
|
t.Errorf("config from the working directory was loaded: %+v", cfg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoad_RejectsInvalidLegacyNetBoxURL(t *testing.T) {
|
||||||
|
for _, bad := range []string{"netbox.example.com", "ftp://netbox.example.com", "https://netbox.example.com/?x=1"} {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", writeConfig(t, "netbox:\n url: \""+bad+"\"\n token: t\n"))
|
||||||
|
if _, err := Load(); err == nil || !strings.Contains(err.Error(), "netbox.url") {
|
||||||
|
t.Errorf("%s: got %v, want a netbox.url error", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -17,6 +17,9 @@ func (c *Config) ValidateNetBoxes() error {
|
|||||||
if len(c.NetBoxes) > 0 && c.NetBox.URL != "" {
|
if len(c.NetBoxes) > 0 && c.NetBox.URL != "" {
|
||||||
return fmt.Errorf("configure either netbox or netboxes, not both")
|
return fmt.Errorf("configure either netbox or netboxes, not both")
|
||||||
}
|
}
|
||||||
|
if c.NetBox.URL != "" && !validNetBoxURL(c.NetBox.URL) {
|
||||||
|
return fmt.Errorf("netbox.url %q must be an HTTP(S) URL without query or fragment", c.NetBox.URL)
|
||||||
|
}
|
||||||
seen := make(map[string]bool)
|
seen := make(map[string]bool)
|
||||||
for _, source := range c.NetBoxes {
|
for _, source := range c.NetBoxes {
|
||||||
if !instanceName.MatchString(source.Name) {
|
if !instanceName.MatchString(source.Name) {
|
||||||
@@ -27,8 +30,7 @@ func (c *Config) ValidateNetBoxes() error {
|
|||||||
return fmt.Errorf("duplicate NetBox instance name %q", source.Name)
|
return fmt.Errorf("duplicate NetBox instance name %q", source.Name)
|
||||||
}
|
}
|
||||||
seen[name] = true
|
seen[name] = true
|
||||||
u, err := url.Parse(source.URL)
|
if !validNetBoxURL(source.URL) {
|
||||||
if err != nil || (u.Scheme != "http" && u.Scheme != "https") || u.Host == "" || u.RawQuery != "" || u.Fragment != "" {
|
|
||||||
return fmt.Errorf("NetBox %q requires an HTTP(S) URL without query or fragment", source.Name)
|
return fmt.Errorf("NetBox %q requires an HTTP(S) URL without query or fragment", source.Name)
|
||||||
}
|
}
|
||||||
if source.TokenVersion < 0 || source.TokenVersion > 2 {
|
if source.TokenVersion < 0 || source.TokenVersion > 2 {
|
||||||
@@ -38,6 +40,12 @@ func (c *Config) ValidateNetBoxes() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// validNetBoxURL accepts base URLs that API paths can be appended to.
|
||||||
|
func validNetBoxURL(raw string) bool {
|
||||||
|
u, err := url.Parse(raw)
|
||||||
|
return err == nil && (u.Scheme == "http" || u.Scheme == "https") && u.Host != "" && u.RawQuery == "" && u.Fragment == ""
|
||||||
|
}
|
||||||
|
|
||||||
func (c *Config) HasNetBox() bool { return c.NetBox.URL != "" || len(c.NetBoxes) > 0 }
|
func (c *Config) HasNetBox() bool { return c.NetBox.URL != "" || len(c.NetBoxes) > 0 }
|
||||||
|
|
||||||
// HasHosts reports whether netssh has anything to connect to: NetBox or static hosts.
|
// HasHosts reports whether netssh has anything to connect to: NetBox or static hosts.
|
||||||
@@ -57,3 +65,17 @@ func (c *Config) CachePath() string {
|
|||||||
sum := sha256.Sum256([]byte(strings.Join(identities, "\x00")))
|
sum := sha256.Sum256([]byte(strings.Join(identities, "\x00")))
|
||||||
return filepath.Join(filepath.Dir(c.Cache.Path), fmt.Sprintf("instances-%x", sum[:8]), filepath.Base(c.Cache.Path))
|
return filepath.Join(filepath.Dir(c.Cache.Path), fmt.Sprintf("instances-%x", sum[:8]), filepath.Base(c.Cache.Path))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// HostLabel omits the configured instance prefix for display only. Callers
|
||||||
|
// must retain the canonical target for connections and handle label collisions.
|
||||||
|
func (c *Config) HostLabel(target string) string {
|
||||||
|
source, host, qualified := strings.Cut(target, "/")
|
||||||
|
if qualified {
|
||||||
|
for _, instance := range c.NetBoxes {
|
||||||
|
if instance.DisablePrefix && strings.EqualFold(instance.Name, source) {
|
||||||
|
return host
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return target
|
||||||
|
}
|
||||||
@@ -15,6 +15,7 @@ func TestLoadNamedNetBoxes(t *testing.T) {
|
|||||||
- name: Office
|
- name: Office
|
||||||
url: https://office.example/netbox
|
url: https://office.example/netbox
|
||||||
token: nbt_office
|
token: nbt_office
|
||||||
|
disable_prefix: true
|
||||||
- name: lab
|
- name: lab
|
||||||
url: https://lab.example
|
url: https://lab.example
|
||||||
token: legacy-token
|
token: legacy-token
|
||||||
@@ -34,7 +35,14 @@ cache:
|
|||||||
if cfg.NetBox.URL != "" {
|
if cfg.NetBox.URL != "" {
|
||||||
t.Fatal("legacy environment variables added an unnamed instance")
|
t.Fatal("legacy environment variables added an unnamed instance")
|
||||||
}
|
}
|
||||||
|
if !cfg.NetBoxes[0].DisablePrefix || cfg.NetBoxes[1].DisablePrefix {
|
||||||
|
t.Fatal("per-instance alias prefix setting was not loaded")
|
||||||
|
}
|
||||||
first := cfg.CachePath()
|
first := cfg.CachePath()
|
||||||
|
cfg.NetBoxes[0].DisablePrefix = false
|
||||||
|
if cfg.CachePath() != first {
|
||||||
|
t.Fatal("alias prefix setting discarded cache")
|
||||||
|
}
|
||||||
if first == cfg.Cache.Path {
|
if first == cfg.Cache.Path {
|
||||||
t.Fatal("named sources reuse legacy cache")
|
t.Fatal("named sources reuse legacy cache")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,6 +24,21 @@ type SSHOptions struct {
|
|||||||
Options map[string]string `mapstructure:"options"`
|
Options map[string]string `mapstructure:"options"`
|
||||||
// Forwards are named port forwards, selected with --forward or netssh tunnel.
|
// Forwards are named port forwards, selected with --forward or netssh tunnel.
|
||||||
Forwards map[string]Forward `mapstructure:"forwards"`
|
Forwards map[string]Forward `mapstructure:"forwards"`
|
||||||
|
// PreConnect is a shell command run locally before connecting; a non-zero
|
||||||
|
// exit aborts the connection. "none" disables a hook set by a broader layer.
|
||||||
|
PreConnect string `mapstructure:"pre_connect"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PreConnectNone disables an inherited pre_connect hook.
|
||||||
|
const PreConnectNone = "none"
|
||||||
|
|
||||||
|
// PreConnectCommand returns the hook to run, or "" when none is configured.
|
||||||
|
func (o SSHOptions) PreConnectCommand() string {
|
||||||
|
command := strings.TrimSpace(o.PreConnect)
|
||||||
|
if strings.EqualFold(command, PreConnectNone) {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return command
|
||||||
}
|
}
|
||||||
|
|
||||||
// Forward is one port forward; exactly one of the fields is set.
|
// Forward is one port forward; exactly one of the fields is set.
|
||||||
@@ -155,6 +170,9 @@ func (o SSHOptions) Validate(scope string) error {
|
|||||||
return fmt.Errorf("%s.options: invalid option %q", scope, key)
|
return fmt.Errorf("%s.options: invalid option %q", scope, key)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if strings.ContainsRune(o.PreConnect, 0) {
|
||||||
|
return fmt.Errorf("%s.pre_connect must not contain NUL bytes", scope)
|
||||||
|
}
|
||||||
for name, forward := range o.Forwards {
|
for name, forward := range o.Forwards {
|
||||||
if !instanceName.MatchString(name) {
|
if !instanceName.MatchString(name) {
|
||||||
return fmt.Errorf("%s.forwards: name %q must contain only letters, digits, underscores, or hyphens", scope, name)
|
return fmt.Errorf("%s.forwards: name %q must contain only letters, digits, underscores, or hyphens", scope, name)
|
||||||
@@ -221,6 +239,9 @@ func (o SSHOptions) merge(override SSHOptions) SSHOptions {
|
|||||||
if override.AddressFamily != "" {
|
if override.AddressFamily != "" {
|
||||||
out.AddressFamily = override.AddressFamily
|
out.AddressFamily = override.AddressFamily
|
||||||
}
|
}
|
||||||
|
if strings.TrimSpace(override.PreConnect) != "" {
|
||||||
|
out.PreConnect = override.PreConnect
|
||||||
|
}
|
||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -210,3 +210,50 @@ func TestMultiConfig(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestPreConnectLayeringAndNone(t *testing.T) {
|
||||||
|
cfg, err := loadYAML(t, `
|
||||||
|
netboxes:
|
||||||
|
- name: prod
|
||||||
|
url: https://prod.example.com
|
||||||
|
ssh:
|
||||||
|
pre_connect: vpn-up prod
|
||||||
|
- name: lab
|
||||||
|
url: https://lab.example.com
|
||||||
|
ssh:
|
||||||
|
pre_connect: check-vpn
|
||||||
|
rules:
|
||||||
|
- match: {tag: dmz}
|
||||||
|
pre_connect: none
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
host SSHHost
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{SSHHost{Instance: "lab", Name: "web01"}, "check-vpn"},
|
||||||
|
{SSHHost{Instance: "prod", Name: "web01"}, "vpn-up prod"},
|
||||||
|
{SSHHost{Instance: "prod", Name: "gw", Tags: []string{"dmz"}}, ""},
|
||||||
|
} {
|
||||||
|
if got := cfg.SSHOptionsFor(tc.host).PreConnectCommand(); got != tc.want {
|
||||||
|
t.Errorf("%+v: got %q, want %q", tc.host, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := (SSHOptions{PreConnect: "a\x00b"}).Validate("ssh"); err == nil {
|
||||||
|
t.Error("NUL byte in pre_connect accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreConnectFromEnvironment(t *testing.T) {
|
||||||
|
t.Setenv("NETSSH_SSH_PRE_CONNECT", "true")
|
||||||
|
t.Setenv("NETSSH_SHORTCUTS_SHOW", "true")
|
||||||
|
cfg, err := loadYAML(t, "")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if cfg.SSH.PreConnect != "true" || !cfg.Shortcuts.Show {
|
||||||
|
t.Fatalf("env not applied: pre_connect=%q show=%v", cfg.SSH.PreConnect, cfg.Shortcuts.Show)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -124,9 +124,34 @@ func BuildAliasEntries(entries []cache.Entry, cfg config.Config) []AliasEntry {
|
|||||||
seen[cfg.Shell.Alias] = true
|
seen[cfg.Shell.Alias] = true
|
||||||
out = append(out, AliasEntry{Name: cfg.Shell.Alias})
|
out = append(out, AliasEntry{Name: cfg.Shell.Alias})
|
||||||
}
|
}
|
||||||
for _, e := range entries {
|
|
||||||
|
withoutPrefix := make(map[string]bool, len(cfg.NetBoxes))
|
||||||
|
for _, source := range cfg.NetBoxes {
|
||||||
|
withoutPrefix[strings.ToLower(source.Name)] = source.DisablePrefix
|
||||||
|
}
|
||||||
|
// Reserve canonical aliases as well as requested bare aliases before
|
||||||
|
// generating any output, so cache ordering cannot redirect a collision.
|
||||||
|
canonical := make(map[string]bool, len(entries))
|
||||||
|
counts := make(map[string]int, len(entries))
|
||||||
|
candidates := make([]string, len(entries))
|
||||||
|
for i, e := range entries {
|
||||||
name := shortcuts.AliasName(e.Name, cfg.Shortcuts)
|
name := shortcuts.AliasName(e.Name, cfg.Shortcuts)
|
||||||
if seen[name] || name == "" || !regexp.MustCompile(`^[a-zA-Z_][a-zA-Z0-9_-]*$`).MatchString(name) {
|
canonical[name] = true
|
||||||
|
source, host, qualified := strings.Cut(e.Name, "/")
|
||||||
|
if qualified && withoutPrefix[strings.ToLower(source)] {
|
||||||
|
name = shortcuts.AliasName(host, cfg.Shortcuts)
|
||||||
|
}
|
||||||
|
candidates[i] = name
|
||||||
|
counts[name]++
|
||||||
|
}
|
||||||
|
validAlias := regexp.MustCompile(`^[a-zA-Z_][a-zA-Z0-9_-]*$`)
|
||||||
|
for i, e := range entries {
|
||||||
|
name := candidates[i]
|
||||||
|
full := shortcuts.AliasName(e.Name, cfg.Shortcuts)
|
||||||
|
if name != full && (counts[name] > 1 || canonical[name] || seen[name] || !validAlias.MatchString(name)) {
|
||||||
|
name = full
|
||||||
|
}
|
||||||
|
if seen[name] || name == "" || !validAlias.MatchString(name) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
seen[name] = true
|
seen[name] = true
|
||||||
|
|||||||
@@ -253,3 +253,78 @@ func TestAliasesUseRewriteRules(t *testing.T) {
|
|||||||
t.Fatalf("entries: %+v", entries)
|
t.Fatalf("entries: %+v", entries)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestAliasesOptionalInstancePrefix(t *testing.T) {
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBoxes: []config.NetBoxConfig{
|
||||||
|
{Name: "OFFICE", DisablePrefix: true},
|
||||||
|
{Name: "lab"},
|
||||||
|
},
|
||||||
|
Shortcuts: config.ShortcutsConfig{
|
||||||
|
Domains: []string{".example.com"},
|
||||||
|
Rewrites: []config.ShortcutRewrite{{Pattern: "^web-", Replace: "app"}},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
entries := hook.BuildAliasEntries([]cache.Entry{
|
||||||
|
{Name: "office/web-01.example.com"},
|
||||||
|
{Name: "lab/web-01.example.com"},
|
||||||
|
}, cfg)
|
||||||
|
got := map[string]string{}
|
||||||
|
for _, e := range entries {
|
||||||
|
got[e.Name] = e.Host
|
||||||
|
// Both output formats must keep the fully qualified destination.
|
||||||
|
for _, shell := range []string{"bash", "zsh", "fish"} {
|
||||||
|
if !strings.Contains(e.Definition(shell), e.Host) {
|
||||||
|
t.Fatalf("%s alias lost its target: %s", shell, e.Definition(shell))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(got) != 2 || got["app01"] != "office/web-01.example.com" || got["lab_app01"] != "lab/web-01.example.com" {
|
||||||
|
t.Fatalf("unexpected aliases: %+v", entries)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAliasesWithoutPrefixCollisions(t *testing.T) {
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBoxes: []config.NetBoxConfig{
|
||||||
|
{Name: "office", DisablePrefix: true},
|
||||||
|
{Name: "lab", DisablePrefix: true},
|
||||||
|
},
|
||||||
|
Shell: config.ShellConfig{Alias: "j"},
|
||||||
|
Shortcuts: config.ShortcutsConfig{Domains: []string{".example.com"}},
|
||||||
|
}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
hosts []string
|
||||||
|
want map[string]string
|
||||||
|
}{
|
||||||
|
{"two instances", []string{"office/web.example.com", "lab/web.example.com"},
|
||||||
|
map[string]string{"j": "", "office_web": "office/web.example.com", "lab_web": "lab/web.example.com"}},
|
||||||
|
{"static host", []string{"office/web.example.com", "web"},
|
||||||
|
map[string]string{"j": "", "office_web": "office/web.example.com", "web": "web"}},
|
||||||
|
{"command aliases", []string{"office/j", "office/netssh"},
|
||||||
|
map[string]string{"j": "", "office_j": "office/j", "office_netssh": "office/netssh"}},
|
||||||
|
{"reserved qualified alias", []string{"office/lab_web", "lab/web"},
|
||||||
|
map[string]string{"j": "", "office_lab_web": "office/lab_web", "web": "lab/web"}},
|
||||||
|
{"invalid bare alias", []string{"office/123.example.com"},
|
||||||
|
map[string]string{"j": "", "office_123": "office/123.example.com"}},
|
||||||
|
{"normalized names", []string{"office/web.example.com", "office/web"},
|
||||||
|
map[string]string{"j": "", "office_web": "office/web"}},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
var input []cache.Entry
|
||||||
|
for _, host := range tc.hosts {
|
||||||
|
input = append(input, cache.Entry{Name: host})
|
||||||
|
}
|
||||||
|
entries := hook.BuildAliasEntries(input, cfg)
|
||||||
|
if len(entries) != len(tc.want) {
|
||||||
|
t.Fatalf("aliases: %+v, want %+v", entries, tc.want)
|
||||||
|
}
|
||||||
|
for _, e := range entries {
|
||||||
|
if host, ok := tc.want[e.Name]; !ok || host != e.Host {
|
||||||
|
t.Fatalf("unexpected alias: %+v", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -18,6 +18,7 @@ type fake struct {
|
|||||||
syncState string
|
syncState string
|
||||||
keys map[string]string // existing prefix bindings by key
|
keys map[string]string // existing prefix bindings by key
|
||||||
solo string
|
solo string
|
||||||
|
prefix string
|
||||||
n int
|
n int
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -33,6 +34,8 @@ func (f *fake) Output(argv ...string) (string, error) {
|
|||||||
f.calls = append(f.calls, strings.Join(argv, " "))
|
f.calls = append(f.calls, strings.Join(argv, " "))
|
||||||
f.n++
|
f.n++
|
||||||
switch argv[1] {
|
switch argv[1] {
|
||||||
|
case "show-options":
|
||||||
|
return f.prefix, nil
|
||||||
case "new-window", "new-session":
|
case "new-window", "new-session":
|
||||||
return fmt.Sprintf("@%d %%%d", f.n, f.n), nil
|
return fmt.Sprintf("@%d %%%d", f.n, f.n), nil
|
||||||
case "split-window":
|
case "split-window":
|
||||||
@@ -121,6 +124,8 @@ func TestTmuxInside(t *testing.T) {
|
|||||||
"tmux list-keys -T prefix S",
|
"tmux list-keys -T prefix S",
|
||||||
"tmux list-keys -T prefix e",
|
"tmux list-keys -T prefix e",
|
||||||
"tmux source-file /tmp/l/netssh-multi.tmux.conf",
|
"tmux source-file /tmp/l/netssh-multi.tmux.conf",
|
||||||
|
"tmux set-window-option -t @1 @netssh_keys keys: Ctrl+b then S: sync on/off | Ctrl+b then e: solo on/off",
|
||||||
|
"tmux set-window-option -t @1 pane-border-format #{@netssh_host}#{?pane_synchronized, [SYNC],#{?@netssh_solo, [SOLO],}} #{?pane_active, | #{@netssh_keys},} ",
|
||||||
"tmux select-window -t @1",
|
"tmux select-window -t @1",
|
||||||
}
|
}
|
||||||
if strings.Join(f.calls, "\n") != strings.Join(want, "\n") {
|
if strings.Join(f.calls, "\n") != strings.Join(want, "\n") {
|
||||||
@@ -234,7 +239,7 @@ func TestTmuxKeyBindings(t *testing.T) {
|
|||||||
t.Errorf("conf lacks %q:\n%s", want, conf)
|
t.Errorf("conf lacks %q:\n%s", want, conf)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if hint != "keys: C-b S broadcast to all panes, C-b e exclude/include this pane" {
|
if hint != "keys: Ctrl+b then S: sync on/off | Ctrl+b then e: solo on/off" {
|
||||||
t.Errorf("hint %q", hint)
|
t.Errorf("hint %q", hint)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -279,3 +284,34 @@ func TestToggleSyncPane(t *testing.T) {
|
|||||||
t.Fatalf("zellij: %v", err)
|
t.Fatalf("zellij: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTmuxPersistentHints(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
keys map[string]string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{"custom prefix", nil, "keys: Ctrl+a then Ctrl+s: sync on/off | Ctrl+a then e: solo on/off"},
|
||||||
|
{"occupied key", map[string]string{"C-s": "bind-key -T prefix C-s display-time"}, "keys: Ctrl+a then e: solo on/off; C-a C-s kept your own binding (use netssh sync)"},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
f := newFake(nil, "tmux")
|
||||||
|
f.prefix, f.keys = "C-a", tc.keys
|
||||||
|
if err := Open(Tmux, panes("a", "b"), Options{PerWindow: 1, SyncKey: "C-s", SoloKey: "e"}, f); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
n := 0
|
||||||
|
for _, call := range f.calls {
|
||||||
|
if strings.Contains(call, " @netssh_keys ") {
|
||||||
|
n++
|
||||||
|
if !strings.HasSuffix(call, " @netssh_keys "+tc.want) {
|
||||||
|
t.Fatalf("wrong persistent hint: %s", call)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if n != 2 {
|
||||||
|
t.Fatalf("hints installed in %d windows, want 2", n)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -27,6 +27,7 @@ func openTmux(panes []Pane, opts Options, r Runner) error {
|
|||||||
}
|
}
|
||||||
groups := chunks(panes, opts.PerWindow)
|
groups := chunks(panes, opts.PerWindow)
|
||||||
first := ""
|
first := ""
|
||||||
|
var windows []string
|
||||||
for i, group := range groups {
|
for i, group := range groups {
|
||||||
name := windowLabel(opts.Label, i, len(groups))
|
name := windowLabel(opts.Label, i, len(groups))
|
||||||
format := []string{"-P", "-F", "#{window_id} #{pane_id}", "-n", name}
|
format := []string{"-P", "-F", "#{window_id} #{pane_id}", "-n", name}
|
||||||
@@ -52,6 +53,7 @@ func openTmux(panes []Pane, opts Options, r Runner) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
window, pane, _ := strings.Cut(out, " ")
|
window, pane, _ := strings.Cut(out, " ")
|
||||||
|
windows = append(windows, window)
|
||||||
if first == "" {
|
if first == "" {
|
||||||
first = window
|
first = window
|
||||||
}
|
}
|
||||||
@@ -91,6 +93,17 @@ func openTmux(panes []Pane, opts Options, r Runner) error {
|
|||||||
}
|
}
|
||||||
if keys != "" {
|
if keys != "" {
|
||||||
opts.Hint(keys)
|
opts.Hint(keys)
|
||||||
|
// Window-local hints remain visible after attaching, including in an
|
||||||
|
// existing session. Keep other windows and the user's status bar intact.
|
||||||
|
for _, window := range windows {
|
||||||
|
if _, err := r.Output("tmux", "set-window-option", "-t", window, "@netssh_keys", keys); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if _, err := r.Output("tmux", "set-window-option", "-t", window, "pane-border-format",
|
||||||
|
" #{@netssh_host}#{?pane_synchronized, [SYNC],#{?@netssh_solo, [SOLO],}} #{?pane_active, | #{@netssh_keys},} "); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if inside {
|
if inside {
|
||||||
_, err := r.Output("tmux", "select-window", "-t", first)
|
_, err := r.Output("tmux", "select-window", "-t", first)
|
||||||
@@ -149,8 +162,8 @@ func bindKeys(r Runner, opts Options) (string, error) {
|
|||||||
var conf strings.Builder
|
var conf strings.Builder
|
||||||
var hints, taken []string
|
var hints, taken []string
|
||||||
for _, key := range []struct{ key, binding, what string }{
|
for _, key := range []struct{ key, binding, what string }{
|
||||||
{opts.SyncKey, syncBinding, "broadcast to all panes"},
|
{opts.SyncKey, syncBinding, "sync on/off"},
|
||||||
{opts.SoloKey, soloBinding, "exclude/include this pane"},
|
{opts.SoloKey, soloBinding, "solo on/off"},
|
||||||
} {
|
} {
|
||||||
if key.key == "" {
|
if key.key == "" {
|
||||||
continue
|
continue
|
||||||
@@ -161,7 +174,7 @@ func bindKeys(r Runner, opts Options) (string, error) {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
fmt.Fprintf(&conf, key.binding, key.key)
|
fmt.Fprintf(&conf, key.binding, key.key)
|
||||||
hints = append(hints, prefix+" "+key.key+" "+key.what)
|
hints = append(hints, displayKey(prefix)+" then "+displayKey(key.key)+": "+key.what)
|
||||||
}
|
}
|
||||||
if conf.Len() > 0 {
|
if conf.Len() > 0 {
|
||||||
path := filepath.Join(opts.LayoutDir, "netssh-multi.tmux.conf")
|
path := filepath.Join(opts.LayoutDir, "netssh-multi.tmux.conf")
|
||||||
@@ -172,7 +185,7 @@ func bindKeys(r Runner, opts Options) (string, error) {
|
|||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
hint := "keys: " + strings.Join(hints, ", ")
|
hint := "keys: " + strings.Join(hints, " | ")
|
||||||
if len(hints) == 0 {
|
if len(hints) == 0 {
|
||||||
hint = "toggle broadcast with: netssh sync, netssh sync --pane"
|
hint = "toggle broadcast with: netssh sync, netssh sync --pane"
|
||||||
}
|
}
|
||||||
@@ -192,3 +205,9 @@ func freeSession(r Runner, name string) string {
|
|||||||
candidate = name + "-" + strconv.Itoa(n)
|
candidate = name + "-" + strconv.Itoa(n)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// displayKey expands tmux's modifier notation for the on-screen legend.
|
||||||
|
func displayKey(key string) string {
|
||||||
|
key = strings.ReplaceAll(key, "C-", "Ctrl+")
|
||||||
|
return strings.ReplaceAll(key, "M-", "Alt+")
|
||||||
|
}
|
||||||
+33
-24
@@ -176,24 +176,32 @@ func (c *Client) GetIPs(ctx context.Context, entry HostEntry) ([]string, error)
|
|||||||
}
|
}
|
||||||
return source.GetIPs(ctx, host)
|
return source.GetIPs(ctx, host)
|
||||||
}
|
}
|
||||||
var apiURL string
|
|
||||||
switch entry.Kind {
|
switch entry.Kind {
|
||||||
case "device":
|
case "device":
|
||||||
apiURL = fmt.Sprintf("%s/api/ipam/ip-addresses/?device_id=%d&limit=100", c.baseURL, entry.ID)
|
return c.fetchAllIPs(ctx, fmt.Sprintf("device_id=%d", entry.ID))
|
||||||
case "vm":
|
case "vm":
|
||||||
apiURL = fmt.Sprintf("%s/api/ipam/ip-addresses/?virtual_machine_id=%d&limit=100", c.baseURL, entry.ID)
|
return c.fetchAllIPs(ctx, fmt.Sprintf("virtual_machine_id=%d", entry.ID))
|
||||||
default:
|
|
||||||
return nil, fmt.Errorf("unknown host kind: %q", entry.Kind)
|
|
||||||
}
|
}
|
||||||
|
return nil, fmt.Errorf("unknown host kind: %q", entry.Kind)
|
||||||
|
}
|
||||||
|
|
||||||
var resp netboxIPListResponse
|
// fetchAllIPs pages through the IP addresses matching filterParams, so hosts
|
||||||
if err := c.get(ctx, apiURL, &resp); err != nil {
|
// with more addresses than one page do not lose their management address.
|
||||||
return nil, err
|
func (c *Client) fetchAllIPs(ctx context.Context, filterParams string) ([]string, error) {
|
||||||
}
|
const pageSize = 100
|
||||||
|
var ips []string
|
||||||
ips := make([]string, 0, len(resp.Results))
|
for offset := 0; ; offset += pageSize {
|
||||||
for _, r := range resp.Results {
|
apiURL := fmt.Sprintf("%s/api/ipam/ip-addresses/?%s&limit=%d&offset=%d", c.baseURL, filterParams, pageSize, offset)
|
||||||
ips = append(ips, stripPrefix(r.Address))
|
var resp netboxIPListResponse
|
||||||
|
if err := c.get(ctx, apiURL, &resp); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
for _, r := range resp.Results {
|
||||||
|
ips = append(ips, stripPrefix(r.Address))
|
||||||
|
}
|
||||||
|
if len(resp.Results) < pageSize || len(ips) >= resp.Count {
|
||||||
|
break
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return ips, nil
|
return ips, nil
|
||||||
}
|
}
|
||||||
@@ -203,16 +211,7 @@ func (c *Client) GetIPsWithFilter(ctx context.Context, filterParams string) ([]s
|
|||||||
if c.sources != nil {
|
if c.sources != nil {
|
||||||
return nil, fmt.Errorf("IP filters require a host instance; use GetIPsWithFilterForHost")
|
return nil, fmt.Errorf("IP filters require a host instance; use GetIPsWithFilterForHost")
|
||||||
}
|
}
|
||||||
apiURL := fmt.Sprintf("%s/api/ipam/ip-addresses/?%s&limit=100", c.baseURL, filterParams)
|
return c.fetchAllIPs(ctx, filterParams)
|
||||||
var resp netboxIPListResponse
|
|
||||||
if err := c.get(ctx, apiURL, &resp); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
ips := make([]string, 0, len(resp.Results))
|
|
||||||
for _, r := range resp.Results {
|
|
||||||
ips = append(ips, stripPrefix(r.Address))
|
|
||||||
}
|
|
||||||
return ips, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) searchDevices(ctx context.Context, query, tag string) ([]HostEntry, error) {
|
func (c *Client) searchDevices(ctx context.Context, query, tag string) ([]HostEntry, error) {
|
||||||
@@ -348,7 +347,7 @@ func (c *Client) request(ctx context.Context, method, apiURL string, body io.Rea
|
|||||||
}
|
}
|
||||||
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
if resp.StatusCode != http.StatusOK {
|
||||||
return "", fmt.Errorf("netbox returned %d for %s", resp.StatusCode, apiURL)
|
return "", &StatusError{Code: resp.StatusCode, URL: apiURL}
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := json.NewDecoder(resp.Body).Decode(out); err != nil {
|
if err := json.NewDecoder(resp.Body).Decode(out); err != nil {
|
||||||
@@ -399,6 +398,16 @@ func stripPrefix(cidr string) string {
|
|||||||
return cidr
|
return cidr
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// StatusError is an unexpected HTTP status from NetBox.
|
||||||
|
type StatusError struct {
|
||||||
|
Code int
|
||||||
|
URL string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *StatusError) Error() string {
|
||||||
|
return fmt.Sprintf("netbox returned %d for %s", e.Code, e.URL)
|
||||||
|
}
|
||||||
|
|
||||||
// ErrHostNotFound distinguishes a missing exact match from API failures or ambiguity.
|
// ErrHostNotFound distinguishes a missing exact match from API failures or ambiguity.
|
||||||
var ErrHostNotFound = errors.New("host not found")
|
var ErrHostNotFound = errors.New("host not found")
|
||||||
|
|
||||||
|
|||||||
@@ -3,8 +3,11 @@ package netbox
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
@@ -499,3 +502,45 @@ func TestCommentConflictIsReported(t *testing.T) {
|
|||||||
t.Fatal("conflict ignored")
|
t.Fatal("conflict ignored")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Hosts with more addresses than one page must not lose the later ones.
|
||||||
|
func TestGetIPs_Paginates(t *testing.T) {
|
||||||
|
const total = 230
|
||||||
|
var offsets []string
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
offsets = append(offsets, r.URL.Query().Get("offset"))
|
||||||
|
offset, _ := strconv.Atoi(r.URL.Query().Get("offset"))
|
||||||
|
limit, _ := strconv.Atoi(r.URL.Query().Get("limit"))
|
||||||
|
var addrs []string
|
||||||
|
for i := offset; i < offset+limit && i < total; i++ {
|
||||||
|
addrs = append(addrs, fmt.Sprintf("10.0.%d.%d/24", i/250, i%250+1))
|
||||||
|
}
|
||||||
|
resp := ipListResponse(addrs...)
|
||||||
|
resp.Count = total
|
||||||
|
json.NewEncoder(w).Encode(resp)
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
ips, err := NewClient(srv.URL, "token", 0).GetIPs(context.Background(), HostEntry{ID: 1, Kind: "device"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetIPs: %v", err)
|
||||||
|
}
|
||||||
|
if len(ips) != total || ips[total-1] != "10.0.0.230" {
|
||||||
|
t.Errorf("got %d IPs (last %q), want %d", len(ips), ips[len(ips)-1], total)
|
||||||
|
}
|
||||||
|
if strings.Join(offsets, ",") != "0,100,200" {
|
||||||
|
t.Errorf("offsets %v, want 0,100,200", offsets)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequest_StatusErrorCarriesCode(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
_, err := NewClient(srv.URL, "token", 0).GetIPsWithFilter(context.Background(), "device_id=1&interface=nope")
|
||||||
|
var status *StatusError
|
||||||
|
if !errors.As(err, &status) || status.Code != http.StatusBadRequest {
|
||||||
|
t.Fatalf("got %v, want a StatusError with code 400", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,6 +2,7 @@ package resolver
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
@@ -32,6 +33,12 @@ func (c *Chain) Resolve(ctx context.Context, entry *netbox.HostEntry, client *ne
|
|||||||
if err == nil {
|
if err == nil {
|
||||||
return ip, nil
|
return ip, nil
|
||||||
}
|
}
|
||||||
|
// Only "this strategy has no address" moves on. After an API failure
|
||||||
|
// the next strategy would connect to (and cache) a different address
|
||||||
|
// than the configured order asks for.
|
||||||
|
if !errors.Is(err, ErrNoIP) {
|
||||||
|
return "", fmt.Errorf("resolver strategy %q for %q: %w", s.Name(), entry.Name, err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return "", fmt.Errorf("no strategy resolved an IP for %q", entry.Name)
|
return "", fmt.Errorf("no strategy resolved an IP for %q", entry.Name)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -153,3 +153,17 @@ func TestNew_MultipleStrategies(t *testing.T) {
|
|||||||
t.Errorf("got %d strategies, want 2", len(c.strategies))
|
t.Errorf("got %d strategies, want 2", len(c.strategies))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// An API failure must not fall through: the next strategy would connect to
|
||||||
|
// and cache a different address than the configured order asks for.
|
||||||
|
func TestChain_APIErrorStopsTheChain(t *testing.T) {
|
||||||
|
apiErr := errors.New("connection refused")
|
||||||
|
c := &Chain{strategies: []Strategy{
|
||||||
|
&stubStrategy{name: "management_subnet", err: apiErr},
|
||||||
|
&stubStrategy{name: "primary_ip", ip: "10.0.0.2"},
|
||||||
|
}}
|
||||||
|
ip, err := c.Resolve(context.Background(), &netbox.HostEntry{Name: "host"}, nil)
|
||||||
|
if !errors.Is(err, apiErr) || ip != "" {
|
||||||
|
t.Fatalf("got %q, %v; want the API error and no address", ip, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,7 +2,9 @@ package resolver
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
@@ -31,6 +33,10 @@ func (s *InterfaceNameStrategy) Resolve(ctx context.Context, entry *netbox.HostE
|
|||||||
}
|
}
|
||||||
|
|
||||||
ips, err := client.GetIPsWithFilterForHost(ctx, *entry, filterParam)
|
ips, err := client.GetIPsWithFilterForHost(ctx, *entry, filterParam)
|
||||||
|
var status *netbox.StatusError
|
||||||
|
if errors.As(err, &status) && status.Code == http.StatusBadRequest {
|
||||||
|
return "", ErrNoIP // the host has no interface of this name
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("fetching IPs for interface %q: %w", s.name, err)
|
return "", fmt.Errorf("fetching IPs for interface %q: %w", s.name, err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ package resolver
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"net/url"
|
"net/url"
|
||||||
@@ -54,3 +55,16 @@ func urlQuery(s string) (string, error) {
|
|||||||
q, err := url.ParseQuery(s)
|
q, err := url.ParseQuery(s)
|
||||||
return q.Encode(), err
|
return q.Encode(), err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Only the HTTP 400 of a missing interface means "no address here"; a server
|
||||||
|
// error must stop the chain instead of silently using the next strategy.
|
||||||
|
func TestInterfaceNameStrategyServerErrorIsNotNoIP(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusBadGateway)
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
_, err := (&InterfaceNameStrategy{name: "mgmt0"}).Resolve(context.Background(), &netbox.HostEntry{ID: 7, Kind: "device"}, netbox.NewClient(srv.URL, "t", 1))
|
||||||
|
if err == nil || errors.Is(err, ErrNoIP) {
|
||||||
|
t.Fatalf("got %v, want an API error", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -108,6 +108,9 @@ func editInstance(source config.NetBoxConfig, sources []config.NetBoxConfig, ori
|
|||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}),
|
}),
|
||||||
|
huh.NewConfirm().Title("Hide instance prefix in aliases and TUI?").
|
||||||
|
Description("Shorter shell aliases and TUI host names. Conflicting names keep their prefix.").
|
||||||
|
Value(&source.DisablePrefix),
|
||||||
huh.NewInput().Title("NetBox URL").Placeholder("https://netbox.example.com").Value(&source.URL).Validate(func(value string) error {
|
huh.NewInput().Title("NetBox URL").Placeholder("https://netbox.example.com").Value(&source.URL).Validate(func(value string) error {
|
||||||
return (&config.Config{NetBoxes: []config.NetBoxConfig{{Name: "instance", URL: strings.TrimSpace(value)}}}).ValidateNetBoxes()
|
return (&config.Config{NetBoxes: []config.NetBoxConfig{{Name: "instance", URL: strings.TrimSpace(value)}}}).ValidateNetBoxes()
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ func editSSHOptions(title string, o config.SSHOptions) (config.SSHOptions, error
|
|||||||
extraArgs := strings.Join(o.ExtraArgs, "\n")
|
extraArgs := strings.Join(o.ExtraArgs, "\n")
|
||||||
options := formatOptions(o.Options)
|
options := formatOptions(o.Options)
|
||||||
forwards := formatForwards(o.Forwards)
|
forwards := formatForwards(o.Forwards)
|
||||||
|
preConnect := o.PreConnect
|
||||||
|
|
||||||
err := huh.NewForm(huh.NewGroup(
|
err := huh.NewForm(huh.NewGroup(
|
||||||
huh.NewInput().
|
huh.NewInput().
|
||||||
@@ -69,6 +70,14 @@ func editSSHOptions(title string, o config.SSHOptions) (config.SSHOptions, error
|
|||||||
_, err := parseForwards(s)
|
_, err := parseForwards(s)
|
||||||
return err
|
return err
|
||||||
}),
|
}),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Pre-connect hook").
|
||||||
|
Description("Shell command run locally before connecting, e.g. vpn-check.sh \"$NETSSH_HOST\".\n"+
|
||||||
|
"A non-zero exit aborts. Leave empty to inherit; 'none' disables a hook set elsewhere.").
|
||||||
|
Value(&preConnect).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
return config.SSHOptions{PreConnect: s}.Validate("ssh")
|
||||||
|
}),
|
||||||
).Title(title)).Run()
|
).Title(title)).Run()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return o, err
|
return o, err
|
||||||
@@ -84,6 +93,7 @@ func editSSHOptions(title string, o config.SSHOptions) (config.SSHOptions, error
|
|||||||
AddressFamily: addressFamily,
|
AddressFamily: addressFamily,
|
||||||
ExtraArgs: parseLines(extraArgs),
|
ExtraArgs: parseLines(extraArgs),
|
||||||
Options: parsed,
|
Options: parsed,
|
||||||
|
PreConnect: strings.TrimSpace(preConnect),
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -226,6 +226,7 @@ func editShortcuts(cfg *config.Config) error {
|
|||||||
stripHyphens := cfg.Shortcuts.StripHyphens
|
stripHyphens := cfg.Shortcuts.StripHyphens
|
||||||
rewrites := formatRewrites(cfg.Shortcuts.Rewrites)
|
rewrites := formatRewrites(cfg.Shortcuts.Rewrites)
|
||||||
commandAlias := cfg.Shell.Alias
|
commandAlias := cfg.Shell.Alias
|
||||||
|
showShortcuts := cfg.Shortcuts.Show
|
||||||
err := huh.NewForm(huh.NewGroup(
|
err := huh.NewForm(huh.NewGroup(
|
||||||
huh.NewInput().
|
huh.NewInput().
|
||||||
Title("Domain suffixes").
|
Title("Domain suffixes").
|
||||||
@@ -247,6 +248,11 @@ func editShortcuts(cfg *config.Config) error {
|
|||||||
_, err := parseRewrites(s)
|
_, err := parseRewrites(s)
|
||||||
return err
|
return err
|
||||||
}),
|
}),
|
||||||
|
huh.NewConfirm().
|
||||||
|
Title("Show shortcuts").
|
||||||
|
Description("Show each host's shortcut alias in the TUI, netssh cache list and netssh hosts list,\n"+
|
||||||
|
"and offer shortcuts in Tab completion even when the full name matches.").
|
||||||
|
Value(&showShortcuts),
|
||||||
huh.NewInput().
|
huh.NewInput().
|
||||||
Title("Command alias").
|
Title("Command alias").
|
||||||
Description("Optional alias for netssh itself, e.g. j. Leave empty to disable.").
|
Description("Optional alias for netssh itself, e.g. j. Leave empty to disable.").
|
||||||
@@ -266,6 +272,7 @@ func editShortcuts(cfg *config.Config) error {
|
|||||||
}
|
}
|
||||||
cfg.Shortcuts.StripHyphens = stripHyphens
|
cfg.Shortcuts.StripHyphens = stripHyphens
|
||||||
cfg.Shortcuts.Rewrites, _ = parseRewrites(rewrites)
|
cfg.Shortcuts.Rewrites, _ = parseRewrites(rewrites)
|
||||||
|
cfg.Shortcuts.Show = showShortcuts
|
||||||
cfg.Shell.Alias = strings.TrimSpace(commandAlias)
|
cfg.Shell.Alias = strings.TrimSpace(commandAlias)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -385,6 +392,9 @@ func save(cfg config.Config) error {
|
|||||||
b.WriteString("netboxes:\n")
|
b.WriteString("netboxes:\n")
|
||||||
for _, source := range cfg.NetBoxes {
|
for _, source := range cfg.NetBoxes {
|
||||||
fmt.Fprintf(&b, " - name: %q\n url: %q\n token: %q\n token_version: %d\n", source.Name, source.URL, source.Token, source.TokenVersion)
|
fmt.Fprintf(&b, " - name: %q\n url: %q\n token: %q\n token_version: %d\n", source.Name, source.URL, source.Token, source.TokenVersion)
|
||||||
|
if source.DisablePrefix {
|
||||||
|
b.WriteString(" disable_prefix: true\n")
|
||||||
|
}
|
||||||
if !sshOptionsEmpty(source.SSH) {
|
if !sshOptionsEmpty(source.SSH) {
|
||||||
b.WriteString(" ssh:\n")
|
b.WriteString(" ssh:\n")
|
||||||
writeSSHOptions(&b, " ", source.SSH)
|
writeSSHOptions(&b, " ", source.SSH)
|
||||||
@@ -501,7 +511,7 @@ func save(cfg config.Config) error {
|
|||||||
fmt.Fprintf(&b, "\ncompletion:\n max_results: %d\n", cfg.Completion.MaxResults)
|
fmt.Fprintf(&b, "\ncompletion:\n max_results: %d\n", cfg.Completion.MaxResults)
|
||||||
}
|
}
|
||||||
|
|
||||||
if cfg.Shortcuts.Enabled() {
|
if cfg.Shortcuts.Enabled() || cfg.Shortcuts.Show {
|
||||||
b.WriteString("\nshortcuts:\n")
|
b.WriteString("\nshortcuts:\n")
|
||||||
if len(cfg.Shortcuts.Domains) > 0 {
|
if len(cfg.Shortcuts.Domains) > 0 {
|
||||||
b.WriteString(" domains:\n")
|
b.WriteString(" domains:\n")
|
||||||
@@ -518,6 +528,9 @@ func save(cfg config.Config) error {
|
|||||||
fmt.Fprintf(&b, " - pattern: %q\n replace: %q\n", r.Pattern, r.Replace)
|
fmt.Fprintf(&b, " - pattern: %q\n replace: %q\n", r.Pattern, r.Replace)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if cfg.Shortcuts.Show {
|
||||||
|
b.WriteString(" show: true\n")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if cfg.Shell.Alias != "" {
|
if cfg.Shell.Alias != "" {
|
||||||
@@ -533,12 +546,12 @@ func save(cfg config.Config) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func sshOptionsEmpty(o config.SSHOptions) bool {
|
func sshOptionsEmpty(o config.SSHOptions) bool {
|
||||||
return o.ProxyJump == "" && o.HostKeyChecking == "" && o.Target == "" && o.AddressFamily == "" && len(o.ExtraArgs) == 0 && len(o.Options) == 0 && len(o.Forwards) == 0
|
return o.ProxyJump == "" && o.HostKeyChecking == "" && o.Target == "" && o.AddressFamily == "" && len(o.ExtraArgs) == 0 && len(o.Options) == 0 && len(o.Forwards) == 0 && o.PreConnect == ""
|
||||||
}
|
}
|
||||||
|
|
||||||
// writeSSHOptions keeps settings the wizard does not ask for when it rewrites the config.
|
// writeSSHOptions keeps settings the wizard does not ask for when it rewrites the config.
|
||||||
func writeSSHOptions(b *strings.Builder, indent string, o config.SSHOptions) {
|
func writeSSHOptions(b *strings.Builder, indent string, o config.SSHOptions) {
|
||||||
for _, field := range [][2]string{{"proxy_jump", o.ProxyJump}, {"host_key_checking", o.HostKeyChecking}, {"target", o.Target}, {"address_family", o.AddressFamily}} {
|
for _, field := range [][2]string{{"proxy_jump", o.ProxyJump}, {"host_key_checking", o.HostKeyChecking}, {"target", o.Target}, {"address_family", o.AddressFamily}, {"pre_connect", o.PreConnect}} {
|
||||||
if field[1] != "" {
|
if field[1] != "" {
|
||||||
fmt.Fprintf(b, "%s%s: %q\n", indent, field[0], field[1])
|
fmt.Fprintf(b, "%s%s: %q\n", indent, field[0], field[1])
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -398,7 +398,7 @@ func TestSaveMultipleNetBoxesRoundTrip(t *testing.T) {
|
|||||||
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
cfg := config.Config{
|
cfg := config.Config{
|
||||||
NetBoxes: []config.NetBoxConfig{
|
NetBoxes: []config.NetBoxConfig{
|
||||||
{Name: "office", URL: "https://office.example/netbox", Token: "nbt_secret: office", TokenVersion: 2},
|
{Name: "office", URL: "https://office.example/netbox", Token: "nbt_secret: office", TokenVersion: 2, DisablePrefix: true},
|
||||||
{Name: "lab", URL: "https://lab.example", Token: "legacy#token", TokenVersion: 1},
|
{Name: "lab", URL: "https://lab.example", Token: "legacy#token", TokenVersion: 1},
|
||||||
},
|
},
|
||||||
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
||||||
@@ -438,9 +438,10 @@ func TestSaveKeepsSSHOptions(t *testing.T) {
|
|||||||
AddressFamily: "inet",
|
AddressFamily: "inet",
|
||||||
ExtraArgs: []string{"-A"},
|
ExtraArgs: []string{"-A"},
|
||||||
Options: map[string]string{"serveraliveinterval": "60"},
|
Options: map[string]string{"serveraliveinterval": "60"},
|
||||||
|
PreConnect: `vpn-check "$NETSSH_HOST" && echo 'ok'`,
|
||||||
}
|
}
|
||||||
cfg := config.Config{
|
cfg := config.Config{
|
||||||
NetBoxes: []config.NetBoxConfig{{Name: "prod", URL: "https://prod.example", Token: "t", TokenVersion: 1, SSH: config.SSHOptions{HostKeyChecking: "off"}}},
|
NetBoxes: []config.NetBoxConfig{{Name: "prod", URL: "https://prod.example", Token: "t", TokenVersion: 1, SSH: config.SSHOptions{HostKeyChecking: "off", PreConnect: "none"}}},
|
||||||
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
||||||
Cache: config.CacheConfig{TTL: 3600},
|
Cache: config.CacheConfig{TTL: 3600},
|
||||||
SSH: config.SSHConfig{
|
SSH: config.SSHConfig{
|
||||||
@@ -651,3 +652,28 @@ func TestParseGroupsAndSaveMulti(t *testing.T) {
|
|||||||
t.Fatalf("got %v %+v", loaded.Groups, loaded.Multi)
|
t.Fatalf("got %v %+v", loaded.Groups, loaded.Multi)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestSaveKeepsShortcutsShow(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
t.Setenv("HOME", t.TempDir())
|
||||||
|
for _, sc := range []config.ShortcutsConfig{
|
||||||
|
{Domains: []string{".example.com"}, Show: true},
|
||||||
|
{Show: true}, // no shortcut rules yet: the switch alone must survive
|
||||||
|
} {
|
||||||
|
cfg := config.Config{
|
||||||
|
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
||||||
|
Cache: config.CacheConfig{TTL: 3600},
|
||||||
|
Shortcuts: sc,
|
||||||
|
}
|
||||||
|
if err := save(cfg); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
loaded, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !loaded.Shortcuts.Show || !reflect.DeepEqual(loaded.Shortcuts.Domains, sc.Domains) {
|
||||||
|
t.Fatalf("shortcuts lost: %+v", loaded.Shortcuts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,6 +2,7 @@ package ssh
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"net/netip"
|
||||||
"regexp"
|
"regexp"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -142,6 +143,18 @@ type Result struct {
|
|||||||
Notice string
|
Notice string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var destinationName = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9._-]*$`)
|
||||||
|
|
||||||
|
// ValidAddress reports whether addr is an IP address or a hostname. Addresses
|
||||||
|
// come from NetBox and the cache file; one such as "-oProxyCommand=…" would be
|
||||||
|
// read by ssh as an option and run a command.
|
||||||
|
func ValidAddress(addr string) bool {
|
||||||
|
if _, err := netip.ParseAddr(addr); err == nil {
|
||||||
|
return !strings.ContainsAny(addr, " \t\r\n")
|
||||||
|
}
|
||||||
|
return destinationName.MatchString(addr)
|
||||||
|
}
|
||||||
|
|
||||||
var plainHostname = regexp.MustCompile(`^[A-Za-z0-9]([A-Za-z0-9._-]*[A-Za-z0-9])?$`)
|
var plainHostname = regexp.MustCompile(`^[A-Za-z0-9]([A-Za-z0-9._-]*[A-Za-z0-9])?$`)
|
||||||
|
|
||||||
// Apply replaces the destination at destIdx and inserts the configured -o
|
// Apply replaces the destination at destIdx and inserts the configured -o
|
||||||
|
|||||||
@@ -128,3 +128,17 @@ func TestQuote(t *testing.T) {
|
|||||||
t.Fatalf("got %s", got)
|
t.Fatalf("got %s", got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestValidAddress(t *testing.T) {
|
||||||
|
for _, addr := range []string{"10.0.0.1", "fd00:30::60", "fe80::1%eth0", "web01", "web01.example.com", "db_1.lan"} {
|
||||||
|
if !ValidAddress(addr) {
|
||||||
|
t.Errorf("ValidAddress(%q) = false, want true", addr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// ssh would read the first as an option and run the command.
|
||||||
|
for _, addr := range []string{"-oProxyCommand=touch /tmp/pwned", "-J", "", "a b", "host;id", "user@host", "host/path", "fe80::1%eth0 x", "$(id)"} {
|
||||||
|
if ValidAddress(addr) {
|
||||||
|
t.Errorf("ValidAddress(%q) = true, want false", addr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
package storage
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestWriteFileReplacesAtomically(t *testing.T) {
|
||||||
|
dir := filepath.Join(t.TempDir(), "new", "dir")
|
||||||
|
path := filepath.Join(dir, "file")
|
||||||
|
for _, content := range []string{"first", "second"} {
|
||||||
|
if err := WriteFile(path, []byte(content), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, err := os.ReadFile(path)
|
||||||
|
if err != nil || string(got) != content {
|
||||||
|
t.Fatalf("got %q, %v; want %q", got, err, content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
info, err := os.Stat(path)
|
||||||
|
if err != nil || info.Mode().Perm() != 0o600 {
|
||||||
|
t.Errorf("mode %v, %v; want 0600", info.Mode().Perm(), err)
|
||||||
|
}
|
||||||
|
entries, _ := os.ReadDir(dir)
|
||||||
|
if len(entries) != 1 {
|
||||||
|
t.Errorf("temporary files left behind: %v", entries)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -9,6 +9,7 @@ import (
|
|||||||
|
|
||||||
tea "charm.land/bubbletea/v2"
|
tea "charm.land/bubbletea/v2"
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -79,3 +80,116 @@ func TestPartialOutageKeepsLiveAndCachedResultsVisible(t *testing.T) {
|
|||||||
t.Fatalf("outage warning overflowed view: %d", rows)
|
t.Fatalf("outage warning overflowed view: %d", rows)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestHiddenPrefixKeepsCanonicalTargets(t *testing.T) {
|
||||||
|
cfg := config.Config{NetBoxes: []config.NetBoxConfig{
|
||||||
|
{Name: "OFFICE", DisablePrefix: true}, {Name: "lab"},
|
||||||
|
}}
|
||||||
|
for _, cached := range []bool{false, true} {
|
||||||
|
for _, action := range []string{"ssh", "sftp", "multi", "autocomplete", "edit", "tunnel"} {
|
||||||
|
t.Run(fmt.Sprintf("cached=%v/%s", cached, action), func(t *testing.T) {
|
||||||
|
m := New(nil, nil, "")
|
||||||
|
m.SetHostLabel(cfg.HostLabel)
|
||||||
|
m.Update(tea.WindowSizeMsg{Width: 100, Height: 24})
|
||||||
|
entries := []netbox.HostEntry{
|
||||||
|
{Source: "office", Name: "web01", PrimaryIP4: "10.0.0.1"},
|
||||||
|
{Source: "lab", Name: "web01", PrimaryIP4: "10.0.0.2"},
|
||||||
|
}
|
||||||
|
if cached {
|
||||||
|
for i := range entries {
|
||||||
|
entries[i].Name = entries[i].Target()
|
||||||
|
entries[i].Source = ""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m.updateListItems(entries)
|
||||||
|
item := m.list.Items()[0].(hostItem)
|
||||||
|
if item.Title() != "web01" || item.name != "office/web01" {
|
||||||
|
t.Fatalf("display changed identity: %+v", item)
|
||||||
|
}
|
||||||
|
view := m.View().Content
|
||||||
|
if strings.Contains(view, "office/web01") || !strings.Contains(view, "lab/web01") {
|
||||||
|
t.Fatalf("wrong rendered prefixes: %s", view)
|
||||||
|
}
|
||||||
|
switch action {
|
||||||
|
case "ssh", "sftp":
|
||||||
|
key := tea.KeyPressMsg{Code: tea.KeyEnter}
|
||||||
|
if action == "sftp" {
|
||||||
|
key = tea.KeyPressMsg{Code: 'o', Mod: tea.ModCtrl}
|
||||||
|
}
|
||||||
|
m.Update(key)
|
||||||
|
if m.selected == nil || m.selected.Name != "office/web01" {
|
||||||
|
t.Fatalf("lost instance: %+v", m.selected)
|
||||||
|
}
|
||||||
|
case "multi":
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeySpace, Text: " "})
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeyEnter})
|
||||||
|
if m.selected == nil || len(m.selected.Targets) != 1 || m.selected.Targets[0] != "office/web01" {
|
||||||
|
t.Fatalf("multi lost instance: %+v", m.selected)
|
||||||
|
}
|
||||||
|
case "autocomplete":
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeyTab})
|
||||||
|
if m.input.Value() != "office/web01" {
|
||||||
|
t.Fatal("autocomplete lost instance")
|
||||||
|
}
|
||||||
|
case "edit":
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 'e', Mod: tea.ModCtrl})
|
||||||
|
if m.editHost == nil || m.editHost.name != "office/web01" {
|
||||||
|
t.Fatal("editor lost instance")
|
||||||
|
}
|
||||||
|
case "tunnel":
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 't', Mod: tea.ModCtrl})
|
||||||
|
if m.forwardHost == nil || m.forwardHost.name != "office/web01" {
|
||||||
|
t.Fatal("tunnel lost instance")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHiddenPrefixDuplicateLabels(t *testing.T) {
|
||||||
|
cfg := config.Config{NetBoxes: []config.NetBoxConfig{
|
||||||
|
{Name: "office", DisablePrefix: true}, {Name: "lab", DisablePrefix: true},
|
||||||
|
}}
|
||||||
|
for _, other := range []netbox.HostEntry{
|
||||||
|
{Source: "lab", Name: "WEB"},
|
||||||
|
{Name: "web", Kind: "static"},
|
||||||
|
} {
|
||||||
|
m := New(nil, nil, "")
|
||||||
|
m.SetHostLabel(cfg.HostLabel)
|
||||||
|
m.updateListItems([]netbox.HostEntry{{Source: "office", Name: "web"}, other})
|
||||||
|
for _, entry := range m.list.Items() {
|
||||||
|
item := entry.(hostItem)
|
||||||
|
if item.Title() != item.name {
|
||||||
|
t.Fatalf("ambiguous label: %+v", item)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAliasesShownNextToHostName(t *testing.T) {
|
||||||
|
m := New(nil, cache.New("", 3600), "")
|
||||||
|
m.SetAliases(func(target string) string {
|
||||||
|
return map[string]string{"fsn1-bx1.hoster.de": "fsnbx1", "web01": "web01"}[target]
|
||||||
|
})
|
||||||
|
m.updateListItems([]netbox.HostEntry{{Name: "fsn1-bx1.hoster.de", PrimaryIP4: "10.0.0.1"}, {Name: "web01", PrimaryIP4: "10.0.0.2"}})
|
||||||
|
items := m.list.Items()
|
||||||
|
if got := items[0].(hostItem).alias; got != "fsnbx1" {
|
||||||
|
t.Fatalf("alias = %q", got)
|
||||||
|
}
|
||||||
|
// An alias equal to the shown name is not repeated.
|
||||||
|
if got := items[1].(hostItem).alias; got != "" {
|
||||||
|
t.Fatalf("redundant alias %q", got)
|
||||||
|
}
|
||||||
|
var b strings.Builder
|
||||||
|
compactDelegate{marked: map[string]bool{}}.Render(&b, m.list, 1, items[0])
|
||||||
|
if !strings.Contains(b.String(), "fsn1-bx1.hoster.de") || !strings.Contains(b.String(), "→ fsnbx1") {
|
||||||
|
t.Fatalf("row %q", b.String())
|
||||||
|
}
|
||||||
|
// Without SetAliases nothing changes.
|
||||||
|
plain := New(nil, cache.New("", 3600), "")
|
||||||
|
plain.updateListItems([]netbox.HostEntry{{Name: "fsn1-bx1.hoster.de"}})
|
||||||
|
if got := plain.list.Items()[0].(hostItem).alias; got != "" {
|
||||||
|
t.Fatalf("alias without SetAliases: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
+56
-9
@@ -63,14 +63,21 @@ type searchResultMsg struct {
|
|||||||
// --- list item ---
|
// --- list item ---
|
||||||
|
|
||||||
type hostItem struct {
|
type hostItem struct {
|
||||||
name string
|
label string // display only; name remains the canonical target
|
||||||
id int
|
alias string // shortcut alias shown next to the name (shortcuts.show)
|
||||||
ip string
|
name string
|
||||||
kind string
|
id int
|
||||||
tags []string
|
ip string
|
||||||
|
kind string
|
||||||
|
tags []string
|
||||||
}
|
}
|
||||||
|
|
||||||
func (h hostItem) Title() string { return h.name }
|
func (h hostItem) Title() string {
|
||||||
|
if h.label != "" {
|
||||||
|
return h.label
|
||||||
|
}
|
||||||
|
return h.name
|
||||||
|
}
|
||||||
func (h hostItem) Description() string { return fmt.Sprintf("%s [%s]", h.ip, h.kind) }
|
func (h hostItem) Description() string { return fmt.Sprintf("%s [%s]", h.ip, h.kind) }
|
||||||
func (h hostItem) FilterValue() string { return h.name }
|
func (h hostItem) FilterValue() string { return h.name }
|
||||||
|
|
||||||
@@ -91,7 +98,11 @@ func (d compactDelegate) Render(w io.Writer, m list.Model, index int, item list.
|
|||||||
if d.marked[h.key()] {
|
if d.marked[h.key()] {
|
||||||
mark = "● "
|
mark = "● "
|
||||||
}
|
}
|
||||||
line := fmt.Sprintf(" %s%s %s", mark, h.name, lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render(h.ip))
|
title := h.Title()
|
||||||
|
if h.alias != "" {
|
||||||
|
title += " " + lipgloss.NewStyle().Foreground(lipgloss.Color("109")).Render("→ "+h.alias)
|
||||||
|
}
|
||||||
|
line := fmt.Sprintf(" %s%s %s", mark, title, lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render(h.ip))
|
||||||
if index == m.Index() {
|
if index == m.Index() {
|
||||||
line = lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("86")).Render("> " + strings.TrimPrefix(line, " "))
|
line = lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("86")).Render("> " + strings.TrimPrefix(line, " "))
|
||||||
}
|
}
|
||||||
@@ -181,7 +192,9 @@ type Model struct {
|
|||||||
editMode bool // Ctrl+E on the selected item
|
editMode bool // Ctrl+E on the selected item
|
||||||
forwardMode bool // Ctrl+T on the selected item
|
forwardMode bool // Ctrl+T on the selected item
|
||||||
marked map[string]bool // hostItem.key() of hosts marked with space
|
marked map[string]bool // hostItem.key() of hosts marked with space
|
||||||
markOrder []string // targets in the order they were marked
|
hostLabel func(string) string
|
||||||
|
aliasFor func(string) string // shortcut alias per target, "" for none
|
||||||
|
markOrder []string // targets in the order they were marked
|
||||||
}
|
}
|
||||||
|
|
||||||
func New(client *netbox.Client, c *cache.Cache, defaultUser string, defaultPorts ...int) *Model {
|
func New(client *netbox.Client, c *cache.Cache, defaultUser string, defaultPorts ...int) *Model {
|
||||||
@@ -678,12 +691,34 @@ func (m *Model) updateListItems(entries []netbox.HostEntry) {
|
|||||||
f := parseFilter(m.filterInput.Value())
|
f := parseFilter(m.filterInput.Value())
|
||||||
filtered := applyFilter(entries, f)
|
filtered := applyFilter(entries, f)
|
||||||
items := make([]list.Item, len(filtered))
|
items := make([]list.Item, len(filtered))
|
||||||
|
labels := make([]string, len(filtered))
|
||||||
|
counts := make(map[string]int, len(filtered))
|
||||||
|
canonical := make(map[string]bool, len(filtered))
|
||||||
|
for i, e := range filtered {
|
||||||
|
labels[i] = e.Target()
|
||||||
|
canonical[strings.ToLower(e.Target())] = true
|
||||||
|
if m.hostLabel != nil {
|
||||||
|
labels[i] = m.hostLabel(e.Target())
|
||||||
|
}
|
||||||
|
counts[strings.ToLower(labels[i])]++
|
||||||
|
}
|
||||||
for i, e := range filtered {
|
for i, e := range filtered {
|
||||||
ip := e.PrimaryIP4
|
ip := e.PrimaryIP4
|
||||||
if ip == "" {
|
if ip == "" {
|
||||||
ip = e.PrimaryIP6
|
ip = e.PrimaryIP6
|
||||||
}
|
}
|
||||||
items[i] = hostItem{id: e.ID, name: e.Target(), ip: ip, kind: e.Kind, tags: e.Tags}
|
label := labels[i]
|
||||||
|
if label != e.Target() && (counts[strings.ToLower(label)] > 1 || canonical[strings.ToLower(label)]) {
|
||||||
|
label = e.Target()
|
||||||
|
}
|
||||||
|
alias := ""
|
||||||
|
if m.aliasFor != nil {
|
||||||
|
alias = m.aliasFor(e.Target())
|
||||||
|
if strings.EqualFold(alias, label) {
|
||||||
|
alias = ""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
items[i] = hostItem{label: label, alias: alias, id: e.ID, name: e.Target(), ip: ip, kind: e.Kind, tags: e.Tags}
|
||||||
}
|
}
|
||||||
m.list.SetItems(items)
|
m.list.SetItems(items)
|
||||||
m.resizeList()
|
m.resizeList()
|
||||||
@@ -819,3 +854,15 @@ func parseForwards(input string, available []string) ([]string, error) {
|
|||||||
}
|
}
|
||||||
return fields, nil
|
return fields, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetHostLabel sets the display name formatter without changing host identity.
|
||||||
|
// Configure it before the program starts, just like SetNotes and SetForwards.
|
||||||
|
func (m *Model) SetHostLabel(format func(string) string) {
|
||||||
|
m.hostLabel = format
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetAliases shows the shortcut alias returned for each target next to its
|
||||||
|
// name; return "" for hosts without one. Configure it before the program starts.
|
||||||
|
func (m *Model) SetAliases(aliasFor func(target string) string) {
|
||||||
|
m.aliasFor = aliasFor
|
||||||
|
}
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
name: netssh-test
|
name: netssh-test
|
||||||
|
|
||||||
x-netbox: &netbox
|
x-netbox: &netbox
|
||||||
image: netboxcommunity/netbox:v4.7.4-5.1.1
|
image: netboxcommunity/netbox:v4.7.5-5.1.1
|
||||||
depends_on:
|
depends_on:
|
||||||
postgres: {condition: service_healthy}
|
postgres: {condition: service_healthy}
|
||||||
redis: {condition: service_healthy}
|
redis: {condition: service_healthy}
|
||||||
|
|||||||
Reference in new issue
Block a user