commit | 521dbc67dabf5f5dc2ad8148b6f01662805caac7 | [log] [tgz] |
---|---|---|
author | Jaeden Amero <jaeden.amero@arm.com> | Wed Apr 17 12:12:24 2019 +0100 |
committer | Jaeden Amero <jaeden.amero@arm.com> | Wed Apr 17 12:12:24 2019 +0100 |
tree | e21ba0e0f9d45ed7ee71bc0659948fb6bd636a64 | |
parent | 125a1e980e44a8b756ba3a9a3b7c4d1ce5cbf134 [diff] | |
parent | f790a6cbeea43ae297ef75dfd697e5cf30b94913 [diff] |
Merge remote-tracking branch 'tls/development' into development Merge Mbed TLS at f790a6cbeea4 into Mbed Crypto. Resolve conflicts by performing the following: - Reject changes to README.md - Don't add crypto as a submodule - Remove test/ssl_cert_test from programs/Makefile - Add cipher.nist_kw test to tests/CMakeLists.txt - Reject removal of crypto-specific all.sh tests - Reject update to SSL-specific portion of component_test_valgrind in all.sh - Reject addition of ssl-opt.sh testing to component_test_m32_o1 in all.sh * tls/development: (87 commits) Call mbedtls_cipher_free() to reset a cipher context Don't call mbedtls_cipher_setkey twice Update crypto submodule Minor fixes in get certificate policies oid test Add certificate policy oid x509 extension cpp_dummy_build: Add missing header psa_util.h Clarify comment mangled by an earlier refactoring Add an "out-of-box" component Run ssl-opt.sh on 32-bit runtime Don't use debug level 1 for informational messages Skip uncritical unsupported extensions Give credit to OSS-Fuzz for #2404 all.sh: remove component_test_new_ecdh_context Remove crypto-only related components from all.sh Remove ssl_cert_test sample app Make CRT callback tests more robust Rename constant in client2.c Document and test flags in x509_verify Fix style issues and a typo Fix a rebase error ...
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.
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:
Mbed Crypto is a reference implementation of the PSA cryptography API. It is written in portable C.
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.
You can read the complete PSA cryptography API specification as a PDF document. The API reference is also available in HTML format.
To generate a local copy of the library documentation in HTML format:
make apidoc
.apidoc/index.html
or apidoc/modules.html
.You need the following tools to build the library with the provided makefiles:
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.
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.
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.
Future releases of this library will include:
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.