✨ feat(apikey): adds command to delete api keys

[pallabpain]

Description

We currently do not have a way to clean up api keys. There may be cases where users of headscale may generate a lot of api keys and these may end up accumulating in the database. This commit adds the command to delete an api key given a prefix.

Usage

→ hs apikeys --help
Handle the Api keys in Headscale

Usage:
  headscale apikeys [command]

Aliases:
  apikeys, apikey, api

Available Commands:
  create      Creates a new Api key
  delete      Delete an ApiKey
  expire      Expire an ApiKey
  list        List the Api keys for headscale

Flags:
  -h, --help   help for apikeys

Global Flags:
  -c, --config string   config file (default is /etc/headscale/config.yaml)
      --force           Disable prompts and forces the execution
  -o, --output string   Output format. Empty for human-readable, 'json', 'json-line' or 'yaml'

Use "headscale apikeys [command] --help" for more information about a command.

→ hs apikeys delete --help
Delete an ApiKey

Usage:
  headscale apikeys delete [flags]

Aliases:
  delete, remove, del

Flags:
  -h, --help            help for delete
  -p, --prefix string   ApiKey prefix

Global Flags:
  -c, --config string   config file (default is /etc/headscale/config.yaml)
      --force           Disable prompts and forces the execution
  -o, --output string   Output format. Empty for human-readable, 'json', 'json-line' or 'yaml'

Testing

Manual

04:16:58 pallab@pop-os headscale ±|feat/delete-apikeys ✗|
→ sudo ./headscale apikeys create -e 9d --config config.yaml
uYZ927_pGw.2BjBph-ncqd5ZFM1_cISVgjEUkHA8fj-vOYn3WuaZ3Y

04:17:06 pallab@pop-os headscale ±|feat/delete-apikeys ✗|
→ sudo ./headscale apikeys ls --config config.yaml 
ID | Prefix     | Expiration          | Created
1  | uYZ927_pGw | 2024-02-06 10:47:06 | 2024-01-28 10:47:06

04:17:09 pallab@pop-os headscale ±|feat/delete-apikeys ✗|
→ alias hs='sudo ./headscale --config config.yaml'

04:17:39 pallab@pop-os headscale ±|feat/delete-apikeys ✗|
→ hs apikeys ls
ID | Prefix     | Expiration          | Created
1  | uYZ927_pGw | 2024-02-06 10:47:06 | 2024-01-28 10:47:06

04:17:44 pallab@pop-os headscale ±|feat/delete-apikeys ✗|
→ hs apikeys delete --prefix uYZ927_pGw
Key deleted

04:17:54 pallab@pop-os headscale ±|feat/delete-apikeys ✗|
→ hs apikeys ls
ID | Prefix | Expiration | Created

• read the CONTRIBUTING guidelines
• raised a GitHub issue or discussed it on the projects chat beforehand
• added unit tests
• added integration tests
• updated documentation if needed
• updated CHANGELOG.md

Resolves

• Add "delete" to the 'apikey' command #1667

Depends

• Replace database locks with transactions #1701
• Restructure database config #1700

[kradalby]

I think this looks reasonable, but I would prefer to get in the db changes I have a pr up for first (transactions).

[pallabpain]

I think this looks reasonable, but I would prefer to get in the db changes I have a pr up for first (transactions).

Sounds good to me.

[kradalby]

Could you add a test for this in integrations/cli_test.go ?, otherwise looks sensible.

[pallabpain]

Could you add a test for this in integrations/cli_test.go ?, otherwise looks sensible.

@kradalby Done. Please review.