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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
|
[![Logo](assets/logo.jpg)](https://github.com/orhun/gpg-tui)
[![GitHub Release](https://img.shields.io/github/v/release/orhun/gpg-tui?style=flat&labelColor=1d1d1d&color=424242&logo=GitHub&logoColor=white)](https://github.com/orhun/gpg-tui/releases)
[![Crate Release](https://img.shields.io/crates/v/gpg-tui?style=flat&labelColor=1d1d1d&color=424242&logo=Rust&logoColor=white)](https://crates.io/crates/gpg-tui/)
[![Coverage](https://img.shields.io/codecov/c/gh/orhun/gpg-tui?style=flat&labelColor=1d1d1d&color=424242&logo=Codecov&logoColor=white)](https://codecov.io/gh/orhun/gpg-tui)
[![Continuous Integration](https://img.shields.io/github/workflow/status/orhun/gpg-tui/Continuous%20Integration/master?style=flat&labelColor=1d1d1d&color=424242&logo=GitHub%20Actions&logoColor=white)](https://github.com/orhun/gpg-tui/actions?query=workflow%3A%22Continuous+Integration%22)
[![Continuous Deployment](https://img.shields.io/github/workflow/status/orhun/gpg-tui/Continuous%20Deployment?style=flat&labelColor=1d1d1d&color=424242&logo=GitHub%20Actions&logoColor=white&label=deploy)](https://github.com/orhun/gpg-tui/actions?query=workflow%3A%22Continuous+Deployment%22)
[![Docker Builds](https://img.shields.io/docker/cloud/build/orhunp/gpg-tui?style=flat&labelColor=1d1d1d&color=424242&label=docker&logo=Docker&logoColor=white)](https://hub.docker.com/r/orhunp/gpg-tui)
[![Documentation](https://img.shields.io/docsrs/gpg-tui?style=flat&labelColor=1d1d1d&color=424242&logo=Rust&logoColor=white)](https://docs.rs/gpg-tui/)
## About
**gpg-tui** is a [Terminal User Interface](https://en.wikipedia.org/wiki/Text-based_user_interface) for [GnuPG](https://gnupg.org/).
It aims to ease the key management operations such as listing/exporting/signing by providing an interface along with the command-line fallback for more complex operations. It is not trying to be a full-fledged interface for _all_ the features that [gpg](https://linux.die.net/man/1/gpg) provides but it tries to bring a more interactive approach to key management.
<details>
<summary><b>Demo</b></summary>
![](demo/gpg-tui-showcase.gif)
<pre>
<b>gpg-tui</b> --style <span style="color: #036A9BFF"><i>colored</i></span> --splash --homedir <span style="color: #036A9BFF"><i>/etc/pacman.d/gnupg</i></span>
</pre>
</details>
<details>
<summary>Table of Contents</summary>
- [About](#about)
- [Requirements](#requirements)
- [Installation](#installation)
- [Cargo](#cargo)
- [Arch Linux](#arch-linux)
- [Docker](#docker)
- [Docker Hub](#docker-hub)
- [Using the Dockerfile](#using-the-dockerfile)
- [Manually](#manually)
- [Building from source](#building-from-source)
- [Binary releases](#binary-releases)
- [Usage](#usage)
- [Key Bindings](#key-bindings)
- [User Interface](#user-interface)
- [Key Management](#key-management)
- [Approach](#approach)
- [Detail Levels](#detail-levels)
- [Key Information](#key-information)
- [User Information](#user-information)
- [Features](#features)
- [User Interface](#user-interface-1)
- [Scrolling](#scrolling)
- [Options Menu](#options-menu)
- [Copy / Paste](#copy--paste)
- [Detailed View](#detailed-view)
- [Search](#search)
- [Running commands](#running-commands)
- [Key Management](#key-management-1)
- [List](#list)
- [Export](#export)
- [Sign](#sign)
- [Edit](#edit)
- [Import/Receive](#importreceive)
- [Send](#send)
- [Generate](#generate)
- [Delete](#delete)
- [Refresh](#refresh)
- [Styling](#styling)
- [Colors](#colors)
- [Splash screen](#splash-screen)
- [Roadmap](#roadmap)
- [Platforms](#platforms)
- [Packaging](#packaging)
- [Command-Line Fallback](#command-line-fallback)
- [Key Management Only](#key-management-only)
- [Resources](#resources)
- [About the project](#about-the-project)
- [External Links](#external-links)
- [Social Media](#social-media)
- [Funding](#funding)
- [License](#license)
- [Copyright](#copyright)
</details>
## Requirements
- Rust: `>=1.46.0`
- Core dependencies: `gnupg`, `gpgme>=1.7.0`, `libgpg-error`
- Other dependencies: `libxcb`
## Installation
### Cargo
**gpg-tui** is available on [crates.io](https://crates.io/crates/gpg-tui/):
```sh
cargo install gpg-tui
```
### Arch Linux
**gpg-tui** can be installed using available [AUR packages](https://aur.archlinux.org/packages/?O=0&SeB=b&K=gpg-tui&outdated=&SB=n&SO=a&PP=50&do_Search=Go) with an [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers):
```sh
paru gpg-tui
```
Or if you prefer, you can clone the [AUR packages](https://aur.archlinux.org/packages/?O=0&SeB=b&K=gpg-tui&outdated=&SB=n&SO=a&PP=50&do_Search=Go) and compile them with [makepkg](https://wiki.archlinux.org/index.php/Makepkg):
```sh
# clone the AUR repository
git clone https://aur.archlinux.org/gpg-tui.git && cd gpg-tui/
# build the package
makepkg -si
```
### Docker
#### Docker Hub
See available [tags](https://hub.docker.com/r/orhunp/gpg-tui/tags).
```sh
docker pull orhunp/gpg-tui:[tag]
```
#### Using the Dockerfile
```sh
# clone the repository
git clone https://github.com/orhun/gpg-tui.git && cd gpg-tui/
# build the image
docker build -t gpg-tui .
# run the container
docker run -it gpg-tui
```
### Manually
#### Building from source
```sh
# clone the repository
git clone https://github.com/orhun/gpg-tui.git && cd gpg-tui/
# build and install
cargo install --root "$HOME/.cargo" --path .
```
#### Binary releases
See available [releases](https://github.com/orhun/gpg-tui/releases) that are automated by [Continuous Deployment](.github/workflows/cd.yml) workflow.
## Usage
```
gpg-tui [FLAGS] [OPTIONS]
```
```
FLAGS:
-a, --armor Enables ASCII armored output
--splash Shows the splash screen on startup
-h, --help Prints help information
-V, --version Prints version information
```
```
OPTIONS:
--homedir <dir> Sets the GnuPG home directory [env: HOMEDIR=]
-o, --outdir <dir> Sets the output directory [env: OUTDIR=]
-d, --default-key <key> Sets the default key to sign with [env: DEFAULT_KEY=]
-t, --tick-rate <ms> Sets the tick rate of the terminal [env: TICK_RATE=] [default: 250]
-c, --color <color> Sets the accent color of the terminal [env: COLOR=] [default: gray]
-s, --style <style> Sets the style of the terminal [env: STYLE=] [default: plain]
[possible values: plain, colored]
```
## Key Bindings
### User Interface
| Key Binding | Action |
| -------------------- | ---------------------------- |
| `?` | show help |
| `o,space,enter` | show options |
| `hjkl,arrows,pgkeys` | navigate |
| `n` | switch to normal mode |
| `v` | switch to visual mode |
| `c` | switch to copy mode |
| `p,C-v` | paste from clipboard |
| `a` | toggle armored output |
| `1,2,3` | set detail level |
| `t,tab` | toggle detail (all/selected) |
| `` ` `` | toggle table margin |
| `m` | toggle table size |
| `C-s` | toggle style |
| `/` | search |
| `:` | run command |
| `r,f5` | refresh application |
| `q,C-c/d,escape` | quit application |
### Key Management
| Key Binding | Action |
| ------------- | ------------- |
| `x` | export key |
| `s` | sign key |
| `e` | edit key |
| `i` | import key(s) |
| `f` | receive key |
| `u` | send key |
| `g` | generate key |
| `d,backspace` | delete key |
| `C-r` | refresh keys |
## Approach
Available keys in the keyring (which can be specified via `--homedir` argument) are showed on a table. This table consists of 2 columns which are [key information](#key-information) and [user information](#user-information).
The level of detail that an individual table row shows is determined by [detail levels](#detail-levels).
### Detail Levels
1. **Minimum**: shows only the primary key and user ID.
```
[sc--] rsa3072/B14085A20355B74DE0CE0FA1E19F76D037BD65B6 │ [u] Example Key <example@key>
```
2. **Standard**: shows all the subkeys and user IDs.
```
[sc--] rsa3072/B14085A20355B74DE0CE0FA1E19F76D037BD65B6 │ [u] Example Key <example@key>
| └─(2021-05-14) │ └─[u] Other User ID <example@key>
[--e-] rsa3072/E56CAC142AE5A979BEECB00FB4F68595CAD4E7E5 │
└─(2021-05-14)
```
3. **Full**: shows signatures.
```
[sc--] rsa3072/B14085A20355B74DE0CE0FA1E19F76D037BD65B6 │ [u] Example Key <example@key>
| └─(2021-05-14) │ │ └─[13] selfsig (2021-05-16)
[--e-] rsa3072/E56CAC142AE5A979BEECB00FB4F68595CAD4E7E5 │ └─[u] Other User ID <example@key>
└─(2021-05-14) ├─[13] selfsig (2021-05-16)
└─[10] 84C39331F6F85326 Other Signer Key <example@signer> (2021-05-16)
```
### Key Information
An example table entry for the detail level `full` (which includes subkeys) is explained via reference numbers below.
<pre>
[sc--]<b>⁰</b> rsa3072<b>¹</b>/B14085A20355B74DE0CE0FA1E19F76D037BD65B6<b>²</b>
|<b>³</b> └─(2021-05-14)<b>⁴</b>
[--e-]<b>⁰</b> rsa3072<b>¹</b>/E56CAC142AE5A979BEECB00FB4F68595CAD4E7E5<b>²</b>
└─(2021-05-14) -> (2021-05-16)<b>⁴</b> [exp]<b>⁵</b>
</pre>
**0**: Key flags. Determines what this key can do.
* `s`: sign
* `c`: certify
* `e`: encrypt
* `a`: authenticate
**1**: Algorithm of the key.
**2**: Fingerprint of the key.
**3**: Indicates that the next key is a subkey.
**4**: Time information of the key:
* creation time (`Y-m-d`)
* expiration time (`Y-m-d`)
**5**: Is the key one of the following?
* `[exp]`: expired
* `[rev]`: revoked
* `[d]`: disabled
* `[i]`: invalid
* `[q]`: qualified
### User Information
An example table entry for the detail level `full` (which includes other user IDs and signatures) is explained via reference numbers below.
<pre>
[u]<b>⁰</b> Test Key <test@test><b>¹</b>
│<b>²</b> └─[13]<b>³</b> selfsig<b>⁴</b> (2021-05-16)<b>⁶</b>
└─[u]<b>⁰</b> Test Key2 <test2@test2><b>¹</b>
├─[13]<b>³</b> selfsig<b>⁴</b> (2021-05-16)<b>⁶</b>
└─[10]<b>³</b> 84C39331F6F85326 Test Key 2 <test2@example.com><b>⁵</b> (2021-05-16)<b>⁶</b> [!x]<b>⁷</b>
</pre>
**0**: Validity of the user.
* `q`: undefined
* `n`: never
* `m`: marginal
* `f`: full
* `u`: ultimate
* `?`: unknown
**1**: User ID. (`name` + `email`)
**2**: Indicates the next user ID.
**3**: Certification level of the signature.
* `10`: no indication
* `11`: personal belief but no verification
* `12`: casual verification
* `13`: extensive verification
**4**: Indicates that this is a self signature, whereby the users' own private key was used to sign their public key.
**5**: Key and user ID of the signer. (`key` + `name` + `email`)
**6**: Time information of the signature.
* creation time (`Y-m-d`)
* expiration time (`Y-m-d`)
**7**: Is the signature one of the following?
* `[exp]`: expired
* `[rev]`: revoked
* `[i]`: invalid
* `[!x]`: non-exportable
## Features
Press `?` while running the terminal interface to see information about key bindings and GnuPG configuration.
![](demo/gpg-tui-help_menu.gif)
### User Interface
#### Scrolling
Use arrow or `hjkl` keys to scroll and navigate through lists/menus/tabs. Additionally, you can use `Ctrl-Up/Down` combinations or `PageUp`/`PageDown` keys to scroll to the top/bottom.
![](demo/gpg-tui-scrolling.gif)
If rows are not fitting on the terminal interface, use `Alt` + arrow/`hjkl` keys to individually scroll them.
![](demo/gpg-tui-scrolling_rows.gif)
![](demo/gpg-tui-scrolling_rows2.gif)
#### Options Menu
Most of the actions can be performed using the options menu. Simply press `Enter` and select what you want to do.
![](demo/gpg-tui-options_menu.gif)
#### Copy / Paste
There's a `copy` mode for making it easier to copy particular values to the clipboard. To use this mode, press `c` followed by one of the key bindings:
* `x`: Copy the exported key
* `i`: Copy the key id
* `f`: Copy the key fingerprint
* `u`: Copy the user id
* `1,2`: Copy the content of the row
Then the value will be copied to the clipboard and the application mode will be reverted to `normal`.
Press `ESC` or `n` to cancel and switch to `normal` mode during this operation.
![](demo/gpg-tui-copy_mode.gif)
Instead of copying values with `copy` mode, you can use the `visual` mode which disables the mouse capture. It means that you can select/highlight the text on the interface and copy as you do normally.
`visual` mode can be used for other purposes such as scrolling via mouse.
![](demo/gpg-tui-visual_mode.gif)
#### Detailed View
Press `Tab` to toggle the [detail level](#detail-levels) for the selected entry in the list. Number keys (e.g. `1`, `2`, `3`) can be also used to set a specific level.
![](demo/gpg-tui-detailed_view.gif)
Press `t` to toggle the detail level for all entries in the list.
![](demo/gpg-tui-detailed_view2.gif)
There are couple a of different modes for the size of the tables which changes the details that each entry shows. You can use the `m` key for switching to different modes.
![](demo/gpg-tui-detailed_view3.gif)
#### Search
Press `/` to search for a value from the currently shown table.
![](demo/gpg-tui-search.gif)
#### Running commands
Every operation on the terminal interface is handled implicitly by the application-specific commands. So it's possible to do certain things by switching to command mode with pressing `:` and running commands. (similar to Vim)
For example,
* `:list pub` -> list public keys
* `:set armor true` -> enable armored output
A full list of commands can be found [here.](COMMANDS.md)
![](demo/gpg-tui-running_commands.gif)
Also you can switch between command mode and search by pressing `Tab`.
![](demo/gpg-tui-switch_search.gif)
### Key Management
#### List
Available keys in the keyring are listed on a table as default. They can be [scrolled](#scrolling) or the listing type (public/secret keys) can be changed by changing the tab via arrow keys.
See the [approach](#approach) section for more information about the meaning of the table rows.
![](demo/gpg-tui-list_keys.gif)
#### Export
Press `x` to export the selected key to a file. The default output directory is `$GNUPGHOME/out` and can be changed by either using `--homedir` or `--outdir` argument.
Additionally, you can enable/disable armored output by pressing `a`.
![](demo/gpg-tui-export_key.gif)
#### Sign
Press `s` to sign the selected key with the default secret key. This key can be specified with `--default-key` argument.
This feature uses `gpg` fallback and runs `gpg --sign-key` command.
![](demo/gpg-tui-sign_key.gif)
#### Edit
Press `e` to edit the selected key.
This feature uses `gpg` fallback and runs `gpg --edit-key` command. It presents a menu that provides a list of options to change the key details. See the [edit-key](https://www.gnupg.org/gph/en/manual/r899.html) documentation for more information.
![](demo/gpg-tui-edit_key.gif)
#### Import/Receive
Import operation is done by using the `:import` command. So press `i` to switch to command mode (which will automatically add the import command) and then give it your file(s) to import.
![](demo/gpg-tui-import_key.gif)
Similar to import, receive operation is also done by using a command which is `:receive`. So press `f` (for **f**etching keys from a keyserver) and give it your key ID(s).
This feature uses `gpg` fallback and runs `gpg --receive-keys` command.
![](demo/gpg-tui-receive_key.gif)
#### Send
Press `u` (for **u**ploading to the keyserver) followed by `y` (for confirmation) to send the selected key to the default keyserver.
![](demo/gpg-tui-send_key.gif)
#### Generate
Press `g` to generate a new key pair.
This feature uses `gpg` fallback and runs `gpg --full-generate-key` command. It presents dialogs for all of the generation options.
![](demo/gpg-tui-generate_key.gif)
#### Delete
Press `Backspace` followed by `y` (for confirmation) to delete the selected key from the keyring.
![](demo/gpg-tui-delete_key.gif)
#### Refresh
Press `Ctrl-y` for refreshing the keyring.
This feature uses `gpg` fallback and runs `gpg --refresh-keys` command.
![](demo/gpg-tui-refresh_keys.gif)
### Styling
You can customize the look of **gpg-tui** to get rid of its _boring_ and _minimalistic_ vibe. (!)
#### Colors
To enable colors, you can specify a style with `--style` argument or press `Ctrl-S` while running for toggling the style. Currently, only one style is supported which is `colored`.
```sh
gpg-tui --style colored
```
![](demo/gpg-tui-colored_style.gif)
If the default _accent_ color of the interface causes problems with your theme or if you just want to change it to something more vivid, you can use `--color` argument to specify another color in HEX format.
```sh
gpg-tui --style colored --color 507030
```
![](demo/gpg-tui-custom_colors.gif)
#### Splash screen
There is a splash screen that shows the project's logo for a couple of seconds if `--splash` flag is present. It's purely cosmetical.
```sh
gpg-tui --splash
```
![](demo/gpg-tui-splash_screen.gif)
To enable colors for the splash screen, use the `colored` style.
```sh
gpg-tui --splash --style colored
```
![](demo/gpg-tui-splash_screen_colored.gif)
## Roadmap
### Platforms
**gpg-tui** is tested on Linux systems during the development phase. It should be tested on other platforms such as Microsoft Windows and macOS and found issues should be reported for future compatibility with these platforms.
### Packaging
[![Packaging status](https://img.shields.io/repology/repositories/gpg-tui?label=in%20repositories&style=flat&labelColor=424242&color=1d1d1d&logoColor=white)](https://repology.org/project/gpg-tui/versions)
**gpg-tui** should be more and easily accessible for other platforms/distributions. Thus, it should be packaged for package managers such as [Homebrew](https://brew.sh/) and [APT](https://en.wikipedia.org/wiki/APT_(software)). If you're a packager and want to contribute, feel free to [submit an issue](https://github.com/orhun/gpg-tui/issues/new/choose) or [start a discussion](https://github.com/orhun/gpg-tui/discussions/new)!
### Command-Line Fallback
Some of the features of **gpg-tui** require the execution of the CLI program `gpg` in order to operate. This is due to the fact that design
|