Next Previous Contents

6. Smartcards (Security Tokens)

Since XCA 0.8.0 the use of Smartcards (Security tokens) is supported. It is based on the PKCS#11 standard. The Options dialog contains a list to add one or more PKCS#11 providers (libraries). This is not restricted to Smartcards but includes all type of security tokens like USB tokens. The default is /usr/lib/opensc-pkcs11.so and opensc-pkcs11.dll in the XCA installation path, depending on your OS.

Once again: This software comes with no warranty at all! If XCA transforms your security token into a fridge, don't blame me. For me everything worked fine and I tested it thoroughly.

On Linux the package opensc should be installed. Please read the opensc documentation for more details. Generally: if the opensc commandline-tool "pkcs11-tool -L" shows reasonable output, XCA will work. Otherwise fix the opensc setup. I had a functional setup with a "Reiner SCT" and a DELL keyboard with integrated card reader and TCOS Netkey E4 cards. I also used Aladdin Etoken very successfully (Thanks for support!). The Aladdin PKCS#11 library supports all needed features very well.

Before the keys of a token can be used, they must be imported into XCA. This means that XCA reads the token and shows the keys and certificates on the token. They can then be imported partially or completely via the Multi-import dialog. It is not unusal that a token contains more than one key or certificate. It is of course possible to create your own keys on the token. When selecting a token-key for signing, XCA verifies that the corresponding token is available.

The following actions with smartcards are supported:

Existing, non-deletable, built-in certificates of Smart-cards may be ignored. A new CA certificate can be created and self-signed by the Smart-card key. It can then be used to issue end-entity certificates, containing other RSA, DSA or EC keys or sign imported certificate requests.

6.1 Key Management on the Token

XCA assumes for every private key on the card a corresponding public key. When managing cards, XCA only searches for public keys. There is thus no need to enter a PIN. When using the the key for signing the corresponding private key on the card is selected and a PIN must be entered.

Accordingly, every time a key is generated on the card, a public/private keypair is generated. Every time a key is stored on the card, XCA creates a public and a private key object.

Firefox always only looks for private keys on the card. If XCA does not show a key, which is however recognized by firefox a missing public-key object is the cause.

6.2 The Token Menu

The menu item: Token is accessible if a PKCS#11 library was loaded and initialized.

Managing Smartcards

Security token specific operations are collected below the menu-item Token

Manage Security Token

This is the Multi import dialog, which allows to view and select the items to be imported. When started it reads the content of the selected token. Additionally, it shows token information in the bottom-right corner and allows to delete and rename items directly on the token.

Initializing Tokens

Initializing tokens is done via the menu item Initialize token. During this process either a new SO PIN must be supplied or the old SO PIN must be given. Additionally XCA asks for the label of this token.

After this operation succeeded, the User PIN is uninitialized and must be initialized via Init PIN

Deleting Items from the Token

Just delete the item as usual. XCA will then ask whether the item shall also be removed from the token. Items on the token that were not yet imported can be deleted via the "Manage security token" menu.

Changing PINs

The User PIN and SO PIN can be changed via the Token menu and also via the key context-menu. In this case the correct token containing the key will be enforced.

Tested Providers

The following providers were used for testing:

Tested compatibility with other applications

For interoperability tests I used the Aladdin eToken together with the Aladdin PKIclient 5.1 software and OpenSC with the Feitian PKI-card.

I initialized the token as follows:

Firefox / Mozilla -> Apache

OpenVPN

The relevant server config is as follows:

pkcs12 server.p12

The client config is:

ca ca.crt
pkcs11-providers /usr/lib/libeTPkcs11.so
pkcs11-id 'Aladdin\x20Knowledge\x20Systems\x20Ltd\x2E/eToken/002882d2/F\xC3\xBCr\x20den\x20Firefox/D1A7BFF94B86C061'

The pkcs11-id can be obtained with the command: openvpn --show-pkcs11-ids /usr/lib/libeTPkcs11.so


Next Previous Contents