Skip to content
Mbed Crypto is a reference implementation of the Arm PSA Crypto API
Branch: development
Clone or download
Patater Merge pull request #148 from ARMmbed/dev/gilles-peskine-arm/check_par…
…ams-test_without_function-crypto

Make test suites compatible with #include <assert.h>
Latest commit 86268e1 Jun 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add github issue template Nov 29, 2018
configs config: Remove explicit ciphersuite lists Apr 25, 2019
docs New key file format for 1.0.1 May 21, 2019
doxygen
include psa: Avoid use of relative include paths Jun 7, 2019
library
programs Merge remote-tracking branch 'tls/development' into development May 1, 2019
scripts Merge remote-tracking branch 'tls/development' into development May 21, 2019
tests Make test suites compatible with #include <assert.h> Jun 13, 2019
visualc/VS2010 Remove unused TLS, NET, and X.509 files Apr 25, 2019
.gitignore Ignore more generated files: seedfile, apidoc Feb 25, 2019
.globalrc Generate tags for Vi, for Emacs and with Global Feb 25, 2019
.pylintrc Allow main() to lack a docstring. Feb 27, 2019
.travis.yml Merge remote-tracking branch 'tls/development' into development Apr 17, 2019
CMakeLists.txt Merge remote-tracking branch 'tls/development' into development May 21, 2019
CONTRIBUTING.md Fix #2370, minor typos and spelling mistakes Jan 24, 2019
DartConfiguration.tcl Rename to mbed TLS in the documentation/comments Jan 22, 2015
LICENSE Change main license to Apache 2.0 Sep 4, 2015
Makefile Merge remote-tracking branch 'tls/development' into development May 21, 2019
README.md API spec HTML: Use Github Pages rather than htmlpreview May 23, 2019
apache-2.0.txt Change main license to Apache 2.0 Sep 4, 2015

README.md

Mbed Crypto library

The Mbed cryptography library is a reference implementation of the cryptography interface of the Arm Platform Security Architecture (PSA). This is a preview release of Mbed Crypto, provided for evaluation purposes only.

Mbed Crypto is distributed under the Apache License, version 2.0. See the LICENSE file for the full text of the license.

PSA cryptography API

Arm's Platform Security Architecture (PSA) is a holistic set of threat models, security analyses, hardware and firmware architecture specifications, and an open source firmware reference implementation. PSA provides a recipe, based on industry best practice, that allows security to be consistently designed in, at both a hardware and firmware level.

The PSA cryptography API provides access to a set of cryptographic primitives. It has a dual purpose. First, it can be used in a PSA-compliant platform to build services, such as secure boot, secure storage and secure communication. Second, it can also be used independently of other PSA components on any platform.

The design goals of the PSA cryptography API include:

  • The API distinguishes caller memory from internal memory, which allows the library to be implemented in an isolated space for additional security. Library calls can be implemented as direct function calls if isolation is not desired, and as remote procedure calls if isolation is desired.
  • The structure of internal data is hidden to the application, which allows substituting alternative implementations at build time or run time, for example, in order to take advantage of hardware accelerators.
  • All access to the keys happens through handles, which allows support for external cryptoprocessors that is transparent to applications.
  • The interface to algorithms is generic, favoring algorithm agility.
  • The interface is designed to be easy to use and hard to accidentally misuse.

Mbed Crypto implementation

Mbed Crypto is a reference implementation of the PSA cryptography API. It is written in portable C.

Documentation

The Mbed Crypto library is a reference implementation of the PSA cryptography API. Please refer to the PSA Cryptography API documents for an overview of the library's interfaces and a detailed description of the types, macros and functions that it provides.

There are currently a few deviations where the library does not yet implement the latest version of the specification. Please refer to the compliance issues on Github for an up-to-date list.

PSA Cryptography API

You can read the complete PSA cryptography API specification as a PDF document. The API reference is also available in HTML format.

Browsable library documentation

To generate a local copy of the library documentation in HTML format:

  1. Make sure that Doxygen is installed. We use version 1.8.11 but slightly older or more recent versions should work.
  2. Run make apidoc.
  3. Browse apidoc/index.html or apidoc/modules.html.

Compiling

You need the following tools to build the library with the provided makefiles:

  • GNU Make or a build tool that CMake supports.
  • A C99 toolchain (compiler, linker, archiver).
  • Python 2 or Python 3 (either will work) to generate the test code.
  • Perl to run the tests.

If you have a C compiler, such as GCC or Clang, just run make in the top-level directory to build the library, a set of unit tests and some sample programs.

To select a different compiler, set the CC variable to the name or path of the compiler and linker (default: cc), and set AR to a compatible archiver (default: ar). For example:

make CC=arm-linux-gnueabi-gcc AR=arm-linux-gnueabi-ar

The provided makefiles pass options to the compiler that assume a GCC-like command-line syntax. To use a different compiler, you may need to pass different values for CFLAGS, WARNINGS_CFLAGS and LDFLAGS.

To run the unit tests on the host machine, run make test from the top-level directory. If you are cross-compiling, copy the test executable from the tests directory to the target machine.

Compiling as a subproject

Mbed Crypto supports being built as a subproject of Mbed TLS. Mbed TLS can use Mbed Crypto for its cryptography implementation by using Mbed Crypto as a subproject.

From the Mbed TLS project repository, CMake can be invoked as follows to build Mbed TLS using Mbed Crypto's libmbedcrypto.

mkdir cmake
cd cmake
cmake .. -DUSE_CRYPTO_SUBMODULE=1
make -j
make test

When building Mbed Crypto as a subproject of Mbed TLS, the Mbed TLS configuration file (config.h) is used, and not the Mbed Crypto configuration file.

Example programs

The programs/ subdirectory contains sample programs that use the library. Please note that the goal of these sample programs is to demonstrate specific features of the library, and the code may need to be adapted to build a real-world application.

Upcoming features

Future releases of this library will include:

  • A driver programming interface, which makes it possible to use hardware accelerators instead of the default software implementation for chosen algorithms.
  • Support for external keys to be stored and manipulated exclusively in a separate cryptoprocessor.
  • A configuration mechanism to compile only the algorithms you need for your application.
  • A wider set of cryptographic algorithms.

Feedback welcome

Arm welcomes feedback on the design of the API. If you think something could be improved, please open an issue on our Github repository. Alternatively, if you prefer to provide your feedback privately, please email us at mbed-crypto@arm.com. All feedback received by email is treated confidentially.

You can’t perform that action at this time.