blob: e12d6fd1b63eaca59dae56d57d269d7953dab0b0 (
plain)
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
# `arti keys`
`arti keys` is a command line utility for managing keystores and their content. In the
future, we will extend `arti keys` with additional functionality, for example multiple formatting
options for the output.
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` interacts with are relative to the
state directory, which you might have overridden in the configuration.
> `arti keys` is an experimental subcommand.
> To use it, you will need to compile `arti` with the experimental `onion-service-cli-extra` feature.
## Listing keystores
`arti keys list-keystores` allows the user to list all the available keystores in the state
directory (i.e.: `~/.local/share/arti` on Linux platforms)
```
$ arti -c keys.toml keys list-keystores
Keystores:
- "arti"
```
## Listing the content of keystores
The command `arti keys list` is used for listing the content of keystores.
By default the command displays the content of all the keystores. If the
flag `-k` (`--keystore-id`) is provided, only the content of the specified
keystore will be displayed.
This command provides a way of listing both recognized and unrecognized entries.
- Recognized: keys that present a valid path.
- Unrecognized: keys that are in a valid location but do not present a
valid filename.
- Unrecognized paths: filesystem objects that should not be in the state directory.
Some of the information displayed by `keys list` can be used as input for other
commands. For instance: "Location", is the raw identifier of the entry; and
"Keystore ID", the identifier, of the keystore. These can be used together
with `arti keys-raw remove-by-id`.
Example usage:
<details>
<summary>With `-k`:</summary>
```ignore
$ arti -c keys.toml keys list -k arti
===== Keystore entries =====
Keystore ID: arti
Role: ks_hsc_desc_enc
Summary: Descriptor decryption key
KeystoreItemType: X25519StaticKeypair
Location: client/mnyizjj7m3hpcr7i5afph3zt7maa65johyu2ruis6z7cmnjmaj3h6tad/ks_hsc_desc_enc.x25519_private
Extra info:
- hs_id: mnyizjj7m3hpcr7i5afph3zt7maa65johyu2ruis6z7cmnjmaj3h6tad.onion
--------------------------------------------------------------------------------
Keystore ID: arti
Unrecognized path: herba-spontanea/ks_hs_id.ed25519_expanded_private
--------------------------------------------------------------------------------
Keystore ID: arti
Role: ks_hs_id
Summary: Long-term identity keypair
KeystoreItemType: Ed25519ExpandedKeypair
Location: hss/allium-cepa/ks_hs_id.ed25519_expanded_private
Extra info:
- nickname: allium-cepa
--------------------------------------------------------------------------------
Unrecognized entry
Keystore ID: arti
Location: hss/allium-cepa/Ks_hs_id.ed25519_expanded_private
Error: Key has invalid path: hss/allium-cepa/Ks_hs_id.ed25519_expanded_private
--------------------------------------------------------------------------------
```
</details>
<details>
<summary>Default behavior</summary>
```ignore
$ arti -c keys.toml keys list
===== Keystore entries =====
Keystore ID: arti
Role: ks_hsc_desc_enc
Summary: Descriptor decryption key
KeystoreItemType: X25519StaticKeypair
Location: client/mnyizjj7m3hpcr7i5afph3zt7maa65johyu2ruis6z7cmnjmaj3h6tad/ks_hsc_desc_enc.x25519_private
Extra info:
- hs_id: mnyizjj7m3hpcr7i5afph3zt7maa65johyu2ruis6z7cmnjmaj3h6tad.onion
--------------------------------------------------------------------------------
Keystore ID: arti
Unrecognized path: herba-spontanea/ks_hs_id.ed25519_expanded_private
--------------------------------------------------------------------------------
Keystore ID: arti
Role: ks_hs_id
Summary: Long-term identity keypair
KeystoreItemType: Ed25519ExpandedKeypair
Location: hss/allium-cepa/ks_hs_id.ed25519_expanded_private
Extra info:
- nickname: allium-cepa
--------------------------------------------------------------------------------
Unrecognized entry
Keystore ID: arti
Location: hss/allium-cepa/Ks_hs_id.ed25519_expanded_private
Error: Key has invalid path: hss/allium-cepa/Ks_hs_id.ed25519_expanded_private
--------------------------------------------------------------------------------
CTor service key
Hidden service nickname: allium-cepa
Keystore ID: ctor
KeystoreItemType: Ed25519ExpandedKeypair
Location: hs_ed25519_secret_key
--------------------------------------------------------------------------------
Unrecognized entry
Keystore ID: ctor
Location: hostname
Error: Key hostname is malformed
--------------------------------------------------------------------------------
CTor service key
Hidden service nickname: allium-cepa
Keystore ID: ctor
KeystoreItemType: Ed25519PublicKey
Location: hs_ed25519_public_key
--------------------------------------------------------------------------------
```
</details>
> The `hostname` file of a CTor keystore is represented as an unrecognized entry.
|
