Skip to content

Latest commit

 

History

History
281 lines (176 loc) · 15.9 KB

prepare-management-utilities.md

File metadata and controls

281 lines (176 loc) · 15.9 KB
Raw
copyright lastupdated keywords subcollection
years
2019, 2024
2024-08-07
smart card, smart card reader, install driver, linux, trusted key entry, tke, master key, initialize service, load master key
hs-crypto

{{site.data.keyword.attribute-definition-list}}

Setting up smart cards and the Management Utilities

{: #prepare-management-utilities}

With smart cards and the {{site.data.keyword.IBM}} {{site.data.keyword.hscrypto}} Management Utilities, you can initialize service instances with the highest level of security. The Management Utilities use smart cards for storing signature keys and master key parts. {: shortdesc}

The following diagram gives you an overview of steps you need to take to initialize service instances with smart cards and the Management Utilities. This topic covers the steps to set up the Management Utilities. For the detailed instructions on initialize the service instance, see Initializing service instances by using smart cards and the Management Utilities.

The task flow of service instance initialization with smart cards and the Management Utilities{: caption="Figure 1. Task flow of service instance initialization with smart cards and the Management Utilities" caption-side="bottom"}

Step 1: Order smart cards and smart card readers

{: #order-smart-card-and-reader}

Before you can configure smart cards, you need to first order smart cards and smart card readers online.

Ordering smart cards

{: #order-smart-card}

Complete the following steps to order smart cards:

  1. Determine the quantity of smart cards that are required.

    A minimum of two smart cards are needed to use the Management Utilities:

    • A certificate authority smart card to define a smart card zone, which is a set of smart cards that can work together.
    • An Enterprise PKCS #11 (EP11) smart card to hold a signature key and one or more master key parts that are used to configure service instances. Currently, the Management Utilities support two or three master key parts to be loaded.

    For added security, the two or three master key parts that are used to configure a service instance can be generated on separate EP11 smart cards that are assigned to different people. The signature key that is used to sign commands to the crypto module can be generated on a separate EP11 smart card. Three or four EP11 smart cards are then needed to configure a service instance. {: tip}

    It is also suggested to create backup copies of all used smart cards and to save the backup smart cards in a secure place. For maximum security, 12 smart cards are needed, which includes backup smart cards:

    • Two certificate authority smart cards
    • Ten EP11 smart cards

    For how to calculate the number of smart cards needed, see FAQ: Are there any recommendations on how to set up smart cards?

  2. Contact your IBM Sales representative or your IBM Business Partner and provide the following information.

    • The total number of smart cards needed; minimum of two.
    • Billing contact information, which includes the name, billing address, phone number, email address, and time zone.
    • Shipping contact information, which includes the name, shipping address, phone number, email address, and time zone.

    For more information about ordering smart cards through your IBM sales representatives or Business Partners, see How to Order{: external}.

Ordering smart card readers

{: #order-smart-card-reader}

To order smart card readers, you have the following options:

  • Contact your IBM Sales representative or your IBM Business Partner to order smart card readers. For more information, see How to Order{: external}.

  • Order two smart card readers Identiv SPR332 v2.0 Secure Class 2 PIN Pad Reader (part number 905127-1), from third-party online shops. The following list contains a few example online shopping sites where the required smart card readers are available. The deliver policy might vary depending on your geographical locations:

Step 2: Install the smart card reader driver on your local workstation

{: #install-smart-card-reader-driver}

You need to install the Identiv SPR332 V2 smart card reader driver on your local workstation. Currently, Red Hat Enterprise Linux® 8.0, Red Hat Enterprise Linux 9.0, and Ubuntu 22.04.1 LTS are supported.

You need to take the Security considerations for initalizing a service instance into account when you plan your security policy for your smart cards and smart card readers. Otherwise, your smart cards might be exposed to some vulnerabilities. {: note}

Before you install the smart card reader driver on a Linux operating system, download and extract the driver package from the Identiv SPR332 v2.0 Support website{: external}. And then, install the smart card reader driver by completing the following steps depending on your Linux® distributions:

  • Red Hat Enterprise Linux 8.0 and 9.0

    1. To install packages on Red Hat Enterprise Linux and receive software updates, first register the system and attach a subscription. This can be done using the subscription-manager command. See Red Hat documentation{: external} for details.

    2. Install the pcsc-lite package with the following command:

      sudo yum install pcsc-lite

      {: pre}

    3. Install the libusb package with the following command:

      sudo yum install libusb

      {: pre}

    4. Check and make sure that the opensc and esc packages are not installed. These packages can cause unexpected errors during the operations of the smart card readers.

      Run the following command to display all installed opensc or esc packages. Replace <package_name> with opensc or esc:

      sudo yum list installed <package_name>

      {: pre}

      If any packages are listed, remove them using the following commands. Replace <package_name> with opensc or esc:

      sudo yum remove <package_name>

      {: pre}

    5. Run the install.sh script, which is included in the downloaded driver package.

    6. Start the PC/SC daemon with the following command:

      sudo pcscd

      {: pre}

  • Ubuntu 22.04.1 LTS

    1. Install the pcscd and libccid packages with the following command:

      sudo apt install pcscd

      {: pre}

    2. Run the install.sh script, which is included in the downloaded package of the smart card reader driver.

    3. On some Ubuntu configurations, the PC/SC daemon does not start automatically on the first PC/SC call. To avoid this problem, run the following command:

      sudo systemctl enable pcscd.socket

      {: pre}

    4. Restart the workstation.

Step 3: Install the Management Utilities on your local workstation

{: #install-management-utility-application}

Two applications are provided as part of the Management Utilities: the Smart Card Utility Program and the Trusted Key Entry (TKE) application. With the Smart Card Utility Program, you can initialize the smart cards to use. The TKE application uses the smart cards to load master keys in service instances.

To install the applications on Red Hat Enterprise Linux 8.0, Red Hat Enterprise Linux 9.0, or Ubuntu 22.04.1 LTS, complete the following steps:

  1. Download the latest installation file, cloudtke.bin, from GitHub{: external} to your workstation.

  2. (Optional) For maximum security, verify the integrity and authenticity of the Management Utilities installation file cloudtke.bin before you install or update the applications.

    {{site.data.keyword.hscrypto}} Management Utilities enable signed code verification{: external} to ensure that the signature matches the original code. If the downloaded installation file is altered or corrupted, a different signature is produced and the verification fails. To make sure that the applications are not tampered with or corrupted during the download process, complete the following steps by using the OpenSSL command-line tool{: external}:

    1. Download the latest version of following files from GitHub{: external} to the same directory where you store the cloudtke.bin file:

      • cloudtke.sig: The signed cryptographic hash of cloudtke.bin (SHA-256).
      • digicert_cert.pem: An intermediate code signing certificate to prove the Management Utilities signing certificate.
      • signing_cert.pem: The signing certificate of the Management Utilities.

    2. Extract the public key from the signing certificate signing_cert.pem to the sigkey.pub file with the following command by using the OpenSSL command-line tool:

      openssl x509 -pubkey -noout -in signing_cert.pem -out sigkey.pub

      {: pre}

    3. Verify the integrity of the cloudtke.bin file with the following command:

      openssl dgst -sha256 -verify sigkey.pub -signature cloudtke.sig cloudtke.bin

      {: pre}

      When the verification is successful, Verified OK is displayed.

    4. Verify the authenticity and validity of the signing certificate with the following command:

      openssl ocsp -no_nonce -issuer digicert_cert.pem -cert signing_cert.pem -VAfile digicert_cert.pem -text -url http://ocsp.digicert.com -respout ocsptest

      {: pre}

      When the verification is successful, Response verify OK and signing_cert.pem: good are displayed in the output.

    5. If the verification fails, cancel the installation and contact IBM for support. Otherwise, proceed with the following steps.

  3. From the command line, enter the directory that the downloaded installation file is located, and perform the following steps to install the applications:

    1. Add the execute permission to the installation file by running the following command:

      chmod +x cloudtke.bin

      {: pre}

    2. Install the applications by running the following command:

      ./cloudtke.bin

      {: pre}

    3. When prompted, choose the installation folder for the Management Utilities and then select the Don't create links option.

Step 4: Configure smart cards with the Smart Card Utility Program

{: #configure-smart-card-utility}

Two types of smart cards are used in the Management Utilities, the certificate authority smart card and EP11 smart cards. The certificate authority smart card is used to define a smart card zone and create a set of EP11 smart cards in the zone, while an EP11 smart card is used to generate and store an administrator signature key and master key parts.

To configure smart cards, use the Smart Card Utility Program to complete the following tasks.

Initializing the certificate authority smart card

{: #initialize-ca-smart-card}

To create and initialize a certificate authority smart card, follow these steps:

  1. Plug the two smart card readers into the USB ports of your workstation.

  2. To start the Smart Card Utility Program, go to the subdirectory where you install the Management Utilities applications and run the following command:

    ./scup

    {: pre}

  3. After the Smart Card Utility Program is started, from the CA Smart Card menu, select Initialize and personalize CA smart card.

  4. Insert the smart card to be initialized into a smart card reader 1, and click OK.

    If you receive a message similar to No smart card inserted, try the following solutions:

    • Insert the smart card into another smart card reader. The smart card reader that you picked might not be smart card reader 1.
    • Reinsert the smart card into the same smart card reader. The smart card reader might not be reading the smart card properly.

  5. Enter a six-digit personal identification number (PIN) twice on the smart card reader PIN pad as the first certificate authority card PIN.

    Enter the PIN twice in 20 seconds. Otherwise, the session is expired and you need to reenter the PIN. {: tip}

  6. Enter a six-digit PIN twice on the smart card reader PIN pad as the second certificate authority card PIN. You need to enter both PINs later when you use the certificate authority smart card.

    Enter the PIN twice in 20 seconds. Otherwise, the session is expired and you need to reenter the PIN. {: tip}

  7. Enter a description for the smart card zone that holds the EP11 smart cards.

  8. Enter a description for the certificate authority smart card.

The certificate authority is created.

It is suggested to create a backup copy of your certificate authority smart card. You can create a backup copy by clicking CA Smart Card > Backup CA smart card. {: important}

Initializing the EP11 smart card

{: #initialize-ep11-smart-card}

To create and initialize an EP11 smart card, follow these steps:

  1. Select EP11 Smart Card > Initialize and enroll EP11 smart card from the menu.
  2. Insert the smart card to be initialized as the EP11 smart card in smart card reader 2 and click OK.
  3. Select EP11 Smart Card > Personalize EP11 smart card from the menu bar.
  4. Enter a six-digit PIN twice on the smart card reader PIN pad. You need to enter this PIN later when you use the EP11 smart card.
  5. Enter a description for the EP11 smart card.
  6. If you have more than one EP11 smart card, repeat step 1 to step 5 to initialize other EP11 smart cards.

Your EP11 smart cards are created and personalized.

What's next

{: #prepare-management-utilities-next}