aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authordrduh <github@duh.to>2023-08-13 13:11:05 -0700
committerGitHub <noreply@github.com>2023-08-13 13:11:05 -0700
commite89e855bb4c42f92b503dc437682d2bca656510f (patch)
tree3065640eaa865291ef501f9410053eac658ef9f2 /README.md
parentMerge pull request #380 from smoores-dev/adduid (diff)
parentUpdate ykman set-touch instructions (diff)
downloadYubiKey-Guide-e89e855bb4c42f92b503dc437682d2bca656510f.tar.gz
Merge pull request #383 from o-kotb/master
Update ykman set-touch instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 18 insertions, 17 deletions
diff --git a/README.md b/README.md
index ef8b549..ea22a7e 100644
--- a/README.md
+++ b/README.md
@@ -2800,37 +2800,38 @@ $ ykman openpgp keys set-touch sig on
Encryption:
```console
-$ ykman openpgp keys set-touch enc on
+$ ykman openpgp keys set-touch dec on
```
+**Note** Versions of YubiKey Manager before 5.1.0 use `enc` instead of `dec` for encryption.
+
Depending on how the YubiKey is going to be used, you may want to look at the policy options for each of these and adjust the above commands accordingly. They can be viewed with the following command:
```
$ ykman openpgp keys set-touch -h
Usage: ykman openpgp keys set-touch [OPTIONS] KEY POLICY
- Set touch policy for OpenPGP keys.
-
- KEY Key slot to set (sig, enc, aut or att).
- POLICY Touch policy to set (on, off, fixed, cached or cached-fixed).
+ Set the touch policy for OpenPGP keys.
- The touch policy is used to require user interaction for all operations using the private key on the YubiKey. The touch policy is set individually for each key slot. To see the current touch policy, run
-
- $ ykman openpgp info
+ The touch policy is used to require user interaction for all operations using the private key on the YubiKey. The touch policy is set
+ individually for each key slot. To see the current touch policy, run the "openpgp info" subcommand.
Touch policies:
- Off (default) No touch required
- On Touch required
- Fixed Touch required, can't be disabled without a full reset
- Cached Touch required, cached for 15s after use
- Cached-Fixed Touch required, cached for 15s after use, can't be disabled
- without a full reset
+ Off (default) no touch required
+ On touch required
+ Fixed touch required, can't be disabled without deleting the private key
+ Cached touch required, cached for 15s after use
+ Cached-Fixed touch required, cached for 15s after use, can't be disabled
+ without deleting the private key
+
+ KEY key slot to set (sig, dec, aut or att)
+ POLICY touch policy to set (on, off, fixed, cached or cached-fixed)
Options:
- -a, --admin-pin TEXT Admin PIN for OpenPGP.
- -f, --force Confirm the action without prompting.
- -h, --help Show this message and exit.
+ -a, --admin-pin TEXT Admin PIN for OpenPGP
+ -f, --force confirm the action without prompting
+ -h, --help show this message and exit
```
If the YubiKey is going to be used within an email client that opens and verifies encrypted mail, `Cached` or `Cached-Fixed` may be desirable.