Skip to content

Commit 2f8324c

Browse files
defguard-communitygitbook-bot
authored andcommitted
GITBOOK-388: change request with no subject merged in GitBook
1 parent 7d2fafd commit 2f8324c

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

admin-and-features/features-and-configuration/yubikey-provisioning.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,20 @@ description: 'Provisioner repository: https://github.com/DefGuard/YubiKey-Provis
44

55
# YubiKey Provisioning
66

7-
{% hint style="danger" %}
8-
We only support (and tested) Yubikey 5.
7+
### Compatibility
98

10-
Yubikey 4 should work - we have not tested.
9+
Some Yubikey's will not be compatible with this feature.
1110

12-
Other Yubikeys - especially NEO (which has slots for RSA GPG/PGP keys) will not work, as YK NEO has only 2048 key length slot, which is commonly treated as unsecure for RSA key length.
11+
{% hint style="danger" %}
12+
This feature was tested only on Yubikey series 5, we don't support older series ( some still might work).
1313
{% endhint %}
1414

15+
Conditions below needs to be met:
16+
17+
* Yubikey needs to return serial number via `ykman list` 
18+
* Yubikey needs to have available and active OpenPGP application. You can check out your series capabilities on yubico website [here](https://support.yubico.com/hc/en-us/articles/360013790259-Using-Your-YubiKey-with-OpenPGP).
19+
* Yubikey needs to support RSA 4096, older series can have problem with this especially with older firmware versions.
20+
1521
## Overview
1622

1723
Our provisioning service (installed on a computer that has USB access and securely communicating with defguard) allows you to easily create and populate the **SSH and GPG/OpenPGP** keys on a YubiKey hardware key, and share its public information inside defguard - which can be [used for example to authenticate to servers using defguard](ssh-authentication.md).
@@ -30,6 +36,10 @@ That also means that the **master key** is deleted and only sub-keys are stored
3036
As we do not want to store any private keys for security reasons, we have some ideas and plans for **optional master-key** storage based on **HSM encryption**, but we want to see if any actual companies/users need that, as there is always a way just to overwrite the existing YK and provision with new data.
3137
{% endhint %}
3238

39+
### Prerequisites
40+
41+
If you want to use solutions other then docker, the provisioning station needs to have both gpg2 and [ykman](https://docs.yubico.com/software/yubikey/tools/ykman/Install_ykman.html) programs on the provisioning machine.
42+
3343
## Installation of provisioning service
3444

3545
{% hint style="info" %}

0 commit comments

Comments
 (0)