Skip to content

Latest commit

 

History

History
140 lines (104 loc) · 5.92 KB

README.md

File metadata and controls

140 lines (104 loc) · 5.92 KB
Raw

MoCOCrW

(mo)dern (c)++ (o)penssl (cr)ypto (w)rapper library

As part of our development efforts we noticed that there are cryptographic primitives that are needed in many different situations. Unfortunately, most of the libraries are only in C and the only library that implements all the different algorithms/modes and primitives is OpenSSL.

OpenSSL is hard to use and does not integrate well in a C++14/17 development environment. Consequently, we decided to provide a wrapping framework around OpenSSL with the following goals in mind:

  • Translation of OpenSSL memory management into C++ memory management concepts
  • Good testability - in particular all calls to OpenSSL should be mockable
  • Extensive automatic testing
  • Easy to use end-user interface for common features

This library is the work-in-progress result of the above ideas.

Support

We currently support OpenSSL 1.1.1 in the openssl1.1 branch. The support for OpenSSL 1.0.<x> (in the master and the openssl1.0.2 branch) has been dropped. These branches are not maintained anymore. The library is developed and tested mainly for x86_64 and aarch64 targets with Linux. However, there is no general limitation to that.

The library provides end-user interfaces for:

  • X509 certificate processing
  • X509 certificate CA functionality
  • CRLs
  • RSA Encryption and Signatures
  • ECDSA Signatures
  • EdDSA Signatures
  • ECIES Encryption (according to IEEE 1363a-2004)
  • PBKDF2 and X963KDF Key derivation
  • HMAC
  • AES-CMAC (according to RFC 4493 for 128 and 256 bit keys)
  • AES Encryption (including GCM to support authenticated encryption with additional data)
  • SHA 1/2/3 Hashing

Building

The library contains CMake build scripts. As a dependency, your build environment should have development packages for the following libraries installed:

  • OpenSSL (1.1.1 branch)
  • Boost
  • gtest/gmock

In order to build the library with tests, do

$ mkdir build; cd build
build/$ cmake -DBUILD_TESTING=True ..
build/$ make
build/$ ctest . --output-on-failure

The bci.config file is used by our internal validation environment, please just ignore it.

Build with dilithium support

Dilithium is an optional feature provided by MoCOCrW.

This feature depends on reference implementation of the Dilithium signature scheme since OpenSSL still doesn't have a support for Dilithium. The following adaptations are necessary in order to successfully compile MoCOCrW with the Dilithium feature .

Dilithium Adaptions

It is not possible to take the bare Dilithium implementation. The Dilithium implementation was adapted with the following PRs: PR#1 PR#2. These PRs need to be pulled and used to build and install libdilithium locally before trying to use it with MoCOCrW.

Then, to use the Dilithium feature, replace the CMake invocation with:

build/$ cmake -DBUILD_TESTING=True -DMOCOCRW_DILITHIUM_ENABLED=ON ..

Build with HSM support

HSM support is an optional feature for MoCOCrW. This allows for loading and storing keys on HSM and using those keys in various cryptographic algorithms without having keys in memory. Thread safety is not guaranteed. To build MoCOCrW with HSM support, a patched version of libp11 is necessary since upstream libp11 does not support key generation through OpenSSL's ENGINE API.

libp11 release 0.4.12 patched with patch for key generation is required for building MoCOCrW with HSM feature enabled. To build and install patched libp11, check out how it's done in our CI or official instructions by libp11.

Then, to use the HSM feature, replace the CMake invocation with:

build/$ cmake -DBUILD_TESTING=True -DMOCOCRW_HSM_ENABLED=ON ..

Installation / Usage / Packaging

MoCOCrW is prepared to be installed or packaged into an SDK. It also provides a CMake exported target that you can use in your projects. A minimal example how to use this CMake integration can be found in tests/sdk. This can also be used as an integration test if you want to ship MoCOCrW with an SDK.

Unfortunately, there is not a lot of usage examples available right now. You may have a look at the unit tests to see the API in action.

Most functionality is already documented in a doxygen style documentation in code. More examples and a complete documentation will follow.

Support / Comments

Support for this library will be provided on a best-effort basis. However, we encourage you to submit bugs or contact us via github if there is an issue.

Documentation

Documentation and examples are also part of the repository.

Doxygen

In order to generate the doxygen documentation please follow the next steps: on the project build directory run:

cmake -DBUILD_DOCUMENTATION=ON -DDOCUMENTATION_INSTALL_DESTINATION=/<path to doc folder> ..
make doc

If the option DOCUMENTATION_INSTALL_DESTINATION is omitted, the documentation will only be built but not installed.

Versioning and Releases

This library applies versioning similar to what is described at semver.org. In addition, we are keeping soversion and library version in sync and will create major releases even though it would not be necessary according to Semantic Versioning (e.g. due to break of ABI)

Code Format

We use clang-format, version 10, to properly format MoCOCrW's code-base. Kindly use this version when formatting your PRs for contribution.