IBM PCIeCC2 library

Product documentation for the IBM PCIe Cryptographic Coprocessor Version 2 (PCIeCC2) is available in PDF format. To view a PDF document, you need the Adobe® (Adobe Systems Incorporated) Reader®. If you don't have the Reader installed, you can download a complimentary copy from Adobe.(link resides outside of ibm.com)


 

The PCIeCC2 is available on IBM Z® mainframe computers (z14®, z13s™, and z13® only), on IBM Power Systems™ (POWER8® only), and on x86 servers:

IBM Z mainframe. The PCIeCC2 is available as feature code (FC) 0890 (Crypto Express5S, or CEX5S) on IBM Z mainframes (z14, z13s, and z13 only), either on z/OS® or Linux® on z Systems® operating systems.

  • The CEX5S publications for z/OS are not available here.
  • On Linux on z Systems, IBM offers a CCA API for the CEX5S and a PKCS #11 (EP11) API to the user.

x86 servers. The PCIeCC2 is available as a machine type-model 4767-002 on x86 servers on either Microsoft® Windows®, SUSE® (a Micro Focus company) Linux Enterprise Server (SLES), or Red Hat® Enterprise Linux® (RHEL) 64-bit operating systems. IBM offers a Common Cryptographic Architecture (CCA) Support Program for the IBM 4767 PCIe Cryptographic Coprocessor, at no charge, to the user.

IBM Power Systems. The PCIeCC2 is available as FC EJ32, Customer Card Identification Number 4767 (without blind-swap cassette custom carrier) and as FC EJ33, Customer Card Identification Number 4767 (with blind-swap cassette custom carrier) on IBM POWER8® servers, either on IBM AIX®, IBM i®, or PowerLinux® (RHEL, SLES, or Ubuntu®) operating systems.

The PCIeCC2 is available on IBM Z® mainframe computers (z14®, z13s™, and z13® only), on IBM Power Systems™ (POWER8® only), and on x86 servers:

PCIeCC2 CCA Support Program

The CCA Basic Services and Secure Key Solution manuals describe the capabilities of the security application programming interface (API) provided with the CCA Support Program, while the CCA Support Program Installation manual describes how to install CCA. Refer to the Manuals by platform table to select these manuals by platform.

Manuals by platform

Platform Manual
Linux on IBM Z IBM Secure Key Solution with the Common Cryptographic Architecture Application Programmer's Guide (PDF, 6.7 MB)
IBM AIX, IBM i, and IBM PowerLinux on Power Systems IBM CCA Basic Services Reference and Guide for the IBM 4767 and IBM 4765 PCIe Cryptographic Coprocessors (PDF, 6.0 MB)
x86 systems IBM CCA Basic Services Reference and Guide for the IBM 4767 and IBM 4765 PCIe Cryptographic Coprocessors (PDF, 6.0 MB)
  IBM 4767 PCIe Cryptographic Coprocessor CCA Support Program Installation Manual: Linux and Windows (PDF, 1.14 MB)

 


IBM 4767 custom programming

Custom Software Developer's Toolkit Guide

This guide describes the tools that enable developers to build applications for the IBM 4767, authenticate programs, and load programs into the IBM 4767.

IBM 4767 PCIe Cryptographic Coprocessor Custom Software Developer's Toolkit Guide (PDF, 844 KB)

Custom Software Interface Reference

This manual describes the function calls that applications running in the IBM 4767 use to obtain services from the coprocessor operating system and from the coprocessor device driver in the host system.

IBM 4767 PCIe Cryptographic Coprocessor Custom Software Interface Reference (PDF, 777 KB)

CCA User Defined Extensions Reference and Guide

This manual describes the user-defined extensions programming environment within the CCA application in the IBM 4767, the method for extending the CCA host API, and the application programming interface reference for these environments.

IBM 4767 PCIe Cryptographic Coprocessor CCA User Defined Extensions Reference and Guide (PDF, 1.5 MB)

Interactive Code Analysis Tool (ICAT)

This manual describes the tool that developers use to debug applications running on the IBM 4767.

IBM 4767 PCIe Cryptographic Coprocessor ICAT Getting Started (PDF, 321 KB)


IBM 4767 optional smart cards and readers for Linux users

Smart Card User Guide

This manual describes the IBM Smart Card Utility Program (SCUP) and SCUP-enabled Cryptographic Node Management (CNM) utility.

IBM 4767 PCIe Cryptographic Coprocessor Smart Card User Guide (PDF, 1.69 MB)


IBM 4767 CCA utilities

CCA Utilities User Guide
This manual describes CCA backup/restore, CCA initialization, and CCA HSM.

IBM 4767 PCIe Cryptographic Coprocessor CCA Utilities User Guide (PDF, 510 KB)


PCIeCC2 Enterprise PKCS #11 (EP11)

This manual describes the library structure and capabilities of the cryptographic application programming interface (API) provided with the Enterprise PKCS#11 (EP11) Library for Linux on Z.

Enterprise PKCS#11 (EP11) Library structure (PDF, 1.2 MB)


Related products

The IBM CPACF Enablement crypto feature

The IBM Central Processor Assist for Cryptographic Functions (CPACF) feature, IBM Z feature code 3863, provides hardware acceleration for 290-960 MB/sec bulk encryption rate, AES (128, 192, 256 bit), DES (DEA, TDEA2, TDEA3), SHA-1 (160 bit), and SHA-2 (224, 256, 384, 512 bit).

The IBM Cryptographic Coprocessor Facility (CCF)

The Cryptographic Coprocessor Facility (CCF) is an optional hardware feature that provides high-performance cryptographic capabilities for z/VM®, including DES, Triple-DES, RSA, and various finance-industry-specific cryptographic services. IBM zSeries servers, except the zSeries 990, offer the CCF feature.