This repository contains a software based implementation of the PKCS #11 interface (API) to enable rapid development and flexibility when developing applications that rely on cryptographic operations.

Only a subset of the PKCS #11 standard is implemented, with a focus on operations involving asymmetric keys, random number generation, and hashing.

The targeted use cases include certificate and key management for TLS authentication and code-sign signature verification, on small embedded devices.

corePKCS11 is implemented on PKCS #11 v2.4.0, the full PKCS #11 standard can be found on the oasis website.

This library has gone through code quality checks including verification that no function has a GNU Complexity score over 8, and checks against deviations from mandatory rules in the MISRA coding standard. Deviations from the MISRA C:2012 guidelines are documented under MISRA Deviations. This library has also undergone both static code analysis from Coverity static analysis and validation of memory safety and proof of functional correctness through the CBMC automated reasoning tool.

See memory requirements for the latest release here.

The PKCS #11 library exposes build configuration macros that are required for building the library. A list of all the configurations and their default values are defined in the doxygen documentation for this library.

• For building the library, CMake 3.13.0 or later and a C90 compiler.
• For running unit tests, Ruby 2.0.0 or later is additionally required for the CMock test framework (that we use).
• For running the coverage target, gcov is additionally required.

By default, the submodules in this repository are configured with update=none in .gitmodules to avoid increasing clone time and disk space usage of other repositories (like amazon-freertos that submodule this repository.

To build unit tests, the submodule dependency of CMock is required. Use the following command to clone the submodule:

git submodule update --checkout --init --recursive test/unit-test/CMock

1. Go to the root directory of this repository. (Make sure that the CMock submodule is cloned as described above)

2. Run cmake while inside build directory: cmake -S ../test/unit-test -B build

3. Run this command to build the library and unit tests: make -C build all

4. The built library will be present in build/lib folder, and generated test executables will be present in build/bin/tests folder.

5. Run ctest to execute all tests and view the test run summary.

The FreeRTOS-Labs repository contains demos using the PKCS #11 library here using FreeRTOS on the Windows simulator platform. These can be used as reference examples for the library API.

The Doxygen references were created using Doxygen version 1.8.20. To generate the Doxygen pages, please run the following command from the root of this repository:

doxygen docs/doxygen/config.doxyfile

See CONTRIBUTING for more information.

This library is licensed under the MIT-0 License. See the LICENSE file.