diff options
| author | James O'Doherty <james@theodohertyfamily.com> | 2026-05-29 19:30:26 -0400 |
|---|---|---|
| committer | James O'Doherty <james@theodohertyfamily.com> | 2026-05-29 19:30:26 -0400 |
| commit | b1b68a4aa441d9ce39d05f85338e371a704dd601 (patch) | |
| tree | 63491b88a18522eafddbd4b7525bb89bc2a04732 /README.md | |
| parent | 70096b533d42b684ab13651aaae884047e01e43d (diff) | |
feat(cli,parser): support custom profile names and overhaul WireGuard .conf parser for robustness
- CLI:
- Add optional `[name]` argument to `wg-wrap profile import <path> [name]` to allow overriding the imported profile name. If not provided, it falls back to the derived filename.
- Update `README.md` command documentation to reflect custom profile names and list the `wg-wrap profile stop <name>` subcommand.
- Expand `internal/cli/profile_test.go` to cover derived vs custom-named profile imports.
- WG Configuration Parser:
- Overhaul `pkg/wgconf/wgconf.go` to support case-insensitivity on section headers (e.g. `[peer]`, `[interface]`) and key names (e.g. `privatekey`, `allowedips`).
- Implement robust trailing comment stripping (both `#` and `;`) while preserving inline comment-like characters in cryptographic keys (e.g. `key-with-hash-inside#123`) using whitespace-padded match logic.
- Clean up and normalize leading/trailing spaces/tabs on parsed keys, values, and list elements (e.g. `AllowedIPs` and `DNS` fields).
- Gracefully ignore unrecognized keys (e.g. `MTU`, `ListenPort`, `PresharedKey`) without returning errors.
- Add comprehensive tests in `pkg/wgconf/wgconf_test.go` covering inline/block comments, formatting variations, unrecognized keys, and case-insensitivity.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 3 |
1 files changed, 2 insertions, 1 deletions
@@ -43,9 +43,10 @@ To simplify usage, `wg-wrap` implements a profile system for managing WireGuard ### Profile Management Commands Beyond wrapping commands, `wg-wrap` provides management sub-commands to handle profiles: - `wg-wrap profile list`: Lists all available profiles in the config directory. -- `wg-wrap profile import <path>`: Imports a `.conf` file into the profiles directory, prompting for a profile name. +- `wg-wrap profile import <path> [name]`: Imports a `.conf` file into the profiles directory. If `[name]` is not provided, the profile name is derived from the `.conf` filename. Otherwise, the specified custom name is used. - `wg-wrap profile configure <name>`: Opens the selected profile in the system's default editor. - `wg-wrap profile delete <name>`: Removes the specified profile. +- `wg-wrap profile stop <name>`: Stops the tunnel/namespace associated with the specified profile and unpins it. ### Diagnostics For debugging and environment verification, `wg-wrap` provides diagnostic tools: |