go-piv: A Go implementation of the PIV standards for smart card certificate management

YubiKeys provide an applet implementing the PIV standards for managing certificates on a smart card. This applet is a simpler alternative to GPG for managing asymmetric keys on a YubiKey.

This package is an alternative to Paul Tagliamonte's go-ykpiv, a wrapper for YubiKey's ykpiv.h C library. This package aims to provide:

• Better error messages
• Idiomatic Go APIs
• Modern features such as PIN protected management keys

This package is a fork from github.com/go-piv/piv-go with the following changes:

• Replacement of in-repo PCSC bindings with github.com/ebfe/scard.
• Improved CI tests, linting and repository structure.
• Made repository REUSE compliant.
• Removal of Google's CLA.

Examples

• Signing
• PINs
• Certificates
• Attestation

Signing

The piv-go package can be used to generate keys and store certificates on a YubiKey. This uses a management key to generate new keys on the applet, and a PIN for signing operations. The package provides default PIN values. If the PIV credentials on the YubiKey haven't been modified, the follow code generates a new EC key on the smart card, and provides a signing interface:

// List all smart cards connected to the system.
cards, err := piv.Cards()
if err != nil {
    // ...
}

// Find a YubiKey and open the reader.
var c *piv.Card
for _, card := range cards {
    if strings.Contains(strings.ToLower(card), "yubikey") {
        if c, err = piv.Open(card); err != nil {
            // ...
        }
        break
    }
}

if c == nil {
    // ...
}

// Generate a private key on the YubiKey.
key := piv.Key{
    Algorithm:   piv.AlgorithmEC256,
    PINPolicy:   piv.PINPolicyAlways,
    TouchPolicy: piv.TouchPolicyAlways,
}

pub, err := c.GenerateKey(piv.DefaultManagementKey, piv.SlotAuthentication, key)
if err != nil {
    // ...
}

auth := piv.KeyAuth{PIN: piv.DefaultPIN}
priv, err := c.PrivateKey(piv.SlotAuthentication, pub, auth)
if err != nil {
    // ...
}
// Use private key to sign or decrypt.

PINs

The PIV applet has three unique credentials:

• Management key (3DES key) used to generate new keys on the YubiKey.
• PIN (up to 8 digits, usually 6) used to access signing operations.
• PUK (up to 8 digits) used to unblock the PIN. Usually set once and thrown away or managed by an administrator.

piv-go implements PIN protected management keys to store the management key on the YubiKey. This allows users to only provide a PIN and still access management capabilities.

The following code generates new, random credentials for a YubiKey:

newPINInt, err := rand.Int(rand.Reader, big.NewInt(1_000_000))
if err != nil {
    // ...
}

newPUKInt, err := rand.Int(rand.Reader, big.NewInt(100_000_000))
if err != nil {
    // ...
}

var newKey ManagementKey
if _, err := io.ReadFull(rand.Reader, newKey[:]); err != nil {
    // ...
}

// Format with leading zeros.
newPIN := fmt.Sprintf("%06d", newPINInt)
newPUK := fmt.Sprintf("%08d", newPUKInt)

// Set all values to a new value.
if err := c.SetManagementKey(piv.DefaultManagementKey, newKey); err != nil {
    // ...
}

if err := c.SetPUK(piv.DefaultPUK, newPUK); err != nil {
    // ...
}

if err := c.SetPIN(piv.DefaultPIN, newPIN); err != nil {
    // ...
}

// Store management key on the YubiKey.
m := piv.Metadata{ManagementKey: &newKey}
if err := c.SetMetadata(newKey, m); err != nil {
    // ...
}

fmt.Println("Credentials set. Your PIN is: %s", newPIN)

The user can use the PIN later to fetch the management key:

m, err := c.Metadata(pin)
if err != nil {
    // ...
}

if m.ManagementKey == nil {
    // ...
}

key := *m.ManagementKey

Certificates

The PIV applet can also store X.509 certificates on the YubiKey:

cert, err := x509.ParseCertificate(certDER)
if err != nil {
    // ...
}

if err := c.SetCertificate(managementKey, piv.SlotAuthentication, cert); err != nil {
    // ...
}

The certificate can later be used in combination with the private key. For example, to serve TLS traffic:

cert, err := c.Certificate(piv.SlotAuthentication)
if err != nil {
    // ...
}

priv, err := c.PrivateKey(piv.SlotAuthentication, cert.PublicKey, auth)
if err != nil {
    // ...
}

s := &http.Server{
    TLSConfig: &tls.Config{
        Certificates: []tls.Certificate{
            {
                Certificate: [][]byte{cert.Raw},
                PrivateKey:  priv,
            },
        },
    },
    Handler: myHandler,
}

Attestation

YubiKeys can attest that a particular key was generated on the smart card, and that it was set with specific PIN and touch policies. The client generates a key, then asks the YubiKey to sign an attestation certificate:

// Get the YubiKey's attestation certificate, which is signed by Yubico.
yubiKeyAttestationCert, err := c.AttestationCertificate()
if err != nil {
    // ...
}

// Generate a key on the YubiKey and generate an attestation certificate for
// that key. This will be signed by the YubiKey's attestation certificate.
key := piv.Key{
    Algorithm:   piv.AlgorithmEC256,
    PINPolicy:   piv.PINPolicyAlways,
    TouchPolicy: piv.TouchPolicyAlways,
}
if _, err := c.GenerateKey(managementKey, piv.SlotAuthentication, key); err != nil {
    // ...
}
slotAttestationCertificate, err := c.Attest(piv.SlotAuthentication)
if err != nil {
    // ...
}

// Send certificates to server.

A CA can then verify the attestation, proving a key was generated on the card and enforce policy:

// Server receives both certificates, then proves a key was generated on the
// YubiKey.
a, err := piv.Verify(yubiKeyAttestationCert, slotAttestationCertificate)
if err != nil {
    // ...
}
if a.TouchPolicy != piv.TouchPolicyAlways {
    // ...
}

// Record YubiKey's serial number and public key.
pub := slotAttestationCertificate.PublicKey
serial := a.Serial

Installation

On MacOS, piv-go doesn't require any additional packages.

To build on Linux, piv-go requires PCSC lite. To install on Debian-based distributions, run:

Debian, Ubuntu

sudo apt-get install libpcsclite-dev

RHEL, Fedora, Rocky Linux

sudo yum install pcsc-lite-devel

FreeBSD

sudo pkg install pcsc-lite

Windows

No prerequisites are needed. The default driver by Microsoft supports all functionalities which get tested by unit tests. However if you run into problems try the official YubiKey Smart Card Minidriver. Yubico states on their website the driver adds additional smart functionality.

Please notice the following:

Windows support is best effort due to lack of test hardware. This means the maintainers will take patches for Windows, but if you encounter a bug or the build is broken, you may be asked to fix it.

Non-YubiKey smart cards

Non-YubiKey smart cards that implement the PIV standard are not officially supported due to a lack of test hardware. However, PRs that fix integrations with other smart cards are welcome, and piv-go will attempt to not break that support.

Testing

Tests automatically find connected available YubiKeys, but won't modify the smart card without the TEST_DANGEROUS_WIPE_REAL_CARD=1 environment variable is set. To let the tests modify your YubiKey's PIV applet, run:

TEST_DANGEROUS_WIPE_REAL_CARD=1 go test -v ./piv

Longer tests can be skipped with the --test.short flag.

TEST_DANGEROUS_WIPE_REAL_CARD=1  go test -v --short ./piv

Why?

YubiKey's C PIV library, ykpiv, is brittle. The error messages aren't terrific, and while it has debug options, plumbing them through isn't idiomatic or convenient.

ykpiv wraps PC/SC APIs available on Windows, Mac, and Linux. There's no requirement for it to be written in any particular langauge. As an alternative to pault.ag/go/ykpiv this package re-implements ykpiv in Go instead of calling it.

Authors

go-piv has been forked from go-piv/piv-go at commit 8c3a0ff

• Eric Chiang (@ericchiang)
• Steffen Vogel (@stv0g)

Contact

Please have a look at the contact page: cunicu.li/docs/contact.

License

go-piv is licensed under the Apache 2.0 license.

• SPDX-FileCopyrightText: 2020 Google LLC
• SPDX-FileCopyrightText: 2023-2024 Steffen Vogel post@steffenvogel.de
• SPDX-License-Identifier: Apache-2.0