1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
# `arti keys-raw`
`arti keys-raw` is a plumbing, unsafe command line utility for managing the
content of keystores.
**Important**: The functionalities of this subcommand operate at a lower
level than the `arti keys` commands, on individual keystore entries.
As such, misusing them can lead to unexpected behaviour. For example, using
`remove-by-id` to remove an identity key will trigger the generation of a
new identity key when the service is launched.
Before using `keys raw` subcommands, check whether your use case is covered
by the `arti keys` subcommands.
Like the other `arti` subcommands, it has an optional `--config` option for
specifying the TOML configuration file. Using the correct configuration file is
important, because the keystores that `arti keys-raw` interacts with are relative to the
state directory, which you might have overridden in the configuration.
> `arti keys-raw` is an experimental subcommand.
> To use it, you will need to compile `arti` with the experimental `onion-service-cli-extra` feature.
## Remove a keystore entry by path
`arti keys raw-remove-by-id` allows the operator to remove a single keystore entry, provided a raw ID.
A raw ID is an identifier used to reference any filesystem object associated with a specific keystore.
This command provides a way of removing not just recognized keys, but also unrecognized keys and paths.
```ignore
$ arti keys-raw remove-by-id [OPTIONS] --keystore-id <KEYSTORE_ID> <RAW_ENTRY_ID>
```
The command takes an optional flag and a positional argument: `-k <KEYSTORE_ID>` (`--keystore-id`), which
represents the identifier of the keystore the entry should be removed from; and `<RAW_ENTRY_ID>`, the
location of said entry.
If `-k` is omitted, the primary keystore ("arti") will be used.
To remove an entry from a `ArtiNativeKeystore` (currently the only supported keystore type for this
operation), the location must be in the form `<ARTI_PATH>.<ENTRY_TYPE>` where `<ARTI_PATH>` is the
`ArtiPath` of the key, and `<ENTRY_TYPE>` is the string representation of its `KeystoreItemType`.
The values that need to be provided can be obtained using the `arti keys list` command; it
appears as the "Location" field in the output.
```ignore
$ arti keys-raw remove-by-id -k arti hss/allium-cepa/ks_hs_id.ed25519_expanded_private
```
> `remove-by-id` doesn't support removing CTor keystore entries.
> `keys-raw remove-by-id` is currently very similar to `rm(1)` (note: the direct use of `rm`
> on keystores is allowed). In the future, however, support for non-on-disk keystores will
> be added, allowing the operator to interact with such keystores through the same interface.
|
