Solution ID : SO010419053049

Last Modified : 07/28/2020

Configure and test issuance of certificate using Yubico's YubiKey

Solution

 

 

 
Introduction

 

This how-to article explains how to configure a DigiCert PKI Platform certificate profile to enforce the use of Yubico's YubiKey to store/manage a certificate that can then be used for smart card logon.

Pre-requisites


Summary of Configuration Steps

  1. Install YubiKey Smart Card Mini Driver
  2. Create certificate profile in PKI Manager making use of the "Microsoft Base Smart Card CSP" as the security device
  3. Enrol for a certificate using a YubiKey
  4. Check issued certificate via PKI Client agent

Detailed Configuration Steps

Follow the below steps in order.

Install YubiKey Smart Card Mini Driver

  1. Use a Windows 7 or 10 physical workstation to download the YubiKey Smart Card Mini Driver from the below location:
    https://www.yubico.com/products/services-software/download/smart-card-drivers-tools/

    Note: to use the YubiKey through a VMWare Workstation virtual machine see section at the bottom of this article

  2. Unzip the .cab file, which will show the below content


  3. Install the driver.  On a Windows 10 workstation, you simply right-click on the ykmd.inf file and click Install
    Note: If you don't have Administrator rights, you will be prompted to enter them

    For Windows 7, you have to install the driver via Device Manager

  4. If the installation is successful, a pop-up window will appear:



  5. You can check the driver has been installed by inserting your YubiKey into a USB slot, launching Device Manager on your workstation and searching for Smart cards:



  6. Check visibility of the YubiKey token via the DigiCert PKI Client agent by launching PKI Client on your Windows workstation, and ensuring you see the Security Device icon:


Create Certificate Profile

  1. Access PKI Manager using a PKI Administrator with privileges to create/manage certificate profiles:
    https://pki-manager.symauth.com/pki-manager/

  2. Click on Manage certificate profiles icon

  3. Click on Add certificate profiles

  4. Select Test or Production mode

  5. Select the Smart Card Logon certificate template:



    Note: you can select any certificate template that supports PKI Client, e.g. Client Authentication, Secure Email, etc

  6. Click Continue

  7. Under Primary certificate options, enter a Friendly name for the certificate profile and select the following:

    1. Enrollment method: PKI Client
    2. Authentication method: Enrollment CodeManual approval or Active Directory
      In this example, the Enrollment Code method is being configured, the code is being included as part of the enrollment URL sent via email to the end-user, using the maximum expiration of 10 days:



    3. Certificate store: Security device, and select the "Microsoft Base Smart Card CSP" from the drop-down list:



  8. Configure all remaining certificate profile options as required, to meet your certificate use-case

  9. Click Save

  10. By default, the Email address will be configured as the Seat ID identifier (see the "Customize user identification" panel on the right-hand side):



    Alternatively, you can click on Edit and select the Other Name (UPN) field:



Enroll for a certificate using a YubiKey

The below steps explain how to manually create a user on PKI Manager and how to enroll such user against the certificate profile created above.
 

Note: if you are deploying a profile using other Authentication Methods (e.g. Manual approval and Active Directory), the enrollment steps vary.
 

  1. Access PKI Manager with a PKI Administrator with privileges to create/manage Users:
    https://pki-manager.symauth.com/pki-manager/

  2. Click on Manage users icon

  3. Click on Add users → single user → enter an email address



  4. Click Continue

  5. Enter the user's First and Last Name, and select the "I want to enroll this user for a certificate" checkbox:



  6. Select the certificate profile you created earlier from the drop-down list:



  7. Click Continue

  8. Enter the user's UPN, Email address and select the checkbox to send the enrollment code to the user via email:



  9. Click Continue

  10. If successful, a screen will show the system-generated Enrollment Code generated for this request:



  11. Click Done, where you will be redirected to a page where you can manage the user's Enrollment Code and Email:



  12. Check your email Inbox for an email from "Enterprise PKI Team":



  13. Click on the enrollment link within the email. The below screenshots make use of the Chrome browser, where your identify will be automatically confirmed since the enrollment code is included within the URL:



    Note: if PKI Client is not installed on the workstation, you will be prompted to download/install it.

  14. Insert a supported YubiKey into a USB slot, and optionally, modify the certificate 'nickname'

  15.  Click Continue and wait until the web page completes its background processing:



  16. Click on the Install certificate button, and the below screen will be shown:



  17. A pop-up window will appear requesting the PIN for the YubiKey token (default PIN is 123456):



  18. Click OK

  19. If successful, the below screen will be shown:



Check Certificate via PKI Client Agent

Perform the below steps on the Windows workstation you enrolled for the certificate using a YubiKey.

  1. Launch PKI Client:



  2. Click on the Security Device icon to view all certificates installed on the YubiKey:



  3. Click on View certificate details to view the contents of the certificate:



  4. Your workstation is now ready to consume the DigiCert certificate installed on the YubiKey token, e.g. use it for Windows smart card logon, remote access via VPN, signing/encrypting an email, etc.

Getting YubiKey working with VMWare Workstation

You can follow the below Yubico knowledge base article on how to configure/troubleshoot VMWare Worstation guest virtual machine to passthrough the details of a connected YubiKey on a host device to your guest VM:

Troubleshooting VMWare Workstation Device Passthrough https://support.yubico.com/support/solutions/articles/15000008891-troubleshooting-vmware-workstation-device-passthrough

In a nutshell, you need to edit your VMWare VMX file and add the following two lines:

  • usb.generic.allowHID = "TRUE"
  • usb.generic.allowLastHID = "TRUE"
  • usb.generic.allowCCID = "TRUE"

Here’s an example vmx file with above lines added:


Once the above lines have been added and the file saved, you can select the Yubico.com removable device from VM → Removable Devices → Connect

 

You select the actual Yubico.com device, and not the Shared device. If you select the shared device to passthrough it will not work.

 

 

Additional Information

Known Limitations

MacOS hasn't been qualified for YubiKey.